eslint-plugin-smarthr 0.0.0 → 0.1.1

package/CHANGELOG.md

@@ -2,9 +2,28 @@
 
 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.0.2](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.0.1...v0.0.2) (2022-01-26)
+### [0.1.1](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.1.0...v0.1.1) (2022-03-08)
+
+
+### Features
+
+* add require-barrel-import rule ([#13](https://github.com/kufu/eslint-plugin-smarthr/issues/13)) ([79ee88d](https://github.com/kufu/eslint-plugin-smarthr/commit/79ee88d355e01bb8344dc95bd65157e2fbcf916e))
+
+## [0.1.0](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.0.1...v0.1.0) (2022-02-09)
+
+
+### ⚠ BREAKING CHANGES
+
+* BREAKING CHANGE: add require-import & update prohibit-import (#12) ([e6c5c44](https://github.com/kufu/eslint-plugin-smarthr/commit/e6c5c445a21620d4b796ded00a685e5da367c7bb)), closes [#12](https://github.com/kufu/eslint-plugin-smarthr/issues/12)
+
+### [0.0.1](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.0.0...v0.0.1) (2022-02-08)
+
+
+### Features
+
+* add type property function params redundant ([758df90](https://github.com/kufu/eslint-plugin-smarthr/commit/758df90f89bd27dd589aeeb55165e27c8e072b08))
+* redundant-name の修正候補を操作できるように改修 ([20991e8](https://github.com/kufu/eslint-plugin-smarthr/commit/20991e874890556e84e7c682e789e4b2650a85b0))
 
-### [0.0.1](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.0.0...v0.0.1) (2022-01-26)
 
 ## 0.0.0 (2022-01-25)
 

package/README.md

@@ -145,13 +145,19 @@ import globalModulePart from '@/modules/views/parts'
 ## smarthr/jsx-start-with-spread-attributes
 
 - jsxを記述する際、意図しない属性の上書きを防ぐため、spread-attributesを先に指定するように強制するruleです
+- eslint を `--fix` オプション付きで実行する際、 fix option を true にすると自動修正します
 
 ### rules
 
 ```js
 {
   rules: {
-    'smarthr/jsx-start-with-spread-attributes': 'error', // 'warn', 'off'
+    'smarthr/jsx-start-with-spread-attributes': [
+      'error', // 'warn', 'off'
+      {
+        fix: false, // true
+      },
+    ]
   },
 }
 ```
@@ -268,12 +274,17 @@ import globalModulePart from '@/modules/views/parts'
     'smarthr/prohibit-import': [
       'error', // 'warn', 'off'
       {
-        targets: {
-          '^query-string$': true, // key は 正規表現を指定する
-          '^smarthr-ui$': ['SecondaryButtonAnchor'], 
+        '^.+$': {
+          'smarthr-ui': {
+            imported: ['SecondaryButtonAnchor'],
+            reportMessage: `{{module}}/{{export}} はXxxxxxなので利用せず yyyy/zzzz を利用してください`
+          }, 
+        }
+        '\/pages\/views\/': {
+          'query-string': {
+            imported: true,
+          },
         },
-        // generateReportMessage: (source, imported) => 
-        //   `${source}${imported && `/${imported}`} はXxxxxxなので利用せず yyyy/zzzz を利用してください`
       }
     ]
   },
@@ -283,6 +294,7 @@ import globalModulePart from '@/modules/views/parts'
 ### ❌ Incorrect
 
 ```js
+// src/pages/views/Page.tsx
 import queryString from 'query-string'
 import { SecondaryButtonAnchor } from 'smarthr-ui'
 ```
@@ -291,10 +303,101 @@ import { SecondaryButtonAnchor } from 'smarthr-ui'
 
 
 ```js
+// src/pages/views/Page.tsx
 import { PrimaryButton, SecondaryButton } from 'smarthr-ui'
 ```
 
+## smarthr/require-import
+
+- 対象ファイルにimportを強制させたい場合に利用します
+  - 例: Page.tsx ではページタイトルを設定させたいので useTitle を必ずimportさせたい
+
+### rules
+
+```js
+{
+  rules: {
+    'smarthr/require-import': [
+      'error',
+      {
+        'Buttons\/.+\.tsx': {
+          'smarthr-ui': {
+            imported: ['SecondaryButton'],
+            reportMessage: 'Buttons以下のコンポーネントでは {{module}}/{{export}} を拡張するようにしてください',
+          },
+        },
+        'Page.tsx$': {
+          './client/src/hooks/useTitle': {
+            imported: true,
+            reportMessage: '{{module}} を利用してください（ページタイトルを設定するため必要です）',
+          },
+        },
+      },
+    ]
+  },
+}
+```
+
+### ❌ Incorrect
+
+```js
+// client/src/Buttons/SecondaryButton.tsx
+import { SecondaryButtonAnchor } from 'smarthr-ui'
+
+// client/src/Page.tsx
+import { SecondaryButton } from 'smarthr-ui'
+```
+
+### ✅ Correct
+
+
+```js
+// client/src/Buttons/SecondaryButton.tsx
+import { SecondaryButton } from 'smarthr-ui'
+
+// client/src/Page.tsx
+import useTitle from '.hooks/useTitle'
+```
+
+## smarthr/require-barrel-import
+
+- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- importした対象が本来exportされているべきであるbarrel(index.tsなど)が有る場合、import pathの変更を促します
+  - 例: Page/parts/Menu/Item の import は Page/parts/Menu から行わせたい
+- ディレクトリ内のindexファイルを捜査し、対象を決定します
+
+### rules
+
+```js
+{
+  rules: {
+    'smarthr/require-barrel-import': 'error',
+  },
+}
+```
+
+### ❌ Incorrect
 
+```js
+// client/src/views/Page/parts/Menu/index.ts
+export { Menu } from './Menu'
+export { Item } from './Item'
+
+// client/src/App.tsx
+import { Item } from './Page/parts/Menu/Item'
+```
+
+### ✅ Correct
+
+
+```js
+// client/src/views/Page/parts/Menu/index.ts
+export { Menu } from './Menu'
+export { Item } from './Item'
+
+// client/src/App.tsx
+import { Item } from './Page/parts/Menu'
+```
 
 
 ## smarthr/redundant-name
@@ -305,47 +408,14 @@ import { PrimaryButton, SecondaryButton } from 'smarthr-ui'
 ### config
 
 - tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
-- 以下の設定を記述する必要があります
+- 以下の設定を行えます。全て省略可能です。
   - ignoreKeywords
     - ディレクトリ名から生成されるキーワードに含めたくない文字列を指定します
-  - keywordGenerator
-    - ディレクトリ名から生成されるキーワードを元に最終的なキーワードを生成します
-  - suffixGenerator:
+  - betterNames
+    - 対象の名前を修正する候補を指定します
+  - suffix:
     - type のみ指定出来ます
-    - type のsuffixを生成します
-
-#### 指定例
-```
-const ignorekeywords = ['views', 'parts']
-const keywordGenerator = ({ keywords }) => (
-  keywords.reduce((prev, keyword, index) => {
-    switch (keyword) {
-      case 'repositories':
-        return [...prev, keyword, 'repository']
-    }
-
-    const replacedKeyword = keyword.replace(/(repository|s)$/, '')
-    if (keyword !== replacedKeyword) {
-      return [...prev, keyword, replacedKeyword]
-    }
-
-    return [...prev, keyword]
-  }, [])
-)
-// 例: actions 以下の場合だけ 'Action' もしくは `Actions` のSuffixを許可する
-const suffixGenerator = ({ node, filename }) => {
-  let suffix = ['Props', 'Type']
-
-  if (filename.match(/\/actions\//)) {
-    suffix = [
-      isUnionType || (node.typeAnnotation.type === 'TSTypeReference' && node.id.name.match(/Actions$/))
-        ? 'Actions'
-        : 'Action',
-      ...suffix,
-    ]
-  }
-}
-```
+    - type のsuffixを指定します
 
 #### ファイル例
 - `@/crews/index/views/page.tsx` の場合
@@ -359,17 +429,33 @@ const suffixGenerator = ({ node, filename }) => {
 ### rules
 
 ```js
+const ignorekeywords = ['views', 'parts']
+const betterNames = {
+  '\/repositories\/': {
+    operator: '-',
+    names: ['repository', 'Repository'],
+  },
+  '\/entities\/': {
+    operator: '+',
+    names: ['entity'],
+  },
+  '\/slices\/': {
+    operator: '=',
+    names: ['index'],
+  },
+}
+
 {
   rules: {
     'smarthr/redundant-name': [
       'error', // 'warn', 'off'
       {
-        type: { ignorekeywords, keywordGenerator, suffixGenerator },
-        file: { ignorekeywords, keywordGenerator },
-        // property: { ignorekeywords, keywordGenerator },
-        // function: { ignorekeywords, keywordGenerator },
-        // variable: { ignorekeywords, keywordGenerator },
-        // class: { ignorekeywords, keywordGenerator },
+        type: { ignorekeywords, suffix: ['Props', 'Type'] },
+        file: { ignorekeywords, betternames },
+        // property: { ignorekeywords },
+        // function: { ignorekeywords },
+        // variable: { ignorekeywords },
+        // class: { ignorekeywords },
       }
     ]
   },

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+	moduleFileExtensions: ['js'],
+	testMatch: ['**/test/**/*.+(js)'],
+	roots: ['<rootDir>/']
+}

package/libs/common_domain.js

@@ -6,7 +6,6 @@ const BASE_SCHEMA_PROPERTIES = {
   globalModuleDir: { type: 'array', items: { type: 'string' } },
   domainModuleDir: { type: 'array', items: { type: 'string' }, default: [] },
   domainConstituteDir: { type: 'array', items: { type: 'string' } },
-  isDomain: { type: 'function' },
 }
 
 const calculateDomainContext = (context) => {
@@ -87,13 +86,14 @@ const calculateDomainNode = (calclatedContext, node) => {
   let filteredDirs = dirs
   let filteredPaths = paths
 
+  const deductedNames = []
   const recursiveDeductionEq = () => {
     if (dirs.length === 0 || paths.length === 0) {
       return
     }
 
     if (dirs[0] === paths[0]) {
-      dirs.shift()
+      deductedNames.push(dirs.shift())
       paths.shift()
       recursiveDeductionEq()
     }
@@ -102,21 +102,22 @@ const calculateDomainNode = (calclatedContext, node) => {
   filteredDirs = dirs
   filteredPaths = paths
 
+  let isDomainConstitute = false
+
   if (option.domainConstituteDir) {
+    const { domainConstituteDir } = option
+    isDomainConstitute =
+      !!deductedNames.find((d) => domainConstituteDir.includes(d)) || // 同一dirを削り、その中にconstitute dir があれば同一ドメイン
+      domainConstituteDir.includes(dirs[0]) && domainConstituteDir.includes(paths[0]) // 同一を削りきった先頭が両方constitute dirならば同一ドメイン
+
     // HINT: 同一ドメイン内（例: workflows/index）で定形で利用されるディレクトリ名を省くことで
     // ドメインの識別に利用される文字を抽出する
     dirs = dirs.filter((k) => !option.domainConstituteDir.includes(k))
     paths = paths.filter((k) => !option.domainConstituteDir.includes(k))
   }
 
-  if (option.isDomain) {
-    // HINT: ドメインの識別に利用される文字を抽出する
-    dirs = dirs.filter((k) => option.isDomain(k))
-    paths = paths.filter((k) => option.isDomain(k))
-  }
-
   const isLowerImport = filteredDirs.length === 0 // 同一階層、もしくは下層からのimport
-  const isDomainImport = dirs.length === 0 // 同一ドメイン内、もしくは同一階層・下層からのimport
+  const isDomainImport = dirs.length === 0 || isDomainConstitute // 同一ドメイン内、もしくは同一階層・下層からのimport
   const isModuleImport = paths.length > 0 && option.domainModuleDir.includes(paths[0]) // ドメイン内共通パーツ
 
   return {

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "eslint-plugin-smarthr",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "author": "SmartHR",
   "license": "MIT",
   "description": "A sharable ESLint plugin for SmartHR",
   "main": "index.js",
   "scripts": {
+    "test": "jest",
     "release:dryrun": "standard-version --dry-run",
     "release": "standard-version"
   },
@@ -21,9 +22,12 @@
     "url": "https://github.com/kufu/eslint-plugin-smarthr/issues"
   },
   "dependencies": {
+    "inflected": "^2.1.0",
     "json5": "^2.2.0"
   },
   "devDependencies": {
+    "eslint": "^8.8.0",
+    "jest": "^27.4.7",
     "standard-version": "^9.3.2"
   },
   "peerDependencies": {

package/rules/jsx-start-with-spread-attributes.js

@@ -1,38 +1,72 @@
+const SCHEMA = [
+  {
+    type: 'object',
+    properties: {
+      fix: { type: 'boolean', default: false },
+    },
+    additionalProperties: false,
+  }
+]
+
 module.exports = {
   meta: {
     type: 'suggestion',
     messages: {
       'jsx-start-with-spread-attributes': '{{ message }}',
     },
-    schema: [],
+    fixable: 'code',
+    schema: SCHEMA,
   },
   create(context) {
     return {
       JSXSpreadAttribute: (node) => {
-        // HINT: 0: 計算中 1: 見つからなかった 2: 見つかった 
-        const hit = node.parent.attributes.reduce((h, a) => {
-          if (h === 0) {
+        // HINT: -2: 計算中 -1: 見つからなかった >= 0: 見つかった 
+        const insertIndex = node.parent.attributes.reduce((h, a, i) => {
+          if (h === -2) {
             if (a === node) {
-              return 1
+              return -1
             }
 
-            return a.type !== 'JSXSpreadAttribute' ? 2 : 0
+            return a.type !== 'JSXSpreadAttribute' ? i : h
           }
 
           return h
-        }, 0)
+        }, -2)
+
+        if (insertIndex >= 0) {
+          const option = context.options[0]
+          const sourceCode = context.getSourceCode()
+          const attributeCode = sourceCode.getText(node)
 
-        if (hit === 2) {
           context.report({
             node,
             messageId: 'jsx-start-with-spread-attributes',
             data: {
-              message: `"${context.getSourceCode().getText(node)}" は他の属性より先に記述してください`,
+              message: `"${attributeCode}" は意図しない上書きを防ぐため、spread attributesでない属性より先に記述してください`,
             },
+            fix: option?.fix ? (fixer) => {
+              const elementNode = node.parent
+              const sortedAttributes = [...elementNode.attributes].reduce((p, a, i) => {
+                if (insertIndex === i) {
+                  p = [attributeCode, ...p]
+                }
+
+                if (a !== node) {
+                  p = [...p, sourceCode.getText(a)]
+                }
+
+                return p
+              }, [])
+
+              return fixer.replaceText(
+                elementNode,
+                `<${elementNode.name.name} ${sortedAttributes.join(' ')}${elementNode.selfClosing ? '/' : ''}>`
+              )
+            } : null
           });
         }
       },
     }
   },
 }
-module.exports.schema = []
+module.exports.schema = SCHEMA

package/rules/prohibit-import.js

@@ -1,15 +1,36 @@
-const SCHEMA = [
-  {
-    type: 'object',
-    properties: {
-      targets: { type: 'object', default: {} },
-      generateReportMessage: { type: 'function' },
+const path = require('path')
+
+const SCHEMA = [{
+  type: 'object',
+  patternProperties: {
+    '.+': {
+      type: 'object',
+      patternProperties: {
+        '.+': {
+          type: 'object',
+          required: [
+            'imported',
+          ],
+          properties: {
+            imported: {
+              type: ['boolean', 'array'],
+              items: {
+                type: 'string',
+              },
+            },
+            reportMessage: {
+              type: 'string',
+            },
+          },
+          additionalProperties: false
+        }
+      }
     },
-    additionalProperties: false,
-  }
-]
+  },
+  additionalProperties: true,
+}]
 
-const generateDefaultReportMessage = (source, imported) => `${source}${imported && `/${imported}`} は利用しないでください`
+const defaultReportMessage = (moduleName, exportName) => `${moduleName}${typeof exportName == 'string' ? `/${exportName}`: ''} は利用しないでください`
 
 module.exports = {
   meta: {
@@ -20,38 +41,64 @@ module.exports = {
     schema: SCHEMA,
   },
   create(context) {
-    const option = context.options[0]
-    const parsedOption = Object.entries(option.targets)
-    const generateReportMessage = option.generateReportMessage || generateDefaultReportMessage
+    const options = context.options[0]
+    const filename = context.getFilename()
+    const parentDir = (() => {
+      const dir = filename.match(/^(.+?)\..+?$/)[1].split('/')
+      dir.pop()
+
+      return dir.join('/')
+    })()
+    const targetPathRegexs = Object.keys(options)
+    const targetProhibits = targetPathRegexs.filter((regex) => !!filename.match(new RegExp(regex)))
+
+    if (targetProhibits.length === 0) {
+      return {}
+    }
 
     return {
       ImportDeclaration: (node) => {
-        parsedOption.forEach(([matchText, importNames]) => {
-          if (!node.source.value.match(new RegExp(matchText))) {
-            return
-          }
-
-          const imported = (() => {
-            if (!Array.isArray(importNames)) {
-              return !!importNames
+        targetProhibits.forEach((prohibitKey) => {
+          const option = options[prohibitKey]
+          const targetModules = Object.keys(option)
+
+          targetModules.forEach((targetModule) => {
+            const { imported, reportMessage } = Object.assign({imported: true}, option[targetModule])
+            const actualTarget = targetModule[0] !== '.' ? targetModule : path.resolve(`${process.cwd()}/${targetModule}`)
+            let sourceValue = node.source.value
+
+            if (actualTarget[0] === '/') {
+              sourceValue = path.resolve(`${parentDir}/${sourceValue}`)
+            }
+
+            if (actualTarget !== sourceValue) {
+              return
             }
-            const specifier = node.specifiers.find((s) => importNames.includes(s.imported.name))
+            
+            const useImported = (() => {
+              if (!Array.isArray(imported)) {
+                return !!imported
+              }
 
-            return specifier ? specifier.imported.name : false
-          })()
+              const specifier = node.specifiers.find((s) => s.imported && imported.includes(s.imported.name))
 
-          if (imported) {
-            context.report({
-              node,
-              messageId: 'prohibit_import',
-              data: {
-                message: generateReportMessage(node.source.value, imported === true ? '' : imported),
-              },
-            });
-          }
+              return specifier ? specifier.imported.name : false
+            })()
+
+            if (useImported) {
+              context.report({
+                node,
+                messageId: 'prohibit_import',
+                data: {
+                  message: reportMessage ? reportMessage.replace('{{module}}', node.source.value).replace('{{export}}', useImported) : defaultReportMessage(node.source.value, useImported)
+                },
+              });
+            }
+          })
         })
       },
     }
   },
 }
+
 module.exports.schema = SCHEMA