eslint-plugin-smarthr 0.1.2 → 0.2.1

package/rules/no-import-other-domain/README.md

@@ -0,0 +1,85 @@
+# smarthr/no-import-other-domain
+
+- ドメイン外からのimportを防ぐruleです
+  - 例: crews/index 以下からのimportはOK, crews/index から crews/show 以下をimportするとNG
+- ディレクトリ構造からドメインを識別して判定することが出来ます
+
+## config
+
+- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- ドメインを識別するために以下の設定を記述する必要があります
+  - globalModuleDir
+    - 全体で利用するファイルを収めているディレクトリを相対パスで指定します
+  - domainModuleDir:
+    - ドメイン内で共通のファイルを収めているディレクトリ名を指定します
+  - domainConstituteDir
+    - ドメインを構築するディレクトリ名を指定します
+
+### ディレクトリ例
+```
+/ constants
+/ modules  // 全体共通ディレクトリ
+/ crews
+  / modules // 共通ディレクトリ
+    / views
+      / parts
+  / index
+    / adapters
+      / index.ts
+      / hoge.ts
+    / slices
+      / index.ts
+    / views
+      / index.ts
+      / parts
+        / Abc.ts
+  / show
+    / views
+      / parts
+```
+
+### 指定例
+```
+const DOMAIN_RULE_ARGS = {
+  globalModuleDir: [ './constants', './modules' ],
+  domainModuleDir: [ 'modules' ],
+  domainConstituteDir: [ 'adapters', 'slices', 'views', 'parts' ],
+}
+```
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/no-import-other-domain': [
+      'error', // 'warn', 'off'
+      {
+        ...DOMAIN_RULE_ARGS,
+        // analyticsMode: 'all', // 'same-domain', 'another-domain'
+      }
+    ]
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+// crews/index/views/index.js
+
+import showPart1 from '@/crews/show/views/parts'
+import showPart2 from '../../show/views/parts'
+```
+
+## ✅ Correct
+
+```js
+// crews/index/views/index.js
+
+import slice from '../slice'
+import hoge from '../adapter/hoge'
+import Abc from './parts/Abc'
+import modulePart from '../../modules/views/parts'
+import globalModulePart from '@/modules/views/parts'
+```

package/rules/{no-import-other-domain.js → no-import-other-domain/index.js}

@@ -1,7 +1,7 @@
 const path = require('path')
 const fs = require('fs')
-const { replacePaths, rootPath } = require('../libs/common')
-const { BASE_SCHEMA_PROPERTIES, calculateDomainContext, calculateDomainNode } = require('../libs/common_domain')
+const { replacePaths, rootPath } = require('../../libs/common')
+const { BASE_SCHEMA_PROPERTIES, calculateDomainContext, calculateDomainNode } = require('../../libs/common_domain')
 
 const SCHEMA = [
   {

package/rules/prohibit-export-array-type/README.md

@@ -0,0 +1,28 @@
+# smarthr/prohibit-export-array-type
+
+- 配列の型をexport出来ないように制御するルールです
+- 利用するファイルで `ItemProps[]` のように配列指定を強制する目的などで利用できます
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/prohibit-export-array-type': 'error', // 'warn', 'off'
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+type Item = { attr: string }
+export type Items = Item[]
+```
+
+## ✅ Correct
+
+
+```js
+export type Item = { attr: string }
+```

package/rules/prohibit-export-array-type/index.js

@@ -0,0 +1,28 @@
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    messages: {
+      'prohibit-export-array-type': '{{ message }}',
+    },
+    schema: [],
+  },
+  create(context) {
+    const checker = (node) => {
+      if (node.declaration?.typeAnnotation?.type === 'TSArrayType') {
+        context.report({
+          node,
+          messageId: 'prohibit-export-array-type',
+          data: {
+            message: '利用する際、配列かどうかわかりにくいため、配列ではない状態でexportしてください',
+          },
+        })
+      }
+    }
+
+    return {
+      ExportDefaultDeclaration: checker,
+      ExportNamedDeclaration: checker,
+    }
+  },
+}
+module.exports.schema = []

package/rules/prohibit-file-name/README.md

@@ -0,0 +1,35 @@
+# smarthr/prohibit-file-name
+
+- 正規表現に合致するファイル、ディレクトリの作成を阻害するルールです
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/prohibit-file-name': [
+      'error', // 'warn', 'off'
+      {
+        '\/(actions|reducers)\/$': 'slicesディレクトリ内でcreateSliceを利用してください',
+        '\/views\/(page|template)\.(ts(x)?)$': 'index.$2、もしくはTemplate.$2にリネームしてください',
+        '\/modules\/(adapters|entities|repositories|slices)\/index\.ts(x)?$': '利用目的が推測出来ない為、リネームしてください(例: new, edit用ならform.tsなど)',
+      },
+    ]
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+// src/pages/actions/index.ts
+// src/modules/entities/index.ts
+```
+
+## ✅ Correct
+
+
+```js
+// src/pages/slices/index.ts
+// src/modules/entities/item.ts
+```

package/rules/prohibit-file-name/index.js

@@ -0,0 +1,61 @@
+const SCHEMA = [{
+  type: 'object',
+  patternProperties: {
+    '.+': {
+      type: 'string',
+    },
+  },
+  additionalProperties: true,
+}]
+
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    messages: {
+      'prohibit-file-name': '{{ message }}',
+    },
+    schema: SCHEMA,
+  },
+  create(context) {
+    const options = context.options[0]
+    const filename = context.getFilename()
+    const targetPaths = Object.keys(options).filter((regex) => !!filename.match(new RegExp(regex)))
+
+
+    if (targetPaths.length === 0) {
+      return {}
+    }
+
+    const messages = []
+
+    targetPaths.forEach((path) => {
+      const message = options[path]
+
+      matcher = filename.match(new RegExp(path))
+
+      if (matcher) {
+        messages.push([...matcher].reduce(((prev, k, index) => prev.replaceAll(`\$${index}`, k)), message))
+      }
+    })
+
+    if (messages.length === 0) {
+      return {}
+    }
+
+    return {
+      Program: (node) => {
+        messages.forEach((message) => {
+          context.report({
+            node,
+            messageId: 'prohibit-file-name',
+            data: {
+              message,
+            },
+          })
+        })
+      },
+    }
+  },
+}
+module.exports.schema = SCHEMA

package/rules/prohibit-import/README.md

@@ -0,0 +1,44 @@
+# smarthr/prohibit-import
+
+- 例えば特定の module にバグが発見されたなど、importさせたくない場合に利用するルールです
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/prohibit-import': [
+      'error', // 'warn', 'off'
+      {
+        '^.+$': {
+          'smarthr-ui': {
+            imported: ['SecondaryButtonAnchor'],
+            reportMessage: `{{module}}/{{export}} はXxxxxxなので利用せず yyyy/zzzz を利用してください`
+          }, 
+        }
+        '\/pages\/views\/': {
+          'query-string': {
+            imported: true,
+          },
+        },
+      }
+    ]
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+// src/pages/views/Page.tsx
+import queryString from 'query-string'
+import { SecondaryButtonAnchor } from 'smarthr-ui'
+```
+
+## ✅ Correct
+
+
+```js
+// src/pages/views/Page.tsx
+import { PrimaryButton, SecondaryButton } from 'smarthr-ui'
+```

package/rules/redundant-name/README.md

@@ -0,0 +1,94 @@
+# smarthr/redundant-name
+
+- ファイル、コードの冗長な部分を取り除くことを提案するruleです
+- ファイルが設置されているディレクトリ構造からキーワードを生成し、取り除く文字列を生成します
+
+## config
+
+- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- 以下の設定を行えます。全て省略可能です。
+  - ignoreKeywords
+    - ディレクトリ名から生成されるキーワードに含めたくない文字列を指定します
+  - betterNames
+    - 対象の名前を修正する候補を指定します
+  - allowedNames
+    - 許可する名前を指定します
+  - suffix:
+    - type のみ指定出来ます
+    - type のsuffixを指定します
+
+### ファイル例
+- `@/crews/index/views/page.tsx` の場合
+  - 生成されるキーワードは `['crews', 'crew', 'index', 'page']`
+- `@/crews/index/views/parts/Abc.tsx` の場合
+  - 生成されるキーワードは `['crews', 'crew', 'index', 'Abc']`
+- `@/crews/index/repositories/index.ts` の場合
+  - 生成されるキーワードは `['crews', 'crew', 'index', 'repositories', 'repository']`
+
+
+## rules
+
+```js
+const ignorekeywords = ['views', 'parts']
+const betterNames = {
+  '\/repositories\/': {
+    operator: '-',
+    names: ['repository', 'Repository'],
+  },
+  '\/entities\/': {
+    operator: '+',
+    names: ['entity'],
+  },
+  '\/slices\/': {
+    operator: '=',
+    names: ['index'],
+  },
+}
+// const allowedNames = {
+//   '\/views\/crews\/histories\/': ['crewId'],
+// }
+
+{
+  rules: {
+    'smarthr/redundant-name': [
+      'error', // 'warn', 'off'
+      {
+        type: { ignorekeywords, suffix: ['Props', 'Type'] },
+        file: { ignorekeywords, betternames },
+        // property: { ignorekeywords, allowedNames },
+        // function: { ignorekeywords },
+        // variable: { ignorekeywords },
+        // class: { ignorekeywords },
+      }
+    ]
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+// @/crews/index/views/page.tsx
+
+type CrewIndexPage = { hoge: string }
+type CrewsView = { hoge: string }
+```
+```js
+// @/crews/show/repositories/index.tsx
+
+type CrewIndexRepository = { hoge: () => any }
+```
+
+## ✅ Correct
+
+```js
+// @/crews/index/views/page.tsx
+
+type ItemProps = { hoge: string }
+```
+```js
+// @/crews/show/repositories/index.tsx
+
+type IndexProps = { hoge: () => any }
+type ResponseType = { hoge: () => any }
+```

package/rules/{redundant-name.js → redundant-name/index.js}

@@ -1,7 +1,7 @@
 const path = require('path')
 const Inflector = require('inflected')
 
-const { rootPath } = require('../libs/common')
+const { rootPath } = require('../../libs/common')
 
 const uniq = (array) => array.filter((elem, index, self) => self.indexOf(elem) === index)
 
@@ -48,6 +48,10 @@ const DEFAULT_SCHEMA_PROPERTY = {
       },
     },
   },
+  allowedNames: {
+    type: 'array',
+    items: 'string',
+  },
 }
 
 const SCHEMA = [
@@ -91,9 +95,11 @@ const generateRedundantKeywords = ({ args, key, terminalImportName }) => {
       return prev
     }
 
-    const singularized = Inflector.singularize(keyword)
-
-    return singularized === keyword ? [...prev, keyword] : [...prev, keyword, singularized]
+    return [...prev, ...uniq([
+      Inflector.pluralize(keyword),
+      keyword,
+      Inflector.singularize(keyword),
+    ])]
   }, [])
 }
 const handleReportBetterName = ({
@@ -113,7 +119,11 @@ const handleReportBetterName = ({
   return (node) => {
     const name = fetchName(node)
 
-    if (!name) {
+    if (
+      !name ||
+      option.allowedNames &&
+      Object.entries(option.allowedNames).find(([regex, calcs]) => filename.match(new RegExp(regex)) && calcs.find((c) => c === name))
+    ) {
       return
     }
 

package/rules/require-barrel-import/README.md

@@ -0,0 +1,39 @@
+# 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'
+```

package/rules/{require-barrel-import.js → require-barrel-import/index.js}

@@ -1,6 +1,6 @@
 const path = require('path')
 const fs = require('fs')
-const { replacePaths, rootPath } = require('../libs/common')
+const { replacePaths, rootPath } = require('../../libs/common')
 const calculateAbsoluteImportPath = (source) => {
   if (source[0] === '/') {
     return source

package/rules/require-export/README.md

@@ -0,0 +1,43 @@
+# smarthr/require-export
+
+- 対象ファイルにexportを強制させたい場合に利用します
+  - 例: Page.tsx ではページタイトルを設定させたいので useTitle を必ずexportさせたい
+
+## rules
+
+```js
+{
+  rules: {
+    'smarthr/require-export': [
+      'error',
+      {
+        'adapter\/.+\.ts': ['Props', 'generator'],
+        // slice以下のファイルかつmodulesディレクトリに属さずファイル名にmockを含まないもの
+        '^(?=.*\/slices\/[a-zA-Z0-9]+\.ts)(?!.*(\/modules\/|mock\.)).*$': [ 'default' ],
+      },
+    ]
+  },
+}
+```
+
+## ❌ Incorrect
+
+```js
+// adapter/index.ts
+export type Type = { abc: string }
+
+// slice/index.ts
+export const slice = { method: () => 'any action' }
+```
+
+## ✅ Correct
+
+
+```js
+// adapter/index.ts
+export type Props = { abc: string }
+
+// slice/index.ts
+const slice = { method: () => 'any action' }
+export default slice
+```

package/rules/require-export/index.js

@@ -0,0 +1,90 @@
+const SCHEMA = [{
+  type: 'object',
+  patternProperties: {
+    '.+': {
+      type: 'array',
+      items: { type: 'string' },
+      additionalProperties: true,
+    },
+  },
+  additionalProperties: true,
+}]
+
+const fetchEdgeDeclaration = (node) => {
+  const { declaration } = node
+
+  if (!declaration) {
+    return node
+  }
+
+  return fetchEdgeDeclaration(declaration)
+}
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    messages: {
+      'require-export': '{{ message }}',
+    },
+    schema: SCHEMA,
+  },
+  create(context) {
+    const options = context.options[0]
+    const filename = context.getFilename()
+    const targetPathRegexs = Object.keys(options)
+    const targetRequires = targetPathRegexs.filter((regex) => !!filename.match(new RegExp(regex)))
+
+    if (targetRequires.length === 0) {
+      return {}
+    }
+
+    return {
+      Program: (node) => {
+        targetRequires.forEach((requireKey) => {
+          const option = options[requireKey]
+          let existDefault = false
+          const exports =
+            node.body
+              .filter((i) => {
+                if (i.type == 'ExportDefaultDeclaration') {
+                  existDefault = true
+
+                  return false
+                }
+
+                return i.type == 'ExportNamedDeclaration'
+              })
+              .map((i) => {
+                const declaration = fetchEdgeDeclaration(i)
+
+                if (declaration.id) {
+                  return declaration.id.name
+                }
+                if (declaration.specifiers) {
+                  return declaration.specifiers.map((s) => s.exported.name)
+                }
+                if (declaration.declarations) {
+                  return declaration.declarations.map((d) => d.id.name || d.id.properties.map((p) => p.key.name))
+                }
+
+                return declaration
+              })
+              .flat(2)
+
+          let notExistsExports = [...(!existDefault && option.includes('default') ? ['default'] : []), ...option.filter((o) => o !== 'default' && !exports.includes(o))]
+
+          if (notExistsExports.length) {
+            context.report({
+              node,
+              messageId: 'require-export',
+              data: {
+                message: `${notExistsExports.join(', ')} をexportしてください`,
+              },
+            })
+          }
+        })
+      },
+    }
+  },
+}
+module.exports.schema = SCHEMA

package/rules/require-import/README.md

@@ -0,0 +1,51 @@
+# 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'
+```