feat: add fixer to invalid file annotation style message (#440)

* Add fixer to invalid file annotation style message * Add flow strict test
gajus · Jan 11, 2020 · 97a230b · 97a230b
1 parent dccaa76
commit 97a230b
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 3 deletions.
diff --git a/src/rules/requireValidFileAnnotation.js b/src/rules/requireValidFileAnnotation.js
@@ -94,9 +94,18 @@ const create = (context) => {
         const annotationValue = potentialFlowFileAnnotation.value.trim();
         if (isFlowFileAnnotation(annotationValue)) {
           if (!isValidAnnotationStyle(potentialFlowFileAnnotation, style)) {
-            const str = style === 'line' ? '`// ' + annotationValue + '`' : '`/* ' + annotationValue + ' */`';
-
-            context.report(potentialFlowFileAnnotation, 'Flow file annotation style must be ' + str);
+            const annotation = style === 'line' ? '// ' + annotationValue : '/* ' + annotationValue + ' */';
+
+            context.report({
+              fix: (fixer) => {
+                return fixer.replaceTextRange(
+                  [potentialFlowFileAnnotation.start, potentialFlowFileAnnotation.end],
+                  annotation
+                );
+              },
+              message: 'Flow file annotation style must be `' + annotation + '`',
+              node: potentialFlowFileAnnotation,
+            });
           }
           if (!noFlowAnnotation(annotationValue) && flowStrict) {
             if (!isFlowStrict(annotationValue)) {

diff --git a/tests/rules/assertions/requireValidFileAnnotation.js b/tests/rules/assertions/requireValidFileAnnotation.js
@@ -211,6 +211,36 @@ export default {
       ],
       output: '// @flow strict\na;\nb;',
     },
+    {
+      code: '/* @flow */\na;\nb;',
+      errors: [
+        {
+          message: 'Flow file annotation style must be `// @flow`',
+        },
+      ],
+      options: [
+        'never',
+        {
+          annotationStyle: 'line',
+        },
+      ],
+      output: '// @flow\na;\nb;',
+    },
+    {
+      code: '/* @flow strict */\na;\nb;',
+      errors: [
+        {
+          message: 'Flow file annotation style must be `// @flow strict`',
+        },
+      ],
+      options: [
+        'never',
+        {
+          annotationStyle: 'line',
+        },
+      ],
+      output: '// @flow strict\na;\nb;',
+    },
   ],
   misconfigured: [
     {