@dbx-tools/projen 0.6.142 → 0.6.144

package/README.md

@@ -88,6 +88,43 @@ Git `#subdirectory=` URL. `root.vscode` is projen's existing VS Code component;
 dbx-tools reuses it rather than constructing a second `.vscode/settings.json`
 owner.
 
+## Add A Rust Workspace
+
+`DBXToolsRustWorkspace` discovers every source-bearing folder under
+`packages/rs`, generates its Cargo manifest, and derives the crate name from the
+root scope plus folder name. A crate containing `uniffi::setup_scaffolding!()`
+automatically wires matching private Node and Python binding packages using the
+same capability name. Repository-specific dependencies and features remain
+declarative options in `.projenrc.ts`; generated bindings are built separately
+from projen synthesis.
+
+`sync --watch` runs a focused Rust watcher beside the OpenAPI watcher. Changes
+inside an existing UniFFI crate regenerate only that crate's bindings; adding or
+removing a crate or `setup_scaffolding!()` marker triggers a full synth. Repos
+without Rust crates start no Rust watcher. When Rust projects are detected,
+Cargo is required and the focused task fails immediately if it is unavailable.
+
+The workspace also generates a `rust-release` workflow from those discovered
+UniFFI crates. It builds Linux x64/arm64, macOS x64/arm64, and Windows x64.
+Node publishes a small facade plus optional OS/CPU packages, so npm installs
+only the matching native library. Python publishes one platform-tagged wheel
+per target, so pip follows the same thin-install model.
+
+Set the repository variable `LOCAL_REPOSITORIES=true` to enable the generated
+self-hosted mirror job. Configure `LOCAL_NPM_REGISTRY` and
+`LOCAL_PYPI_PUBLISH_URL` with their matching `LOCAL_*` credentials. Set
+`LOCAL_CARGO_REGISTRY` to a named Cargo registry such as a loopback
+[Kellnr](https://kellnr.io/) instance and provide `LOCAL_CARGO_TOKEN`. The runner
+detects its OS, architecture, libc, Rust target, and Python wheel tag and builds
+only that native target. Public Cargo crates also publish directly to crates.io
+with `CARGO_REGISTRY_TOKEN`. Override `releaseTargets` only when a consumer has
+additional native runners; ordinary projects inherit the maintained matrix
+automatically.
+
+Private Python projects are marked with `[tool.dbx-tools] private = true`. They
+are excluded from the uv workspace, documentation, and Python release workflow
+until their native artifact publishing matrix is enabled.
+
 ## Customize Packages With Mixins
 
 ```ts

package/index.ts

@@ -19,11 +19,13 @@ export * as project from "./src/project.ts";
 export * as projectJs from "./src/project-js.ts";
 export * as projectPredicate from "./src/project-predicate.ts";
 export * as projectPy from "./src/project-py.ts";
+export * as projectRs from "./src/project-rs.ts";
 export * as publish from "./src/publish.ts";
 export * as release from "./src/release.ts";
 export * as scaffold from "./src/scaffold.ts";
 export * as tags from "./src/tags.ts";
 export * as tsconfig from "./src/tsconfig.ts";
+export * as uniffi from "./src/uniffi.ts";
 export * as vscode from "./src/vscode.ts";
 export * as watch from "./src/watch.ts";
 export * as workspaceVersion from "./src/workspace-version.ts";
@@ -43,12 +45,16 @@ export { PackageIdentifier, PROJEN_VERSION, DBXToolsNodeProject, ROOT_INSTALL_ON
 export type { DBXToolsJavaScriptProject, DBXToolsJavaScriptProjectOptions, DBXToolsTypeScriptProjectOptions } from "./src/project-js.ts";
 export { DBXToolsPythonProject, DBXToolsPythonWorkspace } from "./src/project-py.ts";
 export type { PythonRepositoryOptions, PythonPackageOptions, DBXToolsPythonProjectOptions, PythonReleaseOptions, DBXToolsPythonWorkspaceOptions } from "./src/project-py.ts";
+export { UNIFFI_RELEASE_TARGETS, DBXToolsRustProject, DBXToolsRustWorkspace } from "./src/project-rs.ts";
+export type { CargoDependencyOptions, CargoDependency, RustPackageOptions, DBXToolsRustWorkspaceOptions, UniFFIReleaseTarget, RustBindingMapping, RustWorkspaceMapping } from "./src/project-rs.ts";
 export { COMPILED_DIR, COMPILED_COMPILER_OPTIONS } from "./src/publish.ts";
 export { DBXToolsRelease } from "./src/release.ts";
 export type { StandaloneRelease, DBXToolsReleaseOptions } from "./src/release.ts";
 export { AGNOSTIC_COMPILER_OPTIONS, PACKAGE_TAG_MIXINS } from "./src/tags.ts";
 export type { PackageTag } from "./src/tags.ts";
 export { DBXToolsRootTsconfig } from "./src/tsconfig.ts";
+export { makeDefaultedInterfaceParametersOptional, addExplicitInterfaceReexports } from "./src/uniffi.ts";
+export type { TypeScriptBindingModule } from "./src/uniffi.ts";
 export { DBXToolsVsCode } from "./src/vscode.ts";
 export type { IgnoreGroupOptions } from "./src/watch.ts";
 export { VERSION_FILE, DEFAULT_VERSION } from "./src/workspace-version.ts";

package/package.json

@@ -26,9 +26,9 @@
   },
   "dependencies": {
     "@clack/prompts": "^1.7.0",
-    "@dbx-tools/core": "0.6.142",
-    "@dbx-tools/path": "0.6.142",
-    "@dbx-tools/shared-core": "0.6.142",
+    "@dbx-tools/core": "0.6.144",
+    "@dbx-tools/path": "0.6.144",
+    "@dbx-tools/shared-core": "0.6.144",
     "commander": "^15.0.0",
     "concurrently": "^10.0.3",
     "constructs": "^10.6.0",
@@ -48,7 +48,7 @@
   },
   "main": "index.ts",
   "license": "Apache-2.0",
-  "version": "0.6.142",
+  "version": "0.6.144",
   "types": "index.ts",
   "type": "module",
   "exports": {

package/src/barrels.ts

@@ -6,7 +6,8 @@
  * rules (see {@link isExcluded}):
  *   1. a file/folder whose name starts with `_` is private and never barrelled;
  *   2. test / `.d.ts` files are skipped;
- *   3. a `src/**​/index.ts` is a hand-authored subpath entry, not a module;
+ *   3. a hand-authored `src/**​/index.ts` is a subpath entry, while a generated
+ *      nested index is the facade for its generated folder;
  *   4. only files that actually contain an `export` are re-exported.
  *
  * A hand-authored `exports.ts` sitting next to the generated `index.ts` (a Vite-style
@@ -62,15 +63,16 @@ import { isModuleFile, toPosix, recordedPackages, repoRoot } from "./packages.ts
  *   1. any path segment starting with `_` (private module or folder);
  *   2. a test / spec file;
  *   3. a `.d.ts` declaration;
- *   4. a `src/**​/index.ts` - a hand-authored subpath entry (e.g. `src/react/index.ts`
+ *   4. a hand-authored `src/**​/index.ts` - a subpath entry (e.g. `src/react/index.ts`
  *      behind a package's `./react` export), not a module to namespace into the barrel.
+ *      Generated nested indexes are retained as the generated folder's facade.
  */
-function isExcluded(relPath: string): boolean {
+function isExcluded(relPath: string, srcDir: string): boolean {
   return (
     /(^|\/)_/.test(relPath) ||
     /\.(test|spec)\./.test(relPath) ||
     /\.d\.ts$/.test(relPath) ||
-    /(^|\/)index\.ts$/.test(relPath)
+    (/(^|\/)index\.ts$/.test(relPath) && !isGenerated(join(srcDir, relPath)))
   );
 }
 
@@ -128,12 +130,14 @@ function kebabToCamel(segment: string): string {
 /** Derive a valid namespace identifier from a relocated barrel module path. */
 function modulePathToNamespace(modulePath: string): string {
   const rel = modulePath.replace(/^\.\/src\//, "").replace(/\.(tsx?|jsx?|mjs|cjs)$/, "");
-  const segments = rel.split("/").map(kebabToCamel);
+  const segments = rel.split("/");
+  if (segments.at(-1) === "index" && segments.length > 1) segments.pop();
+  const names = segments.map(kebabToCamel);
   let name =
-    segments.length === 1
-      ? segments[0]!
-      : segments[0]! +
-        segments
+    names.length === 1
+      ? names[0]!
+      : names[0]! +
+        names
           .slice(1)
           .map((s) => string.capitalize(s))
           .join("");
@@ -315,23 +319,36 @@ function generateForPackage(pkgDir: string): number {
   const before = existsSync(rootBarrel) ? readFileSync(rootBarrel, "utf8") : undefined;
 
   // The re-exportable module set under `src/`: every source file that actually
-  // exports something, minus the private / test / declaration files and any
-  // `src/**/index.ts` (those are hand-authored subpath entries behind a package's
-  // `./sub` export, not modules to namespace into the root barrel). `findFiles`
+  // exports something, minus private / test / declaration files and hand-authored
+  // `src/**/index.ts` subpath entries. A generated nested index is retained as
+  // that generated folder's public facade. `findFiles`
   // yields posix paths relative to `srcDir`; `hasExport` parses each via
   // `moduleStatements` and needs the absolute path.
   const candidates = [...find.findFiles("**/*", { cwd: srcDir })]
     .map(toPosix)
-    .filter(isModuleFile)
-    .filter((f) => !isExcluded(f))
+    .filter(
+      (file) =>
+        isModuleFile(file) || (/(^|\/)index\.ts$/.test(file) && isGenerated(join(srcDir, file))),
+    )
+    .filter((f) => !isExcluded(f, srcDir))
     .filter((f) => hasExport(join(srcDir, f)));
 
+  const generatedIndexDirs = new Set(
+    candidates
+      .filter((file) => /(^|\/)index\.ts$/.test(file) && isGenerated(join(srcDir, file)))
+      .map((file) => file.replace(/(^|\/)index\.ts$/, "")),
+  );
+  const publicCandidates = candidates.filter((file) => {
+    if (/(^|\/)index\.ts$/.test(file)) return true;
+    return ![...generatedIndexDirs].some((dir) => dir && file.startsWith(`${dir}/`));
+  });
+
   // Collapse each extensionless module path to one entry, preferring a TypeScript
   // source over a sibling compiled artifact (`math.ts` wins over a committed
   // `math.js`), so a module is barrelled exactly once. Then sort by module path.
   const byModulePath = new Map<string, string>();
-  for (const f of candidates) {
-    const stem = f.replace(MODULE_EXT_RE, "");
+  for (const f of publicCandidates) {
+    const stem = f.replace(/(^|\/)index\.ts$/, "").replace(MODULE_EXT_RE, "");
     const existing = byModulePath.get(stem);
     if (!existing || (!isSourceExt(existing) && isSourceExt(f))) byModulePath.set(stem, f);
   }

package/src/packages.ts

@@ -269,7 +269,7 @@ export function readPackageManifest(dir: string): Record<string, unknown> | unde
 }
 
 /** A package's `dbxToolsConfig` object, or `undefined` when absent. */
-function readDbxToolsConfig(dir: string): Record<string, unknown> | undefined {
+export function readDbxToolsConfig(dir: string): Record<string, unknown> | undefined {
   const config = readPackageManifest(dir)?.dbxToolsConfig;
   return object.isRecord(config) ? config : undefined;
 }

package/src/project-predicate.ts

@@ -33,7 +33,8 @@ export function isDBXToolsProject(): Predicate<IConstruct, DBXToolsProject> {
   return isProject().and(
     (project): project is DBXToolsProject =>
       (project as Partial<DBXToolsProject>).language === "javascript" ||
-      (project as Partial<DBXToolsProject>).language === "python",
+      (project as Partial<DBXToolsProject>).language === "python" ||
+      (project as Partial<DBXToolsProject>).language === "rust",
   );
 }
 

package/src/project-py.ts

@@ -23,6 +23,8 @@ export interface PythonPackageOptions extends DBXToolsProjectOptions {
   readonly description: string;
   readonly dependencies?: readonly string[];
   readonly scripts?: Readonly<Record<string, string>>;
+  /** Keep this package unpublished and out of public docs and releases. */
+  readonly private?: boolean;
 }
 
 /** Options for one projen-native Python workspace member. */
@@ -58,6 +60,8 @@ export interface DBXToolsPythonWorkspaceOptions {
   readonly testPaths?: readonly string[];
   readonly lintPaths?: readonly string[];
   readonly ruffPerFileIgnores?: Readonly<Record<string, readonly string[]>>;
+  /** Generated Python implementation files Pyrefly should resolve but not type-check. */
+  readonly pyreflyProjectExcludes?: readonly string[];
   readonly interpreterPath?: string | false;
   readonly release?: boolean | PythonReleaseOptions;
 }
@@ -171,6 +175,9 @@ export class DBXToolsPythonProject extends python.PythonProject implements DBXTo
     if (pkg.scripts) {
       this.uv.file.addOverride("project.scripts", pkg.scripts);
     }
+    if (pkg.private) {
+      this.uv.file.addOverride("tool.dbx-tools.private", true);
+    }
     formatPyproject(this.uv.file);
     this.uv.file.readonly = true;
 
@@ -263,7 +270,9 @@ export class DBXToolsPythonWorkspace extends Component {
       tool: {
         uv: python.uvConfig.toJson_UvConfiguration({
           package: false,
-          workspace: { members: [`${this.repository.root}/*`] },
+          workspace: {
+            members: [`${this.repository.root}/*`],
+          },
         }),
         pytest: {
           ini_options: {
@@ -283,6 +292,10 @@ export class DBXToolsPythonWorkspace extends Component {
     if (options.indexStrategy) {
       file.addOverride("tool.uv.index-strategy", options.indexStrategy);
     }
+    file.addOverride("tool.pyrefly.ignore-errors-in-generated-code", true);
+    if (options.pyreflyProjectExcludes?.length) {
+      file.addOverride("tool.pyrefly.project-excludes", [...options.pyreflyProjectExcludes]);
+    }
     file.addOverride(
       "tool.uv.sources",
       Object.fromEntries(options.packages.map((pkg) => [pkg.name, { workspace: true }])),
@@ -318,6 +331,8 @@ export class DBXToolsPythonWorkspace extends Component {
 
   private addReleaseWorkflow(project: javascript.NodeProject, options: PythonReleaseOptions): void {
     if (!project.github) return;
+    const publishablePackages = this.packages.filter((pkg) => !pkg.packageOptions.private);
+    if (publishablePackages.length === 0) return;
     const workflow = new GithubWorkflow(project.github, options.workflowName ?? "python-release");
     workflow.file?.addOverride("permissions", { contents: "read" });
     workflow.on({ push: { tags: ["v*"] }, workflowDispatch: {} });
@@ -346,7 +361,7 @@ export class DBXToolsPythonWorkspace extends Component {
         },
         {
           name: "Build distributions",
-          run: this.packages
+          run: publishablePackages
             .map(
               (pkg) =>
                 `uv build --package ${pkg.packageOptions.name} --out-dir dist/${pkg.packageOptions.directory}`,
@@ -356,7 +371,7 @@ export class DBXToolsPythonWorkspace extends Component {
         {
           name: "Validate distributions",
           run: [
-            `test "$(find dist -type f \\( -name '*.whl' -o -name '*.tar.gz' \\) | wc -l | tr -d ' ')" -eq ${this.packages.length * 2}`,
+            `test "$(find dist -type f \\( -name '*.whl' -o -name '*.tar.gz' \\) | wc -l | tr -d ' ')" -eq ${publishablePackages.length * 2}`,
             "uvx twine check dist/*/*.whl dist/*/*.tar.gz",
           ].join("\n"),
         },
@@ -367,7 +382,7 @@ export class DBXToolsPythonWorkspace extends Component {
         },
       ],
     });
-    for (const pkg of this.packages) {
+    for (const pkg of publishablePackages) {
       workflow.addJob(`publish-${pkg.packageOptions.directory}`, {
         if: "${{ github.event_name == 'push' }}",
         needs: ["build"],