docs: mention custom commands

Author: antfu

README.md

@@ -206,7 +206,34 @@ const { default: bar, foo } = await import('./foo')
 
 ## Custom Commands
 
-It's also possible to define custom commands.
+It's also possible to define your custom commands.
+
+```js
+// eslint.config.mjs
+import command from 'eslint-plugin-command/config'
+import { builtinCommands, defineCommand } from 'eslint-plugin-command/commands'
+
+const myCommand = defineCommand({
+  name: 'my-command',
+  // RegExp to match the command comment (without leading `//`)
+  match: /^@my-command$/,
+  action(context) {
+    // Do something with the context
+  },
+})
+
+export default [
+  // ... your other flat config
+  command({
+    commands: [
+      ...builtinCommands,
+      myCommand,
+    ]
+  }),
+]
+```
+
+You can refer to [the built-in commands for examples](./src/commands/).
 
 ## Sponsors
 

package.json

@@ -51,6 +51,12 @@
       ],
       "./config": [
         "./dist/config.d.ts"
+      ],
+      "./commands": [
+        "./dist/commands.d.ts"
+      ],
+      "./types": [
+        "./dist/types.d.ts"
       ]
     }
   },

src/commands.ts

@@ -1 +1,4 @@
 export * from './commands/index'
+
+export type { Command } from './types'
+export { defineCommand } from './types'

src/commands/index.ts

@@ -16,11 +16,11 @@ export {
 }
 
 // @keep-sorted
-export const commands = {
+export const builtinCommands = [
   keepSorted,
   toArrow,
   toDynamicImport,
   toForEach,
   toForOf,
   toFunction,
-}
+]

src/rule.ts

@@ -1,6 +1,6 @@
 import { createEslintRule } from './utils'
 import type { Command, MessageIds, RuleOptions } from './types'
-import { commands } from './commands'
+import { builtinCommands } from './commands'
 import { CommandContext } from './context'
 
 export function createRuleWithCommands(commands: Command[]) {
@@ -43,4 +43,4 @@ export function createRuleWithCommands(commands: Command[]) {
   })
 }
 
-export default createRuleWithCommands(Object.values(commands))
+export default /* @__PURE__ */ createRuleWithCommands(builtinCommands)

src/types.ts

@@ -54,3 +54,7 @@ export type CommandReportErrorCauseDescriptor = {
    */
   message: string
 }
+
+export function defineCommand(command: Command) {
+  return command
+}