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

Consistent configuration file naming #5936

Open
inimicus opened this issue Sep 22, 2023 · 0 comments
Open

Consistent configuration file naming #5936

inimicus opened this issue Sep 22, 2023 · 0 comments
Labels
cli Something to do with CLI arguments enhancement New feature or request

Comments

@inimicus
Copy link

What is the problem this feature would solve?

Configurations may be local (within project root, alongside package.json file) or global (within $HOME or $XDG_CONFIG_HOME), but the bunfig file changes naming depending on where it exists.

  • In local project: bunfig.toml
  • Global: .bunfig.toml

This one-character variation may lead to confusion (🖐🏻) if the wrong file name to an otherwise similar configuration file is used.

What is the feature you are proposing to solve the problem?

Make naming consistent between the local/global locations or support both dotfile/non-dotfile filename permutations.

What alternatives have you considered?

Documentation does clearly call out the exact filenames and their associated locations (well done), but this nuance could be more explicitly highlighted via a ⚠️ Heads-Up call-out block, or something along these lines, for our visually impaired friends (🖐🏻) or those who struggle at reading comprehension (🖐🏻).

@inimicus inimicus added the enhancement New feature or request label Sep 22, 2023
@Electroid Electroid added the cli Something to do with CLI arguments label Sep 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Something to do with CLI arguments enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants