netless-io/flat

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

Open

#1.080 geöffnet am 10. Nov. 2021

Auf GitHub ansehen
 (7 Kommentare) (1 Reaktion) (0 zugewiesene Personen)TypeScript (6.396 Stars) (878 Forks)user submission
enhancementgood first issue

Beschreibung

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"
			],
		}
	}
]

Contributor Guide

Tech Stack
typescript
Domain
developer experience
Issue Type
chore
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Knowledge of ESLintFamiliarity with flat's codebaseUnderstanding of file naming conventions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
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.