The .meta directory: let's tidy things up
dotmeta.org
dotmeta.org
On having it start with a dot: Why? Why would we pretend that these crucial files don't exist?
On having it named meta: These files aren't "about" the project or "above" the project, they ARE the project.
If I'm writing an editor, I expect the config directory in the source code to hold the configuration for the editor, not .babelrc
meta is a much better name and they are "about" the project, not the project itself, so I disagree on that point. Though I agree it should not be hidden. I will start having a "meta" directory in my projects
Other things that would land in the folder:
- Files essential to building the project - Files essential to running the test suite - Files essential to developing on the project
IMO a "project" includes all those things. In your definition are those all "meta"? Does "meta" mean anything that's not source code?
I guess I'm also not seeing what the exact problem is. The project root is crowded, yes, now this suggests making a different directory crowded. The messiness is shifted.
The original Greek prefix is a preposition that means “with”, “among”, or “beside”. Doesn’t seem like a stretch that config files are a type of metafile.
Even .config would be better
The truth is, it's not that the current project roots are a mess. It's that there's a complete and holistic category of file that is being kept in the root of projects, and putting them in a directory dedicated to that category is utterly sensible. Every other category is kept in a dedicated namespace in the file structure, why should config files be the exception?
I agree with the GP about bikeshedding. A debate about this would never end.
Which is why the whole thing needs to be nipped in the bud.
For one thing .meta would already be a dotfile so .dotfile/.env would be redundant. But that's called dotenv! What's it going to be named now? Or maybe that wouldn't be included. But it's on the list in the tweet linked to in the article.
Tell this to the guy who started it by suggesting files should be moved in the first place.
Right now any codebase can put them wherever it wants. If you suggest to standardize things you damn better get the whole idea including naming right.
.project - Since these files typically "configure a project", a dot project directory could hold all of those files.
.meta - Agree its not super descriptive, which is fine, but more precision could be good.
.config - Problem with this is "configuration for what?", the project or the application?
Or simply
tools
There's a reason Linux doesn't just stuff everything into /
It’s the ones that arent hidden that are a problem, and if they’re already obnoxious enough to choose a non-hidden file name they’re probably not going to support a hidden directory either - Dockerfile, Jenkinsfile, and bitbucket-compose.yml, I’m looking at you.
But, can't pretty much any of these be put wherever one wishes? Like `ops/` or w/e?
The presence of a makefile at the top level tells you you can run make. The presence of a dockerfile tells you you can build with docker. It's not a good system, but it kinda works.
_any_ repo has clues about the toolchain encoded in the file types and extensions, but that’s not the same thing.
and yes, npm or yarn can define scripts which can have the same documentation benefits. but there’s lots of others too that are specifically for tasks. i really like https://taskfile.dev.
these files can communicate how to work in a project.
Still, I feel like the status quo is pretty good. Most ecosystems have built in task runners for specifying/documenting commands, js and python projects can opt to shove a lot of config in package.json or pyproject.toml for a lot of ecosystem tooling respectively if they want (similar for a lot of languages).
I wouldn't mind if some ~/.config-like (https://unix.stackexchange.com/a/33945/203864) convention emerged here similar to the .meta proposal though.
I agree with this proposal that it can be a mess, but hiding the files or directories isn’t a solution. Instead, the mess we often see reflects the abysmal unification of tooling in modern software development, and the JS ecosystem is perhaps the worst offender.
If things suck, let them fester in the open air. Stuffing them away isn’t gonna fix the mess, just sweep it under the rug.
I must say though, that one huge pet peeve that I have, is software that don’t allow projects to be rooted in a subdir of the git repo root. This is a huge annoyance when you work with multiple stacks in the same project.
The onus is on the tools developers to adopt this change. And the proposal allows for the gradual, graceful migration from current status to a place where all such files are stored in a central location.
The directory name `.toolsconfig`, or `.tc` is the best I could recommend, since `config` or `.config` can be safely assumed to be already in use. Using 'tools' in the directory name also makes it explicit as to whose config files are stored in there; tools developers use, not the config of the projecct itself.
Edit: The Git repo of the proposal is hosted on Github. Feel free to propose any changes or improvements to the proposal or the algorithm.
https://github.com/DrPostgres/ToolsConfig/ https://www.toolsconfig.org/
---
While probably a bikeshed consideration, .config is a much more obvious name to use for this.
HN thread with many agreements:
https://news.ycombinator.com/item?id=36472613
Previous project suggesting .config: https://dot-config.github.io/
I'd suggest leaving this issue around and collecting thumbs up / down (Please don't comment with +1s on this, unless you have something novel to add).Hiding files under a directory is not really a solution for anything other than slightly improving file navigation, but even if you think it's valuable, the real problem is getting tools to adopt it. There is no incentive to be the first. The intermediate state is terrible - now you need to guess if a config is located at the root or this new config directory, and if your version of the tooling is able to pick up the new location.
Things I like:
- I agree that something should be done
- I think having a wall of honor on your site is a good way to promote adoption
- I think you make some good arguments
Things I question: - .meta - As others have pointed out, it's not metadata about the project, it's part of the project. Also, as others have noted, having this be a dot file will unnecessarily hide the directory in some circumstances.
- There is no org-based namespacing in the .meta approach
- A wall of honor is probably not enough to drive adoption
Recommendations: - I think another form of adoption driver is to discuss it on the mailing lists of 2-3 large open source projects, get them to buy into you submitting a PR for this as a non-breaking enhancement (if files not found in current dirs, look in .meta; if files not found at all create them in .meta), and then follow through with the PR for each. Some candidates are VS Code, NPM, NetBeans, Maven, and Cargo.
- etc seems a natural project config directory name. /etc is for system config files, ${BASEDIR}/etc is for project config files. There may be some conflicts here with projects already using etc, but the file's should conflict.
- what I think we need is a unified project metadata file, then links in that file could be traversed to the tool specific files and it wouldn't matter where they were - they wouldn't need to be in the root directory. Description of a Project (DOAP) [1] was a good start toward this, but the last time it had more than 1 PR a year was in 2018. There's no JSON format.
[1] https://github.com/ewilderj/doap/wikiRegistered an entire domain name to back an idea based on a tweet, but completely missing the point of that tweet. If only they'd read the tweeter's own replies under that same tweet they could've avoided wasting their time on this.
For clarity: the original tweeter was bemoaning the state of JS tooling (the busy root directory being a symptom - not the core problem). Throwing your fifty config files in a hidden subdirectory is what's typically referred to as "supporting dysfunction".
Hilarious expression. But we’re going even further here: standardizing dysfunction.
- A lot of files they mention aren't random metadata but critical parts of the project. Stuff like package.json, Dockerfile, build configs etc. should not be hidden away.
- For a lot of other files like .git, .gitignore, .dockerignore their exact path matters to their operation, especially since a lot of them are hierarchical as well.
The author's sole problem seems to be that their project root is too cluttered, and some people here have a better suggestion - fix it at the UI layer instead. Have VS Code (or whatever other file browser) automatically put these files in a virtual sub-folder.
It's generally really well respected by a lot of software. It's just not well known enough that its annoying. In my experience a lot of the failures are from Apple developers assuming that this is a "Linux spec".
The latest version of which can be found here: https://specifications.freedesktop.org/basedir-spec/basedir-...
And, of course, obligatory reference to https://xkcd.com/927/
[1] surprisingly hard to find history, but Wayback Machine to the rescue: https://web.archive.org/web/20170319100840/https://specifica...
(edit: related: https://news.ycombinator.com/item?id=36474981 , https://news.ycombinator.com/item?id=36474943 )
Lastly, I think part of the reason this problem is so annoying to warrant it is that lots of tools think they’re so special that they need to create a new config even when they create redundancies with other overlapping config content. I know this is a “there are N competing standards” proclamation, but it would be nice if same-ecosystem tools were encouraged to collaborate on config specs/schemas so a great deal more stuff could be defined once, in one format, at one well-known path.
The problem you're trying to solve with this is just related to the fact that README starts with R. In the past, I've been an advocate for breaking with tradition and naming your README "ABOUT" instead.
> it would be nice if same-ecosystem tools were encouraged to collaborate on config specs/schemas so a great deal more stuff could be defined once, in one format, at one well-known path
Or better: thinking long and hard about the question "What problem is this trying to solve?" and then considering whether another tool that dumps/reads a config file at a fixed location is the best way to deal with it in the first place.
I feel like the main reason why dotfiles exist is because they typically got put in your $HOME and that would just litter your file manager's view.
- node monorepos by putting everything in the packages directory
- python repos by putting almost everything underneath the name of the package
What might help some who are annoyed by this perceived clutter is to be to jump straight into the main content in the subdirectory. Getting the other files moved out only helps it a little because you don't have to go through as many items to click or cd into the main content's directory. It doesn't remove a whole step. The steps are still 1) to go to the repo and 2) click or cd to the directory that has the main content.
If you're gonna propose tidying it up, at least propose a useful organization other than just hiding it, like from the example list of files maybe something like 3 subdirectories: installers, linters, and compilers/runners?
I think the point of ".meta" is the drawer for config files of _tools_. And these tools, depending on the language and the ecosystem, might not fall into neat subdirectories like "installers", or "linters". Some compiler comes with their own packaging system, and some with their own linter.
".meta/{tool_name}.{ext}" or ".meta/{tool_name}/*.{ext}" should be sufficient in that regard. (Though I do prefer ".config" over ".meta")
The criteria is a little clearer compared to “config” files, which could mean a lot of things.
This case isn't covered by XDG, but there's a path here we probably could & should adapt, that suggests itself. And this forges off in a new direction.
https://specifications.freedesktop.org/basedir-spec/basedir-...
If we're tossing this into random subfolders, I'm not sure why we wouldn't keep that going?
That's not the filesystem root, is it? From what I can tell, ~/.local mimics `/usr`; it has bin and include, yes, but also `share`, and no `/etc` that I'm aware of. `/` does have `bin`, but I don't think I've ever seen `include` there on a system before.
It's a little weird because presumably repos shouldn't just be a .local folder. We'd still be excepting the actual source from this.
Maybe we just use a FileSystem Heirarchy pattern for repos? Many projects already have source in src/. Move all the build config stuff into a etc/ in the project, no .anything/?
It's very flexible and widely accepted. It's just not accepted _enough_ to be annoying.
There are other top level files which I’d want to include if I were the one designing this, many of which are just text/reference, all of which are inherently meta content relative to their containing project. It may well even be worth nesting sub-category directories below .meta, eg .meta/config or even .meta/config/{checks,env,…}. I’m sure some would consider any/all of this overkill, but the current status quo of top-level junk is certainly no better than a tree with well defined and well named branches.
I'm sad that we got away from that standard. It was nice when I could just back up /etc and be good to go.
(Of course this is looking with rose colored glasses, we never had 100% adherence to the standard, which is how we got to where we are).
/etc stores system configuration (like the local timezone). They have a very different purpose.
If you want config files in one place, at least on Unix-like systems, the Free Desktop Spec recommends that config files be in $XDG_CONFIG_HOME which by default is $HOME/.config - see: https://specifications.freedesktop.org/basedir-spec/basedir-...
For a while I was dumping stuff into .config but I eventually tired of struggling even more with various tool chains.
Also, what about .idea/.vscode and related IDE stuff? Those I would definitely consider "metadata".
Would X/.meta/.dockerignore work the same as X/.dockerignore ? As in relative to the root as if .meta was not there?
Not sure I agree with docker-compose.yml being there, but not really opposed to it either. What about Makefile or CMakeList.txt?
~/.config and ~/.local already exist for that purpose: applications should read and store configuration in ~/.config, use ~/.local/share for data, and install binaries to ~/.local/bin.
For unix-like systems like Linux at least, for Windows there is the AppData directory with the same function.
The term also has a meaning that "an area ... used for a special purpose". As you may use your back "yard" tidying your households from time to time, it is quite aligned with the idea of .meta directory - tidying things up?
As an excuse to try mapping out a debate in some depth, I set up a Discussion, “Should software projects adopt a standard subdirectory for files for configuration, tools, & metadata?”[1] on kialo.com, that others can explore or add to.
[1]: https://www.kialo.com/should-software-projects-adopt-a-stand...
Prediction: Once we have AI in between everything all these config files will disappear.
I don't see why you shouldn't integrate it into your project configuration instead of pretending that _'this is fine'_ and hiding all of it in a directory.
also: <https://xkcd.com/927>
This already exists. Why you are reinventing the wheel again?!?
A lot of programs already implement the XDG Base Directory Specification[1], putting the configuration in the .config directory. These programs should just follow the ALREADY EXISTING specification.
If you want to understand it, the arch wiki[2] have a good explanation about all the directories.
[1] https://specifications.freedesktop.org/basedir-spec/basedir-... [2] https://wiki.archlinux.org/title/XDG_Base_Directory
https://dotmeta.org, note projects
This site exists to advocate that software libraries look for their config files in .meta directories of projects.
This is avoid making a mess in the root directory of projects, as this tweet laments.
https://specifications.freedesktop.org/basedir-spec/basedir-..., note users ## Basics
The XDG Base Directory Specification is based on the following concepts:
- There is a single base directory relative to which user-specific data files should be written. This directory is defined by the environment variable $XDG_DATA_HOME.