@atlaskit/eslint-plugin-platform 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.2.5
+
+### Patch Changes
+
+- [`e5f52093b2a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e5f52093b2a) - Add a rule to ensure that publish config is correct for packages
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -13,6 +13,7 @@ var _ensureAtlassianTeam = _interopRequireDefault(require("./rules/ensure-atlass
 var _noInvalidFeatureFlagUsage = _interopRequireDefault(require("./rules/no-invalid-feature-flag-usage"));
 var _ensureFeatureFlagPrefix = _interopRequireDefault(require("./rules/ensure-feature-flag-prefix"));
 var _noInvalidStorybookDecoratorUsage = _interopRequireDefault(require("./rules/no-invalid-storybook-decorator-usage"));
+var _ensurePublishValid = _interopRequireDefault(require("./rules/ensure-publish-valid"));
 var rules = {
   'ensure-feature-flag-registration': _ensureFeatureFlagRegistration.default,
   'ensure-feature-flag-prefix': _ensureFeatureFlagPrefix.default,
@@ -21,7 +22,8 @@ var rules = {
   'ensure-atlassian-team': _ensureAtlassianTeam.default,
   'no-invalid-feature-flag-usage': _noInvalidFeatureFlagUsage.default,
   'no-pre-post-install-scripts': _noPrePostInstalls.default,
-  'no-invalid-storybook-decorator-usage': _noInvalidStorybookDecoratorUsage.default
+  'no-invalid-storybook-decorator-usage': _noInvalidStorybookDecoratorUsage.default,
+  'ensure-publish-valid': _ensurePublishValid.default
 };
 exports.rules = rules;
 var configs = {

package/dist/cjs/rules/ensure-publish-valid/index.js

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var getObjectPropertyAsLiteral = function getObjectPropertyAsLiteral(node, property) {
+  var prop = node.properties.find(function (p) {
+    return p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property;
+  });
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'Literal') {
+    var _prop$value$value;
+    return (_prop$value$value = prop.value.value) !== null && _prop$value$value !== void 0 ? _prop$value$value : null;
+  }
+  return null;
+};
+var getObjectPropertyAsObject = function getObjectPropertyAsObject(node, property) {
+  var prop = node.properties.find(function (p) {
+    return p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property;
+  });
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'ObjectExpression') {
+    var _prop$value;
+    return (_prop$value = prop.value) !== null && _prop$value !== void 0 ? _prop$value : null;
+  }
+  return null;
+};
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'This rule ensures that the package.json for your packages are set up correctly for publishing depending on the package name prefix',
+      recommended: true
+    },
+    hasSuggestions: false,
+    schema: [{
+      type: 'object',
+      properties: {
+        exceptions: {
+          type: 'array',
+          items: [{
+            type: 'string'
+          }]
+        }
+      }
+    }],
+    messages: {
+      publishConfigRequired: '@atlaskit prefix is public! You have to specify a `publishConfig`, (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+      noPrivate: 'setting private to true prevents publishing, your package prefix implies you want to publish! (package {{packageName}}) see https://go.atlassian.com/package-namespace'
+    }
+  },
+  create: function create(context) {
+    var _ref2, _context$options;
+    var _ref = (_ref2 = (_context$options = context.options) === null || _context$options === void 0 ? void 0 : _context$options[0]) !== null && _ref2 !== void 0 ? _ref2 : {},
+      exceptions = _ref.exceptions;
+    return {
+      ObjectExpression: function ObjectExpression(node) {
+        if (!context.getFilename().endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        var packageName = getObjectPropertyAsLiteral(node, 'name');
+        var packagePrivate = getObjectPropertyAsLiteral(node, 'private');
+        var packagePublishConfig = getObjectPropertyAsObject(node, 'publishConfig');
+
+        // exit if package is on known exception list
+        if (exceptions && exceptions.findIndex(function (name) {
+          return name === packageName;
+        }) !== -1) {
+          return;
+        }
+        if (typeof packageName === 'string' && packageName.startsWith('@atlaskit')) {
+          if (typeof packagePrivate === 'boolean' && packagePrivate) {
+            return context.report({
+              node: node,
+              messageId: 'noPrivate',
+              data: {
+                packageName: packageName
+              }
+            });
+          }
+          if (packagePublishConfig === null) {
+            return context.report({
+              node: node,
+              messageId: 'publishConfigRequired',
+              data: {
+                packageName: packageName
+              }
+            });
+          }
+        }
+      }
+    };
+  }
+};
+var _default = rule;
+exports.default = _default;

package/dist/es2019/index.js

@@ -6,6 +6,7 @@ import ensureAtlassianTeam from './rules/ensure-atlassian-team';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
+import ensurePublishValid from './rules/ensure-publish-valid';
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
@@ -14,7 +15,8 @@ export const rules = {
   'ensure-atlassian-team': ensureAtlassianTeam,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
-  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage
+  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
+  'ensure-publish-valid': ensurePublishValid
 };
 export const configs = {
   recommended: {

package/dist/es2019/rules/ensure-publish-valid/index.js

@@ -0,0 +1,87 @@
+const getObjectPropertyAsLiteral = (node, property) => {
+  const prop = node.properties.find(p => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property);
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'Literal') {
+    var _prop$value$value;
+    return (_prop$value$value = prop.value.value) !== null && _prop$value$value !== void 0 ? _prop$value$value : null;
+  }
+  return null;
+};
+const getObjectPropertyAsObject = (node, property) => {
+  const prop = node.properties.find(p => p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property);
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'ObjectExpression') {
+    var _prop$value;
+    return (_prop$value = prop.value) !== null && _prop$value !== void 0 ? _prop$value : null;
+  }
+  return null;
+};
+const rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'This rule ensures that the package.json for your packages are set up correctly for publishing depending on the package name prefix',
+      recommended: true
+    },
+    hasSuggestions: false,
+    schema: [{
+      type: 'object',
+      properties: {
+        exceptions: {
+          type: 'array',
+          items: [{
+            type: 'string'
+          }]
+        }
+      }
+    }],
+    messages: {
+      publishConfigRequired: '@atlaskit prefix is public! You have to specify a `publishConfig`, (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+      noPrivate: 'setting private to true prevents publishing, your package prefix implies you want to publish! (package {{packageName}}) see https://go.atlassian.com/package-namespace'
+    }
+  },
+  create(context) {
+    var _ref, _context$options;
+    const {
+      exceptions
+    } = (_ref = (_context$options = context.options) === null || _context$options === void 0 ? void 0 : _context$options[0]) !== null && _ref !== void 0 ? _ref : {};
+    return {
+      ObjectExpression: node => {
+        if (!context.getFilename().endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        const packageName = getObjectPropertyAsLiteral(node, 'name');
+        const packagePrivate = getObjectPropertyAsLiteral(node, 'private');
+        const packagePublishConfig = getObjectPropertyAsObject(node, 'publishConfig');
+
+        // exit if package is on known exception list
+        if (exceptions && exceptions.findIndex(name => name === packageName) !== -1) {
+          return;
+        }
+        if (typeof packageName === 'string' && packageName.startsWith('@atlaskit')) {
+          if (typeof packagePrivate === 'boolean' && packagePrivate) {
+            return context.report({
+              node,
+              messageId: 'noPrivate',
+              data: {
+                packageName
+              }
+            });
+          }
+          if (packagePublishConfig === null) {
+            return context.report({
+              node,
+              messageId: 'publishConfigRequired',
+              data: {
+                packageName
+              }
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/esm/index.js

@@ -6,6 +6,7 @@ import ensureAtlassianTeam from './rules/ensure-atlassian-team';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
+import ensurePublishValid from './rules/ensure-publish-valid';
 export var rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
   'ensure-feature-flag-prefix': ensureFeatureFlagPrefix,
@@ -14,7 +15,8 @@ export var rules = {
   'ensure-atlassian-team': ensureAtlassianTeam,
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
-  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage
+  'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
+  'ensure-publish-valid': ensurePublishValid
 };
 export var configs = {
   recommended: {

package/dist/esm/rules/ensure-publish-valid/index.js

@@ -0,0 +1,92 @@
+var getObjectPropertyAsLiteral = function getObjectPropertyAsLiteral(node, property) {
+  var prop = node.properties.find(function (p) {
+    return p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property;
+  });
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'Literal') {
+    var _prop$value$value;
+    return (_prop$value$value = prop.value.value) !== null && _prop$value$value !== void 0 ? _prop$value$value : null;
+  }
+  return null;
+};
+var getObjectPropertyAsObject = function getObjectPropertyAsObject(node, property) {
+  var prop = node.properties.find(function (p) {
+    return p.type === 'Property' && p.key.type === 'Literal' && p.key.value === property;
+  });
+
+  // double check for property is to make typescript happy
+  if ((prop === null || prop === void 0 ? void 0 : prop.type) === 'Property' && (prop === null || prop === void 0 ? void 0 : prop.value.type) === 'ObjectExpression') {
+    var _prop$value;
+    return (_prop$value = prop.value) !== null && _prop$value !== void 0 ? _prop$value : null;
+  }
+  return null;
+};
+var rule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'This rule ensures that the package.json for your packages are set up correctly for publishing depending on the package name prefix',
+      recommended: true
+    },
+    hasSuggestions: false,
+    schema: [{
+      type: 'object',
+      properties: {
+        exceptions: {
+          type: 'array',
+          items: [{
+            type: 'string'
+          }]
+        }
+      }
+    }],
+    messages: {
+      publishConfigRequired: '@atlaskit prefix is public! You have to specify a `publishConfig`, (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+      noPrivate: 'setting private to true prevents publishing, your package prefix implies you want to publish! (package {{packageName}}) see https://go.atlassian.com/package-namespace'
+    }
+  },
+  create: function create(context) {
+    var _ref2, _context$options;
+    var _ref = (_ref2 = (_context$options = context.options) === null || _context$options === void 0 ? void 0 : _context$options[0]) !== null && _ref2 !== void 0 ? _ref2 : {},
+      exceptions = _ref.exceptions;
+    return {
+      ObjectExpression: function ObjectExpression(node) {
+        if (!context.getFilename().endsWith('package.json') || node.type !== 'ObjectExpression') {
+          return;
+        }
+        var packageName = getObjectPropertyAsLiteral(node, 'name');
+        var packagePrivate = getObjectPropertyAsLiteral(node, 'private');
+        var packagePublishConfig = getObjectPropertyAsObject(node, 'publishConfig');
+
+        // exit if package is on known exception list
+        if (exceptions && exceptions.findIndex(function (name) {
+          return name === packageName;
+        }) !== -1) {
+          return;
+        }
+        if (typeof packageName === 'string' && packageName.startsWith('@atlaskit')) {
+          if (typeof packagePrivate === 'boolean' && packagePrivate) {
+            return context.report({
+              node: node,
+              messageId: 'noPrivate',
+              data: {
+                packageName: packageName
+              }
+            });
+          }
+          if (packagePublishConfig === null) {
+            return context.report({
+              node: node,
+              messageId: 'publishConfigRequired',
+              data: {
+                packageName: packageName
+              }
+            });
+          }
+        }
+      }
+    };
+  }
+};
+export default rule;

package/dist/types/index.d.ts

@@ -8,6 +8,7 @@ export declare const rules: {
     '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;
+    'ensure-publish-valid': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {
     recommended: {

package/dist/types/rules/ensure-publish-valid/index.d.ts

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

package/dist/types-ts4.5/index.d.ts

@@ -8,6 +8,7 @@ export declare const rules: {
     '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;
+    'ensure-publish-valid': import("eslint").Rule.RuleModule;
 };
 export declare const configs: {
     recommended: {

package/dist/types-ts4.5/rules/ensure-publish-valid/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.2.4",
+  "version": "0.2.5",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",

package/report.api.md

@@ -54,6 +54,7 @@ export const rules: {
   'no-invalid-feature-flag-usage': Rule.RuleModule;
   'no-pre-post-install-scripts': Rule.RuleModule;
   'no-invalid-storybook-decorator-usage': Rule.RuleModule;
+  'ensure-publish-valid': Rule.RuleModule;
 };
 
 // (No @packageDocumentation comment for this package)

package/src/index.tsx

@@ -7,6 +7,7 @@ import ensureAtlassianTeam from './rules/ensure-atlassian-team';
 import noInvalidFeatureFlagUsage from './rules/no-invalid-feature-flag-usage';
 import ensureFeatureFlagPrefix from './rules/ensure-feature-flag-prefix';
 import noInvalidStorybookDecoratorUsage from './rules/no-invalid-storybook-decorator-usage';
+import ensurePublishValid from './rules/ensure-publish-valid';
 
 export const rules = {
   'ensure-feature-flag-registration': ensureFeatureFlagRegistration,
@@ -17,6 +18,7 @@ export const rules = {
   'no-invalid-feature-flag-usage': noInvalidFeatureFlagUsage,
   'no-pre-post-install-scripts': noPreAndPostInstallScripts,
   'no-invalid-storybook-decorator-usage': noInvalidStorybookDecoratorUsage,
+  'ensure-publish-valid': ensurePublishValid,
 };
 
 export const configs = {

package/src/rules/ensure-publish-valid/__tests__/unit/rule.test.ts

@@ -0,0 +1,41 @@
+import { tester } from '../../../../__tests__/utils/_tester';
+import rule from '../../index';
+
+describe('test ensure-publish-valid-rule', () => {
+  tester.run('ensure-publish-valid', rule, {
+    valid: [
+      {
+        code: `const foo = { "name": "@af/test" }`,
+        filename: 'package.json',
+      },
+      {
+        options: [{ exceptions: ['@atlaskit/test'] }],
+        code: `const foo = { "name": "@atlaskit/test" }`,
+        filename: 'package.json',
+      },
+      {
+        code: `const foo = { "name": "@atlaskit/test", "private": false, "publishConfig": { "registry": "https://registry.npmjs.org/" } }`,
+        filename: 'foo/package.json',
+      },
+    ],
+    invalid: [
+      {
+        code: `const foo = { "name": "@atlaskit/test" }`,
+        filename: 'foo/package.json',
+        errors: [
+          {
+            messageId: 'publishConfigRequired',
+            data: { packageName: '@atlaskit/test' },
+          },
+        ],
+      },
+      {
+        code: `const foo = { "name": "@atlaskit/test", "private": true, "publishConfig": { "registry": "https://registry.npmjs.org/" } }`,
+        filename: 'foo/package.json',
+        errors: [
+          { messageId: 'noPrivate', data: { packageName: '@atlaskit/test' } },
+        ],
+      },
+    ],
+  });
+});

package/src/rules/ensure-publish-valid/index.ts

@@ -0,0 +1,134 @@
+import type { Rule } from 'eslint';
+import type {
+  ObjectExpression,
+  SimpleLiteral,
+  RegExpLiteral,
+  BigIntLiteral,
+} from 'estree';
+const getObjectPropertyAsLiteral = (
+  node: ObjectExpression,
+  property: string,
+): SimpleLiteral['value'] | RegExpLiteral['value'] | BigIntLiteral['value'] => {
+  const prop = node.properties.find(
+    (p) =>
+      p.type === 'Property' &&
+      p.key.type === 'Literal' &&
+      p.key.value === property,
+  );
+
+  // double check for property is to make typescript happy
+  if (prop?.type === 'Property' && prop?.value.type === 'Literal') {
+    return prop.value.value ?? null;
+  }
+
+  return null;
+};
+
+const getObjectPropertyAsObject = (
+  node: ObjectExpression,
+  property: string,
+): ObjectExpression | null => {
+  const prop = node.properties.find(
+    (p) =>
+      p.type === 'Property' &&
+      p.key.type === 'Literal' &&
+      p.key.value === property,
+  );
+
+  // double check for property is to make typescript happy
+  if (prop?.type === 'Property' && prop?.value.type === 'ObjectExpression') {
+    return prop.value ?? null;
+  }
+
+  return null;
+};
+
+type RuleOptions = {
+  // exceptions to this rule, will be ignored
+  exceptions?: string[];
+};
+
+const rule: Rule.RuleModule = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'This rule ensures that the package.json for your packages are set up correctly for publishing depending on the package name prefix',
+      recommended: true,
+    },
+    hasSuggestions: false,
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          exceptions: {
+            type: 'array',
+            items: [{ type: 'string' }],
+          },
+        },
+      },
+    ],
+    messages: {
+      publishConfigRequired:
+        '@atlaskit prefix is public! You have to specify a `publishConfig`, (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+      noPrivate:
+        'setting private to true prevents publishing, your package prefix implies you want to publish! (package {{packageName}}) see https://go.atlassian.com/package-namespace',
+    },
+  },
+  create(context) {
+    const { exceptions } = (context.options?.[0] as RuleOptions) ?? {};
+
+    return {
+      ObjectExpression: (node: Rule.Node) => {
+        if (
+          !context.getFilename().endsWith('package.json') ||
+          node.type !== 'ObjectExpression'
+        ) {
+          return;
+        }
+
+        const packageName = getObjectPropertyAsLiteral(node, 'name');
+        const packagePrivate = getObjectPropertyAsLiteral(node, 'private');
+        const packagePublishConfig = getObjectPropertyAsObject(
+          node,
+          'publishConfig',
+        );
+
+        // exit if package is on known exception list
+        if (
+          exceptions &&
+          exceptions.findIndex((name) => name === packageName) !== -1
+        ) {
+          return;
+        }
+
+        if (
+          typeof packageName === 'string' &&
+          packageName.startsWith('@atlaskit')
+        ) {
+          if (typeof packagePrivate === 'boolean' && packagePrivate) {
+            return context.report({
+              node,
+              messageId: 'noPrivate',
+              data: {
+                packageName,
+              },
+            });
+          }
+
+          if (packagePublishConfig === null) {
+            return context.report({
+              node,
+              messageId: 'publishConfigRequired',
+              data: {
+                packageName,
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+};
+
+export default rule;

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

@@ -40,6 +40,7 @@ export const rules: {
     'no-invalid-feature-flag-usage': Rule.RuleModule;
     'no-pre-post-install-scripts': Rule.RuleModule;
     'no-invalid-storybook-decorator-usage': Rule.RuleModule;
+    'ensure-publish-valid': Rule.RuleModule;
 };
 
 // (No @packageDocumentation comment for this package)

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/version.json

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