diff --git a/README.md b/README.md deleted file mode 120000 index 7bdb3899..00000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -vike-vue/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..21893293 --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +[](https://vike.dev) + +# `vike-{vue,pinia}` + +Vue-related integrations for [Vike](https://vike.dev): + +- [`vike-vue`](packages/vike-vue/) +- [`vike-pinia`](packages/vike-pinia/) + +> See also other [Vike extensions](https://vike.dev/vike-packages). diff --git a/package.json b/package.json index 58903e71..627c88e1 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,11 @@ { "scripts": { - "dev": "cd vike-vue/ && pnpm run dev", - "build": "cd vike-vue/ && pnpm run build && cd ../packages/vike-pinia/ && pnpm run build", - "release": "cd vike-vue/ && pnpm run release", + "========= Basics": "", + "dev": "cd ./packages/vike-vue/ && pnpm run dev", + "build": "pnpm --recursive --filter {packages/*} run build", + "========= Release": "", + "release": "cd ./packages/vike-vue/ && pnpm run release", + "release:commit": "cd ./packages/vike-vue/ && pnpm run release:commit", "========= Clean": "", "clean": "git clean -Xdf", "reset": "pnpm run clean && pnpm install && pnpm run build", diff --git a/packages/vike-pinia/package.json b/packages/vike-pinia/package.json index 6dc4aca9..bd7af774 100644 --- a/packages/vike-pinia/package.json +++ b/packages/vike-pinia/package.json @@ -8,7 +8,9 @@ "scripts": { "dev": "tsc --watch", "build": "rm -rf dist && tsc", - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "release": "release-me --git-prefix vike-pinia --changelog-dir packages/vike-pinia/ patch", + "release:commit": "release-me --git-prefix vike-pinia --changelog-dir packages/vike-pinia/ commit" }, "exports": { ".": "./dist/+config.js", diff --git a/vike-vue/.gitignore b/packages/vike-vue/.gitignore similarity index 100% rename from vike-vue/.gitignore rename to packages/vike-vue/.gitignore diff --git a/CHANGELOG.md b/packages/vike-vue/CHANGELOG.md similarity index 100% rename from CHANGELOG.md rename to packages/vike-vue/CHANGELOG.md diff --git a/CONTRIBUTING.md b/packages/vike-vue/CONTRIBUTING.md similarity index 56% rename from CONTRIBUTING.md rename to packages/vike-vue/CONTRIBUTING.md index 8f937dad..32c6f2c9 100644 --- a/CONTRIBUTING.md +++ b/packages/vike-vue/CONTRIBUTING.md @@ -6,9 +6,9 @@ Build `vike-vue`: ```bash git clone git@github.com:vikejs/vike-vue -cd vike-vue/ && pnpm install +cd vike-vue/ +pnpm install pnpm build -cd ../ ``` > Note that you'll need [pnpm](https://pnpm.io/) for development, which you can install with `$ npm install -g pnpm`. @@ -29,14 +29,12 @@ cd ../../ ## Releasing -Choose the next version number according to the rules of -[Semantic Versioning](https://semver.org/). Let's assume you are releasing -version `1.2.3`, run: +In order to release the next patch version (`MAJOR.MINOR.PATCH`, see [Semantic Versioning](https://semver.org/)), run: ```bash -cd vike-vue/ -pnpm exec release-me v1.2.3 -cd ../ +cd packages/vike-vue/ +pnpm release +cd ../../ ``` This will: @@ -44,10 +42,12 @@ This will: - update the version number and dependencies in `package.json`, - extend [`CHANGELOG.md`](CHANGELOG.md), - update the `pnpm-lock.yaml` file, -- create a `release: v1.2.3` git commit and push it, -- create a `v1.2.3` git tag and push it, +- create a `release: vike-vue@1.2.3` git commit and push it, +- create a `vike-vue@1.2.3` git tag and push it, - build the package and publish it to npm. -Extend [`CHANGELOG.md`](CHANGELOG.md) if anything is missing, as the release -script only picks up commits -[that match the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes"](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli). +Extend [`CHANGELOG.md`](CHANGELOG.md) if anything is missing, as the release script: + +- only picks up commits + [that match the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes"](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli), +- mistakenly picks up commits touching all packages in this monorepo, not only `vike-vue`. diff --git a/vike-vue/README.md b/packages/vike-vue/README.md similarity index 100% rename from vike-vue/README.md rename to packages/vike-vue/README.md diff --git a/vike-vue/components/ClientOnly.vue b/packages/vike-vue/components/ClientOnly.vue similarity index 100% rename from vike-vue/components/ClientOnly.vue rename to packages/vike-vue/components/ClientOnly.vue diff --git a/vike-vue/components/useData.ts b/packages/vike-vue/components/useData.ts similarity index 100% rename from vike-vue/components/useData.ts rename to packages/vike-vue/components/useData.ts diff --git a/vike-vue/components/usePageContext.ts b/packages/vike-vue/components/usePageContext.ts similarity index 100% rename from vike-vue/components/usePageContext.ts rename to packages/vike-vue/components/usePageContext.ts diff --git a/vike-vue/package.json b/packages/vike-vue/package.json similarity index 88% rename from vike-vue/package.json rename to packages/vike-vue/package.json index 0a7dbf98..6423aba7 100644 --- a/vike-vue/package.json +++ b/packages/vike-vue/package.json @@ -16,7 +16,8 @@ "scripts": { "dev": "vite build --watch", "build": "rm -rf dist/ && vite build", - "release": "release-me patch" + "release": "release-me --git-prefix vike-vue --changelog-dir packages/vike-vue/ patch", + "release:commit": "release-me --git-prefix vike-vue --changelog-dir packages/vike-vue/ commit" }, "peerDependencies": { "vike": "^0.4.152", diff --git a/vike-vue/renderer/+config.ts b/packages/vike-vue/renderer/+config.ts similarity index 100% rename from vike-vue/renderer/+config.ts rename to packages/vike-vue/renderer/+config.ts diff --git a/vike-vue/renderer/app.ts b/packages/vike-vue/renderer/app.ts similarity index 100% rename from vike-vue/renderer/app.ts rename to packages/vike-vue/renderer/app.ts diff --git a/vike-vue/renderer/getLang.ts b/packages/vike-vue/renderer/getLang.ts similarity index 100% rename from vike-vue/renderer/getLang.ts rename to packages/vike-vue/renderer/getLang.ts diff --git a/vike-vue/renderer/getTitle.ts b/packages/vike-vue/renderer/getTitle.ts similarity index 100% rename from vike-vue/renderer/getTitle.ts rename to packages/vike-vue/renderer/getTitle.ts diff --git a/vike-vue/renderer/onRenderClient.ts b/packages/vike-vue/renderer/onRenderClient.ts similarity index 100% rename from vike-vue/renderer/onRenderClient.ts rename to packages/vike-vue/renderer/onRenderClient.ts diff --git a/vike-vue/renderer/onRenderHtml.ts b/packages/vike-vue/renderer/onRenderHtml.ts similarity index 100% rename from vike-vue/renderer/onRenderHtml.ts rename to packages/vike-vue/renderer/onRenderHtml.ts diff --git a/vike-vue/renderer/types.ts b/packages/vike-vue/renderer/types.ts similarity index 100% rename from vike-vue/renderer/types.ts rename to packages/vike-vue/renderer/types.ts diff --git a/vike-vue/renderer/utils/getGlobalObject.ts b/packages/vike-vue/renderer/utils/getGlobalObject.ts similarity index 100% rename from vike-vue/renderer/utils/getGlobalObject.ts rename to packages/vike-vue/renderer/utils/getGlobalObject.ts diff --git a/vike-vue/renderer/utils/isCallable.ts b/packages/vike-vue/renderer/utils/isCallable.ts similarity index 100% rename from vike-vue/renderer/utils/isCallable.ts rename to packages/vike-vue/renderer/utils/isCallable.ts diff --git a/vike-vue/tsconfig.json b/packages/vike-vue/tsconfig.json similarity index 100% rename from vike-vue/tsconfig.json rename to packages/vike-vue/tsconfig.json diff --git a/vike-vue/types.d.ts b/packages/vike-vue/types.d.ts similarity index 100% rename from vike-vue/types.d.ts rename to packages/vike-vue/types.d.ts diff --git a/vike-vue/utils/assert.ts b/packages/vike-vue/utils/assert.ts similarity index 100% rename from vike-vue/utils/assert.ts rename to packages/vike-vue/utils/assert.ts diff --git a/vike-vue/utils/objectAssign.ts b/packages/vike-vue/utils/objectAssign.ts similarity index 100% rename from vike-vue/utils/objectAssign.ts rename to packages/vike-vue/utils/objectAssign.ts diff --git a/vike-vue/vite.config.ts b/packages/vike-vue/vite.config.ts similarity index 100% rename from vike-vue/vite.config.ts rename to packages/vike-vue/vite.config.ts