eslint-plugin-smarthr 3.3.0 → 3.3.2

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.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)
+
+
+### Bug Fixes
+
+* smarthr/best-practice-for-rest-parametersの誤検知を修正 ([#959](https://github.com/kufu/tamatebako/issues/959)) ([12d2018](https://github.com/kufu/tamatebako/commit/12d20189c5f697b74751169925a063b8c67b4edb))
+
 ## [3.3.0](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.2.0...eslint-plugin-smarthr-v3.3.0) (2025-12-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-smarthr",
-  "version": "3.3.0",
+  "version": "3.3.2",
   "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": "61261c2334b39d607b47e1f5be64fdb74f4ac83f"
+  "gitHead": "6b6b572bcc35d4b23cb20ef6b29bedf011e3a881"
 }

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

@@ -3,13 +3,16 @@
 - 残余引数(rest parameters)の命名規則を設定するルールです
   - https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Functions/rest_parameters
 - 残余引数にはrestという名称を設定することを推奨します
-  - よく利用される `props` という名称と完全一致する場合、エラーになります
+  - よく利用される `props` などを利用するとエラーになります
     - コンポーネントが受け取れる属性を定義する際、多用される "Props" 型と勘違いされる可能性を減らすためです
     - 残余引数の時点でコンポーネントが受け取れる属性全てではないことが確定するためpropsの利用を禁止しています
-    - `xxxProps` のように他単語と組合されている場合はエラーになりません
+    - `rest` という名称に揃えることで可読性を向上させることが出来ます
 - 残余引数以外でrestという名称と完全一致する設定することを禁止します
   - restは rest parametersから命名されたjsのイディオムのため、残余引数以外の箇所で利用すると混乱を招くためです
     - `xxxRest` のように他単語と組合されている場合はエラーになりません
+- 残余引数内の属性を直接参照することを禁止します
+  - 例: `const hoge = rest.fuga`
+  - この条件を守る場合、残余引数がそのスコープ内で関心が薄い引数の集まりになり、可読性が向上します
 
 ## rules
 
@@ -24,7 +27,7 @@
 ## ❌ Incorrect
 
 ```js
-// 残余引数にpropsという名称が設定されているためNG
+// 残余引数にrest以外の名称が利用されているためNG
 const hoge = (a, b, ...props) => {
   // any
 }
@@ -40,6 +43,17 @@ const hoge = (a, rest, b) => {
 }
 // 引数以外の場合でも混乱するためNG
 const rest = { /* any */ }
+
+// 残余引数内の属性を参照しているためNG
+const Component = ({ a, b, ...rest }) => {
+  ...
+
+  if (rest.abc) {
+    return <Children {...rest} />
+  }
+
+  ...
+}
 ```
 
 ## ✅ Correct
@@ -50,14 +64,22 @@ const rest = { /* any */ }
 const hoge = (a, b, ...rest) => {
   // any
 }
-// 残余引数でもprops以外は許容
-const hoge = ({ a, b, ...actionButtonProps }) => {
-  // 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,9 @@
 const SCHEMA = []
 
+const MEMBER_EXPRESSION_REST_REGEX = /^rest\./
+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,23 +13,36 @@ module.exports = {
     schema: SCHEMA,
   },
   create(context) {
-    return {
-      [`RestElement[argument.name='props']`]: (node) => {
+    const actionNotRest = (node) => {
+      context.report({
+        node,
+        message: `残余引数以外に 'rest' という名称を利用しないでください${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: `残余引数には 'props' という名称を利用しないでください
- - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
- - 'rest' という名称を推奨します`,
+          message: `残余引数内の属性を参照しないでください${DETAIL_LINK}`,
         });
-      },
-      [`:not(RestElement)>Identifier[name='rest']`]: (node) => {
+      }
+    }
+
+    return {
+      [`RestElement:not([argument.name='rest'])`]: (node) => {
         context.report({
           node,
-          message: `残余引数以外に 'rest' という名称を利用しないでください
- - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
- - 残余引数(rest parameters)と混同する可能性があるため別の名称に修正してください`,
+          message: `残余引数には 'rest' という名称を指定してください${DETAIL_LINK}`,
         });
       },
+      [`:not(:matches(RestElement,JSXSpreadAttribute,JSXSpreadAttribute>TSAsExpression,SpreadElement,SpreadElement>TSAsExpression,MemberExpression,VariableDeclarator,ArrayExpression,CallExpression,ObjectPattern>Property,ObjectExpression>Property))>Identifier[name='rest']`]: actionNotRest,
+      [`:matches(VariableDeclarator[id.name='rest'],ObjectPattern>Property[value.name='rest'],ObjectExpression>Property[key.name='rest'])`]: actionNotRest,
+      [`MemberExpression[object.name='rest']`]: actionMemberExpressionName,
     }
   },
 }

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

@@ -11,29 +11,39 @@ 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 = `残余引数には 'rest' という名称を指定してください${DETAIL_LINK}`
+const ERROR_NOT_REST_NAME = `残余引数以外に 'rest' という名称を利用しないでください${DETAIL_LINK}
  - 残余引数(rest parameters)と混同する可能性があるため別の名称に修正してください`
+const ERROR_REST_CHILD_REF = `残余引数内の属性を参照しないでください${DETAIL_LINK}`
 
 ruleTester.run('best-practice-for-rest-parameters', rule, {
   valid: [
     { 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 = (props) => {}` },
     { code: `const props = {}` },
     { code: `const hogeRest = {}` },
+    { code: `const hoge = { fuga: rest }` },
+    { code: `const hoge = rest` },
+    { code: `const hoge = hoge.rest.fuga` },
+    { code: `const hoge = { ...rest }` },
+    { code: `const hoge = [rest]` },
+    { code: `hoge(rest)` },
+    { 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 rest = {}`, errors: [ { message: ERROR_REST } ] },
+    { code: `const hoge = (a, b, ...props) => {}`, errors: [ { message: ERROR_REST_NAME } ] },
+    { code: `const hoge = ({ a, b, ...props }) => {}`, errors: [ { message: ERROR_REST_NAME } ] },
+    { code: `const hoge = (rest) => {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = (a, b, rest) => {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = ({ a: rest, b }) => {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const rest = {}`, errors: [ { message: ERROR_NOT_REST_NAME } ] },
+    { code: `const hoge = { rest }`, 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 = rest.hoge.fuga`, errors: [ { message: ERROR_REST_CHILD_REF } ] },
   ]
 })