netless-io/flat

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

Open

#1 080 ouverte le 10 nov. 2021

Voir sur GitHub
 (7 commentaires) (1 réaction) (0 assignés)TypeScript (6 396 stars) (878 forks)user submission
enhancementgood first issue

Description

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

Guide contributeur

Stack technique
typescript
Domaine
developer experience
Type d'issue
chore
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Knowledge of ESLintFamiliarity with flat's codebaseUnderstanding of file naming conventions
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75
Direction de recherche
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.