@pieceful/ravel-core 0.1.0 → 0.1.1
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 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# @pieceful/ravel-core
|
|
2
|
+
|
|
3
|
+
The portable composition engine behind Ravel. It parses chunk references,
|
|
4
|
+
resolves the dependency graph, evaluates static composition, reports
|
|
5
|
+
source-linked diagnostics, and creates provenance maps for generated output.
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @pieceful/ravel-core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Use this package when embedding Ravel in a browser, Bun, Node, or another host.
|
|
12
|
+
It is native ESM and deliberately has no filesystem, process, shell, or network
|
|
13
|
+
capabilities. Pair it with an adapter such as `@pieceful/ravel-markdown` and a
|
|
14
|
+
host that supplies any I/O you need.
|
|
15
|
+
|
|
16
|
+
The documented public functions include `combineMaps`, `transformGraph`, and
|
|
17
|
+
the generated/source provenance query helpers. Requires Node.js 22 or newer
|
|
18
|
+
when used in Node.
|
|
19
|
+
|
|
20
|
+
See the [Ravel documentation](https://ravel.jostylr.com/) for the public API,
|
|
21
|
+
Ravel Map contract, chunk syntax, and provenance format.
|
|
22
|
+
|
|
23
|
+
MIT © James Taylor
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pieceful/ravel-core",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Ravel chunk syntax, resolution, graph evaluation, and diagnostics.",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"author": "James Taylor",
|
|
8
8
|
"repository": { "type": "git", "url": "git+https://github.com/jostylr/ravel.git", "directory": "packages/core" },
|
|
9
9
|
"bugs": { "url": "https://github.com/jostylr/ravel/issues" },
|
|
10
|
-
"homepage": "https://
|
|
10
|
+
"homepage": "https://ravel.jostylr.com/",
|
|
11
11
|
"engines": { "node": ">=22" },
|
|
12
12
|
"keywords": ["ravel", "literate-programming", "graph", "composition"],
|
|
13
13
|
"publishConfig": { "access": "public" },
|
|
@@ -16,5 +16,5 @@
|
|
|
16
16
|
"./directives": "./src/directives.js"
|
|
17
17
|
},
|
|
18
18
|
"types": "./src/index.d.ts",
|
|
19
|
-
"files": ["src", "LICENSE"]
|
|
19
|
+
"files": ["src", "README.md", "LICENSE"]
|
|
20
20
|
}
|