@langri-sha/projen-project 0.32.1 → 0.34.0

package/src/index.ts

@@ -1,45 +1,6 @@
 import { createRequire } from 'node:module'
 import * as path from 'node:path'
 
-import { Babel, BabelOptions } from '@langri-sha/projen-babel'
-import { Beachball, BeachballOptions } from '@langri-sha/projen-beachball'
-import {
-  type CargoOptions,
-  CargoPackage,
-  CargoWorkspace,
-} from '@langri-sha/projen-cargo'
-import {
-  Codeowners,
-  type CodeownersOptions,
-} from '@langri-sha/projen-codeowners'
-import { Dagger, type DaggerOptions } from '@langri-sha/projen-dagger'
-import {
-  EditorConfig,
-  type EditorConfigOptions,
-} from '@langri-sha/projen-editorconfig'
-import { ESLint, ESLintOptions } from '@langri-sha/projen-eslint'
-import { Husky, type HuskyOptions } from '@langri-sha/projen-husky'
-import { JestConfig, JestConfigOptions } from '@langri-sha/projen-jest-config'
-import { License } from '@langri-sha/projen-license'
-import { LintStaged, LintStagedOptions } from '@langri-sha/projen-lint-staged'
-import {
-  LintSynthesized,
-  type LintSynthesizedOptions,
-} from '@langri-sha/projen-lint-synthesized'
-import {
-  PnpmWorkspace,
-  PnpmWorkspaceOptions,
-} from '@langri-sha/projen-pnpm-workspace'
-import { Prettier, PrettierOptions } from '@langri-sha/projen-prettier'
-import { ReadmeFile, type ReadmeFileOptions } from '@langri-sha/projen-readme'
-import { Renovate, type RenovateOptions } from '@langri-sha/projen-renovate'
-import { SWCConfig, type SWCConfigOptions } from '@langri-sha/projen-swcrc'
-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,
@@ -49,13 +10,41 @@ import {
   IgnoreFileOptions,
   javascript,
 } from 'projen'
+import { Babel, BabelOptions } from 'projen-babel-config'
+import { Beachball, BeachballOptions } from 'projen-beachball'
+import { type CargoOptions, CargoPackage, CargoWorkspace } from 'projen-cargo'
+import { Codeowners, type CodeownersOptions } from 'projen-codeowners'
+import { Dagger, type DaggerOptions } from 'projen-dagger'
+import { EditorConfig, type EditorConfigOptions } from 'projen-editorconfig'
+import { ESLint, ESLintOptions } from 'projen-eslint'
+import { Husky, type HuskyOptions } from 'projen-husky'
+import { JestConfig, JestConfigOptions } from 'projen-jest-config'
+import { License } from 'projen-license'
+import { LintStaged, LintStagedOptions } from 'projen-lint-staged'
+import {
+  LintSynthesized,
+  type LintSynthesizedOptions,
+} from 'projen-lint-synthesized'
+import { PnpmWorkspace, PnpmWorkspaceOptions } from 'projen-pnpm-workspace'
+import { Prettier, PrettierOptions } from 'projen-prettier'
+import { ReadmeFile, type ReadmeFileOptions } from 'projen-readme'
+import { Renovate, type RenovateOptions } from 'projen-renovate'
+import { Ruff, type RuffOptions } from 'projen-ruff'
+import { SWCConfig, type SWCConfigOptions } from 'projen-swcrc'
+import { type SupportedPythonVersion, Ty, type TyOptions } from 'projen-ty'
+import {
+  TypeScriptConfig,
+  type TypeScriptConfigOptions,
+} from 'projen-typescript-config'
+import { type UvOptions, UvPackage, UvWorkspace } from 'projen-uv'
+import { Worktrunk, type WorktrunkOptions, pipeline } from 'projen-worktrunk'
 import * as R from 'ramda'
 import { satisfies, valid } from 'semver'
 
 import { GitAttributesFile } from './lib/gitattributes.js'
 import { NodePackage, NodePackageOptions, ProjenrcFile } from './lib/index.js'
 
-export * from '@langri-sha/projen-typescript-config'
+export * from 'projen-typescript-config'
 
 /**
  * The package manager assumed when a project does not name one.
@@ -77,6 +66,38 @@ const PROJEN_COMMANDS: Record<javascript.NodePackageManager, string> = {
   [javascript.NodePackageManager.YARN_CLASSIC]: 'yarn projen',
 }
 
+/**
+ * The name of the command that installs dependencies in a worktree hook, per
+ * package manager. The binary rather than the enum value, so that every yarn
+ * version is `yarn`.
+ */
+const PACKAGE_MANAGER_BINARIES: Record<javascript.NodePackageManager, string> =
+  {
+    [javascript.NodePackageManager.BUN]: 'bun',
+    [javascript.NodePackageManager.NPM]: 'npm',
+    [javascript.NodePackageManager.PNPM]: 'pnpm',
+    [javascript.NodePackageManager.YARN]: 'yarn',
+    [javascript.NodePackageManager.YARN2]: 'yarn',
+    [javascript.NodePackageManager.YARN_BERRY]: 'yarn',
+    [javascript.NodePackageManager.YARN_CLASSIC]: 'yarn',
+  }
+
+/**
+ * The `sync` command of the default `pre-start` pipeline. Worktrunk fails on
+ * undefined variables, and leaves `remote` undefined in a repository with no
+ * remote and `base` undefined for a worktree on an existing branch, so the
+ * command is skipped there. Worktrunk approves a command by its exact text, so
+ * editing it asks every teammate to approve it again.
+ */
+const WORKTRUNK_SYNC_COMMAND =
+  '{% if remote and base and base == default_branch %}git fetch {{ remote }} {{ default_branch }} && git merge --ff-only --quiet {{ remote }}/{{ default_branch }}{% endif %}'
+
+/**
+ * Copies each tracked `.env.example` to a `.env` that is missing.
+ */
+const WORKTRUNK_ENV_COMMAND =
+  'git ls-files -- ":(glob)**/.env.example" | while read -r example; do target=${example%.example}; [ -e "$target" ] || cp "$example" "$target"; done'
+
 /**
  * How long a release must have been published before Renovate proposes it.
  *
@@ -204,11 +225,30 @@ export interface ProjectOptions extends Omit<
    */
   renovate?: RenovateOptions
 
+  /**
+   * Pass in to configure Ruff. Root projects only: Ruff takes the nearest
+   * configuration, so one at the root covers the whole workspace.
+   *
+   * With `lintStaged`, staged Python files are fixed and formatted on commit,
+   * through `uv run --frozen` when `uv` is set, so ruff comes from `uv.lock`:
+   * declare it in the workspace's `dev` group, or `uv run` falls back to
+   * whatever ruff is on the `PATH`.
+   */
+  ruff?: RuffOptions
+
   /*
    * Pass in to configure SWC.
    */
   swcrc?: SWCConfigOptions
 
+  /**
+   * Pass in to configure ty. Root projects only, like `ruff`.
+   *
+   * With `uv.pythonVersion` set, `environment.python-version` follows it; set
+   * it to `null` to leave the version to ty.
+   */
+  ty?: TyOptions
+
   /**
    * TypeScript configuration options.
    */
@@ -226,8 +266,8 @@ export interface ProjectOptions extends Omit<
   withTerraform?: boolean
 
   /**
-   * Configures Worktrunk, when provided. No hooks are supplied by default:
-   * each one runs on teammates' machines, so a project declares its own.
+   * Configures Worktrunk, when provided. Supplies a default `pre-start`
+   * pipeline, which a `pre-start` in `config`, in any form, replaces whole.
    */
   worktrunk?: WorktrunkOptions
 }
@@ -252,7 +292,9 @@ export class Project extends BaseProject {
   projenrc?: ProjenrcFile
   readme?: ReadmeFile
   renovate?: Renovate
+  ruff?: Ruff
   swcrc?: SWCConfig
+  ty?: Ty
   typeScriptConfig?: TypeScriptConfig
   uv?: UvPackage | UvWorkspace
   worktrunk?: Worktrunk
@@ -319,6 +361,8 @@ export class Project extends BaseProject {
     this.#configureNpmIgnore(options)
     this.#configurePnpmWorkspace(options)
     this.#configureReadme(options)
+    this.#configureRuff(options)
+    this.#configureTy(options)
     this.#configureUv(options)
     this.#configureWorktrunk(options)
     this.#configureRenovate(options)
@@ -599,6 +643,7 @@ export class Project extends BaseProject {
 
   #configureEditorConfig({
     editorConfig: editorConfigOptions,
+    uv,
   }: ProjectOptions) {
     if (!editorConfigOptions || this.parent) {
       return
@@ -616,11 +661,19 @@ export class Project extends BaseProject {
       Dockerfile: {
         indent_style: 'tab',
       },
+      // What ruff formats Python to. It ignores EditorConfig, so editors
+      // indenting at anything else are corrected on every format.
+      ...(uv && {
+        '*.{py,pyi}': {
+          indent_style: 'space',
+          indent_size: 4,
+        },
+      }),
     }
 
     this.editorConfig = new EditorConfig(
       this,
-      deepMerge(editorConfigOptions ?? {}, defaults),
+      deepMerge(defaults, editorConfigOptions),
     )
 
     this.prettier?.ignore.addPatterns('!.editorconfig')
@@ -704,7 +757,7 @@ export class Project extends BaseProject {
     })
   }
 
-  #configureLintStaged({ lintStaged, package: pkg }: ProjectOptions) {
+  #configureLintStaged({ lintStaged, package: pkg, ruff, uv }: ProjectOptions) {
     if (!lintStaged) {
       return
     }
@@ -721,7 +774,34 @@ export class Project extends BaseProject {
       this.#addDefaultDevDeps('lint-staged@17.6.0')
     }
 
-    this.lintStaged = new LintStaged(this, deepMerge(defaults, lintStaged))
+    // ruff is configured at the root alone, but lint-staged runs the nearest
+    // configuration to each staged file, so a subproject's runs ruff as well.
+    const root = this.root instanceof Project ? this.root : undefined
+    const withRuff = this.parent ? root?.ruff : ruff
+    const withUv = uv ?? (this.parent ? root?.uv : undefined)
+
+    // ruff fixes before it formats, so that the formatter has the last word.
+    // lint-staged names the files, which ruff checks even where the project
+    // excludes them unless forced to exclude. Since 17.6 it also stages every
+    // file a task changes, so `uv run` must not re-lock the workspace.
+    const ruffCommand = withUv ? 'uv run --frozen ruff' : 'ruff'
+    const python = withRuff
+      ? {
+          '*.{py,pyi}': [
+            `${ruffCommand} check --fix --force-exclude`,
+            `${ruffCommand} format --force-exclude`,
+          ],
+        }
+      : {}
+
+    const { config, ...options } = deepMerge(defaults, lintStaged)
+
+    // Spread rather than merged, so that a project's own glob replaces these
+    // the way it replaces those of the configuration it extends.
+    this.lintStaged = new LintStaged(this, {
+      ...options,
+      config: { ...python, ...config },
+    })
 
     this.typeScriptConfig?.addFile(this.lintStaged!.path)
   }
@@ -1085,6 +1165,26 @@ export class Project extends BaseProject {
               },
             ]
           : []),
+        // `.python-version` is synthesized from the projenrc, so pyenv's update
+        // to the file alone would be put back by the next synthesis. Read with
+        // pyenv's depName, datasource and versioning, the declaration moves on
+        // the same branch as the file. Held to the projenrc for the reason
+        // spelled out under the `packageManager` manager, and because
+        // `pythonVersion:` appears in this preset's tests and projen-uv's.
+        ...(uv?.pythonVersion
+          ? [
+              {
+                customType: 'regex' as const,
+                datasourceTemplate: 'docker',
+                depNameTemplate: 'python',
+                versioningTemplate: 'docker',
+                managerFilePatterns: [
+                  '/(^|/)\\.?projenrc\\.(js|cjs|mjs|ts|mts|cts)$/',
+                ],
+                matchStrings: ["pythonVersion:\\s*'(?<currentValue>[^']+)'"],
+              },
+            ]
+          : []),
         // 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
@@ -1111,9 +1211,9 @@ export class Project extends BaseProject {
         // `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
+        // Anchored to a projenrc for the reason the anchored 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.
@@ -1140,6 +1240,14 @@ export class Project extends BaseProject {
     this.renovate = new Renovate(this, deepMerge(defaults, renovateOptions))
   }
 
+  #configureRuff({ ruff }: ProjectOptions) {
+    if (!ruff || this.parent) {
+      return
+    }
+
+    this.ruff = new Ruff(this, ruff)
+  }
+
   #configureSWC({ swcrc, typeScriptConfig }: ProjectOptions) {
     if (!swcrc) {
       return
@@ -1170,6 +1278,29 @@ export class Project extends BaseProject {
     this.swcrc = new SWCConfig(this, deepMerge(defaults, swcrc))
   }
 
+  #configureTy({ ty, uv }: ProjectOptions) {
+    if (!ty || this.parent) {
+      return
+    }
+
+    // ty takes `major.minor` alone, so a pinned patch release is cut back to
+    // it and a pinned implementation is left to ty. The schema's type lists
+    // only the versions ty knew when it was published; a newer one is ty's
+    // to refuse.
+    const pythonVersion = uv?.pythonVersion?.match(/^\d+\.\d+/)?.[0] as
+      SupportedPythonVersion | undefined
+
+    const defaults: TyOptions = {
+      ...(pythonVersion && {
+        environment: {
+          'python-version': pythonVersion,
+        },
+      }),
+    }
+
+    this.ty = new Ty(this, deepMerge(defaults, ty))
+  }
+
   #configureTypeScript({ parent, typeScriptConfig }: ProjectOptions) {
     if (!typeScriptConfig) {
       return
@@ -1252,7 +1383,33 @@ export class Project extends BaseProject {
       return
     }
 
-    this.worktrunk = new Worktrunk(this, worktrunk)
+    // Replaced whole per event, not deep-merged like the other defaults: the
+    // three hook forms cannot be merged into one another.
+    this.worktrunk = new Worktrunk(this, {
+      ...worktrunk,
+      config: {
+        ...worktrunk.config,
+        'pre-start': worktrunk.config?.['pre-start'] ?? this.#defaultPreStart(),
+      },
+    })
+  }
+
+  /**
+   * The install commands are the components' own text, so an upgrade that
+   * changes one asks every teammate to approve the hook again.
+   */
+  #defaultPreStart() {
+    const install = this.package && {
+      [PACKAGE_MANAGER_BINARIES[this.package.packageManager]]:
+        this.package.installCommand,
+    }
+    const cargo = this.cargo && { cargo: this.cargo.installCommand }
+    const uv = this.uv && { uv: this.uv.installCommand }
+
+    return pipeline(
+      { sync: WORKTRUNK_SYNC_COMMAND },
+      { env: WORKTRUNK_ENV_COMMAND, ...install, ...cargo, ...uv },
+    )
   }
 
   #populateTypeScriptProjectReferencesFromDependencies() {
@@ -1297,6 +1454,7 @@ const getGitIgnoreOptions = ({
   parent,
   typeScriptConfig: typeScriptConfigOptions,
   withTerraform,
+  worktrunk,
 }: ProjectOptions): ProjectOptions['gitIgnoreOptions'] =>
   parent
     ? gitIgnoreOptions
@@ -1307,6 +1465,7 @@ const getGitIgnoreOptions = ({
     !.babelrc
     !.dockerignore
     !.editorconfig
+    ${worktrunk ? '!.env.example' : ''}
     !.gitattributes
     !.gitignore
     !.gitkeep
@@ -1341,6 +1500,8 @@ const deepMerge = R.mergeDeepWith(
     [R.allPass([R.is(String), R.is(String)]), R.nthArg(1)],
     // Same for booleans, which cannot be concatenated at all.
     [R.allPass([R.is(Boolean), R.is(Boolean)]), R.nthArg(1)],
+    // And for numbers.
+    [R.allPass([R.is(Number), R.is(Number)]), R.nthArg(1)],
     // Otherwise, concatenate.
     [R.T, R.concat],
   ]),