@muxion/dev-config 0.2.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/agents/repository.md +1 -1
- package/agents/rust-core.md +0 -1
- package/agents/rust-ffi.md +0 -3
- package/agents/rust.md +2 -0
- package/agents/typescript.md +1 -0
- package/dist/agents-check.js +1 -1
- package/dist/agents-check.js.map +1 -1
- package/package.json +1 -1
package/agents/repository.md
CHANGED
|
@@ -6,7 +6,7 @@ This layer adds to the engineering principles.
|
|
|
6
6
|
|
|
7
7
|
- Use npm 11 workspaces and commit `package-lock.json` in repositories that contain packages.
|
|
8
8
|
- Put workspace packages in `packages/`. Put runnable examples in `examples/`.
|
|
9
|
-
- Each package directory in `packages/` ends with `-js` (cross-platform JavaScript), `-node` (Node.js), `-web` (browser), or `-rust
|
|
9
|
+
- Each package directory in `packages/` ends with `-js` (cross-platform JavaScript), `-node` (Node.js), `-web` (browser), or `-rust`, or contains `-node-` (a Node.js part, such as `core-node-native`). The `muxion-agents check` command enforces this.
|
|
10
10
|
- Put shared integration tests in `tests/`. Put benchmarks or diagnostics in their named top-level directories.
|
|
11
11
|
- Keep generated files in the output directory that owns them. Do not edit generated files by hand.
|
|
12
12
|
- Use Turborepo for dependency-ordered `build`, `test`, and `lint` tasks.
|
package/agents/rust-core.md
CHANGED
|
@@ -8,7 +8,6 @@ paths:
|
|
|
8
8
|
This layer adds to the Rust layer.
|
|
9
9
|
|
|
10
10
|
- Keep protocol cores deterministic and independent of runtimes and platforms.
|
|
11
|
-
- Do not use `unsafe` outside ABI modules.
|
|
12
11
|
- Use the sans-IO shape: `handle_input(bytes, now)`, `poll_transmit(now)`, and `poll_timeout()`. The host gives time and seeds.
|
|
13
12
|
- Do not panic on peer input. Check bounds in all parsing (`clippy::indexing_slicing`).
|
|
14
13
|
- Use `checked_`, `saturating_`, or `wrapping_` arithmetic explicitly (`clippy::arithmetic_side_effects`).
|
package/agents/rust-ffi.md
CHANGED
|
@@ -8,8 +8,6 @@ paths:
|
|
|
8
8
|
|
|
9
9
|
This layer adds to the Rust layer. It applies to ABI modules.
|
|
10
10
|
|
|
11
|
-
- Confine handwritten `unsafe` code to ABI or generated boundary modules.
|
|
12
|
-
- Add a safety explanation to each handwritten `unsafe` block.
|
|
13
11
|
- Give each `unsafe fn` a `# Safety` section. Put one unsafe operation in each block (`clippy::undocumented_unsafe_blocks`, `clippy::multiple_unsafe_ops_per_block`, `clippy::missing_safety_doc`).
|
|
14
12
|
- Write `#[unsafe(no_mangle)]` and `unsafe extern "C"`.
|
|
15
13
|
- Do not let a panic cross `extern "C"`. Catch it with `catch_unwind` and return an error code. Choose one panic strategy for the crate and state it.
|
|
@@ -17,4 +15,3 @@ This layer adds to the Rust layer. It applies to ABI modules.
|
|
|
17
15
|
- Free memory on the side that allocated it. Export a `*_free` function for each owned output.
|
|
18
16
|
- Export `abi_version()`. Use `#[repr(u32)]` enums. Reject unknown discriminants on input.
|
|
19
17
|
- Return status codes. Return values through out-parameters.
|
|
20
|
-
- Keep native results borrowed only for the current operation. Copy data before the next native call.
|
package/agents/rust.md
CHANGED
|
@@ -9,6 +9,8 @@ paths:
|
|
|
9
9
|
This layer adds to the engineering principles.
|
|
10
10
|
|
|
11
11
|
- Use edition 2024.
|
|
12
|
+
- Confine handwritten `unsafe` code to ABI or generated boundary modules.
|
|
13
|
+
- Add a safety explanation to each handwritten `unsafe` block.
|
|
12
14
|
- Keep `cargo fmt` and workspace Clippy settings in each repository that contains Rust.
|
|
13
15
|
- Put lint policy in `[workspace.lints]`. Set `lints.workspace = true` in each crate. Do not put `#![deny]` at crate roots.
|
|
14
16
|
- Suppress a lint with `#[expect(lint, reason = "...")]`. Do not use `allow` (`clippy::allow_attributes_without_reason`).
|
package/agents/typescript.md
CHANGED
|
@@ -20,6 +20,7 @@ This layer adds to the engineering principles.
|
|
|
20
20
|
- Use `bigint` for 64-bit values at TypeScript and native boundaries.
|
|
21
21
|
- Trust typed values. Validate untyped input only when it enters a typed boundary.
|
|
22
22
|
- Use integer discriminators across runtime and native boundaries.
|
|
23
|
+
- Keep native results borrowed only for the current operation. Copy data before the next native call.
|
|
23
24
|
- Keep lint suppressions on the smallest item and state the reason.
|
|
24
25
|
|
|
25
26
|
## APIs
|
package/dist/agents-check.js
CHANGED
|
@@ -78,7 +78,7 @@ const checkPackages = async (root) => {
|
|
|
78
78
|
const directories = await readPackageDirectories(root);
|
|
79
79
|
const errors = directories
|
|
80
80
|
.filter((name) => !isTargetPackageName(name) && !exempt.includes(name))
|
|
81
|
-
.map((name) => `packages/${name} must end with -js, -node, -web, or -rust, or be in muxionAgents.exempt.`);
|
|
81
|
+
.map((name) => `packages/${name} must end with -js, -node, -web, or -rust, or contain -node-, or be in muxionAgents.exempt.`);
|
|
82
82
|
for (const name of exempt) {
|
|
83
83
|
if (!directories.includes(name)) {
|
|
84
84
|
errors.push(`The exempt package ${name} does not exist in packages/. Remove it from muxionAgents.exempt.`);
|
package/dist/agents-check.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agents-check.js","sourceRoot":"","sources":["../src/agents-check.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC3E,yFAAyF;AACzF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEzC,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAA;AACpD,MAAM,CAAC,MAAM,gBAAgB,GAAG,8CAA8C,CAAA;AAE9E,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AAExD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAW,EAAE,CAC3D,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAEnF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAW,EAAE,CAC7C,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAA;AAEtE,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;IACtD,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,CAAA;QAChB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;IACvC,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAA;QAC/B,MAAM,GAAG,KAAK,CAAC,cAAc,EAAE,CAAA;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,cAAc,yCAAyC,gBAAgB,GAAG,CAAC,CAAA;QACxF,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,GAAG,cAAc,2CAA2C,gBAAgB,GAAG,CAAC,CAAA;IAC1F,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;IACnC,IAAI,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAChC,OAAO,CAAC,GAAG,cAAc,cAAc,MAAM,sBAAsB,gBAAgB,GAAG,CAAC,CAAA;IACzF,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,OAAO;YACL,GAAG,cAAc,gFAAgF;SAClG,CAAA;IACH,CAAC;IACD,OAAO,EAAE,CAAA;AACX,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IAC3D,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;IACxF,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,cAAc,IAAI,QAAQ,CAAC,EAAE,CAAC;QACvF,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAA;IACjC,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,IAAI,YAAY,CAAC,EAAE,CAAC;QAC7F,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QAChF,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;IACzE,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,sBAAsB,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IACvE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;QAC9E,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAClF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IAC9D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IACrC,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,IAAI,CAAC,CAAA;IACtD,MAAM,MAAM,GAAG,WAAW;SACvB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SACtE,GAAG,CACF,CAAC,IAAI,EAAE,EAAE,CACP,YAAY,IAAI,
|
|
1
|
+
{"version":3,"file":"agents-check.js","sourceRoot":"","sources":["../src/agents-check.ts"],"names":[],"mappings":"AAAA,6FAA6F;AAC7F,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC3E,yFAAyF;AACzF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEzC,MAAM,CAAC,MAAM,cAAc,GAAG,sBAAsB,CAAA;AACpD,MAAM,CAAC,MAAM,gBAAgB,GAAG,8CAA8C,CAAA;AAE9E,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;AAExD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAW,EAAE,CAC3D,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAEnF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAW,EAAE,CAC7C,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAA;AAEtE,MAAM,MAAM,GAAG,KAAK,EAAE,IAAY,EAAoB,EAAE;IACtD,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,CAAA;QAChB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IAC1D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;IACvC,IAAI,MAAe,CAAA;IACnB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAA;QAC/B,MAAM,GAAG,KAAK,CAAC,cAAc,EAAE,CAAA;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,cAAc,yCAAyC,gBAAgB,GAAG,CAAC,CAAA;QACxF,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,GAAG,cAAc,2CAA2C,gBAAgB,GAAG,CAAC,CAAA;IAC1F,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAA;IACnC,IAAI,MAAM,KAAK,gBAAgB,EAAE,CAAC;QAChC,OAAO,CAAC,GAAG,cAAc,cAAc,MAAM,sBAAsB,gBAAgB,GAAG,CAAC,CAAA;IACzF,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACjD,OAAO;YACL,GAAG,cAAc,gFAAgF;SAClG,CAAA;IACH,CAAC;IACD,OAAO,EAAE,CAAA;AACX,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IAC3D,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;IACxF,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,CAAC,cAAc,IAAI,QAAQ,CAAC,EAAE,CAAC;QACvF,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,EAAE,YAAY,EAAE,GAAG,QAAQ,CAAA;IACjC,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,KAAK,IAAI,IAAI,CAAC,CAAC,QAAQ,IAAI,YAAY,CAAC,EAAE,CAAC;QAC7F,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAC/B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QAChF,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAA;IACzE,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,sBAAsB,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IACvE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;QAC9E,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAClF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE;IAC9D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IACrC,MAAM,WAAW,GAAG,MAAM,sBAAsB,CAAC,IAAI,CAAC,CAAA;IACtD,MAAM,MAAM,GAAG,WAAW;SACvB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SACtE,GAAG,CACF,CAAC,IAAI,EAAE,EAAE,CACP,YAAY,IAAI,6FAA6F,CAChH,CAAA;IACH,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,CAAC,IAAI,CACT,sBAAsB,IAAI,mEAAmE,CAC9F,CAAA;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAAqB,EAAE,CAAC;IACxE,GAAG,CAAC,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IAC1B,GAAG,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC;CAC/B,CAAA"}
|