@atlaskit/eslint-plugin-platform 2.7.0 → 2.7.2

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

@@ -1,75 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _registrationUtils = require("../util/registration-utils");
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-var rule = {
-  meta: {
-    docs: {
-      url: 'http://go/pff-eslint',
-      recommended: false
-    },
-    type: 'problem',
-    messages: {
-      featureFlagIncorrectPrefix: "Is this a LaunchDarkly feature flag? It needs a prefix so Confluence picks it up: [{{ allowedPrefixes }}]. Statsig feature gates don't need a prefix."
-    },
-    hasSuggestions: true,
-    schema: [{
-      type: 'object',
-      properties: {
-        allowedPrefixes: {
-          type: 'array',
-          items: [{
-            type: 'string'
-          }]
-        }
-      },
-      required: ['allowedPrefixes']
-    }]
-  },
-  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 : {},
-      allowedPrefixes = _ref.allowedPrefixes;
-    return Object.fromEntries(Object.keys(_registrationUtils.getterIdentifierToFlagTypeMap).map(function (getterIdentifier) {
-      return ["CallExpression[callee.name=/".concat(getterIdentifier, "/]"), function (node) {
-        // to make typescript happy
-        if (node.type === 'CallExpression') {
-          var args = node.arguments;
-          var filename = context.getFilename();
-          var _getMetadataForFilena = (0, _registrationUtils.getMetadataForFilename)(filename),
-            packageJson = _getMetadataForFilena.pkgJson;
-          var platformFeatureFlags = packageJson['platform-feature-flags'];
-
-          // existence of registration section is done in 'ensure-feature-flag-registration'
-          if (!platformFeatureFlags) {
-            return {};
-          }
-          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 context.report({
-                node: args[0],
-                messageId: 'featureFlagIncorrectPrefix',
-                data: {
-                  allowedPrefixes: allowedPrefixes.map(function (p) {
-                    return "".concat(p);
-                  }).join(','),
-                  featureFlag: featureFlag
-                }
-              });
-            }
-          }
-        }
-        return {};
-      }];
-    }));
-  }
-};
-var _default = exports.default = rule;

package/dist/cjs/rules/ensure-valid-platform-yarn-protocol-usage/index.js

@@ -1,79 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _handleAstObject = require("../util/handle-ast-object");
-function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } // eslint-disable-next-line import/no-extraneous-dependencies
-var rootProtocolRegex = /^root:[\^~\*]$/;
-
-/**
- * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
- */
-function getYarnProtocolsUsed(node) {
-  var protocolsUsed = {
-    workspace: false,
-    root: false
-  };
-  var dependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'dependencies');
-  var devDependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'devDependencies');
-  var peerDependencies = (0, _handleAstObject.getObjectPropertyAsObject)(node, 'peerDependencies');
-  for (var _i = 0, _arr = [dependencies, devDependencies, peerDependencies]; _i < _arr.length; _i++) {
-    var obj = _arr[_i];
-    var _iterator = _createForOfIteratorHelper((obj === null || obj === void 0 ? void 0 : obj.properties) || []),
-      _step;
-    try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        var p = _step.value;
-        if (p.type === 'Property' && p.value.type === 'Literal') {
-          if (typeof p.value.value === 'string') {
-            if (rootProtocolRegex.test(p.value.value)) {
-              protocolsUsed.root = true;
-            }
-          }
-        }
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-  }
-  return protocolsUsed;
-}
-var rule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: "Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.",
-      recommended: true
-    },
-    hasSuggestions: false,
-    messages: {
-      invalidWorkspaceProtocolUsage: "The 'workspace:^'protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.",
-      invalidRootProtocolUsage: "The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0')."
-    }
-  },
-  create: function create(context) {
-    return {
-      ObjectExpression: function ObjectExpression(node) {
-        if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
-          return;
-        }
-        var yarnProtocolsUsed = getYarnProtocolsUsed(node);
-
-        // The 'root:' protocol can not be used in any platform packages
-        if (yarnProtocolsUsed.root) {
-          context.report({
-            node: node,
-            messageId: 'invalidRootProtocolUsage'
-          });
-        }
-      }
-    };
-  }
-};
-var _default = exports.default = rule;

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

@@ -1,65 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getMetadataForFilename, getterIdentifierToFlagTypeMap } from '../util/registration-utils';
-const rule = {
-  meta: {
-    docs: {
-      url: 'http://go/pff-eslint',
-      recommended: false
-    },
-    type: 'problem',
-    messages: {
-      featureFlagIncorrectPrefix: `Is this a LaunchDarkly feature flag? It needs a prefix so Confluence picks it up: [{{ allowedPrefixes }}]. Statsig feature gates don't need a prefix.`
-    },
-    hasSuggestions: true,
-    schema: [{
-      type: 'object',
-      properties: {
-        allowedPrefixes: {
-          type: 'array',
-          items: [{
-            type: 'string'
-          }]
-        }
-      },
-      required: ['allowedPrefixes']
-    }]
-  },
-  create(context) {
-    var _ref, _context$options;
-    const {
-      allowedPrefixes
-    } = (_ref = (_context$options = context.options) === null || _context$options === void 0 ? void 0 : _context$options[0]) !== null && _ref !== void 0 ? _ref : {};
-    return Object.fromEntries(Object.keys(getterIdentifierToFlagTypeMap).map(getterIdentifier => [`CallExpression[callee.name=/${getterIdentifier}/]`, node => {
-      // to make typescript happy
-      if (node.type === 'CallExpression') {
-        const args = node.arguments;
-        const filename = context.getFilename();
-        const {
-          pkgJson: packageJson
-        } = getMetadataForFilename(filename);
-        const platformFeatureFlags = packageJson['platform-feature-flags'];
-
-        // existence of registration section is done in 'ensure-feature-flag-registration'
-        if (!platformFeatureFlags) {
-          return {};
-        }
-        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],
-              messageId: 'featureFlagIncorrectPrefix',
-              data: {
-                allowedPrefixes: allowedPrefixes.map(p => `${p}`).join(','),
-                featureFlag
-              }
-            });
-          }
-        }
-      }
-      return {};
-    }]));
-  }
-};
-export default rule;

package/dist/es2019/rules/ensure-valid-platform-yarn-protocol-usage/index.js

@@ -1,62 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getObjectPropertyAsObject } from '../util/handle-ast-object';
-const rootProtocolRegex = /^root:[\^~\*]$/;
-
-/**
- * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
- */
-function getYarnProtocolsUsed(node) {
-  const protocolsUsed = {
-    workspace: false,
-    root: false
-  };
-  const dependencies = getObjectPropertyAsObject(node, 'dependencies');
-  const devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
-  const peerDependencies = getObjectPropertyAsObject(node, 'peerDependencies');
-  for (const obj of [dependencies, devDependencies, peerDependencies]) {
-    for (const p of (obj === null || obj === void 0 ? void 0 : obj.properties) || []) {
-      if (p.type === 'Property' && p.value.type === 'Literal') {
-        if (typeof p.value.value === 'string') {
-          if (rootProtocolRegex.test(p.value.value)) {
-            protocolsUsed.root = true;
-          }
-        }
-      }
-    }
-  }
-  return protocolsUsed;
-}
-const rule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: `Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.`,
-      recommended: true
-    },
-    hasSuggestions: false,
-    messages: {
-      invalidWorkspaceProtocolUsage: `The 'workspace:^'protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.`,
-      invalidRootProtocolUsage: `The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0').`
-    }
-  },
-  create(context) {
-    return {
-      ObjectExpression: node => {
-        if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
-          return;
-        }
-        const yarnProtocolsUsed = getYarnProtocolsUsed(node);
-
-        // The 'root:' protocol can not be used in any platform packages
-        if (yarnProtocolsUsed.root) {
-          context.report({
-            node,
-            messageId: 'invalidRootProtocolUsage'
-          });
-        }
-      }
-    };
-  }
-};
-export default rule;

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

@@ -1,69 +0,0 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getMetadataForFilename, getterIdentifierToFlagTypeMap } from '../util/registration-utils';
-var rule = {
-  meta: {
-    docs: {
-      url: 'http://go/pff-eslint',
-      recommended: false
-    },
-    type: 'problem',
-    messages: {
-      featureFlagIncorrectPrefix: "Is this a LaunchDarkly feature flag? It needs a prefix so Confluence picks it up: [{{ allowedPrefixes }}]. Statsig feature gates don't need a prefix."
-    },
-    hasSuggestions: true,
-    schema: [{
-      type: 'object',
-      properties: {
-        allowedPrefixes: {
-          type: 'array',
-          items: [{
-            type: 'string'
-          }]
-        }
-      },
-      required: ['allowedPrefixes']
-    }]
-  },
-  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 : {},
-      allowedPrefixes = _ref.allowedPrefixes;
-    return Object.fromEntries(Object.keys(getterIdentifierToFlagTypeMap).map(function (getterIdentifier) {
-      return ["CallExpression[callee.name=/".concat(getterIdentifier, "/]"), function (node) {
-        // to make typescript happy
-        if (node.type === 'CallExpression') {
-          var args = node.arguments;
-          var filename = context.getFilename();
-          var _getMetadataForFilena = getMetadataForFilename(filename),
-            packageJson = _getMetadataForFilena.pkgJson;
-          var platformFeatureFlags = packageJson['platform-feature-flags'];
-
-          // existence of registration section is done in 'ensure-feature-flag-registration'
-          if (!platformFeatureFlags) {
-            return {};
-          }
-          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 context.report({
-                node: args[0],
-                messageId: 'featureFlagIncorrectPrefix',
-                data: {
-                  allowedPrefixes: allowedPrefixes.map(function (p) {
-                    return "".concat(p);
-                  }).join(','),
-                  featureFlag: featureFlag
-                }
-              });
-            }
-          }
-        }
-        return {};
-      }];
-    }));
-  }
-};
-export default rule;

package/dist/esm/rules/ensure-valid-platform-yarn-protocol-usage/index.js

@@ -1,75 +0,0 @@
-function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
-function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
-function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-// eslint-disable-next-line import/no-extraneous-dependencies
-
-import { getObjectPropertyAsObject } from '../util/handle-ast-object';
-var rootProtocolRegex = /^root:[\^~\*]$/;
-
-/**
- * Checks if the 'workspace:' and 'root:' protocol are used as either dependencies or devDependencies
- */
-function getYarnProtocolsUsed(node) {
-  var protocolsUsed = {
-    workspace: false,
-    root: false
-  };
-  var dependencies = getObjectPropertyAsObject(node, 'dependencies');
-  var devDependencies = getObjectPropertyAsObject(node, 'devDependencies');
-  var peerDependencies = getObjectPropertyAsObject(node, 'peerDependencies');
-  for (var _i = 0, _arr = [dependencies, devDependencies, peerDependencies]; _i < _arr.length; _i++) {
-    var obj = _arr[_i];
-    var _iterator = _createForOfIteratorHelper((obj === null || obj === void 0 ? void 0 : obj.properties) || []),
-      _step;
-    try {
-      for (_iterator.s(); !(_step = _iterator.n()).done;) {
-        var p = _step.value;
-        if (p.type === 'Property' && p.value.type === 'Literal') {
-          if (typeof p.value.value === 'string') {
-            if (rootProtocolRegex.test(p.value.value)) {
-              protocolsUsed.root = true;
-            }
-          }
-        }
-      }
-    } catch (err) {
-      _iterator.e(err);
-    } finally {
-      _iterator.f();
-    }
-  }
-  return protocolsUsed;
-}
-var rule = {
-  meta: {
-    type: 'problem',
-    docs: {
-      description: "Ensures that yarn protocols 'workspace:' and 'root:' are used correctly.",
-      recommended: true
-    },
-    hasSuggestions: false,
-    messages: {
-      invalidWorkspaceProtocolUsage: "The 'workspace:^'protocol is Used. To resolve this error, please use the 'workspace:*' protocol instead.",
-      invalidRootProtocolUsage: "The 'root:' protocol is not allowed in platform packages. To resolve this error, replace the 'root:' protocol with specific package versions (e.g. '^1.0.0')."
-    }
-  },
-  create: function create(context) {
-    return {
-      ObjectExpression: function ObjectExpression(node) {
-        if (!context.filename.endsWith('package.json') || node.type !== 'ObjectExpression') {
-          return;
-        }
-        var yarnProtocolsUsed = getYarnProtocolsUsed(node);
-
-        // The 'root:' protocol can not be used in any platform packages
-        if (yarnProtocolsUsed.root) {
-          context.report({
-            node: node,
-            messageId: 'invalidRootProtocolUsage'
-          });
-        }
-      }
-    };
-  }
-};
-export default rule;

package/dist/types/rules/ensure-feature-flag-prefix/index.d.ts

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

package/dist/types/rules/ensure-valid-platform-yarn-protocol-usage/index.d.ts

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

package/src/__tests__/utils/_tester.tsx

@@ -1,26 +0,0 @@
-/* eslint-disable @repo/internal/fs/filename-pattern-match */
-/* eslint-disable no-undef */
-import { RuleTester } from 'eslint';
-
-(RuleTester as any).describe = (text: string, method: Function) => {
-	const origHasAssertions = expect.hasAssertions;
-	describe(text, () => {
-		beforeAll(() => {
-			// Stub out expect.hasAssertions beforeEach from jest-presetup.js
-			expect.hasAssertions = () => {};
-		});
-		afterAll(() => {
-			expect.hasAssertions = origHasAssertions;
-		});
-
-		method();
-	});
-};
-
-export const tester = new RuleTester({
-	parser: require.resolve('@babel/eslint-parser'),
-	parserOptions: {
-		ecmaVersion: 6,
-		sourceType: 'module',
-	},
-});