@atlaskit/eslint-plugin-platform 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.0.7
+
+### Patch Changes
+
+- [`0cab60b90c3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0cab60b90c3) - Add fix to eslint rule on the arguments of nested test runner
+
 ## 0.0.6
 
 ### Patch Changes

package/dist/cjs/rules/ensure-test-runner-arguments/index.js

@@ -13,11 +13,12 @@ var rule = {
       recommended: false
     },
     type: 'problem',
+    fixable: 'code',
     messages: {
       onlyInlineFeatureFlag: 'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
       onlyInlineTestFunction: 'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
-      passDownExistingFeatureFlagParam: 'Existing feature flags need to be passed down as params when calling nested test runner. See examples in the package which declares this function.',
-      passDownExistingFeatureFlagArgument: 'Existing feature flags need to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagParam: 'An argument symbolising existing FFs needs to be passed down as param when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagArgument: 'An argument symbolising existing FFs needs to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
       passDownExistingFeatureFlagNamesMatch: 'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.'
     }
   },
@@ -64,25 +65,35 @@ var rule = {
           // Not pass in ff to the function that calls test runner
           if (!node.parent.params[0] || node.parent.params[0].type !== 'Identifier') {
             return context.report({
-              node: node,
-              messageId: 'passDownExistingFeatureFlagParam'
+              node: node.parent,
+              messageId: 'passDownExistingFeatureFlagParam',
+              fix: function fix(fixer) {
+                var parentNodeRange = node.parent.range;
+                return [fixer.replaceTextRange([parentNodeRange[0], parentNodeRange[0] + 2], 'ff'), node.arguments[3] ? fixer.replaceText(node.arguments[3], 'ff') : fixer.insertTextAfter(node.arguments[2], ', ff')];
+              }
             });
           }
 
           // Not pass in ff to test runner as 4th argument
+          var paramName = node.parent.params[0].name;
           if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
             return context.report({
               node: node,
-              messageId: 'passDownExistingFeatureFlagArgument'
+              messageId: 'passDownExistingFeatureFlagArgument',
+              fix: function fix(fixer) {
+                return node.arguments[3] ? fixer.replaceText(node.arguments[3], paramName) : fixer.insertTextAfter(node.arguments[2], ", ".concat(paramName));
+              }
             });
           }
           // Pass in the above two, but names don't match
-          var paramName = node.parent.params[0].name;
           var arguName = node.arguments[3].name;
           if (paramName !== arguName) {
             return context.report({
-              node: node,
-              messageId: 'passDownExistingFeatureFlagNamesMatch'
+              node: node.parent,
+              messageId: 'passDownExistingFeatureFlagNamesMatch',
+              fix: function fix(fixer) {
+                return fixer.replaceText(node.arguments[3], paramName);
+              }
             });
           }
         }

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.6",
+	"version": "0.0.7",
 	"sideEffects": false
 }

package/dist/es2019/rules/ensure-test-runner-arguments/index.js

@@ -5,11 +5,12 @@ const rule = {
       recommended: false
     },
     type: 'problem',
+    fixable: 'code',
     messages: {
       onlyInlineFeatureFlag: 'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
       onlyInlineTestFunction: 'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
-      passDownExistingFeatureFlagParam: 'Existing feature flags need to be passed down as params when calling nested test runner. See examples in the package which declares this function.',
-      passDownExistingFeatureFlagArgument: 'Existing feature flags need to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagParam: 'An argument symbolising existing FFs needs to be passed down as param when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagArgument: 'An argument symbolising existing FFs needs to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
       passDownExistingFeatureFlagNamesMatch: 'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.'
     }
   },
@@ -57,25 +58,35 @@ const rule = {
             // Not pass in ff to the function that calls test runner
             if (!node.parent.params[0] || node.parent.params[0].type !== 'Identifier') {
               return context.report({
-                node,
-                messageId: 'passDownExistingFeatureFlagParam'
+                node: node.parent,
+                messageId: 'passDownExistingFeatureFlagParam',
+                fix: function (fixer) {
+                  const parentNodeRange = node.parent.range;
+                  return [fixer.replaceTextRange([parentNodeRange[0], parentNodeRange[0] + 2], 'ff'), node.arguments[3] ? fixer.replaceText(node.arguments[3], 'ff') : fixer.insertTextAfter(node.arguments[2], ', ff')];
+                }
               });
             }
 
             // Not pass in ff to test runner as 4th argument
+            const paramName = node.parent.params[0].name;
             if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
               return context.report({
                 node,
-                messageId: 'passDownExistingFeatureFlagArgument'
+                messageId: 'passDownExistingFeatureFlagArgument',
+                fix: function (fixer) {
+                  return node.arguments[3] ? fixer.replaceText(node.arguments[3], paramName) : fixer.insertTextAfter(node.arguments[2], `, ${paramName}`);
+                }
               });
             }
             // Pass in the above two, but names don't match
-            const paramName = node.parent.params[0].name;
             const arguName = node.arguments[3].name;
             if (paramName !== arguName) {
               return context.report({
-                node,
-                messageId: 'passDownExistingFeatureFlagNamesMatch'
+                node: node.parent,
+                messageId: 'passDownExistingFeatureFlagNamesMatch',
+                fix: function (fixer) {
+                  return fixer.replaceText(node.arguments[3], paramName);
+                }
               });
             }
           }

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.6",
+	"version": "0.0.7",
 	"sideEffects": false
 }

package/dist/esm/rules/ensure-test-runner-arguments/index.js

@@ -6,11 +6,12 @@ var rule = {
       recommended: false
     },
     type: 'problem',
+    fixable: 'code',
     messages: {
       onlyInlineFeatureFlag: 'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
       onlyInlineTestFunction: 'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
-      passDownExistingFeatureFlagParam: 'Existing feature flags need to be passed down as params when calling nested test runner. See examples in the package which declares this function.',
-      passDownExistingFeatureFlagArgument: 'Existing feature flags need to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagParam: 'An argument symbolising existing FFs needs to be passed down as param when calling nested test runner. See examples in the package which declares this function.',
+      passDownExistingFeatureFlagArgument: 'An argument symbolising existing FFs needs to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
       passDownExistingFeatureFlagNamesMatch: 'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.'
     }
   },
@@ -57,25 +58,35 @@ var rule = {
           // Not pass in ff to the function that calls test runner
           if (!node.parent.params[0] || node.parent.params[0].type !== 'Identifier') {
             return context.report({
-              node: node,
-              messageId: 'passDownExistingFeatureFlagParam'
+              node: node.parent,
+              messageId: 'passDownExistingFeatureFlagParam',
+              fix: function fix(fixer) {
+                var parentNodeRange = node.parent.range;
+                return [fixer.replaceTextRange([parentNodeRange[0], parentNodeRange[0] + 2], 'ff'), node.arguments[3] ? fixer.replaceText(node.arguments[3], 'ff') : fixer.insertTextAfter(node.arguments[2], ', ff')];
+              }
             });
           }
 
           // Not pass in ff to test runner as 4th argument
+          var paramName = node.parent.params[0].name;
           if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
             return context.report({
               node: node,
-              messageId: 'passDownExistingFeatureFlagArgument'
+              messageId: 'passDownExistingFeatureFlagArgument',
+              fix: function fix(fixer) {
+                return node.arguments[3] ? fixer.replaceText(node.arguments[3], paramName) : fixer.insertTextAfter(node.arguments[2], ", ".concat(paramName));
+              }
             });
           }
           // Pass in the above two, but names don't match
-          var paramName = node.parent.params[0].name;
           var arguName = node.arguments[3].name;
           if (paramName !== arguName) {
             return context.report({
-              node: node,
-              messageId: 'passDownExistingFeatureFlagNamesMatch'
+              node: node.parent,
+              messageId: 'passDownExistingFeatureFlagNamesMatch',
+              fix: function fix(fixer) {
+                return fixer.replaceText(node.arguments[3], paramName);
+              }
             });
           }
         }

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.6",
+	"version": "0.0.7",
 	"sideEffects": false
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-platform",
   "description": "The essential plugin for use with Atlassian frontend platform tools",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",

package/src/rules/ensure-test-runner-arguments/__tests__/unit/rule.test.tsx

@@ -145,6 +145,32 @@ describe('Verify existing ff overrides are passed down if test runner is nested'
             ),
         );
         `,
+        output: `ffTest(
+          'uip.sample.color',
+          ff =>
+            ffTest(
+              'uip.sample.backgroundColor',
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: red');
+              },
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: red');
+              },
+              ff,
+            ),
+          ff =>
+            ffTest(
+              'uip.sample.backgroundColor',
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
+              },
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
+              },
+              ff,
+            ),
+        );
+        `,
         errors: [
           {
             messageId: 'passDownExistingFeatureFlagParam',
@@ -177,6 +203,31 @@ describe('Verify existing ff overrides are passed down if test runner is nested'
             ),
         );
         `,
+        output: `ffTest(
+          'uip.sample.color',
+          ff =>
+            ffTest(
+              'uip.sample.backgroundColor',
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: red');
+              },
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: red');
+              }, ff,
+            ),
+          ff =>
+            ffTest(
+              'uip.sample.backgroundColor',
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
+              },
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
+              },
+              ff,
+            ),
+        );
+        `,
         errors: [
           {
             messageId: 'passDownExistingFeatureFlagArgument',
@@ -210,6 +261,32 @@ describe('Verify existing ff overrides are passed down if test runner is nested'
             ),
         );
         `,
+        output: `ffTest(
+          'uip.sample.color',
+          ff =>
+            ffTest(
+              'uip.sample.backgroundColor',
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: red');
+              },
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: red');
+              },
+              ff,
+            ),
+          ff =>
+            ffTest(
+              'uip.sample.backgroundColor',
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
+              },
+              () => {
+                expect(getByText('SampleComponent')).toHaveStyle('color: blue');
+              },
+              ff,
+            ),
+        );
+        `,
         errors: [
           {
             messageId: 'passDownExistingFeatureFlagNamesMatch',

package/src/rules/ensure-test-runner-arguments/index.tsx

@@ -8,15 +8,16 @@ const rule: Rule.RuleModule = {
       recommended: false,
     },
     type: 'problem',
+    fixable: 'code',
     messages: {
       onlyInlineFeatureFlag:
         'Only pass in feature flag as string literal, please replace {{identifierName}} with its value.',
       onlyInlineTestFunction:
         'Only pass in test functions/cases in an inline manner. Test functions/cases should be passed in directly, instead of as variables. Please replace {{identifierName}} with its own definition.',
       passDownExistingFeatureFlagParam:
-        'Existing feature flags need to be passed down as params when calling nested test runner. See examples in the package which declares this function.',
+        'An argument symbolising existing FFs needs to be passed down as param when calling nested test runner. See examples in the package which declares this function.',
       passDownExistingFeatureFlagArgument:
-        'Existing feature flags need to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
+        'An argument symbolising existing FFs needs to be passed in as argument when calling nested test runner. See examples in the package which declares this function.',
       passDownExistingFeatureFlagNamesMatch:
         'Argument names not matching when passing down existing feature flags. See examples in the package which declares this function.',
     },
@@ -78,25 +79,48 @@ const rule: Rule.RuleModule = {
               node.parent.params[0].type !== 'Identifier'
             ) {
               return context.report({
-                node,
+                node: node.parent,
                 messageId: 'passDownExistingFeatureFlagParam',
+                fix: function (fixer) {
+                  const parentNodeRange = node.parent.range as [number, number];
+                  return [
+                    fixer.replaceTextRange(
+                      [parentNodeRange[0], parentNodeRange[0] + 2],
+                      'ff',
+                    ),
+                    node.arguments[3]
+                      ? fixer.replaceText(node.arguments[3], 'ff')
+                      : fixer.insertTextAfter(node.arguments[2], ', ff'),
+                  ];
+                },
               });
             }
 
             // Not pass in ff to test runner as 4th argument
+            const paramName = node.parent.params[0].name;
             if (!node.arguments[3] || node.arguments[3].type !== 'Identifier') {
               return context.report({
                 node,
                 messageId: 'passDownExistingFeatureFlagArgument',
+                fix: function (fixer) {
+                  return node.arguments[3]
+                    ? fixer.replaceText(node.arguments[3], paramName)
+                    : fixer.insertTextAfter(
+                        node.arguments[2],
+                        `, ${paramName}`,
+                      );
+                },
               });
             }
             // Pass in the above two, but names don't match
-            const paramName = node.parent.params[0].name;
             const arguName = node.arguments[3].name;
             if (paramName !== arguName) {
               return context.report({
-                node,
+                node: node.parent,
                 messageId: 'passDownExistingFeatureFlagNamesMatch',
+                fix: function (fixer) {
+                  return fixer.replaceText(node.arguments[3], paramName);
+                },
               });
             }
           }