From bc2366d6fe709b6e8c620dcca39fe26ea94f1d1c Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
<41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 23 Apr 2024 14:48:28 +0200
Subject: [PATCH] chore: prepare changeset process
---
.changeset/fuzzy-items-listen.md | 17 ---
README.md | 97 ++++++++++++++++-
apps/docs/CHANGELOG.md | 9 ++
apps/docs/app/routes/_index.mdx | 101 ++++++++++++------
apps/docs/package.json | 2 +-
apps/nextjs-example/CHANGELOG.md | 5 +
apps/nextjs-example/package.json | 2 +-
.../react-vite-chakra-ui-example/CHANGELOG.md | 5 +
.../react-vite-chakra-ui-example/package.json | 2 +-
apps/react-vite-example/CHANGELOG.md | 5 +
apps/react-vite-example/package.json | 2 +-
apps/react-vite-mui-example/CHANGELOG.md | 5 +
apps/react-vite-mui-example/package.json | 2 +-
apps/vue-vite-example/CHANGELOG.md | 5 +
apps/vue-vite-example/package.json | 2 +-
packages/eslint-config/CHANGELOG.md | 9 ++
packages/eslint-config/package.json | 2 +-
packages/react/CHANGELOG.md | 9 ++
packages/react/package.json | 4 +-
packages/tsconfig/CHANGELOG.md | 9 ++
packages/tsconfig/package.json | 2 +-
packages/vue/CHANGELOG.md | 10 ++
packages/vue/package.json | 4 +-
23 files changed, 246 insertions(+), 64 deletions(-)
delete mode 100644 .changeset/fuzzy-items-listen.md
mode change 120000 => 100644 README.md
create mode 100644 apps/docs/CHANGELOG.md
create mode 100644 apps/nextjs-example/CHANGELOG.md
create mode 100644 apps/react-vite-chakra-ui-example/CHANGELOG.md
create mode 100644 apps/react-vite-example/CHANGELOG.md
create mode 100644 apps/react-vite-mui-example/CHANGELOG.md
create mode 100644 apps/vue-vite-example/CHANGELOG.md
create mode 100644 packages/eslint-config/CHANGELOG.md
create mode 100644 packages/react/CHANGELOG.md
create mode 100644 packages/tsconfig/CHANGELOG.md
create mode 100644 packages/vue/CHANGELOG.md
diff --git a/.changeset/fuzzy-items-listen.md b/.changeset/fuzzy-items-listen.md
deleted file mode 100644
index 0cb7550..0000000
--- a/.changeset/fuzzy-items-listen.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-"@uberschrift/vite-chakra-ui-example": minor
-"@uberschrift/vite-mui-example": minor
-"@uberschrift/vite-example": minor
-"@uberschrift/eslint-config": minor
-"vue-vite-example": minor
-"uberschrift": minor
-"vueberschrift": minor
-"@uberschrift/docs": minor
-"nextjs-example": minor
-"@uberschrift/tsconfig": minor
----
-
-Substantial eco system changes:
-
-- add vueberschrift package for Vue.js
-- Make use of changesets
diff --git a/README.md b/README.md
deleted file mode 120000
index 87d4101..0000000
--- a/README.md
+++ /dev/null
@@ -1 +0,0 @@
-packages/react/README.md
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..489dcf4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,96 @@
+# `uberschrift ๐งข`
+
+**Zero-dependency magic heading levels for React and Vue.js**
+
+---
+
+[](https://npmjs.com/package/uberschrift)
+[](https://npmjs.com/package/vueberschrift)
+[](https://github.com/peerigon/uberschrift/issues)
+[](https://github.com/peerigon/uberschrift/actions/workflows/pull_request.yml)
+
+---
+
+## [๐ Full Documentation](https://uberschrift.peerigon.io)
+
+## ๐ ๏ธ Usage
+
+### โ๏ธ React
+
+```sh
+npm install uberschrift
+```
+
+`page.tsx`:
+
+```tsx
+import { Hx, HxBoundary } from "uberschrift";
+
+Outside of the top level: this will be an h1
+
+
+ Within the top level: this will be an h2
+
+
+ Within the 2nd level: this will be an h3
+
+
+ Within the 3rd level: this will be an h4
+
+
+ Again within the 2nd level: this will be an h3
+
+
+```
+
+renders as:
+
+```html
+Outside of the top level: this will be an h1
+Within the top level: this will be an h2
+Within the 2nd level: this will be an h3
+Within the 3rd level: this will be an h4
+Again within the 2nd level: this will be an h3
+```
+
+### ๐ฒ Vue.js
+
+```sh
+npm install vueberschrift
+```
+
+`App.vue`:
+
+```html
+
+
+
+ Outside of the top level: this will be an h1
+
+ Within the top level: this will be an h2
+
+
+ Within the 2nd level: this will be an h3
+
+
+
+```
+
+---
+
+## Sponsors
+
+[
](https://peerigon.com)
+
+---
+
+## ๐ฉโ๐ป Development
+
+```sh
+npm install
+npx turbo dev
+npx turbo test
+npx turbo build
+```
diff --git a/apps/docs/CHANGELOG.md b/apps/docs/CHANGELOG.md
new file mode 100644
index 0000000..c49994f
--- /dev/null
+++ b/apps/docs/CHANGELOG.md
@@ -0,0 +1,9 @@
+# @uberschrift/docs
+
+## 2.0.0
+
+Include vueberschrift
+
+## 1.0.0
+
+Initial release
diff --git a/apps/docs/app/routes/_index.mdx b/apps/docs/app/routes/_index.mdx
index d2bb46b..996f50a 100644
--- a/apps/docs/app/routes/_index.mdx
+++ b/apps/docs/app/routes/_index.mdx
@@ -1,7 +1,7 @@
import { Hx, HxBoundary } from "uberschrift";
import { Clipboardable } from "../components/clipboardable";
-Zero-dependency magic heading levels for React
+Zero-dependency magic heading levels for React and Vue.js
```tsx
I'm the h1!'
@@ -66,11 +66,16 @@ uberschrift provides you with two components: one we call `` (as in "heading
---
Usage ๐ ๏ธ
+
+
+โ๏ธ React
+
```sh
npm install uberschrift
```
+
@@ -82,51 +87,84 @@ npm install uberschrift
Outside of the top level: this will be an h1
-
- Within the top level: this will be an h2
-
-
- Within the 2nd level: this will be an h3
+ Within the top level: this will be an h2
- Within the 3rd level: this will be an h4
+ Within the 2nd level: this will be an h3
- Again within the 2nd level: this will be an h3
-
`}>
```tsx
import { Hx, HxBoundary } from "uberschrift";
Outside of the top level: this will be an h1
-
- Within the top level: this will be an h2
-
-
- Within the 2nd level: this will be an h3
+ Within the top level: this will be an h2
- Within the 3rd level: this will be an h4
+ Within the 2nd level: this will be an h3
- Again within the 2nd level: this will be an h3
-
```
+
+
-renders as:
+
+๐ฒ Vue.js
-```html
-Outside of the top level: this will be an h1
-Within the top level: this will be an h2
-Within the 2nd level: this will be an h3
-Within the 3rd level: this will be an h4
-Again within the 2nd level: this will be an h3
+
+
+```sh
+npm install vueberschrift
```
+
+
+
+
+Example ๐
+
+`App.vue`:
+
+
+import { Hx, HxBoundary } from "vueberschrift";
+
+
+
+ Outside of the top level: this will be an h1
+
+ Within the top level: this will be an h2
+
+
+ Within the 2nd level: this will be an h3
+
+
+
+
+`}>
+```html
+
+
+
+ Outside of the top level: this will be an h1
+
+ Within the top level: this will be an h2
+
+
+ Within the 2nd level: this will be an h3
+
+
+
+
+
+```
+
+
FAQ ๐คฏ
@@ -141,20 +179,15 @@ Example for Chakra:
```tsx
import { Hx, HxBoundary } from "uberschrift";
-import {
- Heading as ChakraHeading,
- HeadingProps,
-} from "@chakra-ui/react";
+import { Heading as ChakraHeading, HeadingProps } from "@chakra-ui/react";
const Heading = (props: HeadingProps) => ;
// โฆ
-โฆ
+โฆ;
```
-
-
How does it handle heading elements nested below the 6th level? 7๏ธโฃ
The [HTML Spec](https://html.spec.whatwg.org/#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements) only allows h1 through h6 as elements and for most documents this should be more than enough.
@@ -183,8 +216,8 @@ In fact, you can use that context with `useHx` if you need it:
import { useHx } from "uberschrift";
const {
- Element, // string, e.g "h4"
- level // number => 4
+ Element, // string, e.g "h4"
+ level, // number => 4
} = useHx();
```
@@ -200,4 +233,4 @@ const {
---
-[Legal Notice](https://www.peerigon.com/en/legal/)
+[Legal Notice](https://www.peerigon.com/en/legal/), reactExample
diff --git a/apps/docs/package.json b/apps/docs/package.json
index b6b3da1..24e3d60 100644
--- a/apps/docs/package.json
+++ b/apps/docs/package.json
@@ -1,6 +1,6 @@
{
"name": "@uberschrift/docs",
- "version": "1.0.0",
+ "version": "2.0.0",
"sideEffects": false,
"type": "module",
"scripts": {
diff --git a/apps/nextjs-example/CHANGELOG.md b/apps/nextjs-example/CHANGELOG.md
new file mode 100644
index 0000000..132ed93
--- /dev/null
+++ b/apps/nextjs-example/CHANGELOG.md
@@ -0,0 +1,5 @@
+# nextjs-example
+
+## 1.0.0
+
+Initial release
diff --git a/apps/nextjs-example/package.json b/apps/nextjs-example/package.json
index 0cff45e..d6bae06 100644
--- a/apps/nextjs-example/package.json
+++ b/apps/nextjs-example/package.json
@@ -1,6 +1,6 @@
{
"name": "nextjs-example",
- "version": "0.0.0",
+ "version": "1.0.0",
"private": true,
"scripts": {
"dev": "next dev",
diff --git a/apps/react-vite-chakra-ui-example/CHANGELOG.md b/apps/react-vite-chakra-ui-example/CHANGELOG.md
new file mode 100644
index 0000000..695e884
--- /dev/null
+++ b/apps/react-vite-chakra-ui-example/CHANGELOG.md
@@ -0,0 +1,5 @@
+# @uberschrift/vite-chakra-ui-example
+
+## 1.0.0
+
+Initial release
diff --git a/apps/react-vite-chakra-ui-example/package.json b/apps/react-vite-chakra-ui-example/package.json
index 273e686..f70307a 100644
--- a/apps/react-vite-chakra-ui-example/package.json
+++ b/apps/react-vite-chakra-ui-example/package.json
@@ -1,7 +1,7 @@
{
"name": "@uberschrift/vite-chakra-ui-example",
"private": true,
- "version": "0.0.0",
+ "version": "1.0.0",
"type": "module",
"scripts": {
"dev": "vite",
diff --git a/apps/react-vite-example/CHANGELOG.md b/apps/react-vite-example/CHANGELOG.md
new file mode 100644
index 0000000..a835523
--- /dev/null
+++ b/apps/react-vite-example/CHANGELOG.md
@@ -0,0 +1,5 @@
+# @uberschrift/vite-example
+
+## 1.0.0
+
+Initial release
diff --git a/apps/react-vite-example/package.json b/apps/react-vite-example/package.json
index a68f07a..b8b4cdc 100644
--- a/apps/react-vite-example/package.json
+++ b/apps/react-vite-example/package.json
@@ -1,7 +1,7 @@
{
"name": "@uberschrift/vite-example",
"private": true,
- "version": "0.0.0",
+ "version": "1.0.0",
"type": "module",
"scripts": {
"dev": "vite",
diff --git a/apps/react-vite-mui-example/CHANGELOG.md b/apps/react-vite-mui-example/CHANGELOG.md
new file mode 100644
index 0000000..cbb58a7
--- /dev/null
+++ b/apps/react-vite-mui-example/CHANGELOG.md
@@ -0,0 +1,5 @@
+# @uberschrift/vite-mui-example
+
+## 1.0.0
+
+Initial release
diff --git a/apps/react-vite-mui-example/package.json b/apps/react-vite-mui-example/package.json
index a25fab6..d0d1aaa 100644
--- a/apps/react-vite-mui-example/package.json
+++ b/apps/react-vite-mui-example/package.json
@@ -1,7 +1,7 @@
{
"name": "@uberschrift/vite-mui-example",
"private": true,
- "version": "0.0.0",
+ "version": "1.0.0",
"type": "module",
"scripts": {
"dev": "vite",
diff --git a/apps/vue-vite-example/CHANGELOG.md b/apps/vue-vite-example/CHANGELOG.md
new file mode 100644
index 0000000..4fec322
--- /dev/null
+++ b/apps/vue-vite-example/CHANGELOG.md
@@ -0,0 +1,5 @@
+# vue-vite-example
+
+## 1.0.0
+
+Initial release
diff --git a/apps/vue-vite-example/package.json b/apps/vue-vite-example/package.json
index e031bcf..0fc4824 100644
--- a/apps/vue-vite-example/package.json
+++ b/apps/vue-vite-example/package.json
@@ -1,7 +1,7 @@
{
"name": "vue-vite-example",
"private": true,
- "version": "0.0.0",
+ "version": "1.0.0",
"type": "module",
"scripts": {
"dev": "vite",
diff --git a/packages/eslint-config/CHANGELOG.md b/packages/eslint-config/CHANGELOG.md
new file mode 100644
index 0000000..96e2c38
--- /dev/null
+++ b/packages/eslint-config/CHANGELOG.md
@@ -0,0 +1,9 @@
+# @uberschrift/eslint-config
+
+## 2.0.0
+
+Include vueberschrift
+
+## 1.0.0
+
+Initial release
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
index 0828f5f..c2a92ee 100644
--- a/packages/eslint-config/package.json
+++ b/packages/eslint-config/package.json
@@ -1,6 +1,6 @@
{
"name": "@uberschrift/eslint-config",
- "version": "0.0.0",
+ "version": "2.0.0",
"files": [
"library.js"
],
diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
new file mode 100644
index 0000000..5aaf0b2
--- /dev/null
+++ b/packages/react/CHANGELOG.md
@@ -0,0 +1,9 @@
+# uberschrift
+
+## 1.0.0โ1.1.11
+
+Changelog is lost :(
+
+## 1.0.0
+
+Initial release
diff --git a/packages/react/package.json b/packages/react/package.json
index 16828c3..475337b 100644
--- a/packages/react/package.json
+++ b/packages/react/package.json
@@ -1,6 +1,6 @@
{
"name": "uberschrift",
- "version": "0.0.0",
+ "version": "1.1.11",
"type": "module",
"sideEffects": false,
"main": "./dist/index.js",
@@ -21,7 +21,7 @@
"build": "tsup src/index.ts --dts --clean --format cjs,esm",
"dev": "npm run build -- --watch",
"prepublish": "npm run build",
- "release": "npm publish",
+ "release": "npm publish --dry-run",
"start": "npm run dev",
"test": "run-p test:*",
"test:lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
diff --git a/packages/tsconfig/CHANGELOG.md b/packages/tsconfig/CHANGELOG.md
new file mode 100644
index 0000000..026b1d8
--- /dev/null
+++ b/packages/tsconfig/CHANGELOG.md
@@ -0,0 +1,9 @@
+# @uberschrift/tsconfig
+
+## 2.0.0
+
+Include vueberschrift
+
+## 1.0.0
+
+Initial release
diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json
index 2e79dc3..6f1772c 100644
--- a/packages/tsconfig/package.json
+++ b/packages/tsconfig/package.json
@@ -1,6 +1,6 @@
{
"name": "@uberschrift/tsconfig",
- "version": "0.0.0",
+ "version": "2.0.0",
"license": "MIT",
"publishConfig": {
"access": "public"
diff --git a/packages/vue/CHANGELOG.md b/packages/vue/CHANGELOG.md
new file mode 100644
index 0000000..4f3a763
--- /dev/null
+++ b/packages/vue/CHANGELOG.md
@@ -0,0 +1,10 @@
+# vueberschrift
+
+## 0.1.0
+
+### Minor Changes
+
+- fd6debf: Substantial eco system changes:
+
+ - add vueberschrift package for Vue.js
+ - Make use of changesets
diff --git a/packages/vue/package.json b/packages/vue/package.json
index 37fc318..6837250 100644
--- a/packages/vue/package.json
+++ b/packages/vue/package.json
@@ -1,6 +1,6 @@
{
"name": "vueberschrift",
- "version": "0.0.0",
+ "version": "0.1.0",
"type": "module",
"sideEffects": false,
"main": "./dist/index.js",
@@ -21,7 +21,7 @@
"build": "vite build",
"dev": "vite dev",
"prepublish": "npm run build",
- "release": "npm publish",
+ "release": "npm publish --dry-run",
"start": "npm run dev",
"test": "run-p test:*",
"test:lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",