0.1.0 • Published 2 years ago

nodejs-git-tag v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

NodeJS Git Tag

Три функции возвращающих последний Git tag:

// Аннотированный - git describe
describe(
  workDir?: null | string,
  args? : null | string[]
): Promise<Tag>
describeSync(...): Tag

// Любой - git describe --tags
describeTags(...): Promise<Tag>
describeTagsSync(...): Tag

// После фиксации - git describe --contains
describeContains(...): Promise<Tag>
describeContainsSync(...): Tag

// Любая из функций возвратит объект:
type Tag = { 
  value: null|string, // Тег, если нет ошибки.
  error: null|string  // Строка ошибки.
}

// Примеры:
{ value: 'v0.2.0-2-g9d351b5', error: null }
{ value: 'v0.3.2^0', error: null }
{ value: null, error: "fatal: cannot describe 'cbd05bcbe40398b55250ed574544281f44ca0d58'" }

Параметры:

  • workDir - Рабочий каталог. Передается в параметры spawn( x, y, {cwd: workDir}). По умолчанию process.cwd(), иначе вычисляется абсолютный путь.
  • args - Массив дополнительных флагов, будет добавлен в конец ['describe', ...args].

Установка

NPM

npm i -D nodejs-git-tag

GitHub

git clone https://github.com/AlexLonberg/nodejs-git-tag.git custom_dir_name
cd custom_dir_name
npm i
npm run build
// example.js
npm run git:describe