Prep api docs (#570)

package.json

@@ -2,10 +2,11 @@
   "name": "root",
   "private": true,
   "volta": {
-    "node": "16.15.0"
+    "node": "18.1.0"
   },
   "scripts": {
     "test": "pnpm run --filter theemo test",
-    "coverage": "pnpm run --filter theemo coverage"
+    "coverage": "pnpm run --filter theemo coverage",
+    "api": "pnpm run --filter theemo api"
   }
 }

packages/theemo/.gitignore

@@ -1 +1,2 @@
-dist
+dist
+api

packages/theemo/api-extractor.json

@@ -2,14 +2,14 @@
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
   "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
   "apiReport": {
-    "enabled": false,
+    "enabled": true,
     "reportFolder": "<projectFolder>/etc/"
   },
   "docModel": {
     "enabled": true,
     "apiJsonFilePath": "<projectFolder>/dist/<unscopedPackageName>.api.json"
   },
   "dtsRollup": {
-    "enabled": false
+    "enabled": true
   }
 }

packages/theemo/etc/theemo.api.md

@@ -0,0 +1,74 @@
+## API Report File for "theemo"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { BaseToken } from './token.js';
+import { default as Figma } from './tools/figma/index.js';
+import { FigmaReaderConfig } from './tools/figma/config.js';
+import { FigmaReferencerConfig } from './tools/figma/config.js';
+import { FigmaReferencerPluginConfig } from './tools/figma/config.js';
+import { FigmaReferencerType } from './tools/figma/config.js';
+import { FigmaTheemoPluginConfig } from './tools/figma/referencers/theemo-plugin.js';
+import { default as GenerateConfig } from './generate/config.js';
+import { default as LexerConfig } from './sync/lexer/config.js';
+import { default as ReaderConfig } from './sync/reader/config.js';
+import { ReaderTool } from './tools/tool.js';
+import { default as StyleDictionary } from './tools/style-dictionary/index.js';
+import { StyleDictionaryConfig } from './tools/style-dictionary/config.js';
+import { StyleDictionaryWriterConfig } from './tools/style-dictionary/config.js';
+import { default as SyncConfig } from './sync/config.js';
+import Theemo from './theemo.js';
+import type TheemoConfig from './config.js';
+import { default as Token } from './token.js';
+import { TokenTier } from './token.js';
+import { Tools } from './tools/tool.js';
+import { default as WriterConfig } from './sync/writer/config.js';
+import { WriterTool } from './tools/tool.js';
+
+export { BaseToken }
+
+export { Figma }
+
+export { FigmaReaderConfig }
+
+export { FigmaReferencerConfig }
+
+export { FigmaReferencerPluginConfig }
+
+export { FigmaReferencerType }
+
+export { FigmaTheemoPluginConfig }
+
+export { GenerateConfig }
+
+export { LexerConfig }
+
+export { ReaderConfig }
+
+export { ReaderTool }
+
+export { StyleDictionary }
+
+export { StyleDictionaryConfig }
+
+export { StyleDictionaryWriterConfig }
+
+export { SyncConfig }
+
+export default Theemo;
+
+export { TheemoConfig }
+
+export { Token }
+
+export { TokenTier }
+
+export { Tools }
+
+export { WriterConfig }
+
+export { WriterTool }
+
+```

packages/theemo/package.json

@@ -36,7 +36,10 @@
     "lint:js": "eslint --ext ts,js src/ test/ --cache",
     "lint:js:fix": "eslint --ext ts,js src/ test/ --fix",
     "lint:types": "tsc --noEmit",
-    "api": "node scripts/make-docs.cjs",
+    "api:extractor": "api-extractor run --local",
+    "api:documenter": "api-documenter markdown -i dist -o api",
+    "api:doc": "pnpm api:extractor && pnpm api:documenter",
+    "api": "pnpm dts && pnpm api:doc",
     "prepublishOnly": "pnpm build",
     "prepack": "pnpm dts",
     "release": "release-it"
@@ -104,6 +107,7 @@
     }
   },
   "volta": {
-    "extends": "../../package.json"
+    "extends": "../../package.json",
+    "node": "18.1.0"
   }
 }

scripts/make-docs.cjs → scripts/make-docs.mjs

@@ -1,30 +1,39 @@
-const { readdir, createReadStream, writeFile } = require('fs-extra');
+import { createReadStream, writeFile } from 'node:fs';
+import { readdir } from 'node:fs/promises';
 
-const { createInterface } = require('readline');
-const { join, parse } = require('path');
-const { exec } = require('child_process');
+import { createInterface } from 'node:readline/promises';
+
+import { join, parse } from 'node:path';
+
+import util from 'node:util';
+import { exec } from 'node:child_process';
 
 // This script uses api-extractor and api-documenter and adds frontmatter
 // Taken from:
 // https://github.com/faastjs/faast.js/blob/master/build/make-docs.js
 
+const execAsync = util.promisify(exec);
+
 async function main() {
-  await new Promise((resolve, reject) =>
-    exec(
-      'api-extractor run --local && api-documenter markdown -i dist -o docs/api',
-      (err, stdout, stderr) => {
-        console.log(stdout);
-        console.error(stderr);
-        if (err) {
-          reject(err);
-        } else {
-          resolve();
-        }
-      }
-    )
-  );
+  const { stdout, stderr } = await execAsync('api-extractor run --local && api-documenter markdown -i packages/theemo/dist -o website/docs/api');
+  console.log(stdout);
+  console.error(stderr);
+  // await new Promise((resolve, reject) =>
+  //   exec(
+  //     'api-extractor run --local && api-documenter markdown -i dist -o website/docs/api',
+  //     (err, stdout, stderr) => {
+  //       console.log(stdout);
+  //       console.error(stderr);
+  //       if (err) {
+  //         reject(err);
+  //       } else {
+  //         resolve();
+  //       }
+  //     }
+  //   )
+  // );
 
-  const dir = './docs/api';
+  const dir = './website/docs/api';
   const docFiles = await readdir(dir);
   for (const docFile of docFiles) {
     try {