Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for preserving original filename casing with --filename-case=keep #960

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Options:
-d, --out-dir <dirname> output files into a directory
--ignore-existing ignore existing files when used with --out-dir
--ext <ext> specify a custom file extension (default: "js")
--filename-case <case> specify filename case ("pascal", "kebab", "camel", "snake") (default: "pascal")
--filename-case <case> specify filename case ("pascal", "kebab", "camel", "snake", "keep") (default: "pascal")
--icon use "1em" as width and height
--native add react-native support with react-native-svg
--memo add React.memo into the result component
Expand Down
10 changes: 10 additions & 0 deletions packages/cli/src/__snapshots__/index.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,16 @@ exports[`cli should support different filename cases with directory output: --fi
]
`;

exports[`cli should support different filename cases with directory output: --filename-case=keep 1`] = `
[
"PascalCase.js",
"camelCase.js",
"index.js",
"kebab-case.js",
"multiple---dashes.js",
]
`;

exports[`cli should support different filename cases with directory output: --filename-case=pascal 1`] = `
[
"CamelCase.js",
Expand Down
1 change: 1 addition & 0 deletions packages/cli/src/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ describe('cli', () => {
[2, '--filename-case=pascal'],
[3, '--filename-case=kebab'],
[4, '--filename-case=snake'],
[5, '--filename-case=keep'],
])(
'should support different filename cases with directory output',
async (index, args) => {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ program
.option('--ext <ext>', 'specify a custom file extension (default: "js")')
.option(
'--filename-case <case>',
'specify filename case ("pascal", "kebab", "camel", "snake") (default: "pascal")',
'specify filename case ("pascal", "kebab", "camel", "snake", "keep") (default: "pascal")',
)
.option(
'--icon [size]',
Expand Down
2 changes: 2 additions & 0 deletions packages/cli/src/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ export function transformFilename(
return camelCase(filename, { pascalCase: true })
case 'snake':
return snakeCase(filename)
case 'keep':
return filename
default:
throw new Error(`Unknown --filename-case ${filenameCase}`)
}
Expand Down
3 changes: 2 additions & 1 deletion website/pages/docs/options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,8 @@ When used with `--out-dir`, it ignores already existing files.

## Filename case

Specify a custom filename case. Possible values: `pascal` for PascalCase, `kebab` for kebab-case, `camel` for camelCase, or `snake` for snake_case.
Specify a custom filename case. Possible values: `pascal` for PascalCase, `kebab` for kebab-case, `camel` for camelCase, `snake` for snake_case, or `keep`
to preserve original filename casing.

| Default | CLI Override | API Override |
| -------- | ----------------- | ---------------------- |
Expand Down