feat: support sub exports

Author: antfu

README.md

@@ -204,6 +204,10 @@ Will be converted to:
 const { default: bar, foo } = await import('./foo')
 ```
 
+## Custom Commands
+
+It's also possible to define custom commands.
+
 ## Sponsors
 
 <p align="center">

build.config.ts

@@ -4,6 +4,8 @@ export default defineBuildConfig({
   entries: [
     'src/index',
     'src/config',
+    'src/types',
+    'src/commands.ts',
   ],
   declaration: true,
   clean: true,

package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "version": "0.1.0",
   "packageManager": "[email protected]",
-  "description": "Anthony extended ESLint rules",
+  "description": "Command in comment for one-off codemod with ESLint",
   "author": "Anthony Fu <[email protected]>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/antfu",
@@ -14,7 +14,8 @@
   },
   "bugs": "https://github.com/antfu/eslint-plugin-command/issues",
   "keywords": [
-    "eslint-plugin"
+    "eslint-plugin",
+    "codemod"
   ],
   "sideEffects": false,
   "exports": {
@@ -27,6 +28,16 @@
       "types": "./dist/config.d.ts",
       "import": "./dist/config.mjs",
       "require": "./dist/config.cjs"
+    },
+    "./commands": {
+      "types": "./dist/commands.d.ts",
+      "import": "./dist/commands.mjs",
+      "require": "./dist/commands.cjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.mjs",
+      "require": "./dist/types.cjs"
     }
   },
   "main": "./dist/index.mjs",

src/commands/_test-utils.ts

@@ -1,3 +1,8 @@
+import { RuleTester } from 'eslint'
+import * as tsParser from '@typescript-eslint/parser'
+import { createRuleWithCommands } from '../rule'
+import type { Command } from '../types'
+
 export function d(str: TemplateStringsArray) {
   const lines = str[0].split('\n')
   const commonIndent = lines.slice(1).reduce((min, line) => {
@@ -8,3 +13,50 @@ export function d(str: TemplateStringsArray) {
   }, Number.POSITIVE_INFINITY)
   return lines.map(line => line.slice(commonIndent)).join('\n')
 }
+
+type Arrayable<T> = T | T[]
+
+export interface TestCase extends RuleTester.ValidTestCase {
+  output?: string | null
+  errors?: Arrayable<string | RuleTester.TestCaseError>
+}
+
+export function run(command: Command, ...cases: (TestCase | string)[]) {
+  const ruleTester: RuleTester = new RuleTester({
+    languageOptions: {
+      parser: tsParser,
+    },
+  })
+
+  const validCases: (TestCase | string)[] = []
+  const invalidCases: TestCase[] = []
+
+  for (const c of cases) {
+    if (typeof c === 'string')
+      validCases.push(c)
+    else if (c.errors)
+      invalidCases.push(c)
+    else
+      validCases.push(c)
+  }
+
+  ruleTester.run(
+    command.name,
+    createRuleWithCommands([command]) as any,
+    {
+      valid: validCases,
+      invalid: invalidCases.map(i => ({
+        ...i,
+        code: i.code,
+        output: i.output ?? null,
+        errors: (Array.isArray(i.errors) ? i.errors : [i.errors])
+          .filter(notFalsy)
+          .map(id => typeof id === 'string' ? ({ messageId: id }) : id),
+      })),
+    },
+  )
+}
+
+function notFalsy<T>(value: T): value is Exclude<T, null | undefined | false> {
+  return !!value
+}

src/commands/keep-sorted.test.ts

@@ -1,21 +1,18 @@
-import { RuleTester } from 'eslint'
-import * as tsParser from '@typescript-eslint/parser'
-import { createRuleWithCommands } from '../rule'
 import { keepSorted as command } from './keep-sorted'
-import { d } from './_test-utils'
+import { d, run } from './_test-utils'
 
-const valids = [
+run(
+  command,
   // Already sorted
   d`
-  // @keep-sorted
-  export const arr = [
-    'apple',
-    'bar',
-    'foo',
-  ]`,
-]
+   // @keep-sorted
+   export const arr = [
+     'apple',
+     'bar',
+     'foo',
+   ]`
 
-const invalids = [
+  ,
   // Object property
   {
     code: d`
@@ -32,7 +29,7 @@ const invalids = [
       bar: () => {},
       foo,
     }`,
-    messageId: ['command-fix'],
+    errors: ['command-fix'],
   },
   // Array elements
   {
@@ -50,7 +47,7 @@ const invalids = [
       'bar',
       'foo',
     ]`,
-    messageId: ['command-fix'],
+    errors: ['command-fix'],
   },
   // Type interface members
   {
@@ -72,7 +69,7 @@ const invalids = [
       parentPath: Path | null
     }
     `,
-    messageId: ['command-fix'],
+    errors: ['command-fix'],
   },
   // Type type members
   {
@@ -94,7 +91,7 @@ const invalids = [
       parentPath: Path | null
     }
     `,
-    messageId: ['command-fix'],
+    errors: ['command-fix'],
   },
   {
     code: d`
@@ -117,7 +114,7 @@ const invalids = [
         parentPath: null,
       })
     }`,
-    messageId: ['command-fix'],
+    errors: ['command-fix'],
   },
   // Export statement
   {
@@ -135,22 +132,6 @@ const invalids = [
       bar,
       foo,
     }`,
-    messageId: ['command-fix'],
+    errors: ['command-fix'],
   },
-]
-
-const ruleTester: RuleTester = new RuleTester({
-  languageOptions: {
-    parser: tsParser,
-  },
-})
-
-ruleTester.run(command.name, createRuleWithCommands([command]) as any, {
-  valid: valids,
-  invalid: invalids.map(i => ({
-    code: i.code,
-    output: i.output,
-    errors: (Array.isArray(i.messageId) ? i.messageId : [i.messageId])
-      .map(id => ({ messageId: id })),
-  })),
-})
+)

src/commands/to-arrow.test.ts

@@ -1,23 +1,18 @@
-import { RuleTester } from 'eslint'
-import * as tsParser from '@typescript-eslint/parser'
-import { createRuleWithCommands } from '../rule'
 import { toArrow as command } from './to-arrow'
-import { d } from './_test-utils'
+import { d, run } from './_test-utils'
 
-const valids = [
+run(
+  command,
   'const foo = function () {}',
   `export const foo = <T = 1>(arg: Z): Bar => {
     const bar = () => {}
   }`,
-]
-
-const invalids = [
   {
     code: d`
     /// 2a
     const a = 1`,
     output: null,
-    messageId: 'command-error',
+    errors: 'command-error',
   },
   // Function declaration
   {
@@ -30,7 +25,7 @@ const invalids = [
     export const foo = async <T = 1>(arg: T): Bar => {
       const bar = () => {}
     }`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Function expression
   {
@@ -43,7 +38,7 @@ const invalids = [
     const bar = async <T = 1>(arg: T): Bar => {
       function baz() {}
     }`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Object method
   {
@@ -66,7 +61,7 @@ const invalids = [
         return 1
       },
     }`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Class method
   {
@@ -89,22 +84,6 @@ const invalids = [
         return 1
       }
     }`,
-    messageId: ['command-removal', 'command-fix'],
-  },
-]
-
-const ruleTester: RuleTester = new RuleTester({
-  languageOptions: {
-    parser: tsParser,
+    errors: ['command-removal', 'command-fix'],
   },
-})
-
-ruleTester.run(command.name, createRuleWithCommands([command]) as any, {
-  valid: valids,
-  invalid: invalids.map(i => ({
-    code: i.code,
-    output: i.output,
-    errors: (Array.isArray(i.messageId) ? i.messageId : [i.messageId])
-      .map(id => ({ messageId: id })),
-  })),
-})
+)

src/commands/to-dynamic-import.test.ts

@@ -1,22 +1,16 @@
-import { RuleTester } from 'eslint'
-import * as tsParser from '@typescript-eslint/parser'
-import { createRuleWithCommands } from '../rule'
 import { toDynamicImport as command } from './to-dynamic-import'
-import { d } from './_test-utils'
+import { d, run } from './_test-utils'
 
-const valids = [
-  'const foo = function () {}',
-]
-
-const invalids = [
+run(
+  command,
   // Named import
   {
     code: d`
     /// to-dynamic-import
     import { foo } from 'bar'`,
     output: d`
     const { foo } = await import('bar')`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Default import
   {
@@ -25,7 +19,7 @@ const invalids = [
     import foo from 'bar'`,
     output: d`
     const { default: foo } = await import('bar')`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Namespace
   {
@@ -34,7 +28,7 @@ const invalids = [
     import * as foo from 'bar'`,
     output: d`
     const foo = await import('bar')`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Mixed
   {
@@ -43,15 +37,14 @@ const invalids = [
     import foo, { bar, baz as tex } from 'bar'`,
     output: d`
     const { default: foo, bar, baz: tex } = await import('bar')`,
-    messageId: ['command-removal', 'command-fix'],
+    errors: ['command-removal', 'command-fix'],
   },
   // Type import (error)
   {
     code: d`
     /// to-dynamic-import
     import type { Type } from 'baz'`,
-    output: null,
-    messageId: ['command-error'],
+    errors: ['command-error'],
   },
   // Mixed with type import
   {
@@ -61,22 +54,6 @@ const invalids = [
     output: d`
     import { type Type } from 'bar'
     const { default: foo, bar } = await import('bar')`,
-    messageId: ['command-removal', 'command-fix'],
-  },
-]
-
-const ruleTester: RuleTester = new RuleTester({
-  languageOptions: {
-    parser: tsParser,
+    errors: ['command-removal', 'command-fix'],
   },
-})
-
-ruleTester.run(command.name, createRuleWithCommands([command]) as any, {
-  valid: valids,
-  invalid: invalids.map(i => ({
-    code: i.code,
-    output: i.output,
-    errors: (Array.isArray(i.messageId) ? i.messageId : [i.messageId])
-      .map(id => ({ messageId: id })),
-  })),
-})
+)