UNPKG

@atlaskit/eslint-plugin-design-system

Version:

The essential plugin for use with the Atlassian Design System.

49 lines (48 loc) • 1.83 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.default = void 0; var _createLintRule = require("../utils/create-lint-rule"); var _createModuleImportListener = require("../utils/create-module-import-listener"); var _isModuleFromPackage = require("../utils/is-module-from-package"); var _libraries = require("./libraries"); var rule = (0, _createLintRule.createLintRule)({ meta: { name: 'no-third-party-focus-traps', type: 'problem', docs: { description: 'Disallow third-party focus trap libraries, such as `react-focus-lock` and `focus-trap`. Design System layering components manage focus.', recommended: false, severity: 'error' }, messages: { noThirdPartyFocusTraps: 'Do not use `{{specifier}}`. Its focus trap does not know about layers in the top layer, so it can pull focus out of a Design System layer that opens outside the trap. Design System layering components manage focus for you. Use one, or `@atlaskit/top-layer` if no component fits.' } }, create: function create(context) { return (0, _createModuleImportListener.createModuleImportListener)({ onModuleImport: function onModuleImport(_ref) { var node = _ref.node, specifier = _ref.specifier; var isFocusTrapLibrary = _libraries.focusTrapLibraries.some(function (packageName) { return (0, _isModuleFromPackage.isModuleFromPackage)({ specifier: specifier, packageName: packageName }); }); if (!isFocusTrapLibrary) { return; } context.report({ node: node, messageId: 'noThirdPartyFocusTraps', data: { specifier: specifier } }); } }); } }); var _default = exports.default = rule;