@langri-sha/projen-project 0.8.1 → 0.10.0

package/src/index.ts

@@ -1,7 +1,10 @@
+import * as path from 'node:path'
+
 import {
   Project as BaseProject,
   type ProjectOptions as BaseProjectOptions,
-  YamlFile,
+  IgnoreFile,
+  IgnoreFileOptions,
   javascript,
 } from 'projen'
 
@@ -26,8 +29,18 @@ import {
   type TypeScriptConfigOptions,
 } from '@langri-sha/projen-typescript-config'
 import { Beachball, BeachballOptions } from '@langri-sha/projen-beachball'
-
-import { ProjenrcFile } from './lib/index.js'
+import { License } from '@langri-sha/projen-license'
+
+import { NodePackage, NodePackageOptions, ProjenrcFile } from './lib/index.js'
+import { JestConfig, JestConfigOptions } from '@langri-sha/projen-jest-config'
+import { Prettier, PrettierOptions } from '@langri-sha/projen-prettier'
+import { ESLint, ESLintOptions } from '@langri-sha/projen-eslint'
+import { LintStaged, LintStagedOptions } from '@langri-sha/projen-lint-staged'
+import { Babel, BabelOptions } from '@langri-sha/projen-babel'
+import {
+  PnpmWorkspace,
+  PnpmWorkspaceOptions,
+} from '@langri-sha/projen-pnpm-workspace'
 
 export * from '@langri-sha/projen-typescript-config'
 
@@ -36,60 +49,105 @@ export interface ProjectOptions
   /*
    * Pass in to set up Beachball.
    */
-  beachballOptions?: BeachballOptions
+  babel?: BabelOptions
 
   /*
    * Pass in to set up Beachball.
    */
-  codeownersOptions?: CodeownersOptions
+  beachball?: BeachballOptions
+
+  /*
+   * Pass in to set up Beachball.
+   */
+  codeowners?: CodeownersOptions
 
   /**
    * EditorConfig options.
    */
-  editorConfigOptions?: EditorConfigOptions
+  editorConfig?: EditorConfigOptions
+
+  /**
+   * Pass in to configure ESLint.
+   */
+  eslint?: ESLintOptions
 
   /**
    * Husky options.
    */
-  huskyOptions?: HuskyOptions
+  husky?: HuskyOptions
 
-  /*
-   * Pass in to configure Renovate.
+  /**
+   * Configures Jest, when provided.
+   */
+  jestConfig?: JestConfigOptions
+
+  /**
+   * Configures `lint-staged`, when provided.
    */
-  renovateOptions?: RenovateOptions
+  lintStaged?: LintStagedOptions
 
   /*
    * Options for the linting synthesized files.
    */
-  lintSynthesizedOptions?: LintSynthesizedOptions
+  lintSynthesized?: LintSynthesizedOptions
 
   /**
    * Package configuration options.
    */
-  package?: javascript.NodePackageOptions
+  package?: {
+    /**
+     * License copyright year.
+     *
+     * @default "Current full year"
+     */
+    copyrightYear?: string
+  } & NodePackageOptions
+
+  /*
+   * PNPM workspaces to generate, if provided.
+   */
+  pnpmWorkspace?: PnpmWorkspaceOptions
 
   /**
-   * TypeScript configuration options.
+   * Pass in to configure Prettier.
    */
-  typeScriptConfigOptions?: TypeScriptConfigOptions
+  prettier?: PrettierOptions
+
+  /**
+   * Pass in to configure NPM ignore options.
+   */
+  npmIgnore?: IgnoreFileOptions
 
   /*
-   * Whether to use Terrafom.
+   * Pass in to configure Renovate.
    */
-  withTerraform?: boolean
+  renovate?: RenovateOptions
+
+  /**
+   * TypeScript configuration options.
+   */
+  typeScriptConfig?: TypeScriptConfigOptions
 
   /*
-   * PNPM workspaces to generate.
+   * Whether to use Terrafom.
    */
-  workspaces?: string[]
+  withTerraform?: boolean
 }
 
 export class Project extends BaseProject {
+  babel?: Babel
   beachball?: Beachball
   codeowners?: Codeowners
   editorConfig?: EditorConfig
+  eslint?: ESLint
   husky?: Husky
-  package?: javascript.NodePackage
+  jestConfig?: JestConfig
+  license?: License
+  lintStaged?: LintStaged
+  npmIgnore?: IgnoreFile
+  package?: NodePackage
+  pnpmWorkspace?: PnpmWorkspace
+  prettier?: Prettier
   projenrc?: ProjenrcFile
   renovate?: Renovate
   typeScriptConfig?: TypeScriptConfig
@@ -111,6 +169,7 @@ export class Project extends BaseProject {
 
     this.#configurePackage(options)
     this.#configureTypeScript(options)
+    this.#configureProjenrc()
 
     if (this.parent) {
       this.tasks.tryFind('default')?.reset()
@@ -118,59 +177,90 @@ export class Project extends BaseProject {
       this.tasks.tryFind('install:ci')?.reset()
     }
 
+    this.#configureESLint(options)
+    this.#configurePrettier(options)
+
+    this.#configureBabel(options)
     this.#configureBeachball(options)
     this.#configureCodeowners(options)
     this.#configureEditorConfig(options)
     this.#configureHusky(options)
+    this.#configureJestConfig(options)
+    this.#configureLicense(options)
+    this.#configureLintStaged(options)
     this.#configureLintSynthesized(options)
-    this.#configureProjenrc()
+    this.#configureNpmIgnore(options)
+    this.#configurePnpmWorkspace(options)
     this.#configureRenovate(options)
-    this.#createPnpmWorkspaces(options)
+  }
+
+  override preSynthesize(): void {
+    super.preSynthesize()
+
+    this.#populateTypeScriptProjectReferencesFromDependencies()
+  }
+
+  get allSubprojects(): BaseProject[] {
+    return this.root.node
+      .findAll(0)
+      .filter((node) => node !== this.root)
+      .filter((node): node is BaseProject => node instanceof BaseProject)
+  }
+
+  get allSubprojectsKind(): Project[] {
+    return this.allSubprojects.filter(
+      (project): project is Project => project instanceof Project,
+    )
   }
 
   /**
    * Add a subproject.
    */
-  addSubproject(projectOptions: ProjectOptions) {
-    return new Project({
+  addSubproject(
+    projectOptions: ProjectOptions,
+    ...compose: Array<(project: Project) => void>
+  ) {
+    const project = new Project({
       parent: this,
       ...projectOptions,
     })
+
+    for (const callback of compose) {
+      callback(project)
+    }
+
+    return project
   }
 
   /**
    * Find a project by it's name, e.g. `@acme/some`.
    */
-  findSubproject(name: string): Project {
-    const subprojects: Array<BaseProject> = []
-
-    const addSubproject = (project: BaseProject) => {
-      for (const subproject of project.subprojects) {
-        subprojects.push(subproject)
+  findSubproject(name: string): Project | undefined {
+    return this.allSubprojectsKind.find((project) => project.name === name)
+  }
 
-        if (subproject.subprojects.length) {
-          addSubproject(subproject)
-        }
-      }
+  #configureBabel({ babel }: ProjectOptions) {
+    if (!babel) {
+      return
     }
 
-    addSubproject(this.root)
-
-    const result = subprojects.find((subproject) => subproject.name === name)
-
-    if (result instanceof Project) {
-      return result
+    const defaults: BabelOptions = {
+      options: {
+        presets: ['@langri-sha/babel-preset'],
+      },
     }
 
-    throw new Error(`Cannot find subproject ${name}`)
+    this.babel = new Babel(this, deepMerge(defaults, babel))
+
+    this.typeScriptConfig?.addFile(this.babel.path)
   }
 
-  #configureBeachball({ beachballOptions }: ProjectOptions) {
-    if (!beachballOptions || this.parent) {
+  #configureBeachball({ beachball }: ProjectOptions) {
+    if (!beachball || this.parent) {
       return
     }
 
-    const options = deepMerge(beachballOptions, {
+    const options = deepMerge(beachball, {
       branch: 'origin/main',
       gitTags: false,
       ignorePatterns: [
@@ -184,11 +274,12 @@ export class Project extends BaseProject {
 
     this.beachball = new Beachball(this, options)
 
+    this.prettier?.ignore.addPatterns('CHANGELOG.md')
     this.package?.addDevDeps('beachball@2.43.1')
     this.typeScriptConfig?.addFile('beachball.config.js')
   }
 
-  #configureCodeowners({ codeownersOptions }: ProjectOptions) {
+  #configureCodeowners({ codeowners: codeownersOptions }: ProjectOptions) {
     if (!codeownersOptions) {
       return
     }
@@ -196,7 +287,9 @@ export class Project extends BaseProject {
     this.codeowners = new Codeowners(this, codeownersOptions)
   }
 
-  #configureEditorConfig({ editorConfigOptions }: ProjectOptions) {
+  #configureEditorConfig({
+    editorConfig: editorConfigOptions,
+  }: ProjectOptions) {
     if (!editorConfigOptions || this.parent) {
       return
     }
@@ -219,9 +312,31 @@ export class Project extends BaseProject {
       this,
       deepMerge(editorConfigOptions ?? {}, defaults),
     )
+
+    this.prettier?.ignore.addPatterns('!.editorconfig')
+  }
+
+  #configureESLint({ eslint: eslintOptions }: ProjectOptions) {
+    if (!eslintOptions) {
+      return
+    }
+
+    const defaults: ESLintOptions = {
+      filename: 'eslint.config.mjs',
+      ignorePatterns: ['.*'],
+      extends: '@langri-sha/eslint-config',
+    }
+
+    this.eslint = new ESLint(this, deepMerge(defaults, eslintOptions))
+
+    if (this.projenrc?.filePath) {
+      this.eslint.ignorePatterns.push(`!${this.projenrc.filePath}`)
+    }
+
+    this.typeScriptConfig?.addFile(this.eslint.path)
   }
 
-  #configureHusky({ huskyOptions }: ProjectOptions) {
+  #configureHusky({ husky: huskyOptions }: ProjectOptions) {
     if (!huskyOptions || this.parent) {
       return
     }
@@ -233,14 +348,93 @@ export class Project extends BaseProject {
     this.tryFindObjectFile('package.json')?.addDeletionOverride('pnpm')
   }
 
-  #configureLintSynthesized({ lintSynthesizedOptions }: ProjectOptions) {
-    new LintSynthesized(
+  #configureJestConfig({ jestConfig: jestConfigOptions }: ProjectOptions) {
+    if (!jestConfigOptions || this.parent) {
+      return
+    }
+
+    this.jestConfig = new JestConfig(this, jestConfigOptions)
+
+    this.typeScriptConfig?.addFile(this.jestConfig.path)
+  }
+
+  #configureLicense({ package: pkg }: ProjectOptions) {
+    if (!pkg?.license) {
+      return
+    }
+
+    if (!pkg.authorName) {
+      throw new Error(
+        'Missing package author name. Set `package.authorName` in the project',
+      )
+    }
+
+    this.license = new License(this, {
+      spdx: pkg.license,
+      copyrightHolder: [
+        pkg.authorName,
+        pkg.authorEmail ? `<${pkg.authorEmail}>` : undefined,
+        pkg.authorUrl ? `(${pkg.authorUrl})` : undefined,
+      ]
+        .filter(Boolean)
+        .join(' '),
+      year: pkg.copyrightYear ?? new Date().getFullYear().toString(),
+    })
+  }
+
+  #configureLintStaged({ lintStaged: lintStagedOptions }: ProjectOptions) {
+    if (!lintStagedOptions) {
+      return
+    }
+
+    const defaults: LintStagedOptions = {
+      filename: 'lint-staged.config.mjs',
+      extends: '@langri-sha/lint-staged',
+    }
+
+    this.lintStaged = new LintStaged(
       this,
-      lintSynthesizedOptions ?? {
-        'package.json': 'pnpx sort-package-json',
-        '*.{js,jsx,ts,tsx}': 'pnpm eslint --fix',
-        '*': 'pnpm prettier --write --ignore-unknown',
-      },
+      deepMerge(defaults, lintStagedOptions),
+    )
+
+    this.typeScriptConfig?.addFile(this.lintStaged!.path)
+  }
+
+  #configureLintSynthesized({ lintSynthesized }: ProjectOptions) {
+    if (!lintSynthesized) {
+      return
+    }
+
+    const defaults: LintSynthesizedOptions = {
+      'package.json': 'pnpx sort-package-json',
+      '*.{js,cjs,mjs,jsx,ts,cts,mts,tsx}': 'pnpm eslint --fix',
+      '*': 'pnpm prettier --write --ignore-unknown',
+    }
+
+    new LintSynthesized(this, deepMerge(defaults, lintSynthesized))
+  }
+
+  #configureNpmIgnore({
+    typeScriptConfig,
+    jestConfig,
+    npmIgnore,
+  }: ProjectOptions) {
+    if (!npmIgnore) {
+      return
+    }
+
+    const defaults: IgnoreFileOptions = {
+      ignorePatterns: [
+        '.*',
+        ...(jestConfig ? ['*.test.*', '__snapshots__/'] : []),
+        ...(typeScriptConfig ? ['tsconfig*.json'] : []),
+      ],
+    }
+
+    this.npmIgnore = new IgnoreFile(
+      this,
+      '.npmignore',
+      deepMerge(defaults, npmIgnore),
     )
   }
 
@@ -249,17 +443,16 @@ export class Project extends BaseProject {
       return
     }
 
-    const defaults: javascript.NodePackageOptions = {
+    const defaults: NodePackageOptions = {
       entrypoint: 'src/index.ts',
       packageManager: javascript.NodePackageManager.PNPM,
-      minNodeVersion: '20.12.0',
     }
 
-    this.package = new javascript.NodePackage(this, deepMerge(defaults, pkg))
+    this.package = new NodePackage(this, deepMerge(defaults, pkg))
 
     if (!this.parent) {
       this.package.addDevDeps('@langri-sha/projen-project@*')
-      this.package.addDevDeps('projen@0.81.15')
+      this.package.addDevDeps('projen@0.82.4')
     }
 
     this.package.removeScript('start')
@@ -270,15 +463,52 @@ export class Project extends BaseProject {
     }
   }
 
-  #configureProjenrc() {
-    if (this.parent) {
+  #configurePnpmWorkspace({ pnpmWorkspace }: ProjectOptions) {
+    if (!pnpmWorkspace) {
+      return
+    }
+
+    this.pnpmWorkspace = new PnpmWorkspace(this, pnpmWorkspace)
+
+    for (const workspace of pnpmWorkspace.packages ?? []) {
+      this.prettier?.ignore.exclude(`${workspace}/lib/`)
+      this.eslint?.ignorePatterns.push(`${workspace}/lib/`)
+    }
+  }
+
+  #configurePrettier({ prettier: prettierOptions }: ProjectOptions) {
+    if (!prettierOptions || this.parent) {
       return
     }
 
+    const defaults: PrettierOptions = {
+      filename: 'prettier.config.mjs',
+      extends: '@langri-sha/prettier',
+      ignorePatterns: ['.*'],
+    }
+
+    this.prettier = new Prettier(this, deepMerge(defaults, prettierOptions))
+
+    if (this.projenrc?.filePath) {
+      this.prettier.ignore.include(this.projenrc.filePath)
+    }
+
+    if (this.package?.packageManager === javascript.NodePackageManager.PNPM) {
+      this.prettier.ignore.addPatterns('pnpm-lock.yaml')
+    }
+
+    this.typeScriptConfig?.addFile(this.prettier!.path)
+  }
+
+  #configureProjenrc() {
     this.projenrc = new ProjenrcFile(this, {})
+
+    if (!this.parent) {
+      this.typeScriptConfig?.addFile(this.projenrc.filePath)
+    }
   }
 
-  #configureRenovate({ renovateOptions }: ProjectOptions) {
+  #configureRenovate({ renovate: renovateOptions }: ProjectOptions) {
     if (!renovateOptions || this.parent) {
       return
     }
@@ -288,16 +518,42 @@ export class Project extends BaseProject {
       extends: ['config:recommended'],
       labels: ['dependencies'],
       reviewersFromCodeOwners: true,
+      lockFileMaintenance: {
+        enabled: true,
+      },
       customManagers: [
+        {
+          customType: 'regex',
+          datasourceTemplate: 'node',
+          depNameTemplate: 'node',
+          versioningTemplate: 'node',
+          currentValueTemplate: '>= {{currentValue}}',
+          fileMatch: ['\\.?projen.*.(js|cjs|mjs|ts|mts|cts)$'],
+          matchStrings: ["minNodeVersion:\\s*'(?<currentValue>[^']+)'"],
+        },
+        {
+          customType: 'regex',
+          datasourceTemplate: 'npm',
+          fileMatch: ['\\.?projen.*.(js|cjs|mjs|ts|mts|cts)$'],
+          matchStringsStrategy: 'recursive',
+          matchStrings: [
+            '\\.(?<depType>addDeps|addDevDeps|addPeerDeps)\\([^)]*\\)',
+            "'(?<depName>@?[\\w-\\/]+)@(?<currentValue>[^']+)'",
+          ],
+          depTypeTemplate:
+            "{{#if (equals depType 'addDeps')}}dependencies{{else if (equals depType 'addDevDeps')}}devDependencies{{else}}peerDependencies{{/if}}",
+        },
         {
           customType: 'regex',
           datasourceTemplate: 'npm',
           fileMatch: ['\\.?projen.*.(js|cjs|mjs|ts|mts|cts)$'],
+          matchStringsStrategy: 'recursive',
           matchStrings: [
-            "\\.(?<depType>addDep|addDevDep|addPeerDep)\\('(?<depName>[a-zA-Z0-9-]+)@(?<currentValue>[^']+)'\\)",
+            '(?<depType>deps|devDeps|peerDeps):\\s*\\[[^\\]]*\\]',
+            "'(?<depName>@?[\\w-\\/]+)@(?<currentValue>[^']+)'",
           ],
           depTypeTemplate:
-            "{{#if (equals depType 'addDevDep')}}devDependencies{{else if (equals depType 'addPeerDep')}}peerDependencies{{else}}dependencies{{/if}}",
+            "{{#if (equals depType 'deps')}}dependencies{{else if (equals depType 'devDeps')}}devDependencies{{else}}peerDependencies{{/if}}",
         },
         {
           customType: 'regex',
@@ -310,10 +566,18 @@ export class Project extends BaseProject {
       ],
     }
 
+    this.addTask('renovate', {
+      description: 'Run Renovate locally for debugging',
+      exec: 'pnpx renovate --platform=local --repository-cache=reset --dry-run=full',
+    })
+
     this.renovate = new Renovate(this, deepMerge(defaults, renovateOptions))
   }
 
-  #configureTypeScript({ parent, typeScriptConfigOptions }: ProjectOptions) {
+  #configureTypeScript({
+    parent,
+    typeScriptConfig: typeScriptConfigOptions,
+  }: ProjectOptions) {
     if (!typeScriptConfigOptions) {
       return
     }
@@ -344,30 +608,50 @@ export class Project extends BaseProject {
       this.package?.addDevDeps('ts-node@10.9.2')
     }
 
-    this.package?.addDevDeps('@langri-sha/tsconfig@*')
+    if (this.name !== '@langri-sha/tsconfig') {
+      this.package?.addDevDeps('@langri-sha/tsconfig@*')
+    }
   }
 
-  #createPnpmWorkspaces({ workspaces }: ProjectOptions) {
-    if (!workspaces) {
+  #populateTypeScriptProjectReferencesFromDependencies() {
+    if (this.parent || !this.package || !this.typeScriptConfig) {
       return
     }
 
-    new YamlFile(this, 'pnpm-workspace.yaml', {
-      readonly: true,
-      marker: true,
-      obj: {
-        packages: workspaces,
-      },
-    })
+    const subprojects = this.allSubprojectsKind.filter(
+      (project) => project.package && project.typeScriptConfig,
+    )
+
+    const root = path.dirname(this.package!.file.absolutePath)
+
+    for (const project of subprojects) {
+      const from = path.dirname(project.package!.file.absolutePath)
+
+      if (project.name !== '@langri-sha/tsconfig') {
+        this.typeScriptConfig!.addReference(path.relative(root, from))
+      }
+
+      for (const dep of project.deps.all) {
+        const reference = subprojects.find(({ name }) => name === dep.name)
+
+        if (!reference) {
+          continue
+        }
+
+        const to = path.dirname(reference.package!.file.absolutePath)
+
+        project.typeScriptConfig!.addReference(path.relative(from, to))
+      }
+    }
   }
 }
 
 const getGitIgnoreOptions = ({
-  huskyOptions,
-  typeScriptConfigOptions,
-  withTerraform,
-  parent,
   gitIgnoreOptions,
+  husky: huskyOptions,
+  parent,
+  typeScriptConfig: typeScriptConfigOptions,
+  withTerraform,
   ...options
 }: ProjectOptions): ProjectOptions['gitIgnoreOptions'] =>
   parent
@@ -393,7 +677,8 @@ const getGitIgnoreOptions = ({
     !.github/
     ${huskyOptions ? '!.husky/' : ''}
     !.projen/
-    ${options.workspaces?.map((workspace) => `${workspace}/lib/`).join('\n') ?? ''}
+    dist/
+    ${options.pnpmWorkspace?.packages?.map((workspace) => `${workspace}/lib/`).join('\n') ?? ''}
     node_modules/
     `
             .split('\n')
@@ -403,4 +688,11 @@ const getGitIgnoreOptions = ({
         ],
       }
 
-const deepMerge = R.mergeDeepWith(R.concat)
+const deepMerge = R.mergeDeepWith(
+  R.cond([
+    // When both arguments are strings, use the right string.
+    [R.allPass([R.is(String), R.is(String)]), R.nthArg(1)],
+    // Otherwise, concatenate.
+    [R.T, R.concat],
+  ]),
+)

package/src/lib/index.ts

@@ -1 +1,2 @@
+export * from './node-package.js'
 export * from './projenrc.js'