@tutti-os/ui-system 0.0.1

package/AGENTS.md

@@ -0,0 +1,146 @@
+# AGENTS.md
+
+## Scope
+
+This file applies to `packages/ui/system/*`.
+
+`packages/ui/system` is the source package for `@tutti-os/ui-system`, the
+shared Nextop UI component library. It owns shared CSS tokens, theme styles,
+icon exports, presentation primitives, reusable host-agnostic business display
+components, component metadata, storyboard inventory, and the bundled
+`nextop-ui-system` agent skill.
+
+Before changing components, icons, metadata, styles, storyboard examples, or
+the bundled skill, read `ui-system.md`.
+
+UI-system design compliance is a release gate for this package, not a follow-up
+task. If a promoted component does not yet follow the shared token model,
+surface language, primitive vocabulary, and storyboard evidence standard, do
+not report it as complete.
+
+## Public API
+
+Stable public imports are:
+
+- `@tutti-os/ui-system`
+- `@tutti-os/ui-system/components`
+- `@tutti-os/ui-system/metadata`
+- `@tutti-os/ui-system/icons`
+- `@tutti-os/ui-system/styles.css`
+- `@tutti-os/ui-system/utils`
+
+Rules:
+
+- prefer adding exports to an existing public barrel before introducing a new
+  public subpath
+- do not expose `src/*` layout as public API
+- do not encourage per-file deep imports such as
+  `@tutti-os/ui-system/components/button`
+- if package exports change intentionally, update both the package exports and
+  the UI-boundary check script
+
+## Component Library Rules
+
+- keep `base` components low-level, generic, and
+  frontend-foundation-focused
+- allow `business` components only when they are reusable business display
+  components that remain host-agnostic and side-effect-free
+- business components may expose domain display props such as workspace, file,
+  task, agent, status, permission, and callbacks, but must not own daemon,
+  Electron, router, store, query, filesystem, persistence, or workflow calls
+- before promoting a business component, scan source usage, build a
+  code-evidence state matrix, and define the public props boundary from that
+  evidence; after that, promote it directly into `packages/ui/system` and add
+  storyboard coverage for the accepted states
+- business components should compose `base` primitives instead of recreating
+  buttons, fields, dialogs, cards, icons, or overlays
+- promoted components and their storyboard examples must use UI-system semantic
+  tokens and approved shared CSS variables; do not leave raw `hex`,
+  `rgb(...)`, `rgba(...)`, ad hoc gradients, or app-local palette values in the
+  final UI-system implementation unless they already come from approved shared
+  tokens
+- storyboard coverage must show the component's real promoted surface and
+  states; do not rely on surrounding docs chrome or wrapper panels to mask
+  component-level visual drift
+- UI storyboard foundation content is JSON-driven. When changing documented
+  token, color, typography, spacing, radius, motion, or overview display data,
+  edit `apps/ui-storyboard/src/foundation/*.json` directly instead of
+  hardcoding those values in `apps/ui-storyboard/src/App.tsx`
+- migrated consumers must end on the same UI-system visual implementation for
+  the promoted surface; temporary bridges are allowed only for wiring, not as a
+  separate long-lived token or styling system
+- treat this package as the shared shadcn and Radix host package
+- when a primitive exists in the shadcn registry, acquire it through shadcn CLI
+  targeted at this package instead of handwriting the component body
+- keep `components.json` and package aliases usable enough that CLI download
+  remains the default path for shared primitives
+- after CLI acquisition, limit edits to narrow package-specific adaptation such
+  as icon routing, import aliases, stable exports, and boundary-check fixes
+- keep CSS variables as the source of truth for token values
+- prefer semantic token naming over raw palette leakage in public APIs
+- keep helper exports minimal and tied to primitive support, not general
+  convenience reuse
+- build primitives for a calm workbench shell, not for marketing-card theatrics
+- every public component, icon, utility, or style entry must have metadata with
+  a stable readable `id` and `layer`
+- use the single `nextop-ui-system` skill for component reuse, extraction,
+  base/business classification, metadata, and storyboard work
+
+## React Component Splitting Rules
+
+- default to one component per directory; keep the component file, tests,
+  stories, local styles, and tightly coupled implementation-detail helpers
+  colocated inside that directory
+- default to one React component per file; allow multiple small stateless
+  helpers in one file only when they are tightly coupled implementation detail
+  of the exported component
+- split presentational components away from host wiring; components promoted
+  into ui-system must receive data, labels, status, and callbacks through props
+  rather than owning side effects or app workflow
+- if a component does not need internal state or refs, prefer a plain function
+  component; introduce heavier component structure only when state, refs, or
+  lifecycle-like coordination is actually required
+- when behavior is reusable but host-owned, extract it into caller-owned hooks,
+  adapters, or controller code instead of embedding that logic in the ui-system
+  component body
+- do not use mixin-style reuse or implicit component coupling; prefer explicit
+  composition through child components, slots, helper modules, or narrow
+  wrappers
+- keep component APIs semantic and stable; do not repurpose DOM prop names such
+  as `style` or `className` to carry business meaning when a clearer prop like
+  `variant`, `tone`, `status`, or `layout` is intended
+- use spread props sparingly on public components; pass explicit props whenever
+  possible so the boundary stays readable and host-agnostic
+- list and collection components must render with stable identity from caller
+  data; do not rely on array index keys in promoted UI-system surfaces
+- when a component grows multiple visual regions or branches, first try to
+  split subparts into local render helpers or child components before adding
+  more mode booleans to one large component
+- avoid boolean-prop sprawl for mutually exclusive modes; prefer a finite
+  variant, discriminated union, explicit slot, or separate subcomponent when
+  states represent distinct rendering modes
+- keep user-visible copy caller-owned by default; if text changes by host,
+  locale, or workflow, expose it through props, labels, or children instead of
+  hardcoding it inside the shared component
+- use the filename as the component name and keep exported component names in
+  PascalCase so file boundaries stay obvious during promotion, review, and
+  migration
+
+## Validation
+
+- Run `pnpm typecheck`
+- Run `pnpm check:ui-boundaries`
+- If component metadata changed, run `node tools/scripts/check-ui-metadata.mjs`
+- If storyboard inventory changed, run
+  `pnpm --filter @tutti-os/ui-storyboard typecheck`
+- If a change affects desktop integration, also run
+  `pnpm --filter @tutti-os/desktop build`
+- In the handoff, explicitly state whether tokens, primitives, storyboard
+  surface, and migrated consumer all comply with the UI-system standard; if any
+  of those are still divergent, the work is not complete
+
+## Related Docs
+
+- `ui-system.md`
+- `docs/conventions/desktop-visual-language.md`
+- `docs/conventions/local-git-hooks.md`

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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,97 @@
+# @tutti-os/ui-system
+
+Shared Nextop UI tokens, styles, icons, and low-level React primitives.
+
+This package is published to npm as `@tutti-os/ui-system`.
+
+Import the stylesheet once from the renderer or application shell:
+
+```ts
+import "@tutti-os/ui-system/styles.css";
+```
+
+Application code should prefer the root package export and the documented stable
+subpaths over deep imports from internal files.
+
+## External Development
+
+External consumers should install the package normally:
+
+```bash
+pnpm add @tutti-os/ui-system
+```
+
+For local source sync from a Nextop checkout, start the UI system dev server:
+
+```bash
+pnpm --filter @tutti-os/ui-system dev:server
+```
+
+Then add the Vite plugin in the external app:
+
+```ts
+import { nextopUISystemDev } from "@tutti-os/ui-system/dev-vite";
+
+export default defineConfig({
+  plugins: [nextopUISystemDev()]
+});
+```
+
+When the dev server is reachable, the plugin mirrors the allowed UI-system
+source and skill-support files into `.nextop-ui-system-dev/` and aliases the
+stable package entrypoints to that cache. When the dev server is unavailable,
+resolution falls back to the installed package in `node_modules`.
+
+Add the generated cache to the external app's `.gitignore`:
+
+```text
+.nextop-ui-system-dev/
+```
+
+If the external app uses Tailwind CSS, include both the installed package output
+and the generated dev cache in the app's Tailwind source scan:
+
+```css
+@source "../node_modules/@tutti-os/ui-system/dist";
+@source "../.nextop-ui-system-dev";
+```
+
+## Agent Usage
+
+Coding agents should read component metadata before creating or promoting UI:
+
+```ts
+import { uiSystemMetadata } from "@tutti-os/ui-system/metadata";
+```
+
+When promoting business UI into this package, use the bundled
+`agent/nextop-ui-system/SKILL.md` skill when it is available. In the source
+checkout, also read `AGENTS.md`, `ui-system.md`, and
+`docs/conventions/desktop-visual-language.md`. The durable rules are:
+
+1. prefer existing metadata entries before creating a component
+2. classify the component as `base` or `business`
+3. keep business components host-agnostic and side-effect-free
+4. before promoting a business component, scan source usage and define the
+   public props boundary from code evidence
+5. compose business components from base primitives
+6. add metadata, stable exports, and storyboard examples for public UI
+7. run metadata and boundary validation before shipping
+
+External repositories can install the bundled skill into their local Codex
+skill directory with one command:
+
+```bash
+pnpm exec nextop-ui-system-install-skill
+```
+
+This copies the package skill into:
+
+```text
+.codex/skills/nextop-ui-system/SKILL.md
+```
+
+When `.nextop-ui-system-dev/` is present, the installer prefers the synced
+source checkout so the installed skill and bundled UI-system rules stay aligned
+with the current local UI-system source. The installer does not overwrite a
+locally modified skill unless `--force` is provided.

package/agent/install-skill.mjs

@@ -0,0 +1,241 @@
+#!/usr/bin/env node
+
+import { constants } from "node:fs";
+import {
+  access,
+  cp,
+  mkdir,
+  readdir,
+  readFile,
+  rm,
+  stat
+} from "node:fs/promises";
+import { dirname, join, relative, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const packageRoot = dirname(dirname(fileURLToPath(import.meta.url)));
+const skillName = "nextop-ui-system";
+const devCacheDirectoryName = ".nextop-ui-system-dev";
+const companionFiles = ["AGENTS.md", "ui-system.md"];
+
+const options = parseArgs(process.argv.slice(2));
+
+if (options.help) {
+  printHelp();
+  process.exit(0);
+}
+
+const targetRoot = resolve(options.cwd, ".codex", "skills");
+const targetDirectory = join(targetRoot, skillName);
+const sourceRoot = await resolveSourceRoot(options.cwd);
+const sourceDirectory = join(sourceRoot, "agent", skillName);
+
+await assertReadableDirectory(sourceDirectory);
+await Promise.all(
+  companionFiles.map((fileName) =>
+    assertReadableFile(join(sourceRoot, fileName))
+  )
+);
+await mkdir(targetRoot, { recursive: true });
+
+if (await pathExists(targetDirectory)) {
+  const targetStats = await stat(targetDirectory);
+
+  if (!targetStats.isDirectory()) {
+    throw new Error(`Target exists and is not a directory: ${targetDirectory}`);
+  }
+
+  if (!options.force) {
+    if (await directoriesMatch(sourceRoot, sourceDirectory, targetDirectory)) {
+      console.log(
+        `nextop-ui-system skill already configured at ${targetDirectory}`
+      );
+      process.exit(0);
+    }
+
+    throw new Error(
+      `Target skill already exists with local changes: ${targetDirectory}\n` +
+        "Run with --force to replace it."
+    );
+  }
+
+  await rm(targetDirectory, { recursive: true, force: true });
+}
+
+await cp(sourceDirectory, targetDirectory, {
+  errorOnExist: false,
+  force: true,
+  recursive: true
+});
+await Promise.all(
+  companionFiles.map((fileName) =>
+    cp(join(sourceRoot, fileName), join(targetDirectory, fileName), {
+      errorOnExist: false,
+      force: true,
+      recursive: false
+    })
+  )
+);
+
+console.log(`Installed nextop-ui-system skill to ${targetDirectory}`);
+console.log(
+  "Agents can now load it from .codex/skills/nextop-ui-system/SKILL.md"
+);
+
+function parseArgs(args) {
+  const parsed = {
+    cwd: process.cwd(),
+    force: false,
+    help: false
+  };
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+
+    if (arg === "--force") {
+      parsed.force = true;
+      continue;
+    }
+
+    if (arg === "--help" || arg === "-h") {
+      parsed.help = true;
+      continue;
+    }
+
+    if (arg === "--cwd") {
+      const cwd = args[index + 1];
+      if (!cwd) {
+        throw new Error("--cwd requires a directory path");
+      }
+      parsed.cwd = resolve(cwd);
+      index += 1;
+      continue;
+    }
+
+    throw new Error(`Unknown option: ${arg}`);
+  }
+
+  return parsed;
+}
+
+function printHelp() {
+  console.log(`Usage: nextop-ui-system-install-skill [options]
+
+Copies the bundled Nextop UI System skill into the current repository.
+
+Options:
+  --cwd <path>  Repository root to configure. Defaults to the current directory.
+  --force       Replace an existing .codex/skills/nextop-ui-system directory.
+  -h, --help    Show this help message.`);
+}
+
+async function assertReadableDirectory(path) {
+  await access(path, constants.R_OK);
+  const pathStats = await stat(path);
+
+  if (!pathStats.isDirectory()) {
+    throw new Error(`Expected directory: ${path}`);
+  }
+}
+
+async function assertReadableFile(path) {
+  await access(path, constants.R_OK);
+  const pathStats = await stat(path);
+
+  if (!pathStats.isFile()) {
+    throw new Error(`Expected file: ${path}`);
+  }
+}
+
+async function pathExists(path) {
+  try {
+    await access(path, constants.F_OK);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function resolveSourceRoot(cwd) {
+  const devCacheRoot = resolve(cwd, devCacheDirectoryName);
+  const devCacheSkillDirectory = join(devCacheRoot, "agent", skillName);
+
+  if (
+    (await pathExists(devCacheSkillDirectory)) &&
+    (await pathExists(join(devCacheRoot, "AGENTS.md"))) &&
+    (await pathExists(join(devCacheRoot, "ui-system.md")))
+  ) {
+    return devCacheRoot;
+  }
+
+  return packageRoot;
+}
+
+async function directoriesMatch(sourceRoot, sourceDirectory, rightDirectory) {
+  const sourceEntries = await listBundleFiles(sourceRoot, sourceDirectory);
+  const leftEntries = sourceEntries.map((entry) => entry.targetRelativePath);
+  const rightEntries = await listFiles(rightDirectory, rightDirectory);
+
+  if (leftEntries.length !== rightEntries.length) {
+    return false;
+  }
+
+  for (let index = 0; index < leftEntries.length; index += 1) {
+    if (leftEntries[index] !== rightEntries[index]) {
+      return false;
+    }
+
+    const leftFile = sourceEntries[index].sourceAbsolutePath;
+    const rightFile = join(rightDirectory, rightEntries[index]);
+
+    const [leftContent, rightContent] = await Promise.all([
+      readFile(leftFile),
+      readFile(rightFile)
+    ]);
+
+    if (!leftContent.equals(rightContent)) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+async function listBundleFiles(sourceRoot, sourceDirectory) {
+  const skillFiles = await listFiles(sourceDirectory, sourceDirectory);
+  const companionEntries = companionFiles.map((fileName) => ({
+    sourceAbsolutePath: join(sourceRoot, fileName),
+    targetRelativePath: fileName
+  }));
+
+  return skillFiles
+    .map((relativePath) => ({
+      sourceAbsolutePath: join(sourceDirectory, relativePath),
+      targetRelativePath: relativePath
+    }))
+    .concat(companionEntries)
+    .sort((left, right) =>
+      left.targetRelativePath.localeCompare(right.targetRelativePath)
+    );
+}
+
+async function listFiles(rootDirectory, directory) {
+  const entries = await readdir(directory, { withFileTypes: true });
+  const files = await Promise.all(
+    entries.map(async (entry) => {
+      const absolutePath = join(directory, entry.name);
+
+      if (entry.isDirectory()) {
+        return listFiles(rootDirectory, absolutePath);
+      }
+
+      if (!entry.isFile()) {
+        return [];
+      }
+
+      return relative(rootDirectory, absolutePath);
+    })
+  );
+
+  return files.flat().sort((left, right) => left.localeCompare(right));
+}