Code Monkey home page Code Monkey logo

npm-cli's Introduction

NPM CLI Starter

This repo is meant to be a starting point for building NPM ClI packages. It comes with the three essential components of building an publishable NPM CLI.

  1. Starter bin command set up
  2. Executable node script
  3. Build scripts and development workflow.

Example Code

The starter code is an example of the common command npm init and npm init -y. This code provides a base example of the three common tasks of command line tools

  1. Getting command line arguments
  2. Getting user input
  3. Writing to files

Running The Example Code

Install packages npm i. At this point you can simply run the example with npm start. In order to run the example with the -y argument, run npm run bin:up. This will run the build script that will convert the typescript code to javascript and then run npm link to link the cmd command to your bin. When you've made changes to the code, be sure to run npm run bin to rebuild build the code. To unlink the cmd command from your bin, run npm run bin:down.

npm-cli's People

Contributors

lvstross avatar

Stargazers

Roman avatar

Watchers

James Cloos 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.