Fix #234 automate src/index.ts

.vscode/settings.json

@@ -1,13 +1,13 @@
 {
   "files.exclude": {
-    // "**/dist": false,
+    // "**/dist": false
   },
   "[typescript]": {
     "editor.formatOnSave": true,
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "typescript.tsdk": "node_modules/typescript/lib",
+  "js/ts.tsdk.path": "node_modules/typescript/lib",
   "editor.codeActionsOnSave": {
     "source.fixAll": "explicit"
-  },
+  }
 }

docs/pull_request_template.md

@@ -7,7 +7,6 @@ Closes: #
 - [ ] **Created method file** under `src/<method_name>/<method_name>.ts`
 - [ ] **Added jsdoc comments** in the method file
 - [ ] **Created a test** under `src/<method_name>/<method_name>.test.ts`
-- [ ] **Export the method file in main entry file** `src/index.ts`
 - [ ] **Generate docs**
 
 ---

package.json

@@ -30,22 +30,23 @@
     "LICENSE"
   ],
   "scripts": {
-    "build": "rm -rf dist/; tsup",
+    "build": "rm -rf dist/; npm run generate-index; tsup",
     "format:check": "eslint ./src",
     "format:fix": "eslint ./src --fix",
     "prepublishOnly": "yarn build",
     "test:ci": "jest --no-cache",
     "test:clear": "jest --clearCache",
     "docusaurus": "docusaurus",
-    "docusaurus:generate": "node scripts/md-generate.mjs",
+    "docusaurus:generate": "node scripts/md-generate.mjs; npm run generate-index",
     "docusaurus:start": "docusaurus start",
     "docusaurus:build": "docusaurus build",
     "docusaurus:swizzle": "docusaurus swizzle",
     "docusaurus:deploy": "docusaurus deploy",
     "docusaurus:clear": "docusaurus clear",
     "docusaurus:serve": "docusaurus serve",
     "docusaurus:write-translations": "docusaurus write-translations",
-    "docusaurus:write-heading-ids": "docusaurus write-heading-ids"
+    "docusaurus:write-heading-ids": "docusaurus write-heading-ids",
+    "generate-index": "node scripts/generate-index.mjs"
   },
   "dependencies": {
     "@docusaurus/plugin-google-gtag": "3.9.2",

scripts/generate-index.mjs

@@ -0,0 +1,36 @@
+import fs from 'fs';
+import { readdir } from 'fs/promises';
+import path from 'path';
+
+const SRC_DIR = 'src';
+const INDEX_FILE = path.join(SRC_DIR, 'index.ts');
+
+const toCamelCase = (str) =>
+  str.replace(/-([a-z])/g, (_, char) => char.toUpperCase());
+
+async function generateIndex() {
+  const dirents = await readdir(SRC_DIR, { withFileTypes: true });
+  const exports = [];
+
+  for (const dirent of dirents) {
+    if (!dirent.isDirectory()) continue;
+
+    const methodName = dirent.name;
+    const filePath = path.join(SRC_DIR, methodName, `${methodName}.ts`);
+
+    // skip if file does not exist
+    if (!fs.existsSync(filePath)) continue;
+
+    const exportName = toCamelCase(methodName);
+
+    exports.push(
+      `export { ${exportName} } from './${methodName}/${methodName}';`
+    );
+  }
+
+  const content = exports.join('\n') + '\n';
+  fs.writeFileSync(INDEX_FILE, content);
+  console.log(`Generated ${INDEX_FILE}`);
+}
+
+generateIndex();