create-npmjs
v1.0.5
Published
A CLI tool to create TypeScript projects
Maintainers
Readme
Based on the project code and package.json, I'll create an English version of README.md for this project:
create-npmjs
A CLI tool to create TypeScript projects
Description
create-npmjs is a command-line interface tool that helps you quickly scaffold new TypeScript projects with proper configuration and structure. It generates a ready-to-use TypeScript project with all necessary configuration files and initial code.
Features
- Creates complete TypeScript project structure
- Preconfigured tsconfig.json for TypeScript compilation
- Ready-to-publish package with proper package.json settings
- Includes common scripts for building and development
- Supports scoped package names (e.g.,
@myorg/my-project) - Configured for Node.js >= 14.0.0
Installation
You don't need to install this tool separately. It can be used directly with npm init command.
Usage
To create a new TypeScript project, run:
npm init npmjsThe tool will prompt you for:
- Project name (can include scoped names like
@myorg/my-project) - Project description (optional)
- Author information (defaults to "jvy [email protected]")
Example
npm init npmjs
# Enter project name: @myorg/my-awesome-project
# Enter project description: An awesome TypeScript project
# Enter author information: Your Name <[email protected]>This will create a new directory with your project name and generate all necessary files.
Generated Project Structure
The tool creates the following structure:
your-project/
├── src/
│ └── index.ts
├── package.json
├── tsconfig.jsonDefault Scripts
The generated project includes these npm scripts:
npm run build- Compiles TypeScript to JavaScript using tscnpm start- Runs the TypeScript code directly with ts-nodenpm publish- Publishes your package (automatically runs build first)
License
MIT
