1.0.9

.gitlab-ci.yml

@@ -17,7 +17,7 @@ testLTS:
     - npmci test lts
   tags:
     - docker
-    
+
 testSTABLE:
   stage: test
   script:

README.md

@@ -2,3 +2,14 @@
 do more with npm
 
 npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.
+
+## Usage
+The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avaoid complexity through many configuration files.
+
+```typescript
+let npmextra = require("npmextra");
+npmextra.dataFor({
+    toolName:"sometool",
+
+});
+```

dist/index.d.ts

@@ -1 +1,7 @@
-export declare let dataFor: (toolNameArg: string, cwdArg?: string) => any;
+export interface IDataFor {
+    toolName: string;
+    defaultSettings?: any;
+    cwd?: string;
+}
+export declare let dataFor: (optionsArg: IDataFor) => any;
+export declare let configFilePresent: () => boolean;

dist/index.js

@@ -1,26 +1,42 @@
 "use strict";
 const plugins = require("./npmextra.plugins");
 const paths = require("./npmextra.paths");
-let allData;
-exports.dataFor = (toolNameArg, cwdArg) => {
-    if (typeof allData == "undefined") {
-        let lookupPath;
-        if (cwdArg) {
-            lookupPath = plugins.path.join(cwdArg, "npmextra.json");
-        }
-        else {
-            lookupPath = paths.configFile;
-        }
-        ;
-        allData = plugins.smartfile.fs.toObjectSync(plugins.path.join(lookupPath));
+exports.dataFor = (optionsArg) => {
+    // handle default settings
+    if (typeof optionsArg.toolName != undefined
+        && typeof optionsArg.defaultSettings != undefined) {
+        let newDefaultOptions = {};
+        newDefaultOptions[optionsArg.toolName] = optionsArg.defaultSettings;
+        optionsArg.defaultSettings = newDefaultOptions;
     }
     ;
-    if (toolNameArg) {
-        if (allData[toolNameArg]) {
-            return allData[toolNameArg];
+    // set lookup path
+    let lookupPath;
+    if (optionsArg.cwd) {
+        lookupPath = plugins.path.join(optionsArg.cwd, "npmextra.json");
+    }
+    else {
+        lookupPath = paths.configFile;
+    }
+    ;
+    // get allData
+    let allData;
+    if (plugins.smartfile.fs.fileExistsSync(lookupPath)) {
+        allData = plugins.smartfile.fs.toObjectSync(lookupPath);
+    }
+    else {
+        plugins.beautylog.warn(`${lookupPath} is missing!`);
+        allData = {};
+    }
+    ;
+    //assign all data
+    allData = plugins.lodash.merge({}, optionsArg.defaultSettings, allData);
+    if (optionsArg.toolName) {
+        if (allData[optionsArg.toolName]) {
+            return allData[optionsArg.toolName];
         }
         else {
-            plugins.beautylog.error(`There is no data for ${toolNameArg}`);
+            plugins.beautylog.error(`There is no data for ${optionsArg.toolName}`);
             return undefined;
         }
     }
@@ -28,4 +44,7 @@ exports.dataFor = (toolNameArg, cwdArg) => {
         return allData;
     }
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBQWtCLENBQUMsQ0FBQTtBQUMxQyxJQUFJLE9BQU8sQ0FBQztBQUVELGVBQU8sR0FBRyxDQUFDLFdBQWtCLEVBQUMsTUFBYztJQUNuRCxFQUFFLENBQUEsQ0FBQyxPQUFPLE9BQU8sSUFBSSxXQUFXLENBQUMsQ0FBQSxDQUFDO1FBQzlCLElBQUksVUFBVSxDQUFDO1FBQ2YsRUFBRSxDQUFBLENBQUMsTUFBTSxDQUFDLENBQUEsQ0FBQztZQUNQLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUMsZUFBZSxDQUFDLENBQUM7UUFDM0QsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osVUFBVSxHQUFHLEtBQUssQ0FBQyxVQUFVLENBQUM7UUFDbEMsQ0FBQztRQUFBLENBQUM7UUFDRixPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUN2QyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FDaEMsQ0FBQztJQUNOLENBQUM7SUFBQSxDQUFDO0lBQ0YsRUFBRSxDQUFBLENBQUMsV0FBVyxDQUFDLENBQUEsQ0FBQztRQUNaLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDckIsTUFBTSxDQUFDLE9BQU8sQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNoQyxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyx3QkFBd0IsV0FBVyxFQUFFLENBQUMsQ0FBQztZQUMvRCxNQUFNLENBQUMsU0FBUyxDQUFDO1FBQ3JCLENBQUM7SUFDTCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsT0FBTyxDQUFDO0lBQ25CLENBQUM7QUFDTCxDQUFDLENBQUEifQ==
+exports.configFilePresent = () => {
+    return plugins.smartfile.fs.fileExistsSync(paths.configFile);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBQWtCLENBQUMsQ0FBQTtBQVEvQixlQUFPLEdBQUcsQ0FBQyxVQUFtQjtJQUVyQywwQkFBMEI7SUFDMUIsRUFBRSxDQUFBLENBQ0UsT0FBTyxVQUFVLENBQUMsUUFBUSxJQUFJLFNBQVM7V0FDcEMsT0FBTyxVQUFVLENBQUMsZUFBZSxJQUFJLFNBQzVDLENBQUMsQ0FBQSxDQUFDO1FBQ0UsSUFBSSxpQkFBaUIsR0FBRyxFQUFFLENBQUM7UUFDM0IsaUJBQWlCLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxlQUFlLENBQUM7UUFDcEUsVUFBVSxDQUFDLGVBQWUsR0FBRyxpQkFBaUIsQ0FBQztJQUNuRCxDQUFDO0lBQUEsQ0FBQztJQUVGLGtCQUFrQjtJQUNsQixJQUFJLFVBQWlCLENBQUM7SUFDdEIsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFBLENBQUM7UUFDZixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQztJQUNsQyxDQUFDO0lBQUEsQ0FBQztJQUVGLGNBQWM7SUFDZCxJQUFJLE9BQU8sQ0FBQztJQUNaLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFBLENBQUM7UUFDaEQsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxHQUFHLFVBQVUsY0FBYyxDQUFDLENBQUM7UUFDcEQsT0FBTyxHQUFHLEVBQUUsQ0FBQztJQUNqQixDQUFDO0lBQUEsQ0FBQztJQUVGLGlCQUFpQjtJQUNqQixPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxFQUFDLFVBQVUsQ0FBQyxlQUFlLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEUsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFBLENBQUM7UUFDcEIsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ3ZFLE1BQU0sQ0FBQyxTQUFTLENBQUM7UUFDckIsQ0FBQztJQUNMLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxPQUFPLENBQUM7SUFDbkIsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUVTLHlCQUFpQixHQUFHO0lBQzNCLE1BQU0sQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0FBQ2pFLENBQUMsQ0FBQSJ9

dist/npmextra.plugins.d.ts

@@ -1,5 +1,6 @@
 import "typings-global";
 export import beautylog = require("beautylog");
+export import lodash = require("lodash");
 export import path = require("path");
 export import smartfile = require("smartfile");
 export import q = require("q");

dist/npmextra.plugins.js

@@ -1,7 +1,8 @@
 "use strict";
 require("typings-global");
 exports.beautylog = require("beautylog");
+exports.lodash = require("lodash");
 exports.path = require("path");
 exports.smartfile = require("smartfile");
 exports.q = require("q");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsU0FBQyxXQUFXLEdBQUcsQ0FBQyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsY0FBTSxXQUFXLFFBQVEsQ0FBQyxDQUFDO0FBQzNCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQyJ9

package.json

@@ -1,8 +1,9 @@
 {
   "name": "npmextra",
-  "version": "1.0.3",
+  "version": "1.0.9",
   "description": "do more with npm",
   "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
     "test": "(npmts)"
   },
@@ -17,14 +18,16 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@types/q": "0.0.27",
-    "beautylog": "^5.0.14",
+    "@types/q": "^0.x.x",
+    "beautylog": "^5.0.20",
+    "lodash": "^4.15.0",
     "q": "^1.4.1",
-    "smartfile": "^4.0.10",
+    "smartfile": "^4.0.13",
     "typings-global": "^1.0.6"
   },
   "devDependencies": {
-    "should": "^9.0.2",
+    "@types/should": "^8.1.27",
+    "should": "^11.1.0",
     "typings-test": "^1.0.1"
   }
 }

test/test.js

@@ -5,8 +5,21 @@ require("should");
 const npmExtra = require("../dist/index");
 describe("npmextra", function () {
     it("should read a config file", function () {
-        let testData = npmExtra.dataFor("testTool", path.join(process.cwd(), "test/"));
-        console.log(testData);
+        let testData = npmExtra.dataFor({
+            toolName: "testTool",
+            defaultSettings: { someKey2: "someValue2" },
+            cwd: path.join(process.cwd(), "test/")
+        });
+        testData.should.have.ownProperty("someKey2");
+    });
+    it("should read a config file", function () {
+        let testData = npmExtra.dataFor({
+            toolName: "testTool",
+            defaultSettings: { someKey2: "someValue2" },
+            cwd: path.join(process.cwd(), "test/")
+        });
+        testData.should.have.ownProperty("someKey2");
+        testData.testValue.should.equal(2);
     });
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxJQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDOUIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFFBQVEsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDLFVBQVUsRUFBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsQ0FBQyxDQUFDO1FBQzdFLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDMUIsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxJQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDOUIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFFBQVEsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDO1lBQzVCLFFBQVEsRUFBQyxVQUFVO1lBQ25CLGVBQWUsRUFBQyxFQUFDLFFBQVEsRUFBQyxZQUFZLEVBQUM7WUFDdkMsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQztTQUN4QyxDQUFDLENBQUM7UUFDSCxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDakQsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsSUFBSSxRQUFRLEdBQUcsUUFBUSxDQUFDLE9BQU8sQ0FBQztZQUM1QixRQUFRLEVBQUMsVUFBVTtZQUNuQixlQUFlLEVBQUMsRUFBQyxRQUFRLEVBQUMsWUFBWSxFQUFDO1lBQ3ZDLEdBQUcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUM7U0FDeEMsQ0FBQyxDQUFDO1FBQ0gsUUFBUSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQzdDLFFBQVEsQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2QyxDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMsQ0FBQyxDQUFDIn0=

test/test.ts

@@ -6,7 +6,20 @@ import npmExtra = require("../dist/index");
 
 describe("npmextra",function(){
     it("should read a config file",function(){
-        let testData = npmExtra.dataFor("testTool",path.join(process.cwd(),"test/"));
-        console.log(testData);
+        let testData = npmExtra.dataFor({
+            toolName:"testTool",
+            defaultSettings:{someKey2:"someValue2"},
+            cwd: path.join(process.cwd(),"test/")
+        });
+        testData.should.have.ownProperty("someKey2");
+    });
+    it("should read a config file",function(){
+        let testData = npmExtra.dataFor({
+            toolName:"testTool",
+            defaultSettings:{someKey2:"someValue2"},
+            cwd: path.join(process.cwd(),"test/")
+        });
+        testData.should.have.ownProperty("someKey2");
+        testData.testValue.should.equal(2);
     });
 });

ts/index.ts

@@ -1,27 +1,55 @@
 import * as plugins from "./npmextra.plugins"
 import * as paths from "./npmextra.paths";
-let allData;
 
-export let dataFor = (toolNameArg:string,cwdArg?:string) => {
-    if(typeof allData == "undefined"){
-        let lookupPath;
-        if(cwdArg){
-            lookupPath = plugins.path.join(cwdArg,"npmextra.json");
-        } else {
-            lookupPath = paths.configFile;
-        };
-        allData = plugins.smartfile.fs.toObjectSync(
-            plugins.path.join(lookupPath)
-        );
+export interface IDataFor {
+    toolName:string;
+    defaultSettings?;
+    cwd?:string
+}
+
+export let dataFor = (optionsArg:IDataFor) => {
+    
+    // handle default settings
+    if(
+        typeof optionsArg.toolName != undefined
+        && typeof optionsArg.defaultSettings != undefined
+    ){
+        let newDefaultOptions = {};
+        newDefaultOptions[optionsArg.toolName] = optionsArg.defaultSettings;
+        optionsArg.defaultSettings = newDefaultOptions;
     };
-    if(toolNameArg){
-        if(allData[toolNameArg]){
-            return allData[toolNameArg];
+
+    // set lookup path
+    let lookupPath:string;
+    if(optionsArg.cwd){
+        lookupPath = plugins.path.join(optionsArg.cwd,"npmextra.json");
+    } else {
+        lookupPath = paths.configFile;
+    };
+    
+    // get allData
+    let allData;
+    if(plugins.smartfile.fs.fileExistsSync(lookupPath)){
+        allData = plugins.smartfile.fs.toObjectSync(lookupPath);
+    } else {
+        plugins.beautylog.warn(`${lookupPath} is missing!`);
+        allData = {};
+    };
+
+    //assign all data
+    allData = plugins.lodash.merge({},optionsArg.defaultSettings,allData);
+    if(optionsArg.toolName){
+        if(allData[optionsArg.toolName]){
+            return allData[optionsArg.toolName];
         } else {
-            plugins.beautylog.error(`There is no data for ${toolNameArg}`);
+            plugins.beautylog.error(`There is no data for ${optionsArg.toolName}`);
             return undefined;
         }
     } else {
         return allData;
     }
+};
+
+export let configFilePresent = ():boolean => {
+    return plugins.smartfile.fs.fileExistsSync(paths.configFile);
 }

ts/npmextra.plugins.ts

@@ -1,5 +1,6 @@
 import "typings-global";
 export import beautylog = require("beautylog");
+export import lodash = require("lodash");
 export import path = require("path");
 export import smartfile = require("smartfile");
 export import q = require("q");