https://github.com/zhengxs2018/shared-node-browser-library-boilerplate

Using rollup.js to build, a re-usable NPM module for run in nodejs and browser.
https://github.com/zhengxs2018/shared-node-browser-library-boilerplate

boilerplate esnext node-module npm perttier template typescript

Last synced: about 2 months ago
JSON representation

Using rollup.js to build, a re-usable NPM module for run in nodejs and browser.

• Host: GitHub
• URL: https://github.com/zhengxs2018/shared-node-browser-library-boilerplate
• Owner: zhengxs2018
• License: mit
• Created: 2019-05-02T15:15:50.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-07T07:54:48.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T15:46:22.052Z (almost 2 years ago)
• Topics: boilerplate, esnext, node-module, npm, perttier, template, typescript
• Language: JavaScript
• Homepage: https://zhengxs2018.github.io/shared-node-browser-library-boilerplate/
• Size: 950 KB
• Stars: 4
• Watchers: 0
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @zhengxs/npm-module-boilerplate

[![lang](https://img.shields.io/badge/lang-typescript-informational)](https://www.typescriptlang.org/)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![codecov](https://codecov.io/gh/zhengxs2018/shared-node-browser-library-boilerplate/branch/main/graph/badge.svg?token=1WYDMOFYX8)](https://codecov.io/gh/zhengxs2018/shared-node-browser-library-boilerplate)

![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)

Using rollup.js to build, a re-usable NPM module for run in nodejs and browser.

查看[中文文档](./README.zh-CN.md)

## 关联文章

- [开发一个适用于 nodejs 与浏览器的 npm 包 - 基于 rollupjs](https://juejin.im/post/6844903834402160647)

## 其他分支

- `branch:esm` - 最初的 rollup + babel + es6 模板

## Features

- Use next javascript development.

- Run in nodejs and browser.

- Built-in bundle analyzer report, document generation, lint, unit testing && code coverage

## Development Setup

You will need [Node.js][nodejs] version 10+.

After cloning the repo, run:

```bash

# Installation dependency

$ npm install

# build for production with minification

$ npm run build

# build for production and generate the bundle analyzer report

$ npm run analyse

# Generate document.

$ npm run ts-doc

```

There are some other scripts available in the scripts section of the package.json file.

## Version Release

```bash

# Bump package version, include linting

$ npm version 

# Publish package, include build

$ npm publish

```

See [npm](https://docs.npmjs.com/) for more help.

## ChangeLog

See [CHANGELOG.md](./CHANGELOG.md)

## Contributing

See [CONTRIBUTING.md](./.github/CONTRIBUTING.md)

[rollupjs]: https://rollupjs.org