@atlaskit/eslint-plugin-platform 0.1.4 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.1.5
+
+### Patch Changes
+
+- [`b47e48ad163`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b47e48ad163) - Adds an eslint rule to confirm that storybooks only get passed an object - to ensure that codemods work correctly.
+
 ## 0.1.4
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -10,12 +10,14 @@ var _noPrePostInstalls = _interopRequireDefault(require("./rules/no-pre-post-ins
 var _ensureTestRunnerArguments = _interopRequireDefault(require("./rules/ensure-test-runner-arguments"));
 var _ensureTestRunnerNestedCount = _interopRequireDefault(require("./rules/ensure-test-runner-nested-count"));
 var _noInvalidFeatureFlagUsage = _interopRequireDefault(require("./rules/no-invalid-feature-flag-usage"));
+var _noInvalidStorybookDecoratorUsage = _interopRequireDefault(require("./rules/no-invalid-storybook-decorator-usage"));
 var rules = {
   'ensure-feature-flag-registration': _ensureFeatureFlagRegistration.default,
   'ensure-test-runner-arguments': _ensureTestRunnerArguments.default,
   'ensure-test-runner-nested-count': _ensureTestRunnerNestedCount.default,
   'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default,
-  'no-pre-post-install-scripts': _noPrePostInstalls.default
+  'no-pre-post-install-scripts': _noPrePostInstalls.default,
+  'no-invalid-storybook-decorator-usage': _noInvalidStorybookDecoratorUsage.default
 };
 exports.rules = rules;
 var configs = {
@@ -25,7 +27,8 @@ var configs = {
       '@atlaskit/platform/ensure-feature-flag-registration': 'error',
       '@atlaskit/platform/ensure-test-runner-arguments': 'error',
       '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
-      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error'
+      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
+      '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error'
     }
   }
 };

package/dist/cjs/rules/no-invalid-storybook-decorator-usage/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var STORYBOOK_DECORATOR_IDENTIFIER = 'withPlatformFeatureFlags';
+var rule = {
+  meta: {
+    hasSuggestions: false,
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      onlyObjectExpression: 'Only object literals allowed in the storybook decorator! See http://go/pff-eslint for more details'
+    }
+  },
+  create: function create(context) {
+    return (0, _defineProperty2.default)({}, "CallExpression[callee.name=/".concat(STORYBOOK_DECORATOR_IDENTIFIER, "/]"), function CallExpressionCalleeName(node) {
+      // to make typescript happy
+      if (node.type === 'CallExpression') {
+        var args = node.arguments;
+        if (args.length === 1 && args[0].type !== 'ObjectExpression') {
+          return context.report({
+            node: node,
+            messageId: 'onlyObjectExpression'
+          });
+        }
+      }
+      return {};
+    });
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/cjs/version.json

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

package/dist/es2019/index.js

@@ -3,12 +3,14 @@ import noPreAndPostInstallScripts from './rules/no-pre-post-installs';
 import ensureTestRunnerArguments from './rules/ensure-test-runner-arguments';
 import ensureTestRunnerNestedCount from './rules/ensure-test-runner-nested-count';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
+import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-test-runner-arguments': ensureTestRunnerArguments,
   'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
-  'no-pre-post-install-scripts': noPreAndPostInstallScripts
+  'no-pre-post-install-scripts': noPreAndPostInstallScripts,
+  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage
 };
 export const configs = {
   recommended: {
@@ -17,7 +19,8 @@ export const configs = {
       '@atlaskit/platform/ensure-feature-flag-registration': 'error',
       '@atlaskit/platform/ensure-test-runner-arguments': 'error',
       '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
-      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error'
+      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
+      '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error'
     }
   }
 };

package/dist/es2019/rules/no-invalid-storybook-decorator-usage/index.js

@@ -0,0 +1,31 @@
+const STORYBOOK_DECORATOR_IDENTIFIER = 'withPlatformFeatureFlags';
+const rule = {
+  meta: {
+    hasSuggestions: false,
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      onlyObjectExpression: 'Only object literals allowed in the storybook decorator! See http://go/pff-eslint for more details'
+    }
+  },
+  create(context) {
+    return {
+      [`CallExpression[callee.name=/${STORYBOOK_DECORATOR_IDENTIFIER}/]`]: node => {
+        // to make typescript happy
+        if (node.type === 'CallExpression') {
+          const args = node.arguments;
+          if (args.length === 1 && args[0].type !== 'ObjectExpression') {
+            return context.report({
+              node,
+              messageId: 'onlyObjectExpression'
+            });
+          }
+        }
+        return {};
+      }
+    };
+  }
+};
+export default rule;

package/dist/es2019/version.json

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

package/dist/esm/index.js

@@ -3,12 +3,14 @@ import noPreAndPostInstallScripts from './rules/no-pre-post-installs';
 import ensureTestRunnerArguments from './rules/ensure-test-runner-arguments';
 import ensureTestRunnerNestedCount from './rules/ensure-test-runner-nested-count';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
+import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 export var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-test-runner-arguments': ensureTestRunnerArguments,
   'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
-  'no-pre-post-install-scripts': noPreAndPostInstallScripts
+  'no-pre-post-install-scripts': noPreAndPostInstallScripts,
+  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage
 };
 export var configs = {
   recommended: {
@@ -17,7 +19,8 @@ export var configs = {
       '@atlaskit/platform/ensure-feature-flag-registration': 'error',
       '@atlaskit/platform/ensure-test-runner-arguments': 'error',
       '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
-      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error'
+      '@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
+      '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error'
     }
   }
 };

package/dist/esm/rules/no-invalid-storybook-decorator-usage/index.js

@@ -0,0 +1,30 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+var STORYBOOK_DECORATOR_IDENTIFIER = 'withPlatformFeatureFlags';
+var rule = {
+  meta: {
+    hasSuggestions: false,
+    docs: {
+      recommended: false
+    },
+    type: 'problem',
+    messages: {
+      onlyObjectExpression: 'Only object literals allowed in the storybook decorator! See http://go/pff-eslint for more details'
+    }
+  },
+  create: function create(context) {
+    return _defineProperty({}, "CallExpression[callee.name=/".concat(STORYBOOK_DECORATOR_IDENTIFIER, "/]"), function CallExpressionCalleeName(node) {
+      // to make typescript happy
+      if (node.type === 'CallExpression') {
+        var args = node.arguments;
+        if (args.length === 1 && args[0].type !== 'ObjectExpression') {
+          return context.report({
+            node: node,
+            messageId: 'onlyObjectExpression'
+          });
+        }
+      }
+      return {};
+    });
+  }
+};
+export default rule;

package/dist/esm/version.json

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

package/dist/types/index.d.ts

@@ -5,6 +5,7 @@ export declare const rules: {
     'ensure-test-runner-nested-count': import("eslint").Rule.RuleModule;
     'no-invalid-feature-flag-usage': import("eslint").Rule.RuleModule;
     'no-pre-post-install-scripts': import("eslint").Rule.RuleModule;
+    'no-invalid-storybook-decorator-usage': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {
     recommended: {
@@ -14,6 +15,7 @@ export declare const configs: {
             '@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;
         };
     };
 };

package/dist/types/rules/no-invalid-storybook-decorator-usage/index.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;

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

package/report.api.md

@@ -27,6 +27,7 @@ export const configs: {
       '@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;
     };
   };
 };
@@ -43,6 +44,7 @@ export const rules: {
   '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)

package/src/index.tsx

@@ -4,6 +4,7 @@ import noPreAndPostInstallScripts from './rules/no-pre-post-installs';
 import ensureTestRunnerArguments from './rules/ensure-test-runner-arguments';
 import ensureTestRunnerNestedCount from './rules/ensure-test-runner-nested-count';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
+import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
 
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -11,6 +12,7 @@ export const rules = {
   'ensure-test-runner-nested-count': ensureTestRunnerNestedCount,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
+  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
 };
 
 export const configs = {
@@ -21,6 +23,7 @@ export const configs = {
       '@atlaskit/platform/ensure-test-runner-arguments': 'error',
       '@atlaskit/platform/ensure-test-runner-nested-count': 'warn',
       '@atlaskit/platform/no-invalid-feature-flag-usage': 'error',
+      '@atlaskit/platform/no-invalid-storybook-decorator-usage': 'error',
     },
   },
 };

package/src/rules/no-invalid-storybook-decorator-usage/__tests__/unit/rule.test.tsx

@@ -0,0 +1,18 @@
+import { tester } from '../../../../__tests__/utils/_tester';
+import rule from '../../index';
+
+describe('no-invalid-storybook-decorator-usage tests', () => {
+  tester.run('no-invalid-storybook-decorator-usage', rule, {
+    valid: [
+      {
+        code: `withPlatformFeatureFlags({})(<SampleComponent/>)`,
+      },
+    ],
+    invalid: [
+      {
+        code: `const flags = {'uip.sample.color': true}; withPlatformFeatureFlags(flags)(<SampleComponent/>)`,
+        errors: [{ messageId: 'onlyObjectExpression' }],
+      },
+    ],
+  });
+});

package/src/rules/no-invalid-storybook-decorator-usage/index.tsx

@@ -0,0 +1,40 @@
+import type { Rule } from 'eslint';
+
+const STORYBOOK_DECORATOR_IDENTIFIER = 'withPlatformFeatureFlags' as const;
+
+const rule: Rule.RuleModule = {
+  meta: {
+    hasSuggestions: false,
+    docs: {
+      recommended: false,
+    },
+    type: 'problem',
+    messages: {
+      onlyObjectExpression:
+        'Only object literals allowed in the storybook decorator! See http://go/pff-eslint for more details',
+    },
+  },
+  create(context) {
+    return {
+      [`CallExpression[callee.name=/${STORYBOOK_DECORATOR_IDENTIFIER}/]`]: (
+        node: Rule.Node,
+      ) => {
+        // to make typescript happy
+        if (node.type === 'CallExpression') {
+          const args = node.arguments;
+
+          if (args.length === 1 && args[0].type !== 'ObjectExpression') {
+            return context.report({
+              node,
+              messageId: 'onlyObjectExpression',
+            });
+          }
+        }
+
+        return {};
+      },
+    };
+  },
+};
+
+export default rule;

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

@@ -16,6 +16,7 @@ export const configs: {
             '@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;
         };
     };
 };
@@ -32,6 +33,7 @@ export const rules: {
     '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)