Skip to content

Latest commit

 

History

History
146 lines (109 loc) · 5.23 KB

.verb.md

File metadata and controls

146 lines (109 loc) · 5.23 KB

{%= name %} {%= badge('npm') %} {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

{%= description %}

[![code climate][codeclimate-img]][codeclimate-url] standard code style [![linux build status][travis-img]][travis-url] [![windows build status][appveyor-img]][appveyor-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]

{%= include('highlight') %}

Table of Contents

Install

Install with npm

$ npm install {%= name %} --save-dev

or install using yarn

$ yarn add --dev {%= name %}

Usage

For more use-cases see the tests

import start from 'start'
import reporter from 'start-pretty-reporter'
import rollup = from '{%= name %}'
import files from 'start-files'
import clean from 'start-clean'
import write from 'start-write'
import buble from 'rollup-plugin-buble'

export const build = () => start(reporter())(
  files('build/'),
  clean(),
  rollup({
    entry: './main.js',
    targets: [
      { dest: 'build/index.es6.js', format: 'es' },
      { dest: 'build/index.js', format: 'cjs' }
    ],
    sourceMap: 'inline',
    plugins: [buble()]
    // or
    // plugins: ['buble']
    // or
    // plugins: [
    //   'commonjs'
    //   ['node-resolve', { jsnext: true }]
    //   ['buble', { target: { node: '4' } }]
    //   
    //   // or pass plugin function
    //   // [buble, { target: { node: '4' } }]
    // ]
  })
)

This task uses Rollup but through [rolldown][] API, which gives some advantages to the original Rollup API. So checkout both docs or at least see rollup wiki page.

Rolldown gives you:

  • better plugins resolving (seems like browserify resolves its transforms from package.json)
  • more configuration options - such as options.source, options.ongenerate and options.onwrite
  • loading configs from package.json from your process.cwd()
  • and even you can create presets of plugins and configs (shareable configs/presets)

{% if (verb.related && verb.related.list && verb.related.list.length) { %}

Related

{%= related(verb.related.list, {words: 20}) %} {% } %}

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

  1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
  2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
  3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
  4. Do NOT bump the version in package.json. For that we use npm run release, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

{%= includeEither('authors', 'author') %}

License

{%= copyright({ start: 2016, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= license %}


{%= include('footer') %}
Project scaffolded using [charlike][] cli.

{%= reflinks(verb.reflinks) %}

[downloads-url]: https://www.npmjs.com/package/{%= name %} [downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %} [codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg

[travis-url]: https://travis-ci.org/{%= repository %} [travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %} [appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows

[coveralls-url]: https://coveralls.io/r/{%= repository %} [coveralls-img]: https://img.shields.io/coveralls/{%= repository %}.svg

[david-url]: https://david-dm.org/{%= repository %} [david-img]: https://img.shields.io/david/{%= repository %}.svg