chore(docs): generate docs from @nuxt/kit schema

This commit is contained in:
Pooya Parsa 2021-09-07 12:41:27 +02:00
parent f2d78674a0
commit b9c65486af
4 changed files with 24 additions and 20 deletions

View File

@ -1,16 +0,0 @@
import { resolve } from 'path'
import { defineBuildConfig } from 'unbuild'
export default defineBuildConfig({
entries: [
{
input: resolve(__dirname, '../packages/kit/src/config/schema/index'),
outDir: 'schema',
name: 'config',
builder: 'untyped',
defaults: {
rootDir: '/project/'
}
}
]
})

View File

@ -1,10 +1,11 @@
{ {
"private": true,
"name": "docs", "name": "docs",
"private": true,
"scripts": { "scripts": {
"dev": "yarn gendocs && nuxt dev", "dev": "yarn gendocs && nuxt dev",
"build": "yarn gendocs && nuxt generate --force-build", "build": "yarn gendocs && nuxt generate --force-build",
"gendocs": "unbuild && jiti ./scripts/gen-docs.ts" "build:ci": "yarn add @nuxt/kit@npm:@nuxt/kit-edge && yarn build",
"gendocs": "jiti ./scripts/gen-docs.ts"
}, },
"devDependencies": { "devDependencies": {
"@docus/app": "^1.1.3", "@docus/app": "^1.1.3",
@ -12,13 +13,13 @@
"@docus/social-image": "^1.0.3", "@docus/social-image": "^1.0.3",
"@docus/theme": "^1.1.3", "@docus/theme": "^1.1.3",
"@docus/twitter": "^1.0.4", "@docus/twitter": "^1.0.4",
"@nuxt/kit": "link:../packages/kit",
"@nuxt/typescript-build": "^2.1.0", "@nuxt/typescript-build": "^2.1.0",
"fs-extra": "^10.0.0", "fs-extra": "^10.0.0",
"jiti": "^1.11.0", "jiti": "^1.11.0",
"mkdirp": "^1.0.4", "mkdirp": "^1.0.4",
"rimraf": "^3.0.2", "rimraf": "^3.0.2",
"scule": "^0.2.1", "scule": "^0.2.1",
"unbuild": "^0.4.2",
"untyped": "^0.2.8", "untyped": "^0.2.8",
"upath": "^2.0.1" "upath": "^2.0.1"
} }

View File

@ -111,7 +111,7 @@ async function generateDocs ({ outDir }) {
await rm(outDir, { recursive: true }).catch(() => {}) await rm(outDir, { recursive: true }).catch(() => {})
await mkdirp(outDir) await mkdirp(outDir)
const rootSchema = require('../schema/config.schema.json') as Schema const rootSchema = require('@nuxt/kit/schema/config.schema.json') as Schema
const keys = Object.keys(rootSchema.properties).sort() const keys = Object.keys(rootSchema.properties).sort()
let ctor = 1 let ctor = 1

View File

@ -1462,6 +1462,10 @@
untyped "^0.2.5" untyped "^0.2.5"
upath "^2.0.1" upath "^2.0.1"
"@nuxt/kit@link:../packages/kit":
version "0.0.0"
uid ""
"@nuxt/loading-screen@^2.0.4": "@nuxt/loading-screen@^2.0.4":
version "2.0.4" version "2.0.4"
resolved "https://registry.yarnpkg.com/@nuxt/loading-screen/-/loading-screen-2.0.4.tgz#756abd861f77c57001be4d21d47534723afb4f3a" resolved "https://registry.yarnpkg.com/@nuxt/loading-screen/-/loading-screen-2.0.4.tgz#756abd861f77c57001be4d21d47534723afb4f3a"
@ -5626,6 +5630,11 @@ hookable@^4.4.1:
resolved "https://registry.yarnpkg.com/hookable/-/hookable-4.4.1.tgz#3d7154ac7e1f6f147e50fef583832f2645b9f04f" resolved "https://registry.yarnpkg.com/hookable/-/hookable-4.4.1.tgz#3d7154ac7e1f6f147e50fef583832f2645b9f04f"
integrity sha512-KWjZM8C7IVT2qne5HTXjM6R6VnRfjfRlf/oCnHd+yFxoHO1DzOl6B9LzV/VqGQK/IrFewq+EG+ePVrE9Tpc3fg== integrity sha512-KWjZM8C7IVT2qne5HTXjM6R6VnRfjfRlf/oCnHd+yFxoHO1DzOl6B9LzV/VqGQK/IrFewq+EG+ePVrE9Tpc3fg==
hookable@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/hookable/-/hookable-5.0.0.tgz#bac6f1d4b56e3f590f21cfe3f813731372c0c69f"
integrity sha512-IqoJ8oXCNTUtNfqwbUQvLd+6ebVXk5qqGpSMOe4BS514vd4bEEH+hd9lva48mbbbe9q4eFKmsOViTZkr7ludHg==
hsl-regex@^1.0.0: hsl-regex@^1.0.0:
version "1.0.0" version "1.0.0"
resolved "https://registry.yarnpkg.com/hsl-regex/-/hsl-regex-1.0.0.tgz#d49330c789ed819e276a4c0d272dffa30b18fe6e" resolved "https://registry.yarnpkg.com/hsl-regex/-/hsl-regex-1.0.0.tgz#d49330c789ed819e276a4c0d272dffa30b18fe6e"
@ -10690,6 +10699,11 @@ ufo@^0.7.5, ufo@^0.7.7:
resolved "https://registry.yarnpkg.com/ufo/-/ufo-0.7.7.tgz#0062f9e5e790819b0fb23ca24d7c63a4011c036a" resolved "https://registry.yarnpkg.com/ufo/-/ufo-0.7.7.tgz#0062f9e5e790819b0fb23ca24d7c63a4011c036a"
integrity sha512-N25aY3HBkJBnahm+2l4JRBBrX5I+JPakF/tDHYDTjd3wUR7iFLdyiPhj8mBwBz21v728BKwM9L9tgBfCntgdlw== integrity sha512-N25aY3HBkJBnahm+2l4JRBBrX5I+JPakF/tDHYDTjd3wUR7iFLdyiPhj8mBwBz21v728BKwM9L9tgBfCntgdlw==
ufo@^0.7.9:
version "0.7.9"
resolved "https://registry.yarnpkg.com/ufo/-/ufo-0.7.9.tgz#0268e3734b413c9ed6f3510201f42372821b875c"
integrity sha512-6t9LrLk3FhqTS+GW3IqlITtfRB5JAVr5MMNjpBECfK827W+Vh5Ilw/LhTcHWrt6b3hkeBvcbjx4Ti7QVFzmcww==
uglify-js@^3.5.1: uglify-js@^3.5.1:
version "3.14.1" version "3.14.1"
resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.14.1.tgz#e2cb9fe34db9cb4cf7e35d1d26dfea28e09a7d06" resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.14.1.tgz#e2cb9fe34db9cb4cf7e35d1d26dfea28e09a7d06"
@ -10750,6 +10764,11 @@ unctx@^1.0.1:
resolved "https://registry.yarnpkg.com/unctx/-/unctx-1.0.1.tgz#e976394f22ab00ac4088d86ebfc639861ed3ec24" resolved "https://registry.yarnpkg.com/unctx/-/unctx-1.0.1.tgz#e976394f22ab00ac4088d86ebfc639861ed3ec24"
integrity sha512-LTxBg2tHfEFwpiIGIM7MOODR1hPiO0njHRIbb6fpxL6czd/rkaSeWoaLAVUDP8qDF1Xvq/wO3Eyp4B8yogiObA== integrity sha512-LTxBg2tHfEFwpiIGIM7MOODR1hPiO0njHRIbb6fpxL6czd/rkaSeWoaLAVUDP8qDF1Xvq/wO3Eyp4B8yogiObA==
unctx@^1.0.2:
version "1.0.2"
resolved "https://registry.yarnpkg.com/unctx/-/unctx-1.0.2.tgz#d8d9c83a0965aa277f61058c94548fcee6861e48"
integrity sha512-qxRfnQZWJqkg180JeOCJEvtjj5/7wnWVqkNHln8muY5/z8kMWBFqikFBPwIPCQrZJ+jtaSWkVHJkuHUAXls6zw==
unfetch@^4.2.0: unfetch@^4.2.0:
version "4.2.0" version "4.2.0"
resolved "https://registry.yarnpkg.com/unfetch/-/unfetch-4.2.0.tgz#7e21b0ef7d363d8d9af0fb929a5555f6ef97a3be" resolved "https://registry.yarnpkg.com/unfetch/-/unfetch-4.2.0.tgz#7e21b0ef7d363d8d9af0fb929a5555f6ef97a3be"