@zthun/janitor-lint 19.5.2 → 19.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -23
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
# Janitor Lint
|
|
2
2
|
|
|
3
|
-
Code gets messy. Most places you work will have a long backlog of tech-debt
|
|
4
|
-
that never quite get addressed, and over time this becomes a maintenance
|
|
5
|
-
Fixing old problems is expensive, and companies tend to focus on
|
|
6
|
-
which means these issues often stay unresolved. New features
|
|
7
|
-
messy foundations, and the software slowly begins to rot.
|
|
3
|
+
Code gets messy. Most places you work will have a long backlog of tech-debt
|
|
4
|
+
tasks that never quite get addressed, and over time this becomes a maintenance
|
|
5
|
+
nightmare. Fixing old problems is expensive, and companies tend to focus on
|
|
6
|
+
short-term ROI — which means these issues often stay unresolved. New features
|
|
7
|
+
get built on top of messy foundations, and the software slowly begins to rot.
|
|
8
8
|
|
|
9
9
|
A common way to fight this is to start with linters. Linters scan your codebase
|
|
10
|
-
and notify you of issues. In a healthy development pipeline, they prevent
|
|
11
|
-
from creating a metaphorical messy room and encourage clean,
|
|
12
|
-
the team. They’re not a silver bullet — messy solutions
|
|
13
|
-
linters eliminate most inconsistent patterns and
|
|
14
|
-
love them because they keep everyone aligned.
|
|
10
|
+
and notify you of issues. In a healthy development pipeline, they prevent
|
|
11
|
+
developers from creating a metaphorical messy room and encourage clean,
|
|
12
|
+
consistent code across the team. They’re not a silver bullet — messy solutions
|
|
13
|
+
can still appear — but linters eliminate most inconsistent patterns and
|
|
14
|
+
formatting errors. Good developers love them because they keep everyone aligned.
|
|
15
15
|
|
|
16
16
|
However, linters come with their own problems. There are so many of them. Each
|
|
17
17
|
has its own configuration style, quirks, and ecosystem. To cover your full
|
|
18
|
-
codebase, you often need multiple tools: ones for code quality, formatting,
|
|
19
|
-
applications, and more. It’s easy to feel overwhelmed, and maintaining
|
|
20
|
-
linters becomes its own form of tech debt.
|
|
18
|
+
codebase, you often need multiple tools: ones for code quality, formatting,
|
|
19
|
+
spelling, applications, and more. It’s easy to feel overwhelmed, and maintaining
|
|
20
|
+
a stack of linters becomes its own form of tech debt.
|
|
21
21
|
|
|
22
22
|
Janitor Lint was created with the belief that there is beauty in simplicity. A
|
|
23
|
-
single tool that handles your linting needs is far better than stitching
|
|
24
|
-
a pile of utilities, each with its own configuration and upkeep. Let
|
|
25
|
-
Lint take on the heavy lifting so you can keep your codebase clean — and
|
|
26
|
-
developers happy.
|
|
23
|
+
single tool that handles your linting needs is far better than stitching
|
|
24
|
+
together a pile of utilities, each with its own configuration and upkeep. Let
|
|
25
|
+
Janitor Lint take on the heavy lifting so you can keep your codebase clean — and
|
|
26
|
+
your developers happy.
|
|
27
27
|
|
|
28
28
|
## Install
|
|
29
29
|
|
|
@@ -39,17 +39,17 @@ yarn add -D @zthun/janitor-lint-config
|
|
|
39
39
|
janitor-lint
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
- `--config` is optional. Without it, the CLI searches for a `janitor`
|
|
43
|
-
|
|
42
|
+
- `--config` is optional. Without it, the CLI searches for a `janitor` config
|
|
43
|
+
using cosmiconfig (in order: `package.json#janitor`, `janitorrc`,
|
|
44
44
|
`janitorrc.json`, `janitorrc.yaml|yml`, `janitorrc.mjs`).
|
|
45
45
|
- Exit code is `0` when every enabled linter passes and `1` when any fail.
|
|
46
46
|
|
|
47
47
|
## Configuration shape
|
|
48
48
|
|
|
49
|
-
Janitor Lint reads a `janitor` options config object with a `lint` section.
|
|
50
|
-
field is optional—only the linters you configure will run. You can
|
|
51
|
-
manually, OR you can use the package, @zthun/janitor-options, to
|
|
52
|
-
configuration.
|
|
49
|
+
Janitor Lint reads a `janitor` options config object with a `lint` section.
|
|
50
|
+
Every field is optional—only the linters you configure will run. You can
|
|
51
|
+
configure this manually, OR you can use the package, @zthun/janitor-options, to
|
|
52
|
+
just build a configuration.
|
|
53
53
|
|
|
54
54
|
```ts
|
|
55
55
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zthun/janitor-lint",
|
|
3
|
-
"version": "19.5.
|
|
3
|
+
"version": "19.5.3",
|
|
4
4
|
"description": "Style checks with tools for web projects using common rules.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"linters"
|
|
@@ -33,29 +33,29 @@
|
|
|
33
33
|
},
|
|
34
34
|
"author": "Anthony Bonta",
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@zthun/janitor-options": "^19.5.
|
|
36
|
+
"@zthun/janitor-options": "^19.5.3",
|
|
37
37
|
"chalk": "^5.6.2",
|
|
38
38
|
"cosmiconfig": "^9.0.0",
|
|
39
|
-
"cspell": "^9.
|
|
40
|
-
"eslint": "^9.39.
|
|
39
|
+
"cspell": "^9.4.0",
|
|
40
|
+
"eslint": "^9.39.2",
|
|
41
41
|
"glob": "^13.0.0",
|
|
42
|
-
"htmlhint": "^1.
|
|
42
|
+
"htmlhint": "^1.8.0",
|
|
43
43
|
"js-yaml": "^4.1.1",
|
|
44
44
|
"lodash-es": "^4.17.21",
|
|
45
|
-
"markdownlint": "~0.
|
|
46
|
-
"prettier": "^3.
|
|
47
|
-
"stylelint": "^16.26.
|
|
45
|
+
"markdownlint": "~0.40.0",
|
|
46
|
+
"prettier": "^3.7.4",
|
|
47
|
+
"stylelint": "^16.26.1",
|
|
48
48
|
"yargs": "^18.0.0"
|
|
49
49
|
},
|
|
50
50
|
"files": [
|
|
51
51
|
"dist"
|
|
52
52
|
],
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@zthun/janitor-build-config": "^19.5.
|
|
54
|
+
"@zthun/janitor-build-config": "^19.5.3",
|
|
55
55
|
"typescript": "~5.9.3",
|
|
56
|
-
"vite": "^7.2.
|
|
57
|
-
"vitest": "^4.0.
|
|
56
|
+
"vite": "^7.2.7",
|
|
57
|
+
"vitest": "^4.0.15",
|
|
58
58
|
"vitest-mock-extended": "^3.1.0"
|
|
59
59
|
},
|
|
60
|
-
"gitHead": "
|
|
60
|
+
"gitHead": "0346801ebb985f75ab3d5faeb8677e6c6a14d9b2"
|
|
61
61
|
}
|