Add TypeScript package generator with PlopJS #667

gunzip · 2025-06-27T09:51:45Z

Introduce a PlopJS generator for creating TypeScript workspaces in the DX monorepo.

changeset-bot · 2025-06-27T09:51:49Z

🦋 Changeset detected

Latest commit: 5da6ccb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@pagopa/typescript-base-generator	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

lucacavallaro · 2025-06-27T09:55:09Z

UHM isn't this the goal of our cli? why making another package?

gunzip · 2025-06-27T09:58:58Z

UHM isn't this the goal of our cli? why making another package?

shouldn't the cli use plop generators to generate workspaces?

packages/typescript-generator/templates/typescript-package/.node-version.hbs

packages/typescript-generator/templates/typescript-package/eslint.config.js.hbs

packages/typescript-generator/templates/typescript-package/package.json.hbs

lucacavallaro · 2025-07-01T09:10:17Z

packages/typescript-generator/templates/typescript-package/package.json.hbs

+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint --fix src",


I would make the setup as easier as possible - IMHO there are no reason for pushing to our consumers a code bundler. tsc is easy to use and it is good enough for the majority of use case we have.

(I would include esbuild/tsup only for advanced setup)

Suggested change

"build": "tsup",

"dev": "tsup --watch",

"typecheck": "tsc --noEmit",

"lint": "eslint --fix src",

"build": "tsc",

"build:watch": "tsc --watch",

"typecheck": "tsc --noEmit",

"lint": "eslint --fix src",

I've included tsup in order to produce both esm and commonjs packages for publication. do you suggest to do the same using two different tsconfig.json or to use a bundler only within the publish pipeline?

if we are going to use tsup, I think we should add it to the tech radar as well

@kin0992 yes for libraries I think is the best option, maybe we can try to use esbuild directly (tsup is just a thin wrapper of it) and add the latter to the technology radar

yes, my point is to use technologies that are listed in the technology radar (at least in the asses or trial section). what do you think?

packages/typescript-generator/templates/typescript-package/tsconfig.json.hbs

packages/typescript-generator/templates/typescript-package/vitest.config.ts.hbs

packages/typescript-generator/package.json

Co-authored-by: Luca Cavallaro <[email protected]>

…onstructed from library input Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

…a/dx into feats/typescript-generator

…rator

package.json

packages/typescript-base-generator/package.json

…d plop

…kage/package.json.hbs Co-authored-by: Copilot <[email protected]>

…kage.json.hbs Co-authored-by: Copilot <[email protected]>

- Resolved conflicts in package.json and pnpm-workspace.yaml - Regenerated pnpm-lock.yaml using pnpm install to avoid lock file conflicts - Combined catalog entries from both branches appropriately

Keep file locally but remove from version control

Copilot

Pull Request Overview

This PR introduces a comprehensive PlopJS generator system for creating TypeScript packages in the DX monorepo. The implementation provides a modular, extensible foundation for package generation with three distinct packages: a core shared library, a base generator, and a library-specific generator that adds build tooling.

Adds PlopJS integration with a root-level plopfile and npm script
Creates a shared core package (@pagopa/typescript-generator) for common generator functionality
Implements two specific generators: a base TypeScript package generator and a library generator with tsup build configuration

Reviewed Changes

Copilot reviewed 38 out of 39 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
turbo.json	Adds build dependency to typecheck task
pnpm-workspace.yaml	Adds PlopJS and inquirer dependencies to catalog
plopfile.js	Root-level configuration for PlopJS generators
packages/typescript-generator/*	Core shared functionality for TypeScript package generators
packages/typescript-base-generator/*	Basic TypeScript package generator without additional build tools
packages/typescript-library-generator/*	TypeScript library generator with tsup build configuration
package.json	Adds generate script for running PlopJS
.changeset/add-plop-generator.md	Changeset documenting the new generator functionality

packages/typescript-library-generator/src/index.ts

packages/typescript-base-generator/src/index.ts

packages/typescript-generator/src/index.ts

kin0992

also a rebase is required

kin0992 · 2025-08-06T09:46:13Z

plopfile.js

question: why not a .ts file?

kin0992 · 2025-08-06T09:48:43Z

.changeset/add-plop-generator.md

note: I see 3 packages, but just one changelog. I'm not sure we do not want to track the changes on other packages.

kin0992 · 2025-08-06T09:50:00Z

packages/typescript-base-generator/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@pagopa/typescript-base-generator",
+  "version": "0.1.0",


note: this will become 0.2.0 when changesets updates the version (because of the minor bump).

this comment is valid for other packages as well

kin0992 · 2025-08-28T07:41:27Z

packages/typescript-base-generator/package.json

+    "@tsconfig/node22": "catalog:",
+    "@types/node": "catalog:",
+    "eslint": "catalog:",
+    "prettier": "catalog:",
+    "tsup": "catalog:",
+    "typescript": "catalog:"


issue: I think some of these need to be updated after some changes were introduced on main.

e.g. eslint should be imported from catalog:dx

kin0992 · 2025-08-28T07:46:59Z

packages/typescript-base-generator/README.md

+When using in the DX monorepo, you can run the generator directly from the root directory:
+
+```bash
+pnpm run turbo gen typescript-base-generator


question: are you sure this is working?

kin0992 · 2025-08-28T08:00:29Z

packages/typescript-library-generator/templates/typescript-package/package.json.hbs

@@ -0,0 +1,31 @@
+{
+  "name": "{{packageName}}",
+  "version": "0.1.0",


kin0992 · 2025-08-28T08:00:43Z

packages/typescript-library-generator/templates/typescript-package/package.json.hbs

+  "devDependencies": {},
+  "scripts": {
+    "start": "node .",
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint --fix src",
+    "lint:check": "eslint src",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }


kin0992 · 2025-08-28T08:00:58Z

packages/typescript-library-generator/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@pagopa/typescript-library-generator",
+  "version": "0.1.0",


kin0992 · 2025-08-28T08:01:07Z

packages/typescript-library-generator/package.json

+    "@pagopa/eslint-config": "workspace:^",
+    "@tsconfig/node22": "catalog:",
+    "@types/node": "catalog:",
+    "eslint": "catalog:",


kin0992 · 2025-08-28T08:07:46Z

packages/typescript-library-generator/README.md

+When using in the DX monorepo, you can run the generator directly from the root directory:
+
+```bash
+pnpm run turbo gen typescript-library-generator


ditto

I think the right command should be pnpm exec turbo gen typescript-library-package.
If you prompt typescript-library-generator, the CLI is asking you to select the generator to use; options are typescript-package and typescript-library-package

why exec turbo gen and not directly pnpm turbo gen ?

it's ok pnpm turbo gen as well

gunzip added 8 commits June 27, 2025 07:04

Initialize TypeScript starter template with configuration files

6f6c37c

Add plop generator

3e73c72

Update output directory for plop generator configuration

99bbba1

Add PlopJS generator for TypeScript packages in DX monorepo

7432a08

Implement code changes to enhance functionality and improve performance

e295f89

Update repository directory in package.json for TypeScript generator

7a6670f

Update plopfile to use TypeScript generator for package creation

c20b57f

Refactor plopfile to define generator function structure

8d6af1b

Update README to reflect package name and usage changes

7d38b30

gunzip and others added 6 commits June 27, 2025 10:00

Lint sources

d9e1dc0

Add TypeScript generator for PlopJS in the DX monorepo

f1ab8b8

Refactor parameter types for PlopJS generator functions

6e9e936

Fix VSCode Eslint config

4e900ff

Refine type definition for changeset skip condition

e864887

Merge branch 'main' into feats/typescript-generator

4a0c3c1

gunzip marked this pull request as ready for review June 30, 2025 10:47

gunzip requested a review from a team as a code owner June 30, 2025 10:47

lucacavallaro requested changes Jul 1, 2025

View reviewed changes

gunzip and others added 6 commits July 1, 2025 12:26

Apply suggestions from code review

3600e40

Co-authored-by: Luca Cavallaro <[email protected]>

Add Prettier for code formatting and update dependencies

328c7a1

Refactor ESLint and TypeScript configurations for consistency

9ce8cac

Add helper to retrieve git repository URL for templates

c63481b

Add installDependencies function for package setup

d41f804

Improve import order for test file consistency

5d4667a

gunzip requested a review from lucacavallaro July 1, 2025 22:25

gunzip added 2 commits July 2, 2025 11:26

Update package name handling and improve error reporting

1305f89

Remove tsup configuration and update build scripts to use tsc

900c867

gunzip and others added 10 commits July 9, 2025 15:35

Potential fix for code scanning alert no. 452: Unsafe shell command c…

7be78c1

…onstructed from library input Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Update vitest mocker dependencies for compatibility

66f0361

Merge branch 'feats/typescript-generator' of https://github.com/pagop…

5aa842b

…a/dx into feats/typescript-generator

Merge branch 'main' into feats/typescript-generator

16588db

Refactor imports for child_process and path modules

82943ee

Update devDependencies to use catalog references

a432f56

Merge remote-tracking branch 'origin/main' into feats/typescript-gene…

e515f22

…rator

Merge branch 'main' into feats/typescript-generator

deb3973

Merge branch 'main' into feats/typescript-generator

69c7019

Upgrade TypeScript dependencies to Node 22

c4608eb

kin0992 requested changes Jul 11, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

packages/typescript-base-generator/package.json Outdated Show resolved Hide resolved

gunzip and others added 4 commits July 11, 2025 07:26

Update package dependencies to use catalog references for inquirer an…

8470e80

…d plop

Refactor dependency specifications to use catalog versions

30f0164

Merge branch 'main' into feats/typescript-generator

b086da1

Update package specifiers for consistency and compatibility

c409569

gunzip requested review from Copilot and kin0992 August 4, 2025 11:00

This comment was marked as outdated.

Sign in to view

gunzip and others added 8 commits August 4, 2025 13:02

Update packages/typescript-library-generator/templates/typescript-pac…

12ee131

…kage/package.json.hbs Co-authored-by: Copilot <[email protected]>

Update packages/typescript-generator/templates/typescript-package/pac…

5425573

…kage.json.hbs Co-authored-by: Copilot <[email protected]>

chore: update mcp.json configuration

a36abc3

Merge main into feats/typescript-generator

96cdba1

- Resolved conflicts in package.json and pnpm-workspace.yaml - Regenerated pnpm-lock.yaml using pnpm install to avoid lock file conflicts - Combined catalog entries from both branches appropriately

Remove unused ESLint and Vitest dependencies

d77cc4e

Remove .vscode/mcp.json from git tracking

cf4fc75

Keep file locally but remove from version control

Add configuration for Terraform MCP server

0278575

Merge branch 'main' into feats/typescript-generator

5da6ccb

gunzip requested a review from Copilot August 6, 2025 07:41

Copilot AI reviewed Aug 6, 2025

View reviewed changes

packages/typescript-library-generator/src/index.ts Show resolved Hide resolved

packages/typescript-base-generator/src/index.ts Show resolved Hide resolved

packages/typescript-generator/src/index.ts Show resolved Hide resolved

kin0992 requested changes Aug 28, 2025

View reviewed changes

gunzip marked this pull request as draft August 28, 2025 08:10

Add TypeScript package generator with PlopJS #667

Are you sure you want to change the base?

Add TypeScript package generator with PlopJS #667

Uh oh!

Conversation

gunzip commented Jun 27, 2025

Uh oh!

changeset-bot bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

lucacavallaro commented Jun 27, 2025

Uh oh!

gunzip commented Jun 27, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kin0992 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

changeset-bot bot commented Jun 27, 2025 •

edited

Loading