Skip to content

chore: align repo scaffolding with the package standard - #17

Merged
TheGreatAxios merged 4 commits into
cl-9371-embedding-switch-to-oxfmt-and-oxlintfrom
cl-9388-embedding-align-repo-scaffolding-with-the-package-standard
Sep 27, 2026
Merged

TheGreatAxios merged 4 commits into
cl-9371-embedding-switch-to-oxfmt-and-oxlintfrom
cl-9388-embedding-align-repo-scaffolding-with-the-package-standard

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Closes CL-9388

Summary

  • LICENSE: the Interchange LGPL-2.1 text, byte-identical across @corbits repos (was the FSF text); add CLA.md and the cla.yml CLA Assistant workflow
  • package.json: drop main/types (exports covers Node 24 and Bun); add keywords; homepage points at #readme; scripts are the standard set: build clears dist first, test runs bun test src --pass-with-no-tests and test:e2e runs e2e, and a new check runs typecheck, lint, format check and unit tests. Key order is oxfmt's
  • tsconfig.json and tsconfig.build.json follow the standard templates: drops the intx-src custom condition, composite, allowJs and the declaration settings from the typecheck config; the build config extends it. No source changes were needed
  • .gitignore: standard list (adds *.tgz, coverage/, .env*, .DS_Store)
  • ci.yml: bun run check, bun run test:e2e, then a pack-and-import smoke under Node 24 that checks embedTexts, probeEmbedDims and EmbeddingRequestError; drops the single-entry matrix and bun-version: latest
  • AGENTS.md: purpose, layout, rules and local development, with the invariants that were in ARCHITECTURE.md
  • Delete PRODUCT.md, ARCHITECTURE.md and IMPLEMENTATION.md

Stacked on #16.

  • CONTRIBUTING gets a Releasing section: releases are manual, as in Interchange (npm version, push tags, gh release create --generate-notes, npm publish).

Commits

  1. chore: use the Interchange LICENSE text and add the CLA
  2. build: align package.json and tsconfig with the package standard
  3. ci: run check and a Node pack smoke
  4. docs: trim CONTRIBUTING, add AGENTS.md, drop planning docs

Checks

bun run build, bun run check and bun run test:e2e pass; the Node pack smoke passes locally.

@TheGreatAxios
TheGreatAxios added this pull request to stack #15 September 26, 2026 02:52
@TheGreatAxios
TheGreatAxios force-pushed the cl-9388-embedding-align-repo-scaffolding-with-the-package-standard branch 2 times, most recently from 87c19a8 to 2933453 Compare September 26, 2026 02:58
@TheGreatAxios
TheGreatAxios force-pushed the cl-9388-embedding-align-repo-scaffolding-with-the-package-standard branch from 2933453 to f2f1a9d Compare September 26, 2026 03:00
@TheGreatAxios
TheGreatAxios force-pushed the cl-9388-embedding-align-repo-scaffolding-with-the-package-standard branch from f2f1a9d to 1d622ec Compare September 26, 2026 04:12
@TheGreatAxios
TheGreatAxios force-pushed the cl-9388-embedding-align-repo-scaffolding-with-the-package-standard branch from 1d622ec to 8927fef Compare September 26, 2026 04:39
@TheGreatAxios
TheGreatAxios merged commit 7526a02 into main Sep 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant