46 lines
2.6 KiB
Markdown
46 lines
2.6 KiB
Markdown
# projectinfo
|
|
|
|
gather information about projects. supports npm, git etc.
|
|
|
|
## Availabililty
|
|
|
|
[](https://www.npmjs.com/package/projectinfo)
|
|
[](https://GitLab.com/pushrocks/projectinfo)
|
|
[](https://github.com/pushrocks/projectinfo)
|
|
[](https://pushrocks.gitlab.io/projectinfo/)
|
|
|
|
## Status for master
|
|
|
|
[](https://GitLab.com/pushrocks/projectinfo/commits/master)
|
|
[](https://GitLab.com/pushrocks/projectinfo/commits/master)
|
|
[](https://www.npmjs.com/package/projectinfo)
|
|
[](https://david-dm.org/pushrocks/projectinfo)
|
|
[](https://www.bithound.io/github/pushrocks/projectinfo/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/projectinfo)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
```javascript
|
|
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](https://lossless.gmbh)
|
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://push.rocks)
|