Fork us on GitHub

Introduction

Build Status npm Version License npm Version Module formats

CI build job

Installation

npm install @rollup-umd/build --save

Getting started

CLI commands

Add help to any @rollup-umd/build command to get help:

$ npx @rollup-umd/build

Run build job

Commands:
  @rollup-umd/build build  Run build job                                                            [default]

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]
  --yarn     Use yarn for install                                         [boolean] [default: false]

Copyright 2019. Yeutech Company Limited.

build

Run build job

aliases: build

$ npx @rollup-umd/build build

Run build job

Options:
  --version  Show version number                                                           [boolean]
  --help     Show help                                                                     [boolean]
  --yarn     Use yarn for install                                         [boolean] [default: false]

Configuration

@rollup-umd/build contain the job build stage for all rollup-umd project.

You can run the build stage by doing:

npx @rollup-umd/build

It should be installed as a devDependencies so we can follow the version used by the rollup-umd project.

It is also automatically removed if the package goes public.

To use it, just use the script within your .travis.yml:

jobs:
  include:

    # Job: Build
    - stage: build
      node_js:
        - 'lts/*'
        - '10'
        - '8'
      script:
        - npx @rollup-umd/build

JSdoc

This part is generated from the JSdoc annotations in the source code.

FAQ

It is the boilerplate for all JS project aimed to be packaged. It is made on top of rollup because the distribution can work everywhere. If you are a contributor, we strongly suggest you to read rollup-umd documentation.

Contribute

We highly encourage contribution, any feature request and merge request will be reviewed.

Commands

Build project:

$ npm run build

Run unit test:

$ npm test

Watch unit test:

$ npm run test:watch

Build the /lib directory:

$ npm run build:lib

Build the /dist directory:

$ npm run build:dist

Build the /dist directory "uncompressed":

$ npm run build:dist:dev

Watch the /dist directory:

$ npm run build:dist:watch

Watch the /lib directory:

$ npm run build:lib:watch

Start a documentation server and watch the /docs directory:

$ npm run styleguide

Build documentation in /public directory:

$ npm run styleguide:build

Build the JSdoc documentation

$ npm run jsdoc

Release

Merge dev into master will release the documentation and tag a new version.

Changelog

Code of conduct

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

Examples of unacceptable behavior by participants include:

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at contact@yeutech.vn. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at here