thesavior/clean-git-ref

Clean an input string into a usable git ref

clean-git-ref

Clean an input string into a usable git ref.

For more reference, read https://git-scm.com/docs/git-check-ref-format

Installation

$ npm install clean-git-ref --save-dev

API Usage

clean(string input) -> string output

var cleanGitRef = require('clean-git-ref');

assert.strictEqual(cleanGitRef.clean('bad git ref formats/'), 'bad-git-ref-formats');

clean-git-ref's Issues

Add TypeScript types

I've opened a PR in DefinitelyTypes (DefinitelyTyped/DefinitelyTyped#41854) to add TypeScript types for clean-git-ref, but it would be much better if clean-git-ref shipped with those types itself. Would you be willing to take the index.d.ts file, package it, and cut a new patch release of clean-git-ref using the types I wrote?

Open bracket [ should be disallowed.

(Note: the exception to the rule is a single * is allowed in refspecs. No exceptions for [.)

] apparently is fine, but git won't let you create a branch with [

Typo in README

assert.stricEqual --> assert.strictEqual

Can we make this so we can use it in the command line?

This would be great if it could be used in the command line and copy the result to clipboard.

I'll clone the repo and see if I can do it myself, but let me know if this would be useful for others?

Request: Add a LICENSE file

The clean-git-ref does not have a license file like LICENSE.txt, but package.json says Apache-2.0.

Is it possible to have a license file added to indicate that this package is Apache-2.0 licensed?

only replaces first instance of invalid character

The example given in the README fails...

var cleanGitRef = require('clean-git-ref');
assert.stricEqual(cleanGitRef.clean('bad git ref formats/'), 'bad-git-ref-formats');

it turns 'bad git ref formats/' into 'bad-git ref formats'.