Git Product home page Git Product logo

lana-cli's Introduction

Lana! NPM scripts with better UX ๐Ÿ“

logo

What?

Lana! provides a convenient, global API to browse and run NPM scripts in your projects. Also, it makes managing your documentation easier by pulling out descriptions from your projects' README.md file.

terminal

Why?

Do you happen to switch between your projects often and rely on reading package.json to look up the dev tasks? Well, I do. So give it a try. Your OCD will thank you.

Why not?

There are many ways of tackling this issue, usually script names should be descriptive enough or one might say package.json is not the right place for that at all.

Normally, I'd agree with that, but it suits my workflow and might help you as well.

Setup

Supported Node.js version: 6.x.x and higher

Yarn

$ yarn global add lana-cli

NPM

$ npm i -g lana-cli

Usage

In a Javascript project with package.json, type:

$ lana

You can share documentation between lana! and README.md by tagging content, like in this imaginary CMS (Cat Management System).

Usage (documentation)

Add <!--lana: NPM_TASK_NAME--> at the end of a header or paragraph describing the task, and Lana will pick it up.

#### Start a debug server <!--lana: start-->
    $ npm start

#### Upload kittens <!--lana: upload-kittens-->
    $ npm run upload-kittens

#### Download database for integration tests <!--lana: integration-db-download-->
    $ ./build/prepare_db.sh && npm run integration-db-download

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.