boilerforge 1.0.2 → 1.2.0-dev.1

package/src/templates/utils/package-manager.ts

@@ -1,78 +0,0 @@
-import { ProjectDependency } from '../../lib/project';
-import { execCmd, ExecCmdError } from '../../utils/exec-cmd';
-import { logger } from '../../utils/logger';
-
-export enum PackageManager {
-    YARN = 'yarn',
-    NPM = 'npm',
-    PNPM = 'pnpm',
-}
-
-export const getPackageManagerVersion = async (
-    packageManager: string,
-): Promise<string | undefined> => {
-    try {
-        const { stdout: packageManagerVersion = '' } =
-            (await execCmd(`${packageManager} --version`)) ?? {};
-
-        return (
-            packageManagerVersion.match(/(?=(\d+.\d+.\d+))/)?.[1] ?? undefined
-        );
-    } catch (error) {
-        const { code, message } = error as ExecCmdError;
-
-        if (code === 'ENOENT') return undefined;
-
-        logger.err(
-            `Error while checking if ${packageManager} exists, Code: ${code} | Message: ${message}`,
-        );
-
-        throw new Error(
-            `${getPackageManagerVersion.name} error, Code: ${code} | Message: ${message}`,
-        );
-    }
-};
-
-export const installDependencies = async (
-    projectDir: string,
-    packageManager: string,
-    projectDeps: ProjectDependency,
-) => {
-    try {
-        const { dependencies, devDependencies } = projectDeps;
-
-        const cmdForInstall =
-            packageManager === PackageManager.YARN ? 'add' : 'install';
-
-        const devDepsCmd = `${packageManager} ${cmdForInstall} -D ${devDependencies.join(' ')}`;
-
-        devDependencies.length &&
-            (await execCmd(devDepsCmd, { cwd: projectDir }));
-
-        dependencies.length &&
-            (await execCmd(
-                `${packageManager} ${cmdForInstall} ${dependencies.join(' ')}`,
-                { cwd: projectDir },
-            ));
-    } catch (error) {
-        const { code, message } = error as ExecCmdError;
-
-        logger.err(
-            `Error while installing node dependencies ${packageManager}, Code: ${code} | Message: ${message}`,
-        );
-
-        throw new Error(
-            `${installDependencies.name} error, Code: ${code} | Message: ${message}`,
-        );
-    }
-};
-
-export const getLockFileName = (packageManager: string): string | undefined => {
-    const lockFileMap: Record<string, string> = {
-        [PackageManager.YARN]: 'yarn.lock',
-        [PackageManager.NPM]: 'package-lock.json',
-        [PackageManager.PNPM]: 'pnpm-lock.yaml',
-    };
-
-    return lockFileMap[packageManager];
-};

package/src/templates/utils/readme.ts

@@ -1,115 +0,0 @@
-import remarkStringify from 'remark-stringify';
-import { Root } from 'remark-stringify/lib';
-import { unified } from 'unified';
-import { u } from 'unist-builder';
-import { NodejsProject, Resource } from '../../lib/project';
-import { Badge } from './badges';
-import { PackageManager } from './package-manager';
-
-const createBadgeNode = (alt: string, url: string, title?: string) =>
-    u('paragraph', [
-        u('image', {
-            url,
-            alt,
-            title: title || alt,
-        }),
-    ]);
-
-const generateReadMeContent = (project: NodejsProject): string => {
-    const {
-        name: projectName,
-        description,
-        packageManager,
-        enabledTypescript,
-        enabledEslintPrettier,
-    } = project;
-
-    const installDepsCommand =
-        packageManager === PackageManager.YARN
-            ? packageManager
-            : `${packageManager} install`;
-
-    const versionBadge = createBadgeNode(
-        'version',
-        `https://img.shields.io/badge/version-${project.version}-green.svg`,
-    );
-
-    const techBadges = [
-        'nodejs',
-        project.packageManager,
-        enabledTypescript ? 'typescript' : 'javascript',
-        ...(enabledEslintPrettier ? ['eslint', 'prettier'] : []),
-    ].map((tech) => createBadgeNode(tech, Badge[tech.toUpperCase()]));
-
-    const readmeAst = u('root', [
-        u('heading', { depth: 1 }, [u('text', `🚀 ${projectName}`)]),
-
-        u('paragraph', versionBadge),
-
-        ...(description.length
-            ? [
-                  u('heading', { depth: 2 }, [u('text', '📖 About Project')]),
-                  u('paragraph', [u('text', description)]),
-              ]
-            : []),
-
-        u('heading', { depth: 3 }, [u('text', 'Built With')]),
-
-        u('heading', { depth: 4 }, techBadges),
-
-        u('heading', { depth: 3 }, [u('text', '🛠️ Installation')]),
-
-        u('heading', { depth: 4 }, [
-            u('text', 'Navigate into the project directory'),
-        ]),
-        u('code', { lang: '' }, `cd ${projectName}`),
-
-        u('heading', { depth: 4 }, [u('text', 'Install dependencies')]),
-        u('code', { lang: '' }, installDepsCommand),
-
-        u('heading', { depth: 3 }, [u('text', '▶️ Running the App')]),
-
-        ...(enabledTypescript
-            ? [
-                  u('heading', { depth: 4 }, [
-                      u('text', 'To start the app in development mode:'),
-                  ]),
-                  u('code', { lang: '' }, `${packageManager} run dev`),
-              ]
-            : []),
-
-        u('paragraph', [u('text', 'To start the app in production mode:')]),
-
-        ...(enabledTypescript
-            ? [
-                  u('list', { ordered: false }, [
-                      u('listItem', [
-                          u('paragraph', [u('text', 'Build the project')]),
-                          u(
-                              'code',
-                              { lang: '' },
-                              `${packageManager} run build`,
-                          ),
-                      ]),
-                      u('listItem', [
-                          u('paragraph', [u('text', 'Run app in production')]),
-                          u(
-                              'code',
-                              { lang: '' },
-                              `${packageManager} run start`,
-                          ),
-                      ]),
-                  ]),
-              ]
-            : [u('code', { lang: '' }, `${packageManager} run start`)]),
-    ]);
-
-    return unified()
-        .use(remarkStringify)
-        .stringify(readmeAst as Root);
-};
-
-export const getReadmeContent = (project: NodejsProject): Resource => ({
-    filename: 'README.md',
-    content: generateReadMeContent(project),
-});

package/src/utils/exec-cmd.ts

@@ -1,80 +0,0 @@
-import { $, ExecaError, Result } from 'execa';
-
-export type ExecCmdProps = {
-    cwd?: string;
-    throwError?: boolean;
-};
-
-export type ExecCmdErrorProps = {
-    code?: string;
-    command: string;
-    message: string;
-    errorName: string;
-    stack?: string;
-    cause: unknown;
-    shortMessage: string;
-    originalMessage: string;
-};
-
-export class ExecCmdError implements Error {
-    name: string;
-    message: string;
-    stack?: string | undefined;
-    cause: unknown;
-    shortMessage: string;
-    originalMessage: string;
-    errorName: string;
-    command: string;
-    code?: string;
-
-    constructor(execCmdErrorProps: ExecCmdErrorProps) {
-        this.name = 'ExecCmdError';
-        this.message = execCmdErrorProps.message;
-        this.cause = execCmdErrorProps.cause;
-        this.stack = execCmdErrorProps.stack;
-        this.shortMessage = execCmdErrorProps.shortMessage;
-        this.originalMessage = execCmdErrorProps.originalMessage;
-        this.errorName = execCmdErrorProps.errorName;
-        this.command = execCmdErrorProps.command;
-        this.code = execCmdErrorProps.code;
-    }
-}
-
-export const execCmd = async (
-    command: string,
-    execCmdProps?: ExecCmdProps,
-): Promise<Result<{}> | undefined> => {
-    const { cwd = '', throwError = true } = execCmdProps ?? {};
-
-    try {
-        const $cmdExecutor = $.s({
-            ...(cwd?.length ? { cwd } : {}),
-        });
-
-        return $cmdExecutor`${command.trim().split(' ')}`;
-    } catch (error) {
-        if (!throwError) return;
-
-        const {
-            message,
-            cause,
-            stack,
-            shortMessage,
-            originalMessage,
-            name: errorName,
-            command,
-            code,
-        } = error as ExecaError;
-
-        throw new ExecCmdError({
-            message,
-            cause,
-            stack,
-            shortMessage,
-            originalMessage,
-            errorName,
-            command,
-            code,
-        });
-    }
-};

package/src/utils/index.ts

@@ -1,60 +0,0 @@
-import { existsSync, mkdirSync, rmSync } from 'fs';
-import { join } from 'path';
-
-import { logger } from './logger';
-
-export const Regex = {
-    PROJECT_NAME: /^[a-zA-Z][a-zA-Z0-9-]*$/,
-    VERSION:
-        /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z.-]+))?(?:\+([0-9A-Za-z.-]+))?$/,
-};
-
-export namespace DirectoryUtils {
-    export type RemoveDirectoryOptions = {
-        recursive: boolean;
-        errorIfNotExists: boolean;
-    };
-
-    export const create = (dir: string, parentDirPath: string = __dirname) => {
-        const dirPath = join(parentDirPath, dir);
-        try {
-            if (existsSync(dirPath)) return;
-
-            mkdirSync(dirPath, { recursive: true });
-        } catch (error) {
-            logger.err(
-                `Error while creating the directory: ${dirPath}, ${(error as Error).message}`,
-            );
-
-            throw new Error(`Error while creating the directory ${dirPath}`);
-        }
-    };
-
-    export const remove = (
-        relativeDirPath: string,
-        parentDirPath: string = __dirname,
-        removeDirectoryOptions: Partial<RemoveDirectoryOptions> = {
-            recursive: false,
-            errorIfNotExists: false,
-        },
-    ) => {
-        const { recursive, errorIfNotExists } = removeDirectoryOptions;
-
-        const dirPath = join(parentDirPath, relativeDirPath);
-        try {
-            const dirExists = existsSync(dirPath);
-            if (!dirExists && errorIfNotExists)
-                throw new Error(`Error directory does not exists: ${dirPath}`);
-
-            if (!dirExists && !errorIfNotExists) return;
-
-            rmSync(dirPath, { recursive, force: !errorIfNotExists });
-        } catch (error) {
-            logger.err(
-                `Error while removing the directory: ${dirPath}, ${(error as Error).message}`,
-            );
-
-            throw new Error(`Error while removing the directory ${dirPath}`);
-        }
-    };
-}

package/src/utils/logger.ts

@@ -1,24 +0,0 @@
-// Class for logger
-class Logger {
-    static log(...data: unknown[]) {
-        console.log(...data);
-    }
-
-    static warn(...data: unknown[]) {
-        console.warn(...data);
-    }
-
-    static err(...data: unknown[]) {
-        console.error(...data);
-    }
-
-    static critical(...data: unknown[]) {
-        console.error(...data);
-    }
-
-    static info(...data: unknown[]) {
-        console.info(...data);
-    }
-}
-
-export const logger = Logger;

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-    "compilerOptions": {
-      "target": "ES2024",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-      /* Modules */
-      "module": "commonjs",                                /* Specify what module code is generated. */
-      /* Emit */
-      "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
-      /* Interop Constraints */
-      "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-      "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-      /* Type Checking */
-      "strict": true,                                      /* Enable all strict type-checking options. */
-      /* Completeness */
-      "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-    },
-    "include": ["bin/**/*.ts", "src/**/*.ts"]
-}