feat(docz): 实现文档与组件分离后,文档依然可以获得组件的TS 类型

mjzhang1993 · Jan 4, 2021 · 86c63c0 · 86c63c0
1 parent 542da71
commit 86c63c0
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 4 deletions.
diff --git a/packages/docs/doczrc.js b/packages/docs/doczrc.js
@@ -6,7 +6,7 @@ export default {
   /**
    * 排除哪些文件
    */
-  ignore: ["README.md"],
+  ignore: ["README.md", "../mjz-ui/node_modules"],
   /**
    * 网站的标题，默认是 package.json name
    */
@@ -32,4 +32,9 @@ export default {
    * docz dev 环境的端口号配置，同样可配置 host
    */
   port: 3000,
+  docgenConfig: {
+    searchPatterns: ["../mjz-ui/**/*"],
+  },
+  filterComponents: (files) =>
+    files.filter((filepath) => /\/[A-Z]\w*\.(js|jsx|ts|tsx)$/.test(filepath)),
 };
diff --git a/packages/docs/gatsby-node.js b/packages/docs/gatsby-node.js
@@ -0,0 +1,11 @@
+const path = require("path");
+
+exports.onCreateWebpackConfig = (args) => {
+  args.actions.setWebpackConfig({
+    resolve: {
+      alias: {
+        "@mjz-test/mjz-ui": path.resolve(__dirname, "../../../packages/mjz-ui/src"),
+      },
+    },
+  });
+};
diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -32,13 +32,14 @@
     "url": "https://github.com/mjzhang1993/lerna-test/issues"
   },
   "dependencies": {
-    "@mjz-test/mjz-ui": "^0.8.0",
+    "@mjz-test/mjz-ui": "0.8.0",
     "docz": "^2.3.1",
     "gatsby": "^2.29.2",
     "gatsby-plugin-less": "^4.4.0",
     "gatsby-theme-docz": "^2.3.1",
     "less": "^4.0.0",
     "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "react-dom": "^17.0.1",
+    "typescript": "^4.1.3"
   }
 }
diff --git a/packages/docs/src/components/Alert.mdx b/packages/docs/src/components/Alert.mdx
@@ -17,7 +17,7 @@ import {Alert, Button} from '@mjz-test/mjz-ui';
 ## 基本使用
 
 <Playground>
-  <Alert>Open</Alert>
+  <Alert label="xxx">Open</Alert>
   <Alert type="error">Open</Alert>
   <Alert type="primary">Open</Alert>
 </Playground>

diff --git a/packages/docs/tsconfig.json b/packages/docs/tsconfig.json
@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": false,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react"
+  },
+  "include": [
+    "src",
+    "../mjz-ui/"
+  ]
+}