@atlaskit/eslint-plugin-design-system 13.30.1 → 13.32.0

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;

package/dist/esm/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::131350ebc877f42247042c6e7327fe18>>
+ * @codegen <<SignedSource::4fa72535ce2bc0a19a6fb01c951150db>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -15,7 +15,7 @@ var rules = {
     '@atlaskit/design-system/ensure-icon-color': 'error',
     '@atlaskit/design-system/ensure-proper-xcss-usage': 'error',
     '@atlaskit/design-system/icon-label': 'warn',
-    '@atlaskit/design-system/lozenge-isBold-and-lozenge-badge-appearance-migration': 'warn',
+    '@atlaskit/design-system/lozenge-badge-tag-labelling-system-migration': 'warn',
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-boolean-autofocus-on-modal-dialog': 'warn',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',
@@ -45,6 +45,7 @@ var 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 @@ var 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',

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

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::b3ddf9ee0a27aaf8a318a6579d48ce99>>
+ * @codegen <<SignedSource::dcf6bf4496c97fd6ad4c1d8d65337a6b>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -14,7 +14,7 @@ var rules = {
     '@atlaskit/design-system/ensure-icon-color': 'error',
     '@atlaskit/design-system/ensure-proper-xcss-usage': 'error',
     '@atlaskit/design-system/icon-label': 'warn',
-    '@atlaskit/design-system/lozenge-isBold-and-lozenge-badge-appearance-migration': 'warn',
+    '@atlaskit/design-system/lozenge-badge-tag-labelling-system-migration': 'warn',
     '@atlaskit/design-system/no-banned-imports': 'error',
     '@atlaskit/design-system/no-boolean-autofocus-on-modal-dialog': 'warn',
     '@atlaskit/design-system/no-css-tagged-template-expression': 'error',
@@ -44,6 +44,7 @@ var 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 @@ var 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',

package/dist/esm/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::27c9a3631c47b134bfb9da3e921e0601>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -32,12 +32,12 @@ var 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',

package/dist/esm/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::52a31bc6cdeb7a9818a0e225d21c88f2>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -31,12 +31,12 @@ var 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',

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

@@ -1,6 +1,6 @@
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::02be73e0813b6f22038f0f3f2ad6865d>>
+ * @codegen <<SignedSource::ca89575f70ae79af2f43113bdc77c0c5>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -11,7 +11,7 @@ import ensureDesignTokenUsagePreview from './ensure-design-token-usage-preview';
 import ensureIconColor from './ensure-icon-color';
 import ensureProperXcssUsage from './ensure-proper-xcss-usage';
 import iconLabel from './icon-label';
-import lozengeIsBoldAndLozengeBadgeAppearanceMigration from './lozenge-isBold-and-lozenge-badge-appearance-migration';
+import lozengeBadgeTagLabellingSystemMigration from './lozenge-badge-tag-labelling-system-migration';
 import noBannedImports from './no-banned-imports';
 import noBooleanAutofocusOnModalDialog from './no-boolean-autofocus-on-modal-dialog';
 import noCssTaggedTemplateExpression from './no-css-tagged-template-expression';
@@ -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';
@@ -85,7 +85,7 @@ export var rules = {
   'ensure-icon-color': ensureIconColor,
   'ensure-proper-xcss-usage': ensureProperXcssUsage,
   'icon-label': iconLabel,
-  'lozenge-isBold-and-lozenge-badge-appearance-migration': lozengeIsBoldAndLozengeBadgeAppearanceMigration,
+  'lozenge-badge-tag-labelling-system-migration': lozengeBadgeTagLabellingSystemMigration,
   'no-banned-imports': noBannedImports,
   'no-boolean-autofocus-on-modal-dialog': noBooleanAutofocusOnModalDialog,
   'no-css-tagged-template-expression': noCssTaggedTemplateExpression,
@@ -116,6 +116,7 @@ export var 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 +125,6 @@ export var 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,