@langri-sha/projen-project 0.2.0

package/CHANGELOG.json

@@ -0,0 +1,70 @@
+{
+  "name": "@langri-sha/projen-project",
+  "entries": [
+    {
+      "date": "Tue, 30 Apr 2024 23:02:26 GMT",
+      "version": "0.2.0",
+      "tag": "@langri-sha/projen-project_v0.2.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen): Add support for configuring Beachball"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen): Remove top-level tasks"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen): Configure PNPM workspaces"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen-project): Configure ESM support"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen-projent): Configure linters for synthesized files"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen-project): Replace `deepMerge`"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen-project): Stub package"
+          },
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "feat(projen-project): Configure default task"
+          }
+        ],
+        "patch": [
+          {
+            "author": "filip.dupanovic@gmail.com",
+            "package": "@langri-sha/projen-project",
+            "commit": "5b2b47f068f116b65549bd1b0c0a68c455ee319b",
+            "comment": "fix(projen-project): Unignore projen config files"
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log - @langri-sha/projen-project
+
+This log was last generated on Tue, 30 Apr 2024 23:02:26 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 0.2.0
+
+Tue, 30 Apr 2024 23:02:26 GMT
+
+### Minor changes
+
+- feat(projen): Add support for configuring Beachball (filip.dupanovic@gmail.com)
+- feat(projen): Remove top-level tasks (filip.dupanovic@gmail.com)
+- feat(projen): Configure PNPM workspaces (filip.dupanovic@gmail.com)
+- feat(projen-project): Configure ESM support (filip.dupanovic@gmail.com)
+- feat(projen-projent): Configure linters for synthesized files (filip.dupanovic@gmail.com)
+- feat(projen-project): Replace `deepMerge` (filip.dupanovic@gmail.com)
+- feat(projen-project): Stub package (filip.dupanovic@gmail.com)
+- feat(projen-project): Configure default task (filip.dupanovic@gmail.com)
+
+### Patches
+
+- fix(projen-project): Unignore projen config files (filip.dupanovic@gmail.com)

package/license

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024 Filip Dupanović <filip.dupanovic@gmail.com> (https://langri-sha.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@langri-sha/projen-project",
+  "version": "0.2.0",
+  "license": "MIT",
+  "type": "module",
+  "main": "src/index.ts",
+  "dependencies": {
+    "@langri-sha/projen-lint-synthesized": "0.1.0",
+    "beachball": "2.43.1",
+    "ramda": "0.29.1"
+  },
+  "devDependencies": {
+    "@langri-sha/jest-test": "0.2.0",
+    "@langri-sha/tsconfig": "0.2.0",
+    "@types/ramda": "0.29.12",
+    "projen": "0.81.1"
+  },
+  "peerDependencies": {
+    "projen": "^0.81.1",
+    "typescript": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme

@@ -0,0 +1,24 @@
+# @langri-sha/projen-project
+
+Collection of [projen] templates for bootstraping monorepos and workspace
+projects.
+
+## Usage
+
+### Defaults
+
+- configures extensive list of Git ignore patterns
+
+### Terraform
+
+- adds lockfile
+
+### TypeScript monorepo
+
+- configures [`@langri-sha/tsconfig`]
+- configures [PNPM] [workspaces]
+
+[`@langri-sha/tsconfig`]: https://github.com/langri-sha/tsconfig
+[pnpm]: https://pnpm.io
+[projen]: https://projen.dev/
+[workspaces]: https://pnpm.io/workspaces

package/src/__snapshots__/index.test.ts.snap

@@ -0,0 +1,329 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`defaults 1`] = `
+{
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+.*
+!.babelrc
+!.dockerignore
+!.editorconfig
+!.eslintignore
+!.eslintrc.js
+!.gitattributes
+!.gitignore
+!.gitkeep
+!.husky
+!.npmignore
+!.openssl
+!.prettierignore
+!.projenrc*
+*.db
+*.log
+!.github/
+!.husky/
+!.projen/
+dist/
+local/
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+    ],
+  },
+  ".projen/tasks.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "tasks": {
+      "default": {
+        "description": "Synthesize project files",
+        "name": "default",
+        "steps": [
+          {
+            "exec": "node --loader ts-node/esm .projenrc.mts",
+          },
+        ],
+      },
+      "test": {
+        "description": "Run tests",
+        "name": "test",
+      },
+    },
+  },
+}
+`;
+
+exports[`with Beachball configuration 1`] = `
+{
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+.*
+!.babelrc
+!.dockerignore
+!.editorconfig
+!.eslintignore
+!.eslintrc.js
+!.gitattributes
+!.gitignore
+!.gitkeep
+!.husky
+!.npmignore
+!.openssl
+!.prettierignore
+!.projenrc*
+*.db
+*.log
+!.github/
+!.husky/
+!.projen/
+dist/
+local/
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+!/beachball.config.js
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+      "beachball.config.js",
+    ],
+  },
+  ".projen/tasks.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "tasks": {
+      "default": {
+        "description": "Synthesize project files",
+        "name": "default",
+        "steps": [
+          {
+            "exec": "node --loader ts-node/esm .projenrc.mts",
+          },
+        ],
+      },
+      "test": {
+        "description": "Run tests",
+        "name": "test",
+      },
+    },
+  },
+  "beachball.config.js": "/** @type {import('beachball').BeachballConfig} */
+module.exports = {
+  "branch": "origin/main",
+  "gitTags": false,
+  "ignorePatterns": [
+    "*.test.*",
+    ".*/**",
+    "__snapshots__/",
+    "dist/",
+    "node_modules/"
+  ]
+}",
+}
+`;
+
+exports[`with Terraform enabled 1`] = `
+{
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+.*
+!.babelrc
+!.dockerignore
+!.editorconfig
+!.eslintignore
+!.eslintrc.js
+!.gitattributes
+!.gitignore
+!.gitkeep
+!.husky
+!.npmignore
+!.openssl
+!.prettierignore
+!.projenrc*
+!.terraform.lock.hcl
+*.db
+*.log
+!.github/
+!.husky/
+!.projen/
+dist/
+local/
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+    ],
+  },
+  ".projen/tasks.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "tasks": {
+      "default": {
+        "description": "Synthesize project files",
+        "name": "default",
+        "steps": [
+          {
+            "exec": "node --loader ts-node/esm .projenrc.mts",
+          },
+        ],
+      },
+      "test": {
+        "description": "Run tests",
+        "name": "test",
+      },
+    },
+  },
+}
+`;
+
+exports[`with TypeScript enabled 1`] = `
+{
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+.*
+!.babelrc
+!.dockerignore
+!.editorconfig
+!.eslintignore
+!.eslintrc.js
+!.gitattributes
+!.gitignore
+!.gitkeep
+!.husky
+!.npmignore
+!.openssl
+!.prettierignore
+!.projenrc*
+*.db
+*.log
+*.tsbuildinfo
+!.github/
+!.husky/
+!.projen/
+dist/
+local/
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+    ],
+  },
+  ".projen/tasks.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "tasks": {
+      "default": {
+        "description": "Synthesize project files",
+        "name": "default",
+        "steps": [
+          {
+            "exec": "node --loader ts-node/esm .projenrc.mts",
+          },
+        ],
+      },
+      "test": {
+        "description": "Run tests",
+        "name": "test",
+      },
+    },
+  },
+}
+`;
+
+exports[`with workspaces 1`] = `
+{
+  ".gitignore": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+.*
+!.babelrc
+!.dockerignore
+!.editorconfig
+!.eslintignore
+!.eslintrc.js
+!.gitattributes
+!.gitignore
+!.gitkeep
+!.husky
+!.npmignore
+!.openssl
+!.prettierignore
+!.projenrc*
+*.db
+*.log
+!.github/
+!.husky/
+!.projen/
+dist/
+local/
+node_modules/
+!/.gitattributes
+!/.projen/tasks.json
+!/.projen/deps.json
+!/.projen/files.json
+!/pnpm-workspace.yaml
+",
+  ".projen/files.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "files": [
+      ".gitattributes",
+      ".gitignore",
+      ".projen/deps.json",
+      ".projen/files.json",
+      ".projen/tasks.json",
+      "pnpm-workspace.yaml",
+    ],
+  },
+  ".projen/tasks.json": {
+    "//": "~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".",
+    "tasks": {
+      "default": {
+        "description": "Synthesize project files",
+        "name": "default",
+        "steps": [
+          {
+            "exec": "node --loader ts-node/esm .projenrc.mts",
+          },
+        ],
+      },
+      "test": {
+        "description": "Run tests",
+        "name": "test",
+      },
+    },
+  },
+  "pnpm-workspace.yaml": "# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+
+packages:
+  - packages/*
+",
+}
+`;

package/src/index.test.ts

@@ -0,0 +1,48 @@
+import { synthSnapshot } from 'projen/lib/util/synth'
+import { expect, test } from '@langri-sha/jest-test'
+
+import { Project } from './index'
+
+test('defaults', () => {
+  const project = new Project({
+    name: 'test-project',
+  })
+
+  expect(synthSnapshot(project)).toMatchSnapshot()
+})
+
+test('with Beachball configuration', () => {
+  const project = new Project({
+    name: 'test-project',
+    beachballConfig: {},
+  })
+
+  expect(synthSnapshot(project)).toMatchSnapshot()
+})
+
+test('with Terraform enabled', () => {
+  const project = new Project({
+    name: 'test-project',
+    withTerraform: true,
+  })
+
+  expect(synthSnapshot(project)).toMatchSnapshot()
+})
+
+test('with TypeScript enabled', () => {
+  const project = new Project({
+    name: 'test-project',
+    withTypeScript: true,
+  })
+
+  expect(synthSnapshot(project)).toMatchSnapshot()
+})
+
+test('with workspaces', () => {
+  const project = new Project({
+    name: 'test-project',
+    workspaces: ['packages/*'],
+  })
+
+  expect(synthSnapshot(project)).toMatchSnapshot()
+})

package/src/index.ts

@@ -0,0 +1,166 @@
+import {
+  Project as BaseProject,
+  type ProjectOptions as BaseProjectOptions,
+  TextFile,
+  YamlFile,
+} from 'projen'
+
+import * as R from 'ramda'
+import { type BeachballConfig } from 'beachball'
+
+import {
+  LintSynthesized,
+  type LintSynthesizedOptions,
+} from '@langri-sha/projen-lint-synthesized'
+
+export interface ProjectOptions extends BaseProjectOptions {
+  /*
+   * Pass in to set up Beachball.
+   */
+  beachballConfig?: BeachballConfig
+
+  /*
+   * Options for the linting synthesized files.
+   */
+  lintSynthesizedOptions?: LintSynthesizedOptions
+  /*
+   * Whether to use Terrafom.
+   */
+  withTerraform?: boolean
+
+  /*
+   * Whether to use TypeScript.
+   */
+  withTypeScript?: boolean
+
+  /*
+   * PNPM workspaces to generate.
+   */
+  workspaces?: string[]
+}
+
+export class Project extends BaseProject {
+  constructor(options: ProjectOptions) {
+    super({
+      ...options,
+      gitIgnoreOptions: getGitIgnoreOptions(options),
+    })
+
+    // Clean up tasks not required at top-level.
+    this.tasks.removeTask('build')
+    this.tasks.removeTask('compile')
+    this.tasks.removeTask('eject')
+    this.tasks.removeTask('package')
+    this.tasks.removeTask('post-compile')
+    this.tasks.removeTask('pre-compile')
+    this.tasks.removeTask('watch')
+
+    this.#configureBeachball(options)
+    this.#configureDefaultTask()
+    this.#configureLintSynthesized(options)
+    this.#createPnpmWorkspaces(options)
+  }
+
+  #configureBeachball({ beachballConfig }: ProjectOptions) {
+    if (!beachballConfig) {
+      return
+    }
+
+    const options = deepMerge(beachballConfig, {
+      branch: 'origin/main',
+      gitTags: false,
+      ignorePatterns: [
+        '*.test.*',
+        '.*/**',
+        '__snapshots__/',
+        'dist/',
+        'node_modules/',
+      ],
+    })
+
+    const file = new TextFile(this, 'beachball.config.js', {
+      readonly: true,
+      marker: true,
+    })
+
+    for (const line of [
+      `/** @type {import('beachball').BeachballConfig} */`,
+      `module.exports = ${JSON.stringify(options, null, 2)}`,
+    ]) {
+      file.addLine(line)
+    }
+  }
+
+  #configureDefaultTask() {
+    this.tasks
+      .tryFind('default')
+      ?.exec(`node --loader ts-node/esm .projenrc.mts`)
+  }
+
+  #configureLintSynthesized({ lintSynthesizedOptions }: ProjectOptions) {
+    new LintSynthesized(
+      this,
+      lintSynthesizedOptions ?? {
+        '*.{js,jsx,ts,tsx}': 'pnpm eslint --fix',
+        '*': 'pnpm prettier --write --ignore-unknown',
+      },
+    )
+  }
+
+  #createPnpmWorkspaces({ workspaces }: ProjectOptions) {
+    if (!workspaces) {
+      return
+    }
+
+    new YamlFile(this, 'pnpm-workspace.yaml', {
+      readonly: true,
+      marker: true,
+      obj: {
+        packages: workspaces,
+      },
+    })
+  }
+}
+
+const getGitIgnoreOptions = ({
+  withTerraform,
+  withTypeScript,
+  ...options
+}: ProjectOptions): ProjectOptions['gitIgnoreOptions'] => ({
+  ...options.gitIgnoreOptions,
+  ignorePatterns: [
+    ...`
+    .*
+    !.babelrc
+    !.dockerignore
+    !.editorconfig
+    !.eslintignore
+    !.eslintrc.js
+    !.gitattributes
+    !.gitignore
+    !.gitkeep
+    !.husky
+    !.npmignore
+    !.openssl
+    !.prettierignore
+    !.projenrc*
+    ${withTerraform ? '!.terraform.lock.hcl' : ''}
+    *.db
+    *.log
+    ${withTypeScript ? '*.tsbuildinfo' : ''}
+
+    !.github/
+    !.husky/
+    !.projen/
+    dist/
+    local/
+    node_modules/
+    `
+      .split('\n')
+      .map((pattern) => pattern.trim())
+      .filter((pattern) => pattern.length > 0),
+    ...(options.gitIgnoreOptions?.ignorePatterns ?? []),
+  ],
+})
+
+const deepMerge = R.mergeDeepWith(R.concat)

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@langri-sha/tsconfig/project.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": ".tsbuild"
+  },
+  "references": [
+    { "path": "../jest-test" },
+    { "path": "../projen-lint-synthesized" },
+    { "path": "../tsconfig" }
+  ]
+}