@sheplu/editorconfig 0.8.1 → 0.8.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 +22 -13
- package/package.json +10 -3
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ This CLI aims to provide a **single source of truth** for your preferred `.edito
|
|
|
22
22
|
You can use it **without installing**, via `npx`:
|
|
23
23
|
|
|
24
24
|
```bash
|
|
25
|
-
npx @sheplu/editorconfig
|
|
25
|
+
npx @sheplu/editorconfig --mode=write
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
Or install it globally:
|
|
@@ -43,7 +43,7 @@ npm install -D @sheplu/editorconfig
|
|
|
43
43
|
From the root of your project:
|
|
44
44
|
|
|
45
45
|
```bash
|
|
46
|
-
npx @sheplu/editorconfig
|
|
46
|
+
npx @sheplu/editorconfig --mode=write
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
This will:
|
|
@@ -54,10 +54,10 @@ This will:
|
|
|
54
54
|
|
|
55
55
|
## Current Features
|
|
56
56
|
|
|
57
|
-
### `
|
|
57
|
+
### `write`
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
|
-
npx @sheplu/editorconfig
|
|
60
|
+
npx @sheplu/editorconfig --mode=write
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
Creates a base `.editorconfig` file in the current directory.
|
|
@@ -80,29 +80,38 @@ quote_type = single
|
|
|
80
80
|
spaces_around_operators = true
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
### 1. Check current `.editorconfig`
|
|
83
|
+
### `check`
|
|
86
84
|
|
|
87
85
|
```bash
|
|
88
|
-
npx @sheplu/editorconfig check
|
|
86
|
+
npx @sheplu/editorconfig --mode=check
|
|
89
87
|
```
|
|
90
88
|
|
|
91
|
-
|
|
89
|
+
Validates your existing `.editorconfig` and reports any drift from the target configuration.
|
|
90
|
+
|
|
91
|
+
This command will:
|
|
92
|
+
|
|
93
|
+
- Read your existing .editorconfig
|
|
94
|
+
- Compare it against the tool’s canonical template
|
|
95
|
+
- Exit with:
|
|
96
|
+
- `0` if everything matches
|
|
97
|
+
- `1` if differences are found
|
|
98
|
+
|
|
99
|
+
## Planned / Upcoming Features
|
|
100
|
+
|
|
101
|
+
### 1. Interactive update / replace
|
|
92
102
|
|
|
93
103
|
```bash
|
|
94
|
-
npx @sheplu/editorconfig fix
|
|
104
|
+
npx @sheplu/editorconfig --mode=fix
|
|
95
105
|
```
|
|
96
106
|
|
|
97
|
-
###
|
|
107
|
+
### 2. Compare with target setup
|
|
98
108
|
|
|
99
109
|
```bash
|
|
100
|
-
npx @sheplu/editorconfig diff
|
|
110
|
+
npx @sheplu/editorconfig --mode=diff
|
|
101
111
|
```
|
|
102
112
|
|
|
103
113
|
## Roadmap
|
|
104
114
|
|
|
105
|
-
- [ ] Add `check` command
|
|
106
115
|
- [ ] Add diff logic and `diff` command
|
|
107
116
|
- [ ] Add interactive `fix` / `update` command
|
|
108
117
|
- [ ] Expose presets or configuration options
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sheplu/editorconfig",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -13,8 +13,15 @@
|
|
|
13
13
|
"type": "git",
|
|
14
14
|
"url": "git+https://github.com/sheplu/editorconfig.git"
|
|
15
15
|
},
|
|
16
|
-
"keywords": [
|
|
17
|
-
|
|
16
|
+
"keywords": [
|
|
17
|
+
"editorconfig",
|
|
18
|
+
"cli",
|
|
19
|
+
"config",
|
|
20
|
+
"code-style",
|
|
21
|
+
"formatting",
|
|
22
|
+
"generator"
|
|
23
|
+
],
|
|
24
|
+
"author": "Jean Burellier",
|
|
18
25
|
"license": "MIT",
|
|
19
26
|
"type": "module",
|
|
20
27
|
"bugs": {
|