feat: docs (#1080)

- Added typedoc and `build:docs` script


ticket: [CLNP-2426]

[CLNP-2426]:
https://sendbird.atlassian.net/browse/CLNP-2426?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

.gitignore

@@ -36,4 +36,7 @@ yarn-error.log*
 
 .idea/
 
-*storybook.log
+*storybook.log
+
+# docs
+/docs

package.json

@@ -53,6 +53,7 @@
     "storybook": "storybook dev -p 6006",
     "start:storybook": "yarn storybook",
     "start:apps:testing": "yarn workspace @uikit-app/testing dev",
+    "build:docs": "node ./scripts/build_docs.mjs",
     "build:storybook": "storybook build",
     "build:apps:testing": "yarn workspace @uikit-app/testing build"
   },
@@ -137,6 +138,7 @@
     "stylelint": "^13.0.0",
     "stylelint-config-sass-guidelines": "^7.0.0",
     "ts-pattern": "^4.2.2",
+    "typedoc": "^0.25.13",
     "typescript": "^5.4.5",
     "vite": "^5.1.5",
     "vite-plugin-svgr": "^4.2.0"

scripts/build_docs.mjs

@@ -0,0 +1,47 @@
+import { execSync } from 'child_process';
+import { promises as fs } from 'fs';
+import moduleExports from '../rollup.module-exports.mjs';
+
+function removeDuplicates(items) {
+  return [...new Set(items)];
+}
+const order = [
+  'src/modules/App',
+  'src/modules/GroupChannel',
+  'src/modules/GroupChannelList',
+  'src/modules',
+  'src/ui',
+  'src/hooks',
+  'src/utils',
+];
+async function updateEntryPoints() {
+  const modulePaths = removeDuplicates(Object.values(moduleExports)).sort((a, b) => {
+    const aOrder = order.findIndex((o) => a.startsWith(o)) ?? -1;
+    const bOrder = order.findIndex((o) => b.startsWith(o)) ?? -1;
+    if (aOrder === -1) return 1;
+    if (bOrder === -1) return -1;
+    if (aOrder !== bOrder) return aOrder - bOrder;
+    return a.localeCompare(b);
+  });
+  const typedoc = JSON.parse(await fs.readFile('typedoc.json', 'utf-8'));
+  typedoc.entryPoints = modulePaths;
+  await fs.writeFile('typedoc.json', JSON.stringify(typedoc, null, 2));
+}
+
+function execTypedoc() {
+  execSync('npx typedoc', (error, stdout, stderr) => {
+    if (error) {
+      console.error(`exec error: ${error}`);
+      return;
+    }
+    console.log(`stdout: ${stdout}`);
+    console.error(`stderr: ${stderr}`);
+  });
+}
+
+async function run() {
+  await updateEntryPoints();
+  execTypedoc();
+}
+
+run();

ts_debt/README.md

@@ -1,8 +1,6 @@
 This directory has a list of remaining files to be migrated:
 They are split into three categories:
 
-* Source files (high priority)
-* Story files (medium priority)
 * Test files (low priority)
 
 See the list in respective .yml files.