moves tsdoc scripts (#1843)

Author: TheSonOfThomp

package.json

@@ -12,7 +12,7 @@
     "create-package": "node ./scripts/create-package.js",
     "build": "turbo run build tsc",
     "build-storybook": "storybook build",
-    "build:docs": "npx ts-node ./scripts/parse-tsdocs.ts",
+    "build:docs": "lg-tsdoc",
     "chromatic": "npx chromatic",
     "clean": "yarn clean:builds && yarn clean:modules",
     "clean:builds": "rm -rf packages/*/dist packages/*/tsconfig.tsbuildinfo ./tsconfig.tsbuildinfo packages/**/stories.js",

tools/build/bin/tsdoc.js

@@ -0,0 +1,2 @@
+#! /usr/bin/env node
+require('../dist/tsdoc.js');

tools/build/package.json

@@ -6,6 +6,12 @@
   "publishConfig": {
     "access": "public"
   },
+  "bin": {
+    "lg-tsdoc": "./bin/tsdoc.js"
+  },
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs"
+  },
   "dependencies": {
     "@babel/core": "^7.9.0",
     "@babel/plugin-proposal-class-properties": "^7.8.3",
@@ -30,7 +36,13 @@
     "@svgr/babel-plugin-replace-jsx-attribute-value": "^8.0.0",
     "@svgr/cli": "^8.0.0",
     "@svgr/rollup": "^8.0.0",
+    "chalk": "^4.0.0",
+    "commander": "^11.0.0",
+    "react-docgen-typescript": "^2.2.2",
     "rollup": "^3.25.0",
     "rollup-plugin-node-externals": "^6.1.1"
+  },
+  "peerDependencies": {
+    "typescript": "^4.6.3"
   }
 }

tools/build/rollup.config.mjs

@@ -0,0 +1,8 @@
+import { umdConfig } from '@lg-tools/build/config/rollup.config.mjs';
+
+const config = {
+  ...umdConfig,
+  input: 'src/tsdoc/tsdoc.ts',
+};
+
+export default config;

scripts/parse-tsdocs.ts renamed to tools/build/src/tsdoc/tsdoc.ts

@@ -3,15 +3,22 @@ import { Command } from 'commander';
 import fs from 'fs';
 import path from 'path';
 
-import { writeDocs } from './utils/tsDocParser';
+import { writeDocs } from './tsDocParser';
+
+const rootDir = process.cwd();
+
+// TODO:
+// This script should run on a single package,
+// and be a part of the turbo build process
+// to take advantage of caching
 
 const cli = new Command('parse-tsdoc')
   .arguments('[packages]')
-  .option('-r, --root <path>', 'Source packages directory', '../packages')
+  .option('-r, --root <path>', 'Source packages directory', './packages')
   .option(
     '-o, --out <path>',
     'Directory to write the doc files (must have the same component folder(s) as source)',
-    '../packages',
+    './packages',
   )
   .parse(process.argv);
 
@@ -24,7 +31,7 @@ const outDir = cli.opts()['out'];
 if (cli.args.length) {
   cli.args.forEach(generateDocFiles);
 } else {
-  const packagesDir = path.resolve(__dirname, packagesRoot);
+  const packagesDir = path.resolve(rootDir, packagesRoot);
   const packages = fs.readdirSync(packagesDir);
   packages.forEach(generateDocFiles);
 }
@@ -36,7 +43,7 @@ if (cli.args.length) {
 function generateDocFiles(componentName: string): void {
   writeDocs(
     componentName,
-    path.resolve(__dirname, packagesRoot),
-    path.resolve(__dirname, outDir),
+    path.resolve(rootDir, packagesRoot),
+    path.resolve(rootDir, outDir),
   );
 }

scripts/utils/tsDoc.utils.ts renamed to tools/build/src/tsdoc/tsdoc.utils.ts

@@ -82,7 +82,7 @@ interface ParseFunctionOptions {
   excludeTags?: Array<string>;
 }
 const defaultParseFunctionOptions = {
-  packagesRoot: path.resolve(__dirname, '../../packages'),
+  packagesRoot: path.resolve(process.cwd(), 'packages'),
   excludeTags: ['example', 'internal', 'noDocgen'],
 };
 
@@ -103,7 +103,7 @@ export function parseTSDoc(
   );
 
   const componentDir = path.resolve(
-    __dirname,
+    process.cwd(),
     `${packagesRoot}/${componentName}`,
   );
 
@@ -185,8 +185,8 @@ export function parseTSDoc(
  */
 export function writeDocs(
   componentName: string,
-  packagesRoot = path.resolve(__dirname, '../../packages'),
-  outDir = path.resolve(__dirname, '../../packages'),
+  packagesRoot: string,
+  outDir: string,
 ): void {
   const docs = parseTSDoc(componentName);
   const docString = JSON.stringify(docs, null, 2);
@@ -200,7 +200,7 @@ export function writeDocs(
   );
 
   const outFilePath = path.resolve(
-    __dirname,
+    process.cwd(),
     `${outDir}/${componentName}/tsdoc.json`,
   );
 

scripts/utils/tsDocParser.ts renamed to tools/build/src/tsdoc/tsdocParser.ts

@@ -0,0 +1,12 @@
+{
+  "extends": "@lg-tools/build/config/package.tsconfig.json",
+   "compilerOptions": {
+    "declarationDir": "dist",
+    "outDir": "dist",
+    "rootDir": "src",
+    "baseUrl": "."
+  },
+  "include": [
+    "src/**/*"
+  ]
+}