@atlaskit/eslint-plugin-platform 0.1.7 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.2.0
+
+### Minor Changes
+
+- [`56507598609`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56507598609) - Skip minor dependency bump
+
+## 0.1.8
+
+### Patch Changes
+
+- [`cb0e94d2ce4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cb0e94d2ce4) - Fix prefixes for all flags being checked at any callsite, only the current flag will be checked from now on
+
 ## 0.1.7
 
 ### Patch Changes

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

@@ -1,11 +1,9 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _registrationUtils = require("../util/registration-utils");
 var rule = {
   meta: {
@@ -48,30 +46,22 @@ var rule = {
           if (!platformFeatureFlags) {
             return {};
           }
-
-          // check registration section for valid feature flag prefixes.
-          // this checks all flags at every call site to ensure that new flags show errors as soon as possible.
-          var _loop = function _loop(featureFlag) {
+          if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
+            var featureFlag = args[0].value;
             if (!allowedPrefixes.some(function (prefix) {
               return featureFlag.startsWith(prefix);
             })) {
-              return {
-                v: context.report({
-                  node: args[0],
-                  messageId: 'featureFlagIncorrectPrefix',
-                  data: {
-                    allowedPrefixes: allowedPrefixes.map(function (p) {
-                      return "".concat(p);
-                    }).join(','),
-                    featureFlag: featureFlag
-                  }
-                })
-              };
+              return context.report({
+                node: args[0],
+                messageId: 'featureFlagIncorrectPrefix',
+                data: {
+                  allowedPrefixes: allowedPrefixes.map(function (p) {
+                    return "".concat(p);
+                  }).join(','),
+                  featureFlag: featureFlag
+                }
+              });
             }
-          };
-          for (var featureFlag in platformFeatureFlags) {
-            var _ret = _loop(featureFlag);
-            if ((0, _typeof2.default)(_ret) === "object") return _ret.v;
           }
         }
         return {};

package/dist/cjs/version.json

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

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

@@ -41,10 +41,8 @@ const rule = {
         if (!platformFeatureFlags) {
           return {};
         }
-
-        // check registration section for valid feature flag prefixes.
-        // this checks all flags at every call site to ensure that new flags show errors as soon as possible.
-        for (const featureFlag in platformFeatureFlags) {
+        if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
+          const featureFlag = args[0].value;
           if (!allowedPrefixes.some(prefix => featureFlag.startsWith(prefix))) {
             return context.report({
               node: args[0],

package/dist/es2019/version.json

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

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

@@ -1,4 +1,3 @@
-import _typeof from "@babel/runtime/helpers/typeof";
 import { getMetadataForFilename, getterIdentifierToFlagTypeMap } from '../util/registration-utils';
 var rule = {
   meta: {
@@ -41,30 +40,22 @@ var rule = {
           if (!platformFeatureFlags) {
             return {};
           }
-
-          // check registration section for valid feature flag prefixes.
-          // this checks all flags at every call site to ensure that new flags show errors as soon as possible.
-          var _loop = function _loop(featureFlag) {
+          if (args.length === 1 && args[0].type === 'Literal' && args[0].raw) {
+            var featureFlag = args[0].value;
             if (!allowedPrefixes.some(function (prefix) {
               return featureFlag.startsWith(prefix);
             })) {
-              return {
-                v: context.report({
-                  node: args[0],
-                  messageId: 'featureFlagIncorrectPrefix',
-                  data: {
-                    allowedPrefixes: allowedPrefixes.map(function (p) {
-                      return "".concat(p);
-                    }).join(','),
-                    featureFlag: featureFlag
-                  }
-                })
-              };
+              return context.report({
+                node: args[0],
+                messageId: 'featureFlagIncorrectPrefix',
+                data: {
+                  allowedPrefixes: allowedPrefixes.map(function (p) {
+                    return "".concat(p);
+                  }).join(','),
+                  featureFlag: featureFlag
+                }
+              });
             }
-          };
-          for (var featureFlag in platformFeatureFlags) {
-            var _ret = _loop(featureFlag);
-            if (_typeof(_ret) === "object") return _ret.v;
           }
         }
         return {};

package/dist/esm/version.json

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

package/dist/types/rules/util/registration-utils.d.ts

@@ -6,7 +6,7 @@ export declare const getterIdentifierToFlagTypeMap: {
 };
 export declare type PlatformFeatureFlagRegistrationSection = {
     [key: string]: {
-        type: typeof getterIdentifierToFlagTypeMap[keyof typeof getterIdentifierToFlagTypeMap];
+        type: (typeof getterIdentifierToFlagTypeMap)[keyof typeof getterIdentifierToFlagTypeMap];
     };
 };
 export declare type EnhancedPackageJson = readPkgUp.PackageJson & {

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.7",
+  "version": "0.2.0",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",

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

@@ -18,12 +18,15 @@ jest.mock('read-pkg-up', () => ({
   }),
 }));
 
-describe('with flag with invalid prefix', () => {
+describe('test prefix rule', () => {
   beforeEach(() => {
     mockPath = 'test/package.json';
 
     mockPackageJson = {
       'platform-feature-flags': {
+        'prefix-flag': {
+          type: 'boolean',
+        },
         'no-prefix-flag': {
           type: 'boolean',
         },
@@ -33,7 +36,16 @@ describe('with flag with invalid prefix', () => {
 
   // this isolates the invalid case so we can test the suggestion properly
   tester.run('ensure-feature-flag-registration', rule, {
-    valid: [],
+    valid: [
+      {
+        options: [{ allowedPrefixes: ['prefix'] }],
+        code: `ffTest('prefix-flag')`,
+      },
+      {
+        options: [{ allowedPrefixes: ['prefix'] }],
+        code: `getBooleanFF('prefix-flag')`,
+      },
+    ],
     invalid: [
       {
         options: [{ allowedPrefixes: ['prefix'] }],

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

@@ -59,9 +59,12 @@ const rule: Rule.RuleModule = {
               return {};
             }
 
-            // check registration section for valid feature flag prefixes.
-            // this checks all flags at every call site to ensure that new flags show errors as soon as possible.
-            for (const featureFlag in platformFeatureFlags) {
+            if (
+              args.length === 1 &&
+              args[0].type === 'Literal' &&
+              args[0].raw
+            ) {
+              const featureFlag = args[0].value as string;
               if (
                 !allowedPrefixes.some((prefix) =>
                   featureFlag.startsWith(prefix),

package/src/rules/ensure-test-runner-nested-count/index.tsx

@@ -8,7 +8,7 @@ const getDepthOfNestedRunner = (
   node: SimpleCallExpression & Rule.NodeParentExtension,
 ): number => {
   // Calculate the depth of a binary tree, using a queue to track path
-  let queue: typeof node[] = [];
+  let queue: (typeof node)[] = [];
   queue.push(node);
   let depth = 0;
   while (queue.length > 0) {

package/src/rules/util/registration-utils.ts

@@ -12,7 +12,7 @@ export const getterIdentifierToFlagTypeMap = {
 export type PlatformFeatureFlagRegistrationSection = {
   [key: string]: {
     // get the values of the object above
-    type: typeof getterIdentifierToFlagTypeMap[keyof typeof getterIdentifierToFlagTypeMap];
+    type: (typeof getterIdentifierToFlagTypeMap)[keyof typeof getterIdentifierToFlagTypeMap];
   };
 };
 

package/tmp/api-report-tmp.d.ts

@@ -1,45 +0,0 @@
-## API Report File for "@atlaskit/eslint-plugin-platform"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import type { Linter } from 'eslint';
-import { Rule } from 'eslint';
-
-// @public (undocumented)
-export const configs: {
-    recommended: {
-        plugins: string[];
-        rules: {
-            '@atlaskit/platform/ensure-feature-flag-registration': string;
-            '@atlaskit/platform/ensure-feature-flag-prefix': (string | {
-                allowedPrefixes: string[];
-            })[];
-            '@atlaskit/platform/ensure-test-runner-arguments': string;
-            '@atlaskit/platform/ensure-test-runner-nested-count': string;
-            '@atlaskit/platform/no-invalid-feature-flag-usage': string;
-            '@atlaskit/platform/no-invalid-storybook-decorator-usage': string;
-        };
-    };
-};
-
-// @public (undocumented)
-export const processors: {
-    'package-json-processor': Linter.Processor<Linter.ProcessorFile | string>;
-};
-
-// @public (undocumented)
-export const rules: {
-    'ensure-feature-flag-registration': Rule.RuleModule;
-    'ensure-feature-flag-prefix': Rule.RuleModule;
-    'ensure-test-runner-arguments': Rule.RuleModule;
-    'ensure-test-runner-nested-count': Rule.RuleModule;
-    'no-invalid-feature-flag-usage': Rule.RuleModule;
-    'no-pre-post-install-scripts': Rule.RuleModule;
-    'no-invalid-storybook-decorator-usage': Rule.RuleModule;
-};
-
-// (No @packageDocumentation comment for this package)
-
-```