Skip to content

Latest commit

 

History

History

javascript

README.md

create lib starter

Commitizen friendly

English | 简体中文

This is a startup development configuration template used to build the JavaScript/Node.js library.

The build tool is based on rollup and babel, among other tools.

Bundle

Run npm run build, the following bundles will eventually be generated.

build/
├── bundle.esm.js
├── bundle.esm.min.js
├── bundle.umd.js
└── bundle.umd.min.js

Will also generate the corresponding sourcemap file.

Usage

  • For development:

    npm run dev

Development Guidelines

Git Commit Message Format

Adopt community commit format best practices:

# Before
git commit

# Now
npm run commit

This constraint relies on tools commitizen and commitlint provided by the community.

npm publish

The version management of this module adopts the specifications recommended by the community Semantic Versioning. Follow version changes and maintain a CHANGELOG.md(Learn why).

# Update version and generate changelog before publishing to npm repository
npm run release # npm run release -- --first-release
# Or, preview
npm run release -- --dry-run

# Then
npm publish # npm publish --access public

These jobs are done with the help of standard-version tool provided by the community.

License

MIT.