@atlaskit/eslint-plugin-platform 0.1.3 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.1.4
+
+### Patch Changes
+
+- [`971489f4ff4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/971489f4ff4) - Add test runner to identified calls that require registration of platform feature flags
+
 ## 0.1.3
 
 ### Patch Changes

package/dist/cjs/rules/ensure-feature-flag-registration/index.js

@@ -13,8 +13,10 @@ var _fuse = _interopRequireDefault(require("fuse.js"));
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 // defines a "getter" to "type" map, if more types are required for feature flags (like string) add it here!
+// if you don't want to verify the type use `null` as the value
 var getterIdentifierToFlagTypeMap = {
-  getBooleanFF: 'boolean'
+  getBooleanFF: 'boolean',
+  ffTest: 'boolean'
 };
 // make sure we cache reading the package.json so we don't end up reading it for every instance of this rule.
 var pkgJsonCache = new Map();
@@ -54,7 +56,8 @@ var rule = {
     messages: {
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
       featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details",
-      changeFeatureFlag: "Change flag key to \"{{ closestFlag }}\" already defined in package.json"
+      changeFeatureFlag: "Change flag key to \"{{ closestFlag }}\" already defined in package.json",
+      featureFlagIncorrectType: "Please change the type for \"{{ featureFlag }}\" to \"{{ expectedType }}\" in the section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details\""
     },
     hasSuggestions: true
   },
@@ -78,6 +81,19 @@ var rule = {
           if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
             var featureFlag = args[0].value;
             var featureFlagRegistration = platformFeatureFlags[featureFlag];
+            var expectedType = getterIdentifierToFlagTypeMap[getterIdentifier];
+
+            // ensure the flag type matches what is registered
+            if (featureFlagRegistration != null && expectedType != null && (featureFlagRegistration === null || featureFlagRegistration === void 0 ? void 0 : featureFlagRegistration.type) !== expectedType) {
+              return context.report({
+                node: args[0],
+                messageId: 'featureFlagIncorrectType',
+                data: {
+                  featureFlag: featureFlag,
+                  expectedType: expectedType
+                }
+              });
+            }
             if (!featureFlagRegistration) {
               // find the closest match in existing section for suggestion text
               var closestMatchFix = null;

package/dist/cjs/version.json

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

package/dist/es2019/rules/ensure-feature-flag-registration/index.js

@@ -3,8 +3,10 @@ import path from 'path';
 import Fuse from 'fuse.js';
 
 // defines a "getter" to "type" map, if more types are required for feature flags (like string) add it here!
+// if you don't want to verify the type use `null` as the value
 const getterIdentifierToFlagTypeMap = {
-  getBooleanFF: 'boolean'
+  getBooleanFF: 'boolean',
+  ffTest: 'boolean'
 };
 // make sure we cache reading the package.json so we don't end up reading it for every instance of this rule.
 const pkgJsonCache = new Map();
@@ -45,7 +47,8 @@ const rule = {
     messages: {
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
       featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`,
-      changeFeatureFlag: `Change flag key to "{{ closestFlag }}" already defined in package.json`
+      changeFeatureFlag: `Change flag key to "{{ closestFlag }}" already defined in package.json`,
+      featureFlagIncorrectType: `Please change the type for "{{ featureFlag }}" to "{{ expectedType }}" in the section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details"`
     },
     hasSuggestions: true
   },
@@ -69,6 +72,19 @@ const rule = {
         if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
           const featureFlag = args[0].value;
           const featureFlagRegistration = platformFeatureFlags[featureFlag];
+          const expectedType = getterIdentifierToFlagTypeMap[getterIdentifier];
+
+          // ensure the flag type matches what is registered
+          if (featureFlagRegistration != null && expectedType != null && (featureFlagRegistration === null || featureFlagRegistration === void 0 ? void 0 : featureFlagRegistration.type) !== expectedType) {
+            return context.report({
+              node: args[0],
+              messageId: 'featureFlagIncorrectType',
+              data: {
+                featureFlag,
+                expectedType
+              }
+            });
+          }
           if (!featureFlagRegistration) {
             // find the closest match in existing section for suggestion text
             let closestMatchFix = null;

package/dist/es2019/version.json

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

package/dist/esm/rules/ensure-feature-flag-registration/index.js

@@ -7,8 +7,10 @@ import path from 'path';
 import Fuse from 'fuse.js';
 
 // defines a "getter" to "type" map, if more types are required for feature flags (like string) add it here!
+// if you don't want to verify the type use `null` as the value
 var getterIdentifierToFlagTypeMap = {
-  getBooleanFF: 'boolean'
+  getBooleanFF: 'boolean',
+  ffTest: 'boolean'
 };
 // make sure we cache reading the package.json so we don't end up reading it for every instance of this rule.
 var pkgJsonCache = new Map();
@@ -48,7 +50,8 @@ var rule = {
     messages: {
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
       featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details",
-      changeFeatureFlag: "Change flag key to \"{{ closestFlag }}\" already defined in package.json"
+      changeFeatureFlag: "Change flag key to \"{{ closestFlag }}\" already defined in package.json",
+      featureFlagIncorrectType: "Please change the type for \"{{ featureFlag }}\" to \"{{ expectedType }}\" in the section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details\""
     },
     hasSuggestions: true
   },
@@ -72,6 +75,19 @@ var rule = {
           if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
             var featureFlag = args[0].value;
             var featureFlagRegistration = platformFeatureFlags[featureFlag];
+            var expectedType = getterIdentifierToFlagTypeMap[getterIdentifier];
+
+            // ensure the flag type matches what is registered
+            if (featureFlagRegistration != null && expectedType != null && (featureFlagRegistration === null || featureFlagRegistration === void 0 ? void 0 : featureFlagRegistration.type) !== expectedType) {
+              return context.report({
+                node: args[0],
+                messageId: 'featureFlagIncorrectType',
+                data: {
+                  featureFlag: featureFlag,
+                  expectedType: expectedType
+                }
+              });
+            }
             if (!featureFlagRegistration) {
               // find the closest match in existing section for suggestion text
               var closestMatchFix = null;

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.1.3",
+	"version": "0.1.4",
 	"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.1.3",
+  "version": "0.1.4",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",

package/src/rules/ensure-feature-flag-registration/__tests__/unit/rule.test.tsx

@@ -27,6 +27,9 @@ describe('with existing platform-feature-flags section', () => {
         'test-flag': {
           type: 'boolean',
         },
+        'string-flag': {
+          type: 'string',
+        },
       },
     };
   });
@@ -37,10 +40,30 @@ describe('with existing platform-feature-flags section', () => {
       {
         code: `getBooleanFF('test-flag')`,
       },
+      {
+        code: `ffTest('test-flag')`,
+      },
     ],
     invalid: [
       {
-        code: `getBooleanFF('invalid-flag')`,
+        code: `ffTest('test-flag-invalid')`,
+        errors: [
+          {
+            messageId: 'featureFlagMissing',
+            suggestions: [
+              {
+                messageId: 'changeFeatureFlag',
+                data: {
+                  closestFlag: 'test-flag',
+                },
+                output: `ffTest('test-flag')`,
+              },
+            ],
+          },
+        ],
+      },
+      {
+        code: `getBooleanFF('test-flag-invalid')`,
         errors: [
           {
             messageId: 'featureFlagMissing',
@@ -56,6 +79,18 @@ describe('with existing platform-feature-flags section', () => {
           },
         ],
       },
+      {
+        code: `getBooleanFF('string-flag')`,
+        errors: [
+          {
+            messageId: 'featureFlagIncorrectType',
+            data: {
+              featureFlag: 'string-flag',
+              expectedType: 'boolean',
+            },
+          },
+        ],
+      },
     ],
   });
 });

package/src/rules/ensure-feature-flag-registration/index.tsx

@@ -4,8 +4,10 @@ import path from 'path';
 import Fuse from 'fuse.js';
 
 // defines a "getter" to "type" map, if more types are required for feature flags (like string) add it here!
+// if you don't want to verify the type use `null` as the value
 const getterIdentifierToFlagTypeMap = {
   getBooleanFF: 'boolean' as const,
+  ffTest: 'boolean' as const,
 } as const;
 
 type PlatformFeatureFlagRegistrationSection = {
@@ -69,6 +71,7 @@ const rule: Rule.RuleModule = {
         'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
       featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`,
       changeFeatureFlag: `Change flag key to "{{ closestFlag }}" already defined in package.json`,
+      featureFlagIncorrectType: `Please change the type for "{{ featureFlag }}" to "{{ expectedType }}" in the section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details"`,
     },
 
     hasSuggestions: true,
@@ -106,6 +109,25 @@ const rule: Rule.RuleModule = {
               const featureFlag = args[0].value as string;
               const featureFlagRegistration = platformFeatureFlags[featureFlag];
 
+              const expectedType =
+                getterIdentifierToFlagTypeMap[getterIdentifier];
+
+              // ensure the flag type matches what is registered
+              if (
+                featureFlagRegistration != null &&
+                expectedType != null &&
+                featureFlagRegistration?.type !== expectedType
+              ) {
+                return context.report({
+                  node: args[0],
+                  messageId: 'featureFlagIncorrectType',
+                  data: {
+                    featureFlag,
+                    expectedType,
+                  },
+                });
+              }
+
               if (!featureFlagRegistration) {
                 // find the closest match in existing section for suggestion text
                 let closestMatchFix: Rule.SuggestionReportDescriptor | null =