eslint-plugin-smarthr 0.4.2 → 0.5.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.5.0](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.4.2...v0.5.0) (2024-03-11)
+
+
+### ⚠ BREAKING CHANGES
+
+* spread attributesが指定されている場合、ruleをcorrectにする smartr オプションを allow-spread-attributes オプションにリネームする (#119)
+
+### Bug Fixes
+
+* spread attributesが指定されている場合、ruleをcorrectにする smartr オプションを allow-spread-attributes オプションにリネームする ([#119](https://github.com/kufu/eslint-plugin-smarthr/issues/119)) ([25752bb](https://github.com/kufu/eslint-plugin-smarthr/commit/25752bb8e77cf170779de3746b9dbbc3997be09d))
+
 ### [0.4.2](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.4.1...v0.4.2) (2024-03-03)
 
 
@@ -333,7 +344,7 @@ All notable changes to this project will be documented in this file. See [standa
 ### [0.2.14](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.2.13...v0.2.14) (2022-12-13)
 
 ### Features
-* trim-propsルールを追加 ([#44](https://github.com/kufu/eslint-plugin-smarthr/pull/44)) 
+* trim-propsルールを追加 ([#44](https://github.com/kufu/eslint-plugin-smarthr/pull/44))
 
 ### [0.2.13](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.2.12...v0.2.13) (2022-12-07)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-smarthr",
-  "version": "0.4.2",
+  "version": "0.5.0",
   "author": "SmartHR",
   "license": "MIT",
   "description": "A sharable ESLint plugin for SmartHR",

package/rules/a11y-anchor-has-href-attribute/README.md

@@ -6,7 +6,7 @@
   - URL遷移を行う場合、hrefが設定されていないとキーボード操作やコンテキストメニューからの遷移ができなくなります
     - これらの操作は href属性を参照します
   - 無効化されたリンクであることを表したい場合 `href={undefined}` を設定してください
-- checkTypeオプションに 'smart' を指定することで spread attributeが設定されている場合はcorrectに出来ます
+- checkTypeオプションに 'allow-spread-attributes' を指定することで spread attributeが設定されている場合はcorrectに出来ます
 - react-router-dom packageを利用している場合、a要素にto属性が指定されている場合、href属性が指定されているものとして許容します
 - next/link コンポーネント直下のa要素にhref属性が指定されていないことを許容します
 
@@ -17,7 +17,7 @@
   rules: {
     'smarthr/a11y-anchor-has-href-attribute': [
       'error', // 'warn', 'off'
-      // { checkType: 'always' } /* 'always' || 'smart' */
+      // { checkType: 'always' } /* 'always' || 'allow-spread-attributes' */
     ]
   },
 }
@@ -49,7 +49,7 @@
 // react-router-domを利用している場合
 <Link to={hoge}>any</Link>
 
-// checkType: 'smart'
+// checkType: 'allow-spread-attributes'
 <XxxAnchor {...args} />
 <XxxLink {...args} any="any" />
 ```

package/rules/a11y-anchor-has-href-attribute/index.js

@@ -45,7 +45,7 @@ const baseCheck = (node, checkType) => {
   if (
     nodeName.match(REGEX_TARGET) &&
     checkExistAttribute(node, findHrefAttribute) &&
-    (checkType !== 'smart' || !node.attributes.some(findSpreadAttr))
+    (checkType !== 'allow-spread-attributes' || !node.attributes.some(findSpreadAttr))
   ) {
     return nodeName
   }
@@ -87,7 +87,7 @@ const SCHEMA = [
   {
     type: 'object',
     properties: {
-      checkType: { type: 'string', enum: ['always', 'smart'], default: 'always' },
+      checkType: { type: 'string', enum: ['always', 'allow-spread-attributes'], default: 'always' },
     },
     additionalProperties: false,
   }

package/rules/a11y-delegate-element-has-role-presentation/README.md

@@ -1,10 +1,10 @@
-# smarthr/a11y-delegate-element-has-role-presantation
+# smarthr/a11y-delegate-element-has-role-presentation
 
-- 'role="presantation"'を適切に設定することを促すルールです
-- インタラクティブな要素に対して'role="presantation"'が設定されている場合、エラーになります
+- 'role="presentation"'を適切に設定することを促すルールです
+- インタラクティブな要素に対して'role="presentation"'が設定されている場合、エラーになります
   - インタラクティブな要素とは form, inputなどの入力要素、button, a などのクリッカブルな要素を指します
-- インタラクティブな要素から発生するイベントを親要素でキャッチする場合、親要素に 'role="presantation"' を設定することを促します
-  - インタラクティブではない要素でイベントをキャッチしており、かつ'role="presantation"'を設定しているにも関わらず、子要素にインタラクティブな要素がない場合はエラーになります
+- インタラクティブな要素から発生するイベントを親要素でキャッチする場合、親要素に 'role="presentation"' を設定することを促します
+  - インタラクティブではない要素でイベントをキャッチしており、かつ'role="presentation"'を設定しているにも関わらず、子要素にインタラクティブな要素がない場合はエラーになります
 - additionalInteractiveComponentRegexオプションに独自コンポーネントの名称を正規表現で設定することで、インタラクティブな要素として判定することが可能です
 
 ## rules
@@ -12,7 +12,7 @@
 ```js
 {
   rules: {
-    'smarthr/a11y-delegate-element-has-role-presantation': [
+    'smarthr/a11y-delegate-element-has-role-presentation': [
       'error', // 'warn', 'off'
       // { additionalInteractiveComponentRegex: ['^InteractiveComponent%'] }
     ]
@@ -23,12 +23,12 @@
 ## ❌ Incorrect
 
 ```jsx
-// インタラクティブな要素に対して role="presantation" は設定できない
-<Button role="presantation">text.</Button>
-<input type="text" role="presantation" />
+// インタラクティブな要素に対して role="presentation" は設定できない
+<Button role="presentation">text.</Button>
+<input type="text" role="presentation" />
 
 // インタラクティブな要素で発生するイベントを非インタラクティブな要素でキャッチする場合
-// role="presantation" を設定する必要がある
+// role="presentation" を設定する必要がある
 <div onClick={hoge}>
   <Button>text.</Button>
 </div>
@@ -44,7 +44,7 @@
 
 ```jsx
 // インタラクティブな要素で発生するイベントを非インタラクティブな要素でキャッチする場合
-// role="presantation" を設定する
+// role="presentation" を設定する
 <div onClick={hoge} role="presentation">
   <Button>text.</Button>
 </div>

package/rules/a11y-image-has-alt-attribute/README.md

@@ -1,7 +1,7 @@
 # smarthr/a11y-image-has-alt-attribute
 
 - 画像やアイコンにalt属性を設定することを強制するルールです
-- checkTypeオプションに 'smart' を指定することで spread attributeが設定されている場合はcorrectに出来ます。
+- checkTypeオプションに 'allow-spread-attributes' を指定することで spread attributeが設定されている場合はcorrectに出来ます。
 
 ## rules
 
@@ -10,7 +10,7 @@
   rules: {
     'smarthr/a11y-image-has-alt-attribute': [
       'error', // 'warn', 'off'
-      // { checkType: 'always' } /* 'always' || 'smart' */
+      // { checkType: 'always' } /* 'always' || 'allow-spread-attributes' */
     ]
   },
 }
@@ -56,7 +56,7 @@ const StyledPiyo = styled(Icon)``
 <Icon alt="message" />
 ```
 ```jsx
-// checkType: 'smart'
+// checkType: 'allow-spread-attributes'
 <XxxImage {...args} />
 <YyyIcon {...args} any="any" />
 ```

package/rules/a11y-image-has-alt-attribute/index.js

@@ -42,7 +42,7 @@ const SCHEMA = [
   {
     type: 'object',
     properties: {
-      checkType: { type: 'string', enum: ['always', 'smart'], default: 'always' },
+      checkType: { type: 'string', enum: ['always', 'allow-spread-attributes'], default: 'always' },
     },
     additionalProperties: false,
   }
@@ -76,7 +76,7 @@ module.exports = {
                   !isWithinSvgJsxElement(node.parent)
                 ) &&
                 (
-                  checkType !== 'smart' ||
+                  checkType !== 'allow-spread-attributes' ||
                   !node.attributes.some(findSpreadAttr)
                 )
               ) {

package/rules/a11y-input-has-name-attribute/README.md

@@ -4,7 +4,7 @@
   - 入力要素は name を設定することでブラウザの補完機能が有効になる可能性が高まります。
     - 補完機能はブラウザによって異なるため、補完される可能性が上がるよう、name には半角英数の小文字・大文字と一部記号(`_ , [, ]`)のみ利用可能です。
   - input[type="radio"] は name を適切に設定することでラジオグループが確立され、キーボード操作しやすくなる等のメリットがあります。
-- checkTypeオプションに 'smart' を指定することで spread attributeが設定されている場合はcorrectに出来ます。
+- checkTypeオプションに 'allow-spread-attributes' を指定することで spread attributeが設定されている場合はcorrectに出来ます。
 
 ## rules
 
@@ -13,7 +13,7 @@
   rules: {
     'smarthr/a11y-input-has-name-attribute': [
       'error', // 'warn', 'off'
-      // { checkType: 'always' } /* 'always' || 'smart' */
+      // { checkType: 'always' } /* 'always' || 'allow-spread-attributes' */
     ]
   },
 }
@@ -51,7 +51,7 @@ const StyledPiyo = styled(RadioButton)``;
 <Textarea name="some" />
 <Select name="piyo" />
 
-// checkType: 'smart'
+// checkType: 'allow-spread-attributes'
 <AnyInput {...args} />
 <AnyInput {...args} any="any" />
 ```

package/rules/a11y-input-has-name-attribute/index.js

@@ -34,7 +34,7 @@ const SCHEMA = [
   {
     type: 'object',
     properties: {
-      checkType: { type: 'string', enum: ['always', 'smart'], default: 'always' },
+      checkType: { type: 'string', enum: ['always', 'allow-spread-attributes'], default: 'always' },
     },
     additionalProperties: false,
   }
@@ -60,7 +60,7 @@ module.exports = {
           if (!nameAttr) {
             if (
               node.attributes.length === 0 ||
-              checkType !== 'smart' ||
+              checkType !== 'allow-spread-attributes' ||
               !node.attributes.some(findSpreadAttr)
             ) {
               const isRadio =

package/test/a11y-anchor-has-href-attribute.js

@@ -37,7 +37,7 @@ ruleTester.run('a11y-anchor-has-href-attribute', rule, {
     { code: `<HogeAnchor href={hoge}>ほげ</HogeAnchor>` },
     { code: `<Link href="hoge">ほげ</Link>` },
     { code: `<Link href="#fuga">ほげ</Link>` },
-    { code: '<AnyAnchor {...args1} />', options: [{ checkType: 'smart' }] },
+    { code: '<AnyAnchor {...args1} />', options: [{ checkType: 'allow-spread-attributes' }] },
   ],
   invalid: [
     { code: `import hoge from 'styled-components'`, errors: [ { message: `styled-components をimportする際は、名称が"styled" となるようにしてください。例: "import styled from 'styled-components'"` } ] },

package/test/a11y-image-has-alt-attribute.js

@@ -45,7 +45,7 @@ ruleTester.run('a11y-image-has-alt-attribute', rule, {
     { code: '<HogeImage aria-describedby="hoge" />' },
     { code: '<HogeImage aria-describedby="hoge" alt="fuga" />' },
     { code: '<svg><image /></svg>' },
-    { code: '<AnyImg {...hoge} />', options: [{ checkType: 'smart' }] },
+    { code: '<AnyImg {...hoge} />', options: [{ checkType: 'allow-spread-attributes' }] },
   ],
   invalid: [
     { code: `import hoge from 'styled-components'`, errors: [ { message: `styled-components をimportする際は、名称が"styled" となるようにしてください。例: "import styled from 'styled-components'"` } ] },

package/test/a11y-input-has-name-attribute.js

@@ -46,9 +46,9 @@ ruleTester.run('a11y-input-has-name-attribute', rule, {
     { code: '<HogeTextarea name="hoge" />' },
     { code: '<select name="hoge" />' },
     { code: '<Select name="hoge[0][Fuga]" />' },
-    { code: '<Input {...hoge} />', options: [{ checkType: 'smart' }] },
-    { code: '<Input {...args1} {...args2} />', options: [{ checkType: 'smart' }] },
-    { code: '<Input {...args} hoge="fuga" />', options: [{ checkType: 'smart' }] },
+    { code: '<Input {...hoge} />', options: [{ checkType: 'allow-spread-attributes' }] },
+    { code: '<Input {...args1} {...args2} />', options: [{ checkType: 'allow-spread-attributes' }] },
+    { code: '<Input {...args} hoge="fuga" />', options: [{ checkType: 'allow-spread-attributes' }] },
   ],
   invalid: [
     { code: `import hoge from 'styled-components'`, errors: [ { message: `styled-components をimportする際は、名称が"styled" となるようにしてください。例: "import styled from 'styled-components'"` } ] },