@yoshinani/style-guide 0.0.3 → 0.0.5

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 YOSHINANI, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/eslint/base.js

@@ -11,18 +11,28 @@ module.exports = {
       },
     },
   },
-  plugins: ["@typescript-eslint", "eslint-plugin-import"],
+  plugins: ["@typescript-eslint", "eslint-plugin-import", "eslint-comments", "functional"],
   rules: {
+    // [比較演算子禁止](https://www.notion.so/yoshinani-note/1dff5577f5838145acfcca9176913b79)
     eqeqeq: ["error", "always", { null: "ignore" }],
+    // [any禁止](https://www.notion.so/yoshinani-note/any-1dff5577f5838174907ae6b2cfaf72ea)
+    "@typescript-eslint/no-explicit-any": "error",
+    // [混乱を招くvoidの使用禁止](https://www.notion.so/yoshinani-note/void-1dff5577f5838144bf0dc90e4bdffcb3)
     "@typescript-eslint/no-confusing-void-expression": [
       "error",
       { ignoreArrowShorthand: true },
     ],
+    // [awaitつけ忘れ防止](https://www.notion.so/yoshinani-note/await-1dff5577f58381e5ab40f29d8d3f0be4)
+    "@typescript-eslint/no-floating-promises": "error",
     "@typescript-eslint/no-shadow": "off",
+    // [誤ったpromiseの使用禁止](https://www.notion.so/yoshinani-note/promise-1dff5577f58381ae86c0d8c5b83f052a)
     "@typescript-eslint/no-misused-promises": [
       "error",
       { checksVoidReturn: { attributes: false } },
     ],
+    // [不要なオプショナルチェーン禁止](https://www.notion.so/yoshinani-note/1dff5577f583816e8b5eec9963add23d)
+    "@typescript-eslint/no-unnecessary-condition": "error",
+    // [nullなどをそのまま文字列にするのを禁止](https://www.notion.so/yoshinani-note/null-1dff5577f5838104b3b9db6eee64f106)
     "@typescript-eslint/restrict-template-expressions": [
       "error",
       {
@@ -33,6 +43,9 @@ module.exports = {
         allowNever: false,
       },
     ],
+    // [ルール無効化の際に理由を添える](https://www.notion.so/yoshinani-note/1dff5577f583818b913fec991d5e8b46)
+    "eslint-comments/require-description": ["error", {"ignore": []}],
+    "functional/immutable-data": "error",
     // sort import statements
     "import/order": [
       "warn",
@@ -53,6 +66,7 @@ module.exports = {
     "sort-imports": ["warn", { ignoreDeclarationSort: true }],
     "no-restricted-syntax": [
       "error",
+      // [enum禁止](https://www.notion.so/yoshinani-note/enum-1dff5577f58381a2b809d81ddc486701)
       {
         selector: "TSEnumDeclaration",
         message:
@@ -77,7 +91,9 @@ module.exports = {
           "`with` is disallowed in strict mode because it makes code impossible to predict and optimize.",
       },
     ],
+    // [process.envの乱用禁止](https://www.notion.so/yoshinani-note/process-env-1dff5577f58381f4ba04f06cac13d334)
     "no-process-env": "error",
+    // [インポートを制限](https://www.notion.so/yoshinani-note/1dff5577f58381a7bd81ef0805696e2b)
     "no-restricted-imports": [
       "warn",
       {

package/package.json

@@ -1,7 +1,15 @@
 {
 	"name": "@yoshinani/style-guide",
-	"version": "0.0.3",
+	"version": "0.0.5",
 	"description": "Yoshinani's Style Guide",
+	"homepage": "https://github.com/yoshinani-dev/style-guide#readme",
+	"bugs": {
+		"url": "https://github.com/yoshinani-dev/style-guide/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/yoshinani-dev/style-guide.git"
+	},
 	"exports": {
 		"./typescript": "./typescript/base.json",
 		"./typescript/nextjs": "./typescript/nextjs.json",
@@ -17,6 +25,8 @@
 		"@typescript-eslint/parser": "^8.18.2",
 		"@vercel/style-guide": "^6.0.0",
 		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-eslint-comments": "^3.2.0",
+		"eslint-plugin-functional": "6.6.3",
 		"eslint-plugin-import": "^2.31.0",
 		"eslint-plugin-only-warn": "^1.1.0",
 		"eslint-plugin-tailwindcss": "^3.17.5"