eslint-plugin-smarthr 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -2,28 +2,17 @@
 
 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.1.0](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.0.1...v0.1.0) (2022-02-09)
-
-
-### ⚠ BREAKING CHANGES
-
-* update prohibit-imoprt option
+### [0.1.1](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.1.0...v0.1.1) (2022-03-08)
 
-* chore: require-importの対象ファイル指定方法をoptionの第一階層のkeyにする
 
-* chore: update README.md
-
-* chore: require-importのdefaultReportMessageを修正
-
-* chore: update yarn.lock
+### Features
 
-* chore: fix test
+* 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))
 
-* chore: add test
+## [0.1.0](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.0.1...v0.1.0) (2022-02-09)
 
-* chore: refactoring prohibit-import
 
-* chore: add test
+### ⚠ 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)
 

package/README.md

@@ -359,6 +359,46 @@ import { SecondaryButton } from 'smarthr-ui'
 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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-smarthr",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "author": "SmartHR",
   "license": "MIT",
   "description": "A sharable ESLint plugin for SmartHR",

package/rules/require-barrel-import.js

@@ -0,0 +1,125 @@
+const path = require('path')
+const fs = require('fs')
+const { replacePaths, rootPath } = require('../libs/common')
+const calculateAbsoluteImportPath = (source) => {
+  if (source[0] === '/') {
+    return source
+  }
+
+  return Object.entries(replacePaths).reduce((prev, [key, values]) => {
+    if (source === prev) {
+      return values.reduce((p, v) => {
+        if (prev === p) {
+          const regexp = new RegExp(`^${key}(.+)$`)
+
+          if (prev.match(regexp)) {
+            return p.replace(regexp, `${path.resolve(`${process.cwd()}/${v}`)}/$1`)
+          }
+        }
+
+        return p
+      }, prev)
+    }
+
+    return prev
+  }, source)
+}
+const calculateReplacedImportPath = (source) => {
+  return Object.entries(replacePaths).reduce((prev, [key, values]) => {
+    if (source === prev) {
+      return values.reduce((p, v) => {
+        if (prev === p) {
+          const regexp = new RegExp(`^${path.resolve(`${process.cwd()}/${v}`)}(.+)$`)
+
+          if (prev.match(regexp)) {
+            return p.replace(regexp, `${key}/$1`).replace(/(\/)+/g, '/')
+          }
+        }
+
+        return p
+      }, prev)
+    }
+
+    return prev
+  }, source)
+}
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    messages: {
+      'require-barrel-import': '{{ message }}',
+    },
+    schema: [],
+  },
+  create(context) {
+    const filename = context.getFilename()
+
+    // HINT: indexファイルがある == barrelであるとする
+    if (filename.match(/\/index\.(js|ts)x?$/)) {
+      return {}
+    }
+
+    const dir = (() => {
+      const d = filename.split('/')
+      d.pop()
+
+      return d.join('/')
+    })()
+
+    return {
+      ImportDeclaration: (node) => {
+        let sourceValue = node.source.value
+
+        if (sourceValue[0] === '.') {
+          sourceValue = path.resolve(`${dir}/${sourceValue}`)
+        }
+
+        sourceValue = calculateAbsoluteImportPath(sourceValue)
+
+        if (sourceValue[0] !== '/') {
+          return
+        }
+
+        const sources = sourceValue.split('/')
+        let joinedSources = sourceValue
+        let ext = undefined
+
+        while (sources.length > 0) {
+          // HINT: 以下の場合は即終了
+          // - import元以下のimportだった場合
+          // - rootまで捜索した場合
+          if (dir === joinedSources || dir === rootPath) {
+            return
+          }
+
+          ext = ['ts', 'tsx', 'js', 'jsx'].find((e) => fs.existsSync(`${sources.join('/')}/index.${e}`))
+
+          if (ext) {
+            break
+          }
+
+          sources.pop()
+          joinedSources = sources.join('/')
+        }
+
+        if (
+          joinedSources &&
+          sourceValue !== joinedSources &&
+          !dir.match(new RegExp(`^${joinedSources}/`))
+        ) {
+          const replacedSources = calculateReplacedImportPath(joinedSources)
+
+          context.report({
+            node,
+            messageId: 'require-barrel-import',
+            data: {
+              message: `${replacedSources}からimportするか、${replacedSources}/index.${ext}を削除してください`,
+            },
+          });
+        }
+      },
+    }
+  },
+}
+module.exports.schema = []