@tukuyomil032/bricklayer 1.0.1 → 1.0.2

package/README.md

@@ -16,17 +16,33 @@ Quickly generate a well-structured TypeScript CLI project with best practices bu
 ## Installation
 
 ```bash
-npm install -g bricklayer
+npm install -g @tukuyomil032/bricklayer
+
+# or
+pnpm add -g @tukuyomil032/bricklayer
+
 # or
-pnpm add -g bricklayer
+yarn global add @tukuyomil032/bricklayer
+
 # or
-yarn global add bricklayer
+bun add -g @tukuyomil032/bricklayer
 ```
 
 ## Usage
 
 ```bash
+# When treating the current directory during command execution as the project's root folder:
 bricklayer create
+
+# If you want to specify the project's root folder yourself (we generally recommend using this option):
+# Use the arrow keys (up and down) and the Enter key to navigate to the project's root folder.
+bricklayer create -d
+
+# You can also specify a project folder directly by entering a relative path after the `-d` option.
+bricklayer create -d ~/Documents/dev/CLI/my-test-project
+
+# available aliases
+bl create
 ```
 
 Follow the interactive prompts to configure your project:
@@ -34,8 +50,10 @@ Follow the interactive prompts to configure your project:
 - Project name
 - Module system (ESM / CommonJS)
 - Package manager
+- Automatically install dependencies(create lockfile)
 - Git repository details
 - Optional tools (Prettier, ESLint)
+- husky(pre-commit, pre-push)
 
 ## Generated Project Structure
 
@@ -45,7 +63,7 @@ your-cli/
 │   ├── commands/
 │   │   └── hello.ts
 │   └── index.ts
-├── .husky/
+├── .husky/ #options
 │   ├── pre-commit
 │   └── pre-push
 ├── .gitignore

package/dist/create/file-writer.js

@@ -16,77 +16,62 @@ export async function writeProjectFiles(targetDir, answers, versions) {
         'src/commands/hello.ts',
         'README.md',
         '.gitignore',
-        // husky hooks are optional and added conditionally below
         '.prettierignore',
         '.npmignore',
         '.editorconfig',
         'LICENSE',
     ];
-    // Always include ESLint and Prettier config files by default
     tasks.push('.prettierrc');
     tasks.push('eslint.config.js');
     // Add .npmrc when using pnpm
     const shouldAddNpmrc = answers.packageManager === 'pnpm';
-    if (shouldAddNpmrc)
+    if (shouldAddNpmrc) {
         tasks.push('.npmrc');
-    // Add husky hooks entries only if requested
+    }
     if (answers.useHusky) {
         tasks.unshift('.husky/pre-push');
         tasks.unshift('.husky/pre-commit');
     }
     progressBar.start(tasks.length, 0);
     let completed = 0;
-    // Create directory structure
     await fs.mkdir(targetDir, { recursive: true });
     await fs.mkdir(path.join(targetDir, 'src', 'commands'), { recursive: true });
     if (answers.useHusky) {
         await fs.mkdir(path.join(targetDir, '.husky'), { recursive: true });
     }
-    // Write package.json
     const pkg = templates.generatePackageJson(answers, versions);
     await fs.writeFile(path.join(targetDir, 'package.json'), JSON.stringify(pkg, null, 2));
     progressBar.update(++completed);
-    // Write tsconfig.json
     const tsconfig = templates.generateTsConfig(answers);
     await fs.writeFile(path.join(targetDir, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2));
     progressBar.update(++completed);
-    // Write source files
     await fs.writeFile(path.join(targetDir, 'src', 'index.ts'), templates.generateIndexTs(answers));
     progressBar.update(++completed);
     await fs.writeFile(path.join(targetDir, 'src', 'commands', 'hello.ts'), templates.generateHelloCommandTs());
     progressBar.update(++completed);
-    // Write README
     await fs.writeFile(path.join(targetDir, 'README.md'), templates.generateReadme(answers));
     progressBar.update(++completed);
-    // Write .gitignore
     await fs.writeFile(path.join(targetDir, '.gitignore'), templates.generateGitignore());
     progressBar.update(++completed);
-    // Write Husky hooks (only if requested)
     if (answers.useHusky) {
         await fs.writeFile(path.join(targetDir, '.husky', 'pre-commit'), templates.generatePreCommitHook());
         progressBar.update(++completed);
         await fs.writeFile(path.join(targetDir, '.husky', 'pre-push'), templates.generatePrePushHook());
         progressBar.update(++completed);
     }
-    // Always add .prettierignore
     await fs.writeFile(path.join(targetDir, '.prettierignore'), templates.generatePrettierIgnore());
     progressBar.update(++completed);
-    // Always add .npmignore
     await fs.writeFile(path.join(targetDir, '.npmignore'), templates.generateNpmIgnore());
     progressBar.update(++completed);
-    // Conditionally add .npmrc for pnpm
     if (shouldAddNpmrc) {
         await fs.writeFile(path.join(targetDir, '.npmrc'), templates.generateNpmrc());
         progressBar.update(++completed);
     }
-    // Always add .editorconfig
     await fs.writeFile(path.join(targetDir, '.editorconfig'), templates.generateEditorConfig());
     progressBar.update(++completed);
-    // Write LICENSE
     const licenseText = await templates.generateLicenseText(answers.license, answers.author, new Date().getFullYear());
     await fs.writeFile(path.join(targetDir, 'LICENSE'), licenseText);
     progressBar.update(++completed);
-    // Write Prettier and ESLint configs (default included)
     await fs.writeFile(path.join(targetDir, '.prettierrc'), templates.generatePrettierConfig());
     progressBar.update(++completed);
     await fs.writeFile(path.join(targetDir, 'eslint.config.js'), templates.generateEslintConfig());

package/dist/create/index.js

@@ -14,36 +14,32 @@ export function createCommand() {
         .option('-d, --destination [path]', 'Project destination directory');
     cmd.action(async (options) => {
         console.log(chalk.green('Welcome to bricklayer — TypeScript CLI scaffold generator'));
-        // Show spinner
         const initSpinner = ora('Initializing project setup...').start();
-        // Small delay for better UX
         await new Promise((resolve) => setTimeout(resolve, 500));
         initSpinner.stop();
-        // Determine destination behavior
         const flagProvided = Boolean(options.destination);
         const flagHasArg = typeof options.destination === 'string';
         const askDestination = flagProvided && !flagHasArg;
-        // Prompt once: if -d present, always skip the `name` question; if -d without arg, also ask destination interactively first
         const answers = await promptProjectDetails({ skipName: flagProvided, askDestination });
-        // Resolve target directory
         let target;
         if (flagHasArg) {
             const dest = options.destination.replace(/^~/, os.homedir());
             target = path.resolve(dest);
-            if (!answers.name)
+            if (!answers.name) {
                 answers.name = path.basename(target);
+            }
         }
         else if (answers.destination) {
             const dest = answers.destination.replace(/^~/, os.homedir());
             target = path.resolve(dest);
-            if (!answers.name)
+            if (!answers.name) {
                 answers.name = path.basename(target);
+            }
         }
         else {
             const baseDir = process.cwd();
             target = path.resolve(baseDir, answers.name);
         }
-        // Fetch latest package versions
         const versionSpinner = ora('Fetching latest package versions...').start();
         let versions;
         try {
@@ -58,14 +54,12 @@ export function createCommand() {
         try {
             await writeProjectFiles(target, answers, versions);
             fileSpinner.succeed('Project scaffold created at ' + target);
-            // Install dependencies if user opted in
             if (answers.autoInstall) {
                 await installDependencies(target, answers.packageManager);
             }
             else {
                 console.log(chalk.yellow('Dependencies were not installed automatically.'));
             }
-            // Show next steps
             console.log(chalk.blue('Next steps:'));
             console.log(`  - cd ${answers.name}`);
             const buildCmd = answers.packageManager === 'pnpm'

package/dist/create/installer.js

@@ -25,7 +25,6 @@ export async function installDependencies(targetDir, packageManager) {
     const bin = mgr;
     if (!(await isCommandAvailable(bin))) {
         spinner.fail(`${bin} not found on PATH.`);
-        // Try sensible fallback order
         const fallbacks = ['pnpm', 'npm'];
         let usedFallback = null;
         for (const f of fallbacks) {
@@ -72,20 +71,15 @@ function runCommandWithProgress(command, cwd) {
             barsize: 40,
         }, cliProgress.Presets.shades_classic);
         bar.start(100, 0);
-        // Progress state
         let progress = 0;
         let lastRenderedFloor = 0;
         const start = Date.now();
-        // Interval drives internal progress target; we only redraw when integer percent changes
         let lastOutputAt = 0;
-        const tickInterval = 150; // ms
-        const maxHold = 95; // hold at 95% until process completes
+        const tickInterval = 150;
+        const maxHold = 95;
         const timer = setInterval(() => {
             const elapsed = Date.now() - start;
-            // Ease-out target that slowly approaches maxHold
             const target = maxHold * (1 - Math.exp(-elapsed / 6000));
-            // Advance progress a bit toward target, ensuring monotonic increase
-            // If we've recently seen installer output, move faster
             const sinceOutput = lastOutputAt ? Date.now() - lastOutputAt : Infinity;
             const speedMultiplier = sinceOutput < 1000 ? 2.0 : 1.0;
             progress = Math.min(target, progress + 0.6 * speedMultiplier);
@@ -103,11 +97,10 @@ function runCommandWithProgress(command, cwd) {
         const stderrChunks = [];
         const onOutput = () => {
             lastOutputAt = Date.now();
-            // Aggressively advance progress toward maxHold on real installer output
             const remaining = maxHold - progress;
-            if (remaining <= 0)
+            if (remaining <= 0) {
                 return;
-            // Add a chunk that's a fraction of the remaining, clamped
+            }
             const advance = Math.min(remaining, Math.max(4, Math.round(remaining * 0.18)));
             progress = progress + advance;
             const floor = Math.floor(progress);
@@ -139,7 +132,6 @@ function runCommandWithProgress(command, cwd) {
         });
         child.on('close', (code) => {
             clearInterval(timer);
-            // Smoothly ramp to 100% to avoid a sudden jump
             const finishInterval = 40; // ms
             const finishTimer = setInterval(() => {
                 const remaining = 100 - progress;
@@ -150,14 +142,14 @@ function runCommandWithProgress(command, cwd) {
                     }
                     catch { }
                     clearInterval(finishTimer);
-                    if (code === 0)
+                    if (code === 0) {
                         return resolve();
+                    }
                     const out = Buffer.concat(stdoutChunks).toString('utf8');
                     const errOut = Buffer.concat(stderrChunks).toString('utf8');
                     const e = new Error(`Command exited with code ${code}\n${errOut || out}`);
                     return reject(e);
                 }
-                // advance by a fraction of remaining to create ease-out
                 progress = progress + Math.max(1, Math.round(remaining * 0.18));
                 const floor = Math.floor(progress);
                 if (floor > lastRenderedFloor) {

package/dist/create/package-versions.js

@@ -37,7 +37,6 @@ export async function getLatestVersions() {
         'chalk',
         'ora',
         'yargs',
-        // include package manager packages to record their latest versions
         'pnpm',
         'npm',
         'yarn',
@@ -50,7 +49,6 @@ export async function getLatestVersions() {
                 versions[pkg] = await fetchLatestVersion(pkg);
             }
             catch (err) {
-                // Fallback to a reasonable default if fetch fails
                 console.warn(`Failed to fetch version for ${pkg}, using fallback:`, err);
                 versions[pkg] = 'latest';
             }

package/dist/create/prompts.js

@@ -88,7 +88,7 @@ export async function promptProjectDetails(opts = {}) {
     ];
     const totalQuestions = questions.length;
     const answers = {};
-    console.log(''); // Blank line before prompts
+    console.log('');
     const uiWith = inquirer;
     const bottomBar = uiWith.ui && uiWith.ui.BottomBar
         ? new uiWith.ui.BottomBar()
@@ -100,22 +100,18 @@ export async function promptProjectDetails(opts = {}) {
         }
         catch (err) {
             void err;
-            // fallback: write using readline
             readline.clearLine(process.stdout, 0);
             readline.cursorTo(process.stdout, 0);
             process.stdout.write(progressLine + '\n');
         }
     };
-    // Compute effective total: subtract skipped name, add destination prompt if requested
     const effectiveTotal = totalQuestions - (opts.skipName ? 1 : 0) + (opts.askDestination ? 1 : 0);
     let progressCount = 0;
     updateProgress(progressCount);
-    // If askDestination is requested, prompt for it first using an interactive tree navigator
     if (opts.askDestination) {
         const chooseDirectoryInteractive = async (startDir) => {
             let current = startDir;
             while (true) {
-                // list visible directories (exclude hidden)
                 let entries = [];
                 try {
                     entries = fs.readdirSync(current).filter((name) => {
@@ -135,16 +131,12 @@ export async function promptProjectDetails(opts = {}) {
                     { display: '.. (go up)', value: '__UP__' },
                     ...entries.map((e) => ({ display: e + path.sep, value: e })),
                 ];
-                // Add a small circle at the start of each displayed choice to indicate it's selectable
                 choices.forEach((c) => {
                     c.display = `◯ ${c.display}`;
                 });
-                // Enquirer expects choice objects with `name` (unique id) and `message` (display)
                 const select = new Select({
                     name: 'dir',
                     message: `destination: (navigate folders, Enter to choose)`,
-                    // Enquirer Select returns the `name` of the chosen item.
-                    // Use `name` as the internal id (value) and `message` for display.
                     choices: choices.map((c) => ({ name: c.value, message: c.display })),
                     pageSize: 15,
                 });
@@ -153,12 +145,10 @@ export async function promptProjectDetails(opts = {}) {
                     val = await select.run();
                 }
                 catch (err) {
-                    // Enquirer may throw when TTY not available; surface a friendly error
                     console.error('Selection aborted or failed:', err instanceof Error ? err.message : String(err));
                     throw err;
                 }
                 if (val === '__SELECT__') {
-                    // Use Enquirer's Input so the default/current path is actual editable text
                     while (true) {
                         const input = new Input({
                             message: 'destination: (edit or accept)',
@@ -184,29 +174,29 @@ export async function promptProjectDetails(opts = {}) {
                                 ],
                             },
                         ]);
-                        if (confirm.confirmSel === 'confirm')
+                        if (confirm.confirmSel === 'confirm') {
                             return proposed;
-                        if (confirm.confirmSel === 'reenter')
+                        }
+                        if (confirm.confirmSel === 'reenter') {
                             continue;
-                        if (confirm.confirmSel === 'back')
-                            break; // return to navigation
+                        }
+                        if (confirm.confirmSel === 'back') {
+                            break;
+                        }
                     }
                     continue;
                 }
                 if (val === '__UP__') {
                     const parent = path.dirname(current);
                     if (parent === current) {
-                        // already root
                         continue;
                     }
                     current = parent;
                     continue;
                 }
-                // descend into selected subdirectory
                 current = path.join(current, val);
             }
         };
-        // Count the destination question once and show progress before navigation
         progressCount++;
         updateProgress(progressCount);
         const dest = await chooseDirectoryInteractive(process.cwd());
@@ -215,16 +205,13 @@ export async function promptProjectDetails(opts = {}) {
             console.log('→ Selected: ' + chalk.green(dest));
         }
     }
-    // Build list of questions to ask (skip name if requested)
     const toAsk = opts.skipName ? questions.slice(1) : questions.slice();
     for (let i = 0; i < toAsk.length; i++) {
         const question = toAsk[i];
-        // Update the single progress bottom bar just before each prompt
         progressCount++;
         updateProgress(progressCount);
         const answer = await inquirer.prompt([question]);
         Object.assign(answers, answer);
-        // Display selected value in color for clarity (above the bottom bar)
         const key = question.name;
         const val = answer[key];
         if (typeof val === 'string') {
@@ -237,7 +224,6 @@ export async function promptProjectDetails(opts = {}) {
             console.log('→ Selected: ' + (val ? chalk.green('yes') : chalk.yellow('no')));
         }
     }
-    // Finalize progress
     updateProgress(effectiveTotal);
     try {
         bottomBar.updateBottomBar(`Project Scaffolding Progress: [${effectiveTotal}/${effectiveTotal}] Done.`);
@@ -246,6 +232,6 @@ export async function promptProjectDetails(opts = {}) {
     catch (err) {
         void err;
     }
-    console.log(''); // Blank line after completion
+    console.log('');
     return answers;
 }

package/dist/create/templates.js

@@ -208,9 +208,8 @@ export function generatePackageJson(answers, versions) {
             return 'bun run build';
         return `${m} run build`;
     }
-    const prepareScript = answers.useHusky
-        ? `husky install && ${buildCmdForManager(mgr)}`
-        : buildCmdForManager(mgr);
+    // When Husky is enabled, keep prepare as just 'husky' (user requested).
+    const prepareScript = answers.useHusky ? 'husky' : buildCmdForManager(mgr);
     return {
         name: answers.npmPackageName || answers.name,
         private: false,
@@ -232,6 +231,7 @@ export function generatePackageJson(answers, versions) {
             typecheck: 'tsc --noEmit',
             lint: 'eslint "src/**/*.ts"',
             'lint:fix': 'eslint "src/**/*.ts" --fix',
+            'lint-staged': 'lint-staged',
             format: 'prettier --write "src/**/*.ts"',
             'format:check': 'prettier --check "src/**/*.ts"',
         }, answers.useHusky ? {} : {}),
@@ -355,26 +355,41 @@ export function generateEslintConfig() {
 import globals from 'globals';
 import tseslint from 'typescript-eslint';
 import json from '@eslint/json';
-import { defineConfig } from 'eslint/config';
 
-export default defineConfig({
-  ignores: ['dist/'],
-  overrides: [
-    {
-      files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
-      plugins: { js },
-      extends: ['js/recommended'],
-      languageOptions: { globals: globals.node },
+export default [
+  {
+    ignores: ['dist/**'],
+  },
+
+  {
+    files: ['**/*.{js,mjs,cjs}'],
+    languageOptions: {
+      globals: globals.node,
+    },
+    ...js.configs.recommended,
+  },
+
+  {
+    files: ['**/*.{ts,mts,cts}'],
+    languageOptions: {
+      globals: globals.node,
+      parser: tseslint.parser,
     },
-    Object.assign({ files: ['**/*.{ts,mts,cts}'] }, tseslint.configs.recommended),
-    {
-      files: ['**/*.json'],
-      plugins: { json },
-      language: 'json/json',
-      extends: ['json/recommended'],
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
     },
-  ],
-});
+    rules: {
+      ...tseslint.configs.recommended.rules,
+    },
+  },
+
+  {
+    files: ['**/*.json'],
+    language: 'json/json',
+    plugins: { json },
+    ...json.configs.recommended,
+  },
+];
 `;
 }
 export async function generateLicenseText(license, author, year) {
@@ -402,4 +417,3 @@ export async function generateLicenseText(license, author, year) {
         .replace(fullnameRegex, author)
         .replace(nameRegex, author);
 }
-// Note: .eslintignore generation removed in favor of eslint.config.js ignores

package/dist/index.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 import { Command } from 'commander';
 import { createCommand } from './create/index.js';
 import { sampleCommand } from './sample.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tukuyomil032/bricklayer",
   "private": false,
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Interactive TypeScript CLI project scaffolder",
   "type": "module",
   "main": "./dist/index.js",