fix: code review

.circleci/config.yml

@@ -17,6 +17,9 @@ jobs:
       - run:
           name: test
           command: npm run test
+      - run:
+          name: install ts
+          command: npm i -g typescript && npm i -g ts-node
       - run:
           name: benchmark wrap functionality
           command: npm run benchmark

rollup.config.js

@@ -7,39 +7,46 @@ import commonjs from '@rollup/plugin-commonjs';
 import resolve from '@rollup/plugin-node-resolve';
 import pkge from './package.json'
 
-let filepaths = [];
+// Right now,  vercel/pkg  does not support ESM libraries (https://github.com/vercel/pkg/issues/782)
+// For example, some files rely on @govtechsg/open-attestation, @govtechsg/oa-XX. These libraries in turn rely on jsonLd library, which is an ESM library
+// To bypass this issue, files that rely on the ESM libraries can be bundled into a single JS file,
+// thereby removing the problematic import / export statements.
 
-const walk = (root) => {
+// traverse through the directory recursively to get all file paths relative to root directory
+const traverseAndGetFilePaths = (root, filepaths = []) => {
   let currentPaths = fs.readdirSync(root);
   for (let path of currentPaths) {
-    const abspath = `${root}/${path}`;
-    const isFile = /.*\.(ts|js|json)$/.test(path);
+    const absPath = `${root}/${path}`;
+
+    const isFile = /.*\.(ts|js|json|file)$/.test(path);
+    const isDirectory = !isFile;
+
+    // exclude type and test files
+    // const isTestFile = path.includes("test");
+    // const isTypeFile = path.includes("type");
+    // const isRegularFile = isFile && !(isTestFile);
 
     if (isFile) {
-      filepaths.push(abspath);
-    } else {
-      // isDirectory
-      walk(abspath);
+      filepaths.push(absPath);
+    } else if (isDirectory) {
+      traverseAndGetFilePaths(absPath, filepaths);
     }
   }
-
+  return filepaths;
 }
 
-walk('./src/commands');
+const filepaths = traverseAndGetFilePaths('./src/commands');
 filepaths.push("./src/index.ts");
 
-// exclude type and test files
-filepaths = filepaths
-  .filter(path => !path.includes("test"))
-  .filter(path => !path.includes("type"));
+console.log({filepaths});
 
-// console.log(filepaths);
+// exclude all external dependencies from being bundled together, except for the problematic jsonLd, used by "@govtechsg/open-attestation", "@govtechsg/oa-XX" dependencies
+let deps = [...Object.keys(pkge.dependencies), ...Object.keys(pkge.devDependencies)];
+deps = deps
+  .filter((dep) => !dep.startsWith("@govtechsg/oa-"))
+  .filter((dep) => !dep.startsWith("@govtechsg/open-attestation"))
 
-// exclude all dependencies from being bundled together, except for the problematic jsonLd, used by "open-attestation", "oa-verify" dependencies
-let deps = [...Object.keys(pkge.dependencies), ...Object.keys(pkge.devDependencies)]
-deps = deps.filter( (dep) => !(/oa\-|open-attestation/.test(dep)) )
-
-// console.log(deps);
+console.log({deps});
 
 export default {
   input: filepaths,
@@ -53,11 +60,23 @@ export default {
   plugins: [
       resolve(),
       commonjs(),
-      typescript(),
+      typescript({ "module": "esnext" }),
       json(),
       shebang({
         include: './src/index.ts'
       }),
       multiInput()
   ],
 };
+
+// Explaination of plugins[]
+/*
+resolve: By default, rollup does not know how to find node modules. For example, for the line, `import axios from "axios" `, rollup thinks that there is a
+relative file called axios.js
+commonJS: Convert CommonJS modules to ES6, so they can be included in a Rollup bundle. Rollup only recognises es6 js files.
+typescript(): Convert typescript to js so that rollup can process. rollup only works on js files by default
+json(): Rollup only recognises js file. json() s.json files to ES6 modules
+shebang(): to preserver the shebang line #!/usr/bin/env node in src/index.ts
+multiInput(): By default Rollup bundles every files into a single file from a single entry point. multiinput() allow us to have multiple entry points and
+multiple output paths.
+*/

tsconfig.json

@@ -7,7 +7,7 @@
     "allowSyntheticDefaultImports": true,
     "strict": true,
     "forceConsistentCasingInFileNames": true,
-    "module": "esnext",
+    "module": "CommonJS",
     "moduleResolution": "node",
     "resolveJsonModule": true,
     "jsx": "react",