-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathindex.html
More file actions
66 lines (57 loc) · 1.79 KB
/
index.html
File metadata and controls
66 lines (57 loc) · 1.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@picocss/pico@1/css/pico.min.css">
</head>
<body>
<main class="container">
<h1>The <code>.meta</code> Directory: Let's Tidy Things Up 🧹🧹🧹</h1>
<p>
This site exists to advocate that software libraries look for their config files in <code>.meta</code> directories of
projects.
</p>
<p>
This is avoid making a mess in the root directory of projects, as <a href="https://twitter.com/WarrenInTheBuff/status/1672839156647575552">this tweet</a> laments.
</p>
<p>
If the <code>.meta</code> directory convention was adopted widely, then the following set of files in the root of
a project:
</p>
<pre>
/package.json
/tsconfig.json
/.eslintrc
/.prettierrc
/.babel.config.js (implied child .babelrc)
/.webpack.config.js
/jest.config.js
/.env
/docker-compose.yml
/gitlab-ci.yml
/.npmrc
/.editorconfig
</pre>
<p>
Could instead all be moved into a single top level <code>.meta</code> directory:
</p>
<pre>
/.meta
</pre>
<p>
Nice & tidy.
</p>
<h2>Implementation</h2>
<p>
To implement the <code>.meta</code> standard, a tool looking for its configuration file in directory <code>X</code>
and failing to find it should next look in directory <code>X/.meta</code>, if it exists, for that same file.
</p>
<p>
No other constraint on config file resolution or ordering is placed on a tool.
</p>
<h2><code>.meta</code> respectors</h2>
<ul>
<li>Be the first project to become a <code>.meta</code> respector!</li>
</ul>
</main>
</body>
</html>