@raypx-kit/devkit 0.0.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,21 @@
+# @raypx-kit/devkit
+
+## 0.0.0-alpha.0
+
+Initial Raypx Kit prerelease.
+
+- Refresh compatible dependencies and use caret ranges for ordinary dependencies;
+  keep the coverage provider synchronized with Vite+'s bundled Vitest.
+- Provide configurable workspace discovery, import resolution and architecture checks.
+- Name non-exported implementation paths `internalPath` in import resolution and
+  report internal cross-workspace imports consistently.
+- Check publishable workspaces and explicit source-entry mappings before builds,
+  with narrowly declared bundled development dependencies.
+- Accept complete workspace metadata maps for explicit, typed repository
+  configuration while retaining manifest metadata compatibility and synchronous,
+  non-executing discovery.
+- Check Node and Bun version-file declarations in local composite actions under
+  `.github/actions/`, including nested action directories and both YAML filename extensions.
+- Include Node/Bun toolchain checks, static catalog reading, Markdown link checks,
+  dotenv-aware process and Turbo helpers, and relocated artifact staging and probes.
+- Preserve independent entry points and consumer-owned repository policy.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Zack <heyloyep@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,189 @@
+# @raypx-kit/devkit
+
+Maintenance checks and task helpers for Bun monorepos: workspace boundaries,
+toolchain pins, static message catalogs, documentation links and relocated build
+artifacts.
+
+```sh
+bun add -d @raypx-kit/devkit
+```
+
+ESM only, for Node 22.14+ and Bun. Each entry is independent, so a consumer loads
+only the dependencies it uses. The package reads files and spawns processes; it
+contains no product rules, so repositories compose their own policy from it.
+
+| Entry            | Purpose                                                                |
+| ---------------- | ---------------------------------------------------------------------- |
+| `./workspaces`   | Discover workspaces, read boundary metadata and resolve imports        |
+| `./architecture` | Check dependencies, exports, cycles, platform targets and import leaks |
+| `./toolchain`    | Read Node/Bun pins, check every duplicated pin and the active runtimes |
+| `./catalogs`     | Read static message catalogs without executing them                    |
+| `./docs`         | Report broken relative Markdown links                                  |
+| `./process`      | Run commands, load dotenv files and run Turbo with a guarded cache     |
+| `./artifact`     | Stage a relocated output and probe a running Node server               |
+
+## Workspace architecture
+
+Repositories can keep their check policy in a typed file and pass plain data to
+Devkit. For example, a repository with one `packages/messages` workspace can use
+`devkit.config.ts`:
+
+```ts
+import type { ToolchainOptions } from "@raypx-kit/devkit/toolchain";
+import type { Metadata } from "@raypx-kit/devkit/workspaces";
+
+export default {
+  workspaces: {
+    "packages/messages": {
+      kind: "library",
+      target: "universal",
+      entryTargets: { "./client": "browser" },
+      sourceTargets: { "src/client/**": "browser" },
+      sourceEntries: {
+        ".": "./src/index.ts",
+        "./client": "./src/client.ts",
+      },
+    },
+  } satisfies Record<string, Metadata>,
+  toolchain: {
+    documents: ["README.md", "AGENTS.md"],
+    turboGlobalDependencies: [".nvmrc", "mise.toml", "devkit.config.ts"],
+  } satisfies ToolchainOptions,
+};
+```
+
+The repository's own script imports that trusted configuration explicitly:
+
+```ts
+import { checkArchitecture } from "@raypx-kit/devkit/architecture";
+import { discover } from "@raypx-kit/devkit/workspaces";
+import config from "../devkit.config.js";
+
+const index = discover(root, { metadata: config.workspaces });
+const findings = checkArchitecture(index);
+```
+
+`metadata` accepts a `Readonly<Record<string, Metadata>>` keyed by discovered
+workspace paths relative to `root`, such as `packages/messages`. Keys must match
+the discovered paths exactly, without `./` or a trailing slash. The map is the
+complete metadata source: missing and unknown workspaces are findings, and
+manifest metadata is not merged or used as a fallback. Discovery is synchronous;
+it never finds, imports or executes a configuration file. The filename and
+loading mechanism belong to the caller.
+
+`kind` is `app`, `library` or `tooling`; targets are `universal`, `browser`,
+`native`, `node` and `bun`. Every workspace is ESM; application workspaces must
+declare `private: true`, while libraries and tooling can be publishable.
+
+`sourceEntries` maps a public export key to its maintained TypeScript or
+JavaScript source. Use it when `exports` points to generated output so the gate
+can inspect sources before building. Each mapping must name an existing source
+within its workspace and correspond to an actual export. Without a mapping,
+the check follows the declared export targets directly. Package-root JSON
+configuration exports therefore need no source mapping.
+
+`bundledDependencies` lists external development dependencies deliberately bundled
+into the published runtime. Each name must be declared in `devDependencies`, and
+the package build must bundle it. This option permits those source imports; it
+does not exempt workspace boundaries or platform checks. Ordinary runtime
+dependencies and peers remain in their respective manifest fields.
+
+Without an explicit `metadata` map, discovery retains the manifest interface.
+Each workspace stores its metadata under `package.json#devkit` by default; a
+custom `metadataKey` selects a different field:
+
+```ts
+const index = discover(root, { metadataKey: "devkit" });
+```
+
+An external map moves checking policy only. Workspace membership, exports and
+dependencies still come from package manifests, and aliases come from workspace
+TypeScript configurations. Keep a repository's typed policy file in its type
+check and build-cache dependencies.
+
+`discover` also reports directories under `apps/` and `packages/` without a
+manifest; pass `containers` to change them. `checkArchitecture` statically parses
+runtime sources under `src/`, `server/`, `native/` and `app/` and walks every
+public source entry. It reports public applications and invalid metadata,
+libraries without exports, missing export targets, non-`workspace:*` internal
+ranges, dependency cycles including development dependencies, undeclared runtime
+or type imports, internal cross-workspace paths, application or tooling imports
+from runtime code, test-only imports, host APIs used outside their target and DOM
+globals reachable from universal or native entries.
+
+`resolveImport` marks paths that bypass a workspace's public exports with
+`internalPath: true`; architecture findings call these internal cross-workspace
+imports. Package publication status is separate and uses the standard manifest
+`private` field.
+
+This package's own tests live under `tests/`; production entries live under
+`src/` and are the only sources included in the library build.
+
+## Toolchain
+
+`.nvmrc` pins Node and the root `packageManager` (`bun@x.y.z`) pins Bun. Every
+other declaration must follow those two sources.
+
+```ts
+import { assertToolchainRuntime, checkToolchain, pinnedNode } from "@raypx-kit/devkit/toolchain";
+import config from "../devkit.config.js";
+
+const findings = checkToolchain(root, config.toolchain);
+const { node, bun, nodeBinary } = assertToolchainRuntime(root, {
+  nodeBinaryEnv: "DEVKIT_NODE_BINARY",
+});
+```
+
+`checkToolchain` checks `engines.node` and both `devEngines` entries (including
+`onFail: "error"`), rejects `.node-version`, `.bun-version` and `.tool-versions`,
+requires `mise.toml` to read the existing pins without `[tools]`, requires every
+`actions/setup-node` and `oven-sh/setup-bun` step to read `.nvmrc` and
+`package.json` in workflows under `.github/workflows/` and composite actions
+under `.github/actions/`, matches the `@types/node` range baseline by major and the
+`@types/bun` range baseline to the Bun pin in every manifest and Bun catalog,
+and checks Dockerfile `node:` and `oven/bun:` images,
+documented `Node x.y.z` and `Bun x.y.z` versions and Turbo global dependencies.
+`pinnedNode` returns the Node executable after checking its version; the binary
+variable selects an executable but never relaxes the version.
+
+## Catalogs and documentation
+
+```ts
+import { readStaticCatalog } from "@raypx-kit/devkit/catalogs";
+import { checkDocumentLinks } from "@raypx-kit/devkit/docs";
+
+const en = readStaticCatalog("src/messages/en.ts");
+const broken = checkDocumentLinks(root, ["README.md", "docs/guide.md"]);
+```
+
+`readStaticCatalog` accepts JSON or a module whose default export is an object
+literal of strings, optionally with `as const` or `satisfies`. Computed values,
+spreads and computed keys are rejected, and the module is never executed. Pair it
+with `compareMessageCatalogs` from `@raypx-kit/intl/testing` for ICU parity.
+
+## Processes and artifacts
+
+```ts
+import { pinnedNode } from "@raypx-kit/devkit/toolchain";
+import { probeArtifact } from "@raypx-kit/devkit/artifact";
+import { developmentEnvironment, run, turbo } from "@raypx-kit/devkit/process";
+
+await turbo(root, "build", ["--filter", "web"], { trustedCacheEnv: "CACHE_TRUSTED" });
+await probeArtifact({
+  name: "web",
+  output: `${root}/apps/web/.output`,
+  node: pinnedNode(root),
+  check: async (base) => {
+    if (!(await fetch(base)).ok) throw new Error("home page failed");
+  },
+});
+```
+
+`developmentEnvironment` copies the process environment and layers `.env.local`
+and `.env` beneath it without printing values. `turbo` must run under Bun; it
+loads dotenv files for `dev` and `build`, and unless the trusted variable is
+`"true"` removes remote cache credentials and uses the local cache only.
+`stageArtifact` copies an output after rejecting absolute links and links that
+escape it. `probeArtifact` stages the output in a temporary directory, starts its
+entry with the given Node on a free port, waits for the health path, runs the
+check and always stops the server.

package/dist/architecture.d.mts

@@ -0,0 +1,15 @@
+import { WorkspaceIndex } from "./workspaces.mjs";
+//#region src/architecture.d.ts
+export interface ImportEdge {
+  request: string;
+  typesOnly: boolean;
+}
+/** Static import, re-export, dynamic import and `import()` type edges, without executing code. */
+export declare function imports(file: string, source: string): ImportEdge[];
+/**
+ * Checks workspace metadata, exports, the dependency graph and every runtime import:
+ * declarations, internal paths, platform targets, tooling and test-only boundaries.
+ */
+export declare function checkArchitecture(index: WorkspaceIndex): string[];
+//#endregion
+//# sourceMappingURL=architecture.d.mts.map