eslint-plugin-smarthr 3.1.0 → 3.3.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.3.0](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.2.0...eslint-plugin-smarthr-v3.3.0) (2025-12-18)
+
+
+### Features
+
+* best-practice-for-rest-parametersを追加 ([#953](https://github.com/kufu/tamatebako/issues/953)) ([093f8f2](https://github.com/kufu/tamatebako/commit/093f8f258b65a746cc10ae90696827600ca45dfc))
+
+## [3.2.0](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.1.0...eslint-plugin-smarthr-v3.2.0) (2025-12-15)
+
+
+### Features
+
+* best-practice-for-prohibit-import-smarthr-ui-local を追加 ([#946](https://github.com/kufu/tamatebako/issues/946)) ([1be8bf8](https://github.com/kufu/tamatebako/commit/1be8bf82aa97ccca9dba60277f50c5247ad2b664))
+
 ## [3.1.0](https://github.com/kufu/tamatebako/compare/eslint-plugin-smarthr-v3.0.0...eslint-plugin-smarthr-v3.1.0) (2025-12-10)
 
 

package/README.md

@@ -21,7 +21,9 @@
 - [best-practice-for-date](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-date)
 - [best-practice-for-layouts](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-layouts)
 - [best-practice-for-nested-attributes-array-index](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-nested-attributes-array-index)
+- [best-practice-for-prohibit-import-smarthr-ui-local](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-prohibit-import-smarthr-ui-local)
 - [best-practice-for-remote-trigger-dialog](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-remote-trigger-dialog)
+- [best-practice-for-rest-parameters](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters)
 - [best-practice-for-tailwind-prohibit-root-margin](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-tailwind-prohibit-root-margin)
 - [best-practice-for-tailwind-variants](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-tailwind-variants)
 - [design-system-guideline-prohibit-double-icons](https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/design-system-guideline-prohibit-double-icons)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-smarthr",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "author": "SmartHR",
   "license": "MIT",
   "description": "A sharable ESLint plugin for SmartHR",
@@ -26,7 +26,7 @@
     "json5": "^2.2.3"
   },
   "devDependencies": {
-    "typescript-eslint": "^8.48.1"
+    "typescript-eslint": "^8.49.0"
   },
   "peerDependencies": {
     "eslint": "^9"
@@ -37,5 +37,5 @@
     "eslintplugin",
     "smarthr"
   ],
-  "gitHead": "beddf6927401452bb9ac84ab7de9bb3fe0d85461"
+  "gitHead": "61261c2334b39d607b47e1f5be64fdb74f4ac83f"
 }

package/rules/best-practice-for-prohibit-import-smarthr-ui-local/README.md

@@ -0,0 +1,46 @@
+# smarthr/best-practice-for-prohibit-import-smarthr-ui-local
+
+- smarthr-uiの内部的に利用している型などのimportを禁止します
+  - 型は必要とするコンポーネントなどから生成することをおすすめします
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/best-practice-for-prohibit-import-smarthr-ui-local': 'error', // 'warn', 'off'
+  },
+}
+```
+
+## ❌ Incorrect
+
+```jsx
+// smarthr-uiの内部構造に依存したpathからimportしているためNG
+import { AnchorButton } from 'smarthr-ui/lib/components/Button/AnchorButton'
+import { FaArrowRightIcon } from 'smarthr-ui/lib/components/Icon'
+
+// 型情報は内部実装、storybookのためにexportしているもののため利用するとNG
+import { HeadingTagTypes } from 'smarthr-ui/lib/components/Heading/Heading'
+import type { Variant } from 'smarthr-ui/lib/components/Button/types'
+import { type Navigation } from 'smarthr-ui/lib/components/AppHeader/types'
+```
+
+## ✅ Correct
+
+```jsx
+// 'smarthr-ui' からimportしているのでOK
+import { AnchorButton, FaArrowRightIcon } from 'smarthr-ui'
+
+// 型情報をコンポーネントから生成しているのでOK
+import { ComponentProps } from 'react'
+
+import { Heading } from 'smarthr-ui'
+type HeadingTagTypes = Required<ComponentProps<typeof Heading>>['tag']
+
+import { Button } from 'smarthr-ui'
+type Variant = Required<ComponentProps<typeof Button>>['variant']
+
+import { AppHeader } from 'smarthr-ui'
+type Navigation = Exclude<ComponentProps<typeof AppHeader>['navigations'], undefined | null>[number]
+```

package/rules/best-practice-for-prohibit-import-smarthr-ui-local/index.js

@@ -0,0 +1,25 @@
+const SCHEMA = []
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.RuleModule<''>}
+ */
+module.exports = {
+  meta: {
+    type: 'problem',
+    schema: SCHEMA,
+  },
+  create(context) {
+    return {
+      [`ImportDeclaration[source.value=/^smarthr-ui\\u002Flib\\u002Fcomponents\\u002F/]`]: (node) => {
+        context.report({
+          node,
+          message: `smarthr-uiからコンポーネントや型をimportする際は 'smarthr-ui' からimportしてください
+ - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-prohibit-import-smarthr-ui-local
+ - 'smarthr-ui/lib/components' 以下からのexportはsmarthr-uiの内部実装・もしくはstorybook用であり、プロダクトからの利用は非推奨です
+ - 型を使いたい場合、コンポーネントからreact/ComponentPropsを利用し生成するように修正してください`,
+        })
+      },
+    }
+  },
+}
+module.exports.schema = SCHEMA

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

@@ -0,0 +1,63 @@
+# smarthr/best-practice-for-rest-parameters
+
+- 残余引数(rest parameters)の命名規則を設定するルールです
+  - https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Functions/rest_parameters
+- 残余引数にはrestという名称を設定することを推奨します
+  - よく利用される `props` という名称と完全一致する場合、エラーになります
+    - コンポーネントが受け取れる属性を定義する際、多用される "Props" 型と勘違いされる可能性を減らすためです
+    - 残余引数の時点でコンポーネントが受け取れる属性全てではないことが確定するためpropsの利用を禁止しています
+    - `xxxProps` のように他単語と組合されている場合はエラーになりません
+- 残余引数以外でrestという名称と完全一致する設定することを禁止します
+  - restは rest parametersから命名されたjsのイディオムのため、残余引数以外の箇所で利用すると混乱を招くためです
+    - `xxxRest` のように他単語と組合されている場合はエラーになりません
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/best-practice-for-rest-parameters': 'error', // 'warn', 'off'
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+// 残余引数にpropsという名称が設定されているためNG
+const hoge = (a, b, ...props) => {
+  // any
+}
+
+// オブジェクトの残余引数の場合も同様のチェックを行うためNG
+const hoge = ({ a, b, ...props }) => {
+  // any
+}
+
+// 残余引数ではない箇所でrestという文字列と完全一致する場合NG
+const hoge = (a, rest, b) => {
+  // any
+}
+// 引数以外の場合でも混乱するためNG
+const rest = { /* any */ }
+```
+
+## ✅ Correct
+
+
+```js
+// 残余引数にrestという名称が設定されておりOK
+const hoge = (a, b, ...rest) => {
+  // any
+}
+// 残余引数でもprops以外は許容
+const hoge = ({ a, b, ...actionButtonProps }) => {
+  // any
+}
+
+// 残余引数以外の場合はpropsを許容
+const hoge = (props) => {
+  // any
+}
+const props = { /* any */ }
+```

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

@@ -0,0 +1,32 @@
+const SCHEMA = []
+
+/**
+ * @type {import('@typescript-eslint/utils').TSESLint.RuleModule<''>}
+ */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    schema: SCHEMA,
+  },
+  create(context) {
+    return {
+      [`RestElement[argument.name='props']`]: (node) => {
+        context.report({
+          node,
+          message: `残余引数には 'props' という名称を利用しないでください
+ - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-rest-parameters
+ - 'rest' という名称を推奨します`,
+        });
+      },
+      [`:not(RestElement)>Identifier[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)と混同する可能性があるため別の名称に修正してください`,
+        });
+      },
+    }
+  },
+}
+module.exports.schema = SCHEMA

package/test/best-practice-for-prohibit-import-smarthr-ui-local.js

@@ -0,0 +1,27 @@
+const rule = require('../rules/best-practice-for-prohibit-import-smarthr-ui-local')
+const RuleTester = require('eslint').RuleTester
+
+const ERROR_MESSAGE = `smarthr-uiからコンポーネントや型をimportする際は 'smarthr-ui' からimportしてください
+ - 詳細: https://github.com/kufu/tamatebako/tree/master/packages/eslint-plugin-smarthr/rules/best-practice-for-prohibit-import-smarthr-ui-local
+ - 'smarthr-ui/lib/components' 以下からのexportはsmarthr-uiの内部実装・もしくはstorybook用であり、プロダクトからの利用は非推奨です
+ - 型を使いたい場合、コンポーネントからreact/ComponentPropsを利用し生成するように修正してください`
+
+const ruleTester = new RuleTester({
+  languageOptions: {
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+  },
+})
+ruleTester.run('best-practice-for-prohibit-import-smarthr-ui-local', rule, {
+  valid: [
+    { code: `import { AnchorButton } from 'smarthr-ui'` },
+  ],
+  invalid: [
+    { code: `import { AnchorButton } from 'smarthr-ui/lib/components/Button/AnchorButton'`, errors: [ { message: ERROR_MESSAGE } ] },
+    { code: `import { FaArrowRightIcon } from 'smarthr-ui/lib/components/Icon'`, errors: [ { message: ERROR_MESSAGE } ] },
+    { code: `import { HeadingTagTypes } from 'smarthr-ui/lib/components/Heading/Heading'`, errors: [ { message: ERROR_MESSAGE } ] },
+  ]
+})

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

@@ -0,0 +1,39 @@
+const rule = require('../rules/best-practice-for-rest-parameters')
+const RuleTester = require('eslint').RuleTester
+
+const ruleTester = new RuleTester({
+  languageOptions: {
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+  },
+})
+
+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
+ - 残余引数(rest parameters)と混同する可能性があるため別の名称に修正してください`
+
+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 = {}` },
+  ],
+  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 } ] },
+  ]
+})
+