Code Monkey home page Code Monkey logo

babel-npm-module-example's Introduction

babel-npm-module-example Build Status

A boilerplate to start writing your NPM modules in ES6 using Babel.

Install

$ npm install babel-npm-module-example --save

How to use

Open sourcecode, take a look and start coding... https://github.com/anvk/babel-npm-module-example

GULP or NPM commands?

Currently you can build this project either by running a gulp command or npm build command.

NPM commands

If you want to build a basic JS module and do not require to run any extra advanced tasks during build you can use npm-commands branch. Or you can remove gulpfile.babel.js file and remove the following npm modules from the project:

  • babel-core
  • gulp
  • gulp-babel
  • gulp-eslint
  • gulp-mocha
  • gulp-rimraf
  • run-sequence

Using NPM commands

$ npm run build
$ npm test

GULP

For those who needs to run extra scripts and do other complicated tasks upon builds you can use gulp-commands branch. Or clean scripts object in package.json as well as remove the following npm modules from the project:

  • rimraf
  • babel-cli

Using GULP command

$ node_modules/gulp/bin/gulp.js

Linting?

I'm using eslint-config-airbnb for this project with my few custom modifications. You can read more on the Airbnb JavaScript Style Guide here

Important!

I commented out dist/ and test-dist folders in my ignore file on purpose to demonstrate how built files will look like. In a real project, most likely, you do not want to push those dist folders to your repo. If you do, you will constantly see changes in dist folders during your merges/code reviews which can be very annoying.

License

MIT license; see LICENSE.

(c) 2016 by Alexey Novak

babel-npm-module-example's People

Contributors

anvk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

babel-npm-module-example's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.