Merge pull request #4 from PipedreamHQ/ts-linting

{{ts}} version linting

Author: dylburger

index.js

@@ -218,6 +218,35 @@ function componentSourceDescriptionCheck(context, node) {
   }
 }
 
+function componentVersionTsMacroCheck(context, node) {
+  let component;
+  if (isDefaultExport(node)) {
+    component = node?.body[0]?.declaration;
+  }
+
+  if (node.expression) {
+    const {
+      left,
+      right,
+    } = node.expression;
+    if (isModuleExports(left) && isObjectWithProperties(right)) {
+      component = right;
+    }
+  }
+
+  if (!component) return;
+  const { properties } = component;
+
+  const versionProp = findPropertyWithName("version", properties);
+  if (!versionProp) return;
+  if (versionProp?.value?.value.includes("{{ts}}")) {
+    context.report({
+      node: versionProp,
+      message: "{{ts}} macro should be removed before committing",
+    });
+  }
+}
+
 // Rules run on two different AST node types: ExpressionStatement (CJS) and Program (ESM)
 module.exports = {
   rules: {
@@ -341,5 +370,17 @@ module.exports = {
         };
       },
     },
+    "no-ts-version": {
+      create: function (context) {
+        return {
+          ExpressionStatement(node) {
+            componentVersionTsMacroCheck(context, node);
+          },
+          Program(node) {
+            componentVersionTsMacroCheck(context, node);
+          },
+        };
+      },
+    },
   },
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-pipedream",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "ESLint plugin for Pipedream components: https://pipedream.com/docs/components/api/",
   "main": "index.js",
   "scripts": {

tests/components.js

@@ -95,4 +95,11 @@ module.exports = {
     description: "foo",
     type: "source",
   },
+  tsVersion: {
+    key: "test",
+    name: "Test",
+    description: "foo",
+    type: "action",
+    version: "0.0.{{ts}}",
+  },
 };

tests/rules.test.js

@@ -12,6 +12,7 @@ const {
   missingPropsDescription,
   badSourceName,
   badSourceDescription,
+  tsVersion,
 } = require("./components");
 
 const ruleTester = new RuleTester({
@@ -319,3 +320,32 @@ ruleTester.run("source-description-test", rules["source-description"], {
     },
   ],
 });
+
+ruleTester.run("ts-version-test", rules["no-ts-version"], {
+  valid: [
+    {
+      code: convertObjectToCJSExportString(valid),
+    },
+    {
+      code: convertObjectToESMExportString(valid),
+    },
+  ],
+  invalid: [
+    {
+      code: convertObjectToCJSExportString(tsVersion),
+      errors: [
+        {
+          message: "{{ts}} macro should be removed before committing",
+        },
+      ],
+    },
+    {
+      code: convertObjectToESMExportString(tsVersion),
+      errors: [
+        {
+          message: "{{ts}} macro should be removed before committing",
+        },
+      ],
+    },
+  ],
+});