Code Monkey home page Code Monkey logo

npm-library-boilerplate's Introduction

npm-library-boilerplate

JavaScript Style Guide

npm-library-boilerplate is a boilerplate for NPM libraries.

  • Handy scripts: easily support multiple data sources in your infinity scroll.
  • Commitizen powered releases: automatic CHANGELOG and semver generation.
  • Babel, prettier, jest, eslint: built in tools to save you setting up time again and again.

I use this for my personal projects, so thought I'd share.

Using this boilerplate

Whilst I'd like to develop a generator for this, the best way to get started is to fork or clone this repo.

What's included?

  • Babel
  • Prettier
  • Jest
  • Commitizen
  • Linting:
    • JS via ESLint
    • JSON via ESLint
    • Markdown via Remark
    • Prettier via ESLint
  • Useful scripts

Scripts

  • compile - compile package to dist
  • format - run prettier on codebase
  • lint _ lint entire codebase
  • lint:js - lint all JS files
  • lint:json - lint all JSON files
  • lint:md - lint all MD files
  • lint:format - lint all files with prettier
  • test - run tests with jest
  • release - automatically create a release, and update CHANGELOG.md, using conventional commits in the Angular format
  • version - print out the next version based on conventional commits in the Angular format

License

MIT © Chris Villa

npm-library-boilerplate's People

Contributors

chrisvxd avatar

Stargazers

Colton Colcleasure avatar Michał Ordon avatar Paul Love avatar

Watchers

 avatar  avatar

Forkers

anglepoised

npm-library-boilerplate'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.