@atlaskit/eslint-plugin-design-system 9.3.1 → 9.4.0

package/dist/esm/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-bind-all.js

@@ -0,0 +1,59 @@
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, 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 normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { getModuleOfIdentifier } from '../../utils/get-import-node-by-source';
+import { isBlockedEventBinding } from '../shared/is-blocked-event-binding';
+export function isBlockedBindAll(context, node) {
+  var callee = node.callee;
+  if (!isNodeOfType(callee, 'Identifier')) {
+    return false;
+  }
+  if (callee.name !== 'bindAll') {
+    return false;
+  }
+  var module = getModuleOfIdentifier(context.sourceCode, 'bindAll');
+  if ((module === null || module === void 0 ? void 0 : module.moduleName) !== 'bind-event-listener') {
+    return false;
+  }
+  var secondArg = node.arguments[1];
+  if (!isNodeOfType(secondArg, 'ArrayExpression')) {
+    return false;
+  }
+  var _iterator = _createForOfIteratorHelper(secondArg.elements),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var element = _step.value;
+      if (!element) {
+        continue;
+      }
+      if (!isNodeOfType(element, 'ObjectExpression')) {
+        continue;
+      }
+      var _iterator2 = _createForOfIteratorHelper(element.properties),
+        _step2;
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var property = _step2.value;
+          if (isBlockedEventBinding(property)) {
+            return true;
+          }
+        }
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+    }
+
+    // no exit conditions hit
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return false;
+}

package/dist/esm/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-bind.js

@@ -0,0 +1,44 @@
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, 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 normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { getModuleOfIdentifier } from '../../utils/get-import-node-by-source';
+import { isBlockedEventBinding } from '../shared/is-blocked-event-binding';
+export function isBlockedBind(context, node) {
+  var callee = node.callee;
+  if (!isNodeOfType(callee, 'Identifier')) {
+    return false;
+  }
+  if (callee.name !== 'bind') {
+    return false;
+  }
+  var module = getModuleOfIdentifier(context.sourceCode, 'bind');
+  if ((module === null || module === void 0 ? void 0 : module.moduleName) !== 'bind-event-listener') {
+    return false;
+  }
+  var secondArg = node.arguments[1];
+  if (!isNodeOfType(secondArg, 'ObjectExpression')) {
+    return false;
+  }
+
+  // using a for loop for speed 🚀
+  var _iterator = _createForOfIteratorHelper(secondArg.properties),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var property = _step.value;
+      if (isBlockedEventBinding(property)) {
+        return true;
+      }
+    }
+
+    // no exit conditions hit
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return false;
+}

package/dist/esm/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-jsx-attribute.js

@@ -0,0 +1,49 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { getModuleOfIdentifier } from '../../utils/get-import-node-by-source';
+import { blockedJSXAttributeLookup } from '../shared/blocked';
+function getJSXElementNameFromAttribute(attribute) {
+  var parent = attribute.parent;
+  if (!parent) {
+    return null;
+  }
+  if (!isNodeOfType(parent, 'JSXOpeningElement')) {
+    return null;
+  }
+  var identifier = parent.name;
+  if (!isNodeOfType(identifier, 'JSXIdentifier')) {
+    return null;
+  }
+  return identifier.name;
+}
+function isOnIntrinsicJSXElement(attribute) {
+  var name = getJSXElementNameFromAttribute(attribute);
+  if (!name) {
+    return false;
+  }
+  var firstLetter = name.at(0);
+  if (!firstLetter) {
+    return false;
+  }
+  return firstLetter === firstLetter.toLocaleLowerCase();
+}
+function isOnBoxPrimitive(context, attribute) {
+  if (getJSXElementNameFromAttribute(attribute) !== 'Box') {
+    return false;
+  }
+  var module = getModuleOfIdentifier(context.sourceCode, 'Box');
+  return (module === null || module === void 0 ? void 0 : module.moduleName) === '@atlaskit/primitives';
+}
+export function isBlockedJSXAttribute(context, node) {
+  var attributeName = node.name;
+  if (!isNodeOfType(attributeName, 'JSXIdentifier')) {
+    return false;
+  }
+
+  // not using a blocked attribute name, can continue on
+  if (!blockedJSXAttributeLookup.has(attributeName.name)) {
+    return false;
+  }
+  return isOnIntrinsicJSXElement(node) || isOnBoxPrimitive(context, node);
+}

package/dist/esm/rules/no-direct-use-of-web-platform-drag-and-drop/index.js

@@ -0,0 +1,49 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { createLintRule } from '../utils/create-rule';
+import { isBlockedAddEventListener } from './checks/is-blocked-add-event-listener';
+import { isBlockedBind } from './checks/is-blocked-bind';
+import { isBlockedBindAll } from './checks/is-blocked-bind-all';
+import { isBlockedJSXAttribute } from './checks/is-blocked-jsx-attribute';
+var rule = createLintRule({
+  meta: {
+    name: 'no-direct-use-of-web-platform-drag-and-drop',
+    type: 'problem',
+    docs: {
+      recommended: true,
+      severity: 'error',
+      description: 'Disallow using direct use of native drag and drop (please use Pragmatic drag and drop)'
+    },
+    messages: {
+      usePragmaticDnd: 'Please use Pragmatic drag and drop, which makes web platform drag and drop safe and easy to work with.'
+    }
+  },
+  create: function create(context) {
+    return {
+      JSXAttribute: function JSXAttribute(node) {
+        if (!isNodeOfType(node, 'JSXAttribute')) {
+          return;
+        }
+        if (isBlockedJSXAttribute(context, node)) {
+          context.report({
+            messageId: 'usePragmaticDnd',
+            node: node
+          });
+          return;
+        }
+      },
+      CallExpression: function CallExpression(node) {
+        if (!isNodeOfType(node, 'CallExpression')) {
+          return;
+        }
+        if (isBlockedAddEventListener(node) || isBlockedBind(context, node) || isBlockedBindAll(context, node)) {
+          context.report({
+            messageId: 'usePragmaticDnd',
+            node: node
+          });
+          return;
+        }
+      }
+    };
+  }
+});
+export default rule;

package/dist/esm/rules/no-direct-use-of-web-platform-drag-and-drop/shared/blocked.js

@@ -0,0 +1,2 @@
+export var blockedJSXAttributeLookup = new Set(['onDragStart', 'onDragEnter', 'onDragLeave', 'onDragOver', 'onDrag', 'onDrop', 'onDragEnd']);
+export var blockedEventNameLookup = new Set(['dragstart', 'dragenter', 'dragleave', 'dragover', 'drag', 'drop', 'dragend']);

package/dist/esm/rules/no-direct-use-of-web-platform-drag-and-drop/shared/is-blocked-event-binding.js

@@ -0,0 +1,25 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { blockedEventNameLookup } from './blocked';
+export function isBlockedEventBinding(property) {
+  if (!isNodeOfType(property, 'Property')) {
+    return false;
+  }
+
+  // are we looking at the "type" property?
+
+  var key = property.key;
+  if (!isNodeOfType(key, 'Identifier')) {
+    return false;
+  }
+  if (key.name !== 'type') {
+    return false;
+  }
+
+  // is the "type" property value blocked?
+
+  var value = property.value;
+  if (!isNodeOfType(value, 'Literal')) {
+    return false;
+  }
+  return typeof value.value === 'string' && blockedEventNameLookup.has(value.value);
+}

package/dist/types/index.codegen.d.ts

@@ -12,6 +12,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
+            '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
             '@atlaskit/design-system/no-empty-styled-expression': string;
             '@atlaskit/design-system/no-exported-css': string;
             '@atlaskit/design-system/no-exported-keyframes': string;
@@ -48,6 +49,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
+            '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
             '@atlaskit/design-system/no-empty-styled-expression': string;
             '@atlaskit/design-system/no-exported-css': string;
             '@atlaskit/design-system/no-exported-keyframes': string;

package/dist/types/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::2e2cf6c0ecfe1b01f3eb24caa223f09e>>
+ * @codegen <<SignedSource::1ab11547db880eba1206f334a9b2150f>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -15,6 +15,7 @@ declare const _default: {
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;
+        '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
         '@atlaskit/design-system/no-empty-styled-expression': string;
         '@atlaskit/design-system/no-exported-css': string;
         '@atlaskit/design-system/no-exported-keyframes': string;

package/dist/types/presets/recommended.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::aebc778f0b10032cbb2941b55189d766>>
+ * @codegen <<SignedSource::05b4fe8f97edc4f7e46ded52b4917037>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -13,6 +13,7 @@ declare const _default: {
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;
+        '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
         '@atlaskit/design-system/no-empty-styled-expression': string;
         '@atlaskit/design-system/no-exported-css': string;
         '@atlaskit/design-system/no-exported-keyframes': string;

package/dist/types/rules/index.codegen.d.ts

@@ -12,6 +12,7 @@ declare const _default: {
     'no-deprecated-imports': import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<string, [{
         deprecatedConfig: import("./utils/types").DeprecatedConfig;
     }], import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+    'no-direct-use-of-web-platform-drag-and-drop': import("eslint").Rule.RuleModule;
     'no-empty-styled-expression': import("eslint").Rule.RuleModule;
     'no-exported-css': import("eslint").Rule.RuleModule;
     'no-exported-keyframes': import("eslint").Rule.RuleModule;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-add-event-listener.d.ts

@@ -0,0 +1,2 @@
+import { CallExpression } from 'eslint-codemod-utils';
+export declare function isBlockedAddEventListener(node: CallExpression): boolean;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-bind-all.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { CallExpression } from 'eslint-codemod-utils';
+export declare function isBlockedBindAll(context: Rule.RuleContext, node: CallExpression): boolean;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-bind.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { CallExpression } from 'eslint-codemod-utils';
+export declare function isBlockedBind(context: Rule.RuleContext, node: CallExpression): boolean;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-jsx-attribute.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { JSXAttribute } from 'eslint-codemod-utils';
+export declare function isBlockedJSXAttribute(context: Rule.RuleContext, node: JSXAttribute): boolean;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/index.d.ts

@@ -0,0 +1,2 @@
+declare const rule: import("eslint").Rule.RuleModule;
+export default rule;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/shared/blocked.d.ts

@@ -0,0 +1,2 @@
+export declare const blockedJSXAttributeLookup: Set<string>;
+export declare const blockedEventNameLookup: Set<string>;

package/dist/types/rules/no-direct-use-of-web-platform-drag-and-drop/shared/is-blocked-event-binding.d.ts

@@ -0,0 +1,2 @@
+import { Property, SpreadElement } from 'eslint-codemod-utils';
+export declare function isBlockedEventBinding(property: Property | SpreadElement): boolean;

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

@@ -12,6 +12,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
+            '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
             '@atlaskit/design-system/no-empty-styled-expression': string;
             '@atlaskit/design-system/no-exported-css': string;
             '@atlaskit/design-system/no-exported-keyframes': string;
@@ -48,6 +49,7 @@ export declare const configs: {
             '@atlaskit/design-system/no-deprecated-apis': string;
             '@atlaskit/design-system/no-deprecated-design-token-usage': string;
             '@atlaskit/design-system/no-deprecated-imports': string;
+            '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
             '@atlaskit/design-system/no-empty-styled-expression': string;
             '@atlaskit/design-system/no-exported-css': string;
             '@atlaskit/design-system/no-exported-keyframes': string;

package/dist/types-ts4.5/presets/all.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::2e2cf6c0ecfe1b01f3eb24caa223f09e>>
+ * @codegen <<SignedSource::1ab11547db880eba1206f334a9b2150f>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -15,6 +15,7 @@ declare const _default: {
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;
+        '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
         '@atlaskit/design-system/no-empty-styled-expression': string;
         '@atlaskit/design-system/no-exported-css': string;
         '@atlaskit/design-system/no-exported-keyframes': string;

package/dist/types-ts4.5/presets/recommended.codegen.d.ts

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::aebc778f0b10032cbb2941b55189d766>>
+ * @codegen <<SignedSource::05b4fe8f97edc4f7e46ded52b4917037>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 declare const _default: {
@@ -13,6 +13,7 @@ declare const _default: {
         '@atlaskit/design-system/no-deprecated-apis': string;
         '@atlaskit/design-system/no-deprecated-design-token-usage': string;
         '@atlaskit/design-system/no-deprecated-imports': string;
+        '@atlaskit/design-system/no-direct-use-of-web-platform-drag-and-drop': string;
         '@atlaskit/design-system/no-empty-styled-expression': string;
         '@atlaskit/design-system/no-exported-css': string;
         '@atlaskit/design-system/no-exported-keyframes': string;

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

@@ -16,6 +16,7 @@ declare const _default: {
             deprecatedConfig: import("./utils/types").DeprecatedConfig;
         }
     ], import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+    'no-direct-use-of-web-platform-drag-and-drop': import("eslint").Rule.RuleModule;
     'no-empty-styled-expression': import("eslint").Rule.RuleModule;
     'no-exported-css': import("eslint").Rule.RuleModule;
     'no-exported-keyframes': import("eslint").Rule.RuleModule;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-add-event-listener.d.ts

@@ -0,0 +1,2 @@
+import { CallExpression } from 'eslint-codemod-utils';
+export declare function isBlockedAddEventListener(node: CallExpression): boolean;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-bind-all.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { CallExpression } from 'eslint-codemod-utils';
+export declare function isBlockedBindAll(context: Rule.RuleContext, node: CallExpression): boolean;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-bind.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { CallExpression } from 'eslint-codemod-utils';
+export declare function isBlockedBind(context: Rule.RuleContext, node: CallExpression): boolean;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/checks/is-blocked-jsx-attribute.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+import { JSXAttribute } from 'eslint-codemod-utils';
+export declare function isBlockedJSXAttribute(context: Rule.RuleContext, node: JSXAttribute): boolean;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/index.d.ts

@@ -0,0 +1,2 @@
+declare const rule: import("eslint").Rule.RuleModule;
+export default rule;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/shared/blocked.d.ts

@@ -0,0 +1,2 @@
+export declare const blockedJSXAttributeLookup: Set<string>;
+export declare const blockedEventNameLookup: Set<string>;

package/dist/types-ts4.5/rules/no-direct-use-of-web-platform-drag-and-drop/shared/is-blocked-event-binding.d.ts

@@ -0,0 +1,2 @@
+import { Property, SpreadElement } from 'eslint-codemod-utils';
+export declare function isBlockedEventBinding(property: Property | SpreadElement): boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-design-system",
   "description": "The essential plugin for use with the Atlassian Design System.",
-  "version": "9.3.1",
+  "version": "9.4.0",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
   "publishConfig": {