update to meet newest standards

.gitlab-ci.yml

@@ -3,7 +3,8 @@ image: hosttoday/ht-docker-node:npmts
 stages:
 - test
 - release
-- page
+- trigger
+- pages
 
 testLEGACY:
   stage: test
@@ -35,3 +36,24 @@ release:
     - tags
   tags:
     - docker
+
+trigger:
+  stage: trigger
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: pages
+  script:
+    - npmci command npmpage --host gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

dist/index.d.ts

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

dist/index.js

@@ -1,16 +1,21 @@
 "use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
 require("typings-global");
-//npm
+// 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");
-var projectinfo_classes_npm_2 = require("./projectinfo.classes.npm");
+// quick functions
-exports.ProjectinfoNpm = projectinfo_classes_npm_2.ProjectinfoNpm;
+/**
-exports.npm = function (cwdArg, optionsArg) {
+ * gets the name from package.json in a specified directory
-    return new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg, optionsArg);
+ */
-};
+exports.getNpmNameForDir = function (cwdArg) {
-//quick functions
+    let localNpm = new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg);
-exports.getName = function (cwdArg) {
+    if (localNpm.status === 'ok') {
-    var localNpm = new projectinfo_classes_npm_1.ProjectinfoNpm(cwdArg);
-    if (localNpm.status === "ok") {
         return localNpm.name;
     }
 };
@@ -23,4 +28,4 @@ projectinfo.mojo = function(){
 
 };
 */
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBR3ZCLEtBQUs7QUFDTCx1RUFBeUQ7QUFDekQscUVBQXlEO0FBQWpELG1EQUFBLGNBQWMsQ0FBQTtBQUNYLFFBQUEsR0FBRyxHQUFHLFVBQVMsTUFBTSxFQUFDLFVBQVU7SUFDdkMsTUFBTSxDQUFDLElBQUksd0NBQWMsQ0FBQyxNQUFNLEVBQUMsVUFBVSxDQUFDLENBQUM7QUFDakQsQ0FBQyxDQUFDO0FBRUYsaUJBQWlCO0FBQ04sUUFBQSxPQUFPLEdBQUcsVUFBUyxNQUFNO0lBQ2hDLElBQUksUUFBUSxHQUFHLElBQUksd0NBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUMxQyxFQUFFLENBQUMsQ0FBQyxRQUFRLENBQUMsTUFBTSxLQUFLLElBQUksQ0FBQyxDQUFBLENBQUM7UUFDMUIsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUM7SUFDekIsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUVGOzs7Ozs7OztFQVFFIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBQUEsMEJBQXVCO0FBR3ZCLDJCQUEyQjtBQUMzQiwrQ0FBeUM7QUFDekMsK0NBQXlDO0FBQ3pDLHVEQUFpRDtBQUVqRCxNQUFNO0FBQ04sdUVBQTBEO0FBRTFELGtCQUFrQjtBQUVsQjs7R0FFRztBQUNRLFFBQUEsZ0JBQWdCLEdBQUcsVUFBUyxNQUFNO0lBQ3pDLElBQUksUUFBUSxHQUFHLElBQUksd0NBQWMsQ0FBQyxNQUFNLENBQUMsQ0FBQTtJQUN6QyxFQUFFLENBQUMsQ0FBQyxRQUFRLENBQUMsTUFBTSxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDM0IsTUFBTSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUE7SUFDeEIsQ0FBQztBQUNMLENBQUMsQ0FBQTtBQUVEOzs7Ozs7OztFQVFFIn0=

dist/projectinfo.classes.git.d.ts

@@ -1 +1,5 @@
-import "typings-global";
+import 'typings-global';
+export declare class ProjectinfoGit {
+    isGit: boolean;
+    constructor();
+}

dist/projectinfo.classes.git.js

@@ -1,3 +1,8 @@
 "use strict";
 require("typings-global");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5naXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLmdpdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCIn0=
+class ProjectinfoGit {
+    constructor() {
+    }
+}
+exports.ProjectinfoGit = ProjectinfoGit;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5naXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLmdpdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBRXZCO0lBRUk7SUFFQSxDQUFDO0NBQ0o7QUFMRCx3Q0FLQyJ9

dist/projectinfo.classes.npm.d.ts

@@ -1,5 +1,6 @@
-import "typings-global";
+import 'typings-global';
 export declare class ProjectinfoNpm {
+    isNpm: boolean;
     packageJson: any;
     name: string;
     version: string;

dist/projectinfo.classes.npm.js

@@ -3,17 +3,22 @@ require("typings-global");
 const plugins = require("./projectinfo.plugins");
 class ProjectinfoNpm {
     constructor(cwdArg, optionsArg = {}) {
-        this.packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(plugins.path.resolve(cwdArg), "package.json"), "json");
+        this.isNpm = false;
-        this.name = this.packageJson.name;
+        let resolvedCwd = plugins.path.resolve(cwdArg);
-        this.version = this.packageJson.version;
+        if (plugins.smartfile.fs.fileExists(plugins.path.join(resolvedCwd, 'package.json'))) {
-        this.status = "ok";
+            this.isNpm = true;
-        this.license = this.packageJson.license;
+            this.packageJson = plugins.smartfile.fs.toObjectSync(plugins.path.join(resolvedCwd, 'package.json'), 'json');
-        if (this.packageJson.repository) {
+            this.name = this.packageJson.name;
-            this.git = new plugins.smartstring.GitRepo(this.packageJson.repository.url, optionsArg.gitAccessToken);
+            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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5ucG0uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLm5wbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLGlEQUFrRDtBQUNsRDtJQVFJLFlBQVksTUFBYSxFQUFDLGFBQXNDLEVBQUU7UUFDOUQsSUFBSSxDQUFDLFdBQVcsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQ2hELE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUNiLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUM1QixjQUFjLENBQ2pCLEVBQ0QsTUFBTSxDQUNULENBQUM7UUFDRixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDO1FBQ2xDLElBQUksQ0FBQyxPQUFPLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUM7UUFDeEMsSUFBSSxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUM7UUFDbkIsSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLE9BQU8sQ0FBQztRQUN4QyxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFBLENBQUM7WUFDN0IsSUFBSSxDQUFDLEdBQUcsR0FBSSxJQUFJLE9BQU8sQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxVQUFVLENBQUMsY0FBYyxDQUFDLENBQUM7UUFDM0csQ0FBQztRQUFBLENBQUM7SUFFTixDQUFDO0lBQUEsQ0FBQztDQUNMO0FBekJELHdDQXlCQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8uY2xhc3Nlcy5ucG0uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9wcm9qZWN0aW5mby5jbGFzc2VzLm5wbS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLGlEQUFpRDtBQUNqRDtJQVNJLFlBQVksTUFBYyxFQUFFLGFBQTBDLEVBQUU7UUFSeEUsVUFBSyxHQUFZLEtBQUssQ0FBQTtRQVNsQixJQUFJLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtRQUM5QyxFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLGNBQWMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2xGLElBQUksQ0FBQyxLQUFLLEdBQUcsSUFBSSxDQUFBO1lBQ2pCLElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUNoRCxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FDYixXQUFXLEVBQ1gsY0FBYyxDQUNqQixFQUNELE1BQU0sQ0FDVCxDQUFBO1lBQ0QsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUMsV0FBVyxDQUFDLElBQUksQ0FBQTtZQUNqQyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxXQUFXLENBQUMsT0FBTyxDQUFBO1lBQ3ZDLElBQUksQ0FBQyxNQUFNLEdBQUcsSUFBSSxDQUFBO1lBQ2xCLElBQUksQ0FBQyxPQUFPLEdBQUcsSUFBSSxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUE7WUFDdkMsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO2dCQUM5QixJQUFJLENBQUMsR0FBRyxHQUFHLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsR0FBRyxFQUFFLFVBQVUsQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxRyxDQUFDO1lBQUEsQ0FBQztRQUNOLENBQUM7SUFDTCxDQUFDO0lBQUEsQ0FBQztDQUNMO0FBN0JELHdDQTZCQyJ9

dist/projectinfo.classes.projectinfo.d.ts

@@ -0,0 +1,13 @@
+import { ProjectinfoNpm } from './projectinfo.classes.npm';
+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;
+    /**
+     * this constructor
+     */
+    constructor(cwdArg: string);
+}

dist/projectinfo.classes.projectinfo.js

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

dist/projectinfo.plugins.d.ts

@@ -1,5 +1,5 @@
-import "typings-global";
+import 'typings-global';
 export declare let path: any;
 export declare let Q: any;
-export import smartfile = require("smartfile");
+export import smartfile = require('smartfile');
-export import smartstring = require("smartstring");
+export import smartstring = require('smartstring');

dist/projectinfo.plugins.js

@@ -1,7 +1,7 @@
 "use strict";
 require("typings-global");
-exports.path = require("path");
+exports.path = require('path');
-exports.Q = require("q");
+exports.Q = require('q');
 exports.smartfile = require("smartfile");
 exports.smartstring = require("smartstring");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Byb2plY3RpbmZvLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUNaLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUN2QixRQUFBLENBQUMsR0FBSSxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUM7QUFDN0IseUNBQStDO0FBQy9DLDZDQUFtRCJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvamVjdGluZm8ucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3Byb2plY3RpbmZvLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUNaLFFBQUEsSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQTtBQUN0QixRQUFBLENBQUMsR0FBSSxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUE7QUFDNUIseUNBQThDO0FBQzlDLDZDQUFrRCJ9

npmextra.json

@@ -0,0 +1,11 @@
+{
+    "npmts": {
+        "mode": "default",
+        "coverageTreshold": 80
+    },
+    "npmci": {
+        "globalNpmTools": [
+            "npmts"
+        ]
+    }
+}

package.json

@@ -25,14 +25,14 @@
   },
   "homepage": "https://gitlab.com/pushrocks/projectinfo#readme",
   "devDependencies": {
-    "npmts-g": "^5.2.8",
+    "npmts-g": "^5.2.10",
     "should": "^11.1.1",
     "typings-test": "^1.0.3"
   },
   "dependencies": {
     "q": "^1.4.1",
     "smartfile": "4.1.0",
-    "smartstring": "2.0.17",
+    "smartstring": "2.0.22",
     "typings-global": "^1.0.14"
   }
 }

test/test.d.ts

@@ -1 +1 @@
-import "typings-test";
+import 'typings-test';

test/test.js

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

test/test.ts

@@ -1,44 +1,38 @@
-import "typings-test";
+import 'typings-test'
-var projectinfo = require("../dist/index.js");
+import projectinfo = require('../dist/index')
-var should = require("should");
+let should = require('should')
-var path = require("path");
+let path = require('path')
-var testBasePath = path.resolve(__dirname);
+let testBasePath = path.resolve(__dirname)
 
-describe("projectinfo",function(){
+describe('projectinfo',function(){
-    describe(".npm() return",function(){
+    describe('.npm() return',function(){
-        var myNpm = projectinfo.npm(testBasePath,{gitAccessToken:"sometoken"});
+        let myNpm = new projectinfo.ProjectinfoNpm(testBasePath,{gitAccessToken: 'sometoken'})
-        it("should have .packageJson",function(){
+        it('should have .packageJson',function(){
-            myNpm.packageJson
+            should(myNpm.packageJson).have.property('version','1.0.0')
-               .should.have.property("version","1.0.0");
+            should(myNpm.packageJson).have.property('name','testpackage')
-            myNpm.packageJson
+        })
-               .should.have.property("name","testpackage");
-        });
 
-        it("should have .version",function(){
+        it('should have .version',function(){
-            myNpm
+            should(myNpm).have.property('version','1.0.0')
-                .should.have.property("version","1.0.0")
+        })
-        });
 
-        it("should have .name",function(){
+        it('should have .name',function(){
-            myNpm
+            should(myNpm).have.property('name','testpackage')
-                .should.have.property("name","testpackage");
+        })
-        });
 
-        it("should have .license",function(){
+        it('should have .license',function(){
-            myNpm
+            should(myNpm).have.property('license','MIT')
-                .should.have.property("license","MIT");
+        })
-        });
+        it('should have .git',function(){
-        it("should have .git",function(){
+            should(myNpm.git.httpsUrl).equal('https://sometoken@github.com/someuser/somerepo.git')
-            myNpm.git.httpsUrl
+        })
-                .should.equal("https://sometoken@github.com/someuser/somerepo.git");
-        });
 
-    });
-
-    describe(".getName()",function(){
-        it("should return a name",function(){
-            projectinfo.getName(testBasePath)
-                .should.equal("testpackage");
-        });
     })
-});
+
+    describe('.getNpmNameForDir()',function(){
+        it('should return a name',function(){
+            should(projectinfo.getNpmNameForDir(testBasePath)
+                ).equal('testpackage')
+        })
+    })
+})

ts/index.ts

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

ts/projectinfo.classes.git.ts

@@ -1 +1,8 @@
-import "typings-global"
+import 'typings-global'
+
+export class ProjectinfoGit {
+    isGit: boolean
+    constructor() {
+        
+    }
+}

ts/projectinfo.classes.npm.ts

@@ -1,28 +1,32 @@
-import "typings-global"
+import 'typings-global'
-import plugins = require("./projectinfo.plugins");
+import plugins = require('./projectinfo.plugins')
-export class ProjectinfoNpm  {
+export class ProjectinfoNpm {
-    packageJson;
+    isNpm: boolean = false
-    name:string;
+    packageJson: any
-    version:string;
+    name: string
-    status:string;
+    version: string
-    license:string;
+    status: string
-    git;
+    license: string
-
+    git
-    constructor(cwdArg:string,optionsArg:{gitAccessToken?:string} = {}){
-        this.packageJson = plugins.smartfile.fs.toObjectSync(
-            plugins.path.join(
-                plugins.path.resolve(cwdArg),
-                "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);
-        };
 
+    constructor(cwdArg: string, optionsArg: { gitAccessToken?: string } = {}) {
+        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)
+            };
+        }
     };
 }

ts/projectinfo.classes.projectinfo.ts

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

ts/projectinfo.plugins.ts

@@ -1,5 +1,5 @@
-import "typings-global"
+import 'typings-global'
-export let path = require("path");
+export let path = require('path')
-export let Q =  require("q");
+export let Q =  require('q')
-export import smartfile = require("smartfile");
+export import smartfile = require('smartfile')
-export import smartstring = require("smartstring");
+export import smartstring = require('smartstring')

tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "tslint-config-standard"
+}