add no-restricted-imports rule for workflows in samples to disallow i…

…mporting node built-ins (temporalio#133) * add no-restricted-imports rule for workflows in samples to disallow importing node built-ins Fix temporalio#106 * Prettier * use `module.builtinModules` instead of hard-coded list Co-authored-by: Loren 🤓 <[email protected]>
field-energy · Apr 20, 2022 · 5275d91 · 5275d91
1 parent fb38b50
commit 5275d91
Show file tree

Hide file tree

Showing 26 changed files with 390 additions and 0 deletions.
diff --git a/.shared/.eslintrc.js b/.shared/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/activities-cancellation-heartbeating/.eslintrc.js b/activities-cancellation-heartbeating/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/activities-dependency-injection/.eslintrc.js b/activities-dependency-injection/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/activities-examples/.eslintrc.js b/activities-examples/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/activities-sticky-queues/.eslintrc.js b/activities-sticky-queues/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/child-workflows/.eslintrc.js b/child-workflows/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/continue-as-new/.eslintrc.js b/continue-as-new/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/cron-workflows/.eslintrc.js b/cron-workflows/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/dsl-interpreter/.eslintrc.js b/dsl-interpreter/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/ejson/.eslintrc.js b/ejson/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/encryption/.eslintrc.js b/encryption/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/expense/.eslintrc.js b/expense/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/grpc-calls/.eslintrc.js b/grpc-calls/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/hello-world-mtls/.eslintrc.js b/hello-world-mtls/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/hello-world/.eslintrc.js b/hello-world/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };
diff --git a/instrumentation/.eslintrc.js b/instrumentation/.eslintrc.js
@@ -1,3 +1,7 @@
+const { builtinModules } = require('module');
+
+const ALLOWED_NODE_BUILTINS = new Set(['assert']);
+
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
@@ -30,4 +34,15 @@ module.exports = {
     ],
     '@typescript-eslint/no-explicit-any': 'off',
   },
+  overrides: [
+    {
+      files: ['src/workflows.ts', 'src/workflows-*.ts', 'src/workflows/*.ts'],
+      rules: {
+        'no-restricted-imports': [
+          'error',
+          ...builtinModules.filter(m => !ALLOWED_NODE_BUILTINS.has(m)).flatMap(m => [m, `node:${m}`])
+        ],
+      },
+    },
+  ],
 };