feat: support block comments

Author: antfu

src/commands/keep-sorted.test.ts

@@ -10,9 +10,7 @@ run(
      'apple',
      'bar',
      'foo',
-   ]`
-
-  ,
+   ]`,
   // Object property
   {
     code: d`
@@ -208,4 +206,32 @@ run(
     ]`,
     errors: ['command-error'],
   },
+  // Block comment
+  {
+    code: d`
+    /**
+     * Some JSdocs
+     *
+     * @keep-sorted
+     * @description
+     */
+    export const arr = [
+      'foo',
+      'bar',
+      'apple',
+    ]`,
+    output: d`
+    /**
+     * Some JSdocs
+     *
+     * @keep-sorted
+     * @description
+     */
+    export const arr = [
+      'apple',
+      'bar',
+      'foo',
+    ]`,
+    errors: ['command-fix'],
+  },
 )

src/commands/keep-sorted.ts

@@ -5,9 +5,13 @@ export interface KeepSortedInlineOptions {
   keys?: string[]
 }
 
+const reLine = /^[\/@:]\s*(?:keep-sorted|sorted)\s*({.*})?$/
+const reBlock = /(?:\b|\s)@keep-sorted\s*({.*})?(?:\b|\s|$)/
+
 export const keepSorted: Command = {
   name: 'keep-sorted',
-  match: /^[\/@:]\s*(?:keep-sorted|sorted)\s*({.*})?$/,
+  commentType: 'both',
+  match: comment => comment.value.trim().match(comment.type === 'Line' ? reLine : reBlock),
   action(ctx) {
     const optionsRaw = ctx.matches[1] || '{}'
     let options: KeepSortedInlineOptions | null = null

src/rule.ts

@@ -26,16 +26,27 @@ export function createRuleWithCommands(commands: Command[]) {
       const comments = sc.getAllComments()
 
       for (const comment of comments) {
-        if (comment.type !== 'Line')
-          continue
-
         const commandRaw = comment.value.trim()
         for (const command of commands) {
-          const matches = commandRaw.match(command.match)
-          if (matches) {
-            command.action(new CommandContext(context, comment, command, matches))
+          const type = command.commentType ?? 'line'
+          if (type === 'line' && comment.type !== 'Line')
+            continue
+          if (type === 'block' && comment.type !== 'Block')
             continue
-          }
+
+          let matches = typeof command.match === 'function'
+            ? command.match(comment)
+            : commandRaw.match(command.match)
+
+          if (!matches)
+            continue
+
+          // create a dummy match for user provided function that returns `true`
+          if (matches === true)
+            matches = '__dummy__'.match('__dummy__')!
+
+          command.action(new CommandContext(context, comment, command, matches))
+          break
         }
       }
       return {}

src/types.ts

@@ -9,8 +9,29 @@ export type RuleOptions = []
 export type MessageIds = 'command-error' | 'command-error-cause' | 'command-fix' | 'command-removal'
 
 export interface Command {
-  match: RegExp
+  /**
+   * The name of the command
+   * Used to identify the command in reported errors
+   */
   name: string
+  /**
+   * RegExp to match the comment, without the leading `//` or `/*`
+   */
+  match: RegExp | ((comment: Tree.Comment) => RegExpMatchArray | boolean | undefined | null)
+  /**
+   * The type of the comment
+   *
+   * - `line` - `//`
+   * - `block` - `/*`
+   *
+   * @default 'line'
+   */
+  commentType?: 'line' | 'block' | 'both'
+  /**
+   * Main action of the command
+   *
+   * @param ctx The context of the command (per-file, per matched comment)
+   */
   action: (ctx: CommandContext) => void
 }