Giter VIP home page Giter VIP logo

rx's Introduction

NPM Package Template

You wrote a sweet piece of code! Releasing it on NPM seems like the obvious next step. Right?

Try it! Not as easy to do as you might think. At high quality. From scratch.

So here's a plug-and-play NPM package template that offers the following features:

  • Tree-shakable support for the latest ES6 goodies with eslint uber alles.

  • CJS distributions targeting specific browser support scenarios.

  • Command line interfaces for your widget with commander.

  • Automated lodash cherry-picking with babel-plugin-lodash.

  • mocha & chai for testing, with examples, and a sweet testing console.

  • In-code access to package.json data, with no warnings to ignore.

  • Code formatting at every save & paste with prettier.

  • Automated documentation of your API with jsdoc-to-markdown and assembly of your README with concat-md.

  • One-button release to GitHub & publish to NPM with release-it.

Click here for full documentation & instructions!

If you want to create a React component in an NPM package, use my React Component NPM Package Template instead!

Command Line Interface

Usage: mycli [options]

Foos your bar.

Options:
  -b, --bar <string>  foo what?
  -h, --help          display help for command

API Documentation

import { foo, PACKAGE_INFO } from '@karmaniverous/npm-package-template`;

foo(value) โ‡’ any

Returns whatever value is passed.

Kind: global function
Returns: any - Whatever value it was passed.

Param Type Description
value any Any value.

See more great templates and other tools on my GitHub Profile!

rx's People

Contributors

dhowe avatar

Watchers

 avatar  avatar

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.