-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathindex.html
More file actions
388 lines (372 loc) · 14.6 KB
/
index.html
File metadata and controls
388 lines (372 loc) · 14.6 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>editorconfig-checker</title>
<link rel="stylesheet" href="/index.css" type="text/css" media="all" />
<link rel="stylesheet" href="/style.css" type="text/css" media="all" />
<link
rel="apple-touch-icon"
sizes="57x57"
href="favicons/apple-icon-57x57.png"
/>
<link
rel="apple-touch-icon"
sizes="60x60"
href="favicons/apple-icon-60x60.png"
/>
<link
rel="apple-touch-icon"
sizes="72x72"
href="favicons/apple-icon-72x72.png"
/>
<link
rel="apple-touch-icon"
sizes="76x76"
href="favicons/apple-icon-76x76.png"
/>
<link
rel="apple-touch-icon"
sizes="114x114"
href="favicons/apple-icon-114x114.png"
/>
<link
rel="apple-touch-icon"
sizes="120x120"
href="favicons/apple-icon-120x120.png"
/>
<link
rel="apple-touch-icon"
sizes="144x144"
href="favicons/apple-icon-144x144.png"
/>
<link
rel="apple-touch-icon"
sizes="152x152"
href="favicons/apple-icon-152x152.png"
/>
<link
rel="apple-touch-icon"
sizes="180x180"
href="favicons/apple-icon-180x180.png"
/>
<link
rel="icon"
type="image/png"
sizes="192x192"
href="favicons/android-icon-192x192.png"
/>
<link
rel="icon"
type="image/png"
sizes="32x32"
href="faviconsfavicon-32x32.png"
/>
<link
rel="icon"
type="image/png"
sizes="96x96"
href="faviconsfavicon-96x96.png"
/>
<link
rel="icon"
type="image/png"
sizes="16x16"
href="faviconsfavicon-16x16.png"
/>
<meta name="msapplication-TileColor" content="#ffffff" />
<meta
name="msapplication-TileImage"
content="favicons/ms-icon-144x144.png"
/>
<meta name="theme-color" content="#ffffff" />
</head>
<body>
<div class="App">
<header class="App-header">
<a
href="https://github.com/editorconfig-checker"
target="_blank"
rel="noopener noreferrer"
>
<img class="logo" src="/logo.png" alt="logo" />
</a>
</header>
<main class="Main">
<h1>Editorconfig-Checker</h1>
<h2>What is this about?</h2>
<p>
An editorconfig is a defintion how your files should be formatted.
Compared to other linting tools this tool is language agnostic and
works for every language and every major editor out there has a plugin
to read the editorconfig. However, there are no good linting tools out
there, so I decided to write my own and this is the result. If you
want to know more about editorconfig have a look here:
<a
href="https://editorconfig.org/"
target="_blank"
rel="noopener noreferrer"
>
https://editorconfig.org
</a>
</p>
<h2>For whom is this useful?</h2>
<p>
This is especially useful if you have more than one filetype in your
codebase. Often there are linting tools for every language, but
nothing that compares every file with a certain defintion. You may
also have files which don't have a linting tool like configuration
files, plain text files with no associated programming language, bash
scripts, xml, or something else. In order to maintain a certain
formatting and enforce this via linting this is for you.
</p>
<h2>How to use this?</h2>
<ol>
<li><a href="#plain">Plain</a></li>
<li><a href="#javascript">JavaScript</a></li>
<li><a href="#php">PHP</a></li>
<li><a href="#python">Python</a></li>
<li><a href="#docker">docker</a></li>
<li><a href="#arch-linux">Arch Linux</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#support">Support</a></li>
</ol>
<h3 id="plain">Plain</h3>
<small>
<a
href="https://github.com/editorconfig-checker/editorconfig-checker/releases"
rel="noopener noreferrer"
target="_blank"
>releases</a
>
</small>
<p>
Head over to the
<a
href="https://github.com/editorconfig-checker/editorconfig-checker/releases"
rel="noopener noreferrer"
target="_blank"
>
release page</a
>, grab the binary which fits your operating system and architecture,
extract it and simply run the binary found in the
<code>bin</code> directory.
</p>
<h3 id="javascript">JavaScript</h3>
<small>
<a
href="https://www.npmjs.com/package/editorconfig-checker"
rel="noopener noreferrer"
target="_blank"
>npm</a
>
|
<a
href="https://github.com/editorconfig-checker/editorconfig-checker.javascript"
rel="noopener noreferrer"
target="_blank"
>github</a
>
</small>
<code>npm install --save-dev editorconfig-checker</code>
<p>
This provides two binaries called <code>ec</code> and
<code>editorconfig-checker</code> which you can call via
<code>./node_modules/.bin/ec</code>,
<code>./node_modules/.bin/editorconfig-checker</code> or inside your
<code>package.json</code> via <code>ec</code> or
<code>editorconfig-checker</code>.
</p>
<h3 id="php">PHP</h3>
<small>
<a
href="https://packagist.org/packages/editorconfig-checker/editorconfig-checker"
rel="noopener noreferrer"
target="_blank"
>packagist</a
>
|
<a
href="https://github.com/editorconfig-checker/editorconfig-checker.php"
rel="noopener noreferrer"
target="_blank"
>github</a
>
</small>
<code>composer require --dev editorconfig-checker</code>
<p>
This provides two binaries called <code>ec</code> and
<code>editorconfig-checker</code> which you can call via
<code>./vendor/bin/ec</code>,
<code>./vendor/bin/editorconfig-checker</code> or inside your
<code>composer.json</code> via <code>ec</code> or
<code>editorconfig-checker</code>.
</p>
<h3 id="python">Python</h3>
<small>
<a
href="https://pypi.org/project/editorconfig-checker/"
rel="noopener noreferrer"
target="_blank"
>pypi</a
>
|
<a
href="https://github.com/editorconfig-checker/editorconfig-checker.python"
rel="noopener noreferrer"
target="_blank"
>github</a
>
</small>
<code>
pip install editorconfig-checker
</code>
<h3 id="docker">Docker</h3>
<small>
<a
href="https://hub.docker.com/r/mstruebing/editorconfig-checker"
rel="noopener noreferrer"
target="_blank"
>dockerhub</a
>
</small>
<code>
docker run --rm --volume=$PWD:/check mstruebing/editorconfig-checker
</code>
<h3 id="arch-linux">Arch Linux</h3>
<small>
<a
href="https://archlinux.org/packages/extra/x86_64/editorconfig-checker/"
rel="noopener noreferrer"
target="_blank"
>package</a
>
</small>
<code>pacman -S editorconfig-checker</code>
<p>Or build it yourself</p>
<pre>
git clone https://aur.archlinux.org/editorconfig-checker-git.git && \
cd editorconfig-checker-git && \
makepkg -si</pre
>
<h2 id="configuration">Configuration</h2>
<p>
There are a bunch of command line flags you can use, but there is also
a configuration file which you can use in your current working
directory called <code>.editorconfig-checker.json</code> or
<code>.ecrc</code> (deprecated). If you want to use a different config
you can pass the <code>-config <path></code>-flag to the binary.
You can generate a configuration with the <code>init</code>-flag. A
sample configuration file can look like this:
</p>
<pre>
{
"Verbose": false,
"Debug": false,
"IgnoreDefaults": false,
"SpacesAftertabs": false,
"NoColor": false,
"Exclude": [],
"AllowedContentTypes": [],
"PassedFiles": [],
"Disable": {
"EndOfLine": false,
"Indentation": false,
"InsertFinalNewline": false,
"TrimTrailingWhitespace": false
}
}</pre
>
<h2 id="support">Support</h2>
<h3>Github Issues</h3>
<p>
In order to get help with problems, feature requests or anything else
you can use Github issues. Please try to use the correct repository,
the main repository where most development is done is this one:
<a
href="https://github.com/editorconfig-checker/editorconfig-checker"
rel="noopener noreferrer"
target="_blank"
>editorconfig-cheker/editorconfig-checker</a
>. If you have issues for a specific language client, which are in
fact only wrappers of the main binary, you can of course open an issue
there - and don't worry, if you use the wrong repository it is not a
big problem. :)
</p>
<h3>IRC</h3>
<p>
Believe it or not, I'm still an active user of IRC. If you want you
can reach me there on freenode in <code>#editorconfig-checker</code>.
If you don't have an IRC-client set up you can use this web-client
<a
href="https://webchat.freenode.net/?channels=editorconfig-checker"
rel="noopener noreferrer"
target="_blank"
>freenode webchat</a
>.
</p>
</main>
<footer>
<ul>
<li>
<a
href="https://twitter.com/mxstrbng"
rel="noopener noreferrer"
target="_blank"
>
<svg viewBox="0 0 430 430" class="jsx-924075221">
<path
d="M381.384,198.639c24.157,-1.993 40.543,-12.975 46.849,-27.876c-8.714,5.353 -35.764,11.189 -50.703,5.631c-0.732,-3.51 -1.55,-6.844 -2.353,-9.854c-11.383,-41.798 -50.357,-75.472 -91.194,-71.404c3.304,-1.334 6.655,-2.576 9.996,-3.691c4.495,-1.61 30.868,-5.901 26.715,-15.21c-3.5,-8.188 -35.722,6.188 -41.789,8.067c8.009,-3.012 21.254,-8.193 22.673,-17.396c-12.27,1.683 -24.315,7.484 -33.622,15.919c3.36,-3.617 5.909,-8.025 6.45,-12.769c-32.726,20.907 -51.843,63.057 -67.314,103.944c-12.148,-11.773 -22.915,-21.044 -32.574,-26.192c-27.097,-14.531 -59.496,-29.692 -110.355,-48.572c-1.561,16.827 8.322,39.201 36.8,54.08c-6.17,-0.826 -17.453,1.017 -26.477,3.178c3.675,19.277 15.677,35.159 48.169,42.839c-14.849,0.98 -22.523,4.359 -29.478,11.642c6.763,13.407 23.266,29.186 52.953,25.947c-33.006,14.226 -13.458,40.571 13.399,36.642c-45.816,47.323 -118.05,43.845 -159.529,4.264c108.299,147.572 343.716,87.274 378.799,-54.866c26.285,0.224 41.737,-9.105 51.318,-19.39c-15.144,2.57 -37.094,-0.086 -48.733,-4.933Z"
class="jsx-924075221"
/>
</svg>
</a>
</li>
<li>
<a
href="https://github.com/mstruebing"
rel="noopener noreferrer"
target="_blank"
>
<svg viewBox="0 0 1024 1024" class="jsx-924075221">
<path
d="M512 0C229.25 0 0 229.25 0 512c0 226.25 146.688 418.125 350.156 485.812 25.594 4.688 34.938-11.125 34.938-24.625 0-12.188-0.469-52.562-0.719-95.312C242 908.812 211.906 817.5 211.906 817.5c-23.312-59.125-56.844-74.875-56.844-74.875-46.531-31.75 3.53-31.125 3.53-31.125 51.406 3.562 78.47 52.75 78.47 52.75 45.688 78.25 119.875 55.625 149 42.5 4.654-33 17.904-55.625 32.5-68.375C304.906 725.438 185.344 681.5 185.344 485.312c0-55.938 19.969-101.562 52.656-137.406-5.219-13-22.844-65.094 5.062-135.562 0 0 42.938-13.75 140.812 52.5 40.812-11.406 84.594-17.031 128.125-17.219 43.5 0.188 87.312 5.875 128.188 17.281 97.688-66.312 140.688-52.5 140.688-52.5 28 70.531 10.375 122.562 5.125 135.5 32.812 35.844 52.625 81.469 52.625 137.406 0 196.688-119.75 240-233.812 252.688 18.438 15.875 34.75 47 34.75 94.75 0 68.438-0.688 123.625-0.688 140.5 0 13.625 9.312 29.562 35.25 24.562C877.438 930 1024 738.125 1024 512 1024 229.25 794.75 0 512 0z"
class="jsx-924075221"
/>
</svg>
</a>
</li>
<li>
<a
href="https://www.xing.com/profile/Max_Struebing2?sc_o=mxb_p"
rel="noopener noreferrer"
target="_blank"
>
<svg viewBox="0 0 2048 2048" class="jsx-924075221">
<path
d="M917 795q-10 18-257 456-27 46-65 46h-239q-21 0-31-17t0-36l253-448q1 0 0-1l-161-279q-12-22-1-37 9-15 32-15h239q40 0 66 45zm806-642q11 16 0 37l-528 934v1l336 615q11 20 1 37-10 15-32 15h-239q-42 0-66-45l-339-622q18-32 531-942 25-45 64-45h241q22 0 31 15z"
class="jsx-924075221"
/>
</svg>
</a>
</li>
<li>
<a
href="https://www.linkedin.com/in/max-str%C3%BCbing-131165131/"
rel="noopener noreferrer"
target="_blank"
>
<svg viewBox="0 0 54 54" class="jsx-924075221">
<path
d="M48.1,12.9v26.8c0,2.2-0.8,4.1-2.4,5.7c-1.6,1.6-3.5,2.4-5.7,2.4H13.3c-2.2,0-4.1-0.8-5.7-2.4c-1.6-1.6-2.4-3.5-2.4-5.7 V12.9c0-2.2,0.8-4.1,2.4-5.7c1.6-1.6,3.5-2.4,5.7-2.4H40c2.2,0,4.1,0.8,5.7,2.4C47.3,8.8,48.1,10.7,48.1,12.9z M18.7,15.4 c0-1-0.4-1.8-1-2.4C17,12.3,16.2,12,15.1,12c-1.1,0-2,0.3-2.6,0.9c-0.7,0.6-1,1.4-1,2.4c0,0.9,0.3,1.7,1,2.4c0.7,0.6,1.5,1,2.6,1h0 c1.1,0,2-0.3,2.7-1C18.4,17.1,18.7,16.3,18.7,15.4z M11.8,40.7h6.4V21.3h-6.4V40.7z M35,40.7h6.4V29.6c0-2.9-0.7-5-2-6.5 c-1.4-1.5-3.2-2.2-5.4-2.2c-2.5,0-4.5,1.1-5.8,3.3h0.1v-2.8h-6.4c0.1,1.2,0.1,7.7,0,19.4h6.4V29.9c0-0.7,0.1-1.2,0.2-1.6 c0.3-0.7,0.7-1.2,1.3-1.7c0.6-0.5,1.2-0.7,2.1-0.7c2.2,0,3.2,1.5,3.2,4.4V40.7z"
class="jsx-924075221"
/>
</svg>
</a>
</li>
</ul>
</footer>
</div>
</body>
</html>