@fnd-platform/core 1.0.0-alpha.1

package/lib/monorepo-project.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FndMonorepoProject = void 0;
+const projen_1 = require("projen");
+const javascript_1 = require("projen/lib/javascript");
+const components_1 = require("./components");
+/**
+ * Creates a new fnd-platform monorepo project.
+ *
+ * This class extends Projen's TypeScriptProject to provide a complete
+ * monorepo setup with:
+ * - pnpm workspace configuration
+ * - NX build orchestration with intelligent caching
+ * - Shared TypeScript, ESLint, Prettier, and Vitest configurations
+ * - Standard scripts for building, testing, and linting
+ *
+ * All configuration files are generated automatically during synthesis.
+ * Users should not edit generated files directly - instead, modify the
+ * project configuration in `.projenrc.ts` and run synthesis.
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * import { FndMonorepoProject } from '@fnd-platform/core';
+ *
+ * const project = new FndMonorepoProject({
+ *   name: 'my-app',
+ *   defaultReleaseBranch: 'main',
+ * });
+ *
+ * project.synth();
+ * ```
+ *
+ * @example
+ * With custom workspace packages:
+ * ```typescript
+ * const project = new FndMonorepoProject({
+ *   name: 'my-app',
+ *   defaultReleaseBranch: 'main',
+ *   workspacePackages: ['packages/*', 'apps/*'],
+ *   nxCache: true,
+ * });
+ *
+ * project.synth();
+ * ```
+ */
+class FndMonorepoProject extends projen_1.typescript.TypeScriptProject {
+    /**
+     * The pnpm workspace configuration component.
+     */
+    pnpmWorkspace;
+    /**
+     * The NX configuration component.
+     */
+    nxConfig;
+    /**
+     * The shared TypeScript configuration component.
+     */
+    sharedTypeScript;
+    /**
+     * The shared ESLint configuration component.
+     */
+    sharedEslint;
+    /**
+     * The shared Prettier configuration component.
+     */
+    sharedPrettier;
+    /**
+     * The shared Vitest configuration component.
+     */
+    sharedVitest;
+    /**
+     * Creates a new FndMonorepoProject.
+     *
+     * @param options - Configuration options for the monorepo
+     * @throws {Error} If required options (name, defaultReleaseBranch) are missing
+     */
+    constructor(options) {
+        // Validate required options
+        if (!options.name) {
+            throw new Error('FndMonorepoProject requires a name option');
+        }
+        if (!options.defaultReleaseBranch) {
+            throw new Error('FndMonorepoProject requires a defaultReleaseBranch option');
+        }
+        // Call super with merged options
+        super({
+            ...options,
+            packageManager: options.packageManager ?? javascript_1.NodePackageManager.PNPM,
+            // Disable projen's default features that we'll override
+            sampleCode: false,
+            jest: false,
+            eslint: false,
+            prettier: false,
+            // Set projenrc config
+            projenrcTs: true,
+        });
+        // Initialize components
+        // 1. pnpm workspace configuration
+        this.pnpmWorkspace = new components_1.PnpmWorkspace(this, {
+            packages: options.workspacePackages ?? ['packages/*'],
+        });
+        // 2. NX configuration for build orchestration
+        this.nxConfig = new components_1.NxConfig(this, {
+            cacheEnabled: options.nxCache ?? true,
+            cacheableOperations: options.nxCacheableOperations ?? ['build', 'test', 'lint'],
+            targetDefaults: options.nxTargetDefaults,
+        });
+        // 3. Shared TypeScript configuration
+        this.sharedTypeScript = new components_1.SharedTypeScript(this);
+        // 4. Shared ESLint configuration
+        this.sharedEslint = new components_1.SharedEslint(this);
+        // 5. Shared Prettier configuration
+        this.sharedPrettier = new components_1.SharedPrettier(this);
+        // 6. Shared Vitest configuration
+        this.sharedVitest = new components_1.SharedVitest(this);
+        // Add monorepo-specific scripts to package.json
+        // These override the default projen scripts for monorepo usage
+        this.package.setScript('build', 'nx run-many --target=build --all');
+        this.package.setScript('test', 'nx run-many --target=test --all');
+        this.package.setScript('test:coverage', 'nx run-many --target=test --all --coverage');
+        this.package.setScript('lint', 'nx run-many --target=lint --all');
+        this.package.setScript('format', 'prettier --write "**/*.{ts,tsx,js,jsx,json,md,yaml,yml}"');
+        this.package.setScript('format:check', 'prettier --check "**/*.{ts,tsx,js,jsx,json,md,yaml,yml}"');
+        // Add devDependencies for the monorepo
+        this.addDevDeps('nx@19.8.4', 'typescript@^5.6.3', 'eslint@^8.57.0', '@typescript-eslint/eslint-plugin@^7.18.0', '@typescript-eslint/parser@^7.18.0', 'prettier@^3.3.3', 'vitest@^1.6.0', '@vitest/coverage-v8@^1.6.0', 'tsx@^4.19.2');
+        // Set package manager version in package.json
+        this.package.addField('packageManager', 'pnpm@10.6.5');
+        // Set engines
+        this.package.addField('engines', {
+            node: '>=20.0.0',
+            pnpm: '>=8.0.0',
+        });
+        // Create empty packages directory
+        new projen_1.TextFile(this, 'packages/.gitkeep', {
+            lines: [''],
+        });
+        // Create .gitignore with standard ignores
+        this.addGitIgnorePatterns();
+    }
+    /**
+     * Adds standard gitignore patterns for the monorepo.
+     */
+    addGitIgnorePatterns() {
+        // The parent class already creates a .gitignore via IgnoreFile
+        // We just need to add our patterns to it
+        this.gitignore.addPatterns('# Dependencies', 'node_modules/', '', '# Build outputs', 'dist/', 'lib/', '*.js.map', '*.d.ts.map', '', '# NX', '.nx/', '', '# Coverage', 'coverage/', '', '# IDE', '.idea/', '.vscode/', '*.swp', '*.swo', '', '# OS', '.DS_Store', 'Thumbs.db', '', '# Logs', '*.log', 'npm-debug.log*', '', '# Misc', '.env', '.env.local', '*.tgz');
+    }
+}
+exports.FndMonorepoProject = FndMonorepoProject;
+//# sourceMappingURL=monorepo-project.js.map

package/lib/monorepo-project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monorepo-project.js","sourceRoot":"","sources":["../src/monorepo-project.ts"],"names":[],"mappings":";;;AAAA,mCAA8C;AAC9C,sDAA2D;AAC3D,6CAOsB;AAGtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAa,kBAAmB,SAAQ,mBAAU,CAAC,iBAAiB;IAClE;;OAEG;IACa,aAAa,CAAgB;IAE7C;;OAEG;IACa,QAAQ,CAAW;IAEnC;;OAEG;IACa,gBAAgB,CAAmB;IAEnD;;OAEG;IACa,YAAY,CAAe;IAE3C;;OAEG;IACa,cAAc,CAAiB;IAE/C;;OAEG;IACa,YAAY,CAAe;IAE3C;;;;;OAKG;IACH,YAAY,OAAkC;QAC5C,4BAA4B;QAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;QAC/E,CAAC;QAED,iCAAiC;QACjC,KAAK,CAAC;YACJ,GAAG,OAAO;YACV,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,+BAAkB,CAAC,IAAI;YACjE,wDAAwD;YACxD,UAAU,EAAE,KAAK;YACjB,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,KAAK;YACf,sBAAsB;YACtB,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QAEH,wBAAwB;QAExB,kCAAkC;QAClC,IAAI,CAAC,aAAa,GAAG,IAAI,0BAAa,CAAC,IAAI,EAAE;YAC3C,QAAQ,EAAE,OAAO,CAAC,iBAAiB,IAAI,CAAC,YAAY,CAAC;SACtD,CAAC,CAAC;QAEH,8CAA8C;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qBAAQ,CAAC,IAAI,EAAE;YACjC,YAAY,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YACrC,mBAAmB,EAAE,OAAO,CAAC,qBAAqB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;YAC/E,cAAc,EAAE,OAAO,CAAC,gBAAgB;SACzC,CAAC,CAAC;QAEH,qCAAqC;QACrC,IAAI,CAAC,gBAAgB,GAAG,IAAI,6BAAgB,CAAC,IAAI,CAAC,CAAC;QAEnD,iCAAiC;QACjC,IAAI,CAAC,YAAY,GAAG,IAAI,yBAAY,CAAC,IAAI,CAAC,CAAC;QAE3C,mCAAmC;QACnC,IAAI,CAAC,cAAc,GAAG,IAAI,2BAAc,CAAC,IAAI,CAAC,CAAC;QAE/C,iCAAiC;QACjC,IAAI,CAAC,YAAY,GAAG,IAAI,yBAAY,CAAC,IAAI,CAAC,CAAC;QAE3C,gDAAgD;QAChD,+DAA+D;QAC/D,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,kCAAkC,CAAC,CAAC;QACpE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,4CAA4C,CAAC,CAAC;QACtF,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,0DAA0D,CAAC,CAAC;QAC7F,IAAI,CAAC,OAAO,CAAC,SAAS,CACpB,cAAc,EACd,0DAA0D,CAC3D,CAAC;QAEF,uCAAuC;QACvC,IAAI,CAAC,UAAU,CACb,WAAW,EACX,mBAAmB,EACnB,gBAAgB,EAChB,0CAA0C,EAC1C,mCAAmC,EACnC,iBAAiB,EACjB,eAAe,EACf,4BAA4B,EAC5B,aAAa,CACd,CAAC;QAEF,8CAA8C;QAC9C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAEvD,cAAc;QACd,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC/B,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;QAEH,kCAAkC;QAClC,IAAI,iBAAQ,CAAC,IAAI,EAAE,mBAAmB,EAAE;YACtC,KAAK,EAAE,CAAC,EAAE,CAAC;SACZ,CAAC,CAAC;QAEH,0CAA0C;QAC1C,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED;;OAEG;IACK,oBAAoB;QAC1B,+DAA+D;QAC/D,yCAAyC;QACzC,IAAI,CAAC,SAAS,CAAC,WAAW,CACxB,gBAAgB,EAChB,eAAe,EACf,EAAE,EACF,iBAAiB,EACjB,OAAO,EACP,MAAM,EACN,UAAU,EACV,YAAY,EACZ,EAAE,EACF,MAAM,EACN,MAAM,EACN,EAAE,EACF,YAAY,EACZ,WAAW,EACX,EAAE,EACF,OAAO,EACP,QAAQ,EACR,UAAU,EACV,OAAO,EACP,OAAO,EACP,EAAE,EACF,MAAM,EACN,WAAW,EACX,WAAW,EACX,EAAE,EACF,QAAQ,EACR,OAAO,EACP,gBAAgB,EAChB,EAAE,EACF,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AA1KD,gDA0KC"}

package/lib/options.d.ts

@@ -0,0 +1,92 @@
+import { typescript } from 'projen';
+/**
+ * Configuration for an NX target (build, test, lint, etc.).
+ */
+export interface NxTargetConfig {
+    /**
+     * Dependencies that must run before this target.
+     * Use `^build` to depend on the build target of all dependencies.
+     *
+     * @example ['^build']
+     */
+    readonly dependsOn?: string[];
+    /**
+     * Whether this target's output should be cached.
+     *
+     * @default true
+     */
+    readonly cache?: boolean;
+    /**
+     * Input files that affect this target's cache.
+     *
+     * @example ['default', '^production']
+     */
+    readonly inputs?: string[];
+    /**
+     * Output files produced by this target.
+     *
+     * @example ['{projectRoot}/dist']
+     */
+    readonly outputs?: string[];
+}
+/**
+ * Configuration options for FndMonorepoProject.
+ *
+ * Extends Projen's TypeScriptProjectOptions with monorepo-specific settings
+ * for pnpm workspaces and NX orchestration.
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * const project = new FndMonorepoProject({
+ *   name: 'my-app',
+ *   defaultReleaseBranch: 'main',
+ * });
+ * ```
+ *
+ * @example
+ * With custom workspace packages:
+ * ```typescript
+ * const project = new FndMonorepoProject({
+ *   name: 'my-app',
+ *   defaultReleaseBranch: 'main',
+ *   workspacePackages: ['packages/*', 'apps/*', 'tools/*'],
+ *   nxCache: true,
+ * });
+ * ```
+ */
+export interface FndMonorepoProjectOptions extends typescript.TypeScriptProjectOptions {
+    /**
+     * Enable NX caching for build tasks.
+     *
+     * When enabled, NX will cache the results of build, test, and lint
+     * operations to speed up subsequent runs.
+     *
+     * @default true
+     */
+    readonly nxCache?: boolean;
+    /**
+     * Workspace package directory patterns.
+     *
+     * Glob patterns defining where workspace packages are located.
+     * These patterns are used in pnpm-workspace.yaml.
+     *
+     * @default ['packages/*']
+     * @example ['packages/*', 'apps/*', 'tools/*']
+     */
+    readonly workspacePackages?: string[];
+    /**
+     * Custom NX target defaults.
+     *
+     * Override or extend the default NX target configurations
+     * for build, test, and lint operations.
+     */
+    readonly nxTargetDefaults?: Record<string, NxTargetConfig>;
+    /**
+     * Operations that should be cached by NX.
+     *
+     * @default ['build', 'test', 'lint']
+     */
+    readonly nxCacheableOperations?: string[];
+}
+//# sourceMappingURL=options.d.ts.map

package/lib/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,yBAA0B,SAAQ,UAAU,CAAC,wBAAwB;IACpF;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtC;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3C"}

package/lib/options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=options.js.map

package/lib/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@fnd-platform/core",
+  "version": "1.0.0-alpha.1",
+  "description": "Core Projen project classes for fnd-platform monorepo scaffolding",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/"
+  ],
+  "dependencies": {
+    "projen": "^0.91.0"
+  },
+  "peerDependencies": {
+    "projen": "^0.91.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "eslint": "^8.57.0",
+    "typescript": "^5.6.3",
+    "vitest": "^1.6.0"
+  },
+  "keywords": [
+    "projen",
+    "monorepo",
+    "aws",
+    "typescript",
+    "scaffolding",
+    "cdk"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-org/fnd-platform",
+    "directory": "packages/core"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src/ test/"
+  }
+}