feat: follow common conventions on folder naming in `$XDG_CONFIG_HOME`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.3k
- Forks
- 214
- Avg merge
- 13h 22m
- Merged PRs (30d)
- 18
Description
🆒 Your use case
While #526 added support for XDG_CONFIG_HOME, it stores files in $XDG_CONFIG_HOME/.nuxt/devtools instead of the convention of $XDG_CONFIG_HOME/<application>, i.e., without the leading .. The leading dot in UNIX conventions is to denote a hidden file, and with the default location of $XDG_CONFIG_HOME being ~/.config, the parent folder is already hidden and there really isn't a need to further hide the folder inside $XDG_CONFIG_HOME.
While the XDG Base Directory specification is unfortunately silent on the naming convention and folder structure inside $XDG_CONFIG_HOME, common convention is to simply name the subdir directly after the application, without the leading dot.
References;
- https://itsfoss.gitlab.io/blog/xdg-base-directory/#xdg_config_home
- https://wiki.archlinux.org/title/XDG_Base_Directory
🆕 The solution you'd like
Store files in $XDG_CONFIG_HOME/nuxt/devtools
🔍 Alternatives you've considered
No response
ℹ️ Additional info
If this is an acceptable feature, I would be willing to contribute a PR.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the code that builds the $XDG_CONFIG_HOME path for devtools and inspect how the current .nuxt/devtools location is selected. Update the configuration location to $XDG_CONFIG_HOME/nuxt/devtools, then verify that devtools files use the requested path without breaking the existing default behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100