@eslint-config-snapshot/api 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 +6 -0
- package/README.md +39 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# @eslint-config-snapshot/api
|
|
2
|
+
|
|
3
|
+
Core API for deterministic ESLint config snapshot extraction, grouping, diffing, and persistence.
|
|
4
|
+
|
|
5
|
+
This package powers the CLI and can be used directly for custom tooling.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm i @eslint-config-snapshot/api
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { compareSnapshots, computeSnapshots } from "@eslint-config-snapshot/api"
|
|
17
|
+
|
|
18
|
+
const current = await computeSnapshots({
|
|
19
|
+
rootDir: process.cwd(),
|
|
20
|
+
})
|
|
21
|
+
|
|
22
|
+
const diff = compareSnapshots(previous, current)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
See exported APIs in `dist/index.d.ts` for the complete surface.
|
|
26
|
+
|
|
27
|
+
## Notes
|
|
28
|
+
|
|
29
|
+
- Node.js `>=20` required.
|
|
30
|
+
- Output is deterministic and excludes volatile metadata.
|
|
31
|
+
- ESLint extraction is workspace-scoped.
|
|
32
|
+
|
|
33
|
+
## Related Packages
|
|
34
|
+
|
|
35
|
+
- End-user CLI: [`@eslint-config-snapshot/cli`](https://www.npmjs.com/package/@eslint-config-snapshot/cli)
|
|
36
|
+
|
|
37
|
+
## More Docs
|
|
38
|
+
|
|
39
|
+
- Project overview and behavior contract: [root README](https://github.com/gabrielmoreira/eslint-config-snapshot#readme)
|