domain-driver 0.1.0 → 0.3.0

package/dist/utils/naming.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toPascalCase = toPascalCase;
+exports.lowerFirst = lowerFirst;
+exports.validateFeatureName = validateFeatureName;
+exports.upperFirst = upperFirst;
+exports.toKebabCase = toKebabCase;
+const FEATURE_NAME_PATTERN = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/;
+function toPascalCase(name) {
+    return name
+        .split('-')
+        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+        .join('');
+}
+function lowerFirst(name) {
+    return name.charAt(0).toLowerCase() + name.slice(1);
+}
+function validateFeatureName(name) {
+    if (!FEATURE_NAME_PATTERN.test(name)) {
+        throw new Error(`Feature name "${name}" must be kebab-case, for example coffee-type.`);
+    }
+}
+function upperFirst(name) {
+    return name.charAt(0).toUpperCase() + name.slice(1);
+}
+function toKebabCase(name) {
+    return name
+        .replace(/([a-z0-9])([A-Z])/g, '$1-$2')
+        .replace(/([A-Z])([A-Z][a-z])/g, '$1-$2')
+        .toLowerCase();
+}

package/dist/utils/paths.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.featureDir = featureDir;
+exports.apiRouteDir = apiRouteDir;
+const path = __importStar(require("path"));
+function featureDir(stack, feature) {
+    return path.join(process.cwd(), stack.featureRoot, feature);
+}
+function apiRouteDir(stack, feature) {
+    return path.join(process.cwd(), stack.featureRoot, 'api', feature);
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "domain-driver",
-  "version": "0.1.0",
-  "description": "CLI scaffolding tool for domain-driven development in Next.js",
-  "main": "index.js",
+  "version": "0.3.0",
+  "description": "CLI scaffolding tool for domain-driven feature folders in Next.js, React, Node, and NestJS projects, with per-action files, bespoke actions, and agent guidance",
+  "main": "dist/index.js",
   "bin": {
     "domain-driver": "./dist/index.js"
   },
@@ -10,15 +10,36 @@
     "type": "git",
     "url": "https://github.com/IsaacHatilima/domain-driver"
   },
+  "files": [
+    "dist",
+    "scripts/postinstall.js"
+  ],
   "scripts": {
-    "build": "tsc",
-    "test": "vitest run"
+    "build": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\" && tsc",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "postinstall": "node ./scripts/postinstall.js"
   },
-  "keywords": [],
+  "keywords": [
+    "cli",
+    "scaffolding",
+    "domain-driven",
+    "nextjs",
+    "react",
+    "nestjs",
+    "node",
+    "express",
+    "fastify",
+    "hono"
+  ],
   "author": "Isaac Hatilima",
   "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
   "devDependencies": {
     "@types/node": "^25.4.0",
+    "@vitest/coverage-v8": "^4.1.2",
     "typescript": "^5.9.3",
     "vitest": "^4.1.2"
   },

package/scripts/postinstall.js

@@ -0,0 +1,7 @@
+// Runs after `npm install` in a consuming project. Never fails the install:
+// dist/ may be absent on a fresh clone, and init may throw for any reason.
+try {
+    require('../dist/postinstall.js').run();
+} catch (_error) {
+    // intentionally silent
+}

package/.github/workflows/publish.yml

@@ -1,28 +0,0 @@
-name: Publish to npm
-
-on:
-  push:
-    branches:
-      - master
-    tags:
-      - 'v*'
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '18'
-          registry-url: 'https://registry.npmjs.org'
-
-      - run: npm install
-      - run: npm run build
-      - run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/dist/utils.js

@@ -1,132 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPascalCase = toPascalCase;
-exports.featureBasePath = featureBasePath;
-exports.ensureFeatureExists = ensureFeatureExists;
-exports.writeFileSafe = writeFileSafe;
-exports.mkdirSafe = mkdirSafe;
-exports.fileExists = fileExists;
-exports.detectAlias = detectAlias;
-exports.resetAliasCache = resetAliasCache;
-exports.resolveImport = resolveImport;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-function toPascalCase(name) {
-    return name
-        .split('-')
-        .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
-        .join('');
-}
-function featureBasePath(feature) {
-    return path.join(process.cwd(), 'app', feature);
-}
-function ensureFeatureExists(feature, subdir) {
-    const base = path.join(featureBasePath(feature), subdir);
-    if (!fs.existsSync(base)) {
-        throw new Error(`Feature "${feature}" does not exist. Run: domain-driver make:feature ${feature}`);
-    }
-    return base;
-}
-function writeFileSafe(filePath, content) {
-    try {
-        fs.writeFileSync(filePath, content);
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : 'Unknown error';
-        throw new Error(`Failed to write ${filePath}: ${message}`);
-    }
-}
-function mkdirSafe(dirPath) {
-    try {
-        fs.mkdirSync(dirPath, { recursive: true });
-    }
-    catch (error) {
-        const message = error instanceof Error ? error.message : 'Unknown error';
-        throw new Error(`Failed to create directory ${dirPath}: ${message}`);
-    }
-}
-function fileExists(filePath) {
-    return fs.existsSync(filePath);
-}
-let cachedAlias;
-function detectAlias() {
-    if (cachedAlias)
-        return cachedAlias;
-    const tsconfigPath = path.join(process.cwd(), 'tsconfig.json');
-    if (!fs.existsSync(tsconfigPath)) {
-        cachedAlias = { alias: null, appDir: 'app' };
-        return cachedAlias;
-    }
-    try {
-        const raw = fs.readFileSync(tsconfigPath, 'utf-8');
-        const stripped = raw.replace(/\/\/.*$/gm, '').replace(/\/\*[\s\S]*?\*\//g, '');
-        const tsconfig = JSON.parse(stripped);
-        const paths = tsconfig?.compilerOptions?.paths;
-        if (paths) {
-            for (const [key, values] of Object.entries(paths)) {
-                const targets = values;
-                const hasAppMapping = targets.some((v) => v === './app/*' || v === 'app/*' || v === './src/app/*' || v === 'src/app/*');
-                if (hasAppMapping && key.endsWith('/*')) {
-                    const prefix = key.slice(0, -1);
-                    const appDir = targets[0].replace('/*', '').replace('./', '');
-                    cachedAlias = { alias: prefix, appDir };
-                    return cachedAlias;
-                }
-                const hasSrcMapping = targets.some((v) => v === './src/*' || v === 'src/*' || v === './*');
-                if (hasSrcMapping && key.endsWith('/*')) {
-                    const prefix = key.slice(0, -1);
-                    cachedAlias = { alias: prefix, appDir: 'app' };
-                    return cachedAlias;
-                }
-            }
-        }
-    }
-    catch {
-        // tsconfig parse failed, fall back to relative imports
-    }
-    cachedAlias = { alias: null, appDir: 'app' };
-    return cachedAlias;
-}
-function resetAliasCache() {
-    cachedAlias = undefined;
-}
-function resolveImport(fromFeature, relativePath, fromRoot = false) {
-    const { alias } = detectAlias();
-    if (alias) {
-        return `${alias}app/${fromFeature}/${relativePath}`;
-    }
-    return fromRoot ? `./${relativePath}` : `../${relativePath}`;
-}

package/src/__tests__/utils.test.ts

@@ -1,128 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import { toPascalCase, detectAlias, resolveImport, resetAliasCache } from '../utils';
-
-describe('toPascalCase', () => {
-    it('converts kebab-case to PascalCase', () => {
-        expect(toPascalCase('coffee-type')).toBe('CoffeeType');
-    });
-
-    it('handles single word', () => {
-        expect(toPascalCase('user')).toBe('User');
-    });
-
-    it('handles multiple hyphens', () => {
-        expect(toPascalCase('my-long-feature-name')).toBe('MyLongFeatureName');
-    });
-});
-
-describe('detectAlias', () => {
-    let testDir: string;
-    let originalCwd: string;
-
-    beforeEach(() => {
-        originalCwd = process.cwd();
-        testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dd-alias-'));
-        process.chdir(testDir);
-        resetAliasCache();
-    });
-
-    afterEach(() => {
-        process.chdir(originalCwd);
-        fs.rmSync(testDir, { recursive: true, force: true });
-    });
-
-    it('returns null alias when no tsconfig exists', () => {
-        const result = detectAlias();
-        expect(result.alias).toBeNull();
-    });
-
-    it('detects @/ alias mapping to ./app/*', () => {
-        fs.writeFileSync(
-            path.join(testDir, 'tsconfig.json'),
-            JSON.stringify({
-                compilerOptions: {
-                    paths: { '@/*': ['./app/*'] },
-                },
-            })
-        );
-        const result = detectAlias();
-        expect(result.alias).toBe('@/');
-    });
-
-    it('detects @/ alias mapping to ./src/*', () => {
-        fs.writeFileSync(
-            path.join(testDir, 'tsconfig.json'),
-            JSON.stringify({
-                compilerOptions: {
-                    paths: { '@/*': ['./src/*'] },
-                },
-            })
-        );
-        const result = detectAlias();
-        expect(result.alias).toBe('@/');
-    });
-
-    it('detects custom alias like ~/*', () => {
-        fs.writeFileSync(
-            path.join(testDir, 'tsconfig.json'),
-            JSON.stringify({
-                compilerOptions: {
-                    paths: { '~/*': ['./app/*'] },
-                },
-            })
-        );
-        const result = detectAlias();
-        expect(result.alias).toBe('~/');
-    });
-
-    it('returns null when paths has no matching pattern', () => {
-        fs.writeFileSync(
-            path.join(testDir, 'tsconfig.json'),
-            JSON.stringify({
-                compilerOptions: {
-                    paths: { '@components/*': ['./components/*'] },
-                },
-            })
-        );
-        const result = detectAlias();
-        expect(result.alias).toBeNull();
-    });
-});
-
-describe('resolveImport', () => {
-    let testDir: string;
-    let originalCwd: string;
-
-    beforeEach(() => {
-        originalCwd = process.cwd();
-        testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dd-resolve-'));
-        process.chdir(testDir);
-        resetAliasCache();
-    });
-
-    afterEach(() => {
-        process.chdir(originalCwd);
-        fs.rmSync(testDir, { recursive: true, force: true });
-    });
-
-    it('uses relative path when no alias', () => {
-        const result = resolveImport('coffee-type', 'hooks/useCoffeeType');
-        expect(result).toBe('../hooks/useCoffeeType');
-    });
-
-    it('uses alias path when @/ alias exists', () => {
-        fs.writeFileSync(
-            path.join(testDir, 'tsconfig.json'),
-            JSON.stringify({
-                compilerOptions: {
-                    paths: { '@/*': ['./app/*'] },
-                },
-            })
-        );
-        const result = resolveImport('coffee-type', 'hooks/useCoffeeType');
-        expect(result).toBe('@/app/coffee-type/hooks/useCoffeeType');
-    });
-});

package/src/commands/__tests__/feature.test.ts

@@ -1,85 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import { makeFeature } from '../feature';
-import { resetAliasCache } from '../../utils';
-
-let testDir: string;
-let originalCwd: string;
-
-function cleanup(): void {
-    process.chdir(originalCwd);
-    resetAliasCache();
-    if (fs.existsSync(testDir)) {
-        fs.rmSync(testDir, { recursive: true, force: true });
-    }
-}
-
-describe('make:feature', () => {
-    beforeEach(() => {
-        originalCwd = process.cwd();
-        testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dd-feature-'));
-        process.chdir(testDir);
-        resetAliasCache();
-    });
-    afterEach(cleanup);
-
-    it('creates feature directories with .gitkeep files', async () => {
-        await makeFeature('test-feature', false);
-
-        const base = path.join(testDir, 'app', 'test-feature');
-        expect(fs.existsSync(base)).toBe(true);
-        expect(fs.existsSync(path.join(base, 'components/client/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'components/server/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'containers/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'hooks/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'services/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'repositories/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'schemas/.gitkeep'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'types/.gitkeep'))).toBe(true);
-    });
-
-    it('creates page.tsx with PascalCase component name', async () => {
-        await makeFeature('test-feature', false);
-
-        const page = fs.readFileSync(path.join(testDir, 'app/test-feature/page.tsx'), 'utf-8');
-        expect(page).toContain('TestFeaturePage');
-        expect(page).toContain('export default function');
-    });
-
-    it('throws if feature already exists', async () => {
-        await makeFeature('test-feature', false);
-        await expect(makeFeature('test-feature', false)).rejects.toThrow('already exists');
-    });
-
-    it('scaffolds all files with -a flag', async () => {
-        await makeFeature('coffee-type', true);
-
-        const base = path.join(testDir, 'app', 'coffee-type');
-
-        // No .gitkeep files when -a is used
-        expect(fs.existsSync(path.join(base, 'components/client/.gitkeep'))).toBe(false);
-
-        // All files created with correct names
-        expect(fs.existsSync(path.join(base, 'page.tsx'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'components/client/CoffeeType.tsx'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'containers/CoffeeTypeContainer.tsx'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'hooks/useCoffeeType.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'schemas/CreateCoffeeType.schema.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'schemas/UpdateCoffeeType.schema.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'services/ListCoffeeType.service.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'services/CreateCoffeeType.service.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'repositories/ListCoffeeType.repository.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'repositories/CreateCoffeeType.repository.ts'))).toBe(true);
-        expect(fs.existsSync(path.join(base, 'types/CoffeeType.types.ts'))).toBe(true);
-    });
-
-    it('page imports container when -a flag is used', async () => {
-        await makeFeature('coffee-type', true);
-
-        const page = fs.readFileSync(path.join(testDir, 'app/coffee-type/page.tsx'), 'utf-8');
-        expect(page).toContain("import CoffeeTypeContainer from './containers/CoffeeTypeContainer'");
-        expect(page).toContain('<CoffeeTypeContainer />');
-    });
-});

package/src/commands/__tests__/imports.test.ts

@@ -1,115 +0,0 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import { makeFeature } from '../feature';
-import { resetAliasCache } from '../../utils';
-
-let testDir: string;
-let originalCwd: string;
-
-function readFile(relativePath: string): string {
-    return fs.readFileSync(path.join(testDir, 'app', relativePath), 'utf-8');
-}
-
-function cleanup(): void {
-    process.chdir(originalCwd);
-    resetAliasCache();
-    if (fs.existsSync(testDir)) {
-        fs.rmSync(testDir, { recursive: true, force: true });
-    }
-}
-
-describe('inter-layer imports (no alias)', () => {
-    beforeEach(async () => {
-        originalCwd = process.cwd();
-        testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dd-imports-'));
-        process.chdir(testDir);
-        resetAliasCache();
-        await makeFeature('coffee-type', true);
-    });
-    afterEach(cleanup);
-
-    it('types file is created with interface', () => {
-        const content = readFile('coffee-type/types/CoffeeType.types.ts');
-        expect(content).toContain('export interface CoffeeType');
-        expect(content).toContain('id: string');
-    });
-
-    it('container imports hook and component with relative paths', () => {
-        const content = readFile('coffee-type/containers/CoffeeTypeContainer.tsx');
-        expect(content).toContain("from '../hooks/useCoffeeType'");
-        expect(content).toContain("from '../components/client/CoffeeType'");
-    });
-
-    it('hook imports type, services, and schemas with relative paths', () => {
-        const content = readFile('coffee-type/hooks/useCoffeeType.ts');
-        expect(content).toContain("import { CoffeeType } from '../types/CoffeeType.types'");
-        expect(content).toContain("from '../services/ListCoffeeType.service'");
-        expect(content).toContain("from '../schemas/CreateCoffeeType.schema'");
-    });
-
-    it('services import type and repositories with relative paths', () => {
-        const content = readFile('coffee-type/services/CreateCoffeeType.service.ts');
-        expect(content).toContain("import { CoffeeType } from '../types/CoffeeType.types'");
-        expect(content).toContain("from '../repositories/CreateCoffeeType.repository'");
-    });
-
-    it('repositories import type and schema types', () => {
-        const create = readFile('coffee-type/repositories/CreateCoffeeType.repository.ts');
-        expect(create).toContain("import { CoffeeType } from '../types/CoffeeType.types'");
-        expect(create).toContain("from '../schemas/CreateCoffeeType.schema'");
-
-        const list = readFile('coffee-type/repositories/ListCoffeeType.repository.ts');
-        expect(list).toContain("import { CoffeeType } from '../types/CoffeeType.types'");
-    });
-
-    it('delete repository has no schema import but has type import', () => {
-        const del = readFile('coffee-type/repositories/DeleteCoffeeType.repository.ts');
-        expect(del).not.toContain('import');
-    });
-});
-
-describe('inter-layer imports (with @/ alias)', () => {
-    beforeEach(async () => {
-        originalCwd = process.cwd();
-        testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'dd-alias-imports-'));
-        process.chdir(testDir);
-        resetAliasCache();
-
-        fs.writeFileSync(
-            path.join(testDir, 'tsconfig.json'),
-            JSON.stringify({
-                compilerOptions: {
-                    paths: { '@/*': ['./app/*'] },
-                },
-            })
-        );
-
-        await makeFeature('coffee-type', true);
-    });
-    afterEach(cleanup);
-
-    it('container imports use @/ alias', () => {
-        const content = readFile('coffee-type/containers/CoffeeTypeContainer.tsx');
-        expect(content).toContain("from '@/app/coffee-type/hooks/useCoffeeType'");
-        expect(content).toContain("from '@/app/coffee-type/components/client/CoffeeType'");
-    });
-
-    it('hook imports use @/ alias', () => {
-        const content = readFile('coffee-type/hooks/useCoffeeType.ts');
-        expect(content).toContain("from '@/app/coffee-type/types/CoffeeType.types'");
-        expect(content).toContain("from '@/app/coffee-type/services/ListCoffeeType.service'");
-    });
-
-    it('services import repositories with @/ alias', () => {
-        const content = readFile('coffee-type/services/CreateCoffeeType.service.ts');
-        expect(content).toContain("from '@/app/coffee-type/types/CoffeeType.types'");
-        expect(content).toContain("from '@/app/coffee-type/repositories/CreateCoffeeType.repository'");
-    });
-
-    it('page imports container with @/ alias', () => {
-        const content = readFile('coffee-type/page.tsx');
-        expect(content).toContain("from '@/app/coffee-type/containers/CoffeeTypeContainer'");
-    });
-});