feat(ts/lines-around-comment): add missing afterHashbangComment in …

…schema, fix #75 (#161)
eslint-stylistic · Nov 17, 2023 · 391335b · 391335b
1 parent b346087
commit 391335b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/packages/eslint-plugin-ts/rules/lines-around-comment/lines-around-comment.test.ts b/packages/eslint-plugin-ts/rules/lines-around-comment/lines-around-comment.test.ts
@@ -1049,5 +1049,14 @@ interface A {
       ],
       errors: [{ messageId: 'after', type: AST_TOKEN_TYPES.Line, line: 2 }],
     },
+
+    // Hashbang comment
+    {
+      code: '#!foo\nvar a = 1;',
+      output: '#!foo\n\nvar a = 1;',
+      options: [{ afterHashbangComment: true }],
+      // @ts-expect-error -- Shebang is not in the type
+      errors: [{ messageId: 'after', type: 'Shebang' }],
+    },
   ],
 })
diff --git a/packages/eslint-plugin-ts/rules/lines-around-comment/lines-around-comment.ts b/packages/eslint-plugin-ts/rules/lines-around-comment/lines-around-comment.ts
@@ -126,6 +126,9 @@ export default createRule<RuleOptions, MessageIds>({
           applyDefaultIgnorePatterns: {
             type: 'boolean',
           },
+          afterHashbangComment: {
+            type: 'boolean',
+          },
         },
         additionalProperties: false,
       },

diff --git a/packages/eslint-plugin-ts/rules/lines-around-comment/types.d.ts b/packages/eslint-plugin-ts/rules/lines-around-comment/types.d.ts
@@ -23,6 +23,7 @@ export interface Schema0 {
   allowModuleEnd?: boolean
   ignorePattern?: string
   applyDefaultIgnorePatterns?: boolean
+  afterHashbangComment?: boolean
 }
 
 export type RuleOptions = [Schema0?]