gajus/eslint-plugin-canonical

[filename-match-exported] add kebab filename export for react components

Open

#18 opened on Feb 23, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (15 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (150 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there any chance to add an ability to have kebab filename for pascal type of export (react component)?

Rule sample: "canonical/filename-match-exported": [ 2, { "transforms": "kebab" } ]

Filename sample: thumb-up.tsx

Export sample: export default ThumbUp

Current state: Error: 1:1 error Filename 'thumb-up' must match the exported and transformed name 'thumbUp' canonical/filename-match-exported

Expected: No error

Contributor guide

Research direction
Examine the rule's source code in the eslint plugin canonical repository to understand how filename transforms are applied. Add a new transform option 'kebab' that converts PascalCase to kebab case and update the relevant tests.
Tech stack
typescriptjavascriptnodejs
Domain
toolingdeveloper experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
Node.jsESLintTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70