@tukuyomil032/bricklayer 1.0.3 → 1.0.41

package/README.md

@@ -6,12 +6,17 @@ Quickly generate a well-structured TypeScript CLI project with best practices bu
 
 ## Features
 
-✨ **Interactive Setup** - Guided prompts for project configuration
-📦 **Latest Packages** - Automatically fetches the latest npm package versions
-🎨 **Optional Tools** - Choose Prettier and ESLint during setup
-🪝 **Git Hooks** - Pre-configured Husky hooks with lint-staged
-🏗️ **Clean Structure** - Role-separated files and commands
-⚡ **Multiple Package Managers** - Support for pnpm, npm, yarn, and bun
+- ✨ **Interactive Setup** - Guided prompts for project configuration
+- 📦 **Latest Packages** - Automatically fetches the latest npm package versions
+- 🎨 **Optional Tools** - Choose Prettier and ESLint during setup
+- 🪝 **Git Hooks** - Pre-configured Husky hooks with lint-staged
+- 🏗️ **Clean Structure** - Role-separated files and commands
+- ⚡ **Multiple Package Managers** - Support for pnpm, npm, yarn, and bun
+
+## Prerequisites
+
+- Node.js 18+
+- npm, pnpm, yarn, bun
 
 ## Installation
 
@@ -32,16 +37,26 @@ bun add -g @tukuyomil032/bricklayer
 
 ```bash
 # When treating the current directory during command execution as the project's root folder:
-brick create
+$ brick create
+
+# To view the help screen:
+$ brick -h
 
 # 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.
-brick create -d
+$ brick create -d
 
 # You can also specify a project folder directly by entering a relative path after the `-d` option.
-brick create -d ~/Documents/dev/CLI/my-test-project
+$ brick create -d ~/Documents/dev/CLI/my-test-project
 ```
 
+## Available Options
+
+- ``-h --help`` - display help for command
+- ``-V --version`` - output the version number
+- ``-d --destination`` - Specify the project creation directory
+  - This option can be used either to manually select the directory path where the project will be created, or to specify a relative path by entering it directly after “-d”.
+
 Follow the interactive prompts to configure your project:
 
 - Project name
@@ -63,15 +78,16 @@ your-cli/
 ├── .husky/ #options
 │   ├── pre-commit
 │   └── pre-push
-├── .gitignore
-├── .prettierrc
-├── .prettierignore
 ├── .editorconfig
+├── .gitignore
 ├── .npmignore
+├── .npmrc
+├── .prettierignore
+├── .prettierrc
 ├── eslint.config.js
 ├── package.json
-├── tsconfig.json
-└── README.md
+├── README.md
+└── tsconfig.json
 ```
 
 ## Development
@@ -82,10 +98,10 @@ git clone https://github.com/tukuyomil032/bricklayer.git
 cd bricklayer
 
 # Install dependencies
-pnpm install
+npm install
 
 # Build
-pnpm run build
+npm run build
 
 # Test locally
 node dist/index.js create
@@ -93,10 +109,10 @@ node dist/index.js create
 
 ## Scripts
 
-- `pnpm run build` - Build the TypeScript project
-- `pnpm run dev` - Run in development mode
-- `pnpm run lint` - Lint the code
-- `pnpm run format` - Format the code with Prettier
+- `npm run build` - Build the TypeScript project
+- `npm run dev` - Run in development mode
+- `npm run lint` - Lint the code
+- `npm run format` - Format the code with Prettier
 
 ## Requirements
 

package/dist/index.js

@@ -5,7 +5,7 @@ const program = new Command();
 program
     .name('brick')
     .description('Interactive CLI to scaffold TypeScript CLI projects')
-    .version('1.0.3');
+    .version('1.0.41');
 program.addCommand(createCommand());
 program.addCommand(sampleCommand());
 program.parseAsync(process.argv).catch((err) => {

package/package.json

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