sindresorhus/eslint-plugin-unicorn

`filename-case`: add `$` as an ignored char

Open

#2,503 opened on Nov 29, 2024

View on GitHub
 (2 comments) (1 reaction) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission
enhancementgood for beginnerhelp wanted

Description

Description

I'm working with tanstack router and the route params are defined with $, like $userId.tsx, but this rule doesn't ignore this char. I saw that it was an ignored char in the past, can you put it again?

Fail

src/app/routes/_area-reservada/area-reservada/certidoes/$idCertidao.tsx

Filename is not in kebab case or pascal case. Rename it to $id-certidao.tsx or $IdCertidao.tsx unicorn/filename-case

Pass

src/app/routes/_area-reservada/area-reservada/certidoes.tsx

Additional Info

No response

Contributor guide

Tech stack
javascript
Domain
tooling
Issue type
feature
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptFamiliarity with ESLint
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Locate the `filename case` rule implementation in the repository, likely in `rules/filename case.js`. The rule likely has a list of ignored characters that can be configured. Identify where characters like `$` are defined as excluded, and determine how to add `$` back. Review any historical commits or issue references that might explain why `$` was removed. Ensure that the change maintains backward compatibility and does not interfere with other patterns. Consider adding a test case for filenames containing `$`.