@metreeca/rack 0.2.0 → 0.3.0

package/dist/tool/index.d.ts

@@ -7,13 +7,18 @@
  * Every tool lists the paths it acts on to stdout, one per line, so that a script log shows what changed on disk. It
  * prints its usage with `--help`, and exits with a non-zero status after printing an error message to stderr.
  *
- * | Tool                       | Purpose                                                                     |
- * |----------------------------|-----------------------------------------------------------------------------|
- * | `cp <target> <pattern>...` | Copies files matching glob patterns into a directory, keeping their layout  |
- * | `ln [<deps>]...`           | Links dependencies to their local checkouts instead of registry releases    |
- * | `rm <pattern>...`          | Removes files and directories matching glob patterns, with their content    |
+ * | Command                               | Purpose                                                                  |
+ * |---------------------------------------|--------------------------------------------------------------------------|
+ * | {@link cp `cp <target> <pattern>...`} | Copies files matching glob patterns to a directory, keeping their layout |
+ * | {@link rm `rm <pattern>...`}          | Removes files and directories matching glob patterns, with their content |
+ * | {@link ln `ln [<deps>]...`}           | Links dependencies to their local checkouts instead of registry releases |
+ *
+ * Build scripts can call the same tools as functions, passing the command operands as arguments: a function throws on
+ * failure instead of printing an error message to stderr and setting a non-zero exit status for the process.
  *
  * @module
  */
-export {};
+export { cp } from "./cp.js";
+export { ln } from "./ln.js";
+export { rm } from "./rm.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/tool/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tool/index.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/tool/index.ts"],"names":[],"mappings":"AAgBA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC"}

package/dist/tool/index.js

@@ -13,5 +13,27 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+/**
+ * Unix-like command line tools for npm package scripts.
+ *
+ * Each tool is installed as a command alongside the package and behaves the same on every platform and shell. Inside
+ * npm scripts, these commands take precedence over system commands with the same name, such as the Unix `cp`.
+ *
+ * Every tool lists the paths it acts on to stdout, one per line, so that a script log shows what changed on disk. It
+ * prints its usage with `--help`, and exits with a non-zero status after printing an error message to stderr.
+ *
+ * | Command                               | Purpose                                                                  |
+ * |---------------------------------------|--------------------------------------------------------------------------|
+ * | {@link cp `cp <target> <pattern>...`} | Copies files matching glob patterns to a directory, keeping their layout |
+ * | {@link rm `rm <pattern>...`}          | Removes files and directories matching glob patterns, with their content |
+ * | {@link ln `ln [<deps>]...`}           | Links dependencies to their local checkouts instead of registry releases |
+ *
+ * Build scripts can call the same tools as functions, passing the command operands as arguments: a function throws on
+ * failure instead of printing an error message to stderr and setting a non-zero exit status for the process.
+ *
+ * @module
+ */
+export { cp } from "./cp.js";
+export { ln } from "./ln.js";
+export { rm } from "./rm.js";
 //# sourceMappingURL=index.js.map

package/dist/tool/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tool/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tool/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC"}

package/dist/tool/ln.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 /**
- * Links the local checkouts of the dependencies of the current package into its `node_modules`.
+ * Links the local checkouts of the dependencies of the package in the current folder into its `node_modules`.
  *
  * The current package, and in a monorepo each of its workspace members, then builds and runs against the working
  * trees of its dependencies instead of their registry releases. Dependencies are matched to checkouts by package name.

package/dist/tool/ln.js

@@ -22,7 +22,7 @@ if (import.meta.main) {
 }
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /**
- * Links the local checkouts of the dependencies of the current package into its `node_modules`.
+ * Links the local checkouts of the dependencies of the package in the current folder into its `node_modules`.
  *
  * The current package, and in a monorepo each of its workspace members, then builds and runs against the working
  * trees of its dependencies instead of their registry releases. Dependencies are matched to checkouts by package name.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metreeca/rack",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Everyday tooling for npm package development.",
   "keywords": [
     "typescript",
@@ -63,6 +63,11 @@
   "peerDependencies": {
     "vite": "^8.0.0"
   },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
   "allowScripts": {
     "fsevents": false
   }