@gitgraph/node

0.1.18 • Public • Published

This rendering library is still under development and is not stable.

@gitgraph/node

version Changelog

Draw pretty git graphs in your terminal.

This is the node.js rendering library of GitGraph.js.

Gitgraph node in action

Get started

You need to have npm installed.

Install the package with npm: npm i --save @gitgraph/node

Then, use it in your node.js scripts.

Example of usage

Let's pretend this is your index.js:

const { Gitgraph, render } = require("@gitgraph/node");

const gitgraph = new Gitgraph();

// Simulate git commands with Gitgraph API.
const master = gitgraph.branch("master");
master.commit("Set up the project");

const develop = master.branch("develop");
develop.commit("Add TypeScript");

const aFeature = develop.branch("a-feature");
aFeature
  .commit("Make it work")
  .commit("Make it right")
  .commit("Make it fast");

develop.merge(aFeature);
develop.commit("Prepare v1");

master.merge(develop).tag("v1.0.0");

// Call `render` to log the graph in terminal.
render(gitgraph);

Running node index.js will produce following output:

Example usage

/@gitgraph/node/

    Package Sidebar

    Install

    npm i @gitgraph/node

    Weekly Downloads

    10

    Version

    0.1.18

    License

    MIT

    Unpacked Size

    139 kB

    Total Files

    17

    Last publish

    Collaborators

    • nicoespeon
    • fabien0102
    • crutchcorn
    • andreasonny83