@langri-sha/projen-project 0.28.0 → 0.30.0

package/src/index.ts

@@ -12,6 +12,7 @@ import {
   Codeowners,
   type CodeownersOptions,
 } from '@langri-sha/projen-codeowners'
+import { Dagger, type DaggerOptions } from '@langri-sha/projen-dagger'
 import {
   EditorConfig,
   type EditorConfigOptions,
@@ -37,9 +38,12 @@ import {
   TypeScriptConfig,
   type TypeScriptConfigOptions,
 } from '@langri-sha/projen-typescript-config'
+import { type UvOptions, UvPackage, UvWorkspace } from '@langri-sha/projen-uv'
+import { Worktrunk, type WorktrunkOptions } from '@langri-sha/projen-worktrunk'
 import {
   Project as BaseProject,
   type ProjectOptions as BaseProjectOptions,
+  type Dependency,
   DependencyType,
   IgnoreFile,
   IgnoreFileOptions,
@@ -127,6 +131,12 @@ export interface ProjectOptions extends Omit<
    */
   codeowners?: CodeownersOptions
 
+  /**
+   * Pass in to set up Dagger modules. Root projects only — modules live in
+   * top-level directories.
+   */
+  dagger?: DaggerOptions
+
   /**
    * EditorConfig options.
    */
@@ -204,10 +214,22 @@ export interface ProjectOptions extends Omit<
    */
   typeScriptConfig?: TypeScriptConfigOptions
 
+  /**
+   * Pass in to set up uv. Root projects get a workspace, subprojects a
+   * package in it.
+   */
+  uv?: UvOptions
+
   /*
    * Whether to use Terrafom.
    */
   withTerraform?: boolean
+
+  /**
+   * Configures Worktrunk, when provided. No hooks are supplied by default:
+   * each one runs on teammates' machines, so a project declares its own.
+   */
+  worktrunk?: WorktrunkOptions
 }
 
 export class Project extends BaseProject {
@@ -215,6 +237,7 @@ export class Project extends BaseProject {
   beachball?: Beachball
   cargo?: CargoPackage | CargoWorkspace
   codeowners?: Codeowners
+  dagger?: Dagger
   editorConfig?: EditorConfig
   eslint?: ESLint
   husky?: Husky
@@ -231,6 +254,8 @@ export class Project extends BaseProject {
   renovate?: Renovate
   swcrc?: SWCConfig
   typeScriptConfig?: TypeScriptConfig
+  uv?: UvPackage | UvWorkspace
+  worktrunk?: Worktrunk
 
   /**
    * Packages whose version this preset supplied because the project did not
@@ -272,6 +297,11 @@ export class Project extends BaseProject {
       this.tasks.tryFind('install:ci')?.reset()
     }
 
+    // Ahead of Prettier and Renovate, which both read the option: the SDK
+    // writes files Prettier must not touch, and the engine version is pinned
+    // in the projenrc where only a custom manager can reach it.
+    this.#configureDagger(options)
+
     this.#configureESLint(options)
     this.#configurePrettier(options)
 
@@ -289,6 +319,8 @@ export class Project extends BaseProject {
     this.#configureNpmIgnore(options)
     this.#configurePnpmWorkspace(options)
     this.#configureReadme(options)
+    this.#configureUv(options)
+    this.#configureWorktrunk(options)
     this.#configureRenovate(options)
   }
 
@@ -366,9 +398,9 @@ export class Project extends BaseProject {
    * the bump is reverted by the next synthesis, the pull request merges as a
    * no-op, and the dependency is proposed again forever.
    *
-   * Only `BUILD` declarations are consulted, which is the type `addDevDeps`
-   * writes; a package the project lists as a runtime dependency is still added
-   * here, exactly as before.
+   * A runtime declaration counts as well. The package is installed either way,
+   * and a development pin beside it would only add a second version of it to
+   * the manifest.
    */
   #addDefaultDevDeps(...specs: string[]) {
     for (const spec of specs) {
@@ -378,10 +410,12 @@ export class Project extends BaseProject {
       const name = separator > 0 ? spec.slice(0, separator) : spec
       const version = separator > 0 ? spec.slice(separator + 1) : '*'
 
-      const declared = this.deps.tryGetDependency(name, DependencyType.BUILD)
+      const declared =
+        this.deps.tryGetDependency(name, DependencyType.BUILD) ??
+        this.deps.tryGetDependency(name, DependencyType.RUNTIME)
 
       if (declared) {
-        this.#assertSupported(name, declared.version)
+        this.#assertSupported(declared)
         continue
       }
 
@@ -418,7 +452,7 @@ export class Project extends BaseProject {
    * to resolve rather than naming a version, and `workspace:` is not semver
    * at all.
    */
-  #assertSupported(name: string, declared: string | undefined) {
+  #assertSupported({ name, type, version: declared }: Dependency) {
     const supported = SUPPORTED_VERSIONS[name]
 
     if (!declared || !supported || !valid(declared)) {
@@ -429,9 +463,12 @@ export class Project extends BaseProject {
       return
     }
 
+    const option =
+      type === DependencyType.RUNTIME ? 'package.deps' : 'package.devDeps'
+
     throw new Error(
       `This project declares ${name}@${declared}, which @langri-sha/projen-project does not support — its peer range is ${supported}.\n\n` +
-        `Raise the declaration to satisfy ${supported}, or remove it from \`package.devDeps\` and take the version the preset supplies.`,
+        `Raise the declaration to satisfy ${supported}, or remove it from \`${option}\` and take the version the preset supplies.`,
     )
   }
 
@@ -447,6 +484,10 @@ export class Project extends BaseProject {
       },
     }
 
+    if (!this.parent) {
+      this.#addDefaultDevDeps('@babel/core@8.0.5')
+    }
+
     this.babel = new Babel(this, deepMerge(defaults, babel))
 
     this.typeScriptConfig?.addFile(this.babel.path)
@@ -476,7 +517,7 @@ export class Project extends BaseProject {
     this.beachball = new Beachball(this, deepMerge(defaults, beachball))
 
     this.prettier?.ignore.addPatterns('CHANGELOG.md')
-    this.#addDefaultDevDeps('beachball@2.65.6')
+    this.#addDefaultDevDeps('beachball@2.66.0')
     this.typeScriptConfig?.addFile(this.beachball!.path)
   }
 
@@ -548,6 +589,14 @@ export class Project extends BaseProject {
     this.codeowners = new Codeowners(this, codeownersOptions)
   }
 
+  #configureDagger({ dagger }: ProjectOptions) {
+    if (!dagger || this.parent) {
+      return
+    }
+
+    this.dagger = new Dagger(this, dagger)
+  }
+
   #configureEditorConfig({
     editorConfig: editorConfigOptions,
   }: ProjectOptions) {
@@ -595,6 +644,10 @@ export class Project extends BaseProject {
       extends: '@langri-sha/eslint-config',
     }
 
+    if (!this.parent) {
+      this.#addDefaultDevDeps('eslint@10.10.0')
+    }
+
     this.eslint = new ESLint(this, deepMerge(defaults, eslint))
 
     if (this.projenrc?.filePath) {
@@ -621,6 +674,7 @@ export class Project extends BaseProject {
       return
     }
 
+    this.#addDefaultDevDeps('jest@30.5.1')
     this.jestConfig = new JestConfig(this, jestConfigOptions)
 
     this.typeScriptConfig?.addFile(this.jestConfig.path)
@@ -663,6 +717,10 @@ export class Project extends BaseProject {
       extends: '@langri-sha/lint-staged',
     }
 
+    if (!this.parent) {
+      this.#addDefaultDevDeps('lint-staged@17.5.1')
+    }
+
     this.lintStaged = new LintStaged(this, deepMerge(defaults, lintStaged))
 
     this.typeScriptConfig?.addFile(this.lintStaged!.path)
@@ -756,7 +814,7 @@ export class Project extends BaseProject {
     )
   }
 
-  #configurePrettier({ prettier, package: pkg }: ProjectOptions) {
+  #configurePrettier({ dagger, prettier, package: pkg }: ProjectOptions) {
     if (!prettier || this.parent) {
       return
     }
@@ -765,9 +823,19 @@ export class Project extends BaseProject {
       filename:
         pkg?.type === 'module' ? 'prettier.config.js' : 'prettier.config.mjs',
       extends: '@langri-sha/prettier',
-      ignorePatterns: ['.*', 'dist/'],
+      ignorePatterns: [
+        '.*',
+        'dist/',
+        // Everything inside a Dagger module directory is written by the CLI or
+        // by the component, each in its own formatting. Prettier would rewrite
+        // them and `dagger develop` would put them back, on every run.
+        ...(dagger
+          ? ['*/dagger.json', '*/package.json', '*/tsconfig.json', '*/sdk/']
+          : []),
+      ],
     }
 
+    this.#addDefaultDevDeps('prettier@3.8.3')
     this.prettier = new Prettier(this, deepMerge(defaults, prettier))
 
     if (this.projenrc?.filePath) {
@@ -801,8 +869,10 @@ export class Project extends BaseProject {
 
   #configureRenovate({
     cargo,
+    dagger,
     renovate: renovateOptions,
     package: pkg,
+    uv,
   }: ProjectOptions) {
     if (!renovateOptions || this.parent) {
       return
@@ -864,6 +934,46 @@ export class Project extends BaseProject {
               },
             ]
           : []),
+        ...(dagger
+          ? [
+              {
+                description:
+                  'Move every Dagger module off one engine release at a time, the way `dagger develop` writes them',
+                groupName: 'Dagger engine',
+                groupSlug: 'dagger-engine',
+                matchDepNames: ['dagger/dagger'],
+              },
+              {
+                description:
+                  'The Dagger SDK writes the module manifests, including the TypeScript pin. Upgrades here are reverted by the next `dagger develop`',
+                matchManagers: ['npm'],
+                matchFileNames: ['*/package.json'],
+                enabled: false,
+              },
+              {
+                description:
+                  'Track the TypeScript major the Dagger SDK installs into the modules, so `check:types` keeps using the runtime compiler',
+                matchManagers: ['npm'],
+                matchPackageNames: ['typescript'],
+                allowedVersions: '^5',
+              },
+            ]
+          : []),
+        // Synthesis writes every requirement into the manifests, so a range
+        // Renovate rewrote there would be put back by its next run. Held to
+        // the declared ranges, pep621 still moves `uv.lock`, by lock-file
+        // updates and maintenance alike; raising a bound is an edit to the
+        // projenrc.
+        ...(uv
+          ? [
+              {
+                description:
+                  'Synthesis writes the pyproject.toml manifests and reverts edits to them. Move only what uv.lock pins, within the ranges they declare',
+                matchManagers: ['pep621'],
+                rangeStrategy: 'in-range-only' as const,
+              },
+            ]
+          : []),
       ],
       customManagers: [
         {
@@ -926,22 +1036,73 @@ export class Project extends BaseProject {
               },
             ]
           : []),
+        // The engine version is declared in the projenrc and written into
+        // every module manifest from there, so nothing Renovate has a manager
+        // for names it. The `v` prefix sits outside the capture group, and
+        // `extractVersionTemplate` strips it off the release tags, so the
+        // replacement leaves the prefix in place.
+        //
+        // Held to the projenrc by the anchored file pattern below, for the
+        // reason spelled out under the `packageManager` manager: a pattern
+        // that merely contains `projen` reaches the sources of every package
+        // in a monorepo named after it, and `engineVersion:` appears in this
+        // preset's own tests. A projenrc is the only file that declares one.
+        ...(dagger
+          ? [
+              {
+                customType: 'regex' as const,
+                datasourceTemplate: 'github-releases',
+                depNameTemplate: 'dagger/dagger',
+                managerFilePatterns: [
+                  '/(^|/)\\.?projenrc\\.(js|cjs|mjs|ts|mts|cts)$/',
+                ],
+                matchStrings: ["engineVersion:\\s*'v(?<currentValue>[^']+)'"],
+                extractVersionTemplate: '^v(?<version>.+)$',
+              },
+            ]
+          : []),
+        // The `packageManager` field is declared in a projenrc and only
+        // reaches the manifest through synthesis, so the npm manager reading
+        // the manifest cannot propose it. Both patterns are held to that one
+        // declaration: an unanchored `pnpm@` also matches the tail of
+        // `langri-sha/github/actions/pnpm@v0.14.1`, and a file pattern that
+        // merely contains `projen` reaches the sources of every package here,
+        // so between them Renovate walked a GitHub Action reference through
+        // four pnpm releases.
         {
           customType: 'regex',
           datasourceTemplate: 'npm',
-          managerFilePatterns: ['/\\.?projen.*.(js|cjs|mjs|ts|mts|cts)$/'],
-          matchStrings: ["pnpm@(?<currentValue>[^']+)"],
+          managerFilePatterns: [
+            '/(^|/)\\.?projenrc\\.(js|cjs|mjs|ts|mts|cts)$/',
+          ],
+          matchStrings: [
+            'packageManager[\'"]?[,:]\\s*[\'"]pnpm@(?<currentValue>[^\'"]+)[\'"]',
+          ],
           depNameTemplate: 'pnpm',
           depTypeTemplate: 'dependencies',
         },
+        // Package executions pinned to a version, which no built-in manager
+        // reads, in the workflows and the projenrcs that spell them out. The
+        // package is whatever the invocation names — forcing `depName` to
+        // `pnpm` offered pnpm's version for every other tool — and the version
+        // ends at the first space or quote.
+        //
+        // Anchored to a projenrc for the reason the two managers above are: a
+        // pattern that merely contains `projen` reaches the sources of every
+        // package here, and this preset's own tests exercise this regex
+        // against a literal `pnpx name@version`. Renovate rewrote the fixture
+        // and left the assertion beside it, failing the suite over a package
+        // nothing depends on.
         {
           customType: 'regex',
           datasourceTemplate: 'npm',
-          managerFilePatterns: ['/\\.(js|cjs|mjs|ts|mts|cts|ya?ml)$/'],
+          managerFilePatterns: [
+            '/^\\.github/workflows/[^/]+\\.ya?ml$/',
+            '/(^|/)\\.?projenrc\\.(js|cjs|mjs|ts|mts|cts)$/',
+          ],
           matchStrings: [
-            '(bun|p?np)x (?<depName>[\\w\\-\\/]+)@(?<currentValue>[^s]+)',
+            '(bun|p?np)x (?<depName>@?[\\w.-]+(?:/[\\w.-]+)?)@(?<currentValue>[^\\s\'"]+)',
           ],
-          depNameTemplate: 'pnpm',
           depTypeTemplate: 'dependencies',
         },
       ],
@@ -1023,7 +1184,7 @@ export class Project extends BaseProject {
       this.#addDefaultDevDeps('typescript@5.9.3')
 
       if (!swcrc) {
-        this.#addDefaultDevDeps('tsx@4.23.12')
+        this.#addDefaultDevDeps('tsx@4.23.13')
       }
     }
 
@@ -1032,6 +1193,48 @@ export class Project extends BaseProject {
     }
   }
 
+  /**
+   * Set up uv, as a workspace at the root and as a member package below.
+   *
+   * A package registers itself as a workspace member on the way, which is the
+   * pairing that otherwise drifts: a subproject added here and a path forgotten
+   * over there.
+   */
+  #configureUv({ uv }: ProjectOptions) {
+    if (!uv) {
+      return
+    }
+
+    // The option is the union of what either component takes, so each branch
+    // has to drop the other's keys.
+    const { pythonVersion, sampleCode, ...pyproject } = uv
+
+    if (!this.parent) {
+      this.uv = new UvWorkspace(this, { ...pyproject, pythonVersion })
+
+      return
+    }
+
+    const workspace =
+      this.root instanceof Project && this.root.uv instanceof UvWorkspace
+        ? this.root.uv
+        : undefined
+
+    this.uv = new UvPackage(this, { ...pyproject, sampleCode })
+
+    workspace?.addMember(
+      path.relative(this.root.outdir, this.outdir).split(path.sep).join('/'),
+    )
+  }
+
+  #configureWorktrunk({ worktrunk }: ProjectOptions) {
+    if (!worktrunk || this.parent) {
+      return
+    }
+
+    this.worktrunk = new Worktrunk(this, worktrunk)
+  }
+
   #populateTypeScriptProjectReferencesFromDependencies() {
     if (this.parent || !this.package || !this.typeScriptConfig) {
       return