@d-zero/eslint-config 5.0.0-dev.93 → 6.0.0-alpha.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 D-ZERO Co., Ltd.
+Copyright (c) 2024 D-ZERO Co., Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,55 @@
 # `@d-zero/eslint-config`
 
-- 使用: 🆗 使用可
-- 解説: 🚧 準備中
+## 個別インストール
+
+```sh
+npm install -D @d-zero/eslint-config
+```
+
+## 使い方
+
+`eslint.config.js`を作成し、`import`からコンフィグデータを読み込みます。
+
+```js
+import dz from '@d-zero/eslint-config';
+
+/**
+ * @type {import('eslint').ESLint.ConfigData[]}
+ */
+export default [...dz.configs.frontend];
+```
+
+### 拡張
+
+プロジェクトに合わせて設定を追加します。
+
+```js
+import dz from '@d-zero/eslint-config';
+
+/**
+ * @type {import('eslint').ESLint.ConfigData[]}
+ */
+export default [
+	...dz.configs.frontend,
+	{
+		rules: {
+			// 例: console.logを許可する
+			'no-console': 0,
+		},
+	},
+];
+```
+
+### プリセット
+
+以下のプリセットが用意されています。
+
+| プロパティ             | 型       | 説明                                               |
+| ---------------------- | -------- | -------------------------------------------------- |
+| `configs.frontend`     | `Array`  | フロントエンド開発用                               |
+| `configs.frontendNoTS` | `Array`  | フロントエンド開発用（TypeScriptを利用しない場合） |
+| `configs.node`         | `Array`  | Node.js開発用                                      |
+| `configs.nodeNoTS`     | `Array`  | Node.js開発用（TypeScriptを利用しない場合）        |
+| `configs.standard`     | `Array`  | `config.node`と同じ                                |
+| `configs.base`         | `Array`  | `config.nodeNoTS`と同じ                            |
+| `configs.commonjs`     | `Object` | CommonJS用単一設定                                 |

package/base.js

@@ -1,104 +1,261 @@
+import dzeroPlugin from '@d-zero/eslint-plugin';
+import js from '@eslint/js';
+import comments from 'eslint-plugin-eslint-comments';
+import { flatConfigs as importX } from 'eslint-plugin-import-x';
+import jsdoc from 'eslint-plugin-jsdoc';
+import * as regexpPlugin from 'eslint-plugin-regexp';
+import sortClassMembers from 'eslint-plugin-sort-class-members';
+import eslintPluginUnicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
+
 /**
- * @type {import('eslint/lib/shared/types').ConfigData}
+ * @type {import('eslint').Linter.Config[]}
  */
-module.exports = {
-	extends: [
-		'eslint:recommended',
-		'plugin:unicorn/recommended',
-		'plugin:regexp/recommended',
-		'plugin:import/recommended',
-	],
-	env: {
-		browser: true,
-		es6: true,
-		node: true,
-	},
-	plugins: ['unicorn', 'jsdoc', 'eslint-comments', 'import', 'sort-class-members'],
-	parserOptions: {
-		ecmaVersion: 2023,
+export const base = [
+	{
+		...js.configs.recommended,
+		rules: {
+			...js.configs.recommended.rules,
+			'no-console': 'warn',
+			'no-mixed-spaces-and-tabs': 0,
+			'no-restricted-syntax': [
+				2,
+				{
+					selector:
+						':matches(PropertyDefinition, MethodDefinition)[accessibility="private"]',
+					message: 'Use #private instead',
+				},
+				{
+					selector:
+						':matches(PropertyDefinition, MethodDefinition)[accessibility="public"]',
+					message: 'Remove public keyword',
+				},
+				{
+					selector: 'MethodDefinition[key.name=/^_/]:not([accessibility="protected"])',
+					message: 'Add protected keyword',
+				},
+				{
+					selector: 'MethodDefinition:not([key.name=/^_/])[accessibility="protected"]',
+					message: 'Start with `_` if you want to use protected',
+				},
+				{
+					selector:
+						"CallExpression[callee.property.name='addEventListener'][arguments.0.value='DOMContentLoaded']",
+					message:
+						"Avoid using 'DOMContentLoaded'. Use 'defer' or 'type=module' attribute instead.",
+				},
+			],
+			'no-unused-vars': 0,
+			'no-var': 2,
+			'prefer-const': 2,
+			'prefer-rest-params': 2,
+			'prefer-spread': 2,
+		},
 	},
-	globals: {
-		NodeJS: true,
+	{
+		...eslintPluginUnicorn.configs.recommended,
+		rules: {
+			...eslintPluginUnicorn.configs.recommended.rules,
+			'unicorn/consistent-destructuring': 0,
+			'unicorn/consistent-function-scoping': 0,
+			'unicorn/no-anonymous-default-export': 0,
+			'unicorn/no-array-callback-reference': 0,
+			'unicorn/no-nested-ternary': 0,
+			'unicorn/no-null': 0,
+			'unicorn/no-process-exit': 0,
+			'unicorn/prefer-global-this': 0,
+			'unicorn/prefer-query-selector': 0,
+			'unicorn/prefer-string-raw': 0,
+			'unicorn/prefer-ternary': 0,
+			'unicorn/prevent-abbreviations': 0,
+		},
 	},
-	rules: {
-		// Standard
-		'no-var': 2,
-		'no-unused-vars': 0,
-		'no-console': 'warn',
-		'no-mixed-spaces-and-tabs': 0,
-		'prefer-const': 2,
-		'prefer-rest-params': 2,
-		'prefer-spread': 2,
-
-		// Unicorn
-		'unicorn/consistent-destructuring': 0,
-		'unicorn/consistent-function-scoping': 0,
-		'unicorn/no-array-callback-reference': 0,
-		'unicorn/no-nested-ternary': 0,
-		'unicorn/no-null': 0,
-		'unicorn/prefer-query-selector': 0,
-		'unicorn/prefer-ternary': 0,
-		'unicorn/prevent-abbreviations': 0,
-
-		// import
-		'import/no-named-as-default': 0,
-		'import/no-unresolved': 0,
-		'import/no-extraneous-dependencies': 2,
-		'import/order': [
-			2,
-			{
-				groups: ['type', 'builtin', 'external', 'parent', 'sibling', 'index', 'object'],
-				pathGroups: [
-					{
-						pattern: '@alias/**',
-						group: 'parent',
-						position: 'before',
+	regexpPlugin.configs['flat/recommended'],
+	{
+		...importX.recommended,
+		rules: {
+			...importX.recommended.rules,
+			'import-x/no-extraneous-dependencies': 2,
+			'import-x/no-named-as-default': 0,
+			'import-x/no-unresolved': 0,
+			'import-x/order': [
+				2,
+				{
+					groups: ['type', 'builtin', 'external', 'parent', 'sibling', 'index', 'object'],
+					pathGroups: [
+						{
+							pattern: '@alias/**',
+							group: 'parent',
+							position: 'before',
+						},
+					],
+					alphabetize: {
+						order: 'asc',
 					},
-				],
-				alphabetize: {
-					order: 'asc',
+					'newlines-between': 'always',
 				},
-				'newlines-between': 'always',
-			},
-		],
-
-		// sort-class-members
-		'sort-class-members/sort-class-members': [
-			1,
-			{
-				order: [
-					'[static-properties]',
-					'[static-methods]',
-					'[properties]',
-					'[conventional-private-properties]',
-					'constructor',
-					'[methods]',
-					'[conventional-private-methods]',
-				],
-				accessorPairPositioning: 'getThenSet',
-			},
+			],
+		},
+	},
+	{
+		files: [
+			'*.{test,spec}.{js,mjs,json}',
+			'*.config.{js,mjs,json}',
+			'.*rc.{js,mjs,json}',
 		],
+		rules: {
+			'import-x/no-extraneous-dependencies': 0,
+		},
 	},
-	settings: {
-		jsdoc: {
-			tagNamePreference: {
-				param: 'arg',
-				returns: 'return',
-			},
+	{
+		...jsdoc.configs['flat/recommended'],
+		rules: {
+			...jsdoc.configs['flat/recommended'].rules,
+			'jsdoc/require-param-type': 0,
+			'jsdoc/require-param-description': 0,
+			'jsdoc/require-returns': 0,
+			'jsdoc/require-returns-type': 0,
+			'jsdoc/require-returns-description': 0,
 		},
 	},
-	overrides: [
-		{
-			files: '**/*.spec.*',
-			rules: {
-				'import/no-extraneous-dependencies': 0,
-			},
+	{
+		plugins: {
+			comments,
+		},
+	},
+	{
+		plugins: {
+			comments,
+			'sort-class-members': sortClassMembers,
 		},
-		{
-			files: ['*.config.{js,mjs,json,ts}', '.*rc.{js,mjs,json,ts}'],
-			rules: {
-				'import/no-extraneous-dependencies': 0,
+		rules: {
+			'sort-class-members/sort-class-members': [
+				1,
+				{
+					order: [
+						'[public-properties]',
+						'[public-readonly-properties]',
+						'[public-properties-function]',
+						'[private-properties]',
+						'[private-properties-function]',
+						'[accessor-pairs]',
+						'[getters]',
+						'[setters]',
+						'constructor',
+						'[public-methods]',
+						'[private-methods]',
+						'[protedted-methods]',
+						'[static-properties]',
+						'[static-methods]',
+						'[everything-else]',
+					],
+					groups: {
+						'public-properties': [
+							{
+								type: 'property',
+								kind: 'nonAccessor',
+								static: false,
+								private: false,
+								override: false,
+								readonly: false,
+								sort: 'alphabetical',
+							},
+						],
+						'public-readonly-properties': [
+							{
+								type: 'property',
+								kind: 'nonAccessor',
+								static: false,
+								private: false,
+								override: false,
+								readonly: true,
+								sort: 'alphabetical',
+							},
+						],
+						'public-properties-function': [
+							{
+								type: 'property',
+								propertyType: 'ArrowFunctionExpression',
+								kind: 'nonAccessor',
+								static: false,
+								private: false,
+								accessibility: 'public',
+								override: false,
+								sort: 'alphabetical',
+							},
+						],
+						'private-properties': [
+							{
+								type: 'property',
+								kind: 'nonAccessor',
+								static: false,
+								private: true,
+								override: false,
+								sort: 'alphabetical',
+							},
+						],
+						'private-properties-function': [
+							{
+								type: 'property',
+								propertyType: 'ArrowFunctionExpression',
+								kind: 'nonAccessor',
+								static: false,
+								private: true,
+								accessibility: 'public',
+								override: false,
+								sort: 'alphabetical',
+							},
+						],
+						'public-methods': [
+							{
+								type: 'method',
+								kind: 'nonAccessor',
+								static: false,
+								private: false,
+								override: false,
+								sort: 'alphabetical',
+							},
+						],
+						'private-methods': [
+							{
+								name: '/#.+/',
+								type: 'method',
+								kind: 'nonAccessor',
+								static: false,
+								private: true,
+								override: false,
+								sort: 'alphabetical',
+							},
+						],
+						'protedted-methods': [
+							{
+								name: '/_.+/',
+								type: 'method',
+								static: false,
+								sort: 'alphabetical',
+							},
+						],
+					},
+					accessorPairPositioning: 'getThenSet',
+				},
+			],
+		},
+	},
+	{
+		languageOptions: {
+			ecmaVersion: 2023,
+			globals: {
+				...globals.builtin,
+				...globals.nodeBuiltin,
 			},
 		},
-	],
-};
+	},
+	{
+		plugins: {
+			'@d-zero': dzeroPlugin,
+		},
+		rules: {
+			'@d-zero/no-click-event': 'warn',
+		},
+	},
+];

package/commonjs.js

@@ -0,0 +1,16 @@
+import globals from 'globals';
+
+/**
+ * @type {import('eslint').Linter.Config}
+ */
+export const commonjs = {
+	rules: {
+		'unicorn/prefer-module': 0,
+		'@typescript-eslint/no-require-imports': 0,
+	},
+	languageOptions: {
+		globals: {
+			...globals.commonjs,
+		},
+	},
+};

package/frontend.js

@@ -0,0 +1,15 @@
+import globals from 'globals';
+
+/**
+ * @type {import('eslint').Linter.Config}
+ */
+export const frontend = {
+	rules: {
+		'unicorn/prefer-top-level-await': 0,
+	},
+	languageOptions: {
+		globals: {
+			...globals.browser,
+		},
+	},
+};

package/index.js

@@ -1,79 +1,19 @@
-const base = require('./base');
+import { base } from './base.js';
+import { commonjs } from './commonjs.js';
+import { frontend } from './frontend.js';
+import { ts } from './typescript.js';
 
 /**
- * @type {import('eslint/lib/shared/types').ConfigData}
+ * @type {import('eslint').ESLint.Plugin}
  */
-module.exports = {
-	...base,
-	overrides: [
-		{
-			files: '**/*.{ts,tsx}',
-			extends: ['plugin:import/typescript', 'plugin:@typescript-eslint/recommended'],
-			plugins: ['@typescript-eslint', ...base.plugins],
-			parser: '@typescript-eslint/parser',
-			parserOptions: {
-				sourceType: 'module',
-				project: ['./tsconfig.json'],
-			},
-			settings: {
-				...base.settings,
-				'import/parsers': {
-					'@typescript-eslint/parser': ['.ts'],
-				},
-			},
-			rules: {
-				...base.rules,
-				// @typescript-eslint
-				'@typescript-eslint/no-unused-vars': 2,
-				'@typescript-eslint/no-array-constructor': 2,
-				'@typescript-eslint/adjacent-overload-signatures': 2,
-				'@typescript-eslint/no-namespace': [2, { allowDeclarations: true }],
-				'@typescript-eslint/prefer-namespace-keyword': 2,
-				'@typescript-eslint/no-var-requires': 2,
-				'@typescript-eslint/no-unnecessary-type-assertion': 2,
-				'@typescript-eslint/restrict-plus-operands': 0,
-				'@typescript-eslint/consistent-type-imports': 1,
-				'@typescript-eslint/require-await': 2,
-				'@typescript-eslint/no-floating-promises': 2,
-				'@typescript-eslint/member-ordering': [
-					'warn',
-					{
-						default: 'never',
-						classes: {
-							memberTypes: [
-								'public-static-field',
-								'protected-static-field',
-								'private-static-field',
-								'public-static-method',
-								'protected-static-method',
-								'public-static-get',
-								'protected-static-get',
-								'private-static-get',
-								'public-instance-field',
-								'protected-instance-field',
-								'private-instance-field',
-								'public-abstract-field',
-								'protected-abstract-field',
-								'public-constructor',
-								'protected-constructor',
-								'private-constructor',
-								['public-abstract-get', 'public-abstract-set'],
-								['protected-abstract-get', 'protected-abstract-set'],
-								['public-instance-get', 'public-instance-set'],
-								['protected-instance-get', 'protected-instance-set'],
-								['private-instance-get', 'private-instance-set'],
-								'public-abstract-method',
-								'protected-abstract-method',
-								'public-instance-method',
-								'protected-instance-method',
-								'private-instance-method',
-								'private-static-method',
-							],
-							order: 'alphabetically',
-						},
-					},
-				],
-			},
-		},
-	],
+export default {
+	configs: {
+		standard: [...ts],
+		base: [...base],
+		node: [...ts],
+		nodeNoTS: [...base],
+		frontend: [...ts, frontend],
+		frontendNoTS: [...base, frontend],
+		commonjs,
+	},
 };

package/package.json

@@ -1,44 +1,39 @@
 {
 	"name": "@d-zero/eslint-config",
-	"version": "5.0.0-dev.93+c6646f2",
+	"version": "6.0.0-alpha.2",
 	"description": "Configurations of ESLint",
-	"repository": "https://github.com/d-zero-dev/node-dev-env.git",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/d-zero-dev/linters.git",
+		"directory": "packages/@d-zero/eslint-config"
+	},
 	"author": "D-ZERO Co., Ltd.",
 	"license": "MIT",
-	"private": false,
 	"publishConfig": {
 		"access": "public"
 	},
+	"engines": {
+		"node": ">=22.0.0"
+	},
 	"files": [
-		"index.js",
-		"base.js"
+		"*.js"
 	],
-	"type": "commonjs",
-	"main": "index.js",
+	"type": "module",
 	"exports": {
-		".": {
-			"require": "./index.js"
-		},
-		"./base": {
-			"require": "./base.js"
-		}
+		".": "./index.js"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "6.15.0",
-		"@typescript-eslint/parser": "6.15.0",
-		"eslint": "8.56.0",
+		"@d-zero/eslint-plugin": "6.0.0-alpha.2",
+		"@eslint/js": "9.39.3",
+		"eslint": "9.39.3",
 		"eslint-plugin-eslint-comments": "3.2.0",
-		"eslint-plugin-import": "2.29.1",
-		"eslint-plugin-jsdoc": "46.9.1",
-		"eslint-plugin-regexp": "2.1.2",
-		"eslint-plugin-sort-class-members": "1.19.0",
-		"eslint-plugin-unicorn": "50.0.1"
-	},
-	"peerDependencies": {
-		"@d-zero/tsconfig": ">= 5"
-	},
-	"devDependencies": {
-		"@d-zero/tsconfig": "5.0.0-dev.93+c6646f2"
+		"eslint-plugin-import-x": "4.16.1",
+		"eslint-plugin-jsdoc": "62.7.1",
+		"eslint-plugin-regexp": "3.0.0",
+		"eslint-plugin-sort-class-members": "1.21.0",
+		"eslint-plugin-unicorn": "63.0.0",
+		"globals": "17.3.0",
+		"typescript-eslint": "8.56.1"
 	},
-	"gitHead": "c6646f2425c257367f106e5e2cee276c42aef9d5"
+	"gitHead": "b2d753122349a8d4dd4b7d484276d03fec498f0d"
 }

package/typescript.js

@@ -0,0 +1,44 @@
+import tsESLint from 'typescript-eslint';
+
+import { base } from './base.js';
+
+export const ts = tsESLint.config(
+	base,
+	tsESLint.configs.recommended,
+	{
+		files: ['*.{ts,tsx}', '**/*.{ts,tsx}'],
+		languageOptions: {
+			parserOptions: {
+				sourceType: 'module',
+				project: ['./tsconfig.json'],
+			},
+		},
+		settings: {
+			'import-x/parsers': {
+				'@typescript-eslint/parser': ['.ts'],
+			},
+		},
+		rules: {
+			'@typescript-eslint/adjacent-overload-signatures': 2,
+			'@typescript-eslint/ban-ts-comment': 0,
+			'@typescript-eslint/consistent-type-imports': 1,
+			'@typescript-eslint/member-ordering': 0,
+			'@typescript-eslint/no-array-constructor': 2,
+			'@typescript-eslint/no-explicit-any': [1, { fixToUnknown: true }],
+			'@typescript-eslint/no-floating-promises': 2,
+			'@typescript-eslint/no-namespace': [2, { allowDeclarations: true }],
+			'@typescript-eslint/no-unnecessary-type-assertion': 2,
+			'@typescript-eslint/no-unused-vars': 2,
+			'@typescript-eslint/no-var-requires': 2,
+			'@typescript-eslint/prefer-namespace-keyword': 2,
+			'@typescript-eslint/require-await': 2,
+			'@typescript-eslint/restrict-plus-operands': 0,
+		},
+	},
+	{
+		files: ['*.{test,spec}.{ts,mts,tsx}'],
+		rules: {
+			'import/no-extraneous-dependencies': 0,
+		},
+	},
+);