boilerforge 1.0.2 → 1.2.0-dev.1

package/src/templates/create-node-app/index.ts

@@ -1,306 +0,0 @@
-import { sep } from 'path';
-import { File } from '../../lib/file';
-import {
-    NodejsProject,
-    NodejsProjectProps,
-    ProjectDependency,
-    Resource,
-} from '../../lib/project';
-import { Prompter } from '../../lib/prompter';
-import { Task } from '../../lib/task';
-import { execCmd } from '../../utils/exec-cmd';
-import { getGitConfiguration, getGitVersion } from '../utils/git';
-import {
-    getLockFileName,
-    getPackageManagerVersion,
-    installDependencies,
-} from '../utils/package-manager';
-import { getReadmeContent } from '../utils/readme';
-import { getEditorConfigContent } from './resource/editor-config';
-import { getEslintContent } from './resource/eslint';
-import { getGitIgnoreContent } from './resource/gitignore';
-import { getPackageJsonContent } from './resource/package-json';
-import {
-    getPrettierIgnoreContent,
-    getPrettierrcContent,
-} from './resource/prettier';
-import { getProjectDeps } from './resource/project-deps';
-import { srcFileContent } from './resource/project-files';
-import { getTsConfigContent } from './resource/tsconfig';
-import { Regex } from '../../utils';
-
-export class CreateNodeApp extends NodejsProject {
-    constructor(props: NodejsProjectProps) {
-        super(props);
-        this.isTypescript = false;
-        this.isEslintPrettier = false;
-        this.configureCliCommand();
-    }
-
-    async setup(): Promise<CreateNodeApp> {
-        // creating the tasks
-        const {
-            systemCheckTask,
-            setupProjectTask,
-            installDepsTask,
-            gitInitTask,
-        } = this.buildTasks(getProjectDeps(this));
-
-        this.tasks = [
-            systemCheckTask,
-            setupProjectTask,
-            installDepsTask,
-            gitInitTask,
-        ];
-
-        await this.bootstrap();
-
-        return this;
-    }
-
-    buildTasks(projectDeps: ProjectDependency): {
-        systemCheckTask: Task;
-        setupProjectTask: Task;
-        installDepsTask: Task;
-        gitInitTask: Task;
-    } {
-        // verify git
-        const verifyGitTask = new Task({
-            title: 'Checking Git availability',
-            task: async () => {
-                this.systemCheck.git = {
-                    version: await getGitVersion(),
-                };
-            },
-        });
-
-        // git configuration (user.name & user.email)
-        const verifyGitConfigTask = new Task({
-            title: 'Checking Git config (user.name & user.email)',
-            enabled: () => !!this.systemCheck.git,
-            task: async () => {
-                const gitConfig = await getGitConfiguration({
-                    global: true,
-                });
-
-                if (!gitConfig) return;
-
-                const username = gitConfig['user.name'];
-                const email = gitConfig['user.email'];
-
-                username &&
-                    email &&
-                    (this.systemCheck.git = {
-                        ...this.systemCheck.git,
-                        configuration: {
-                            username,
-                            email,
-                        },
-                    });
-            },
-        });
-
-        // verify package manager
-        const verifyPkgManagerTask = new Task({
-            title: `Verifying ${this.packageManager} availability`,
-            task: async () => {
-                const pkgManagerVersion = await getPackageManagerVersion(
-                    this.packageManager,
-                );
-
-                if (!pkgManagerVersion)
-                    throw new Error(`${this.packageManager} is not installed`);
-
-                this.packageManagerVersion = pkgManagerVersion;
-                this.systemCheck.packageManager = `${this.packageManager}@${pkgManagerVersion}`;
-            },
-        });
-
-        // checking system requirements
-        const systemCheckTask = new Task({
-            title: 'Verifying System Requirements',
-            subTasks: [
-                verifyGitTask,
-                verifyGitConfigTask,
-                verifyPkgManagerTask,
-            ],
-        });
-
-        // creating the project dir
-        const setupProjectTask = new Task({
-            title: `Scaffolding ${this.name} project`,
-            task: async () => {
-                const resourceFileContent: Resource[] = [
-                    getGitIgnoreContent(),
-                    getEditorConfigContent(),
-                    ...(this.enabledEslintPrettier
-                        ? [getEslintContent(this), getPrettierrcContent()]
-                        : []),
-                    getPackageJsonContent(this),
-                    getPrettierIgnoreContent(),
-                    ...(this.enabledTypescript ? [getTsConfigContent()] : []),
-                    getReadmeContent(this),
-                    srcFileContent(this),
-                ];
-
-                this.files = resourceFileContent.map(
-                    ({ filename, content }) =>
-                        new File(filename, {
-                            dirPath: this.projectPath,
-                            content: `${content.trim()}\n`,
-                        }),
-                );
-
-                await Promise.all(this.files.map((file) => file.create()));
-            },
-            rollback: () => {
-                this.files.map((file) => file.delete());
-            },
-        });
-
-        // installing dependencies
-        const installDepsTask = new Task({
-            title: `Installing dependencies`,
-            task: async () => {
-                await installDependencies(
-                    this.projectPath,
-                    this.packageManager,
-                    projectDeps,
-                );
-            },
-            rollback: async () => {
-                await execCmd(`rm -rf node_modules`, {
-                    cwd: this.projectPath,
-                    throwError: false,
-                });
-
-                const lockFile = getLockFileName(this.packageManager);
-
-                lockFile &&
-                    (await execCmd(`rm ${lockFile}`, {
-                        cwd: this.projectPath,
-                        throwError: false,
-                    }));
-            },
-        });
-
-        // initialize git
-        const gitInitTask = new Task({
-            title: 'Initializing git',
-            enabled: () => !!this.systemCheck.git?.version,
-            task: async () => {
-                await execCmd('git init', {
-                    cwd: this.projectPath,
-                });
-
-                const { username, email } =
-                    this.systemCheck.git?.configuration ?? {};
-
-                username &&
-                    email &&
-                    (await execCmd('git commit -am"✨ Initial project setup"', {
-                        cwd: this.projectPath,
-                    }));
-            },
-            rollback: async () =>
-                this.systemCheck.git?.version &&
-                (await execCmd(`rm -rf .git`, {
-                    cwd: this.projectPath,
-                    throwError: false,
-                })),
-        });
-
-        return {
-            systemCheckTask,
-            setupProjectTask,
-            installDepsTask,
-            gitInitTask,
-        };
-    }
-
-    async configureCliCommand(): Promise<CreateNodeApp> {
-        this.program
-            .command('create-node-app')
-            .description('Create simple node.js app')
-            .argument('[name]', 'name of the project', '')
-            .action(async (name) => {
-                this.name = name;
-                await this.promptUser();
-                await this.setup();
-            });
-
-        return this;
-    }
-
-    async promptUser(): Promise<void> {
-        const prompter = new Prompter([
-            {
-                type: 'input',
-                name: 'name',
-                default: '',
-                description: {
-                    message: 'Project name',
-                    default: process.cwd().split(sep).slice(-1)[0],
-                },
-                validate: (value) =>
-                    !value.length || Regex.PROJECT_NAME.test(value)
-                        ? true
-                        : 'Invalid project name',
-                skip: !!this.name.length,
-            },
-            {
-                type: 'input',
-                name: 'description',
-                default: '',
-                description: { message: 'Description' },
-            },
-            {
-                type: 'input',
-                name: 'version',
-                default: '0.0.1',
-                description: { message: 'Version' },
-                validate: (value) =>
-                    Regex.VERSION.test(value) ? true : 'Invalid version',
-            },
-            {
-                type: 'input',
-                name: 'author',
-                default: '',
-                description: { message: 'Author' },
-            },
-            {
-                type: 'select',
-                name: 'packageManager',
-                choices: ['npm', 'yarn', 'pnpm'],
-                default: 0,
-                description: { message: 'Package manager', default: 'npm' },
-            },
-            {
-                type: 'radio',
-                name: 'isTypescript',
-                enabled: 'Yes',
-                disabled: 'No',
-                default: true,
-                description: { message: 'Use TypeScript' },
-            },
-            {
-                type: 'radio',
-                name: 'isEslintPrettier',
-                enabled: 'Yes',
-                disabled: 'No',
-                default: true,
-                description: { message: 'Use ESLint & Prettier formatting' },
-            },
-        ] as const);
-
-        const { isEslintPrettier, isTypescript, ...restResponse } =
-            await prompter.prompt();
-
-        this.configureProject({
-            ...restResponse,
-        });
-
-        this.isTypescript = isTypescript;
-        this.isEslintPrettier = isEslintPrettier;
-    }
-}

package/src/templates/create-node-app/resource/editor-config.ts

@@ -1,24 +0,0 @@
-import { Resource } from '../../../lib/project';
-
-const content = `
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.yml]
-indent_style = space
-indent_size = 2
-`;
-
-export const getEditorConfigContent = (): Resource => {
-    return {
-        filename: '.editorconfig',
-        content,
-    };
-};

package/src/templates/create-node-app/resource/eslint.ts

@@ -1,62 +0,0 @@
-import { NodejsProject, Resource } from '../../../lib/project';
-
-const eslintTsContent = `
-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/*"] },
-]);
-`;
-
-const eslintJsContent = `
-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/*"] },
-]);
-`;
-
-export const getEslintContent = (project: NodejsProject): Resource => {
-    const filename = 'eslint.config.mjs';
-
-    return {
-        filename,
-        content: project.enabledTypescript ? eslintTsContent : eslintJsContent,
-    };
-};

package/src/templates/create-node-app/resource/package-json.ts

@@ -1,57 +0,0 @@
-import { NodejsProject, Resource } from '../../../lib/project';
-import { PackageManager } from '../../utils/package-manager';
-
-export const getPackageJsonContent = (project: NodejsProject): Resource => {
-    const { name, author, description, packageManager, version } = project;
-
-    const ci = `${packageManager} ${packageManager === PackageManager.NPM ? 'ci' : 'install --frozen-lockfile'}`;
-
-    const prebuildScript = [`${packageManager} run clean`];
-
-    project.enabledEslintPrettier &&
-        prebuildScript.push(
-            `${packageManager} run lint`,
-            `${packageManager} run format`,
-        );
-
-    const packageJson = {
-        name,
-        version,
-        description,
-        author,
-        license: 'ISC',
-        packageManager: project.getPackageManager(),
-        main: project.enabledTypescript ? 'dist/' : 'src/',
-        scripts: {
-            ci,
-            ...(project.enabledTypescript
-                ? {
-                      clean: 'rimraf dist',
-                      build: 'tsc',
-                      dev: 'ts-node src/',
-                      prebuild: prebuildScript.join(' && '),
-                      start: 'node dist/',
-                      ...(project.enabledEslintPrettier
-                          ? {
-                                lint: 'eslint --ext .js,.ts .',
-                                format: 'prettier --write "**/*.+(js|ts)"',
-                            }
-                          : {}),
-                  }
-                : {
-                      start: 'node src/',
-                      ...(project.enabledEslintPrettier
-                          ? {
-                                lint: 'eslint --ext .js .',
-                                format: 'prettier --write "**/*.+(js)"',
-                            }
-                          : {}),
-                  }),
-        },
-    };
-
-    return {
-        filename: 'package.json',
-        content: JSON.stringify(packageJson, null, 4),
-    };
-};

package/src/templates/create-node-app/resource/prettier.ts

@@ -1,45 +0,0 @@
-import { Resource } from '../../../lib/project';
-
-const prettierignore = `
-.gitignore
-.editorconfig
-*.json
-
-node_modules/
-
-# build or bundles
-build/
-
-# Ignore built js files
-dist/
-`;
-
-export const getPrettierrcContent = (): Resource => {
-    const prettierrcJson = {
-        printWidth: 80,
-        tabWidth: 4,
-        useTabs: false,
-        semi: true,
-        singleQuote: true,
-        quoteProps: 'as-needed',
-        trailingComma: 'all',
-        arrowParens: 'always',
-        parser: 'typescript',
-        proseWrap: 'always',
-        endOfLine: 'auto',
-        embeddedLanguageFormatting: 'auto',
-        singleAttributePerLine: true,
-    };
-
-    return {
-        filename: '.prettierrc.json',
-        content: JSON.stringify(prettierrcJson, null, 4),
-    };
-};
-
-export const getPrettierIgnoreContent = (): Resource => {
-    return {
-        filename: '.prettierignore',
-        content: prettierignore,
-    };
-};

package/src/templates/create-node-app/resource/project-deps.ts

@@ -1,30 +0,0 @@
-import { NodejsProject, ProjectDependency } from '../../../lib/project';
-
-export const getProjectDeps = (project: NodejsProject): ProjectDependency => {
-    const { enabledEslintPrettier, enabledTypescript } = project;
-
-    const esLintPrettierDeps = enabledEslintPrettier
-        ? [
-              '@eslint/js',
-              'eslint',
-              'globals',
-              'prettier',
-              ...(enabledTypescript
-                  ? [
-                        '@typescript-eslint/eslint-plugin',
-                        '@typescript-eslint/parser',
-                        'typescript-eslint',
-                    ]
-                  : []),
-          ]
-        : [];
-
-    const tsDeps = enabledTypescript
-        ? ['@types/node', 'ts-node', 'typescript', 'rimraf']
-        : [];
-
-    return {
-        dependencies: [],
-        devDependencies: [...esLintPrettierDeps, ...tsDeps],
-    };
-};

package/src/templates/create-node-app/resource/project-files.ts

@@ -1,17 +0,0 @@
-import { NodejsProject, Resource } from '../../../lib/project';
-
-export const srcFileContent = (project: NodejsProject): Resource => {
-    const filename = `src/index.${project.enabledTypescript ? 'ts' : 'js'}`;
-    const content = `
-async function main() {
-    console.log('Hello from ${project.name}');
-}
-
-main().catch((error) => console.error(error));
-`;
-
-    return {
-        filename,
-        content,
-    };
-};

package/src/templates/create-node-app/resource/tsconfig.ts

@@ -1,20 +0,0 @@
-import { Resource } from '../../../lib/project';
-
-export const getTsConfigContent = (): Resource => {
-    const tsconfigJson = {
-        compilerOptions: {
-            target: 'ES2024',
-            module: 'commonjs',
-            outDir: './dist',
-            esModuleInterop: true,
-            forceConsistentCasingInFileNames: true,
-            strict: true,
-            skipLibCheck: true,
-        },
-        include: ['src'],
-    };
-    return {
-        filename: 'tsconfig.json',
-        content: JSON.stringify(tsconfigJson, null, 4),
-    };
-};

package/src/templates/index.ts

@@ -1 +0,0 @@
-export { CreateNodeApp } from './create-node-app';

package/src/templates/utils/badges.ts

@@ -1,13 +0,0 @@
-export const Badge: Record<string, string> = {
-    TYPESCRIPT:
-        'https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white',
-    JAVASCRIPT:
-        'https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E',
-    NODEJS: 'https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white',
-    YARN: 'https://img.shields.io/badge/yarn-%232C8EBB.svg?style=for-the-badge&logo=yarn&logoColor=white',
-    NPM: 'https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white',
-    PNPM: 'https://img.shields.io/badge/pnpm-%234a4a4a.svg?style=for-the-badge&logo=pnpm&logoColor=f69220',
-    ESLINT: 'https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white',
-    PRETTIER:
-        'https://img.shields.io/badge/prettier-%23F7B93E.svg?style=for-the-badge&logo=prettier&logoColor=black',
-};

package/src/templates/utils/git.ts

@@ -1,64 +0,0 @@
-import { ExecaError } from 'execa';
-import { execCmd, ExecCmdError } from '../../utils/exec-cmd';
-import { logger } from '../../utils/logger';
-
-import type {} from '../../utils';
-
-export type GitOptions = {
-    global: boolean;
-};
-
-const defaultGitOptions: GitOptions = {
-    global: false,
-};
-
-export const getGitVersion = async (): Promise<string | undefined> => {
-    try {
-        const { stdout: gitVersion = '' } =
-            (await execCmd('git --version')) ?? {};
-        return gitVersion.match(/(?=(\d+.\d+.\d+))/)?.[1];
-    } catch (error) {
-        const { code, message } = error as ExecCmdError;
-
-        if (code === 'ENOENT') return undefined;
-
-        logger.err(
-            `Error while checking if git exists, Code: ${code} | Message: ${message}`,
-        );
-
-        throw new Error(
-            `${getGitVersion.name} error, Code: ${code} | Message: ${message}`,
-        );
-    }
-};
-
-export const getGitConfiguration = async (
-    options: GitOptions = { ...defaultGitOptions },
-): Promise<Record<string, string | undefined> | undefined> => {
-    const { global } = options;
-
-    try {
-        const { stdout: gitConfigResult = '' } =
-            (await execCmd(`git config -l ${global ? '--global' : ''}`)) ?? {};
-
-        if (!gitConfigResult.length) return undefined;
-
-        const gitConfig = Object.fromEntries(
-            gitConfigResult.split('\n').map((config) => config.split('=')),
-        );
-
-        return gitConfig;
-    } catch (error) {
-        const { code, message } = error as ExecaError;
-
-        logger.err(
-            `Error while getting ${global ? 'global' : 'local'} git config, Code: ${code} | Message: ${message}`,
-        );
-
-        if (code === 'ENOENT') throw new Error('git does not exists');
-
-        throw new Error(
-            `${getGitConfiguration.name} error, Code: ${code} | Message: ${message}`,
-        );
-    }
-};