@yoshinani/style-guide 0.0.2 → 0.0.4

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/README.md

@@ -51,92 +51,27 @@ yarn add --dev @yoshinani/style-guide
 >
 > 参考: https://eslint.org/docs/user-guide/getting-started#installation-and-usage
 
-この ESLint 設定は合成可能（composable）です。
+利用できる設定は以下の通りです。
 
-以下のベース設定が利用可能です。これらの設定は `extends` の最初に記載してください（どちらか一方または両方を使用可能）。
-
-- `@yoshinani/style-guide/eslint/browser`
-- `@yoshinani/style-guide/eslint/node`
-
-設定をスコープして、特定のファイルのみに適用することもできます。詳細は [Scoped configuration with `overrides`](#scoped-configuration-with-overrides) を参照してください。
-
-追加で利用できる設定は以下の通りです。
-
-- `@yoshinani/style-guide/eslint/jest`
-- `@yoshinani/style-guide/eslint/jest-react`（`@testing-library/react` のルールを含む）
-- `@yoshinani/style-guide/eslint/next`（`@next/eslint-plugin-next` を `next` と同じバージョンでインストールする必要あり）
-- `@yoshinani/style-guide/eslint/playwright-test`
-- `@yoshinani/style-guide/eslint/react`
-- `@yoshinani/style-guide/eslint/typescript`（`typescript` のインストールと[追加設定](#configuring-eslint-for-typescript)が必要）
-- `@yoshinani/style-guide/eslint/vitest`
+- `@yoshinani/style-guide/eslint/base`
+- `@yoshinani/style-guide/eslint/next`
+- `@yoshinani/style-guide/eslint/library`
+- `@yoshinani/style-guide/eslint/react-internal`
 
 > ESLint の設定解決の問題（[eslint/eslint#9188](https://github.com/eslint/eslint/issues/9188)）のため、`require.resolve` を使って絶対パスを指定してください。
 
 例として、Next.js プロジェクトで共有 ESLint 設定を使う場合、`.eslintrc.js` に以下のように記載します。
 
 ```js
-module.exports = {
-  extends: [
-    require.resolve('@yoshinani/style-guide/eslint/browser'),
-    require.resolve('@yoshinani/style-guide/eslint/react'),
-    require.resolve('@yoshinani/style-guide/eslint/next'),
-  ],
-};
-```
-
-### TypeScript 用 ESLint 設定
-
-TypeScript 設定で有効になっている一部のルールは追加の型情報が必要です。`tsconfig.json` へのパスを指定してください。
-
-詳細は https://typescript-eslint.io/docs/linting/type-linting を参照してください。
-
-```js
-const { resolve } = require('node:path');
-
-const project = resolve(__dirname, 'tsconfig.json');
-
+/** @type {import("eslint").Linter.Config} */
 module.exports = {
   root: true,
-  extends: [
-    require.resolve('@yoshinani/style-guide/eslint/node'),
-    require.resolve('@yoshinani/style-guide/eslint/typescript'),
-  ],
+  extends: [require.resolve("@yoshinani/style-guide/eslint/next")],
+  parser: "@typescript-eslint/parser",
   parserOptions: {
-    project,
+    project: true,
   },
-  settings: {
-    'import/resolver': {
-      typescript: {
-        project,
-      },
-    },
-  },
-};
-```
-
-### `jsx-a11y` のカスタムコンポーネント設定
-
-React アプリでは、`Button` などの共通コンポーネントでネイティブ要素をラップすることが一般的です。`jsx-a11y` の `components` 設定でこの情報を渡せます。
-
-以下は一例です。
-
-```js
-module.exports = {
-  root: true,
-  extends: [require.resolve('@yoshinani/style-guide/eslint/react')],
-  settings: {
-    'jsx-a11y': {
-      components: {
-        Article: 'article',
-        Button: 'button',
-        Image: 'img',
-        Input: 'input',
-        Link: 'a',
-        Video: 'video',
-      },
-    },
-  },
-};
+}
 ```
 
 ### `overrides` を使ったスコープ設定
@@ -157,20 +92,6 @@ module.exports = {
 };
 ```
 
-#### ファイル拡張子について
-
-デフォルトでは、すべての TypeScript ルールは `.ts` および `.tsx` ファイルにスコープされています。
-
-ただし、`overrides` を使う場合はファイル拡張子を明示的に含める必要があります。そうしないと ESLint は `.js` ファイルのみを対象にします。
-
-```js
-module.exports = {
-  overrides: [
-    { files: [`directory/**/*.[jt]s?(x)`], rules: { 'my-rule': 'off' } },
-  ],
-};
-```
-
 ## TypeScript
 
 このスタイルガイドは複数の TypeScript 設定を提供しています。これらの設定は LTS の Node.js バージョンに対応しており、それぞれに適した `lib`、`module`、`target`、`moduleResolution` 設定が含まれています。利用可能な設定は以下の通りです。

package/package.json

@@ -1,7 +1,15 @@
 {
 	"name": "@yoshinani/style-guide",
-	"version": "0.0.2",
+	"version": "0.0.4",
 	"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",