eslint-plugin-smarthr 3.3.1 → 3.4.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.
 
+## [3.4.0](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.3.2...eslint-plugin-smarthr-v3.4.0) (2025-12-24)
+
+
+### Features
+
+* best-practice-for-rest-parameters の残余引数の命名規則をrestもしくはxxxRestにすることを促すように修正 ([#973](https://github.com/kufu/tamatebako/issues/973)) ([3824818](https://github.com/kufu/tamatebako/commit/3824818a68d0ab6b2b2dc04ff5292f9d8be03d9b))
+
+## [3.3.2](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.3.1...eslint-plugin-smarthr-v3.3.2) (2025-12-23)
+
+
+### Bug Fixes
+
+* best-practice-for-rest-parametersの誤検知を修正し、エラー文言を条件に合わせて出し分けるように修正 ([#967](https://github.com/kufu/tamatebako/issues/967)) ([cf71e12](https://github.com/kufu/tamatebako/commit/cf71e1256ef6453fe99080829e6969cea88d5a92))
+
 ## [3.3.1](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.3.0...eslint-plugin-smarthr-v3.3.1) (2025-12-19)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-smarthr",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "author": "SmartHR",
   "license": "MIT",
   "description": "A sharable ESLint plugin for SmartHR",
@@ -26,7 +26,7 @@
     "json5": "^2.2.3"
   },
   "devDependencies": {
-    "typescript-eslint": "^8.49.0"
+    "typescript-eslint": "^8.50.0"
   },
   "peerDependencies": {
     "eslint": "^9"
@@ -37,5 +37,5 @@
     "eslintplugin",
     "smarthr"
   ],
-  "gitHead": "7390a378bca7e0f44fa90cb2a983cc807dc6c403"
+  "gitHead": "25b508c89653cc0e754e091f83d8b31346afb08e"
 }

package/rules/best-practice-for-rest-parameters/README.md

@@ -3,13 +3,17 @@
 - 残余引数(rest parameters)の命名規則を設定するルールです
   - https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Functions/rest_parameters
 - 残余引数にはrestという名称を設定することを推奨します
-  - よく利用される `props` という名称と完全一致する場合、エラーになります
+  - よく利用される `props` などを利用するとエラーになります
     - コンポーネントが受け取れる属性を定義する際、多用される "Props" 型と勘違いされる可能性を減らすためです
     - 残余引数の時点でコンポーネントが受け取れる属性全てではないことが確定するためpropsの利用を禁止しています
-    - `xxxProps` のように他単語と組合されている場合はエラーになりません
-- 残余引数以外でrestという名称と完全一致する設定することを禁止します
+    - `rest` という名称に揃えることで可読性を向上させることが出来ます
+  - restがすでに利用されており設定出来ない場合 `xxxRest` というフォーマットが利用出来ます
+- 残余引数以外でrest、もしくはxxxRestというフォーマットの名称を設定することを禁止します
   - restは rest parametersから命名されたjsのイディオムのため、残余引数以外の箇所で利用すると混乱を招くためです
-    - `xxxRest` のように他単語と組合されている場合はエラーになりません
+- 残余引数内の属性を直接参照することを禁止します
+  - 例: `const hoge = rest.fuga`
+  - 例: `const { hoge } = rest`
+  - この条件を守る場合、残余引数がそのスコープ内で関心が薄い引数の集まりになり、可読性が向上します
 
 ## rules
 
@@ -24,7 +28,7 @@
 ## ❌ Incorrect
 
 ```js
-// 残余引数にpropsという名称が設定されているためNG
+// 残余引数にrest、xxxRest以外の名称が利用されているためNG
 const hoge = (a, b, ...props) => {
   // any
 }
@@ -34,12 +38,35 @@ const hoge = ({ a, b, ...props }) => {
   // any
 }
 
-// 残余引数ではない箇所でrestという文字列と完全一致する場合NG
-const hoge = (a, rest, b) => {
+// 残余引数ではない箇所で残余引数と勘違いしかねない命名がされているためNG
+const hoge = (a, anyRest, b) => {
   // any
 }
 // 引数以外の場合でも混乱するためNG
-const rest = { /* any */ }
+const hogeRest = { /* any */ }
+
+// 残余引数内の属性を参照しているためNG
+const ComponentA = ({ a, b, ...rest }) => {
+  ...
+
+  if (rest.abc) {
+    return <Children {...rest} />
+  }
+
+  ...
+}
+const ComponentB = ({ a, b, ...rest }) => {
+  ...
+
+  // 残余引数を構造分解することもNG
+  const { abc } = rest
+
+  if (abc) {
+    return <Children {...rest} />
+  }
+
+  ...
+}
 ```
 
 ## ✅ Correct
@@ -50,14 +77,25 @@ const rest = { /* any */ }
 const hoge = (a, b, ...rest) => {
   // any
 }
-// 残余引数でもprops以外は許容
-const hoge = ({ a, b, ...actionButtonProps }) => {
+const fuga = ({ a, b, ...anyRest }) => {
   // any
 }
 
-// 残余引数以外の場合はpropsを許容
+// 残余引数ではない場合、rest以外の名称を許容
 const hoge = (props) => {
   // any
 }
 const props = { /* any */ }
+
+// 残余引数内の属性を参照しないようにコードが書かれているため許容
+// HINT: 残余引数がそのスコープ内で関心が薄い引数の集まりになり、可読性が向上します
+const Component = ({ a, b, abc, ...rest }) => {
+  ...
+
+  if (abc) {
+    return <Children {...rest} abc={abc} />
+  }
+
+  ...
+}
 ```

package/rules/best-practice-for-rest-parameters/index.js

@@ -1,5 +1,10 @@
 const SCHEMA = []
 
+const REST_REGEX = /(^r|R)est$/
+const MEMBER_EXPRESSION_REST_REGEX = /^(r|[a-zA-Z0-9_]+R)est\./
+const DETAIL_LINK = `
+ - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters`
+
 /**
  * @type {import('@typescript-eslint/utils').TSESLint.RuleModule<''>}
  */
@@ -9,26 +14,48 @@ module.exports = {
     schema: SCHEMA,
   },
   create(context) {
-    const restAction = (node) => {
+    const actionNotRest = (node) => {
       context.report({
         node,
-        message: `残余引数以外に 'rest' という名称を利用しないでください
- - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
+        message: `残余引数以外に ${REST_REGEX} とマッチする名称を利用しないでください${DETAIL_LINK}
  - 残余引数(rest parameters)と混同する可能性があるため別の名称に修正してください`,
-      });
+      })
+    }
+    const actionMemberExpressionName = (node) => {
+      if (node.parent.type === 'MemberExpression') {
+        return actionMemberExpressionName(node.parent)
+      }
+
+      if (MEMBER_EXPRESSION_REST_REGEX.test(context.sourceCode.getText(node))){
+        context.report({
+          node,
+          message: `残余引数内の属性を参照しないでください${DETAIL_LINK}`,
+        })
+      }
     }
 
     return {
-      [`RestElement[argument.name='props']`]: (node) => {
+      [`ObjectPattern[properties.length=1]>RestElement`]: (node) => {
+        context.report({
+          node,
+          message: `意味のない残余引数のため、単一の引数に変更してください${DETAIL_LINK}`,
+        })
+      },
+      [`RestElement:not([argument.name=${REST_REGEX}])`]: (node) => {
+        context.report({
+          node,
+          message: `残余引数には ${REST_REGEX} とマッチする名称を指定してください${DETAIL_LINK}`,
+        })
+      },
+      [`:not(:matches(RestElement,JSXSpreadAttribute,JSXSpreadAttribute>TSAsExpression,SpreadElement,SpreadElement>TSAsExpression,MemberExpression,VariableDeclarator,ArrayExpression,CallExpression,ObjectPattern>Property,ObjectExpression>Property))>Identifier[name=${REST_REGEX}]`]: actionNotRest,
+      [`:matches(VariableDeclarator[id.name=${REST_REGEX}],ObjectPattern>Property[value.name=${REST_REGEX}],ObjectExpression>Property[key.name=${REST_REGEX}])`]: actionNotRest,
+      [`MemberExpression[object.name=${REST_REGEX}]`]: actionMemberExpressionName,
+      [`VariableDeclarator[id.type='ObjectPattern'][init.name=${REST_REGEX}]`]: (node) => {
         context.report({
           node,
-          message: `残余引数には 'props' という名称を利用しないでください
- - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
- - 'rest' という名称を推奨します`,
-        });
+          message: `残余引数内の属性を参照しないでください${DETAIL_LINK}`,
+        })
       },
-      [`:not(:matches(RestElement,JSXSpreadAttribute,ObjectPattern>Property,ObjectExpression>Property))>Identifier[name='rest']`]: restAction,
-      [`:matches(ObjectPattern>Property[value.name='rest'],ObjectExpression>Property[key.name='rest'])`]: restAction,
     }
   },
 }

package/test/best-practice-for-rest-parameters.js

@@ -11,34 +11,42 @@ const ruleTester = new RuleTester({
   },
 })
 
-const ERROR_PROPS = `残余引数には 'props' という名称を利用しないでください
- - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
- - 'rest' という名称を推奨します`
-const ERROR_REST = `残余引数以外に 'rest' という名称を利用しないでください
- - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
+const DETAIL_LINK = `
+ - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters`
+const ERROR_REST_NAME = `残余引数には /(^r|R)est$/ とマッチする名称を指定してください${DETAIL_LINK}`
+const ERROR_NOT_REST_NAME = `残余引数以外に /(^r|R)est$/ とマッチする名称を利用しないでください${DETAIL_LINK}
  - 残余引数(rest parameters)と混同する可能性があるため別の名称に修正してください`
+const ERROR_REST_CHILD_REF = `残余引数内の属性を参照しないでください${DETAIL_LINK}`
 
 ruleTester.run('best-practice-for-rest-parameters', rule, {
   valid: [
+    { code: `const hoge = (...rest) => {}` },
     { code: `const hoge = (a, b, ...rest) => {}` },
-    { code: `const hoge = ({ a, b, ...rest }) => {}` },
-    { code: `const hoge = (a, b, ...hoge) => {}` },
-    { code: `const hoge = ({ a, b, ...xxxProps }) => {}` },
+    { code: `const hoge = ({ a, b, ...anyRest }) => {}` },
     { code: `const hoge = (props) => {}` },
     { code: `const props = {}` },
-    { code: `const hogeRest = {}` },
     { code: `const hoge = { fuga: rest }` },
+    { code: `const hoge = hogeRest` },
+    { code: `const hoge = hoge.rest.fuga` },
+    { code: `const hoge = { ...anyRest }` },
+    { code: `const hoge = [rest]` },
+    { code: `hoge(fugaRest)` },
     { code: `<Any {...rest} />` },
   ],
   invalid: [
-    { code: `const hoge = (a, b, ...props) => {}`, errors: [ { message: ERROR_PROPS } ] },
-    { code: `const hoge = ({ a, b, ...props }) => {}`, errors: [ { message: ERROR_PROPS } ] },
-    { code: `const hoge = (rest) => {}`, errors: [ { message: ERROR_REST } ] },
-    { code: `const hoge = (a, b, rest) => {}`, errors: [ { message: ERROR_REST } ] },
-    { code: `const hoge = ({ a: rest, b }) => {}`, errors: [ { message: ERROR_REST } ] },
-    { code: `const rest = {}`, errors: [ { message: ERROR_REST } ] },
-    { code: `const hoge = { rest }`, errors: [ { message: ERROR_REST } ] },
-    { code: `const hoge = { rest: fuga }`, errors: [ { message: ERROR_REST } ] },
+    { code: `const hoge = ({ ...rest }) => {}`, errors: [ { message: `意味のない残余引数のため、単一の引数に変更してください${DETAIL_LINK}` } ] },
+    { code: `const hoge = (a, b, ...any) => {}`, errors: [ { message: ERROR_REST_NAME } ] },
+    { code: `const hoge = ({ a, b, ...restHoge }) => {}`, errors: [ { message: ERROR_REST_NAME } ] },
+    { code: `const hoge = (rest) => {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hogeRest = {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = (a, b, rest) => {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = ({ a: anyRest, b }) => {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const rest = {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = { hogeRest }`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = { rest: fuga }`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = rest.hoge`, errors: [ { message: ERROR_REST_CHILD_REF } ] },
+    { code: `const hoge = anyRest.hoge.fuga`, errors: [ { message: ERROR_REST_CHILD_REF } ] },
+    { code: `const { any } = rest`, errors: [ { message: ERROR_REST_CHILD_REF } ] },
   ]
 })