eslint-plugin-smarthr 0.2.4 → 0.2.5

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.2.5](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.2.4...v0.2.5) (2022-09-08)
+
+
+### Bug Fixes
+
+* require-import, prohibit-import: report message の一部でテンプレート文字列がそのまま出力されてしまう事があるバグを修正 ([#29](https://github.com/kufu/eslint-plugin-smarthr/issues/29)) ([b805f90](https://github.com/kufu/eslint-plugin-smarthr/commit/b805f90cd39b1aa4b95cbfbd983c5ff1c61f8afe))
+* 画像系コンポーネントが代替テキスト属性を持つかチェックする際にエラーになるパターンを修正 ([#30](https://github.com/kufu/eslint-plugin-smarthr/issues/30)) ([bcd1044](https://github.com/kufu/eslint-plugin-smarthr/commit/bcd1044d7532531015a279520ed8eda582227492))
+
 ### [0.2.4](https://github.com/kufu/eslint-plugin-smarthr/compare/v0.2.3...v0.2.4) (2022-08-30)
 
 

package/package.json

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

package/rules/a11y-clickable-element-has-text/index.js

@@ -36,17 +36,34 @@ module.exports = {
           return
         }
 
-        const recursiveSearch = (c) => (
-          ['JSXText', 'JSXExpressionContainer'].includes(c.type) ||
-          (
-            c.type === 'JSXElement' && (
-              // HINT: SmartHRLogo コンポーネントは内部でaltを持っているため対象外にする
-              c.openingElement.name.name.match(/SmartHRLogo$/) ||
-              c.openingElement.attributes.some((a) => (['visuallyHiddenText', 'alt'].includes(a.name.name) && !!a.value.value)) ||
-              (c.children && filterFalsyJSXText(c.children).some(recursiveSearch))
-            )
-          )
-        ) 
+        const recursiveSearch = (c) => {
+          if (['JSXText', 'JSXExpressionContainer'].includes(c.type)) {
+            return true
+          }
+
+          if (c.type === 'JSXElement') {
+            // // HINT: SmartHRLogo コンポーネントは内部でaltを持っているため対象外にする
+            if (c.openingElement.name.name.match(/SmartHRLogo$/)) {
+              return true
+            }
+            
+            if (c.openingElement.attributes.some((a) =>  {
+              if (!['visuallyHiddenText', 'alt'].includes(a.name.name)) {
+                return false
+              }
+
+              return (!!a.value.value || a.value.type === 'JSXExpressionContainer')
+            })) {
+              return true
+            }
+
+            if (c.children && filterFalsyJSXText(c.children).some(recursiveSearch)) {
+              return true
+            }
+          }
+
+          return false
+        }
 
         const child = filterFalsyJSXText(parentNode.children).find(recursiveSearch)
 

package/rules/a11y-image-has-alt-attribute/index.js

@@ -21,7 +21,7 @@ module.exports = {
       ...generateTagFormatter({ context, EXPECTED_NAMES }),
       JSXOpeningElement: (node) => {
         if ((node.name.name || '').match(/(img|image)$/i)) { // HINT: Iconは別途テキストが存在する場合が多いためチェックの対象外とする
-          const alt = node.attributes.find((a) => a.name.name === 'alt')
+          const alt = node.attributes.find((a) => a.name?.name === 'alt')
 
           let message = ''
 

package/rules/format-import-path/README.md

@@ -7,7 +7,7 @@
 
 ## config
 
-- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- tsconfig.json の compilerOptions.pathsに '@/*', もしくは '~/*' としてroot path を指定する必要があります
 - ドメインを識別するために以下の設定を記述する必要があります
   - globalModuleDir
     - 全体で利用するファイルを収めているディレクトリを相対パスで指定します

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

@@ -6,7 +6,7 @@
 
 ## config
 
-- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- tsconfig.json の compilerOptions.pathsに '@/*', もしくは '~/*' としてroot path を指定する必要があります
 - ドメインを識別するために以下の設定を記述する必要があります
   - globalModuleDir
     - 全体で利用するファイルを収めているディレクトリを相対パスで指定します

package/rules/prohibit-import/index.js

@@ -90,7 +90,7 @@ module.exports = {
                 node,
                 messageId: 'prohibit_import',
                 data: {
-                  message: reportMessage ? reportMessage.replace('{{module}}', node.source.value).replace('{{export}}', useImported) : defaultReportMessage(node.source.value, useImported)
+                  message: reportMessage ? reportMessage.replaceAll('{{module}}', node.source.value).replaceAll('{{export}}', useImported) : defaultReportMessage(node.source.value, useImported)
                 },
               });
             }

package/rules/redundant-name/README.md

@@ -5,7 +5,7 @@
 
 ## config
 
-- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- tsconfig.json の compilerOptions.pathsに '@/*', もしくは '~/*' としてroot path を指定する必要があります
 - 以下の設定を行えます。全て省略可能です。
   - ignoreKeywords
     - ディレクトリ名から生成されるキーワードに含めたくない文字列を指定します

package/rules/redundant-name/index.js

@@ -406,7 +406,7 @@ module.exports = {
   },
   create(context) {
     if (!rootPath) {
-      throw new Error('tsconfig.json の compilerOptions.paths に `"@/*": ["any_path/*"]` 形式でフロントエンドのroot dir を指定してください')
+      throw new Error('tsconfig.json の compilerOptions.paths に `@/*`、もしくは `~/*` 形式でフロントエンドのroot dir を指定してください(例: `"@/*": ["./any_path/*"]`)')
     }
 
     let rules = {}

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

@@ -1,6 +1,6 @@
 # smarthr/require-barrel-import
 
-- tsconfig.json の compilerOptions.pathsに '@/*' としてroot path を指定する必要があります
+- tsconfig.json の compilerOptions.pathsに '@/*', もしくは '~/*' としてroot path を指定する必要があります
 - importした対象が本来exportされているべきであるbarrel(index.tsなど)が有る場合、import pathの変更を促します
   - 例: Page/parts/Menu/Item の import は Page/parts/Menu から行わせたい
 - ディレクトリ内のindexファイルを捜査し、対象を決定します

package/rules/require-import/index.js

@@ -83,7 +83,7 @@ module.exports = {
                 node,
                 messageId: 'require_import',
                 data: {
-                  message: reportMessage ? reportMessage.replace('{{module}}', actualTarget).replace('{{export}}', item) : defaultReportMessage(actualTarget, item)
+                  message: reportMessage ? reportMessage.replaceAll('{{module}}', actualTarget).replaceAll('{{export}}', item) : defaultReportMessage(actualTarget, item)
                 },
               })
             }