https://github.com/guoyunhe/create-node
Initialize a Node.js library project
https://github.com/guoyunhe/create-node
Last synced: about 2 months ago
JSON representation
Initialize a Node.js library project
- Host: GitHub
- URL: https://github.com/guoyunhe/create-node
- Owner: guoyunhe
- License: gpl-3.0
- Created: 2022-12-17T09:59:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-24T12:22:28.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T02:40:40.520Z (about 2 months ago)
- Language: TypeScript
- Size: 51.8 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @guoyunhe/create-node
Initialize a Node.js library project
## Get Started
### Create a new project
```bash
npm create @guoyunhe/node my-lib
```
### Initialize an existing project
```bash
cd my-lib
npm init @guoyunhe/node
```
### Project structure
```bash
├── dist # Build output
│ ├── cjs # CJS format
│ │ └── index.js
│ ├── esm # ESM module format
│ │ └── index.js
│ └── dts # TypeScript types
│ └── index.d.ts
├── src # Source code
│ ├── index.test.ts # API unit test
│ └── index.ts # API entry (add all exports here)
├── .editorconfig
├── .gitignore
├── CHANGELOG.md
├── package.json
├── README.md
└── tsconfig.json
```
### Package scripts
```bash
# Build output
npm run build
# Build output in watch mode
npm run watch
# Format source code
npm run format
# Check lint issues
npm run lint
# Run unit tests (support all jest command options)
npm test
# Run unit tests in watch mode
npm test -- --watch
# Update unit test snapshots
npm test -- -u
```
## Advanced Options
### Initial package version
1.0.0 by default.
```bash
npm create @guoyunhe/node my-lib --package-version=0.1.0
```
### Pure ESM package
If you want your package to be pure ESM, you should modify the following attributes in `package.json`:
```json
{
"type": "module",
"main": "dist/esm/index.js"
}
```