Merge pull request #193 from Commencis/feature/commencis-copyright-te…

…xt-replacement feat(eslint-plugin): update copyright-text rule fixer for text replacement
Commencis · Jan 1, 2025 · 5c5689a · 5c5689a
2 parents c01a3a5 + 11473d6
commit 5c5689a
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 4 deletions.
diff --git a/.changeset/four-frogs-agree.md b/.changeset/four-frogs-agree.md
@@ -0,0 +1,5 @@
+---
+'@commencis/eslint-plugin': minor
+---
+
+feat: add support for Commencis copyright-text replacement to ESLint fixer
diff --git a/packages/eslint-plugin/src/rules/copyright-text.ts b/packages/eslint-plugin/src/rules/copyright-text.ts
@@ -1,7 +1,11 @@
 import { TSESTree } from '@typescript-eslint/utils';
 
 import { DEFAULT_START_YEAR } from '@/constants';
-import { createRule, getCopyrightText } from '@/utils';
+import {
+  createRule,
+  getCopyrightText,
+  validateCommencisCopyright,
+} from '@/utils';
 
 type RuleOptions = {
   startYear?: number;
@@ -19,7 +23,7 @@ export default createRule<[RuleOptions], MessageIds>({
     },
     messages: {
       missingCopyright:
-        'File must start with the required Commencis copyright text.',
+        'File must start with the required Commencis copyright text with correct dates.',
     },
     schema: [
       {
@@ -46,15 +50,23 @@ export default createRule<[RuleOptions], MessageIds>({
     return {
       Program(node: TSESTree.Program): void {
         const sourceCode = context.sourceCode.getText();
+        const firstComment = context.sourceCode.getAllComments()[0];
         const trimmedText = sourceCode.trimStart();
+        const isCopyrightValid = trimmedText.startsWith(expectedCopyrightText);
+
+        if (!isCopyrightValid) {
+          const isCommencisCopyrightExists =
+            validateCommencisCopyright(firstComment);
 
-        if (!trimmedText.startsWith(expectedCopyrightText)) {
           context.report({
             node,
             messageId: 'missingCopyright',
             fix(fixer) {
               const insertText = `${expectedCopyrightText}\n\n`;
-              return fixer.insertTextBeforeRange([0, 0], insertText);
+
+              return isCommencisCopyrightExists
+                ? fixer.replaceText(firstComment, insertText)
+                : fixer.insertTextBeforeRange([0, 0], insertText);
             },
           });
         }

diff --git a/packages/eslint-plugin/src/utils/index.ts b/packages/eslint-plugin/src/utils/index.ts
@@ -1,3 +1,4 @@
 export * from './createRule';
 export * from './getCopyrightText';
 export * from './getDocsUrl';
+export * from './validateCommencisCopyright';
diff --git a/packages/eslint-plugin/src/utils/validateCommencisCopyright.ts b/packages/eslint-plugin/src/utils/validateCommencisCopyright.ts
@@ -0,0 +1,12 @@
+import { AST_TOKEN_TYPES, TSESTree } from '@typescript-eslint/utils';
+
+export function validateCommencisCopyright(
+  commentNode?: TSESTree.Comment
+): boolean {
+  return (
+    !!commentNode &&
+    commentNode.type === AST_TOKEN_TYPES.Block &&
+    commentNode.value.includes('Commencis') &&
+    commentNode.value.includes('Copyright')
+  );
+}