Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pardjs/_module-boilerplate
🍀The default module boilerplate for pardjs modules.
https://github.com/pardjs/_module-boilerplate
Last synced: 27 days ago
JSON representation
🍀The default module boilerplate for pardjs modules.
- Host: GitHub
- URL: https://github.com/pardjs/_module-boilerplate
- Owner: pardjs
- License: mit
- Created: 2019-04-03T11:22:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T19:01:43.000Z (about 2 years ago)
- Last Synced: 2023-03-02T15:02:55.918Z (almost 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 2.58 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# \_module-boilerplate
[](https://github.com/prettier/prettier)
[](https://greenkeeper.io/)
[](https://travis-ci.org/pardjs/_module-boilerplate)
[](https://coveralls.io/github/pardjs/_module-boilerplate?branch=master)
> Bages need to replace with your own
The default module boilerplate for pardjs modules.
## Usage
1. Clone the repo `https://github.com/pardjs/_module-boilerplate.git`
2. Copy the files from the folder to the module fodler
3. Replace all the `ModuleName` and `_module_name` in the boilerplate with your own meaningful names.
4. Update the `package.json` file with your own info [`description`, `main`, `module`, `typings`, `author`, `repository.url`].
5. the `libraryName` in `rollup.config.ts`
6. update the bages anc content in `README.md`.
7. start coding the module.
### Features
- Zero-setup. After running `npm install` things will setup for you :wink:
- **[RollupJS](https://rollupjs.org/)** for multiple optimized bundles following the [standard convention](http://2ality.com/2017/04/setting-up-multi-platform-packages.html) and [Tree-shaking](https://alexjoverm.github.io/2017/03/06/Tree-shaking-with-Webpack-2-TypeScript-and-Babel/)
- Tests, coverage and interactive watch mode using **[Jest](http://facebook.github.io/jest/)**
- **[Prettier](https://github.com/prettier/prettier)** and **[TSLint](https://palantir.github.io/tslint/)** for code formatting and consistency
- **Docs automatic generation and deployment** to `gh-pages`, using **[TypeDoc](http://typedoc.org/)**
- Automatic types `(*.d.ts)` file generation
- **[Travis](https://travis-ci.org)** integration and **[Coveralls](https://coveralls.io/)** report
- (Optional) **Automatic releases and changelog**, using [Semantic release](https://github.com/semantic-release/semantic-release), [Commitizen](https://github.com/commitizen/cz-cli), [Conventional changelog](https://github.com/conventional-changelog/conventional-changelog) and [Husky](https://github.com/typicode/husky) (for the git hooks)
### Importing library
You can import the generated bundle to use the whole library generated by this starter:
```javascript
import myLib from 'mylib';
```
Additionally, you can import the transpiled modules from `dist/lib` in case you have a modular library:
```javascript
import something from 'mylib/dist/lib/something';
```
### NPM scripts
- `npm t`: Run test suite
- `npm start`: Run `npm run build` in watch mode
- `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `npm run test:prod`: Run linting and generate coverage
- `npm run build`: Generate bundles and typings, create docs
- `npm run lint`: Lints code
- `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)
### Excluding peerDependencies
On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in [Rollup docs](https://rollupjs.org/#peer-dependencies) how to do that.
Good news: the setup is here for you, you must only include the dependency name in `external` property within `rollup.config.js`. For example, if you want to exclude `lodash`, just write there `external: ['lodash']`.
### Automatic releases
_**Prerequisites**: you need to create/login accounts and add your project to:_
- [npm](https://www.npmjs.com/)
- [Travis CI](https://travis-ci.org)
- [Coveralls](https://coveralls.io)
_**Prerequisite for Windows**: Semantic-release uses
**[node-gyp](https://github.com/nodejs/node-gyp)** so you will need to
install
[Microsoft's windows-build-tools](https://github.com/felixrieseberg/windows-build-tools)
using this command:_
```bash
npm install --global --production windows-build-tools
```
#### Setup steps
Follow the console instructions to install semantic release and run it (answer NO to "Do you want a `.travis.yml` file with semantic-release setup?").
_Note: make sure you've setup `repository.url` in your `package.json` file_
```bash
npm install -g semantic-release-cli
semantic-release-cli setup
# IMPORTANT!! Answer NO to "Do you want a `.travis.yml` file with semantic-release setup?" question. It is already prepared for you :P
```
From now on, you'll need to use `npm run commit`, which is a convenient way to create conventional commits.
Automatic releases are possible thanks to [semantic release](https://github.com/semantic-release/semantic-release), which publishes your code automatically on [github](https://github.com/) and [npm](https://www.npmjs.com/), plus generates automatically a changelog. This setup is highly influenced by [Kent C. Dodds course on egghead.io](https://egghead.io/courses/how-to-write-an-open-source-javascript-library)
### Git Hooks
There is already set a `precommit` hook for formatting your code with Prettier :nail_care:
By default, there are two disabled git hooks. They're set up when you run the `npm run semantic-release-prepare` script. They make sure:
- You follow a [conventional commit message](https://github.com/conventional-changelog/conventional-changelog)
- Your build is not going to fail in [Travis](https://travis-ci.org) (or your CI server), since it's runned locally before `git push`
This makes more sense in combination with [automatic releases](#automatic-releases)