AINATIVEM-41: CLI tool foundation — create-pipedrive-app scaffold by dmitriyeff · Pull Request #1 · pipedrive/create-pipedrive-app

dmitriyeff · 2026-05-08T11:23:40Z

Summary

Bootstraps the create-pipedrive-app CLI tool: project scaffold, interactive prompts, programmatic code generators, and GitHub Actions CI
Running npx create-pipedrive-app my-app collects choices via Clack prompts (project name, database, App Extensions, webhooks) and generates a production-ready TypeScript project
Generated project passes tsc --noEmit out of the box — validated by an end-to-end test in the suite

What to review

Interactive prompts (src/prompts/)

Each prompt module handles the cancel (Ctrl+C) path cleanly via process.exit(0)
appExtensions.ts has a two-step flow: confirm → conditional multi-select

Generator interface (src/generators/interface.ts)

Language-agnostic GeneratorOptions and Generator interface shared by all generators
PHP slot is already stubbed (src/generators/php/index.ts) for a future ticket

Node generator (src/generators/node/)

app.ts generator has conditional import/mount logic for webhooks, custom-panel, and custom-modal — worth checking the string interpolation approach
index.ts orchestrator conditionally skips webhooks/app-extensions generation and docker-compose based on user choices
Root project files generated: package.json, tsconfig.json, .env.example, docker-compose.yml (postgres/mysql only)

writeFile utility (src/utils/writeFile.ts)

Runs prettier over all generated files before writing; falls back to raw content for extensions prettier can't parse (e.g. .env.example)

CI (.github/workflows/ci.yml)

Runs npm ci → npm run lint → npm test on every push and PR to master

What to test

npm install
npm test          # 35 tests across 11 files — includes e2e tsc --noEmit check (~25s)
npm run lint
npm run typecheck

To test the CLI interactively:

npx tsx src/cli.ts

Then answer the prompts and inspect the generated folder — it should contain a working TypeScript Express project that passes tsc --noEmit after npm install.

Example:

Notes

Package is not yet published to npm — publishing is deferred until approved
Before publishing: add "files": ["dist"] to package.json and a #!/usr/bin/env node shebang to src/cli.ts

…d args

Copilot

Pull request overview

This PR bootstraps the create-pipedrive-app CLI scaffold: interactive prompt flow, Node/TypeScript project generators, a formatting/write utility, and repo-level lint/test/CI configuration to validate generated output.

Changes:

Added Clack-based prompt modules (project name, DB, app extensions, webhooks) with unit tests.
Implemented a Node generator that writes a minimal Express/TS project scaffold, plus generator unit tests and an e2e tsc --noEmit check.
Added repo tooling (Vitest, ESLint, Prettier, CI workflow) to support development and validation.

Reviewed changes

Copilot reviewed 31 out of 34 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
vitest.config.ts	Adds Vitest configuration for Node test environment.
tsconfig.json	Adds TypeScript compiler configuration for building the CLI.
src/utils/writeFile.ts	Introduces a Prettier-formatted file writer utility used by generators.
src/utils/writeFile.test.ts	Adds tests covering formatting behavior and fallback paths.
src/prompts/webhooks.ts	Adds a webhooks confirmation prompt with cancel handling.
src/prompts/webhooks.test.ts	Tests the webhooks prompt behavior (true/false/cancel).
src/prompts/projectName.ts	Adds project name prompt and basic validation.
src/prompts/projectName.test.ts	Tests project name prompt behavior and cancel handling.
src/prompts/database.ts	Adds database selection prompt (postgres/mysql/sqlite).
src/prompts/database.test.ts	Tests database selection prompt options and cancel handling.
src/prompts/appExtensions.ts	Adds app extensions prompt (confirm → multiselect) and cancel handling.
src/prompts/appExtensions.test.ts	Tests app extensions prompt flow and cancel handling.
src/generators/interface.ts	Defines generator options/types and generator interface.
src/generators/php/index.ts	Stubs a PHP generator placeholder throwing “not implemented”.
src/generators/node/webhooks.ts	Generates a stub webhooks router module.
src/generators/node/webhooks.test.ts	Tests webhooks generator output.
src/generators/node/oauth.ts	Generates a stub oauth router module.
src/generators/node/oauth.test.ts	Tests oauth generator output.
src/generators/node/database.ts	Generates a stub database module.
src/generators/node/database.test.ts	Tests database generator output.
src/generators/node/appExtensions.ts	Generates stub app-extension router modules based on selected types.
src/generators/node/appExtensions.test.ts	Tests conditional generation of app-extension stubs.
src/generators/node/app.ts	Generates Express app wiring with conditional imports/mounts.
src/generators/node/app.test.ts	Tests conditional imports/mounts in generated `app.ts`.
src/generators/node/index.ts	Orchestrates Node project generation and root config file generation.
src/generators/node/index.test.ts	Tests full/minimal generation and runs a nested `npm install` + `tsc --noEmit` e2e check.
src/cli.ts	Adds CLI entrypoint that runs prompts and invokes the Node generator.
package.json	Adds CLI package metadata, scripts, dependencies, and `bin` entry.
package-lock.json	Locks dependencies for reproducible installs in CI/dev.
eslint.config.js	Adds ESLint flat config using `typescript-eslint`.
.prettierrc	Adds Prettier configuration used by the repo (and potentially by generators).
.gitignore	Adds standard ignores for node/dist/env and docs artifacts.
CLAUDE.md	Adds contributor guidance and intended architecture notes.
.github/workflows/ci.yml	Adds CI workflow running install, lint, and tests on pushes/PRs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+  try {
+    const config = await resolveConfig(filePath);
+    formatted = await format(content, { singleQuote: true, ...config, filepath: filePath });
+  } catch (error) {


+  const value = await clack.text({
+    message: 'Project name?',
+    initialValue: initial,
+    validate: (v) => {
+      if (!v.trim()) return 'Project name is required';
+    },
+  });


+  const projectName = await promptProjectName(process.argv[2]);
+  const database = await promptDatabase();
+  const appExtensions = await promptAppExtensions();
+  const webhooks = await promptWebhooks();
+
+  const outputDir = join(process.cwd(), projectName);
+


+  it('generated project passes tsc --noEmit', async () => {
+    await nodeGenerator.generate(tmpDir, fullOptions);
+    execSync('npm install', { cwd: tmpDir, stdio: 'pipe' });
+    expect(() => {
+      execSync('npx tsc --noEmit', { cwd: tmpDir, stdio: 'pipe' });
+    }).not.toThrow();
+  }, 60_000);


+  console.log('  npm run dev');
+}
+
+main();


+The CLI asks for:
+- Backend: Node.js/Express, Node.js/Fastify, or PHP/Laravel
+- Database: Postgres, MySQL, or SQLite
+- App Extensions frontend: React, Vanilla JS, or none
+- Webhooks: Yes/No


Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

dev app creation folder - app

youssef-saber-3 · 2026-05-11T07:53:16Z

+
+const app = express();
+
+app.use('/oauth', oauthRouter);


did we setup prettier for the cli project as well ? , these lines look a bit not aligned

prettier does not format string literals. I will check for the solution that could be used here.

youssef-saber-3 · 2026-05-11T07:55:16Z

@@ -0,0 +1,7 @@
+import type { Generator, GeneratorOptions } from '../interface.js';


maybe lets remove the php generator placeholder since it's not in the scope of this mission

I was thinking to leave it as a marketing before we implement it and show the structure of different generators we can add to the package 😺 we can remove it anytime

youssef-saber-3 · 2026-05-11T07:57:21Z

+  },
+  "dependencies": {
+    "@clack/prompts": "^0.9.0",
+    "fs-extra": "^11.2.0",


@dmitriyeff i think in newer versions of node they have promise based writeFile functions so maybe we don't need the fs-extra package ? , no strong opinion either way but would be nice if we can have one less dependency if possible

will replace it 👍

dmitriyeff added 25 commits May 8, 2026 12:41

docs: add initial setup design spec for AINATIVEM-41

9e052e1

docs: add implementation plan for AINATIVEM-41 CLI foundation

ab19f42

chore: initialize project scaffold

b3e3c62

chore: remove extra placeholder files from src/

85eeab6

chore: add .gitignore and untrack node_modules

252d98b

ci: add GitHub Actions workflow for lint and test

b83a875

feat: add GeneratorOptions and Generator interface

08356e7

feat: add writeFile utility with prettier formatting

d3b3a31

fix: narrow writeFile catch to no-parser errors only

e0424d7

feat: add projectName prompt

c926756

feat: add database prompt

6cbb05c

feat: add appExtensions prompt

245822f

feat: add webhooks prompt

9a923f6

fix: trim project name input

da99a4e

feat: add oauth stub generator

f1bc3d6

feat: add database stub generator

e9babef

feat: add webhooks stub generator

3ceec43

feat: add appExtensions stub generator

9800ce9

fix: revert trim on projectName, configure eslint to ignore _-prefixe…

36ffe6e

…d args

feat: add app.ts generator with conditional router logic

9424dbd

feat: add node generator orchestrator with root project file generators

21a6b84

feat: add php generator stub

b5628ca

feat: add CLI entry point

a8f7fe4

test: add end-to-end generator test with tsc --noEmit validation

2c9457c

chore: exclude superpowers plans and specs from version control

1480757

Copilot AI review requested due to automatic review settings May 8, 2026 11:23

Copilot started reviewing on behalf of dmitriyeff May 8, 2026 11:24 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

dmitriyeff and others added 2 commits May 8, 2026 14:30

chore: remove dev script, run CLI locally with npx tsx src/cli.ts

a1a469e

Potential fix for pull request finding

612c6bf

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

AINATIVEM-41 co-pilot review adjustments

2382a9a

dev app creation folder - app

youssef-saber-3 reviewed May 11, 2026

View reviewed changes

dmitriyeff added 2 commits May 11, 2026 11:11

AINATIVEM-41 pretify src files

77eed6a

AINATIVEM-41 use native fs lib

f67f24c

youssef-saber-3 approved these changes May 11, 2026

View reviewed changes

dmitriyeff merged commit c2b7cbd into master May 11, 2026
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AINATIVEM-41: CLI tool foundation — create-pipedrive-app scaffold#1

AINATIVEM-41: CLI tool foundation — create-pipedrive-app scaffold#1
dmitriyeff merged 30 commits into
masterfrom
AINATIVEM-41

dmitriyeff commented May 8, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

youssef-saber-3 May 11, 2026

Uh oh!

dmitriyeff May 11, 2026 •

edited

Loading

Uh oh!

youssef-saber-3 May 11, 2026

Uh oh!

dmitriyeff May 11, 2026 •

edited

Loading

Uh oh!

youssef-saber-3 May 11, 2026

Uh oh!

dmitriyeff May 11, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,7 @@
		import type { Generator, GeneratorOptions } from '../interface.js';

Conversation

dmitriyeff commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What to review

What to test

Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

youssef-saber-3 May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dmitriyeff May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youssef-saber-3 May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dmitriyeff May 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youssef-saber-3 May 11, 2026

Choose a reason for hiding this comment

Uh oh!

dmitriyeff May 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dmitriyeff commented May 8, 2026 •

edited

Loading

dmitriyeff May 11, 2026 •

edited

Loading

dmitriyeff May 11, 2026 •

edited

Loading