https://github.com/idelsink/vue-cli-plugin-git-describe

Vue CLI git-describe plugin
https://github.com/idelsink/vue-cli-plugin-git-describe

describe git git-describe semver version vue vue-cli vue-cli-plugin

Last synced: 23 days ago
JSON representation

Vue CLI git-describe plugin

• Host: GitHub
• URL: https://github.com/idelsink/vue-cli-plugin-git-describe
• Owner: idelsink
• License: mit
• Created: 2019-05-02T22:13:16.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T05:11:52.000Z (over 2 years ago)
• Last Synced: 2025-03-31T12:19:31.170Z (2 months ago)
• Topics: describe, git, git-describe, semver, version, vue, vue-cli, vue-cli-plugin
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/vue-cli-plugin-git-describe
• Size: 3.53 MB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Vue CLI plugin git-describe

[![npm version](https://img.shields.io/npm/v/vue-cli-plugin-git-describe.svg)](https://www.npmjs.com/package/vue-cli-plugin-git-describe)

[![npm license](https://img.shields.io/npm/l/vue-cli-plugin-git-describe.svg)](https://www.npmjs.com/package/vue-cli-plugin-git-describe)

[![Build Status](https://travis-ci.org/idelsink/vue-cli-plugin-git-describe.svg?branch=master)](https://travis-ci.org/idelsink/vue-cli-plugin-git-describe)

This [Vue CLI](https://cli.vuejs.org/) plugin calls

[git-describe](https://www.npmjs.com/package/git-describe) with the provided arguments on the working directory or any other directory and

parses the output to individual components. On compilation time the

git-describe information will be injected so that it can be used in, for example,

browser served applications which have no access to the local file system.

## Installation

Available from npm:

```shell

$ vue add git-describe

```

This will ask a few questions and will install the plugin.

Tests are not included in the npm package —

clone the git repository to run tests.

## Usage

git-describe uses the node [git-describe](https://www.npmjs.com/package/git-describe) module.

During compilation, the variable `variableName`, default `GIT_DESCRIBE`, is replaced with the

[git-describe](https://www.npmjs.com/package/git-describe#example-output) object.

### Example

1. Create an example app (Skip this step if you want to use your own application)

   ```shell

   $ vue create test-app && cd test-app

   ```

   ![Example](assets/example_create_app.png)

2. Install the git-describe plugin

   ```shell

   $ vue add git-describe

   ```

   ![Example](assets/example_install.png)

3. Add the configured constant, default `GIT_DESCRIBE`, to your code.

  ```JavaScript

  console.log('App version', GIT_DESCRIBE.raw);

  ```

  Outputs:

  ```text

  App version c6bd20d-dirty

  ```

## Options

`git-describe` has the following options available in the `vue.config.js` file:

```JavaScript

module.exports = {

  pluginOptions: {

    gitDescribe: {

      variableName: 'GIT_DESCRIBE'  // The compile-time global constant varialbe name to use in the code.

    }

  }

}

```

## Example output

```javascript

{

    dirty: false,

    hash: 'g3c9c15b',

    distance: 6,

    tag: 'v2.1.0-beta',

    semver: SemVer, // SemVer instance, see https://github.com/npm/node-semver

    suffix: '6-g3c9c15b',

    raw: 'v2.1.0-beta-6-g3c9c15b',

    semverString: '2.1.0-beta+6.g3c9c15b'

}

```

## More information

See [git-describe](https://www.npmjs.com/package/git-describe) for more information about the usage of the git-describe package and the reason to include the optional [semver](https://github.com/npm/node-semver) package.

## Tests

Tests can be run by cloning the repository and running the following command.

```sh

$ npm install

$ npm test

```