A tool for gathering project information, supporting npm, git, and more.

Go to file

Phil Kunz d013fbad50 4.0.2		2018-09-02 14:24:45 +02:00
test	fix(ci): update	2018-09-02 14:21:05 +02:00
ts	fix(ci): update	2018-09-02 14:21:05 +02:00
.gitignore	update smartfile	2016-10-27 19:43:54 +02:00
.gitlab-ci.yml	fix(ci): update	2018-09-02 14:21:05 +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	4.0.2	2018-09-02 14:24:45 +02:00
package.json	4.0.2	2018-09-02 14:24:45 +02:00
README.md	fix(ci): update	2018-09-02 14:21:05 +02:00
tslint.json	update to meet newest standards	2016-11-26 14:45:56 +01:00

README.md

projectinfo

gather information about projects. supports npm, git etc.

Availabililty

Status for master

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