feat: add support for TS by pre-compiling it before parsing with babel.

Author: matheusccastroo

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.5.0 - 2024-04-26
+
+### Bug fixes
+
+- Fix error when babel config is not found by returning an empty array.
+- Add guard to `auditArgumentChecks` since `node` could be empty.
+
+### Changes
+
+- Add support to `TS` and `TSX` files by `pre-compiling` it with the `typescript` compiler.
+
 ## 1.4.2 - 2024-03-22
 
 ### Bug fixes

lib/rules/audit-argument-checks.js

@@ -47,7 +47,7 @@ module.exports = {
     }
 
     function auditArgumentChecks(node) {
-      if (!isFunction(node.type)) {
+      if (!node || !isFunction(node.type)) {
         return;
       }
 

lib/rules/no-sync-mongo-methods-on-server.js

@@ -79,7 +79,7 @@ module.exports = {
           archList: ['server'],
           isTest,
           onFile: ({ path }) => {
-            debug(`Processing file ${path}`);
+            debug(`Processing file no-sync-mongo-methods-on-server ${path}`);
           },
         });
       },

lib/rules/no-sync-user-methods-on-server.js

@@ -6,6 +6,7 @@
  */
 
 const { Walker, getInitFolder, shouldSkip } = require('../util/walker');
+const { debug } = require("../util/utilities");
 
 function isCallingUserMethod(node) {
     const isCallExpression = node &&
@@ -49,7 +50,9 @@ module.exports = {
                 new Walker(getInitFolder(context)).walkApp({
                     archList: ['server'],
                     isTest,
-                    onFile: () => {},
+                    onFile: ({ path }) => {
+                        debug(`Processing file no-sync-user-methods-on-server ${path}`);
+                    },
                 });
             },
             CallExpression: function(node) {

lib/util/parse.js

@@ -23,7 +23,7 @@ function findBabelConfig(startDir, appDir) {
 
   const parentDir = path.resolve(startDir, '..');
   if (!parentDir.includes(appDir)) {
-    return false;
+    return [];
   }
 
   return findBabelConfig(parentDir, appDir);
@@ -47,10 +47,48 @@ function findModuleResolveConfig(filePath, appDir) {
   }
 }
 
+function precompileTypeScript(filePath, fileContent) {
+  if (filePath && !filePath.endsWith(".ts") && !filePath.endsWith(".tsx")) {
+    throw new Error("Trying to precompile a non TS file");
+  }
+
+  const ts = require("typescript");
+  try {
+    return ts.transpileModule(fileContent, {
+      filePath,
+      compilerOptions: {
+        target: ts.ScriptTarget.ESNext,
+        // Leave module syntax intact so that Babel/Reify can handle it.
+        module: ts.ModuleKind.ESNext,
+        // This used to be false by default, but appears to have become
+        // true by default around the release of [email protected]. It's
+        // important to disable this option because enabling it allows
+        // TypeScript to use helpers like __importDefault, which are much
+        // better handled by Babel/Reify later in the pipeline.
+        esModuleInterop: false,
+        sourceMap: false,
+        inlineSources: false,
+        experimentalDecorators: true,
+        emitDecoratorMetadata: true,
+        jsx: ts.JsxEmit.React,
+      }
+    });
+  } catch (e) {
+    e.message = `While compiling ${filePath}: ${e.message}`;
+    throw e;
+  }
+}
+
 module.exports = function readAndParse(filePath) {
-  const content = fs.readFileSync(filePath, 'utf-8');
+  if (!filePath) {
+    throw Error("Missing file path");
+  }
 
-  const ast = parse(content, {
+  const fileContent = fs.readFileSync(filePath, 'utf-8');
+  const isTsFile = filePath.endsWith(".ts") || filePath.endsWith("tsx");
+  const codeContent = isTsFile ? precompileTypeScript(filePath, fileContent).outputText : fileContent;
+
+  return parse(codeContent, {
     parser: {
       parse: (source) =>
         meteorBabelParser(source, {
@@ -59,8 +97,6 @@ module.exports = function readAndParse(filePath) {
         }),
     },
   });
-
-  return ast;
 };
 
 module.exports.findImports = function findImports(filePath, ast, appDir) {

lib/util/walker.js

@@ -53,8 +53,7 @@ function shouldWalk(folderPath, archList) {
 
 function findExt(filePath) {
   const ext = parseableExt.find((possibleExt) => {
-    const exists = fs.existsSync(filePath + possibleExt);
-    return exists;
+    return fs.existsSync(filePath + possibleExt);
   });
 
   if (ext) {
@@ -103,15 +102,11 @@ function getAbsFilePath(filePath) {
   // some files have no ext or are only the ext (.gitignore, .editorconfig, etc.)
   const existingExt =
     path.extname(filePath) || path.basename(filePath).startsWith('.');
-  if (!existingExt) {
+
+  if (!existingExt || !parseableExt.includes(existingExt)) {
     // TODO: should maybe only do this if a file doesn't exists with the given path
     // since we might be importing a file with no extension.
-    const pathWithExt = findExt(filePath);
-    if (!pathWithExt) {
-      return pathWithExt;
-    }
-
-    return pathWithExt;
+    return findExt(filePath);
   }
 
   // TODO: if the file doesn't exist, we must try other extensions
@@ -255,32 +250,27 @@ class Walker {
       debug('Cache is not going to be used');
     }
     this.cachedParsedFile = useCache
-      ? JSON.parse(fs.readFileSync(this.filePath()))
+      ? JSON.parse(fs.readFileSync(this.filePath(), 'utf-8'))
       : {};
   }
-  walkApp({ archList, onFile,  isTest }) {
+  walkApp({ archList, onFile, isTest }) {
     if (Object.keys(this.cachedParsedFile).length > 0) {
       debug('Not walking the app as the cachedParsedFile is already present');
       return;
     }
 
-    let initialServerFile;
     const packageJsonLocation = path.join(this.appPath, 'package.json');
     if (fs.existsSync(packageJsonLocation)) {
-      const content = JSON.parse(fs.readFileSync(packageJsonLocation));
-      const { meteor } = content;
+      const { meteor } = JSON.parse(fs.readFileSync(packageJsonLocation, 'utf-8'));
       if (meteor && meteor.mainModule && meteor.mainModule.server) {
-        initialServerFile = path.join(this.appPath, meteor.mainModule.server);
         debug('Starting from meteor.mainModule.server from package.json', meteor.mainModule.server);
+        handleFile(
+          path.join(this.appPath, meteor.mainModule.server),
+          this.appPath,
+          onFile,
+          this.cachedParsedFile
+        );
       }
-    }
-    if (initialServerFile) {
-      handleFile(
-        initialServerFile,
-        this.appPath,
-        onFile,
-        this.cachedParsedFile
-      );
     } else {
       handleFolder(
         this.appPath,
@@ -290,8 +280,10 @@ class Walker {
         this.cachedParsedFile
       );
     }
+
     fs.writeFileSync(this.filePath(), JSON.stringify(this.cachedParsedFile));
   }
+
   get cachedParsedFile() {
     return this.cachedParsedFile;
   }

package-lock.json

@@ -36,6 +36,7 @@
     "readline-sync": "^1.4.10",
     "recast": "^0.23.4",
     "reify": "^0.20.12",
+    "typescript": "^5.4.5",
     "validate-commit-msg": "^2.14.0"
   },
   "peerDependencies": {