@pieceful/ravel-host-node 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.
Files changed (2) hide show
  1. package/README.md +23 -0
  2. package/package.json +6 -6
package/README.md ADDED
@@ -0,0 +1,23 @@
1
+ # @pieceful/ravel-host-node
2
+
3
+ The Node.js host for Ravel projects. It loads Markdown, JSON Ravel Maps, and
4
+ TOML project configuration; confines project filesystem access; and safely
5
+ writes planned deliverables, manifests, provenance maps, cleanups, and backups.
6
+
7
+ ```sh
8
+ npm install @pieceful/ravel-host-node
9
+ ```
10
+
11
+ Use `loadBuildInput` to load a project and `writeBuildArtifacts` to write a
12
+ completed program, or use the higher-level `@pieceful/ravel` CLI. Inputs and
13
+ outputs are contained beneath an explicit project root; path escapes and
14
+ symlink traversal are rejected.
15
+
16
+ Requires Node.js 22 or newer. This package is intentionally Node-specific;
17
+ browser and Bun hosts should supply their own I/O boundary around
18
+ `@pieceful/ravel-core`.
19
+
20
+ See the [Ravel documentation](https://ravel.jostylr.com/) for TOML configuration,
21
+ filesystem safety, manifests, cleanup, and backup behavior.
22
+
23
+ MIT © James Taylor
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@pieceful/ravel-host-node",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "description": "Node host capabilities for Ravel.",
6
6
  "license": "MIT",
7
7
  "author": "James Taylor",
8
8
  "repository": { "type": "git", "url": "git+https://github.com/jostylr/ravel.git", "directory": "packages/host-node" },
9
9
  "bugs": { "url": "https://github.com/jostylr/ravel/issues" },
10
- "homepage": "https://github.com/jostylr/ravel#readme",
10
+ "homepage": "https://ravel.jostylr.com/",
11
11
  "engines": { "node": ">=22" },
12
12
  "keywords": ["ravel", "literate-programming", "node", "build"],
13
13
  "publishConfig": { "access": "public" },
@@ -15,11 +15,11 @@
15
15
  ".": "./src/index.js"
16
16
  },
17
17
  "types": "./src/index.d.ts",
18
- "files": ["src", "LICENSE"],
18
+ "files": ["src", "README.md", "LICENSE"],
19
19
  "dependencies": {
20
- "@pieceful/ravel-core": "0.1.0",
21
- "@pieceful/ravel-markdown": "0.1.0",
22
- "@pieceful/ravel-map": "0.1.0",
20
+ "@pieceful/ravel-core": "0.1.1",
21
+ "@pieceful/ravel-markdown": "0.1.1",
22
+ "@pieceful/ravel-map": "0.1.1",
23
23
  "smol-toml": "^1.7.0"
24
24
  }
25
25
  }