Gathering detailed insights and metrics for grunt-git-describe
Gathering detailed insights and metrics for grunt-git-describe
Installations
npm install grunt-git-describeDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
8.5.0
NPM Version
5.7.1
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
mikaelkaron
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
41 Stars
76 Commits
24 Forks
1 Watchers
1 Branches
6 Contributors
Updated on Mar 13, 2024
Maintainers
1
Package Meta Information
Latest Version
2.4.4
Package Id
grunt-git-describe@2.4.4
Unpacked Size
11.24 kB
Size
4.12 kB
File Count
8
NPM Version
5.7.1
Node Version
8.5.0
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
3
grunt-git-describe
Describes git commit
Getting Started
This plugin requires Grunt ~0.4.0
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
1npm install grunt-git-describe --save-dev
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
1grunt.loadNpmTasks('grunt-git-describe');The "git-describe" task
Overview
In your project's Gruntfile, add a section named git-describe to the data object passed into grunt.initConfig().
1grunt.initConfig({
2 "git-describe": {
3 "options": {
4 // Task-specific options go here.
5 },
6 "your_target": {
7 // Target-specific file lists and/or options go here.
8 },
9 },
10})Note that since this is a multi-task you have to have at least one target defined for
git-describe(otherwise the task won't run)
Options
options.cwd
Type: String
Default value: '.'
A string value that is used to do set the current working directory when spawning the git command
options.commitish
Type: String
Default value: undefined
A string value that is used as commitish for git. Default is to use HEAD.
options.template
Type: String
Default value: {%=tag%}-{%=since%}-{%=object%}{%=dirty%}
A string value used to format the result of this task
options.match
Type: String
Default value: undefined
Value for the --match command line option. If set, only consider tags matching this glob pattern, excluding the "refs/tags/" prefix.
options.failOnError
Type: boolean
Default value: true
A boolean that allows Grunt to keep going if there's an error in this task. This is useful if your build isn't guaranteed to always be run from within a Git repo.
Saving Output
If you would like to save or otherwise use the retun value, use grunt.event.emit. Here is an example:
1grunt.registerTask('saveRevision', function() { 2 grunt.event.once('git-describe', function (rev) { 3 grunt.log.writeln("Git Revision: " + rev); 4 grunt.option('gitRevision', rev); 5 }); 6 grunt.task.run('git-describe'); 7});
Returned Object
The rev object returned makes several specific properties available, in addition to the full toString description.
1grunt.event.once('git-describe', function (rev) { 2 grunt.log.writeln("Git rev tag: " + rev.tag); 3 grunt.log.writeln("Git rev since: " + rev.since); 4 grunt.log.writeln("Git rev object: " + rev.object); // The 6 character commit SHA by itself 5 grunt.log.writeln("Git rev dirty: " + rev.dirty); // A flag denoting whether all local changes are committed 6});
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
Found 4/26 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 8 are checked with a SAST tool
Reason
43 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-957j-59c2-j692
- Warn: Project is vulnerable to: GHSA-m5pj-vjjf-4m3h
- Warn: Project is vulnerable to: GHSA-j383-35pm-c5h4
- Warn: Project is vulnerable to: GHSA-rm36-94g8-835r
- Warn: Project is vulnerable to: GHSA-4hq8-jgr8-mw9j
- Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-7xcx-6wjh-7xp2
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-v2p6-4mp7-3r9v
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.4
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More