@dbx-tools/projen 0.6.211 → 0.6.212

package/index.ts

@@ -3,7 +3,7 @@
 // Hand edits are overwritten on the next watch; this file is read-only.
 
 export const PACKAGE_IDENTIFIER = "@dbx-tools/projen";
-export const PACKAGE_VERSION = "0.6.211";
+export const PACKAGE_VERSION = "0.6.212";
 export * as barrels from "./src/barrels.ts";
 export * as bunApp from "./src/bun-app.ts";
 export * as bunWorkflow from "./src/bun-workflow.ts";
@@ -46,7 +46,7 @@ export type { RecordedPackage } from "./src/packages.ts";
 export { PnpmWorkspaceState } from "./src/pnpm-workspace.ts";
 export type { Catalog, AllowBuilds, DBXToolsPNPMWorkspaceOptions } from "./src/pnpm-workspace.ts";
 export type { DBXToolsProjectLanguage, DBXToolsProjectOptions, DBXToolsProject, ApplyToProjectsOptions } from "./src/project.ts";
-export { PackageIdentifier, PROJEN_VERSION, DBXToolsNodeProject, ROOT_INSTALL_ONLY_MIXIN, DBXToolsTypeScriptProject } from "./src/project-js.ts";
+export { PackageIdentifier, PROJEN_VERSION, DBX_TOOLS_LICENSE, DBXToolsNodeProject, ROOT_INSTALL_ONLY_MIXIN, DBXToolsTypeScriptProject } from "./src/project-js.ts";
 export type { DBXToolsJavaScriptProject, DBXToolsJavaScriptProjectOptions, DBXToolsTypeScriptProjectOptions } from "./src/project-js.ts";
 export { DBXToolsPythonProject, DBXToolsPythonWorkspace } from "./src/project-py.ts";
 export type { PythonRepositoryOptions, PythonPackageOptions, PythonTrustedPublisherOptions, DBXToolsPythonProjectOptions, PythonReleaseOptions, DBXToolsPythonWorkspaceOptions } from "./src/project-py.ts";

package/package.json

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

package/src/_release-platform.ts

@@ -1,4 +1,58 @@
-/** Cartesian-product release target filter shared by the bump task. */
+import { Option } from "commander";
+import type { VersionLevel } from "./workspace-version.ts";
+
+/** Supported semantic version increments for release commands. */
+export const RELEASE_LEVELS = [
+  "patch",
+  "minor",
+  "major",
+] as const satisfies readonly VersionLevel[];
+
+/** Supported release operating systems. */
+export const RELEASE_OSES = ["darwin", "linux", "win32"] as const;
+
+/** Supported release CPU architectures. */
+export const RELEASE_ARCHES = ["arm64", "x64"] as const;
+
+/** Release operating system selector. */
+export type ReleaseOs = (typeof RELEASE_OSES)[number];
+
+/** Release CPU architecture selector. */
+export type ReleaseArch = (typeof RELEASE_ARCHES)[number];
+
+export type { VersionLevel } from "./workspace-version.ts";
+
+function collectValue<T extends string>(value: T, previous: T[]): T[] {
+  return [...previous, value];
+}
+
+/** Commander option for selecting the semantic release increment. */
+export function releaseLevelOption(): Option {
+  return new Option("-l, --level <level>", "semver increment")
+    .choices([...RELEASE_LEVELS])
+    .default("patch");
+}
+
+/** Repeatable Commander option for release operating systems. */
+export function releaseOperatingSystemOption(): Option {
+  return new Option("--os <os>", "release operating system, repeatable; crossed with every --arch")
+    .choices([...RELEASE_OSES])
+    .argParser((value, previous: ReleaseOs[]) => collectValue(value as ReleaseOs, previous))
+    .default([] as ReleaseOs[]);
+}
+
+/** Repeatable Commander option for release CPU architectures. */
+export function releaseArchitectureOption(): Option {
+  return new Option(
+    "--arch <arch>",
+    "release CPU architecture, repeatable; crossed with every --os",
+  )
+    .choices([...RELEASE_ARCHES])
+    .argParser((value, previous: ReleaseArch[]) => collectValue(value as ReleaseArch, previous))
+    .default([] as ReleaseArch[]);
+}
+
+/** Cartesian-product release target filter shared by release commands. */
 export function releasePlatformFilter(
   operatingSystems: readonly string[],
   architectures: readonly string[],

package/src/project-js.ts

@@ -378,6 +378,9 @@ const PRETTIER_SETTINGS: javascript.PrettierSettings = {
  */
 export const PROJEN_VERSION = "^0.101.16";
 
+/** SPDX license shared by generated JavaScript, Python, and Rust packages. */
+export const DBX_TOOLS_LICENSE = "Apache-2.0";
+
 /**
  * The engine's opinionated `NodeProject` defaults. A caller's own options override
  * these (they are spread AFTER this). Root-only concerns key off `options.parent`,
@@ -432,7 +435,8 @@ function defaultProjectOptions(
     jest: false,
     github: false,
     npmignoreEnabled: false,
-    licensed: false,
+    license: DBX_TOOLS_LICENSE,
+    licensed: true,
     entrypoint: "",
     depsUpgrade: false,
     // Bins are declared explicitly via `p.package.addBin(...)`. projen's default
@@ -527,6 +531,12 @@ export interface DBXToolsJavaScriptProjectOptions
    * Only a ROOT scans. Defaults to {@link DEFAULT_PACKAGE_ROOTS}.
    */
   readonly packageRoots?: readonly string[];
+  /**
+   * Descriptions for published packages, keyed by repository-relative package
+   * directory. When configured, synthesis rejects every public JavaScript
+   * package whose final manifest has no non-empty description.
+   */
+  readonly packageDescriptions?: Readonly<Record<string, string>>;
   /**
    * Leading path segment(s) dropped from a discovered package's relative path
    * before its npm name is derived, so a tier folder doesn't become a name
@@ -1062,6 +1072,48 @@ function registerRootTasks(project: javascript.NodeProject): void {
   });
 }
 
+function descendantJavaScriptProjects(
+  parent: Project,
+): Array<DBXToolsNodeProject | DBXToolsTypeScriptProject> {
+  return parent.subprojects.flatMap((subproject) => [
+    ...(subproject instanceof DBXToolsNodeProject || subproject instanceof DBXToolsTypeScriptProject
+      ? [subproject]
+      : []),
+    ...descendantJavaScriptProjects(subproject),
+  ]);
+}
+
+class PublishedPackageDescriptionValidation extends Component {
+  constructor(
+    project: DBXToolsNodeProject | DBXToolsTypeScriptProject,
+    private readonly configuredDescriptions: Readonly<Record<string, string>>,
+  ) {
+    super(project);
+  }
+
+  public override preSynthesize(): void {
+    const root = this.project as DBXToolsNodeProject | DBXToolsTypeScriptProject;
+    const packages = new Map(
+      descendantJavaScriptProjects(root).map((pkg) => [
+        toPosix(relative(root.outdir, pkg.outdir)),
+        pkg,
+      ]),
+    );
+    for (const packagePath of Object.keys(this.configuredDescriptions)) {
+      if (!packages.has(packagePath)) {
+        throw new Error(`Package description targets unknown package ${packagePath}`);
+      }
+    }
+    for (const [packagePath, pkg] of packages) {
+      if (pkg.package.manifest.private === true) continue;
+      const description = pkg.package.manifest.description;
+      if (typeof description !== "string" || !description.trim()) {
+        throw new Error(`Published package ${packagePath} requires a non-empty description`);
+      }
+    }
+  }
+}
+
 /**
  * `bun node_modules/@dbx-tools/projen/tasks/<script>` command for a projen task.
  *
@@ -1289,6 +1341,15 @@ function initProject(
     });
   }
 
+  if (options.packageDescriptions) {
+    for (const pkg of descendantJavaScriptProjects(project)) {
+      const packagePath = toPosix(relative(rootAbs, pkg.outdir));
+      const description = options.packageDescriptions[packagePath];
+      if (description !== undefined) pkg.package.addField("description", description.trim());
+    }
+    new PublishedPackageDescriptionValidation(project, options.packageDescriptions);
+  }
+
   // The root project may itself carry tags (via a `""`/`"."` tag-path key).
   const rootTags = [...new Set([...(tagPaths[""] ?? []), ...(tagPaths["."] ?? [])])];
   if (rootTags.length) project.dbxToolsConfig.tags.push(...rootTags);

package/src/project-py.ts

@@ -1,12 +1,12 @@
 /** Reusable uv workspace generation for Python packages hosted in a projen tree. */
 import { project as coreProject } from "@dbx-tools/core";
 import { string } from "@dbx-tools/shared-core";
-import { Component, TextFile, type Project, javascript, python, vscode } from "projen";
+import { Component, License, TextFile, type Project, javascript, python, vscode } from "projen";
 import type { IResolver } from "projen/lib/file";
 import { JobPermission } from "projen/lib/github/workflows-model";
 import { parse, stringify } from "smol-toml";
 import { BUN_VERSION, bunCacheRestoreSteps, bunCacheSaveStep } from "./bun-workflow.ts";
-import { projectReleaseBranch, projectRepositoryUrl } from "./project-js.ts";
+import { DBX_TOOLS_LICENSE, projectReleaseBranch, projectRepositoryUrl } from "./project-js.ts";
 import { isDBXToolsJavaScriptProject } from "./project-predicate.ts";
 import type { DBXToolsProject, DBXToolsProjectOptions } from "./project.ts";
 import { RELEASE_VERSION, releaseSourceSteps } from "./release-dispatch.ts";
@@ -169,6 +169,7 @@ export class DBXToolsPythonProject extends python.PythonProject implements DBXTo
       authorEmail: "",
       version: options.version,
       description: pkg.description,
+      license: DBX_TOOLS_LICENSE,
       github: false,
       sample: false,
       pytest: false,
@@ -187,6 +188,7 @@ export class DBXToolsPythonProject extends python.PythonProject implements DBXTo
           version: options.version,
           description: pkg.description,
           readme: "README.md",
+          licenseFiles: ["LICENSE"],
           requiresPython: options.requiresPython,
           dependencies: [...(pkg.dependencies ?? [])],
           urls: {
@@ -206,6 +208,7 @@ export class DBXToolsPythonProject extends python.PythonProject implements DBXTo
         },
       },
     });
+    new License(this, { spdx: DBX_TOOLS_LICENSE });
     this.packageOptions = pkg;
     if (!(this.packagingManager instanceof python.Uv)) {
       throw new Error(`Expected uv packaging for ${pkg.name}`);