netless-io/flat

[chore]: use `unicorn/filename-case` eslint rule

Open

#1,080 opened on 2021年11月10日

GitHub で見る
 (7 comments) (1 reaction) (0 assignees)TypeScript (6,396 stars) (878 forks)user submission
enhancementgood first issue

説明

Previously, we discussed the specification of file names (see: https://github.com/netless-io/flat/issues/714)

But this is all built on an ego-driven basis and we need to have a rule to help us check this.

Thanks to @LitoMore recommendation, we were made aware of the existence of unicorn/filename-case.

Rule Link: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/filename-case.md

The following rules, which I have just come up with, may not be perfect.

"unicorn/filename-case": [
	"error",
	{
		"cases": {
			"kebabCase": true,
			"ignore": [
				"^[A-Z].+\\.tsx$",
				"^README.*\\.md$",
				".*\\.yaml",
				".*\\.yml"
			],
		}
	}
]

コントリビューターガイド

技術スタック
typescript
領域
developer experience
Issue 種別
chore
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Knowledge of ESLintFamiliarity with flat's codebaseUnderstanding of file naming conventions
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
Locate the ESLint configuration file in the repository (likely .eslintrc or eslintConfig in package.json). Add the `unicorn/filename case` rule with the configuration provided in the issue, ensuring kebabCase is enforced and specific files (e.g., React components, README, YAML) are ignored. Run `npx eslint .` to verify the rule works and doesn't break existing linting. Refer to the linked issue #714 and the eslint plugin unicorn documentation for further context.