From: Eduardo San Martin Morote Date: Thu, 19 Aug 2021 08:15:13 +0000 (+0200) Subject: docs: refactor to package X-Git-Tag: @pinia/nuxt@0.0.1~15 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ee972227c9e23c4786fb57114d5d807503ebac50;p=thirdparty%2Fvuejs%2Fpinia.git docs: refactor to package --- diff --git a/netlify.toml b/netlify.toml index c3bc787a..64e4ae0a 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,5 +1,4 @@ [build] - command = "yarn run docs:build" - ignore = "./scripts/docs-check.sh" - publish = "docs/.vitepress/dist" - +command = "yarn run docs:build" +ignore = "./scripts/docs-check.sh" +publish = "packages/docs/.vitepress/dist" diff --git a/package.json b/package.json index 16ad8115..714abdec 100644 --- a/package.json +++ b/package.json @@ -8,6 +8,7 @@ "release": "node TODO: scripts/release.mjs", "size": "lerna run size", "build": "lerna run build --parallel", + "docs:build": "lerna run docs:build --scope @pinia/docs", "play": "lerna run play", "build:dts": "lerna run build:dts --parallel", "lint": "prettier -c --parser typescript \"packages/*/{src,__tests__,e2e}/**/*.[jt]s?(x)\"", diff --git a/packages/pinia/docs/.vitepress/components/HomeSponsors.vue b/packages/docs/.vitepress/components/HomeSponsors.vue similarity index 100% rename from packages/pinia/docs/.vitepress/components/HomeSponsors.vue rename to packages/docs/.vitepress/components/HomeSponsors.vue diff --git a/packages/pinia/docs/.vitepress/components/HomeSponsorsGroup.vue b/packages/docs/.vitepress/components/HomeSponsorsGroup.vue similarity index 100% rename from packages/pinia/docs/.vitepress/components/HomeSponsorsGroup.vue rename to packages/docs/.vitepress/components/HomeSponsorsGroup.vue diff --git a/packages/pinia/docs/.vitepress/components/PiniaLogo.vue b/packages/docs/.vitepress/components/PiniaLogo.vue similarity index 100% rename from packages/pinia/docs/.vitepress/components/PiniaLogo.vue rename to packages/docs/.vitepress/components/PiniaLogo.vue diff --git a/packages/pinia/docs/.vitepress/components/ThemeToggle.vue b/packages/docs/.vitepress/components/ThemeToggle.vue similarity index 100% rename from packages/pinia/docs/.vitepress/components/ThemeToggle.vue rename to packages/docs/.vitepress/components/ThemeToggle.vue diff --git a/packages/pinia/docs/.vitepress/components/sponsors.json b/packages/docs/.vitepress/components/sponsors.json similarity index 100% rename from packages/pinia/docs/.vitepress/components/sponsors.json rename to packages/docs/.vitepress/components/sponsors.json diff --git a/packages/pinia/docs/.vitepress/config.js b/packages/docs/.vitepress/config.js similarity index 100% rename from packages/pinia/docs/.vitepress/config.js rename to packages/docs/.vitepress/config.js diff --git a/packages/pinia/docs/.vitepress/darkModeFix.js b/packages/docs/.vitepress/darkModeFix.js similarity index 100% rename from packages/pinia/docs/.vitepress/darkModeFix.js rename to packages/docs/.vitepress/darkModeFix.js diff --git a/packages/pinia/docs/.vitepress/theme/Layout.ts b/packages/docs/.vitepress/theme/Layout.ts similarity index 100% rename from packages/pinia/docs/.vitepress/theme/Layout.ts rename to packages/docs/.vitepress/theme/Layout.ts diff --git a/packages/pinia/docs/.vitepress/theme/code-theme.css b/packages/docs/.vitepress/theme/code-theme.css similarity index 100% rename from packages/pinia/docs/.vitepress/theme/code-theme.css rename to packages/docs/.vitepress/theme/code-theme.css diff --git a/packages/pinia/docs/.vitepress/theme/custom.css b/packages/docs/.vitepress/theme/custom.css similarity index 100% rename from packages/pinia/docs/.vitepress/theme/custom.css rename to packages/docs/.vitepress/theme/custom.css diff --git a/packages/pinia/docs/.vitepress/theme/dark-theme.ts b/packages/docs/.vitepress/theme/dark-theme.ts similarity index 100% rename from packages/pinia/docs/.vitepress/theme/dark-theme.ts rename to packages/docs/.vitepress/theme/dark-theme.ts diff --git a/packages/pinia/docs/.vitepress/theme/index.js b/packages/docs/.vitepress/theme/index.js similarity index 100% rename from packages/pinia/docs/.vitepress/theme/index.js rename to packages/docs/.vitepress/theme/index.js diff --git a/packages/pinia/docs/.vitepress/theme/sponsors.css b/packages/docs/.vitepress/theme/sponsors.css similarity index 100% rename from packages/pinia/docs/.vitepress/theme/sponsors.css rename to packages/docs/.vitepress/theme/sponsors.css diff --git a/packages/pinia/docs/cookbook/composing-stores.md b/packages/docs/cookbook/composing-stores.md similarity index 100% rename from packages/pinia/docs/cookbook/composing-stores.md rename to packages/docs/cookbook/composing-stores.md diff --git a/packages/pinia/docs/cookbook/hot-module-replacement.md b/packages/docs/cookbook/hot-module-replacement.md similarity index 100% rename from packages/pinia/docs/cookbook/hot-module-replacement.md rename to packages/docs/cookbook/hot-module-replacement.md diff --git a/packages/pinia/docs/cookbook/index.md b/packages/docs/cookbook/index.md similarity index 100% rename from packages/pinia/docs/cookbook/index.md rename to packages/docs/cookbook/index.md diff --git a/packages/pinia/docs/cookbook/migration-0-0-7.md b/packages/docs/cookbook/migration-0-0-7.md similarity index 100% rename from packages/pinia/docs/cookbook/migration-0-0-7.md rename to packages/docs/cookbook/migration-0-0-7.md diff --git a/packages/pinia/docs/cookbook/options-api.md b/packages/docs/cookbook/options-api.md similarity index 100% rename from packages/pinia/docs/cookbook/options-api.md rename to packages/docs/cookbook/options-api.md diff --git a/packages/pinia/docs/cookbook/testing.md b/packages/docs/cookbook/testing.md similarity index 100% rename from packages/pinia/docs/cookbook/testing.md rename to packages/docs/cookbook/testing.md diff --git a/packages/pinia/docs/core-concepts/actions.md b/packages/docs/core-concepts/actions.md similarity index 100% rename from packages/pinia/docs/core-concepts/actions.md rename to packages/docs/core-concepts/actions.md diff --git a/packages/pinia/docs/core-concepts/getters.md b/packages/docs/core-concepts/getters.md similarity index 100% rename from packages/pinia/docs/core-concepts/getters.md rename to packages/docs/core-concepts/getters.md diff --git a/packages/pinia/docs/core-concepts/index.md b/packages/docs/core-concepts/index.md similarity index 100% rename from packages/pinia/docs/core-concepts/index.md rename to packages/docs/core-concepts/index.md diff --git a/packages/pinia/docs/core-concepts/outside-component-usage.md b/packages/docs/core-concepts/outside-component-usage.md similarity index 100% rename from packages/pinia/docs/core-concepts/outside-component-usage.md rename to packages/docs/core-concepts/outside-component-usage.md diff --git a/packages/pinia/docs/core-concepts/plugins.md b/packages/docs/core-concepts/plugins.md similarity index 100% rename from packages/pinia/docs/core-concepts/plugins.md rename to packages/docs/core-concepts/plugins.md diff --git a/packages/pinia/docs/core-concepts/state.md b/packages/docs/core-concepts/state.md similarity index 100% rename from packages/pinia/docs/core-concepts/state.md rename to packages/docs/core-concepts/state.md diff --git a/packages/pinia/docs/getting-started.md b/packages/docs/getting-started.md similarity index 100% rename from packages/pinia/docs/getting-started.md rename to packages/docs/getting-started.md diff --git a/packages/pinia/docs/index.md b/packages/docs/index.md similarity index 100% rename from packages/pinia/docs/index.md rename to packages/docs/index.md diff --git a/packages/pinia/docs/introduction.md b/packages/docs/introduction.md similarity index 100% rename from packages/pinia/docs/introduction.md rename to packages/docs/introduction.md diff --git a/packages/docs/package.json b/packages/docs/package.json new file mode 100644 index 00000000..90422d32 --- /dev/null +++ b/packages/docs/package.json @@ -0,0 +1,12 @@ +{ + "name": "@pinia/docs", + "version": "0.0.0", + "private": true, + "scripts": { + "docs": "vitepress dev .", + "docs:build": "vitepress build ." + }, + "dependencies": { + "vitepress": "^0.16.1" + } +} diff --git a/packages/pinia/docs/public/dank-mono.css b/packages/docs/public/dank-mono.css similarity index 100% rename from packages/pinia/docs/public/dank-mono.css rename to packages/docs/public/dank-mono.css diff --git a/packages/pinia/docs/public/logo.png b/packages/docs/public/logo.png similarity index 100% rename from packages/pinia/docs/public/logo.png rename to packages/docs/public/logo.png diff --git a/packages/pinia/docs/public/logo.svg b/packages/docs/public/logo.svg similarity index 100% rename from packages/pinia/docs/public/logo.svg rename to packages/docs/public/logo.svg diff --git a/packages/pinia/docs/public/social.png b/packages/docs/public/social.png similarity index 100% rename from packages/pinia/docs/public/social.png rename to packages/docs/public/social.png diff --git a/packages/pinia/docs/public/sponsors/logo.svg b/packages/docs/public/sponsors/logo.svg similarity index 100% rename from packages/pinia/docs/public/sponsors/logo.svg rename to packages/docs/public/sponsors/logo.svg diff --git a/packages/pinia/docs/public/sponsors/passionate-people-dark.svg b/packages/docs/public/sponsors/passionate-people-dark.svg similarity index 100% rename from packages/pinia/docs/public/sponsors/passionate-people-dark.svg rename to packages/docs/public/sponsors/passionate-people-dark.svg diff --git a/packages/pinia/docs/public/sponsors/passionate-people-light.svg b/packages/docs/public/sponsors/passionate-people-light.svg similarity index 100% rename from packages/pinia/docs/public/sponsors/passionate-people-light.svg rename to packages/docs/public/sponsors/passionate-people-light.svg diff --git a/packages/pinia/docs/public/sponsors/vuejobs.svg b/packages/docs/public/sponsors/vuejobs.svg similarity index 100% rename from packages/pinia/docs/public/sponsors/vuejobs.svg rename to packages/docs/public/sponsors/vuejobs.svg diff --git a/packages/pinia/docs/public/sponsors/vuetify-logo-dark-text.svg b/packages/docs/public/sponsors/vuetify-logo-dark-text.svg similarity index 100% rename from packages/pinia/docs/public/sponsors/vuetify-logo-dark-text.svg rename to packages/docs/public/sponsors/vuetify-logo-dark-text.svg diff --git a/packages/pinia/docs/public/sponsors/vuetify-logo-light-text.svg b/packages/docs/public/sponsors/vuetify-logo-light-text.svg similarity index 100% rename from packages/pinia/docs/public/sponsors/vuetify-logo-light-text.svg rename to packages/docs/public/sponsors/vuetify-logo-light-text.svg diff --git a/packages/pinia/docs/ssr/index.md b/packages/docs/ssr/index.md similarity index 100% rename from packages/pinia/docs/ssr/index.md rename to packages/docs/ssr/index.md diff --git a/packages/pinia/docs/ssr/nuxt.md b/packages/docs/ssr/nuxt.md similarity index 100% rename from packages/pinia/docs/ssr/nuxt.md rename to packages/docs/ssr/nuxt.md diff --git a/packages/docs/vite.config.ts b/packages/docs/vite.config.ts new file mode 100644 index 00000000..ec28b489 --- /dev/null +++ b/packages/docs/vite.config.ts @@ -0,0 +1,37 @@ +import { defineConfig, Plugin } from 'vite' +import _fs from 'fs' +import path from 'path' + +const fs = _fs.promises + +export default defineConfig({ + plugins: [copyPiniaPlugin()], + define: { + __DEV__: 'true', + __BROWSER__: 'true', + }, + optimizeDeps: { + exclude: ['vue-demi', '@vueuse/shared', '@vueuse/core', 'pinia'], + }, +}) + +function copyPiniaPlugin(): Plugin { + return { + name: 'copy-pinia', + async generateBundle() { + const filePath = path.resolve( + __dirname, + '../pinia/dist/pinia.esm-bundler.js' + ) + + // throws if file doesn't exist + await fs.access(filePath) + + this.emitFile({ + type: 'asset', + fileName: 'pinia.esm-bundler.js', + source: await fs.readFile(filePath, 'utf-8'), + }) + }, + } +} diff --git a/packages/pinia/docs/vite.config.js b/packages/pinia/docs/vite.config.js deleted file mode 100644 index becea3ab..00000000 --- a/packages/pinia/docs/vite.config.js +++ /dev/null @@ -1,12 +0,0 @@ -import { defineConfig } from 'vite' - -// touched -export default defineConfig({ - define: { - __DEV__: 'true', - __BROWSER__: 'true', - }, - optimizeDeps: { - exclude: ['vue-demi', '@vueuse/shared', '@vueuse/core'], - }, -}) diff --git a/packages/pinia/package.json b/packages/pinia/package.json index c4df7c56..332da823 100644 --- a/packages/pinia/package.json +++ b/packages/pinia/package.json @@ -23,8 +23,6 @@ }, "funding": "https://github.com/sponsors/posva", "scripts": { - "docs": "vitepress dev docs", - "docs:build": "vitepress build docs", "build": "rimraf dist && rollup -c ../../rollup.config.js --environment TARGET:pinia", "build:dts": "api-extractor run --local --verbose", "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s --commit-path . -l pinia -r 1", @@ -64,7 +62,6 @@ "@vue/compiler-sfc": "^3.2.2", "@vue/server-renderer": "^3.2.2", "@vue/test-utils": "^2.0.0-rc.12", - "vitepress": "^0.16.1", "vue": "^3.2.2", "vue2": "npm:vue@2" }, diff --git a/scripts/docs-check.sh b/scripts/docs-check.sh index 9a20a53d..6ba200d5 100755 --- a/scripts/docs-check.sh +++ b/scripts/docs-check.sh @@ -3,4 +3,4 @@ # check if doc files changes for netlify # needed because we cannot use && in netlify.toml -git diff --quiet 'HEAD^' HEAD ./docs/ && ! git diff 'HEAD^' HEAD ./yarn.lock | grep --quiet vite && git diff --quiet 'HEAD^' HEAD netlify.toml +git diff --quiet 'HEAD^' HEAD ./packages/docs/ && ! git diff 'HEAD^' HEAD ./yarn.lock | grep --quiet vite && git diff --quiet 'HEAD^' HEAD netlify.toml