@atlaskit/eslint-plugin-design-system 13.31.0 → 13.33.0

package/dist/cjs/rules/no-placeholder/index.js

@@ -0,0 +1,162 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.ATLASKIT_FORM_PACKAGE = exports.ATLASKIT_FIELD_IMPORT = exports.AFFECTED_HTML_ELEMENTS = exports.AFFECTED_ATLASKIT_PACKAGES = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+var ast = _interopRequireWildcard(require("../../ast-nodes"));
+var _createRule = require("../utils/create-rule");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+var AFFECTED_HTML_ELEMENTS = exports.AFFECTED_HTML_ELEMENTS = ['input', 'textarea'];
+var AFFECTED_ATLASKIT_PACKAGES = exports.AFFECTED_ATLASKIT_PACKAGES = {
+  '@atlaskit/datetime-picker': ['DatePicker', 'TimePicker', 'DateTimePicker'],
+  '@atlaskit/select': ['default', 'AsyncCreatableSelect', 'CheckboxSelect', 'CountrySelect', 'CreatableSelect', 'PopupSelect', 'RadioSelect'],
+  '@atlaskit/textarea': ['default'],
+  '@atlaskit/textfield': ['default']
+};
+var ATLASKIT_FORM_PACKAGE = exports.ATLASKIT_FORM_PACKAGE = '@atlaskit/form';
+var ATLASKIT_FIELD_IMPORT = exports.ATLASKIT_FIELD_IMPORT = 'Field';
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'no-placeholder',
+    type: 'problem',
+    docs: {
+      description: 'Placeholders should not be used. If information should be given to the user about the proper type or formatting of a value, this should be included using a helper message that is associated to the input instead.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      noPlaceholder: 'Placeholders should not be used. Use separate information to help users associated using `aria-describedby` instead.',
+      noPlaceholderOnSimpleField: 'Placeholders should not be used. Use the `helperMessage` prop instead.',
+      noPlaceholderOnComplexField: 'Placeholders should not be used. Use the `HelperMessage` component instead.'
+    }
+  },
+  create: function create(context) {
+    var hasFieldImport = false;
+    var fieldLocalName = null;
+    var localComponentNames = [];
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var source = node.source.value;
+        if (typeof source !== 'string') {
+          return;
+        }
+
+        // Ignore non-atlaskit input/form packages
+        if (!Object.keys(AFFECTED_ATLASKIT_PACKAGES).includes(source) && ATLASKIT_FORM_PACKAGE !== source) {
+          return;
+        }
+        if (!node.specifiers.length) {
+          return;
+        }
+        var defaultImport = node.specifiers.filter(function (spec) {
+          return spec.type === 'ImportDefaultSpecifier';
+        });
+        var namedImport = node.specifiers.filter(function (spec) {
+          return spec.type === 'ImportSpecifier';
+        });
+        if (source === ATLASKIT_FORM_PACKAGE) {
+          if (namedImport.length && namedImport[0].type === 'ImportSpecifier' && 'name' in namedImport[0].imported && namedImport[0].imported.name === ATLASKIT_FIELD_IMPORT) {
+            hasFieldImport = true;
+            fieldLocalName = namedImport[0].local.name;
+          }
+        } else {
+          var importNames = AFFECTED_ATLASKIT_PACKAGES[source];
+          var usesDefaultImport = importNames.includes('default');
+          var possibleNamedImports = importNames.filter(function (importName) {
+            return importName !== 'default';
+          });
+          if (usesDefaultImport && defaultImport.length && defaultImport[0].local) {
+            localComponentNames.push(defaultImport[0].local.name);
+            // or if popup and using a named import
+          } else if (possibleNamedImports.length >= 1 && namedImport.length) {
+            namedImport.forEach(function (imp) {
+              if (imp.type === 'ImportSpecifier' && 'name' in imp.imported && possibleNamedImports.includes(imp.imported.name)) {
+                localComponentNames.push(imp.local.name);
+              }
+            });
+          }
+        }
+      },
+      JSXElement: function JSXElement(node) {
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
+          return false;
+        }
+        var elName = ast.JSXElement.getName(node);
+        if (!elName) {
+          return false;
+        }
+
+        // If it is one of the affected native HTML elements
+        if (AFFECTED_HTML_ELEMENTS.includes(elName)) {
+          // if has a placeholder attribute
+          var hasPlaceholderAttribute = node.openingElement.attributes.find(function (attr) {
+            return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && attr.name.name === 'placeholder';
+          });
+          if (hasPlaceholderAttribute) {
+            return context.report({
+              node: node.openingElement,
+              messageId: 'noPlaceholder'
+            });
+          }
+          // Else, it is a React component
+        } else {
+          // if none of the affected packages is imported, return
+          if (localComponentNames.length === 0) {
+            return;
+          }
+          // if component name is not in the list, exit
+          if (!(0, _eslintCodemodUtils.isNodeOfType)(node.openingElement.name, 'JSXIdentifier') || !localComponentNames.includes(node.openingElement.name.name)) {
+            return;
+          }
+          if (hasFieldImport && fieldLocalName) {
+            var _node = node;
+            var hasParentField = false;
+            var fieldType = 'Complex';
+            // If node is a Field element or if
+            while ((0, _eslintCodemodUtils.isNodeOfType)(_node, 'JSXElement') && (0, _eslintCodemodUtils.isNodeOfType)(_node.openingElement.name, 'JSXIdentifier') && !hasParentField) {
+              var name = _node.openingElement.name.name;
+              hasParentField = hasParentField || name === fieldLocalName;
+              _node = _node.parent;
+              // Skip up until a JSXElement or JSXAttribute is reached
+              if ((0, _eslintCodemodUtils.isNodeOfType)(_node, 'JSXFragment') || (0, _eslintCodemodUtils.isNodeOfType)(_node, 'ArrowFunctionExpression') || (0, _eslintCodemodUtils.isNodeOfType)(_node, 'JSXExpressionContainer') || (0, _eslintCodemodUtils.isNodeOfType)(_node, 'JSXAttribute')) {
+                while (_node && !(0, _eslintCodemodUtils.isNodeOfType)(_node, 'JSXElement') && !(0, _eslintCodemodUtils.isNodeOfType)(_node, 'Program')) {
+                  if ((0, _eslintCodemodUtils.isNodeOfType)(_node, 'JSXAttribute')) {
+                    fieldType = 'Simple';
+                  }
+                  _node = _node.parent;
+                }
+              }
+            }
+            if (hasParentField) {
+              // if has a placeholder attribute
+              var _hasPlaceholderAttribute = node.openingElement.attributes.find(function (attr) {
+                return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && attr.name.name === 'placeholder';
+              });
+              if (_hasPlaceholderAttribute) {
+                return context.report({
+                  node: node.openingElement,
+                  messageId: "noPlaceholderOn".concat(fieldType, "Field")
+                });
+              }
+            }
+          } else {
+            // if has a placeholder attribute
+            var _hasPlaceholderAttribute2 = node.openingElement.attributes.find(function (attr) {
+              return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && attr.name.name === 'placeholder';
+            });
+            if (_hasPlaceholderAttribute2) {
+              return context.report({
+                node: node.openingElement,
+                messageId: 'noPlaceholder'
+              });
+            }
+          }
+        }
+      }
+    };
+  }
+});
+var _default = exports.default = rule;

package/dist/cjs/rules/use-simple-field/index.js

@@ -0,0 +1,138 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.convertField = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _createRule = require("../utils/create-rule");
+var FORM_PACKAGE = '@atlaskit/form';
+var MESSAGE_COMPONENTS = ['ErrorMessage', 'HelperMessage', 'ValidMessage'];
+var convertField = exports.convertField = 'Convert field to simple field';
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'use-simple-field',
+    type: 'suggestion',
+    hasSuggestions: true,
+    docs: {
+      description: 'Encourage use of simple field for better developer experience and accessibility.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      useSimpleField: 'The simplified field implementation can be used here.'
+    }
+  },
+  create: function create(context) {
+    var fieldImport;
+    var messageImports = [];
+    return {
+      ImportDeclaration: function ImportDeclaration(node) {
+        var source = node.source.value;
+
+        // Ignore anomalies
+        if (typeof source !== 'string') {
+          return;
+        }
+        if (!node.specifiers.length) {
+          return;
+        }
+
+        // If it's not from our package, ignore.
+        if (source !== FORM_PACKAGE) {
+          return;
+        }
+        var namedImportSpecifiers = node.specifiers.filter(function (spec) {
+          return (0, _eslintCodemodUtils.isNodeOfType)(spec, 'ImportSpecifier');
+        });
+        namedImportSpecifiers.forEach(function (spec) {
+          if (spec.type === 'ImportSpecifier' && 'name' in spec.imported) {
+            var name = spec.imported.name;
+            var local = spec.local;
+            if (MESSAGE_COMPONENTS.includes(name)) {
+              messageImports.push(local);
+            } else if (name === 'Field') {
+              fieldImport = local.name;
+            }
+          }
+        });
+      },
+      JSXElement: function JSXElement(node) {
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
+          return;
+        }
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node.openingElement.name, 'JSXIdentifier')) {
+          return;
+        }
+
+        // if no field import exists, skip
+        if (!fieldImport) {
+          return;
+        }
+
+        // if component is not field, skip
+        if (node.openingElement.name.name !== fieldImport) {
+          return;
+        }
+
+        // if message imports exist, skip because we can't really dig around
+        // inside the field to see if they exist because of memory constraints
+        if (messageImports.length > 0) {
+          return;
+        }
+
+        // if component exists as a prop, skip because it's already simple
+        var attributes = node.openingElement.attributes;
+        var componentAttr = attributes.find(function (attr) {
+          return (0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && (0, _eslintCodemodUtils.isNodeOfType)(attr.name, 'JSXIdentifier') && attr.name.name === 'component';
+        });
+        if (componentAttr) {
+          return;
+        }
+
+        // if children is not a render prop, skip
+        var renderProps = node.children.find(function (child) {
+          return (0, _eslintCodemodUtils.isNodeOfType)(child, 'JSXExpressionContainer');
+        });
+        if (!renderProps) {
+          return;
+        }
+        var renderPropExpression = renderProps.expression;
+        // If not an arrow func, ignore
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(renderPropExpression, 'ArrowFunctionExpression')) {
+          return;
+        }
+        var renderPropParams = renderPropExpression.params;
+        // if it is not an object pattern, skip
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(renderPropParams[0], 'ObjectPattern')) {
+          return;
+        }
+        // if component uses more than just fieldProps in render props, skip
+        var renderPropArgProperties = renderPropParams[0].properties;
+        var fieldPropsProp = renderPropArgProperties.find(function (property) {
+          return (0, _eslintCodemodUtils.isNodeOfType)(property, 'Property') && (0, _eslintCodemodUtils.isNodeOfType)(property.key, 'Identifier') && property.key.name === 'fieldProps';
+        });
+        if (renderPropArgProperties.length > 1 || !fieldPropsProp) {
+          return;
+        }
+        var lastProp = attributes.slice(-1)[0] || node.openingElement.name;
+        var sourceCode = context.sourceCode;
+        var renderPropsText = sourceCode.getText(renderProps);
+        context.report({
+          node: node,
+          messageId: 'useSimpleField',
+          suggest: [{
+            desc: convertField,
+            fix: function fix(fixer) {
+              var fixes = [];
+              fixes.push(fixer.insertTextAfter(lastProp, " component=".concat(renderPropsText, " ")));
+              fixes.push(fixer.remove(renderProps));
+              return fixes;
+            }
+          }]
+        });
+      }
+    };
+  }
+});
+var _default = exports.default = rule;

package/dist/es2019/presets/all-flat.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::23364c0ee38a3772c2a588841ed22c55>>
+ * @codegen <<SignedSource::05e8a8ff80cb4a88a89ccd31570686f6>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -45,6 +45,7 @@ const rules = {
     '@atlaskit/design-system/no-margin': 'warn',
     '@atlaskit/design-system/no-nested-styles': 'error',
     '@atlaskit/design-system/no-physical-properties': 'error',
+    '@atlaskit/design-system/no-placeholder': 'warn',
     '@atlaskit/design-system/no-separator-with-list-elements': 'warn',
     '@atlaskit/design-system/no-styled-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-to-match-snapshot': 'error',
@@ -53,7 +54,6 @@ const rules = {
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
     '@atlaskit/design-system/no-unused-css-map': 'warn',
-    '@atlaskit/design-system/no-utility-icons': 'warn',
     '@atlaskit/design-system/prefer-primitives': 'warn',
     '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-character-counter-field': 'warn',
@@ -74,6 +74,7 @@ const rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-simple-field': 'warn',
     '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',

package/dist/es2019/presets/all.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::760141a986e4947e8a1ce74480931f43>>
+ * @codegen <<SignedSource::f2a8bbab8acdaf84ca6e295124378517>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -44,6 +44,7 @@ const rules = {
     '@atlaskit/design-system/no-margin': 'warn',
     '@atlaskit/design-system/no-nested-styles': 'error',
     '@atlaskit/design-system/no-physical-properties': 'error',
+    '@atlaskit/design-system/no-placeholder': 'warn',
     '@atlaskit/design-system/no-separator-with-list-elements': 'warn',
     '@atlaskit/design-system/no-styled-tagged-template-expression': 'error',
     '@atlaskit/design-system/no-to-match-snapshot': 'error',
@@ -52,7 +53,6 @@ const rules = {
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
     '@atlaskit/design-system/no-unused-css-map': 'warn',
-    '@atlaskit/design-system/no-utility-icons': 'warn',
     '@atlaskit/design-system/prefer-primitives': 'warn',
     '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-character-counter-field': 'warn',
@@ -73,6 +73,7 @@ const rules = {
     '@atlaskit/design-system/use-primitives': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-simple-field': 'warn',
     '@atlaskit/design-system/use-spotlight-package': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-shape': 'error',

package/dist/es2019/presets/recommended-flat.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::ba71ef89188bdc20d0ec948cc00f6436>>
+ * @codegen <<SignedSource::2ca5e0a897270a5cfe3e234d7948ed0f>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -32,12 +32,12 @@ const rules = {
       allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
     }],
     '@atlaskit/design-system/no-nested-styles': 'error',
+    '@atlaskit/design-system/no-placeholder': 'warn',
     '@atlaskit/design-system/no-separator-with-list-elements': 'warn',
     '@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
     '@atlaskit/design-system/no-unused-css-map': 'warn',
-    '@atlaskit/design-system/no-utility-icons': 'warn',
     '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-character-counter-field': 'warn',
     '@atlaskit/design-system/use-correct-field': 'warn',
@@ -56,6 +56,7 @@ const rules = {
     '@atlaskit/design-system/use-popup-label': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-simple-field': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-typography': 'warn',
     '@atlaskit/design-system/use-visually-hidden': 'error'

package/dist/es2019/presets/recommended.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::5c119e0ab08e1f39d471b2b827bbb4de>>
+ * @codegen <<SignedSource::aee2986e6e48e70acef7dfa4ba53747d>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -31,12 +31,12 @@ const rules = {
       allowedFunctionCalls: [['@atlaskit/tokens', 'token']]
     }],
     '@atlaskit/design-system/no-nested-styles': 'error',
+    '@atlaskit/design-system/no-placeholder': 'warn',
     '@atlaskit/design-system/no-separator-with-list-elements': 'warn',
     '@atlaskit/design-system/no-unsafe-design-token-usage': 'error',
     '@atlaskit/design-system/no-unsafe-style-overrides': 'warn',
     '@atlaskit/design-system/no-unsupported-drag-and-drop-libraries': 'error',
     '@atlaskit/design-system/no-unused-css-map': 'warn',
-    '@atlaskit/design-system/no-utility-icons': 'warn',
     '@atlaskit/design-system/use-button-group-label': 'warn',
     '@atlaskit/design-system/use-character-counter-field': 'warn',
     '@atlaskit/design-system/use-correct-field': 'warn',
@@ -55,6 +55,7 @@ const rules = {
     '@atlaskit/design-system/use-popup-label': 'warn',
     '@atlaskit/design-system/use-primitives-text': 'warn',
     '@atlaskit/design-system/use-should-render-to-parent': 'warn',
+    '@atlaskit/design-system/use-simple-field': 'warn',
     '@atlaskit/design-system/use-tag-group-label': 'warn',
     '@atlaskit/design-system/use-tokens-typography': 'warn',
     '@atlaskit/design-system/use-visually-hidden': 'error'

package/dist/es2019/rules/index.codegen.js

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::7b80dfb4568d4c5f7c84d7c382b81de9>>
+ * @codegen <<SignedSource::030718cab57dce4d3b39031485e53af4>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -42,6 +42,7 @@ import noLegacyIcons from './no-legacy-icons';
 import noMargin from './no-margin';
 import noNestedStyles from './no-nested-styles';
 import noPhysicalProperties from './no-physical-properties';
+import noPlaceholder from './no-placeholder';
 import noSeparatorWithListElements from './no-separator-with-list-elements';
 import noStyledTaggedTemplateExpression from './no-styled-tagged-template-expression';
 import noToMatchSnapshot from './no-to-match-snapshot';
@@ -50,7 +51,6 @@ import noUnsafeInlineSnapshot from './no-unsafe-inline-snapshot';
 import noUnsafeStyleOverrides from './no-unsafe-style-overrides';
 import noUnsupportedDragAndDropLibraries from './no-unsupported-drag-and-drop-libraries';
 import noUnusedCssMap from './no-unused-css-map';
-import noUtilityIcons from './no-utility-icons';
 import preferPrimitives from './prefer-primitives';
 import useButtonGroupLabel from './use-button-group-label';
 import useCharacterCounterField from './use-character-counter-field';
@@ -71,6 +71,7 @@ import usePopupLabel from './use-popup-label';
 import usePrimitives from './use-primitives';
 import usePrimitivesText from './use-primitives-text';
 import useShouldRenderToParent from './use-should-render-to-parent';
+import useSimpleField from './use-simple-field';
 import useSpotlightPackage from './use-spotlight-package';
 import useTagGroupLabel from './use-tag-group-label';
 import useTokensShape from './use-tokens-shape';
@@ -116,6 +117,7 @@ export const rules = {
   'no-margin': noMargin,
   'no-nested-styles': noNestedStyles,
   'no-physical-properties': noPhysicalProperties,
+  'no-placeholder': noPlaceholder,
   'no-separator-with-list-elements': noSeparatorWithListElements,
   'no-styled-tagged-template-expression': noStyledTaggedTemplateExpression,
   'no-to-match-snapshot': noToMatchSnapshot,
@@ -124,7 +126,6 @@ export const rules = {
   'no-unsafe-style-overrides': noUnsafeStyleOverrides,
   'no-unsupported-drag-and-drop-libraries': noUnsupportedDragAndDropLibraries,
   'no-unused-css-map': noUnusedCssMap,
-  'no-utility-icons': noUtilityIcons,
   'prefer-primitives': preferPrimitives,
   'use-button-group-label': useButtonGroupLabel,
   'use-character-counter-field': useCharacterCounterField,
@@ -145,6 +146,7 @@ export const rules = {
   'use-primitives': usePrimitives,
   'use-primitives-text': usePrimitivesText,
   'use-should-render-to-parent': useShouldRenderToParent,
+  'use-simple-field': useSimpleField,
   'use-spotlight-package': useSpotlightPackage,
   'use-tag-group-label': useTagGroupLabel,
   'use-tokens-shape': useTokensShape,

package/dist/es2019/rules/no-placeholder/index.js

@@ -0,0 +1,142 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import * as ast from '../../ast-nodes';
+import { createLintRule } from '../utils/create-rule';
+export const AFFECTED_HTML_ELEMENTS = ['input', 'textarea'];
+export const AFFECTED_ATLASKIT_PACKAGES = {
+  '@atlaskit/datetime-picker': ['DatePicker', 'TimePicker', 'DateTimePicker'],
+  '@atlaskit/select': ['default', 'AsyncCreatableSelect', 'CheckboxSelect', 'CountrySelect', 'CreatableSelect', 'PopupSelect', 'RadioSelect'],
+  '@atlaskit/textarea': ['default'],
+  '@atlaskit/textfield': ['default']
+};
+export const ATLASKIT_FORM_PACKAGE = '@atlaskit/form';
+export const ATLASKIT_FIELD_IMPORT = 'Field';
+const rule = createLintRule({
+  meta: {
+    name: 'no-placeholder',
+    type: 'problem',
+    docs: {
+      description: 'Placeholders should not be used. If information should be given to the user about the proper type or formatting of a value, this should be included using a helper message that is associated to the input instead.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      noPlaceholder: 'Placeholders should not be used. Use separate information to help users associated using `aria-describedby` instead.',
+      noPlaceholderOnSimpleField: 'Placeholders should not be used. Use the `helperMessage` prop instead.',
+      noPlaceholderOnComplexField: 'Placeholders should not be used. Use the `HelperMessage` component instead.'
+    }
+  },
+  create(context) {
+    let hasFieldImport = false;
+    let fieldLocalName = null;
+    const localComponentNames = [];
+    return {
+      ImportDeclaration(node) {
+        const source = node.source.value;
+        if (typeof source !== 'string') {
+          return;
+        }
+
+        // Ignore non-atlaskit input/form packages
+        if (!Object.keys(AFFECTED_ATLASKIT_PACKAGES).includes(source) && ATLASKIT_FORM_PACKAGE !== source) {
+          return;
+        }
+        if (!node.specifiers.length) {
+          return;
+        }
+        const defaultImport = node.specifiers.filter(spec => spec.type === 'ImportDefaultSpecifier');
+        const namedImport = node.specifiers.filter(spec => spec.type === 'ImportSpecifier');
+        if (source === ATLASKIT_FORM_PACKAGE) {
+          if (namedImport.length && namedImport[0].type === 'ImportSpecifier' && 'name' in namedImport[0].imported && namedImport[0].imported.name === ATLASKIT_FIELD_IMPORT) {
+            hasFieldImport = true;
+            fieldLocalName = namedImport[0].local.name;
+          }
+        } else {
+          const importNames = AFFECTED_ATLASKIT_PACKAGES[source];
+          const usesDefaultImport = importNames.includes('default');
+          const possibleNamedImports = importNames.filter(importName => importName !== 'default');
+          if (usesDefaultImport && defaultImport.length && defaultImport[0].local) {
+            localComponentNames.push(defaultImport[0].local.name);
+            // or if popup and using a named import
+          } else if (possibleNamedImports.length >= 1 && namedImport.length) {
+            namedImport.forEach(imp => {
+              if (imp.type === 'ImportSpecifier' && 'name' in imp.imported && possibleNamedImports.includes(imp.imported.name)) {
+                localComponentNames.push(imp.local.name);
+              }
+            });
+          }
+        }
+      },
+      JSXElement(node) {
+        if (!isNodeOfType(node, 'JSXElement')) {
+          return false;
+        }
+        const elName = ast.JSXElement.getName(node);
+        if (!elName) {
+          return false;
+        }
+
+        // If it is one of the affected native HTML elements
+        if (AFFECTED_HTML_ELEMENTS.includes(elName)) {
+          // if has a placeholder attribute
+          const hasPlaceholderAttribute = node.openingElement.attributes.find(attr => isNodeOfType(attr, 'JSXAttribute') && attr.name.name === 'placeholder');
+          if (hasPlaceholderAttribute) {
+            return context.report({
+              node: node.openingElement,
+              messageId: 'noPlaceholder'
+            });
+          }
+          // Else, it is a React component
+        } else {
+          // if none of the affected packages is imported, return
+          if (localComponentNames.length === 0) {
+            return;
+          }
+          // if component name is not in the list, exit
+          if (!isNodeOfType(node.openingElement.name, 'JSXIdentifier') || !localComponentNames.includes(node.openingElement.name.name)) {
+            return;
+          }
+          if (hasFieldImport && fieldLocalName) {
+            let _node = node;
+            let hasParentField = false;
+            let fieldType = 'Complex';
+            // If node is a Field element or if
+            while (isNodeOfType(_node, 'JSXElement') && isNodeOfType(_node.openingElement.name, 'JSXIdentifier') && !hasParentField) {
+              const name = _node.openingElement.name.name;
+              hasParentField = hasParentField || name === fieldLocalName;
+              _node = _node.parent;
+              // Skip up until a JSXElement or JSXAttribute is reached
+              if (isNodeOfType(_node, 'JSXFragment') || isNodeOfType(_node, 'ArrowFunctionExpression') || isNodeOfType(_node, 'JSXExpressionContainer') || isNodeOfType(_node, 'JSXAttribute')) {
+                while (_node && !isNodeOfType(_node, 'JSXElement') && !isNodeOfType(_node, 'Program')) {
+                  if (isNodeOfType(_node, 'JSXAttribute')) {
+                    fieldType = 'Simple';
+                  }
+                  _node = _node.parent;
+                }
+              }
+            }
+            if (hasParentField) {
+              // if has a placeholder attribute
+              const hasPlaceholderAttribute = node.openingElement.attributes.find(attr => isNodeOfType(attr, 'JSXAttribute') && attr.name.name === 'placeholder');
+              if (hasPlaceholderAttribute) {
+                return context.report({
+                  node: node.openingElement,
+                  messageId: `noPlaceholderOn${fieldType}Field`
+                });
+              }
+            }
+          } else {
+            // if has a placeholder attribute
+            const hasPlaceholderAttribute = node.openingElement.attributes.find(attr => isNodeOfType(attr, 'JSXAttribute') && attr.name.name === 'placeholder');
+            if (hasPlaceholderAttribute) {
+              return context.report({
+                node: node.openingElement,
+                messageId: 'noPlaceholder'
+              });
+            }
+          }
+        }
+      }
+    };
+  }
+});
+export default rule;