boilerforge 1.0.0 → 1.2.0-dev.1

package/dist/templates/create-simple-app/package.json.hbs

@@ -0,0 +1,30 @@
+{
+    "name": "{{name}}",
+    "version": "{{version}}",
+    "description": "{{description}}",
+    "author": "{{author}}",
+    "license": "ISC",
+    "main": "{{main}}",
+    {{#if scripts}}
+    "scripts": {
+        {{#each scripts}}
+        "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
+        {{/each}}
+    },
+    {{/if}}
+    {{#if devDependencies}}
+    "devDependencies": {
+        {{#each devDependencies}}
+        "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
+        {{/each}}
+    },
+    {{/if}}
+    {{#if dependencies}}
+    "dependencies": {
+        {{#each dependencies}}
+        "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
+        {{/each}}
+    },
+    {{/if}}
+    "packageManager": "{{packageManager}}"
+}

package/dist/templates/create-simple-app/src/index.js.hbs

@@ -0,0 +1,5 @@
+async function main() {
+    console.log('Hello from {{name}}');
+}
+
+main().catch((error) => console.error(error));

package/dist/templates/create-simple-app/src/index.ts.hbs

@@ -0,0 +1,5 @@
+async function main() {
+    console.log('Hello from {{name}}');
+}
+
+main().catch((error) => console.error(error));

package/dist/templates/create-simple-app/tsconfig.json.hbs

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "target": "ES2024",
+        "module": "commonjs",
+        "outDir": "./dist",
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true
+    },
+    "include": [
+        "src"
+    ]
+}

package/package.json

@@ -1,34 +1,50 @@
 {
   "name": "boilerforge",
-  "version": "1.0.0",
+  "version": "1.2.0-dev.1",
   "description": "✨ boilerforge is a blazing-fast CLI utility that scaffolds clean, ready-to-use project structures so you can skip the setup and start building instantly.",
-  "main": "dist/",
+  "main": "dist/cli.js",
   "bin": {
     "boilerforge": "dist/cli.js"
   },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">= 20.11.1"
+  },
   "scripts": {
     "clean": "rimraf dist",
     "ci": "pnpm install --frozen-lockfile",
-    "build": "esbuild bin/cli.ts --bundle --platform=node --outfile=dist/cli.js --format=cjs",
+    "build": "ts-node esbuild.config.ts",
     "prebuild": "pnpm run clean && pnpm run lint && pnpm run format",
-    "start": "node dist/",
+    "start": "node dist/cli.js",
     "lint": "eslint --ext .js,.ts .",
     "format": "prettier --write \"**/*.+(js|ts)\"",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "dev": "ts-node bin/cli.ts"
+    "dev": "ts-node bin/cli.ts",
+    "prepare": "husky"
   },
   "keywords": [],
+  "publishConfig": {
+    "tag": "dev"
+  },
   "author": "tspyder7",
   "license": "MIT",
   "packageManager": "pnpm@10.9.0",
   "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@eslint/js": "^9.25.1",
     "@types/node": "^22.15.2",
     "@typescript-eslint/eslint-plugin": "^8.31.0",
     "@typescript-eslint/parser": "^8.31.0",
     "esbuild": "^0.25.3",
+    "esbuild-plugin-copy": "^2.1.1",
     "eslint": "^9.25.1",
     "globals": "^16.0.0",
+    "husky": "^9.1.7",
     "prettier": "^3.5.3",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
@@ -41,6 +57,8 @@
     "commander": "^13.1.0",
     "enquirer": "^2.4.1",
     "execa": "^9.5.2",
+    "globby": "^14.1.0",
+    "handlebars": "^4.7.8",
     "inquirer": "^12.6.1",
     "listr2": "^8.3.2",
     "remark-stringify": "^11.0.0",

package/{src/templates/create-node-app/resource/gitignore.ts → templates/create-simple-app/.gitignore.hbs}

@@ -1,6 +1,3 @@
-import { Resource } from '../../../lib/project';
-
-const gitignore = `
 # Logs
 logs
 *.log
@@ -141,15 +138,5 @@ dist
 # build or bundles
 build/**/*
 
-# Ignore built ts files
+# Ignore built js files
 dist/**/*
-`;
-
-export const getGitIgnoreContent = (): Resource => {
-    const filename = '.gitignore';
-
-    return {
-        filename,
-        content: gitignore,
-    };
-};

package/templates/create-simple-app/eslint.config.mjs.hbs

@@ -0,0 +1,23 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import eslintPluginTs from '@typescript-eslint/eslint-plugin';
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+    { files: ["**/*.{js,mjs,cjs,ts}"], plugins: { js }, extends: ["js/recommended"] },
+    { files: ["**/*.{js,mjs,cjs,ts}"], languageOptions: { globals: globals.node } },
+    tseslint.configs.recommended,
+    {
+        plugins: {
+            '@typescript-eslint': eslintPluginTs,
+        },
+        rules: {
+            "@typescript-eslint/no-namespace": "off",
+            "@typescript-eslint/no-empty-interface": "off",
+            "@typescript-eslint/no-empty-object-type": "off",
+            "@typescript-eslint/no-unused-expressions": "off"
+        }
+    },
+    { ignores: ["node_modules/*", "dist/*"] },
+]);

package/templates/create-simple-app/package.json.hbs

@@ -0,0 +1,30 @@
+{
+    "name": "{{name}}",
+    "version": "{{version}}",
+    "description": "{{description}}",
+    "author": "{{author}}",
+    "license": "ISC",
+    "main": "{{main}}",
+    {{#if scripts}}
+    "scripts": {
+        {{#each scripts}}
+        "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
+        {{/each}}
+    },
+    {{/if}}
+    {{#if devDependencies}}
+    "devDependencies": {
+        {{#each devDependencies}}
+        "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
+        {{/each}}
+    },
+    {{/if}}
+    {{#if dependencies}}
+    "dependencies": {
+        {{#each dependencies}}
+        "{{@key}}": "{{this}}"{{#unless @last}},{{/unless}}
+        {{/each}}
+    },
+    {{/if}}
+    "packageManager": "{{packageManager}}"
+}

package/templates/create-simple-app/src/index.js.hbs

@@ -0,0 +1,5 @@
+async function main() {
+    console.log('Hello from {{name}}');
+}
+
+main().catch((error) => console.error(error));

package/templates/create-simple-app/src/index.ts.hbs

@@ -0,0 +1,5 @@
+async function main() {
+    console.log('Hello from {{name}}');
+}
+
+main().catch((error) => console.error(error));

package/templates/create-simple-app/tsconfig.json.hbs

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "target": "ES2024",
+        "module": "commonjs",
+        "outDir": "./dist",
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true
+    },
+    "include": [
+        "src"
+    ]
+}

package/.github/workflows/npm-publish.yml

@@ -1,34 +0,0 @@
-name: Publish to NPM
-
-on:
-  push:
-    branches:
-      - main  # Trigger publish on push to main
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "22"
-          registry-url: "https://registry.npmjs.org/"
-
-      - name: Install pnpm
-        run: npm install -g pnpm
-
-      - name: Install dependencies
-        run: pnpm install
-
-      - name: Build
-        run: pnpm run build
-
-      - name: Publish to NPM
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/bin/cli.ts

@@ -1,21 +0,0 @@
-#!/usr/bin/env node
-
-import { Command } from 'commander';
-import cliConfig from '../src/config/cli-config';
-import { CreateNodeApp } from '../src/templates';
-
-(async function () {
-    const program = new Command();
-    program
-        .name(cliConfig.name)
-        .description(cliConfig.description)
-        .version(
-            cliConfig.version,
-            '-v, --version',
-            'output the version number',
-        );
-
-    new CreateNodeApp({ program });
-
-    program.parse();
-})();

package/src/config/cli-config.ts

@@ -1,20 +0,0 @@
-type SemVersion =
-    | `${number}.${number}.${number}`
-    | `${number}.${number}.${number}-${string}`
-    | `${number}.${number}.${number}+${string}`
-    | `${number}.${number}.${number}-${string}+${string}`;
-
-type CLIConfiguration = {
-    name: string;
-    description: string;
-    version: SemVersion;
-};
-
-const cliConfig: CLIConfiguration = {
-    name: 'boilerforge',
-    description:
-        'boilerforge is a blazing-fast CLI utility that scaffolds clean, ready-to-use project structures so you can skip the setup and start building instantly.',
-    version: '0.0.1',
-};
-
-export default cliConfig;

package/src/lib/file.ts

@@ -1,159 +0,0 @@
-import {
-    createReadStream,
-    createWriteStream,
-    existsSync,
-    mkdirSync,
-    readdirSync,
-    rmdirSync,
-    unlinkSync,
-    writeFileSync,
-} from 'fs';
-import { join, sep } from 'path';
-
-import { logger } from '../utils/logger';
-
-export class File {
-    private fileName: string;
-    private filePath: string;
-    private fileExtension?: string;
-    private dirPath: string;
-    private contextPath: string;
-    private relativeDirPath: string;
-    private relativeFilePath: string;
-    private content?: string;
-
-    constructor(
-        filePath: string,
-        fileOptions?: { dirPath?: string; content?: string },
-    ) {
-        const { content = '', dirPath } = fileOptions ?? {};
-
-        const filePathSplit = filePath.split('/');
-
-        const relativeDirPath = join(
-            ...filePathSplit.slice(0, filePathSplit.length - 1),
-        );
-
-        const fileName = filePathSplit[filePathSplit.length - 1];
-
-        this.contextPath = dirPath ?? __dirname;
-        this.fileName = fileName;
-        this.content = content;
-        this.dirPath = join(
-            this.contextPath,
-            relativeDirPath.length ? relativeDirPath : __dirname,
-        );
-        this.filePath = join(this.dirPath, fileName);
-        this.fileExtension = fileName.split('.').at(1);
-        this.relativeDirPath = relativeDirPath;
-        this.relativeFilePath = join(relativeDirPath, fileName);
-    }
-
-    get getFileName(): string {
-        return this.fileName;
-    }
-
-    get getFilePath(): string {
-        return this.filePath;
-    }
-
-    get getFileExtension(): string | undefined {
-        return this.fileExtension;
-    }
-
-    get getDirPath(): string {
-        return this.dirPath;
-    }
-
-    get getContextPath(): string {
-        return this.contextPath;
-    }
-
-    get getRelativeDirPath(): string {
-        return this.relativeDirPath;
-    }
-
-    get getRelativeFilePath(): string {
-        return this.relativeFilePath;
-    }
-
-    create(content?: string) {
-        try {
-            mkdirSync(this.dirPath, { recursive: true });
-            writeFileSync(
-                this.filePath,
-                content || this.content || '',
-                'utf-8',
-            );
-        } catch (error) {
-            logger.err(
-                `Error while creating the file: ${this.filePath}, ${(error as Error).message}`,
-            );
-
-            throw new Error(`Error while creating the file ${this.filePath}`);
-        }
-    }
-
-    isExists() {
-        return existsSync(this.filePath);
-    }
-
-    delete() {
-        if (!this.isExists())
-            throw new Error(`File does not exists: ${this.filePath}`);
-
-        try {
-            unlinkSync(this.filePath);
-            this.deleteDir();
-        } catch (error) {
-            logger.err(
-                `Error while deleting the file: ${this.filePath}, ${(error as Error).message}`,
-            );
-
-            throw new Error(`Error while deleting the file ${this.filePath}`);
-        }
-    }
-
-    async createFrom(file: File) {
-        if (!file.isExists())
-            throw new Error(
-                `File to copy from does not exist: ${file.getFilePath}`,
-            );
-
-        if (this.isExists())
-            throw new Error(`File already exists: ${this.filePath}`);
-
-        await new Promise((resolve, reject) => {
-            const readStream = createReadStream(file.getFilePath, 'utf-8');
-            const writeStream = createWriteStream(this.filePath);
-
-            readStream.pipe(writeStream);
-
-            readStream.on('error', reject);
-            writeStream.on('error', reject);
-            writeStream.on('finish', () => resolve);
-        });
-    }
-
-    private deleteDir() {
-        try {
-            const dirs = this.relativeDirPath.split(sep);
-
-            for (let i = dirs.length; i > 0; i--) {
-                const dirPath = join(this.contextPath, ...dirs.slice(0, i));
-
-                if (readdirSync(dirPath).length) break;
-
-                rmdirSync(dirPath);
-            }
-        } catch (error) {
-            logger.err(
-                `Error while deleting the dirs: ${this.relativeDirPath}, ${(error as Error).message}`,
-            );
-
-            throw new Error(
-                `Error while deleting the dirs: ${this.relativeDirPath}`,
-            );
-        }
-    }
-}

package/src/lib/project.ts

@@ -1,210 +0,0 @@
-import { Command } from 'commander';
-import { Listr, ListrTaskWrapper } from 'listr2';
-import { dirname, join } from 'path';
-import { logger } from '../utils/logger';
-import { File } from './file';
-import { Task } from './task';
-
-export interface GitCheck {
-    version?: string;
-    configuration?: {
-        username: string;
-        email: string;
-    };
-}
-
-export interface SystemCheck {
-    git?: GitCheck;
-    packageManager?: string;
-}
-
-export interface ProjectDependency {
-    devDependencies: string[];
-    dependencies: string[];
-}
-
-export interface Resource {
-    filename: string;
-    content: string;
-}
-
-export interface ProjectProps {
-    name: string;
-    packageManager: string;
-    description?: string;
-    version?: string;
-    author?: string;
-}
-
-export interface BootstrapProps extends Partial<ProjectProps> {
-    program: Command;
-    showSubTasks?: boolean;
-    showErrorMessage?: boolean;
-}
-
-export interface NodejsProjectProps extends BootstrapProps {}
-
-export abstract class Project {
-    name: string = '';
-    description: string = '';
-    version: string = '';
-    author: string = '';
-    projectPath: string = '';
-    parentDirPath: string = '';
-    packageManager: string = '';
-    packageManagerVersion: string = '';
-
-    protected configureProject(projectProps: Partial<ProjectProps>) {
-        const {
-            name = this.name,
-            description,
-            version = '0.0.1',
-            author,
-            packageManager = '',
-        } = projectProps;
-
-        const cwd = process.cwd();
-
-        this.name = !name.length ? cwd[cwd.length - 1] : name;
-        this.description =
-            description ?? `Node.js application for ${this.name}`;
-        this.version = version;
-        this.author = author ?? '';
-        this.packageManager = packageManager;
-        this.projectPath = join(cwd, name.length ? name : '');
-        this.parentDirPath = name.length ? cwd : dirname(cwd);
-        this.packageManagerVersion = '';
-    }
-
-    getPackageManager() {
-        return `${this.packageManager}@${this.packageManagerVersion}`;
-    }
-}
-
-export abstract class Bootstrap extends Project {
-    protected tasks: Task[];
-    protected executedTasks: Task[];
-    protected showSubTasks?: boolean;
-    protected showErrorMessage?: boolean;
-    protected taskExecutor: Listr;
-    protected systemCheck: SystemCheck;
-    protected files: File[];
-    protected program: Command;
-    protected cmdExecutedFromDir: string;
-
-    constructor(props: BootstrapProps) {
-        super();
-        this.tasks = [];
-        this.executedTasks = [];
-        this.showSubTasks = props.showSubTasks ?? true;
-        this.showErrorMessage = props.showErrorMessage ?? false;
-        this.taskExecutor = new Listr([]);
-        this.systemCheck = {};
-        this.files = [];
-        this.program = props.program;
-        this.cmdExecutedFromDir = process.cwd();
-        this.configureProject(props);
-    }
-
-    private async buildListrTask(
-        taskHandler: Task,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ): Promise<{ title: string; task: any; enabled?: any }> {
-        if (!taskHandler.subTasks.length) {
-            return {
-                title: taskHandler.title,
-                enabled: taskHandler.enabled,
-                task: async () => {
-                    await taskHandler.task();
-                    this.executedTasks.push(taskHandler);
-                },
-            };
-        }
-
-        return {
-            title: taskHandler.title,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            task: async (_: any, task: ListrTaskWrapper<any, any, any>) => {
-                await taskHandler.task();
-                this.executedTasks.push(taskHandler);
-
-                const subTasks = [];
-                for (const subTask of taskHandler.subTasks) {
-                    subTasks.push(await this.buildListrTask(subTask));
-                }
-
-                return task.newListr([...subTasks], {
-                    exitOnError: taskHandler.exitOnError,
-                    concurrent: taskHandler.concurrent,
-                });
-            },
-        };
-    }
-
-    async bootstrap(): Promise<void> {
-        try {
-            const listrTasks = await Promise.all(
-                this.tasks.map(
-                    async (taskHandler) =>
-                        await this.buildListrTask(taskHandler),
-                ),
-            );
-
-            this.taskExecutor.add(listrTasks);
-            this.taskExecutor.options = {
-                rendererOptions: {
-                    showErrorMessage: this.showErrorMessage,
-                    showSubtasks: this.showSubTasks,
-                },
-            };
-            await this.taskExecutor.run();
-        } catch (error) {
-            logger.err(error);
-
-            const rollbacks = this.tasks
-                .map(({ rollback }) => rollback)
-                .reverse();
-
-            await Promise.all(
-                rollbacks.map(
-                    async (rollback) => rollback && (await rollback()),
-                ),
-            );
-        }
-    }
-
-    async setup(): Promise<Bootstrap> {
-        throw new Error('Not Implemented');
-    }
-
-    async configureCliCommand(): Promise<Bootstrap> {
-        throw new Error('Not Implemented');
-    }
-
-    async promptUser() {
-        throw new Error('Not Implemented');
-    }
-
-    getSystemCheck() {
-        return this.systemCheck;
-    }
-}
-
-export abstract class NodejsProject extends Bootstrap {
-    protected isTypescript: boolean;
-    protected isEslintPrettier: boolean;
-
-    constructor(nodejsProjectProps: NodejsProjectProps) {
-        super(nodejsProjectProps);
-        this.isTypescript = false;
-        this.isEslintPrettier = false;
-    }
-
-    get enabledTypescript() {
-        return this.isTypescript;
-    }
-
-    get enabledEslintPrettier() {
-        return this.isEslintPrettier;
-    }
-}