From 7c2b400a1132cfb8d5f634d1ba43111a2c668281 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Tue, 25 Oct 2022 23:51:25 +0530 Subject: [PATCH 01/20] docs: add banner to next docs --- docs/.vitepress/components/Banner.vue | 50 +++++++ docs/.vitepress/components/shims.d.ts | 5 + docs/.vitepress/theme/index.ts | 11 +- package.json | 6 +- pnpm-lock.yaml | 207 ++++++++++++++------------ 5 files changed, 179 insertions(+), 100 deletions(-) create mode 100644 docs/.vitepress/components/Banner.vue create mode 100644 docs/.vitepress/components/shims.d.ts diff --git a/docs/.vitepress/components/Banner.vue b/docs/.vitepress/components/Banner.vue new file mode 100644 index 00000000000..1c9872a12bd --- /dev/null +++ b/docs/.vitepress/components/Banner.vue @@ -0,0 +1,50 @@ + + + + + + + diff --git a/docs/.vitepress/components/shims.d.ts b/docs/.vitepress/components/shims.d.ts new file mode 100644 index 00000000000..d1f31331283 --- /dev/null +++ b/docs/.vitepress/components/shims.d.ts @@ -0,0 +1,5 @@ +declare module '*.vue' { + import type { DefineComponent } from 'vue'; + const component: DefineComponent; + export default component; +} diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index 2423da6bf18..ae429b9dcfc 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,4 +1,13 @@ import DefaultTheme from 'vitepress/theme'; +import { h } from 'vue'; +import Banner from '../components/Banner.vue'; import './index.css'; -export default DefaultTheme; +export default { + ...DefaultTheme, + Layout() { + return h(DefaultTheme.Layout, null, { + 'layout-top': () => h(Banner), + }); + }, +}; diff --git a/package.json b/package.json index 2a83079484d..13f0a1c4987 100644 --- a/package.json +++ b/package.json @@ -107,6 +107,7 @@ "@typescript-eslint/parser": "~5.40.1", "@vitest/coverage-c8": "~0.24.3", "@vitest/ui": "~0.24.3", + "@vueuse/core": "~9.4.0", "c8": "~7.12.0", "conventional-changelog-cli": "~2.2.2", "cypress": "~10.10.0", @@ -137,8 +138,9 @@ "typescript": "~4.8.4", "validator": "~13.7.0", "vite": "~3.1.8", - "vitepress": "1.0.0-alpha.22", - "vitest": "~0.24.3" + "vitepress": "1.0.0-alpha.25", + "vitest": "~0.24.3", + "vue": "~3.2.41" }, "packageManager": "pnpm@7.14.0", "engines": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7551fe2c0d4..e48652aa6a9 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -15,6 +15,7 @@ specifiers: '@typescript-eslint/parser': ~5.40.1 '@vitest/coverage-c8': ~0.24.3 '@vitest/ui': ~0.24.3 + '@vueuse/core': ~9.4.0 c8: ~7.12.0 conventional-changelog-cli: ~2.2.2 cypress: ~10.10.0 @@ -45,8 +46,9 @@ specifiers: typescript: ~4.8.4 validator: ~13.7.0 vite: ~3.1.8 - vitepress: 1.0.0-alpha.22 + vitepress: 1.0.0-alpha.25 vitest: ~0.24.3 + vue: ~3.2.41 devDependencies: '@actions/github': 5.1.1 @@ -63,6 +65,7 @@ devDependencies: '@typescript-eslint/parser': 5.40.1_wyqvi574yv7oiwfeinomdzmc3m '@vitest/coverage-c8': 0.24.3_@vitest+ui@0.24.3 '@vitest/ui': 0.24.3 + '@vueuse/core': 9.4.0_vue@3.2.41 c8: 7.12.0 conventional-changelog-cli: 2.2.2 cypress: 10.10.0 @@ -93,8 +96,9 @@ devDependencies: typescript: 4.8.4 validator: 13.7.0 vite: 3.1.8 - vitepress: 1.0.0-alpha.22_7s2zbo6pukdbh3jcjyutgyfrd4 + vitepress: 1.0.0-alpha.25_7s2zbo6pukdbh3jcjyutgyfrd4 vitest: 0.24.3_@vitest+ui@0.24.3 + vue: 3.2.41 packages: @@ -115,25 +119,25 @@ packages: tunnel: 0.0.6 dev: true - /@algolia/autocomplete-core/1.7.1: - resolution: {integrity: sha512-eiZw+fxMzNQn01S8dA/hcCpoWCOCwcIIEUtHHdzN5TGB3IpzLbuhqFeTfh2OUhhgkE8Uo17+wH+QJ/wYyQmmzg==} + /@algolia/autocomplete-core/1.7.2: + resolution: {integrity: sha512-eclwUDC6qfApNnEfu1uWcL/rudQsn59tjEoUYZYE2JSXZrHLRjBUGMxiCoknobU2Pva8ejb0eRxpIYDtVVqdsw==} dependencies: - '@algolia/autocomplete-shared': 1.7.1 + '@algolia/autocomplete-shared': 1.7.2 dev: true - /@algolia/autocomplete-preset-algolia/1.7.1_qs6lk5nhygj2o3hj4sf6xnr724: - resolution: {integrity: sha512-pJwmIxeJCymU1M6cGujnaIYcY3QPOVYZOXhFkWVM7IxKzy272BwCvMFMyc5NpG/QmiObBxjo7myd060OeTNJXg==} + /@algolia/autocomplete-preset-algolia/1.7.2_qs6lk5nhygj2o3hj4sf6xnr724: + resolution: {integrity: sha512-+RYEG6B0QiGGfRb2G3MtPfyrl0dALF3cQNTWBzBX6p5o01vCCGTTinAm2UKG3tfc2CnOMAtnPLkzNZyJUpnVJw==} peerDependencies: - '@algolia/client-search': ^4.9.1 - algoliasearch: ^4.9.1 + '@algolia/client-search': '>= 4.9.1 < 6' + algoliasearch: '>= 4.9.1 < 6' dependencies: - '@algolia/autocomplete-shared': 1.7.1 + '@algolia/autocomplete-shared': 1.7.2 '@algolia/client-search': 4.14.2 algoliasearch: 4.14.2 dev: true - /@algolia/autocomplete-shared/1.7.1: - resolution: {integrity: sha512-eTmGVqY3GeyBTT8IWiB2K5EuURAqhnumfktAEoHxfDY2o7vg2rSnO16ZtIG0fMgt3py28Vwgq42/bVEuaQV7pg==} + /@algolia/autocomplete-shared/1.7.2: + resolution: {integrity: sha512-QCckjiC7xXHIUaIL3ektBtjJ0w7tTA3iqKcAE/Hjn1lZ5omp7i3Y4e09rAr9ZybqirL7AbxCLLq0Ra5DDPKeug==} dev: true /@algolia/cache-browser-local-storage/4.14.2: @@ -313,14 +317,14 @@ packages: - supports-color dev: true - /@docsearch/css/3.2.1: - resolution: {integrity: sha512-gaP6TxxwQC+K8D6TRx5WULUWKrcbzECOPA2KCVMuI+6C7dNiGUk5yXXzVhc5sld79XKYLnO9DRTI4mjXDYkh+g==} + /@docsearch/css/3.3.0: + resolution: {integrity: sha512-rODCdDtGyudLj+Va8b6w6Y85KE85bXRsps/R4Yjwt5vueXKXZQKYw0aA9knxLBT6a/bI/GMrAcmCR75KYOM6hg==} dev: true - /@docsearch/js/3.2.1_7s2zbo6pukdbh3jcjyutgyfrd4: - resolution: {integrity: sha512-H1PekEtSeS0msetR2YGGey2w7jQ2wAKfGODJvQTygSwMgUZ+2DHpzUgeDyEBIXRIfaBcoQneqrzsljM62pm6Xg==} + /@docsearch/js/3.3.0_7s2zbo6pukdbh3jcjyutgyfrd4: + resolution: {integrity: sha512-oFXWRPNvPxAzBhnFJ9UCFIYZiQNc3Yrv6912nZHw/UIGxsyzKpNRZgHq8HDk1niYmOSoLKtVFcxkccpQmYGFyg==} dependencies: - '@docsearch/react': 3.2.1_7s2zbo6pukdbh3jcjyutgyfrd4 + '@docsearch/react': 3.3.0_7s2zbo6pukdbh3jcjyutgyfrd4 preact: 10.11.1 transitivePeerDependencies: - '@algolia/client-search' @@ -329,8 +333,8 @@ packages: - react-dom dev: true - /@docsearch/react/3.2.1_7s2zbo6pukdbh3jcjyutgyfrd4: - resolution: {integrity: sha512-EzTQ/y82s14IQC5XVestiK/kFFMe2aagoYFuTAIfIb/e+4FU7kSMKonRtLwsCiLQHmjvNQq+HO+33giJ5YVtaQ==} + /@docsearch/react/3.3.0_7s2zbo6pukdbh3jcjyutgyfrd4: + resolution: {integrity: sha512-fhS5adZkae2SSdMYEMVg6pxI5a/cE+tW16ki1V0/ur4Fdok3hBRkmN/H8VvlXnxzggkQIIRIVvYPn00JPjen3A==} peerDependencies: '@types/react': '>= 16.8.0 < 19.0.0' react: '>= 16.8.0 < 19.0.0' @@ -343,9 +347,9 @@ packages: react-dom: optional: true dependencies: - '@algolia/autocomplete-core': 1.7.1 - '@algolia/autocomplete-preset-algolia': 1.7.1_qs6lk5nhygj2o3hj4sf6xnr724 - '@docsearch/css': 3.2.1 + '@algolia/autocomplete-core': 1.7.2 + '@algolia/autocomplete-preset-algolia': 1.7.2_qs6lk5nhygj2o3hj4sf6xnr724 + '@docsearch/css': 3.3.0 '@types/react': 18.0.22 algoliasearch: 4.14.2 react: 18.2.0 @@ -680,8 +684,8 @@ packages: resolution: {integrity: sha512-y5KJ1PjGXPpU4CZ7lThDu31s+FqvzhqwMOR6Go/x6xaQMFjgzwfzfOvCwABsylr/5n8sB1qFQm1Vi7TaCB8P+A==} dev: true - /@types/web-bluetooth/0.0.15: - resolution: {integrity: sha512-w7hEHXnPMEZ+4nGKl/KDRVpxkwYxYExuHOYXyzIzCDzEZ9ZCGMAewulr9IqJu2LR4N37fcnb1XVeuZ09qgOxhA==} + /@types/web-bluetooth/0.0.16: + resolution: {integrity: sha512-oh8q2Zc32S6gd/j50GowEjKLoOVOwHP/bWVjKJInBwQqdOYMdPrf1oVlelTlyfFK3CKxL1uahMDAr+vy8T7yMQ==} dev: true /@types/yauzl/2.10.0: @@ -820,7 +824,7 @@ packages: eslint-visitor-keys: 3.3.0 dev: true - /@vitejs/plugin-vue/3.1.2_vite@3.1.8+vue@3.2.40: + /@vitejs/plugin-vue/3.1.2_vite@3.1.8+vue@3.2.41: resolution: {integrity: sha512-3zxKNlvA3oNaKDYX0NBclgxTQ1xaFdL7PzwF6zj9tGFziKwmBa3Q/6XcJQxudlT81WxDjEhHmevvIC4Orc1LhQ==} engines: {node: ^14.18.0 || >=16.0.0} peerDependencies: @@ -828,7 +832,7 @@ packages: vue: ^3.2.25 dependencies: vite: 3.1.8 - vue: 3.2.40 + vue: 3.2.41 dev: true /@vitest/coverage-c8/0.24.3_@vitest+ui@0.24.3: @@ -855,113 +859,113 @@ packages: sirv: 2.0.2 dev: true - /@vue/compiler-core/3.2.40: - resolution: {integrity: sha512-2Dc3Stk0J/VyQ4OUr2yEC53kU28614lZS+bnrCbFSAIftBJ40g/2yQzf4mPBiFuqguMB7hyHaujdgZAQ67kZYA==} + /@vue/compiler-core/3.2.41: + resolution: {integrity: sha512-oA4mH6SA78DT+96/nsi4p9DX97PHcNROxs51lYk7gb9Z4BPKQ3Mh+BLn6CQZBw857Iuhu28BfMSRHAlPvD4vlw==} dependencies: '@babel/parser': 7.19.4 - '@vue/shared': 3.2.40 + '@vue/shared': 3.2.41 estree-walker: 2.0.2 source-map: 0.6.1 dev: true - /@vue/compiler-dom/3.2.40: - resolution: {integrity: sha512-OZCNyYVC2LQJy4H7h0o28rtk+4v+HMQygRTpmibGoG9wZyomQiS5otU7qo3Wlq5UfHDw2RFwxb9BJgKjVpjrQw==} + /@vue/compiler-dom/3.2.41: + resolution: {integrity: sha512-xe5TbbIsonjENxJsYRbDJvthzqxLNk+tb3d/c47zgREDa/PCp6/Y4gC/skM4H6PIuX5DAxm7fFJdbjjUH2QTMw==} dependencies: - '@vue/compiler-core': 3.2.40 - '@vue/shared': 3.2.40 + '@vue/compiler-core': 3.2.41 + '@vue/shared': 3.2.41 dev: true - /@vue/compiler-sfc/3.2.40: - resolution: {integrity: sha512-tzqwniIN1fu1PDHC3CpqY/dPCfN/RN1thpBC+g69kJcrl7mbGiHKNwbA6kJ3XKKy8R6JLKqcpVugqN4HkeBFFg==} + /@vue/compiler-sfc/3.2.41: + resolution: {integrity: sha512-+1P2m5kxOeaxVmJNXnBskAn3BenbTmbxBxWOtBq3mQTCokIreuMULFantBUclP0+KnzNCMOvcnKinqQZmiOF8w==} dependencies: '@babel/parser': 7.19.4 - '@vue/compiler-core': 3.2.40 - '@vue/compiler-dom': 3.2.40 - '@vue/compiler-ssr': 3.2.40 - '@vue/reactivity-transform': 3.2.40 - '@vue/shared': 3.2.40 + '@vue/compiler-core': 3.2.41 + '@vue/compiler-dom': 3.2.41 + '@vue/compiler-ssr': 3.2.41 + '@vue/reactivity-transform': 3.2.41 + '@vue/shared': 3.2.41 estree-walker: 2.0.2 magic-string: 0.25.9 postcss: 8.4.17 source-map: 0.6.1 dev: true - /@vue/compiler-ssr/3.2.40: - resolution: {integrity: sha512-80cQcgasKjrPPuKcxwuCx7feq+wC6oFl5YaKSee9pV3DNq+6fmCVwEEC3vvkf/E2aI76rIJSOYHsWSEIxK74oQ==} + /@vue/compiler-ssr/3.2.41: + resolution: {integrity: sha512-Y5wPiNIiaMz/sps8+DmhaKfDm1xgj6GrH99z4gq2LQenfVQcYXmHIOBcs5qPwl7jaW3SUQWjkAPKMfQemEQZwQ==} dependencies: - '@vue/compiler-dom': 3.2.40 - '@vue/shared': 3.2.40 + '@vue/compiler-dom': 3.2.41 + '@vue/shared': 3.2.41 dev: true - /@vue/devtools-api/6.4.4: - resolution: {integrity: sha512-Ku31WzpOV/8cruFaXaEZKF81WkNnvCSlBY4eOGtz5WMSdJvX1v1WWlSMGZeqUwPtQ27ZZz7B62erEMq8JDjcXw==} + /@vue/devtools-api/6.4.5: + resolution: {integrity: sha512-JD5fcdIuFxU4fQyXUu3w2KpAJHzTVdN+p4iOX2lMWSHMOoQdMAcpFLZzm9Z/2nmsoZ1a96QEhZ26e50xLBsgOQ==} dev: true - /@vue/reactivity-transform/3.2.40: - resolution: {integrity: sha512-HQUCVwEaacq6fGEsg2NUuGKIhUveMCjOk8jGHqLXPI2w6zFoPrlQhwWEaINTv5kkZDXKEnCijAp+4gNEHG03yw==} + /@vue/reactivity-transform/3.2.41: + resolution: {integrity: sha512-mK5+BNMsL4hHi+IR3Ft/ho6Za+L3FA5j8WvreJ7XzHrqkPq8jtF/SMo7tuc9gHjLDwKZX1nP1JQOKo9IEAn54A==} dependencies: '@babel/parser': 7.19.4 - '@vue/compiler-core': 3.2.40 - '@vue/shared': 3.2.40 + '@vue/compiler-core': 3.2.41 + '@vue/shared': 3.2.41 estree-walker: 2.0.2 magic-string: 0.25.9 dev: true - /@vue/reactivity/3.2.40: - resolution: {integrity: sha512-N9qgGLlZmtUBMHF9xDT4EkD9RdXde1Xbveb+niWMXuHVWQP5BzgRmE3SFyUBBcyayG4y1lhoz+lphGRRxxK4RA==} + /@vue/reactivity/3.2.41: + resolution: {integrity: sha512-9JvCnlj8uc5xRiQGZ28MKGjuCoPhhTwcoAdv3o31+cfGgonwdPNuvqAXLhlzu4zwqavFEG5tvaoINQEfxz+l6g==} dependencies: - '@vue/shared': 3.2.40 + '@vue/shared': 3.2.41 dev: true - /@vue/runtime-core/3.2.40: - resolution: {integrity: sha512-U1+rWf0H8xK8aBUZhnrN97yoZfHbjgw/bGUzfgKPJl69/mXDuSg8CbdBYBn6VVQdR947vWneQBFzdhasyzMUKg==} + /@vue/runtime-core/3.2.41: + resolution: {integrity: sha512-0LBBRwqnI0p4FgIkO9q2aJBBTKDSjzhnxrxHYengkAF6dMOjeAIZFDADAlcf2h3GDALWnblbeprYYpItiulSVQ==} dependencies: - '@vue/reactivity': 3.2.40 - '@vue/shared': 3.2.40 + '@vue/reactivity': 3.2.41 + '@vue/shared': 3.2.41 dev: true - /@vue/runtime-dom/3.2.40: - resolution: {integrity: sha512-AO2HMQ+0s2+MCec8hXAhxMgWhFhOPJ/CyRXnmTJ6XIOnJFLrH5Iq3TNwvVcODGR295jy77I6dWPj+wvFoSYaww==} + /@vue/runtime-dom/3.2.41: + resolution: {integrity: sha512-U7zYuR1NVIP8BL6jmOqmapRAHovEFp7CSw4pR2FacqewXNGqZaRfHoNLQsqQvVQ8yuZNZtxSZy0FFyC70YXPpA==} dependencies: - '@vue/runtime-core': 3.2.40 - '@vue/shared': 3.2.40 + '@vue/runtime-core': 3.2.41 + '@vue/shared': 3.2.41 csstype: 2.6.21 dev: true - /@vue/server-renderer/3.2.40_vue@3.2.40: - resolution: {integrity: sha512-gtUcpRwrXOJPJ4qyBpU3EyxQa4EkV8I4f8VrDePcGCPe4O/hd0BPS7v9OgjIQob6Ap8VDz9G+mGTKazE45/95w==} + /@vue/server-renderer/3.2.41_vue@3.2.41: + resolution: {integrity: sha512-7YHLkfJdTlsZTV0ae5sPwl9Gn/EGr2hrlbcS/8naXm2CDpnKUwC68i1wGlrYAfIgYWL7vUZwk2GkYLQH5CvFig==} peerDependencies: - vue: 3.2.40 + vue: 3.2.41 dependencies: - '@vue/compiler-ssr': 3.2.40 - '@vue/shared': 3.2.40 - vue: 3.2.40 + '@vue/compiler-ssr': 3.2.41 + '@vue/shared': 3.2.41 + vue: 3.2.41 dev: true - /@vue/shared/3.2.40: - resolution: {integrity: sha512-0PLQ6RUtZM0vO3teRfzGi4ltLUO5aO+kLgwh4Um3THSR03rpQWLTuRCkuO5A41ITzwdWeKdPHtSARuPkoo5pCQ==} + /@vue/shared/3.2.41: + resolution: {integrity: sha512-W9mfWLHmJhkfAmV+7gDjcHeAWALQtgGT3JErxULl0oz6R6+3ug91I7IErs93eCFhPCZPHBs4QJS7YWEV7A3sxw==} dev: true - /@vueuse/core/9.3.0_vue@3.2.40: - resolution: {integrity: sha512-64Rna8IQDWpdrJxgitDg7yv1yTp41ZmvV8zlLEylK4QQLWAhz1OFGZDPZ8bU4lwcGgbEJ2sGi2jrdNh4LttUSQ==} + /@vueuse/core/9.4.0_vue@3.2.41: + resolution: {integrity: sha512-JzgenGj1ZF2BHOen5rsFiAyyI9sXAv7aKhNLlm9b7SwYQeKTcxTWdhudonURCSP3Egl9NQaRBzes2lv/1JUt/Q==} dependencies: - '@types/web-bluetooth': 0.0.15 - '@vueuse/metadata': 9.3.0 - '@vueuse/shared': 9.3.0_vue@3.2.40 - vue-demi: 0.13.11_vue@3.2.40 + '@types/web-bluetooth': 0.0.16 + '@vueuse/metadata': 9.4.0 + '@vueuse/shared': 9.4.0_vue@3.2.41 + vue-demi: 0.13.11_vue@3.2.41 transitivePeerDependencies: - '@vue/composition-api' - vue dev: true - /@vueuse/metadata/9.3.0: - resolution: {integrity: sha512-GnnfjbzIPJIh9ngL9s9oGU1+Hx/h5/KFqTfJykzh/1xjaHkedV9g0MASpdmPZIP+ynNhKAcEfA6g5i8KXwtoMA==} + /@vueuse/metadata/9.4.0: + resolution: {integrity: sha512-7GKMdGAsJyQJl35MYOz/RDpP0FxuiZBRDSN79QIPbdqYx4Sd0sVTnIC68KJ6Oln0t0SouvSUMvRHuno216Ud2Q==} dev: true - /@vueuse/shared/9.3.0_vue@3.2.40: - resolution: {integrity: sha512-caGUWLY0DpPC6l31KxeUy6vPVNA0yKxx81jFYLoMpyP6cF84FG5Dkf69DfSUqL57wX8JcUkJDMnQaQIZPWFEQQ==} + /@vueuse/shared/9.4.0_vue@3.2.41: + resolution: {integrity: sha512-fTuem51KwMCnqUKkI8B57qAIMcFovtGgsCtAeqxIzH3i6nE9VYge+gVfneNHAAy7lj8twbkNfqQSygOPJTm4tQ==} dependencies: - vue-demi: 0.13.11_vue@3.2.40 + vue-demi: 0.13.11_vue@3.2.41 transitivePeerDependencies: - '@vue/composition-api' - vue @@ -4186,6 +4190,14 @@ packages: resolution: {integrity: sha512-Vpfqwm4EnqGdlsBFNmHhxhElJYrdfcxPThu+ryKS5J8L/fhAwLazFZtq+S+TWZ9ANj2piSQLGj6NQg+lKPmxrw==} dev: true + /shiki-processor/0.1.0_shiki@0.11.1: + resolution: {integrity: sha512-7ty3VouP7AQMlERKeiobVeyhjUW6rPMM1b+xFcFF/XwhkN4//Fg9Ju6hPfIOvO4ztylkbLqYufbJmLJmw7SfQA==} + peerDependencies: + shiki: ^0.11.1 + dependencies: + shiki: 0.11.1 + dev: true + /shiki/0.11.1: resolution: {integrity: sha512-EugY9VASFuDqOexOgXR18ZV+TbFrQHeCpEYaXamO+SZlsnT/2LxuLBX25GGtIrwaEVFXUAbUQ601SWE2rMwWHA==} dependencies: @@ -4810,19 +4822,20 @@ packages: fsevents: 2.3.2 dev: true - /vitepress/1.0.0-alpha.22_7s2zbo6pukdbh3jcjyutgyfrd4: - resolution: {integrity: sha512-IWqnAxMDNaiyl6Bz+/79l40Ho6xsjrqxRp/WZw0+5BXR0BTZbmHyhGtI3XrH6oSn8MisLPjCccikaj3mcmCoWg==} + /vitepress/1.0.0-alpha.25_7s2zbo6pukdbh3jcjyutgyfrd4: + resolution: {integrity: sha512-qvKQ4aCArGL8nxP7BAeMBY/N9qm6fX5/dVNGESDvpkm/M8BQlIkOIEanlkAEPY9VOCMA1zcX3wtstcEcnjc5fA==} hasBin: true dependencies: - '@docsearch/css': 3.2.1 - '@docsearch/js': 3.2.1_7s2zbo6pukdbh3jcjyutgyfrd4 - '@vitejs/plugin-vue': 3.1.2_vite@3.1.8+vue@3.2.40 - '@vue/devtools-api': 6.4.4 - '@vueuse/core': 9.3.0_vue@3.2.40 + '@docsearch/css': 3.3.0 + '@docsearch/js': 3.3.0_7s2zbo6pukdbh3jcjyutgyfrd4 + '@vitejs/plugin-vue': 3.1.2_vite@3.1.8+vue@3.2.41 + '@vue/devtools-api': 6.4.5 + '@vueuse/core': 9.4.0_vue@3.2.41 body-scroll-lock: 4.0.0-beta.0 shiki: 0.11.1 + shiki-processor: 0.1.0_shiki@0.11.1 vite: 3.1.8 - vue: 3.2.40 + vue: 3.2.41 transitivePeerDependencies: - '@algolia/client-search' - '@types/react' @@ -4885,7 +4898,7 @@ packages: resolution: {integrity: sha512-gu73tuZfJgu+mvCSy4UZwd2JXykjK9zAZsfmDeut5dx/1a7FeTk0XwJsSuqQn+cuMCGVbIBfl+s53X4T19DnzQ==} dev: true - /vue-demi/0.13.11_vue@3.2.40: + /vue-demi/0.13.11_vue@3.2.41: resolution: {integrity: sha512-IR8HoEEGM65YY3ZJYAjMlKygDQn25D5ajNFNoKh9RSDMQtlzCxtfQjdQgv9jjK+m3377SsJXY8ysq8kLCZL25A==} engines: {node: '>=12'} hasBin: true @@ -4897,17 +4910,17 @@ packages: '@vue/composition-api': optional: true dependencies: - vue: 3.2.40 + vue: 3.2.41 dev: true - /vue/3.2.40: - resolution: {integrity: sha512-1mGHulzUbl2Nk3pfvI5aXYYyJUs1nm4kyvuz38u4xlQkLUn1i2R7nDbI4TufECmY8v1qNBHYy62bCaM+3cHP2A==} + /vue/3.2.41: + resolution: {integrity: sha512-uuuvnrDXEeZ9VUPljgHkqB5IaVO8SxhPpqF2eWOukVrBnRBx2THPSGQBnVRt0GrIG1gvCmFXMGbd7FqcT1ixNQ==} dependencies: - '@vue/compiler-dom': 3.2.40 - '@vue/compiler-sfc': 3.2.40 - '@vue/runtime-dom': 3.2.40 - '@vue/server-renderer': 3.2.40_vue@3.2.40 - '@vue/shared': 3.2.40 + '@vue/compiler-dom': 3.2.41 + '@vue/compiler-sfc': 3.2.41 + '@vue/runtime-dom': 3.2.41 + '@vue/server-renderer': 3.2.41_vue@3.2.41 + '@vue/shared': 3.2.41 dev: true /webidl-conversions/3.0.1: From 4d981a7479d2a347ce4fbac2ec49c47494f78cf8 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 00:55:40 +0530 Subject: [PATCH 02/20] docs: don't render banner on the main site --- docs/.vitepress/components/Banner.vue | 13 ++++--------- docs/.vitepress/theme/index.ts | 4 ++-- 2 files changed, 6 insertions(+), 11 deletions(-) diff --git a/docs/.vitepress/components/Banner.vue b/docs/.vitepress/components/Banner.vue index 1c9872a12bd..c310ab11824 100644 --- a/docs/.vitepress/components/Banner.vue +++ b/docs/.vitepress/components/Banner.vue @@ -1,13 +1,14 @@ - - + diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 838cedb1cba..96058affcf3 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -51,7 +51,7 @@ function extendSideNav(current: SidebarGroup): SidebarGroup[] { return links; } -export default defineConfig({ +const config = defineConfig({ title: 'Faker', description, @@ -72,13 +72,6 @@ export default defineConfig({ content: description, }, ], - [ - 'meta', - { - name: 'description', - content: description, - }, - ], [ 'meta', { @@ -232,7 +225,27 @@ export default defineConfig({ vite: { define: { - __BANNER__: versionBannerInfix, + __BANNER__: versionBannerInfix()?.version ?? false, }, }, }); + +if (versionBannerInfix()) { + config.head?.push([ + 'script', + { id: 'restore-banner-preference' }, + ` +(() => { + const restore = (key, cls, def = false) => { + const saved = localStorage.getItem(key); + if (saved ? saved !== 'false' : def) { + document.documentElement.classList.add(cls); + } + }; + window.__FAKER_BANNER_ID__ = '${versionBannerInfix().id}'; + restore(\`faker-banner-\${__FAKER_BANNER_ID__}\`, 'banner-dismissed'); +})();`, + ]); +} + +export default config; diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index cb78749c068..8555a839b70 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -5,14 +5,18 @@ import './index.css'; export default { ...DefaultTheme, Layout() { - return h(DefaultTheme.Layout, null, { - 'layout-top': () => - __BANNER__ - ? h( - defineAsyncComponent(() => import('../components/Banner.vue')), - { text: __BANNER__ } - ) - : null, - }); + return h( + DefaultTheme.Layout, + null, + __BANNER__ + ? { + 'layout-top': () => + h( + defineAsyncComponent(() => import('../components/Banner.vue')), + { version: __BANNER__ } + ), + } + : null + ); }, }; diff --git a/docs/.vitepress/versions.ts b/docs/.vitepress/versions.ts index 998e71671eb..1b7fe056006 100644 --- a/docs/.vitepress/versions.ts +++ b/docs/.vitepress/versions.ts @@ -41,17 +41,18 @@ const hiddenLink = const otherVersions = readOtherLatestReleaseTagNames(); const isReleaseBranch = /^v\d+$/.test(branchName); -let bannerInfix_: string | null; -if (deployContext === 'production') { - bannerInfix_ = null; -} else if (isReleaseBranch) { - bannerInfix_ = '"an old"'; -} else if (branchName === 'next') { - bannerInfix_ = '"the next (unreleased)"'; -} else { - bannerInfix_ = '"a development"'; -} -export const versionBannerInfix = bannerInfix_; +export const versionBannerInfix = () => { + if (deployContext === 'production') { + return null; + } + if (isReleaseBranch) { + return { version: '"an old version"', id: 'fk01' }; + } + if (branchName === 'next') { + return { version: '"the next (unreleased) version"', id: 'fk02' }; + } + return { version: '"a development version"', id: 'fk03' }; +}; export const currentVersion = isReleaseBranch ? `v${version}` : branchName; export const oldVersions = [ diff --git a/netlify.toml b/netlify.toml index 3d5ea078c45..02730842ce0 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,11 +1,10 @@ [build.environment] NODE_VERSION = "18" - NPM_FLAGS = "--version" # prevent Netlify npm install # Documentation [build] publish = "docs/.vitepress/dist" - command = "npx pnpm i --store=node_modules/.pnpm-store && npm run docs:build:ci" + command = "pnpm docs:build:ci" # Redirect to Discord server [[redirects]] From e9aff8c51f97721751b3d303161ecff2ff20a79f Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 21:48:54 +0530 Subject: [PATCH 07/20] allow not persisting banner --- docs/.vitepress/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 96058affcf3..e0b536a6a70 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -230,7 +230,7 @@ const config = defineConfig({ }, }); -if (versionBannerInfix()) { +if (versionBannerInfix()?.id) { config.head?.push([ 'script', { id: 'restore-banner-preference' }, From 6c14d04abe293e7670ee3c6476b0ec77d2b03e25 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 21:50:26 +0530 Subject: [PATCH 08/20] fix type --- docs/.vitepress/components/shims.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/components/shims.d.ts b/docs/.vitepress/components/shims.d.ts index 84b14a81d40..7ae275ab099 100644 --- a/docs/.vitepress/components/shims.d.ts +++ b/docs/.vitepress/components/shims.d.ts @@ -1,4 +1,4 @@ -declare const __BANNER__: string | null; +declare const __BANNER__: string | false; declare module '*.vue' { import type { DefineComponent } from 'vue'; From b84bc5d772c56a727029ddc9493b112aa38f63b1 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 22:00:11 +0530 Subject: [PATCH 09/20] fix failing tests due to vp version update --- test/scripts/apidoc/signature.expected.json | 32 ++++++++++----------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/test/scripts/apidoc/signature.expected.json b/test/scripts/apidoc/signature.expected.json index 6268978988d..05809105a62 100644 --- a/test/scripts/apidoc/signature.expected.json +++ b/test/scripts/apidoc/signature.expected.json @@ -13,7 +13,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.defaultBooleanParamMethod(c: boolean = true): number\n
\n
", + "examples": "
ts
faker.defaultBooleanParamMethod(c: boolean = true): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -30,7 +30,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.functionParamMethod(fn: (a: string) => number): number\n
\n
", + "examples": "
ts
faker.functionParamMethod(fn: (a: string) => number): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -47,7 +47,7 @@ ], "since": "", "returns": "string", - "examples": "
ts
faker.literalUnionParamMethod(value: 'a' | 'b' | string): string\n
\n
", + "examples": "
ts
faker.literalUnionParamMethod(value: 'a' | 'b' | string): string\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -58,7 +58,7 @@ "parameters": [], "since": "", "returns": "number", - "examples": "
ts
faker.methodWithDeprecated(): number\n
\n
", + "examples": "
ts
faker.methodWithDeprecated(): number\n
\n
", "deprecated": true, "seeAlsos": ["test.apidoc.methodWithExample()"] }, @@ -69,7 +69,7 @@ "parameters": [], "since": "", "returns": "number", - "examples": "
ts
faker.methodWithExample(): number\ntest.apidoc.methodWithExample() // 0\n
\n
", + "examples": "
ts
faker.methodWithExample(): number\ntest.apidoc.methodWithExample() // 0\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -80,7 +80,7 @@ "parameters": [], "since": "", "returns": "number", - "examples": "
ts
faker.methodWithMultipleSeeMarkers(): number\n
\n
", + "examples": "
ts
faker.methodWithMultipleSeeMarkers(): number\n
\n
", "deprecated": false, "seeAlsos": [ "test.apidoc.methodWithExample()", @@ -94,7 +94,7 @@ "parameters": [], "since": "1.0.0", "returns": "number", - "examples": "
ts
faker.methodWithSinceMarker(): number\n
\n
", + "examples": "
ts
faker.methodWithSinceMarker(): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -122,7 +122,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.multiParamMethod(a: number, b?: string, c: boolean = true): number\n
\n
", + "examples": "
ts
faker.multiParamMethod(a: number, b?: string, c: boolean = true): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -133,7 +133,7 @@ "parameters": [], "since": "", "returns": "number", - "examples": "
ts
faker.noParamMethod(): number\n
\n
", + "examples": "
ts
faker.noParamMethod(): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -150,7 +150,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.optionalStringParamMethod(b?: string): number\n
\n
", + "examples": "
ts
faker.optionalStringParamMethod(b?: string): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -195,7 +195,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.optionsInlineParamMethodWithDefaults(a: {\n  value: number\n} = { value: 1 }, b: {\n  value: number\n} = { value: 1 }, c: {\n  value: number\n}): number\n
\n
", + "examples": "
ts
faker.optionsInlineParamMethodWithDefaults(a: {\n  value: number\n} = { value: 1 }, b: {\n  value: number\n} = { value: 1 }, c: {\n  value: number\n}): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -224,7 +224,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.optionsInterfaceParamMethodWithDefaults(a: ParameterOptionsInterfaceA = { value: 1 }, b: ParameterOptionsInterfaceB = { value: 1 }, c: ParameterOptionsInterfaceC): number\n
\n
", + "examples": "
ts
faker.optionsInterfaceParamMethodWithDefaults(a: ParameterOptionsInterfaceA = { value: 1 }, b: ParameterOptionsInterfaceB = { value: 1 }, c: ParameterOptionsInterfaceC): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -261,7 +261,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.optionsParamMethod(options: {\n  a: number,\n  b: string,\n  c: boolean,\n  d: () => string\n}): number\n
\n
", + "examples": "
ts
faker.optionsParamMethod(options: {\n  a: number,\n  b: string,\n  c: boolean,\n  d: () => string\n}): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -290,7 +290,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.optionsTypeParamMethodWithDefaults(a: ParameterOptionsTypeA = { value: 1 }, b: ParameterOptionsTypeB = { value: 1 }, c: ParameterOptionsTypeC): number\n
\n
", + "examples": "
ts
faker.optionsTypeParamMethodWithDefaults(a: ParameterOptionsTypeA = { value: 1 }, b: ParameterOptionsTypeB = { value: 1 }, c: ParameterOptionsTypeC): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -307,7 +307,7 @@ ], "since": "", "returns": "number", - "examples": "
ts
faker.requiredNumberParamMethod(a: number): number\n
\n
", + "examples": "
ts
faker.requiredNumberParamMethod(a: number): number\n
\n
", "deprecated": false, "seeAlsos": [] }, @@ -324,7 +324,7 @@ ], "since": "", "returns": "string", - "examples": "
ts
faker.stringUnionParamMethod(value: 'a' | 'b'): string\n
\n
", + "examples": "
ts
faker.stringUnionParamMethod(value: 'a' | 'b'): string\n
\n
", "deprecated": false, "seeAlsos": [] } From 4729b15621eeb9101e1af124964927290d06686c Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 23:16:59 +0530 Subject: [PATCH 10/20] Update docs/.vitepress/versions.ts Co-authored-by: Shinigami --- docs/.vitepress/versions.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/.vitepress/versions.ts b/docs/.vitepress/versions.ts index 1b7fe056006..7cf851d0771 100644 --- a/docs/.vitepress/versions.ts +++ b/docs/.vitepress/versions.ts @@ -46,12 +46,12 @@ export const versionBannerInfix = () => { return null; } if (isReleaseBranch) { - return { version: '"an old version"', id: 'fk01' }; + return { version: '"an old version"', id: 'old' }; } if (branchName === 'next') { - return { version: '"the next (unreleased) version"', id: 'fk02' }; + return { version: '"the next (unreleased) version"', id: 'next' }; } - return { version: '"a development version"', id: 'fk03' }; + return { version: '"a development version"', id: 'dev' }; }; export const currentVersion = isReleaseBranch ? `v${version}` : branchName; From 78a886225de547d2bd570aac065307babb5d6795 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 23:17:06 +0530 Subject: [PATCH 11/20] Update docs/.vitepress/config.ts Co-authored-by: Shinigami --- docs/.vitepress/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index e0b536a6a70..df04005a381 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -243,7 +243,7 @@ if (versionBannerInfix()?.id) { } }; window.__FAKER_BANNER_ID__ = '${versionBannerInfix().id}'; - restore(\`faker-banner-\${__FAKER_BANNER_ID__}\`, 'banner-dismissed'); + restore(\`faker-version-banner-\${__FAKER_BANNER_ID__}\`, 'banner-dismissed'); })();`, ]); } From 0b3090eb430f098163e69371e7c84871263d40ae Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 23:17:14 +0530 Subject: [PATCH 12/20] Update docs/.vitepress/components/Banner.vue Co-authored-by: Shinigami --- docs/.vitepress/components/Banner.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/components/Banner.vue b/docs/.vitepress/components/Banner.vue index 55eea7a36ed..313bdc3af13 100644 --- a/docs/.vitepress/components/Banner.vue +++ b/docs/.vitepress/components/Banner.vue @@ -20,7 +20,7 @@ watchEffect(() => { const dismiss = () => { localStorage.setItem( - `faker-banner-${(window as any).__FAKER_BANNER_ID__}`, + `faker-version-banner-${(window as any).__FAKER_BANNER_ID__}`, '1' ); document.documentElement.classList.add('banner-dismissed'); From 136d54b2ce7b8d6eeec5e461fee634019587167b Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 26 Oct 2022 23:53:43 +0530 Subject: [PATCH 13/20] persist only for 24 hrs --- docs/.vitepress/components/Banner.vue | 2 +- docs/.vitepress/config.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/.vitepress/components/Banner.vue b/docs/.vitepress/components/Banner.vue index 313bdc3af13..b7440bd490b 100644 --- a/docs/.vitepress/components/Banner.vue +++ b/docs/.vitepress/components/Banner.vue @@ -21,7 +21,7 @@ watchEffect(() => { const dismiss = () => { localStorage.setItem( `faker-version-banner-${(window as any).__FAKER_BANNER_ID__}`, - '1' + (new Date().getTime() + 8.64e7 * 1).toString() ); document.documentElement.classList.add('banner-dismissed'); }; diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index df04005a381..55170576b6d 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -238,7 +238,7 @@ if (versionBannerInfix()?.id) { (() => { const restore = (key, cls, def = false) => { const saved = localStorage.getItem(key); - if (saved ? saved !== 'false' : def) { + if (saved ? saved !== 'false' && new Date() < saved : def) { document.documentElement.classList.add(cls); } }; From 864d22f0d89d2c02d2bb09e994040a76afab7d8b Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Thu, 27 Oct 2022 00:33:43 +0530 Subject: [PATCH 14/20] add comment --- docs/.vitepress/components/Banner.vue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/.vitepress/components/Banner.vue b/docs/.vitepress/components/Banner.vue index b7440bd490b..0daa0d7bed1 100644 --- a/docs/.vitepress/components/Banner.vue +++ b/docs/.vitepress/components/Banner.vue @@ -21,7 +21,7 @@ watchEffect(() => { const dismiss = () => { localStorage.setItem( `faker-version-banner-${(window as any).__FAKER_BANNER_ID__}`, - (new Date().getTime() + 8.64e7 * 1).toString() + (Date.now() + 8.64e7 * 1).toString() // current time + 1 day ); document.documentElement.classList.add('banner-dismissed'); }; From 6c46574f102feca4c0b663f9b2bbb96c79e320ad Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Wed, 26 Oct 2022 22:05:18 +0200 Subject: [PATCH 15/20] chore: export value instead of function --- docs/.vitepress/config.ts | 6 +++--- docs/.vitepress/versions.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 55170576b6d..878e273b6ea 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -225,12 +225,12 @@ const config = defineConfig({ vite: { define: { - __BANNER__: versionBannerInfix()?.version ?? false, + __BANNER__: versionBannerInfix?.version ?? false, }, }, }); -if (versionBannerInfix()?.id) { +if (versionBannerInfix) { config.head?.push([ 'script', { id: 'restore-banner-preference' }, @@ -242,7 +242,7 @@ if (versionBannerInfix()?.id) { document.documentElement.classList.add(cls); } }; - window.__FAKER_BANNER_ID__ = '${versionBannerInfix().id}'; + window.__FAKER_BANNER_ID__ = '${versionBannerInfix.id}'; restore(\`faker-version-banner-\${__FAKER_BANNER_ID__}\`, 'banner-dismissed'); })();`, ]); diff --git a/docs/.vitepress/versions.ts b/docs/.vitepress/versions.ts index 7cf851d0771..97e98a06f4c 100644 --- a/docs/.vitepress/versions.ts +++ b/docs/.vitepress/versions.ts @@ -41,7 +41,7 @@ const hiddenLink = const otherVersions = readOtherLatestReleaseTagNames(); const isReleaseBranch = /^v\d+$/.test(branchName); -export const versionBannerInfix = () => { +export const versionBannerInfix = (() => { if (deployContext === 'production') { return null; } @@ -52,7 +52,7 @@ export const versionBannerInfix = () => { return { version: '"the next (unreleased) version"', id: 'next' }; } return { version: '"a development version"', id: 'dev' }; -}; +})(); export const currentVersion = isReleaseBranch ? `v${version}` : branchName; export const oldVersions = [ From 0ed7ed7eb398269eb23f3754f07bf77530bf080c Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Thu, 27 Oct 2022 18:26:36 +0530 Subject: [PATCH 16/20] update vitepress --- package.json | 2 +- pnpm-lock.yaml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 13f0a1c4987..a560ee90ee9 100644 --- a/package.json +++ b/package.json @@ -138,7 +138,7 @@ "typescript": "~4.8.4", "validator": "~13.7.0", "vite": "~3.1.8", - "vitepress": "1.0.0-alpha.25", + "vitepress": "1.0.0-alpha.26", "vitest": "~0.24.3", "vue": "~3.2.41" }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e48652aa6a9..6418f9660f5 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -46,7 +46,7 @@ specifiers: typescript: ~4.8.4 validator: ~13.7.0 vite: ~3.1.8 - vitepress: 1.0.0-alpha.25 + vitepress: 1.0.0-alpha.26 vitest: ~0.24.3 vue: ~3.2.41 @@ -96,7 +96,7 @@ devDependencies: typescript: 4.8.4 validator: 13.7.0 vite: 3.1.8 - vitepress: 1.0.0-alpha.25_7s2zbo6pukdbh3jcjyutgyfrd4 + vitepress: 1.0.0-alpha.26_7s2zbo6pukdbh3jcjyutgyfrd4 vitest: 0.24.3_@vitest+ui@0.24.3 vue: 3.2.41 @@ -4822,8 +4822,8 @@ packages: fsevents: 2.3.2 dev: true - /vitepress/1.0.0-alpha.25_7s2zbo6pukdbh3jcjyutgyfrd4: - resolution: {integrity: sha512-qvKQ4aCArGL8nxP7BAeMBY/N9qm6fX5/dVNGESDvpkm/M8BQlIkOIEanlkAEPY9VOCMA1zcX3wtstcEcnjc5fA==} + /vitepress/1.0.0-alpha.26_7s2zbo6pukdbh3jcjyutgyfrd4: + resolution: {integrity: sha512-XpDpflrdmyBmUQrg06q29Mhez144NvoZ48pRvNhANy/wV7E7XJ1zenQROOSADnOsAlhV1gzcNjqiFNObCk7l8A==} hasBin: true dependencies: '@docsearch/css': 3.3.0 From cdc5f50900861a0cf40194020fdfc21c65ed2ad3 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Thu, 27 Oct 2022 18:43:20 +0530 Subject: [PATCH 17/20] id is no longer required as time based preference is being stored --- docs/.vitepress/components/Banner.vue | 2 +- docs/.vitepress/config.ts | 5 ++--- docs/.vitepress/versions.ts | 8 ++++---- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/.vitepress/components/Banner.vue b/docs/.vitepress/components/Banner.vue index 0daa0d7bed1..9eea81c9c8f 100644 --- a/docs/.vitepress/components/Banner.vue +++ b/docs/.vitepress/components/Banner.vue @@ -20,7 +20,7 @@ watchEffect(() => { const dismiss = () => { localStorage.setItem( - `faker-version-banner-${(window as any).__FAKER_BANNER_ID__}`, + 'faker-version-banner', (Date.now() + 8.64e7 * 1).toString() // current time + 1 day ); document.documentElement.classList.add('banner-dismissed'); diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 878e273b6ea..2e6775d0905 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -225,7 +225,7 @@ const config = defineConfig({ vite: { define: { - __BANNER__: versionBannerInfix?.version ?? false, + __BANNER__: versionBannerInfix ?? false, }, }, }); @@ -242,8 +242,7 @@ if (versionBannerInfix) { document.documentElement.classList.add(cls); } }; - window.__FAKER_BANNER_ID__ = '${versionBannerInfix.id}'; - restore(\`faker-version-banner-\${__FAKER_BANNER_ID__}\`, 'banner-dismissed'); + restore('faker-version-banner', 'banner-dismissed'); })();`, ]); } diff --git a/docs/.vitepress/versions.ts b/docs/.vitepress/versions.ts index 97e98a06f4c..2964557cee9 100644 --- a/docs/.vitepress/versions.ts +++ b/docs/.vitepress/versions.ts @@ -41,17 +41,17 @@ const hiddenLink = const otherVersions = readOtherLatestReleaseTagNames(); const isReleaseBranch = /^v\d+$/.test(branchName); -export const versionBannerInfix = (() => { +export const versionBannerInfix: string | null = (() => { if (deployContext === 'production') { return null; } if (isReleaseBranch) { - return { version: '"an old version"', id: 'old' }; + return '"an old version"'; } if (branchName === 'next') { - return { version: '"the next (unreleased) version"', id: 'next' }; + return '"the next (unreleased) version"'; } - return { version: '"a development version"', id: 'dev' }; + return '"a development version"'; })(); export const currentVersion = isReleaseBranch ? `v${version}` : branchName; From 315c24f2656fdc558637e48e1578969640a5ab71 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Thu, 27 Oct 2022 20:55:50 +0530 Subject: [PATCH 18/20] revert --- docs/.vitepress/config.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 2e6775d0905..aa0045d81dd 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -72,6 +72,13 @@ const config = defineConfig({ content: description, }, ], + [ + 'meta', + { + name: 'description', + content: description, + }, + ], [ 'meta', { From ac88d9373eb63a72cf7b25ec9fdcc88aa99a844d Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Thu, 27 Oct 2022 20:56:54 +0530 Subject: [PATCH 19/20] revert --- netlify.toml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/netlify.toml b/netlify.toml index 02730842ce0..420f9d58574 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,10 +1,11 @@ [build.environment] NODE_VERSION = "18" + NPM_FLAGS = "--version" # prevent Netlify npm install # Documentation [build] publish = "docs/.vitepress/dist" - command = "pnpm docs:build:ci" + command = "npx pnpm i --store=node_modules/.pnpm-store && npm run docs:build:ci" # Redirect to Discord server [[redirects]] From 171f7f9335c5e056920e4de12a7db2baf7f9046d Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Thu, 27 Oct 2022 20:57:37 +0530 Subject: [PATCH 20/20] Update netlify.toml --- netlify.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netlify.toml b/netlify.toml index 420f9d58574..3d5ea078c45 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,6 +1,6 @@ [build.environment] NODE_VERSION = "18" - NPM_FLAGS = "--version" # prevent Netlify npm install + NPM_FLAGS = "--version" # prevent Netlify npm install # Documentation [build]