Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
@currents/commit-info
Advanced tools
Collects Git commit info from git CLI
Requires Node version 6 or above.
npm install --save @currents-dev/commit-info
const {commitInfo} = require('@currents-dev/commit-info')
// default folder is current working directory
commitInfo(folder)
.then(info => {
// info object will have properties
// branch
// message
// email
// author
// sha
// timestamp (in seconds since epoch)
// remote
})
Notes:
.git
folder and uses Git commands to get each property, like git show -s --pretty=%B
, see src/git-api.js. Note: there is fallback to environment variables.null
for each propertyDEBUG=commit-info
environment variable.If getting the commit information using git
fails for some reason, you can provide the commit information by setting the environment variables. This module will look at the following environment variables as a fallback
branch: COMMIT_INFO_BRANCH
message: COMMIT_INFO_MESSAGE
email: COMMIT_INFO_EMAIL
author: COMMIT_INFO_AUTHOR
sha: COMMIT_INFO_SHA
timestamp: COMMIT_INFO_TIMESTAMP
remote: COMMIT_INFO_REMOTE
When running your application inside a Docker container, you should set these environment variables using -e
syntax.
$ docker run \
-e COMMIT_INFO_BRANCH=develop \
-e COMMIT_INFO_SHA=e5d9eb66474bc0b681da9240aa5a457fe17bc8f3 \
<container name>
See docker-example for a full example.
In addition to commitInfo
this module also exposes individual promise-returning
methods getBranch
, getMessage
, getEmail
, getAuthor
, getSha
, getTimestamp
, getRemoteOrigin
. These methods do NOT use fallback environment variables.
For example
const {getAuthor} = require('@currents/commit-info')
getAuthor('path/to/repo')
.then(name => ...)
Resolves with the current git branch name or null
.
const {getBranch} = require('@currents/commit-info')
getBranch()
.then(branch => ...)
HEAD
), returns null
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet / open issue on Github
Copyright (c) 2017 Cypress.io
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Collects Git commit info from CI or from CLI
The npm package @currents/commit-info receives a total of 92,272 weekly downloads. As such, @currents/commit-info popularity was classified as popular.
We found that @currents/commit-info demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.