@gitgraph/core

中文文档
1.5.0发布于 2021/03/07MITTypeScriptESM + CJS零依赖近 30 天下载 2.9万

Core of gitgraph, a JavaScript library to draw pretty git graphs

原始使用文档
文档目录4 节
  1. Why this package?
  2. Developing a rendering library
  3. Examples of usage
  4. How does it work?

@gitgraph/core

version Changelog

This is the core package of GitGraph.js. It contains the main logic for manipulating git-like API and compute the graph that should be rendered.

If you want to use GitGraph.js, you're probably looking for one of the rendering library. They are all listed at the root level of the monorepo.

If you are a contributor to a rendering library, you'll depend on this package. Read on 🤠

Why this package?

We wanted to deliver GitGraph.js through different libraries, to fit different usages (e.g. React, Angular, Vanilla JS, Node.js…).

The idea was to extract the common logic, without the rendering part.

All the GitGraph.js API is defined there: commit, branch, merge, etc. It embraces git semantics.

Developing a rendering library

A rendering library is a wrapper around @gitgraph/core.

It should:

  • expose the GitGraph.js API to the user
  • subscribe to graph updates to re-render it

How it renders the graph is up to you (e.g. canvas, svg, HTML elements…).

Examples of usage

A vanilla JS implementation:

import { GitgraphCore } from "@gitgraph/core";

export function createGitgraph(options) {
  const $target = options.$target || document.getElementId("#gitgraph");

  const graphOptions = {
    // Build relevant GitgraphCore options.
  };

  // Instantiate the graph.
  const gitgraph = new GitgraphCore(graphOptions);

  // Subscribe to graph updates.
  const gitgraph.subscribe((data) => {
    render($target, data);
  });

  // Return the GitGraph.js API to the user.
  return gitgraph.getUserApi();
}

function render($target, data) {
  // Do the rendering…
  $target.appendChild(renderGraph(data));
}

A React implementation:

import React from "react";
import { GitgraphCore } from "@gitgraph/core";

export class Gitgraph extends React.Component {
  constructor(props) {
    super(props);

    this.state = {
      // Init state.
    };

    // Instantiate the graph.
    this.gitgraph = new GitgraphCore(props.options);

    // Subscribe to graph updates.
    this.gitgraph.subscribe((data) => {
      this.setState(data);
    });
  }

  render() {
    // Do the rendering…
    return <svg>{this.renderGraph()}</svg>;
  }

  componentDidMount() {
    // Pass the GitGraph.js API to the user.
    this.props.children(this.gitgraph.getUserApi());
  }
}

How does it work?

The end-user will be using the rendering library. As we return gitgraph.getUserApi(), the user will be able to perform git-like actions (create a branch, commit, merge…).

Every action updates the internal graph. The core library computes the new graph that should be rendered to represent the new state. When it does, it will call its listeners through the subscribe() method.

版本与发布记录

@gitgraph/core 共发布 19 个版本,首次发布于 2019/02/10;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.5.0latest2021/03/075 年前
1.4.52020/04/056 年前
1.4.42020/03/226 年前
1.4.32019/11/196 年前
1.4.22019/07/297 年前
1.4.12019/07/217 年前

关于 @gitgraph/core 的常见问题

@gitgraph/core 是什么?

Core of gitgraph, a JavaScript library to draw pretty git graphs

如何安装 @gitgraph/core?

在项目目录运行 npm install @gitgraph/core,或使用 pnpm add / yarn add / bun add。

@gitgraph/core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gitgraph/core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gitgraph/core 可以商用吗?

@gitgraph/core 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gitgraph/core 的下载量有多少?

根据 npm 官方下载统计,@gitgraph/core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 29,336 次,日均约 978 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gitgraph/core 还在维护吗?

最新版本 1.5.0 发布于 2021/03/07(5 年前);至今共发布 19 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/02/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。