jsonc-effect 0.1.0
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/LICENSE +21 -0
- package/README.md +49 -0
- package/index.d.ts +751 -0
- package/index.js +1424 -0
- package/package.json +58 -0
- package/tsdoc-metadata.json +11 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 C. Spencer Beggs
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# jsonc-effect
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/jsonc-effect)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](https://www.typescriptlang.org/)
|
|
6
|
+
|
|
7
|
+
Pure [Effect](https://effect.website) JSONC (JSON with Comments) parser with no external parser dependencies. Scanner, parser, AST, and formatting are all implemented natively.
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- **Effect-native** -- typed errors, Schema integration, and composable pipelines
|
|
12
|
+
- **Zero parser dependencies** -- `effect` is the sole runtime dependency
|
|
13
|
+
- **Schema integration** -- parse JSONC strings directly into validated types
|
|
14
|
+
- **Full toolchain** -- scanner, parser, AST navigation, visitor stream, formatting, and modification
|
|
15
|
+
- **Safe by default** -- returns `unknown` (not `any`) and `Option` (not `undefined`)
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install jsonc-effect effect
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Quick Start
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { parse } from "jsonc-effect"
|
|
27
|
+
import { Effect } from "effect"
|
|
28
|
+
|
|
29
|
+
const result = Effect.runSync(
|
|
30
|
+
parse('{ "key": 42, /* comment */ }')
|
|
31
|
+
)
|
|
32
|
+
// => { key: 42 }
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## FAQ
|
|
36
|
+
|
|
37
|
+
### Why does this module exist?
|
|
38
|
+
|
|
39
|
+
If you just need to parse JSONC into a JavaScript object, use [jsonc-parser](https://github.com/microsoft/node-jsonc-parser) or [Bun's native JSONC support](https://bun.sh/docs/api/utils#bunfile-json). They are faster and have no dependencies.
|
|
40
|
+
|
|
41
|
+
This library is for Effect-based programs that need deeper introspection and editing of JSONC documents: typed parse errors you can `catchTag`, Schema pipelines that validate JSONC strings into domain types, AST navigation, document modification and SAX-style visitor streams that are composable in Effect pipelines.
|
|
42
|
+
|
|
43
|
+
## Documentation
|
|
44
|
+
|
|
45
|
+
For API reference, advanced usage, and examples, see [docs](./docs/README.md).
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
[MIT](./LICENSE)
|