@atlaskit/eslint-plugin-design-system/dist/cjs/rules/use-primitives-text/transformers/span-elements.js

The essential plugin for use with the Atlassian Design System.

"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.SpanElements = void 0;
var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _eslintCodemodUtils = require("eslint-codemod-utils");
var _contextCompat = require("@atlaskit/eslint-utils/context-compat");
var _jsxElementHelper = require("../../../ast-nodes/jsx-element-helper");
var _root = require("../../../ast-nodes/root");
var _addColorInheritAttributeFix = require("./add-color-inherit-attribute-fix");
var _allowedAttrs = require("./allowed-attrs");
var _hasTextChildrenOnly = require("./has-text-children-only");
var _updateTestIdAttributeFix = require("./update-test-id-attribute-fix");
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } /* eslint-disable @repo/internal/react/require-jsdoc */
var SpanElements = exports.SpanElements = {
  lint: function lint(node, _ref) {
    var context = _ref.context,
      config = _ref.config;
    if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
      return;
    }

    // Check whether all criteria needed to make a transformation are met
    var _SpanElements$_check = SpanElements._check(node, {
        context: context,
        config: config
      }),
      success = _SpanElements$_check.success,
      autoFixable = _SpanElements$_check.autoFixable;
    if (success && autoFixable) {
      var fix = SpanElements._fix(node, {
        context: context,
        config: config
      });
      context.report(_objectSpread({
        node: node.openingElement,
        messageId: 'preferPrimitivesText'
      }, config.enableUnsafeAutofix ? {
        fix: fix
      } : {
        suggest: [{
          desc: "Convert to Text",
          fix: fix
        }]
      }));
    } else if (success && config.enableUnsafeReport) {
      context.report({
        node: node.openingElement,
        messageId: 'preferPrimitivesText'
      });
    }
  },
  _check: function _check(node, _ref2) {
    var context = _ref2.context,
      config = _ref2.config;
    if (!config.patterns.includes('span-elements')) {
      return {
        success: false
      };
    }
    var elementName = _jsxElementHelper.JSXElementHelper.getName(node);
    if (elementName !== 'span') {
      return {
        success: false
      };
    }
    if (!node.children.length) {
      return {
        success: false
      };
    }

    // Only allow elements with strings as children
    if (!(0, _hasTextChildrenOnly.hasTextChildrenOnly)(node)) {
      return {
        success: false
      };
    }

    // Element has no unallowed props
    if (!_jsxElementHelper.JSXElementHelper.hasAllowedAttrsOnly(node, _allowedAttrs.allowedAttrs)) {
      return {
        success: true,
        autoFixable: false
      };
    }

    // If there is more than one `@atlaskit/primitives` import, then it becomes difficult to determine which import to transform
    var importDeclaration = _root.Root.findImportsByModule((0, _contextCompat.getSourceCode)(context).ast.body, '@atlaskit/primitives');
    if (importDeclaration.length > 1) {
      return {
        success: true,
        autoFixable: false
      };
    }
    return {
      success: true,
      autoFixable: true
    };
  },
  _fix: function _fix(node, _ref3) {
    var context = _ref3.context,
      config = _ref3.config;
    return function (fixer) {
      var importFix = _root.Root.upsertNamedImportDeclaration({
        module: '@atlaskit/primitives',
        specifiers: ['Text']
      }, context, fixer);
      var elementNameFixes = _jsxElementHelper.JSXElementHelper.updateName(node, 'Text', fixer);
      var colorAttributeFix = (0, _addColorInheritAttributeFix.addColorInheritAttributeFix)(node, config, fixer);
      var testAttributeFix = (0, _updateTestIdAttributeFix.updateTestIdAttributeFix)(node, fixer);
      return [importFix].concat((0, _toConsumableArray2.default)(elementNameFixes), [colorAttributeFix, testAttributeFix]).filter(function (fix) {
        return Boolean(fix);
      }); // Some of the transformers can return arrays with undefined, so filter them out
    };
  }
};