feat: Allow TypeScript rules to be applied to diff (#2910)

Author: Tohaker

.changeset/tasty-cycles-press.md

@@ -0,0 +1,5 @@
+---
+'@graphql-inspector/diff-command': minor
+---
+
+Allow TypeScript rules to be applied to diff commands from the CLI

packages/commands/diff/__tests__/assets/rule.js

@@ -0,0 +1 @@
+export default ({ changes }) => changes;

packages/commands/diff/__tests__/assets/rule.ts

@@ -0,0 +1,5 @@
+import { Rule } from '@graphql-inspector/core';
+
+const rule: Rule = ({ changes }) => changes;
+
+export default rule;

packages/commands/diff/__tests__/diff-command.test.ts

@@ -106,12 +106,24 @@ describe('diff', () => {
     expect(spyReporter).not.toHaveBeenCalledNormalized('does not exist');
   });
 
-  test('should load rules with local path from fs', async () => {
+  test('should load cjs rules with local path from fs', async () => {
     await mockCommand(diff, 'diff old.graphql new.graphql --rule ./assets/rule.cjs');
 
     expect(spyReporter).not.toHaveBeenCalledNormalized('does not exist');
   });
 
+  test('should load esm rules with local path from fs', async () => {
+    await mockCommand(diff, 'diff old.graphql new.graphql --rule ./assets/rule.js');
+
+    expect(spyReporter).not.toHaveBeenCalledNormalized('does not exist');
+  });
+
+  test('should load typescript rules with local path from fs', async () => {
+    await mockCommand(diff, 'diff old.graphql new.graphql --rule ./assets/rule.ts');
+
+    expect(spyReporter).not.toHaveBeenCalledNormalized('does not exist');
+  });
+
   test('should load rules with absolute path from fs', async () => {
     await mockCommand(
       diff,

packages/commands/diff/package.json

@@ -69,6 +69,9 @@
     "@graphql-inspector/logger": "workspace:*",
     "tslib": "2.6.2"
   },
+  "devDependencies": {
+    "ts-node": "10.9.2"
+  },
   "publishConfig": {
     "directory": "dist",
     "access": "public"

packages/commands/diff/src/index.ts

@@ -33,23 +33,24 @@ export async function handler(input: {
     : failOnBreakingChanges;
 
   let verboseChanges = false;
-  const rules = [...(input.rules ?? [])]
-    .filter(isString)
-    .map((name): Rule | undefined => {
-      if (name === 'verboseChanges') {
-        verboseChanges = true;
-        return;
-      }
-
-      const rule = resolveRule(name);
-
-      if (!rule) {
-        throw new Error(`Rule '${name}' does not exist!\n`);
-      }
-
-      return rule;
-    })
-    .filter((f): f is NonNullable<typeof f> => !!f);
+  const rules = (
+    await Promise.all(
+      [...(input.rules ?? [])].filter(isString).map(async (name): Promise<Rule | undefined> => {
+        if (name === 'verboseChanges') {
+          verboseChanges = true;
+          return;
+        }
+
+        const rule = await resolveRule(name);
+
+        if (!rule) {
+          throw new Error(`Rule '${name}' does not exist!\n`);
+        }
+
+        return rule;
+      }),
+    )
+  ).filter((f): f is NonNullable<typeof f> => !!f);
   if (!verboseChanges) {
     rules.push(DiffRule.simplifyChanges);
   }
@@ -233,10 +234,10 @@ function reportNonBreakingChanges(changes: Change[]) {
   }
 }
 
-function resolveRule(name: string): Rule | undefined {
+async function resolveRule(name: string): Promise<Rule | undefined> {
   const filepath = ensureAbsolute(name);
   if (existsSync(filepath)) {
-    return require(filepath);
+    return (await import(filepath)).default;
   }
 
   return DiffRule[name as keyof typeof DiffRule];