4.0.4

.gitignore

@@ -1,9 +1,20 @@
+.nogit/
+
+# artifacts
 coverage/
-docs/
+public/
+pages/
+
+# installs
 node_modules/
 
-pages/
+# caches
-public
+.yarn/
-ts/**/*.js
+.cache/
-ts/**/*.js.map
+.rpt2_cache
-ts/typings/
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,59 +1,127 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
+  - security
-- release
+  - test
-- trigger
+  - release
-- pages
+  - metadata
 
-testLEGACY:
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test legacy
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
-  allow_failure: true
+    - priv
 
-testLTS:
+testBuild:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
-  tags:
+    - npmci node install stable
-    - docker
+    - npmci npm install
-    
+    - npmci command npm run build
-testSTABLE:
+  coverage: /\d+.?\d+?\%\s*coverage/
-  stage: test
-  script:
-    - npmci test stable
   tags:
+    - lossless
     - docker
+    - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  stage: metadata
-  stage: pages
   script:
-    - npmci command npmpage --host gitlab
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
       - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,16 +0,0 @@
-# projectinfo
-returns a projectoinfo object for a directory path. TypeScript ready.
-
-## Status
-[![build status](https://gitlab.com/pushrocks/projectinfo/badges/master/build.svg)](https://gitlab.com/pushrocks/projectinfo/commits/master)
-[![Dependency Status](https://david-dm.org/pushrocks/projectinfo.svg)](https://david-dm.org/pushrocks/projectinfo)
-[![devDependency Status](https://david-dm.org/pushrocks/projectinfo/dev-status.svg)](https://david-dm.org/pushrocks/projectinfo#info=devDependencies)
-
-## Usage
-
-```TypeScript
-var projectinfo = require("projectinfo")
-
-myProject = new ProjectinfoNpm("/somepath/to/projectroot");
-myProject.version // displays version
-```

dist/index.d.ts

@@ -1,8 +0,0 @@
-import 'typings-global';
-export * from './projectinfo.classes.git';
-export * from './projectinfo.classes.npm';
-export * from './projectinfo.classes.projectinfo';
-/**
- * gets the name from package.json in a specified directory
- */
-export declare let getNpmNameForDir: (cwdArg: any) => string;

dist/index.js

@@ -1,31 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-require("typings-global");
-// direct access to classes
-__export(require("./projectinfo.classes.git"));
-__export(require("./projectinfo.classes.npm"));
-__export(require("./projectinfo.classes.projectinfo"));
-// npm
-const projectinfo_classes_npm_1 = require("./projectinfo.classes.npm");
-// quick functions
-/**
- * gets the name from package.json in a specified directory
- */
-exports.getNpmNameForDir = function (cwdArg) {
-    let localNpm = new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg);
-    if (localNpm.status === 'ok') {
-        return localNpm.name;
-    }
-};
-/* TODO
-projectinfo.git = function(){
-
-};
-
-projectinfo.mojo = function(){
-
-};
-*/
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBQUEsMEJBQXVCO0FBR3ZCLDJCQUEyQjtBQUMzQiwrQ0FBeUM7QUFDekMsK0NBQXlDO0FBQ3pDLHVEQUFpRDtBQUVqRCxNQUFNO0FBQ04sdUVBQTBEO0FBRTFELGtCQUFrQjtBQUVsQjs7R0FFRztBQUNRLFFBQUEsZ0JBQWdCLEdBQUcsVUFBUyxNQUFNO0lBQ3pDLElBQUksUUFBUSxHQUFHLElBQUksd0NBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQTtJQUN6QyxFQUFFLENBQUMsQ0FBQyxRQUFRLENBQUMsTUFBTSxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDM0IsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUE7SUFDeEIsQ0FBQztBQUNMLENBQUMsQ0FBQTtBQUVEOzs7Ozs7OztFQVFFIn0=

dist/projectinfo.classes.git.d.ts

@@ -1,16 +0,0 @@
-export declare class ProjectinfoGit {
-    isGit: boolean;
-    githost: string;
-    gituser: string;
-    gitrepo: string;
-    cwd: string;
-    constructor(cwdArg: string);
-    /**
-     * get git info from path
-     */
-    getGitInfoFromPath(): void;
-    /**
-     * get git info from remote url
-     */
-    getGitInfoFromRemote(remoteUrlArg: string): void;
-}

dist/projectinfo.classes.git.js

@@ -1,24 +0,0 @@
-"use strict";
-const plugins = require("./projectinfo.plugins");
-class ProjectinfoGit {
-    constructor(cwdArg) {
-        this.cwd = cwdArg;
-        this.getGitInfoFromPath();
-    }
-    /**
-     * get git info from path
-     */
-    getGitInfoFromPath() {
-        let localSmartpath = new plugins.smartpath.Smartpath(this.cwd);
-        this.gitrepo = localSmartpath.pathLevelsBackwards[0];
-        this.gituser = localSmartpath.pathLevelsBackwards[1];
-    }
-    /**
-     * get git info from remote url
-     */
-    getGitInfoFromRemote(remoteUrlArg) {
-        let gitRepoParsed = new plugins.smartstring.GitRepo(remoteUrlArg);
-    }
-}
-exports.ProjectinfoGit = ProjectinfoGit;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5naXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLmdpdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsaURBQWdEO0FBRWhEO0lBTUksWUFBWSxNQUFjO1FBQ3RCLElBQUksQ0FBQyxHQUFHLEdBQUcsTUFBTSxDQUFBO1FBQ2pCLElBQUksQ0FBQyxrQkFBa0IsRUFBRSxDQUFBO0lBQzdCLENBQUM7SUFFRDs7T0FFRztJQUNILGtCQUFrQjtRQUNkLElBQUksY0FBYyxHQUFHLElBQUksT0FBTyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFBO1FBQzlELElBQUksQ0FBQyxPQUFPLEdBQUcsY0FBYyxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFBO1FBQ3BELElBQUksQ0FBQyxPQUFPLEdBQUcsY0FBYyxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFBO0lBQ3hELENBQUM7SUFFRDs7T0FFRztJQUNILG9CQUFvQixDQUFDLFlBQW9CO1FBQ3JDLElBQUksYUFBYSxHQUFHLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDckUsQ0FBQztDQUNKO0FBMUJELHdDQTBCQyJ9

dist/projectinfo.classes.npm.d.ts

@@ -1,14 +0,0 @@
-import 'typings-global';
-import plugins = require('./projectinfo.plugins');
-export declare class ProjectinfoNpm {
-    isNpm: boolean;
-    packageJson: any;
-    name: string;
-    version: string;
-    status: string;
-    license: string;
-    git: plugins.smartstring.GitRepo;
-    constructor(cwdArg: string, optionsArg?: {
-        gitAccessToken?: string;
-    });
-}

dist/projectinfo.classes.npm.js

@@ -1,24 +0,0 @@
-"use strict";
-require("typings-global");
-const plugins = require("./projectinfo.plugins");
-class ProjectinfoNpm {
-    constructor(cwdArg, optionsArg = {}) {
-        this.isNpm = false;
-        let resolvedCwd = plugins.path.resolve(cwdArg);
-        if (plugins.smartfile.fs.fileExists(plugins.path.join(resolvedCwd, 'package.json'))) {
-            this.isNpm = true;
-            this.packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(resolvedCwd, 'package.json'), 'json');
-            this.name = this.packageJson.name;
-            this.version = this.packageJson.version;
-            this.status = 'ok';
-            this.license = this.packageJson.license;
-            if (this.packageJson.repository) {
-                this.git = new plugins.smartstring.GitRepo(this.packageJson.repository.url, optionsArg.gitAccessToken);
-            }
-            ;
-        }
-    }
-    ;
-}
-exports.ProjectinfoNpm = ProjectinfoNpm;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5ucG0uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLm5wbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLGlEQUFpRDtBQUNqRDtJQVNJLFlBQVksTUFBYyxFQUFFLGFBQTBDLEVBQUU7UUFSeEUsVUFBSyxHQUFZLEtBQUssQ0FBQTtRQVNsQixJQUFJLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtRQUM5QyxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLGNBQWMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2xGLElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFBO1lBQ2pCLElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUNoRCxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FDYixXQUFXLEVBQ1gsY0FBYyxDQUNqQixFQUNELE1BQU0sQ0FDVCxDQUFBO1lBQ0QsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQTtZQUNqQyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFBO1lBQ3ZDLElBQUksQ0FBQyxNQUFNLEdBQUcsSUFBSSxDQUFBO1lBQ2xCLElBQUksQ0FBQyxPQUFPLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUE7WUFDdkMsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO2dCQUM5QixJQUFJLENBQUMsR0FBRyxHQUFHLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsR0FBRyxFQUFFLFVBQVUsQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxRyxDQUFDO1lBQUEsQ0FBQztRQUNOLENBQUM7SUFDTCxDQUFDO0lBQUEsQ0FBQztDQUNMO0FBN0JELHdDQTZCQyJ9

dist/projectinfo.classes.projectinfo.d.ts

@@ -1,15 +0,0 @@
-import { ProjectinfoNpm } from './projectinfo.classes.npm';
-import { ProjectinfoGit } from './projectinfo.classes.git';
-export declare type TProjectType = 'git' | 'npm';
-/**
- * class projectinfo automatically examines a given directory and exposes relevant info about it
- */
-export declare class ProjectInfo {
-    type: TProjectType;
-    npm: ProjectinfoNpm;
-    git: ProjectinfoGit;
-    /**
-     * constructor of class ProjectInfo
-     */
-    constructor(cwdArg: string);
-}

dist/projectinfo.classes.projectinfo.js

@@ -1,17 +0,0 @@
-"use strict";
-const projectinfo_classes_npm_1 = require("./projectinfo.classes.npm");
-const projectinfo_classes_git_1 = require("./projectinfo.classes.git");
-/**
- * class projectinfo automatically examines a given directory and exposes relevant info about it
- */
-class ProjectInfo {
-    /**
-     * constructor of class ProjectInfo
-     */
-    constructor(cwdArg) {
-        this.npm = new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg);
-        this.git = new projectinfo_classes_git_1.ProjectinfoGit(cwdArg);
-    }
-}
-exports.ProjectInfo = ProjectInfo;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5wcm9qZWN0aW5mby5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Byb2plY3RpbmZvLmNsYXNzZXMucHJvamVjdGluZm8udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUNBLHVFQUEwRDtBQUMxRCx1RUFBMEQ7QUFHMUQ7O0dBRUc7QUFDSDtJQUlJOztPQUVHO0lBQ0gsWUFBWSxNQUFjO1FBQ3RCLElBQUksQ0FBQyxHQUFHLEdBQUcsSUFBSSx3Q0FBYyxDQUFDLE1BQU0sQ0FBQyxDQUFBO1FBQ3JDLElBQUksQ0FBQyxHQUFHLEdBQUcsSUFBSSx3Q0FBYyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0lBQ3pDLENBQUM7Q0FDSjtBQVhELGtDQVdDIn0=

dist/projectinfo.plugins.d.ts

@@ -1,6 +0,0 @@
-import 'typings-global';
-export import path = require('path');
-export import q = require('q');
-export import smartfile = require('smartfile');
-export import smartstring = require('smartstring');
-export import smartpath = require('smartpath');

dist/projectinfo.plugins.js

@@ -1,8 +0,0 @@
-"use strict";
-require("typings-global");
-exports.path = require("path");
-exports.q = require("q");
-exports.smartfile = require("smartfile");
-exports.smartstring = require("smartstring");
-exports.smartpath = require("smartpath");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Byb2plY3RpbmZvLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2QiwrQkFBb0M7QUFDcEMseUJBQThCO0FBQzlCLHlDQUE4QztBQUM5Qyw2Q0FBa0Q7QUFDbEQseUNBQThDIn0=

npmextra.json

@@ -1,11 +1,17 @@
 {
-    "npmts": {
-        "mode": "default",
-        "coverageTreshold": 80
-    },
   "npmci": {
-        "globalNpmTools": [
+    "npmGlobalTools": [],
-            "npmts"
+    "npmAccessLevel": "public"
-        ]
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "projectinfo",
+      "shortDescription": "gather information about projects. supports npm, git etc.",
+      "npmPackagename": "@pushrocks/projectinfo",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "projectinfo",
+  "name": "@pushrocks/projectinfo",
-  "version": "3.0.0",
+  "version": "4.0.4",
+  "private": false,
   "description": "gather information about projects. supports npm, git etc.",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -25,16 +27,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/projectinfo#readme",
   "devDependencies": {
-    "npmts-g": "^5.2.10",
+    "@gitzone/tsbuild": "^2.1.24",
-    "should": "^11.1.1",
+    "@gitzone/tsrun": "^1.2.12",
-    "typings-test": "^1.0.3"
+    "@gitzone/tstest": "^1.0.33",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^14.0.6",
+    "tslint": "^6.1.2",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/q": "0.0.32",
+    "@pushrocks/smartfile": "^7.0.12",
-    "q": "^1.4.1",
+    "@pushrocks/smartpath": "^4.0.3",
-    "smartfile": "4.1.0",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "smartpath": "^3.2.6",
+    "@pushrocks/smartstring": "^3.0.18"
-    "smartstring": "2.0.22",
+  },
-    "typings-global": "^1.0.14"
+  "files": [
-  }
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,51 @@
+# @pushrocks/projectinfo
+gather information about projects. supports npm, git etc.
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/projectinfo)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/projectinfo)
+* [github.com (source mirror)](https://github.com/pushrocks/projectinfo)
+* [docs (typedoc)](https://pushrocks.gitlab.io/projectinfo/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/projectinfo/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/projectinfo/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/projectinfo)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/projectinfo)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/projectinfo)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/projectinfo)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/projectinfo)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## 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
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,33 +0,0 @@
-"use strict";
-require("typings-test");
-const projectinfo = require("../dist/index");
-let should = require('should');
-let path = require('path');
-let testBasePath = path.resolve(__dirname);
-describe('projectinfo', function () {
-    describe('.npm() return', function () {
-        let myNpm = new projectinfo.ProjectinfoNpm(testBasePath, { gitAccessToken: 'sometoken' });
-        it('should have .packageJson', function () {
-            should(myNpm.packageJson).have.property('version', '1.0.0');
-            should(myNpm.packageJson).have.property('name', 'testpackage');
-        });
-        it('should have .version', function () {
-            should(myNpm).have.property('version', '1.0.0');
-        });
-        it('should have .name', function () {
-            should(myNpm).have.property('name', 'testpackage');
-        });
-        it('should have .license', function () {
-            should(myNpm).have.property('license', 'MIT');
-        });
-        it('should have .git', function () {
-            should(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git');
-        });
-    });
-    describe('.getNpmNameForDir()', function () {
-        it('should return a name', function () {
-            should(projectinfo.getNpmNameForDir(testBasePath)).equal('testpackage');
-        });
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQiw2Q0FBNkM7QUFDN0MsSUFBSSxNQUFNLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFBO0FBQzlCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUMxQixJQUFJLFlBQVksR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFBO0FBRTFDLFFBQVEsQ0FBQyxhQUFhLEVBQUM7SUFDbkIsUUFBUSxDQUFDLGVBQWUsRUFBQztRQUNyQixJQUFJLEtBQUssR0FBRyxJQUFJLFdBQVcsQ0FBQyxjQUFjLENBQUMsWUFBWSxFQUFDLEVBQUMsY0FBYyxFQUFFLFdBQVcsRUFBQyxDQUFDLENBQUE7UUFDdEYsRUFBRSxDQUFDLDBCQUEwQixFQUFDO1lBQzFCLE1BQU0sQ0FBQyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUMsT0FBTyxDQUFDLENBQUE7WUFDMUQsTUFBTSxDQUFDLEtBQUssQ0FBQyxXQUFXLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE1BQU0sRUFBQyxhQUFhLENBQUMsQ0FBQTtRQUNqRSxDQUFDLENBQUMsQ0FBQTtRQUVGLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQztZQUN0QixNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUMsT0FBTyxDQUFDLENBQUE7UUFDbEQsQ0FBQyxDQUFDLENBQUE7UUFFRixFQUFFLENBQUMsbUJBQW1CLEVBQUM7WUFDbkIsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFDLGFBQWEsQ0FBQyxDQUFBO1FBQ3JELENBQUMsQ0FBQyxDQUFBO1FBRUYsRUFBRSxDQUFDLHNCQUFzQixFQUFDO1lBQ3RCLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFNBQVMsRUFBQyxLQUFLLENBQUMsQ0FBQTtRQUNoRCxDQUFDLENBQUMsQ0FBQTtRQUNGLEVBQUUsQ0FBQyxrQkFBa0IsRUFBQztZQUNsQixNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQyxLQUFLLENBQUMsb0RBQW9ELENBQUMsQ0FBQTtRQUMxRixDQUFDLENBQUMsQ0FBQTtJQUVOLENBQUMsQ0FBQyxDQUFBO0lBRUYsUUFBUSxDQUFDLHFCQUFxQixFQUFDO1FBQzNCLEVBQUUsQ0FBQyxzQkFBc0IsRUFBQztZQUN0QixNQUFNLENBQUMsV0FBVyxDQUFDLGdCQUFnQixDQUFDLFlBQVksQ0FBQyxDQUM1QyxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsQ0FBQTtRQUM5QixDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC9C,IAAI,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC/B,IAAI,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC3B,IAAI,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAE3C,QAAQ,CAAC,aAAa,EAAC;IACnB,QAAQ,CAAC,eAAe,EAAC;QACrB,IAAI,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,YAAY,EAAC,EAAC,cAAc,EAAC,WAAW,EAAC,CAAC,CAAC;QACvE,EAAE,CAAC,0BAA0B,EAAC;YAC1B,KAAK,CAAC,WAAW;iBACb,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAC,OAAO,CAAC,CAAC;YAC5C,KAAK,CAAC,WAAW;iBACb,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,aAAa,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAC;YACtB,KAAK;iBACA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAC,OAAO,CAAC,CAAA;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAC;YACnB,KAAK;iBACA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAC,aAAa,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAC;YACtB,KAAK;iBACA,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAC,KAAK,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QACH,EAAE,CAAC,kBAAkB,EAAC;YAClB,KAAK,CAAC,GAAG,CAAC,QAAQ;iBACb,MAAM,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IAEP,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAC;QAClB,EAAE,CAAC,sBAAsB,EAAC;YACtB,WAAW,CAAC,OAAO,CAAC,YAAY,CAAC;iBAC5B,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAC"}

test/test.ts

@@ -1,38 +1,31 @@
-import 'typings-test'
+import { tap, expect } from '@pushrocks/tapbundle';
-import projectinfo = require('../dist/index')
+import projectinfo = require('../ts/index');
-let should = require('should')
-let path = require('path')
-let testBasePath = path.resolve(__dirname)
 
-describe('projectinfo',function(){
+let path = require('path');
-    describe('.npm() return',function(){
+let testBasePath = path.resolve(__dirname);
-        let myNpm = new projectinfo.ProjectinfoNpm(testBasePath,{gitAccessToken: 'sometoken'})
-        it('should have .packageJson',function(){
-            should(myNpm.packageJson).have.property('version','1.0.0')
-            should(myNpm.packageJson).have.property('name','testpackage')
-        })
 
-        it('should have .version',function(){
+let myNpm = new projectinfo.ProjectinfoNpm(testBasePath, { gitAccessToken: 'sometoken' });
-            should(myNpm).have.property('version','1.0.0')
+tap.test('should have .packageJson', async () => {
-        })
+  expect(myNpm.packageJson).have.property('version', '1.0.0');
+  expect(myNpm.packageJson).have.property('name', 'testpackage');
+});
 
-        it('should have .name',function(){
+tap.test('should have .version', async () => {
-            should(myNpm).have.property('name','testpackage')
+  expect(myNpm).have.property('version', '1.0.0');
-        })
+});
 
-        it('should have .license',function(){
+tap.test('should have .name', async () => {
-            should(myNpm).have.property('license','MIT')
+  expect(myNpm).have.property('name', 'testpackage');
-        })
+});
-        it('should have .git',function(){
-            should(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git')
-        })
 
-    })
+tap.test('should have .license', async () => {
+  expect(myNpm).have.property('license', 'MIT');
+});
+tap.test('should have .git', async () => {
+  expect(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git');
+});
+tap.test('should return a name', async () => {
+  expect(projectinfo.getNpmNameForDir(testBasePath)).equal('testpackage');
+});
 
-    describe('.getNpmNameForDir()',function(){
+tap.start();
-        it('should return a name',function(){
-            should(projectinfo.getNpmNameForDir(testBasePath)
-                ).equal('testpackage')
-        })
-    })
-})

ts/index.ts

@@ -1,32 +1,21 @@
-import 'typings-global'
+import plugins = require('./projectinfo.plugins');
-import plugins = require('./projectinfo.plugins')
 
 // direct access to classes
-export * from './projectinfo.classes.git'
+export * from './projectinfo.classes.git';
-export * from './projectinfo.classes.npm'
+export * from './projectinfo.classes.npm';
-export * from './projectinfo.classes.projectinfo'
+export * from './projectinfo.classes.projectinfo';
 
 // npm
-import { ProjectinfoNpm } from './projectinfo.classes.npm'
+import { ProjectinfoNpm } from './projectinfo.classes.npm';
 
 // quick functions
 
 /**
  * gets the name from package.json in a specified directory
  */
-export let getNpmNameForDir = function(cwdArg){
+export let getNpmNameForDir = function(cwdArg) {
-    let localNpm = new ProjectinfoNpm(cwdArg)
+  let localNpm = new ProjectinfoNpm(cwdArg);
   if (localNpm.status === 'ok') {
-        return localNpm.name
+    return localNpm.name;
   }
-}
-
-/* TODO
-projectinfo.git = function(){
-
 };
-
-projectinfo.mojo = function(){
-
-};
-*/

ts/projectinfo.classes.git.ts

@@ -1,29 +1,29 @@
-import * as plugins from './projectinfo.plugins'
+import * as plugins from './projectinfo.plugins';
 
 export class ProjectinfoGit {
-    isGit: boolean
+  isGit: boolean;
-    githost: string
+  githost: string;
-    gituser: string
+  gituser: string;
-    gitrepo: string
+  gitrepo: string;
-    cwd: string
+  cwd: string;
   constructor(cwdArg: string) {
-        this.cwd = cwdArg
+    this.cwd = cwdArg;
-        this.getGitInfoFromPath()
+    this.getGitInfoFromPath();
   }
 
   /**
    * get git info from path
    */
   getGitInfoFromPath() {
-        let localSmartpath = new plugins.smartpath.Smartpath(this.cwd)
+    let localSmartpath = new plugins.smartpath.Smartpath(this.cwd);
-        this.gitrepo = localSmartpath.pathLevelsBackwards[0]
+    this.gitrepo = localSmartpath.pathLevelsBackwards[0];
-        this.gituser = localSmartpath.pathLevelsBackwards[1]
+    this.gituser = localSmartpath.pathLevelsBackwards[1];
   }
 
   /**
    * get git info from remote url
    */
   getGitInfoFromRemote(remoteUrlArg: string) {
-        let gitRepoParsed = new plugins.smartstring.GitRepo(remoteUrlArg)
+    let gitRepoParsed = new plugins.smartstring.GitRepo(remoteUrlArg);
   }
 }

ts/projectinfo.classes.npm.ts

@@ -1,32 +1,31 @@
-import 'typings-global'
+import plugins = require('./projectinfo.plugins');
-import plugins = require('./projectinfo.plugins')
 export class ProjectinfoNpm {
-    isNpm: boolean = false
+  isNpm: boolean = false;
-    packageJson: any
+  packageJson: any;
-    name: string
+  name: string;
-    version: string
+  version: string;
-    status: string
+  status: string;
-    license: string
+  license: string;
-    git: plugins.smartstring.GitRepo
+  git: plugins.smartstring.GitRepo;
 
   constructor(cwdArg: string, optionsArg: { gitAccessToken?: string } = {}) {
-        let resolvedCwd = plugins.path.resolve(cwdArg)
+    let resolvedCwd = plugins.path.resolve(cwdArg);
     if (plugins.smartfile.fs.fileExists(plugins.path.join(resolvedCwd, 'package.json'))) {
-            this.isNpm = true
+      this.isNpm = true;
       this.packageJson = plugins.smartfile.fs.toObjectSync(
-                plugins.path.join(
+        plugins.path.join(resolvedCwd, 'package.json'),
-                    resolvedCwd,
-                    'package.json'
-                ),
         'json'
-            )
+      );
-            this.name = this.packageJson.name
+      this.name = this.packageJson.name;
-            this.version = this.packageJson.version
+      this.version = this.packageJson.version;
-            this.status = 'ok'
+      this.status = 'ok';
-            this.license = this.packageJson.license
+      this.license = this.packageJson.license;
       if (this.packageJson.repository) {
-                this.git = new plugins.smartstring.GitRepo(this.packageJson.repository.url, optionsArg.gitAccessToken)
+        this.git = new plugins.smartstring.GitRepo(
-            };
+          this.packageJson.repository.url,
+          optionsArg.gitAccessToken
+        );
+      }
+    }
   }
-    };
 }

ts/projectinfo.classes.projectinfo.ts

@@ -1,20 +1,20 @@
-import * as plugins from './projectinfo.plugins'
+import * as plugins from './projectinfo.plugins';
-import { ProjectinfoNpm } from './projectinfo.classes.npm'
+import { ProjectinfoNpm } from './projectinfo.classes.npm';
-import { ProjectinfoGit } from './projectinfo.classes.git'
+import { ProjectinfoGit } from './projectinfo.classes.git';
-export type TProjectType = 'git' | 'npm'
+export type TProjectType = 'git' | 'npm';
 
 /**
  * class projectinfo automatically examines a given directory and exposes relevant info about it
  */
 export class ProjectInfo {
-    type: TProjectType
+  type: TProjectType;
-    npm: ProjectinfoNpm
+  npm: ProjectinfoNpm;
-    git: ProjectinfoGit
+  git: ProjectinfoGit;
   /**
    * constructor of class ProjectInfo
    */
   constructor(cwdArg: string) {
-        this.npm = new ProjectinfoNpm(cwdArg)
+    this.npm = new ProjectinfoNpm(cwdArg);
-        this.git = new ProjectinfoGit(cwdArg)
+    this.git = new ProjectinfoGit(cwdArg);
   }
 }

ts/projectinfo.plugins.ts

@@ -1,6 +1,7 @@
-import 'typings-global'
+import * as path from 'path';
-export import path = require('path')
+import * as smartpromise from '@pushrocks/smartpromise';
-export import q = require('q')
+import * as smartfile from '@pushrocks/smartfile';
-export import smartfile = require('smartfile')
+import * as smartstring from '@pushrocks/smartstring';
-export import smartstring = require('smartstring')
+import * as smartpath from '@pushrocks/smartpath';
-export import smartpath = require('smartpath')
+
+export { path, smartpromise, smartfile, smartstring, smartpath };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }