push.rocks/projectinfo
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A tool for gathering project information, supporting npm, git, and more.
40 Commits 1 Branch 26 Tags 431 KiB
TypeScript 100%
9abe15f871
Go to file
Phil Kunz 9abe15f871 fix(dependencies): update
2018-09-02 14:08:15 +02:00
test fix(dependencies): update 2018-09-02 14:08:15 +02:00
ts fix(dependencies): update 2018-09-02 14:08:15 +02:00
.gitignore update smartfile 2016-10-27 19:43:54 +02:00
.gitlab-ci.yml update ci 2017-09-22 23:52:28 +02:00
LICENSE Initial commit 2016-02-20 03:45:25 +01:00
npmextra.json fix(dependencies): update 2018-09-02 14:08:15 +02:00
package-lock.json fix(dependencies): update 2018-09-02 14:08:15 +02:00
package.json fix(dependencies): update 2018-09-02 14:08:15 +02:00
README.md update deps and readme 2017-02-27 22:46:12 +01:00
tslint.json update to meet newest standards 2016-11-26 14:45:56 +01:00
yarn.lock update ci 2017-09-22 23:52:28 +02:00

README.md

projectinfo

gather information about projects. supports npm, git etc.

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import { ProjectInfo } from 'projectinfo'

let myProjectInfo = new ProjectInfo('/some/path/to/proejct')
let npmName = myProjectInfo.npm.name // returns npm name from package.json
let npmVersion = myProjectInfo.npm.version // returns version from package.json
let gitRepo = myProjectInfo.git.gitrepo // returns the name of the gitrepo
let gitRemotes = myProjectInfo.git.remotes // returns array with registered remotes

// for more info check out the module in your IDE with TypeScript intellisense enabled

For further information read the linked docs at the top of this README.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer