Merge pull request #437 from bitpshr/feat/jsx-a11y-iframe-has-title

feat: add jsx-a11y/iframe-has-title lint rule

packages/@romejs/diagnostics/categories.ts

@@ -102,6 +102,7 @@ type LintDiagnosticCategory =
   | 'lint/getterReturn'
   | 'lint/importDefaultBasename'
   | 'lint/inconsiderateLanguage'
+  | 'lint/jsxA11yIframeHasTitle'
   | 'lint/jsxA11yHTMLHasLang'
   | 'lint/jsxKey'
   | 'lint/jsxNoCommentText'

packages/@romejs/diagnostics/descriptions.ts

@@ -419,6 +419,10 @@ export const descriptions = createMessages({
       category: 'lint/jsxNoCommentText',
       message: 'Comments inside children should be placed in braces',
     },
+    REACT_JSX_A11Y_IFRAME_HAS_TITLE: {
+      category: 'lint/jsxA11yIframeHasTitle',
+      message: `<emphasis>iframe</emphasis> elements should have a <emphasis>title prop</emphasis>.`,
+    },
     REACT_JSX_KEY: (origin: string) => ({
       category: 'lint/jsxKey',
       message: markup`Missing the "key" prop for element in ${origin}`,

packages/@romejs/js-compiler/lint/rules/index.ts

@@ -16,6 +16,7 @@ import emptyMatches from './regular/emptyMatches';
 import getterReturn from './regular/getterReturn';
 import importDefaultBasename from './regular/importDefaultBasename';
 import inconsiderateLanguage from './regular/inconsiderateLanguage';
+import jsxA11YIframeHasTitle from './react/jsxA11yIframeHasTitle';
 import jsxA11YHTMLHasLang from './react/jsxA11yHTMLHasLang';
 import jsxKey from './react/jsxKey';
 import jsxNoCommentText from './react/jsxNoCommentText';
@@ -76,6 +77,7 @@ export const lintTransforms = [
   getterReturn,
   importDefaultBasename,
   inconsiderateLanguage,
+  jsxA11YIframeHasTitle,
   jsxA11YHTMLHasLang,
   jsxKey,
   jsxNoCommentText,

packages/@romejs/js-compiler/lint/rules/react/jsxA11yIframeHasTitle.test.md

@@ -0,0 +1,249 @@
+# `jsxA11yIframeHasTitle.test.ts`
+
+**DO NOT MODIFY**. This file has been autogenerated. Run `rome test packages/@romejs/js-compiler/lint/rules/react/jsxA11yIframeHasTitle.test.ts --update-snapshots` to update.
+
+## `require a title attribute on <iframe> JSX elements`
+
+### `0`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe />
+    ^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `0: formatted`
+
+```
+<iframe />;
+
+```
+
+### `1`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe {...props} />
+    ^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `10`
+
+```
+✔ No known problems!
+
+```
+
+### `10: formatted`
+
+```
+<iframe title={title}></iframe>;
+
+```
+
+### `1: formatted`
+
+```
+<iframe {...props} />;
+
+```
+
+### `2`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title="" />
+    ^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `2: formatted`
+
+```
+<iframe title="" />;
+
+```
+
+### `3`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title={""} />
+    ^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `3: formatted`
+
+```
+<iframe title={''} />;
+
+```
+
+### `4`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title={``} />
+    ^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `4: formatted`
+
+```
+<iframe title={``} />;
+
+```
+
+### `5`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title={undefined} />
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `5: formatted`
+
+```
+<iframe title={undefined} />;
+
+```
+
+### `6`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title={false} />
+    ^^^^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `6: formatted`
+
+```
+<iframe title={false} />;
+
+```
+
+### `7`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title={true} />
+    ^^^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `7: formatted`
+
+```
+<iframe title={true} />;
+
+```
+
+### `8`
+
+```
+
+ unknown:1 lint/jsxA11yIframeHasTitle ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+  ✖ iframe elements should have a title prop.
+
+    <iframe title={42} />
+    ^^^^^^^^^^^^^^^^^^^^^
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+✖ Found 1 problem
+
+```
+
+### `8: formatted`
+
+```
+<iframe title={42} />;
+
+```
+
+### `9`
+
+```
+✔ No known problems!
+
+```
+
+### `9: formatted`
+
+```
+<iframe title="title" />;
+
+```

packages/@romejs/js-compiler/lint/rules/react/jsxA11yIframeHasTitle.test.ts

@@ -0,0 +1,35 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {test} from 'rome';
+
+import {testLintMultiple} from '../testHelpers';
+
+test(
+  'require a title attribute on <iframe> JSX elements',
+  async (t) => {
+    await testLintMultiple(
+      t,
+      [
+        // INVALID
+        '<iframe />',
+        '<iframe {...props} />',
+        '<iframe title="" />',
+        '<iframe title={""} />',
+        '<iframe title={``} />',
+        '<iframe title={undefined} />',
+        '<iframe title={false} />',
+        '<iframe title={true} />',
+        '<iframe title={42} />',
+        // VALID
+        '<iframe title="title" />',
+        '<iframe title={title} >',
+      ],
+      {category: 'lint/jsxA11yIframeHasTitle'},
+    );
+  },
+);

packages/@romejs/js-compiler/lint/rules/react/jsxA11yIframeHasTitle.ts

@@ -0,0 +1,47 @@
+/**
+* Copyright (c) Facebook, Inc. and its affiliates.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+import {descriptions} from '@romejs/diagnostics';
+import {AnyNode} from '@romejs/js-ast';
+import {Path} from '@romejs/js-compiler';
+
+function jsxIframeMissingTitle(node: AnyNode) {
+  return (
+    node.type === 'JSXElement' &&
+    node.name.type === 'JSXIdentifier' &&
+    node.name.name === 'iframe' &&
+    !node.attributes.some((attribute) =>
+      attribute.type === 'JSXAttribute' &&
+      attribute.name.name === 'title' &&
+      attribute.value &&
+      ((attribute.value.type === 'StringLiteral' &&
+      attribute.value.value.length > 0) ||
+      (attribute.value.type === 'JSXExpressionContainer' &&
+      ((attribute.value.expression.type === 'ReferenceIdentifier' &&
+      attribute.value.expression.name !== 'undefined') ||
+      (attribute.value.expression.type === 'StringLiteral' &&
+      attribute.value.expression.value.length > 0))))
+    )
+  );
+}
+
+export default {
+  name: 'jsxA11yIframeHasTitle',
+
+  enter(path: Path): AnyNode {
+    const {node} = path;
+
+    if (jsxIframeMissingTitle(node)) {
+      path.context.addNodeDiagnostic(
+        node,
+        descriptions.LINT.REACT_JSX_A11Y_IFRAME_HAS_TITLE,
+      );
+    }
+
+    return node;
+  },
+};