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

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/eslint-plugin-design-system
 
+## 13.34.0
+
+### Minor Changes
+
+- [`dd764a0fde24c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/dd764a0fde24c) -
+  Add rule to enforce simple ADS forms.
+
+## 13.33.0
+
+### Minor Changes
+
+- [`dfd88c3eda55b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/dfd88c3eda55b) -
+  Add rule to enforce simplified fields in form implementations.
+
 ## 13.32.0
 
 ### Minor Changes

package/README.md

@@ -116,6 +116,8 @@ module.exports = {
 | <a href="./src/rules/use-primitives/README.md">use-primitives</a>                                                             | Encourage the usage of primitives components.                                                                                                                                                                                                                                                                       |             | Yes     | Yes         |
 | <a href="./src/rules/use-primitives-text/README.md">use-primitives-text</a>                                                   | Encourage the usage of text components.                                                                                                                                                                                                                                                                             | Yes         | Yes     | Yes         |
 | <a href="./src/rules/use-should-render-to-parent/README.md">use-should-render-to-parent</a>                                   | Encourages makers to use the `shouldRenderToParent` where possible in Atlassian Design System `Popup` and `DropdownMenu` components.                                                                                                                                                                                | Yes         |         | Yes         |
+| <a href="./src/rules/use-simple-field/README.md">use-simple-field</a>                                                         | Encourage use of simple field for better developer experience and accessibility.                                                                                                                                                                                                                                    | Yes         |         | Yes         |
+| <a href="./src/rules/use-simple-form/README.md">use-simple-form</a>                                                           | Encourage use of simple form for better developer experience and accessibility.                                                                                                                                                                                                                                     | Yes         |         | Yes         |
 | <a href="./src/rules/use-spotlight-package/README.md">use-spotlight-package</a>                                               | Discourage the use of @atlaskit/onboarding in favor of @atlaskit/spotlight.                                                                                                                                                                                                                                         |             | Yes     | Yes         |
 | <a href="./src/rules/use-tag-group-label/README.md">use-tag-group-label</a>                                                   | Ensures tag groups are described to assistive technology by a direct label or by another element.                                                                                                                                                                                                                   | Yes         |         | Yes         |
 | <a href="./src/rules/use-tokens-shape/README.md">use-tokens-shape</a>                                                         | Enforces usage of shape design tokens rather than hard-coded values.                                                                                                                                                                                                                                                |             | Yes     | Yes         |

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

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::4fa72535ce2bc0a19a6fb01c951150db>>
+ * @codegen <<SignedSource::1e1e5efbb1ffcefdebdd86064e50fd4a>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -80,6 +80,8 @@ var 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-simple-form': '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/cjs/presets/all.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::dcf6bf4496c97fd6ad4c1d8d65337a6b>>
+ * @codegen <<SignedSource::474fa7fcdd540003aa6622a9e52497fa>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -79,6 +79,8 @@ var 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-simple-form': '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/cjs/presets/recommended-flat.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::27c9a3631c47b134bfb9da3e921e0601>>
+ * @codegen <<SignedSource::cb96c76e14fd1bfeec1ecf16f2787d10>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -62,6 +62,8 @@ var 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-simple-form': '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/cjs/presets/recommended.codegen.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::52a31bc6cdeb7a9818a0e225d21c88f2>>
+ * @codegen <<SignedSource::7d6723309ffe428e466de19a384d02c9>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -61,6 +61,8 @@ var 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-simple-form': '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/cjs/rules/index.codegen.js

@@ -72,6 +72,8 @@ var _usePopupLabel = _interopRequireDefault(require("./use-popup-label"));
 var _usePrimitives = _interopRequireDefault(require("./use-primitives"));
 var _usePrimitivesText = _interopRequireDefault(require("./use-primitives-text"));
 var _useShouldRenderToParent = _interopRequireDefault(require("./use-should-render-to-parent"));
+var _useSimpleField = _interopRequireDefault(require("./use-simple-field"));
+var _useSimpleForm = _interopRequireDefault(require("./use-simple-form"));
 var _useSpotlightPackage = _interopRequireDefault(require("./use-spotlight-package"));
 var _useTagGroupLabel = _interopRequireDefault(require("./use-tag-group-label"));
 var _useTokensShape = _interopRequireDefault(require("./use-tokens-shape"));
@@ -80,7 +82,7 @@ var _useTokensTypography = _interopRequireDefault(require("./use-tokens-typograp
 var _useVisuallyHidden = _interopRequireDefault(require("./use-visually-hidden"));
 /**
  * THIS FILE WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
- * @codegen <<SignedSource::ca89575f70ae79af2f43113bdc77c0c5>>
+ * @codegen <<SignedSource::f9f7263c6ed88b95a13cbfbe56cfc380>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -152,6 +154,8 @@ var rules = exports.rules = {
   'use-primitives': _usePrimitives.default,
   'use-primitives-text': _usePrimitivesText.default,
   'use-should-render-to-parent': _useShouldRenderToParent.default,
+  'use-simple-field': _useSimpleField.default,
+  'use-simple-form': _useSimpleForm.default,
   'use-spotlight-package': _useSpotlightPackage.default,
   'use-tag-group-label': _useTagGroupLabel.default,
   'use-tokens-shape': _useTokensShape.default,

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/cjs/rules/use-simple-form/index.js

@@ -0,0 +1,162 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.topLevelAttributeNames = exports.default = exports.convertForm = void 0;
+var _eslintCodemodUtils = require("eslint-codemod-utils");
+var _createRule = require("../utils/create-rule");
+var FORM_PACKAGE = '@atlaskit/form';
+var topLevelAttributeNames = exports.topLevelAttributeNames = ['autocomplete', 'id', 'label', 'labelId', 'onKeyDown', 'onSubmit', 'name', 'noValidate', 'ref', 'xcss'];
+var convertForm = exports.convertForm = 'Convert form to simple form';
+var rule = (0, _createRule.createLintRule)({
+  meta: {
+    name: 'use-simple-form',
+    type: 'suggestion',
+    hasSuggestions: true,
+    docs: {
+      description: 'Encourage use of simple form for better developer experience and accessibility.',
+      recommended: true,
+      severity: 'warn'
+    },
+    messages: {
+      useSimpleForm: 'The simplified form implementation can be used here.'
+    }
+  },
+  create: function create(context) {
+    var formImport;
+    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 defaultImportSpecifiers = node.specifiers.filter(function (spec) {
+          return (0, _eslintCodemodUtils.isNodeOfType)(spec, 'ImportDefaultSpecifier');
+        });
+        if (defaultImportSpecifiers.length > 0) {
+          formImport = defaultImportSpecifiers[0].local.name;
+        }
+      },
+      JSXElement: function JSXElement(node) {
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node, 'JSXElement')) {
+          return;
+        }
+        if (!(0, _eslintCodemodUtils.isNodeOfType)(node.openingElement.name, 'JSXIdentifier')) {
+          return;
+        }
+
+        // if no form import exists, skip
+        if (!formImport) {
+          return;
+        }
+
+        // if component is not field, skip
+        if (node.openingElement.name.name !== formImport) {
+          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 formProps in render props, skip
+        var renderPropArgProperties = renderPropParams[0].properties;
+        var formPropsProp = renderPropArgProperties.find(function (property) {
+          return (0, _eslintCodemodUtils.isNodeOfType)(property, 'Property') && (0, _eslintCodemodUtils.isNodeOfType)(property.key, 'Identifier') && property.key.name === 'formProps';
+        });
+        if (renderPropArgProperties.length > 1 || !formPropsProp) {
+          return;
+        }
+        var attributes = node.openingElement.attributes;
+        var lastProp = attributes.slice(-1)[0] || node.openingElement.name;
+        var sourceCode = context.sourceCode;
+
+        // if html form is not first child, don't give a fix
+        var renderPropBody = renderPropExpression.body;
+        var firstChildIsHTMLForm = (0, _eslintCodemodUtils.isNodeOfType)(renderPropBody, 'JSXElement') && (0, _eslintCodemodUtils.isNodeOfType)(renderPropBody.openingElement.name, 'JSXIdentifier') && renderPropBody.openingElement.name.name === 'form';
+
+        // If this is not an HTML form. skip because we can't convert
+        if (!firstChildIsHTMLForm) {
+          return;
+        }
+        context.report({
+          node: node,
+          messageId: 'useSimpleForm',
+          suggest: [{
+            desc: convertForm,
+            fix: function fix(fixer) {
+              var fixes = [];
+
+              // add each attribute in the HTML form inside to the AK form
+              var attrs = {
+                topLevel: [],
+                formProps: []
+              };
+              var htmlFormAttributes = renderPropBody.openingElement.attributes;
+              htmlFormAttributes.forEach(function (attr) {
+                if ((0, _eslintCodemodUtils.isNodeOfType)(attr, 'JSXAttribute') && (0, _eslintCodemodUtils.isNodeOfType)(attr.name, 'JSXIdentifier')) {
+                  if (topLevelAttributeNames.includes(attr.name.name)) {
+                    attrs.topLevel.push(attr);
+                  } else {
+                    attrs.formProps.push(attr);
+                  }
+                }
+              });
+              attrs.topLevel.forEach(function (attr) {
+                fixes.push(fixer.insertTextAfter(lastProp, " ".concat(sourceCode.getText(attr))));
+              });
+              if (attrs.formProps.length > 0) {
+                var formPropsText = attrs.formProps.map(function (attr) {
+                  return sourceCode.getText(attr).replace(/^([^=]*)/, "'$1'").replace('=', ': ');
+                }).join(',\n');
+                fixes.push(fixer.insertTextAfter(lastProp, " formProps={{\n".concat(formPropsText, "\n}} ")));
+              }
+
+              // remove the body of the AK form
+              fixes.push(fixer.remove(renderProps));
+
+              // Get all children text of HTML form to be added to AK form
+              var childrenText = '<>';
+              renderPropBody.children.forEach(function (child) {
+                // Doing `as any` because it doesn't like spread props. I
+                // added a test that verifies that this does indeed work,
+                // though, so it's fine.
+                childrenText += sourceCode.getText(child);
+              });
+              childrenText += '</>';
+
+              // Add the children of the HTML form to the children of the AK form
+              node.closingElement && fixes.push(fixer.insertTextBefore(node.closingElement, childrenText));
+              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::4fa72535ce2bc0a19a6fb01c951150db>>
+ * @codegen <<SignedSource::1e1e5efbb1ffcefdebdd86064e50fd4a>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -74,6 +74,8 @@ 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-simple-form': '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::dcf6bf4496c97fd6ad4c1d8d65337a6b>>
+ * @codegen <<SignedSource::474fa7fcdd540003aa6622a9e52497fa>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -73,6 +73,8 @@ 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-simple-form': '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::27c9a3631c47b134bfb9da3e921e0601>>
+ * @codegen <<SignedSource::cb96c76e14fd1bfeec1ecf16f2787d10>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -56,6 +56,8 @@ 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-simple-form': '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::52a31bc6cdeb7a9818a0e225d21c88f2>>
+ * @codegen <<SignedSource::7d6723309ffe428e466de19a384d02c9>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -55,6 +55,8 @@ 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-simple-form': '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::ca89575f70ae79af2f43113bdc77c0c5>>
+ * @codegen <<SignedSource::f9f7263c6ed88b95a13cbfbe56cfc380>>
  * @codegenCommand yarn workspace @atlaskit/eslint-plugin-design-system codegen
  */
 
@@ -71,6 +71,8 @@ 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 useSimpleForm from './use-simple-form';
 import useSpotlightPackage from './use-spotlight-package';
 import useTagGroupLabel from './use-tag-group-label';
 import useTokensShape from './use-tokens-shape';
@@ -145,6 +147,8 @@ export const rules = {
   'use-primitives': usePrimitives,
   'use-primitives-text': usePrimitivesText,
   'use-should-render-to-parent': useShouldRenderToParent,
+  'use-simple-field': useSimpleField,
+  'use-simple-form': useSimpleForm,
   'use-spotlight-package': useSpotlightPackage,
   'use-tag-group-label': useTagGroupLabel,
   'use-tokens-shape': useTokensShape,

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

@@ -0,0 +1,124 @@
+import { isNodeOfType } from 'eslint-codemod-utils';
+import { createLintRule } from '../utils/create-rule';
+const FORM_PACKAGE = '@atlaskit/form';
+const MESSAGE_COMPONENTS = ['ErrorMessage', 'HelperMessage', 'ValidMessage'];
+export const convertField = 'Convert field to simple field';
+const rule = 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(context) {
+    let fieldImport;
+    let messageImports = [];
+    return {
+      ImportDeclaration(node) {
+        const 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;
+        }
+        const namedImportSpecifiers = node.specifiers.filter(spec => isNodeOfType(spec, 'ImportSpecifier'));
+        namedImportSpecifiers.forEach(spec => {
+          if (spec.type === 'ImportSpecifier' && 'name' in spec.imported) {
+            const name = spec.imported.name;
+            const local = spec.local;
+            if (MESSAGE_COMPONENTS.includes(name)) {
+              messageImports.push(local);
+            } else if (name === 'Field') {
+              fieldImport = local.name;
+            }
+          }
+        });
+      },
+      JSXElement(node) {
+        if (!isNodeOfType(node, 'JSXElement')) {
+          return;
+        }
+        if (!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
+        const attributes = node.openingElement.attributes;
+        const componentAttr = attributes.find(attr => isNodeOfType(attr, 'JSXAttribute') && isNodeOfType(attr.name, 'JSXIdentifier') && attr.name.name === 'component');
+        if (componentAttr) {
+          return;
+        }
+
+        // if children is not a render prop, skip
+        const renderProps = node.children.find(child => isNodeOfType(child, 'JSXExpressionContainer'));
+        if (!renderProps) {
+          return;
+        }
+        const renderPropExpression = renderProps.expression;
+        // If not an arrow func, ignore
+        if (!isNodeOfType(renderPropExpression, 'ArrowFunctionExpression')) {
+          return;
+        }
+        const renderPropParams = renderPropExpression.params;
+        // if it is not an object pattern, skip
+        if (!isNodeOfType(renderPropParams[0], 'ObjectPattern')) {
+          return;
+        }
+        // if component uses more than just fieldProps in render props, skip
+        const renderPropArgProperties = renderPropParams[0].properties;
+        const fieldPropsProp = renderPropArgProperties.find(property => isNodeOfType(property, 'Property') && isNodeOfType(property.key, 'Identifier') && property.key.name === 'fieldProps');
+        if (renderPropArgProperties.length > 1 || !fieldPropsProp) {
+          return;
+        }
+        const lastProp = attributes.slice(-1)[0] || node.openingElement.name;
+        const sourceCode = context.sourceCode;
+        const renderPropsText = sourceCode.getText(renderProps);
+        context.report({
+          node: node,
+          messageId: 'useSimpleField',
+          suggest: [{
+            desc: convertField,
+            fix: fixer => {
+              const fixes = [];
+              fixes.push(fixer.insertTextAfter(lastProp, ` component=${renderPropsText} `));
+              fixes.push(fixer.remove(renderProps));
+              return fixes;
+            }
+          }]
+        });
+      }
+    };
+  }
+});
+export default rule;