is-git-clean

Find out if a git directory is clean or not

is-git-clean

Find out if a git directory is clean or not

Install

$ npm install --save is-git-clean

Usage

const isGitClean = require('is-git-clean');

isGitClean().then(clean => console.log(clean));
//=> true || false

// alternate directory
isGitClean('/some/path')

// options
// `ignore.txt` is ignored and not counted as dirty
isGitClean('/some/path', {files: ['!ignore.txt']})

// sync version
isGitClean.sync()

API

isGitClean([dir], [options])

Returns a promise for a boolean value. true if the directory is clean, false if it is not.

dir

Type: string
Default: process.cwd()

Path to the directory you want to check.

options

Type: object

files

Type: array

An array of multimatch patterns to ignore certain files.

isGitClean.sync([dir], [options])

Synchronous version, with the same API as above. Returns a boolean directly, instead of a Promise.

License

MIT © James Talmage

Repository

jamestalmage/is-git-clean


上一篇:babel-plugin-transform-react-es6-displayname
下一篇:jest-codemods

相关推荐

  • 鲍尔注册本地的Git包

    鲍尔注册本地的Git包 ...

    3 年前
  • 高效阅读Github源代码

    三种办法。如果你主要看前端项目的代码,直接看第三种。 1,用Chrome插件Octotree,左侧会出现树形结构,方便你浏览源代码。 地址: https://chrome.google.com/we...

    3 年前
  • 链接和执行外部JavaScript文件托管在GitHub上

    AuthorProxy提出了一个问题:Link and execute external JavaScript file hosted on GitHub,或许与您遇到的问题类似。

    3 年前
  • 邮件驱动 Git 工作流的优势

    git 2.18.0 has been released, and with it my first contribution to git has shipped! My patch was for...

    2 年前
  • 那些年前端接触的Git知识大全

    1、Git诞生的历史 Git的定义 Git是当下最先进的开源分布式版本控制系统,可以高效便捷地管理大大小小的项目版本 所谓的分布式,按我的理解就是主要专注于分字,分开,分离,把某些事物分开布置在...

    5 个月前
  • 通过github actions实现:vuepress博客自动构建,github仓库自动同步到gitee,giteepage自动部署

    说明 将vuepress博客的本地构建过程转移到github-actions中,同时支持将构建结果自动部署到gitee上,且可以自动更新gitee pages。 使用此action后你将不再需要关心博...

    3 天前
  • 通过 41 个 问答方式快速了解学习 Git

    为了保证的可读性,本文采用意译而非直译。 1. 你最喜欢的 Git 命令是什么 个人比较喜欢 git add -p. 这增加了“补丁模式”的变化,这是一个内置的命令行程序。

    1 年前
  • 谈谈git分支管理的本质

    前言 想了想工作两年中自己做的事情,发现这方面还算不错,所以拎出来说说自己对 git 的一些理解。 粗略浏览了一下网上存在的 Git 相关的中文文章,大多数是介绍 Git 的一些命令怎么使用,或者是介...

    5 个月前
  • 详解 Github App 的玩法

    之前在使用 Github issues 搭建博客平台的时候,研究过一番如何取得 Github 授权并调用 API 的办法。后来选择了较简单的账号密码和 Token 的方法。

    1 年前
  • 记一次github.io打不开的解决经历

    记一次github.io打不开的解决经历 记得之前有 github.com 打不开或者打开很慢的解决方案,现在轮到了 github.io,哈哈。我的 github.io 很久开始就打不开了,当时从网上...

    9 天前

官方社区

扫码加入 JavaScript 社区