@procedures/fs 0.1.0 → 0.2.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/CHANGELOG.md +27 -0
- package/README.md +8 -11
- package/dist/.tsbuildinfo +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/module.d.ts +7 -1
- package/dist/module.d.ts.map +1 -1
- package/dist/module.js +26 -1
- package/dist/module.js.map +1 -1
- package/dist/register.d.ts +3 -4
- package/dist/register.d.ts.map +1 -1
- package/dist/register.js +4 -9
- package/dist/register.js.map +1 -1
- package/package.json +6 -3
- package/src/index.ts +1 -1
- package/src/module.ts +28 -1
- package/src/register.ts +4 -10
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,32 @@
|
|
|
1
1
|
# @procedures/fs
|
|
2
2
|
|
|
3
|
+
## 0.2.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [a9dc8c8]
|
|
8
|
+
- @procedures/client@0.2.1
|
|
9
|
+
|
|
10
|
+
## 0.2.0
|
|
11
|
+
|
|
12
|
+
### Minor Changes
|
|
13
|
+
|
|
14
|
+
- 76d0d64: **Breaking:** an import of a package registers nothing. The `./register` entry of a package registers its procedures, and the procedures of the modules that they need, in the global registry (ARCHITECTURE-PROPOSALS-2026-10, P9).
|
|
15
|
+
|
|
16
|
+
- `import "@procedures/git"` gives the exports and registers nothing. Use `import "@procedures/git/register"`, or give `gitModule` (`@procedures/git/module`) to `createRegistry()`.
|
|
17
|
+
- `import "@procedures/client/register"` registers the control flow (`client.chain` and the others) and `procedure.define`/`get`/`list`/`delete`. `createRegistry()` adds them to each new registry, as before. The new `registerClientProcedures(registry?)` does the same for any registry.
|
|
18
|
+
- Each `register<Name>Procedures(registry?)` function is in the module of its package, takes a registry (the global one by default) and registers the modules that the package requires. `registerBridge` (splay) and `register` (store) are now `registerSplayProcedures` and `registerStoreProcedures`. The old names stay for one version.
|
|
19
|
+
- `sideEffects` names only `./dist/register.js`, so a bundler can drop the rest of a package.
|
|
20
|
+
- The bundles require `clientModule`, so `@procedures/bundle-mcp/register` gives the whole tool surface.
|
|
21
|
+
- `lib new` makes `src/module.ts` and a root without side effects, and `procedure new` adds procedures to the module.
|
|
22
|
+
|
|
23
|
+
### Patch Changes
|
|
24
|
+
|
|
25
|
+
- Updated dependencies [0cf4bea]
|
|
26
|
+
- Updated dependencies [44d3e30]
|
|
27
|
+
- Updated dependencies [76d0d64]
|
|
28
|
+
- @procedures/client@0.2.0
|
|
29
|
+
|
|
3
30
|
## 0.1.0
|
|
4
31
|
|
|
5
32
|
The first release on npm. The packages of the client monorepo have one version together.
|
package/README.md
CHANGED
|
@@ -17,7 +17,7 @@ File system operations as RPC procedures. Read, write, copy, move, glob files an
|
|
|
17
17
|
- **JSON utilities**: Read and parse JSON files
|
|
18
18
|
- **Zod validation**: Runtime type safety on all inputs
|
|
19
19
|
|
|
20
|
-
The package
|
|
20
|
+
The package has 11 procedures. Its register entry (`import "@procedures/fs/register"`) registers them:
|
|
21
21
|
`fs.read`, `fs.write`, `fs.exists`, `fs.stat`, `fs.mkdir`, `fs.rm`, `fs.readdir`, `fs.copy`, `fs.move`, `fs.glob`, `fs.read.json`
|
|
22
22
|
|
|
23
23
|
## Architecture
|
|
@@ -96,13 +96,10 @@ graph LR
|
|
|
96
96
|
npm install @procedures/fs
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
Since 0.2.0, an import of the package registers nothing. To register its procedures in the global registry:
|
|
100
100
|
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
"@procedures/client": "github:mark1russell7/client#main",
|
|
104
|
-
"zod": "^3.24.0"
|
|
105
|
-
}
|
|
101
|
+
```ts
|
|
102
|
+
import "@procedures/fs/register";
|
|
106
103
|
```
|
|
107
104
|
|
|
108
105
|
## API Reference
|
|
@@ -548,7 +545,7 @@ console.log(pkg.name, pkg.version);
|
|
|
548
545
|
|
|
549
546
|
```typescript
|
|
550
547
|
import { Client, LocalTransport, PROCEDURE_REGISTRY } from "@procedures/client";
|
|
551
|
-
import "@procedures/fs"; // registers its procedures
|
|
548
|
+
import "@procedures/fs/register"; // registers its procedures
|
|
552
549
|
|
|
553
550
|
const client = new Client(new LocalTransport({ registry: PROCEDURE_REGISTRY }));
|
|
554
551
|
|
|
@@ -814,9 +811,9 @@ await client.exec(
|
|
|
814
811
|
|
|
815
812
|
```typescript
|
|
816
813
|
// In bundle-dev/src/register.ts
|
|
817
|
-
import "@procedures/fs"; // registers its procedures
|
|
818
|
-
import "@procedures/shell"; // registers its procedures
|
|
819
|
-
import "@procedures/cli-run"; // registers its procedures
|
|
814
|
+
import "@procedures/fs/register"; // registers its procedures
|
|
815
|
+
import "@procedures/shell/register"; // registers its procedures
|
|
816
|
+
import "@procedures/cli-run/register"; // registers its procedures
|
|
820
817
|
```
|
|
821
818
|
|
|
822
819
|
## Dependencies
|