netless-io/flat

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

Open

#1,080 opened on Nov 10, 2021

View on GitHub
 (7 comments) (1 reaction) (0 assignees)TypeScript (878 forks)user submission
enhancementgood first issue

Repository metrics

Stars
 (6,396 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Contributor guide

Research direction
Add the unicorn/filename case rule to the ESLint configuration as proposed in the issue.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ESLintNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80