feat: introduce nxt-gen-cli for Next.js project scaffolding with upda…#1
feat: introduce nxt-gen-cli for Next.js project scaffolding with upda…#1prabothcharith merged 1 commit intodevelopmentfrom
Conversation
…ted documentation and dependencies.
There was a problem hiding this comment.
Pull request overview
This PR modernizes the nxt-gen-cli project by renaming the CLI command from cnp to nxt-gen-cli for better discoverability and consistency, updating code style to use double quotes, and providing comprehensive documentation improvements.
- Renamed CLI command from
cnptonxt-gen-cliacross package configuration and source code - Standardized quote style from single to double quotes in src/index.ts
- Completely rewrote README.md with improved structure, detailed examples, and clearer feature explanations
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| package.json | Updated bin field to reference the new CLI command name nxt-gen-cli |
| package-lock.json | Updated bin reference to match package.json changes |
| src/index.ts | Changed CLI name from cnp to nxt-gen-cli and standardized to double quotes throughout |
| README.md | Comprehensive rewrite with better organization, detailed usage examples, feature tables, and updated command references |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "main": "dist/index.js", | ||
| "bin": { | ||
| "cnp": "./bin/cnp" | ||
| "nxt-gen-cli": "./bin/nxt-gen-cli" |
There was a problem hiding this comment.
The bin field references "./bin/nxt-gen-cli" but the actual file in the bin directory is still named "cnp". This will cause the CLI command to fail when users install the package, as npm will look for a file that doesn't exist. The physical file "bin/cnp" needs to be renamed to "bin/nxt-gen-cli" to match this reference.
| import { Command } from "commander"; | ||
| import prompts from "prompts"; | ||
| import chalk from "chalk"; | ||
| import path from "path"; |
There was a problem hiding this comment.
Unused import path.
| import path from "path"; |
| import prompts from "prompts"; | ||
| import chalk from "chalk"; | ||
| import path from "path"; | ||
| import fs from "fs-extra"; |
There was a problem hiding this comment.
Unused import fs.
| import fs from "fs-extra"; |
This pull request primarily improves the usability and clarity of the
nxt-gen-cliproject by updating its documentation, renaming the CLI command for consistency, and modernizing code style. The most significant changes are a comprehensive rewrite of theREADME.mdto provide better instructions and feature explanations, and standardizing the CLI tool's name across the codebase and package configuration.Documentation improvements:
README.mdto provide a clearer overview, detailed installation and usage instructions, feature breakdowns, example commands, and updated project structure. The new documentation is more comprehensive and user-friendly for both new and experienced users.CLI command standardization:
cnptonxt-gen-cliin both thepackage.jsonbinfield and in the code, ensuring consistency in how users invoke the tool. [1] [2]Code consistency and modernization:
src/index.tsto use double quotes for consistency and modern JavaScript style.src/index.tsto match the new command name and improve clarity.…ted documentation and dependencies.