@eslint-config-snapshot/cli 0.1.4 → 0.1.5

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/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @eslint-config-snapshot/cli
2
2
 
3
+ ## 0.1.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Add package-level README files for npm pages with cross-links between CLI and API docs.
8
+ - Updated dependencies
9
+ - @eslint-config-snapshot/api@0.1.5
10
+
3
11
  ## 0.1.4
4
12
 
5
13
  ### Patch Changes
package/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # @eslint-config-snapshot/cli
2
+
3
+ Deterministic ESLint config drift checker for workspaces.
4
+
5
+ `@eslint-config-snapshot/cli` snapshots effective ESLint rule state and reports drift after dependency or config changes.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm i -D @eslint-config-snapshot/cli
11
+ ```
12
+
13
+ Or run without install:
14
+
15
+ ```bash
16
+ npx @eslint-config-snapshot/cli@latest --update
17
+ ```
18
+
19
+ ## Quick Start
20
+
21
+ Create baseline:
22
+
23
+ ```bash
24
+ eslint-config-snapshot --update
25
+ ```
26
+
27
+ Check drift:
28
+
29
+ ```bash
30
+ eslint-config-snapshot
31
+ ```
32
+
33
+ ## Commands
34
+
35
+ - `check`
36
+ - `update`
37
+ - `print`
38
+ - `init`
39
+
40
+ Compatibility aliases:
41
+
42
+ - `snapshot` => `update`
43
+ - `compare` => `check --format diff`
44
+ - `status` => `check --format status`
45
+ - `what-changed` => `check --format summary`
46
+
47
+ ## Notes
48
+
49
+ - Node.js `>=20` required.
50
+ - If no config is found, built-in defaults are used.
51
+ - Snapshots are stored under `.eslint-config-snapshot/`.
52
+
53
+ ## Related Packages
54
+
55
+ - API engine: [`@eslint-config-snapshot/api`](https://www.npmjs.com/package/@eslint-config-snapshot/api)
56
+
57
+ ## More Docs
58
+
59
+ - Project overview and full guides: [root README](https://github.com/gabrielmoreira/eslint-config-snapshot#readme)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eslint-config-snapshot/cli",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
4
4
  "type": "module",
5
5
  "repository": {
6
6
  "type": "git",
@@ -29,6 +29,6 @@
29
29
  "dependencies": {
30
30
  "commander": "^14.0.3",
31
31
  "fast-glob": "^3.3.3",
32
- "@eslint-config-snapshot/api": "0.1.4"
32
+ "@eslint-config-snapshot/api": "0.1.5"
33
33
  }
34
34
  }