@riebeckite/test 0.0.6

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 Rerurate_514
+
+   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,88 @@
+# @riebeckite/test
+
+Shared test utilities for Riebeckite packages, plus a generic external-consumer
+end-to-end engine.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`@riebeckite/test` has two entry points:
+
+- `@riebeckite/test` — dependency-free helpers for package unit tests.
+- `@riebeckite/test/e2e` — a reusable engine for testing a built site end to
+  end against published tarballs. It knows nothing about the Riebeckite
+  monorepo: the repository root, the package list, the fixtures, and the
+  content assertions are all supplied by the caller.
+
+## Installation
+
+```sh
+pnpm add -D @riebeckite/test
+```
+
+## Unit-test helpers
+
+`assertGolden` and `assertGoldenJson` record expensive output as committed
+golden files instead of asserting it by hand. Node's built-in snapshot
+assertion needs Node 22.3+, but Riebeckite supports Node 20.19+, so this helper
+covers the supported range.
+
+```ts
+import { assertGolden, assertGoldenJson } from "@riebeckite/test";
+
+assertGolden(renderHtml(), new URL("./__golden__/page.html", import.meta.url));
+assertGoldenJson(manifest, new URL("./__golden__/manifest.json", import.meta.url));
+```
+
+The helpers normalize CRLF/CR to LF and collapse trailing newlines by default so
+golden files stay stable across platforms and editors. Pass
+`{ normalize: false }` when byte-exact output matters, and `{ message }` to add
+context to failures.
+
+A missing or mismatched golden file fails the test. Regenerate the recorded
+files with `pnpm test:update` at the repository root (or `UPDATE_GOLDEN=1` for a
+single package) and review the resulting diff.
+
+See [Testing](../../docs/en/testing.md) for the full workflow.
+
+## External-site engine
+
+`@riebeckite/test/e2e` packages a set of workspace packages into tarballs,
+installs them into an empty consumer project alongside a fixture site, and runs
+assertions against the result. Nothing about the monorepo is hardcoded.
+
+```ts
+import path from "node:path";
+
+import { runExternalSiteE2E } from "@riebeckite/test/e2e";
+
+await runExternalSiteE2E({
+  repoRoot,
+  packages: [{ directory: "packages/core", name: "@riebeckite/core" }],
+  fixture: { site: fixtureSite, vault: fixtureVault },
+  dependencyCheckScript: path.join(repoRoot, "scripts/check_dependencies.mjs"),
+  scope: "@riebeckite",
+  cliName: "riebeckite",
+  resolveCliEntry: (siteDir) =>
+    path.join(siteDir, "node_modules", "@riebeckite", "cli", "bin", "riebeckite.mjs"),
+  cliCommands: [{ args: ["build"] }],
+  keepEnv: "RIEBECKITE_E2E_KEEP",
+  assertions: {
+    buildOutput: (siteDir, vaultDir) => {
+      // assert on the built site
+    },
+  },
+});
+```
+
+The engine also exports the lower-level steps it is built from —
+`run`/`runAsync` for spawning commands, `packPackages` for tarball creation,
+`stageIsolatedSite` for building the consumer project, and the install and
+artifact assertions — so a repository can compose its own flow. Work that does
+not generalize, such as generating a starter site from the packed tarballs, runs
+through the `afterSiteChecks` callback.
+
+## See also
+
+- [Testing](../../docs/en/testing.md)

package/README_ja.md

@@ -0,0 +1,69 @@
+# @riebeckite/test
+
+Riebeckite パッケージ共通のテストユーティリティと、汎用の external-consumer E2E engine です。
+
+[English](./README.md)
+
+## 概要
+
+`@riebeckite/test` には 2 つのエントリポイントがあります。
+
+- `@riebeckite/test` — パッケージの単体テスト向けの依存ゼロ helper。
+- `@riebeckite/test/e2e` — ビルド済みサイトを公開 tarball に対して end-to-end で検証する再利用可能な engine。Riebeckite モノレポを一切知りません。リポジトリルート、パッケージ一覧、fixture、コンテンツのアサーションはすべて呼び出し側が渡します。
+
+## インストール
+
+```sh
+pnpm add -D @riebeckite/test
+```
+
+## 単体テストの helper
+
+`assertGolden` と `assertGoldenJson` は、手で書くには大きすぎる出力を committed な golden ファイルとして記録します。Node 標準の snapshot 機能は Node 22.3+ が必要ですが、Riebeckite は Node 20.19+ をサポートするため、この helper が対応範囲をカバーします。
+
+```ts
+import { assertGolden, assertGoldenJson } from "@riebeckite/test";
+
+assertGolden(renderHtml(), new URL("./__golden__/page.html", import.meta.url));
+assertGoldenJson(manifest, new URL("./__golden__/manifest.json", import.meta.url));
+```
+
+既定では CRLF/CR を LF に変換し、末尾の改行を 1 つにまとめるため、golden ファイルはプラットフォームやエディタをまたいで安定します。バイト単位で一致させたい場合は `{ normalize: false }`、失敗時に文脈を足したい場合は `{ message }` を渡してください。
+
+golden ファイルが無い、または一致しない場合はテストが失敗します。リポジトリルートで `pnpm test:update`（単一パッケージなら `UPDATE_GOLDEN=1`）を実行して記録を更新し、差分を確認してください。
+
+詳しいワークフローは [Testing](../../docs/ja/testing.md) を参照してください。
+
+## External-site engine
+
+`@riebeckite/test/e2e` は、複数のワークスペースパッケージを tarball にまとめ、空の consumer プロジェクト（fixture サイト付き）にインストールし、結果に対してアサーションを実行します。モノレポ固有の情報はハードコードしません。
+
+```ts
+import path from "node:path";
+
+import { runExternalSiteE2E } from "@riebeckite/test/e2e";
+
+await runExternalSiteE2E({
+  repoRoot,
+  packages: [{ directory: "packages/core", name: "@riebeckite/core" }],
+  fixture: { site: fixtureSite, vault: fixtureVault },
+  dependencyCheckScript: path.join(repoRoot, "scripts/check_dependencies.mjs"),
+  scope: "@riebeckite",
+  cliName: "riebeckite",
+  resolveCliEntry: (siteDir) =>
+    path.join(siteDir, "node_modules", "@riebeckite", "cli", "bin", "riebeckite.mjs"),
+  cliCommands: [{ args: ["build"] }],
+  keepEnv: "RIEBECKITE_E2E_KEEP",
+  assertions: {
+    buildOutput: (siteDir, vaultDir) => {
+      // ビルド済みサイトに対するアサーション
+    },
+  },
+});
+```
+
+engine は、それが組み立てられている下位ステップも公開します。コマンド実行の `run` / `runAsync`、tarball 作成の `packPackages`、consumer プロジェクトを組み立てる `stageIsolatedSite`、インストールと成果物のアサーションなどです。リポジトリ側で独自のフローを構成できます。一般化できない処理（たとえば packed tarball から starter サイトを生成するなど）は `afterSiteChecks` コールバックで実行します。
+
+## 関連資料
+
+- [Testing](../../docs/ja/testing.md)

package/dist/e2e/assertions.d.ts

@@ -0,0 +1,63 @@
+import type { Logger } from "./logger.js";
+/** A path that must exist after installation, with its failure message. */
+export interface RequiredInstallPath {
+    /** Label used in the success line, e.g. `"vite/client"`. */
+    label: string;
+    /** Path relative to the site directory. */
+    relativePath: string;
+    /** Message thrown when the path is missing. */
+    missingMessage: string;
+    /** Include the path in the success line. Defaults to true. */
+    report?: boolean;
+}
+export interface AssertIsolatedInstallOptions {
+    /** Absolute repository root the workspace must live outside of. */
+    repoRoot: string;
+    /** Paths that must exist inside the isolated install. */
+    requiredPaths?: readonly RequiredInstallPath[];
+    logger: Logger;
+}
+/**
+ * Verify the install is genuinely standalone: the workspace lives outside the
+ * repository, no pnpm workspace state leaked in, and the locally installed
+ * tooling the type-check phase depends on is present.
+ */
+export declare function assertIsolatedInstall(siteDir: string, tempRoot: string, options: AssertIsolatedInstallOptions): void;
+export interface AssertNoMonorepoEscapeHatchesOptions {
+    /**
+     * Directory under the repository root that site sources must not reach into
+     * via a relative parent traversal. Defaults to `"packages"`.
+     */
+    monorepoPackagesDirectory?: string;
+    logger: Logger;
+}
+/**
+ * Fail if the staged site contains any way to escape into the repository:
+ * `workspace:` protocol references, a copied package directory, or source
+ * files that traverse into the monorepo's package directory.
+ */
+export declare function assertNoMonorepoEscapeHatches(siteDir: string, options: AssertNoMonorepoEscapeHatchesOptions): void;
+export interface AssertPublishedArtifactsOptions {
+    /** Absolute repository root published packages must not resolve into. */
+    repoRoot: string;
+    /** Published package scope, e.g. `"@scope"`. */
+    scope: string;
+    logger: Logger;
+}
+/**
+ * Verify every installed scoped package resolves to a real installed directory
+ * outside the repository (never a symlink back into the monorepo).
+ */
+export declare function assertPublishedArtifacts(siteDir: string, options: AssertPublishedArtifactsOptions): void;
+export interface AssertDeclaredDependenciesOptions {
+    /** Absolute path to the undeclared-dependency checker script. */
+    dependencyCheckScript: string;
+    /** Working directory for the checker. Defaults to `process.cwd()`. */
+    cwd?: string;
+    logger: Logger;
+}
+/**
+ * Run the repository's dependency checker against the site so it cannot
+ * silently rely on hoisted (undeclared) packages.
+ */
+export declare function assertDeclaredDependencies(siteDir: string, options: AssertDeclaredDependenciesOptions): void;

package/dist/e2e/cli.d.ts

@@ -0,0 +1,23 @@
+import type { Logger } from "./logger.js";
+import { type RunResult } from "./process.js";
+export interface RunCliOptions {
+    /** Absolute path to the installed CLI entry point. */
+    cliEntry: string;
+    /** Working directory for the invocation. */
+    cwd: string;
+    /** Name shown in the step line, e.g. `"riebeckite"`. */
+    cliName: string;
+    logger: Logger;
+}
+/**
+ * Invoke an installed CLI entry with `args`, print its combined output, and
+ * return the raw result. The step line reads `<cliName> <args...>`.
+ */
+export declare function runCli(args: readonly string[], options: RunCliOptions): RunResult;
+/** Combined stdout and stderr of a run. */
+export declare function cliText(result: RunResult): string;
+/**
+ * Type-check the site with its locally installed TypeScript compiler. The
+ * command matches `<typescript>/bin/tsc --noEmit -p <project>`.
+ */
+export declare function runTypecheck(siteDir: string, project: string, logger: Logger): RunResult;

package/dist/e2e/files.d.ts

@@ -0,0 +1,7 @@
+/** Predicate applied to each candidate file's absolute path. */
+export type FilePredicate = (absolutePath: string) => boolean;
+/**
+ * Recursively list the files under `root` that satisfy `predicate`. Missing
+ * roots yield an empty list instead of throwing.
+ */
+export declare function walkFiles(root: string, predicate?: FilePredicate): string[];

package/dist/e2e/format.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Format a byte count using binary units (`B`, `KB`, `MB`, `GB`). Values below
+ * 10 keep one decimal place; larger values and raw bytes are rounded.
+ */
+export declare function formatBytes(bytes: number): string;

package/dist/e2e/html.d.ts

@@ -0,0 +1,10 @@
+/** Escape a string so it can be embedded literally in a `RegExp`. */
+export declare function escapeRegExp(value: string): string;
+/**
+ * Extract the textual bodies of `<script>` elements that carry `attribute`
+ * (for example `"data-rb-hover-preview"`), joined with newlines.
+ *
+ * Generic on purpose: the caller supplies the attribute name so the engine
+ * never hardcodes a fixture marker.
+ */
+export declare function extractScriptPayloads(html: string, attribute: string): string;

package/dist/e2e/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A reusable, monorepo-agnostic engine for testing a built site end to end
+ * against locally packed tarballs.
+ *
+ * The engine owns the mechanical sequence and knows nothing about any specific
+ * repository. Callers inject the repository root, package list, fixtures, CLI
+ * shape, assertion callbacks, and keep-temp variable through
+ * {@link runExternalSiteE2E}. Lower-level primitives are exported so a
+ * repository can compose its own flow.
+ */
+export { type AssertDeclaredDependenciesOptions, type AssertIsolatedInstallOptions, type AssertNoMonorepoEscapeHatchesOptions, type AssertPublishedArtifactsOptions, assertDeclaredDependencies, assertIsolatedInstall, assertNoMonorepoEscapeHatches, assertPublishedArtifacts, type RequiredInstallPath, } from "./assertions.js";
+export { cliText, type RunCliOptions, runCli, runTypecheck, } from "./cli.js";
+export { type FilePredicate, walkFiles, } from "./files.js";
+export { formatBytes } from "./format.js";
+export { escapeRegExp, extractScriptPayloads } from "./html.js";
+export { createLogger, type Logger } from "./logger.js";
+export { type PackageSpec, type PackedPackage, type PackedPackages, type PackPackagesOptions, packPackages, } from "./pack.js";
+export { MAX_BUFFER, quote, type RunOptions, type RunResult, run, runAsync, } from "./process.js";
+export { type CliCommandSpec, type ExternalSiteAssertions, type ExternalSiteE2EConfig, type ExternalSiteFixture, type ExternalSiteWorkspace, runExternalSiteE2E, type SiteCheck, } from "./run.js";
+export { type LayerExternalConsumerTypesOptions, layerExternalConsumerTypes, type NodeNextProjectSpec, type StageIsolatedSiteOptions, stageIsolatedSite, writeFileDependencies, } from "./stage.js";