2.0.1

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 coverage/
-docs/
+pages/
+public/

.gitlab-ci.yml

@@ -3,6 +3,7 @@ image: hosttoday/ht-docker-node:npmts
 stages:
 - test
 - release
+- page
 
 testLEGACY:
   stage: test
@@ -33,3 +34,15 @@ release:
     - tags
   tags:
     - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: page
+  script:
+    - npmci command npmpage --host gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

README.md

@@ -1,15 +1,47 @@
 # npmextra
-do more with npm
+do more with npm.
 
 npmextra is a hub for a series of js tools that help writing, documenting and maintaining npm modules.
 
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmextra)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmextra)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmextra)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmextra/)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/npmextra/badges/master/build.svg)](https://gitlab.com/pushrocks/npmextra/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/npmextra/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmextra/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/npmextra.svg)](https://david-dm.org/pushrocks/npmextra)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmextra/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmextra/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/npmextra/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmextra)
+[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+
 ## 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.
+The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files.
+
+npmextra.json
+```json
+{
+    "sometool": {
+        "defaultKey1": "awesomeValueFromConfig"
+    }
+}
+```
 
 ```typescript
-let npmextra = require("npmextra");
-npmextra.dataFor({
-    toolName:"sometool",
+import { Npmextra } from 'npmextra'
 
-});
-```
+let myNpmExtra = new Npmextra('my/path/to/cwd') // cwd argument is optional 
+mergedData = myNpmExtra.dataFor(
+    'sometool',
+    { // gets merged with whatever is in the configfile
+        defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig"
+        defaultKey2: 'defaultValue2' // this one will pass through unaltered
+    }
+)
+```
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,7 +1,2 @@
-export interface IDataFor {
-    toolName: string;
-    defaultSettings?: any;
-    cwd?: string;
-}
-export declare let dataFor: (optionsArg: IDataFor) => any;
-export declare let configFilePresent: () => boolean;
+export * from './npmextra.classes.npmextra';
+export * from './npmextra.classes.keyvaluestore';

dist/index.js

@@ -1,50 +1,7 @@
 "use strict";
-const plugins = require("./npmextra.plugins");
-const paths = require("./npmextra.paths");
-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;
-    }
-    ;
-    // 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 ${optionsArg.toolName}`);
-            return undefined;
-        }
-    }
-    else {
-        return allData;
-    }
-};
-exports.configFilePresent = () => {
-    return plugins.smartfile.fs.fileExistsSync(paths.configFile);
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBQWtCLENBQUMsQ0FBQTtBQVEvQixlQUFPLEdBQUcsQ0FBQyxVQUFtQjtJQUVyQywwQkFBMEI7SUFDMUIsRUFBRSxDQUFBLENBQ0UsT0FBTyxVQUFVLENBQUMsUUFBUSxJQUFJLFNBQVM7V0FDcEMsT0FBTyxVQUFVLENBQUMsZUFBZSxJQUFJLFNBQzVDLENBQUMsQ0FBQSxDQUFDO1FBQ0UsSUFBSSxpQkFBaUIsR0FBRyxFQUFFLENBQUM7UUFDM0IsaUJBQWlCLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxlQUFlLENBQUM7UUFDcEUsVUFBVSxDQUFDLGVBQWUsR0FBRyxpQkFBaUIsQ0FBQztJQUNuRCxDQUFDO0lBQUEsQ0FBQztJQUVGLGtCQUFrQjtJQUNsQixJQUFJLFVBQWlCLENBQUM7SUFDdEIsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFBLENBQUM7UUFDZixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQztJQUNsQyxDQUFDO0lBQUEsQ0FBQztJQUVGLGNBQWM7SUFDZCxJQUFJLE9BQU8sQ0FBQztJQUNaLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFBLENBQUM7UUFDaEQsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxHQUFHLFVBQVUsY0FBYyxDQUFDLENBQUM7UUFDcEQsT0FBTyxHQUFHLEVBQUUsQ0FBQztJQUNqQixDQUFDO0lBQUEsQ0FBQztJQUVGLGlCQUFpQjtJQUNqQixPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxFQUFDLFVBQVUsQ0FBQyxlQUFlLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEUsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFBLENBQUM7UUFDcEIsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ3ZFLE1BQU0sQ0FBQyxTQUFTLENBQUM7UUFDckIsQ0FBQztJQUNMLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxPQUFPLENBQUM7SUFDbkIsQ0FBQztBQUNMLENBQUMsQ0FBQztBQUVTLHlCQUFpQixHQUFHO0lBQzNCLE1BQU0sQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFDO0FBQ2pFLENBQUMsQ0FBQSJ9
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+__export(require("./npmextra.classes.npmextra"));
+__export(require("./npmextra.classes.keyvaluestore"));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBRUEsaURBQTJDO0FBQzNDLHNEQUFnRCJ9

dist/npmextra.classes.keyValueStore.d.ts

@@ -0,0 +1,18 @@
+export declare type keyValueStoreTypes = 'path' | 'gitProject';
+export declare class KeyValueStore {
+    constructor(optionsArg: {
+        type: keyValueStoreTypes;
+    });
+    /**
+ * reads a keyValueFile from disk
+ */
+    kvRead(): void;
+    /**
+     * writes a key value file to disk
+     */
+    kvWrite(): void;
+    /**
+     * wipes a key value store from disk
+     */
+    kevWipe(): void;
+}

dist/npmextra.classes.keyValueStore.js

@@ -0,0 +1,22 @@
+"use strict";
+class KeyValueStore {
+    constructor(optionsArg) {
+    }
+    /**
+ * reads a keyValueFile from disk
+ */
+    kvRead() {
+    }
+    /**
+     * writes a key value file to disk
+     */
+    kvWrite() {
+    }
+    /**
+     * wipes a key value store from disk
+     */
+    kevWipe() {
+    }
+}
+exports.KeyValueStore = KeyValueStore;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5rZXl2YWx1ZXN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtZXh0cmEuY2xhc3Nlcy5rZXl2YWx1ZXN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFLQTtJQUNJLFlBQVksVUFFWDtJQUVELENBQUM7SUFDRDs7R0FFRDtJQUNDLE1BQU07SUFFTixDQUFDO0lBRUQ7O09BRUc7SUFDSCxPQUFPO0lBRVAsQ0FBQztJQUVEOztPQUVHO0lBQ0gsT0FBTztJQUVQLENBQUM7Q0FDSjtBQTFCRCxzQ0EwQkMifQ==

dist/npmextra.classes.npmextra.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Npmextra class allows easy configuration of tools
+ */
+export declare class Npmextra {
+    cwd: string;
+    lookupPath: string;
+    npmextraJsonExists: boolean;
+    npmextraJsonData: boolean;
+    /**
+     * creates instance of Npmextra
+     */
+    constructor(cwdArg?: string);
+    /**
+     * merges the supplied options with the ones from npmextra.json
+     */
+    dataFor<IToolConfig>(toolnameArg: string, defaultOptionsArg: any): IToolConfig;
+    /**
+     * checks if the JSON exists
+     */
+    private checkNpmextraJsonExists();
+    /**
+     * gets lookupPath
+     */
+    private checkLookupPath();
+    /**
+     * get npmextraJsonData
+     */
+    private checkNpmextraJsonData();
+}

dist/npmextra.classes.npmextra.js

@@ -0,0 +1,64 @@
+"use strict";
+const plugins = require("./npmextra.plugins");
+const paths = require("./npmextra.paths");
+/**
+ * Npmextra class allows easy configuration of tools
+ */
+class Npmextra {
+    /**
+     * creates instance of Npmextra
+     */
+    constructor(cwdArg) {
+        if (cwdArg) {
+            this.cwd = cwdArg;
+        }
+        else {
+            this.cwd = paths.cwd;
+        }
+        this.checkLookupPath();
+        this.checkNpmextraJsonExists();
+        this.checkNpmextraJsonData();
+    }
+    /**
+     * merges the supplied options with the ones from npmextra.json
+     */
+    dataFor(toolnameArg, defaultOptionsArg) {
+        let npmextraToolOptions;
+        if (this.npmextraJsonData[toolnameArg]) {
+            npmextraToolOptions = this.npmextraJsonData[toolnameArg];
+        }
+        else {
+            npmextraToolOptions = {};
+        }
+        let mergedOptions = plugins.lodash.merge({}, defaultOptionsArg, npmextraToolOptions);
+        return mergedOptions;
+    }
+    /**
+     * checks if the JSON exists
+     */
+    checkNpmextraJsonExists() {
+        this.npmextraJsonExists = plugins.smartfile.fs.fileExistsSync(this.lookupPath);
+    }
+    /**
+     * gets lookupPath
+     */
+    checkLookupPath() {
+        if (this.cwd) {
+            this.lookupPath = plugins.path.join(this.cwd, 'npmextra.json');
+        }
+        else {
+            this.lookupPath = paths.configFile;
+        }
+        ;
+    }
+    /**
+     * get npmextraJsonData
+     */
+    checkNpmextraJsonData() {
+        if (this.npmextraJsonExists) {
+            this.npmextraJsonData = plugins.smartfile.fs.toObjectSync(this.lookupPath);
+        }
+    }
+}
+exports.Npmextra = Npmextra;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5ucG1leHRyYS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLmNsYXNzZXMubnBtZXh0cmEudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDhDQUE2QztBQUM3QywwQ0FBeUM7QUFFekM7O0dBRUc7QUFDSDtJQU1JOztPQUVHO0lBQ0gsWUFBWSxNQUFlO1FBQ3ZCLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUM7WUFDVCxJQUFJLENBQUMsR0FBRyxHQUFHLE1BQU0sQ0FBQTtRQUNyQixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixJQUFJLENBQUMsR0FBRyxHQUFHLEtBQUssQ0FBQyxHQUFHLENBQUE7UUFDeEIsQ0FBQztRQUNELElBQUksQ0FBQyxlQUFlLEVBQUUsQ0FBQTtRQUN0QixJQUFJLENBQUMsdUJBQXVCLEVBQUUsQ0FBQTtRQUM5QixJQUFJLENBQUMscUJBQXFCLEVBQUUsQ0FBQTtJQUNoQyxDQUFDO0lBRUQ7O09BRUc7SUFDSCxPQUFPLENBQWMsV0FBbUIsRUFBRSxpQkFBc0I7UUFDNUQsSUFBSSxtQkFBbUIsQ0FBQTtRQUN2QixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ3JDLG1CQUFtQixHQUFHLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUM1RCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixtQkFBbUIsR0FBRyxFQUFFLENBQUE7UUFDNUIsQ0FBQztRQUNELElBQUksYUFBYSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsRUFBRSxpQkFBaUIsRUFBRSxtQkFBbUIsQ0FBQyxDQUFBO1FBQ3BGLE1BQU0sQ0FBQyxhQUFhLENBQUE7SUFDeEIsQ0FBQztJQUVEOztPQUVHO0lBQ0ssdUJBQXVCO1FBQzNCLElBQUksQ0FBQyxrQkFBa0IsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxDQUFBO0lBQ2xGLENBQUM7SUFFRDs7T0FFRztJQUNLLGVBQWU7UUFDbkIsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7WUFDWCxJQUFJLENBQUMsVUFBVSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsZUFBZSxDQUFDLENBQUE7UUFDbEUsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osSUFBSSxDQUFDLFVBQVUsR0FBRyxLQUFLLENBQUMsVUFBVSxDQUFBO1FBQ3RDLENBQUM7UUFBQSxDQUFDO0lBQ04sQ0FBQztJQUVEOztPQUVHO0lBQ0sscUJBQXFCO1FBQ3pCLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxrQkFBa0IsQ0FBQyxDQUFDLENBQUM7WUFDMUIsSUFBSSxDQUFDLGdCQUFnQixHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLENBQUE7UUFDOUUsQ0FBQztJQUNMLENBQUM7Q0FFSjtBQTdERCw0QkE2REMifQ==

dist/npmextra.paths.js

@@ -2,7 +2,7 @@
 const plugins = require("./npmextra.plugins");
 // directories
 exports.cwd = process.cwd();
-exports.packageDir = plugins.path.join(__dirname, "../");
-//
-exports.configFile = plugins.path.join(exports.cwd, "npmextra.json");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1leHRyYS5wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQW9CLENBQUMsQ0FBQTtBQUU5QyxjQUFjO0FBQ0gsV0FBRyxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztBQUNwQixrQkFBVSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxLQUFLLENBQUMsQ0FBQztBQUUzRCxFQUFFO0FBQ1Msa0JBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFHLEVBQUMsZUFBZSxDQUFDLENBQUMifQ==
+exports.packageDir = plugins.path.join(__dirname, '../');
+// files
+exports.configFile = plugins.path.join(exports.cwd, 'npmextra.json');
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1leHRyYS5wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsOENBQTZDO0FBRTdDLGNBQWM7QUFDSCxRQUFBLEdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7QUFDbkIsUUFBQSxVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLEtBQUssQ0FBQyxDQUFBO0FBRTFELFFBQVE7QUFDRyxRQUFBLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFHLEVBQUMsZUFBZSxDQUFDLENBQUEifQ==

dist/npmextra.plugins.d.ts

@@ -1,6 +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");
+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

@@ -5,4 +5,4 @@ exports.lodash = require("lodash");
 exports.path = require("path");
 exports.smartfile = require("smartfile");
 exports.q = require("q");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsY0FBTSxXQUFXLFFBQVEsQ0FBQyxDQUFDO0FBQzNCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2Qix5Q0FBOEM7QUFDOUMsbUNBQXdDO0FBQ3hDLCtCQUFvQztBQUNwQyx5Q0FBOEM7QUFDOUMseUJBQThCIn0=

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmextra",
-  "version": "1.0.9",
+  "version": "2.0.1",
   "description": "do more with npm",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -19,15 +19,15 @@
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
     "@types/q": "^0.x.x",
-    "beautylog": "^5.0.20",
-    "lodash": "^4.15.0",
+    "beautylog": "^5.0.23",
+    "lodash": "^4.16.1",
     "q": "^1.4.1",
-    "smartfile": "^4.0.13",
-    "typings-global": "^1.0.6"
+    "smartfile": "^4.0.20",
+    "typings-global": "^1.0.14"
   },
   "devDependencies": {
-    "@types/should": "^8.1.27",
+    "@types/should": "^8.1.30",
     "should": "^11.1.0",
-    "typings-test": "^1.0.1"
+    "typings-test": "^1.0.3"
   }
 }

test/test.d.ts

@@ -1,2 +1 @@
-import "typings-test";
-import "should";
+import 'typings-test';

test/test.js

@@ -1,25 +1,27 @@
 "use strict";
 require("typings-test");
-const path = require("path");
-require("should");
+const should = require("should");
 const npmExtra = require("../dist/index");
-describe("npmextra", function () {
-    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");
+let testNpmextra;
+describe('npmextra', function () {
+    it('should create a new Npmtextra instance', function () {
+        testNpmextra = new npmExtra.Npmextra('./test/');
+        should(testNpmextra).be.instanceof(npmExtra.Npmextra);
     });
-    it("should read a config file", function () {
-        let testData = npmExtra.dataFor({
-            toolName: "testTool",
-            defaultSettings: { someKey2: "someValue2" },
-            cwd: path.join(process.cwd(), "test/")
+    it('should state wether a npmextra.json exists', function () {
+        should(testNpmextra.npmextraJsonExists).be.true();
+    });
+    it('should pass through default value, if not overriden by config from file', function () {
+        let testData = testNpmextra.dataFor('testTool', { someKey2: 'someValue2' });
+        console.log(testData);
+        should(testData).have.ownProperty('someKey2');
+    });
+    it('should read a config file', function () {
+        let testData = testNpmextra.dataFor('testTool', {
+            someKey2: 'someValue2'
         });
-        testData.should.have.ownProperty("someKey2");
-        testData.testValue.should.equal(2);
+        should(testData).have.ownProperty('someKey2');
+        should(testData.testValue).equal(2);
     });
 });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxJQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDOUIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFFBQVEsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDO1lBQzVCLFFBQVEsRUFBQyxVQUFVO1lBQ25CLGVBQWUsRUFBQyxFQUFDLFFBQVEsRUFBQyxZQUFZLEVBQUM7WUFDdkMsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQztTQUN4QyxDQUFDLENBQUM7UUFDSCxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDakQsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsSUFBSSxRQUFRLEdBQUcsUUFBUSxDQUFDLE9BQU8sQ0FBQztZQUM1QixRQUFRLEVBQUMsVUFBVTtZQUNuQixlQUFlLEVBQUMsRUFBQyxRQUFRLEVBQUMsWUFBWSxFQUFDO1lBQ3ZDLEdBQUcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUM7U0FDeEMsQ0FBQyxDQUFDO1FBQ0gsUUFBUSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQzdDLFFBQVEsQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2QyxDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMsQ0FBQyxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUVyQixpQ0FBZ0M7QUFFaEMsMENBQTBDO0FBRTFDLElBQUksWUFBK0IsQ0FBQTtBQUVuQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQyx3Q0FBd0MsRUFBRTtRQUN6QyxZQUFZLEdBQUcsSUFBSSxRQUFRLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFBO1FBQy9DLE1BQU0sQ0FBQyxZQUFZLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsQ0FBQTtJQUN6RCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw0Q0FBNEMsRUFBRTtRQUM3QyxNQUFNLENBQUMsWUFBWSxDQUFDLGtCQUFrQixDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksRUFBRSxDQUFBO0lBQ3JELENBQUMsQ0FBQyxDQUFBO0lBQ0YsRUFBRSxDQUFDLHlFQUF5RSxFQUFDO1FBQ3pFLElBQUksUUFBUSxHQUFHLFlBQVksQ0FBQyxPQUFPLENBQUMsVUFBVSxFQUFFLEVBQUMsUUFBUSxFQUFFLFlBQVksRUFBQyxDQUFDLENBQUE7UUFDekUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUNyQixNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxZQUFZLENBQUMsT0FBTyxDQUMvQixVQUFVLEVBQ1Y7WUFDSSxRQUFRLEVBQUUsWUFBWTtTQUN6QixDQUNKLENBQUE7UUFDRCxNQUFNLENBQUMsUUFBUSxDQUFDLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxVQUFVLENBQUMsQ0FBQTtRQUM3QyxNQUFNLENBQUMsUUFBUSxDQUFDLFNBQVMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQTtJQUN2QyxDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

test/test.ts

@@ -1,25 +1,32 @@
-import "typings-test";
-import path = require("path");
-import "should";
+import 'typings-test'
+import path = require('path')
+import * as should from 'should'
 
-import npmExtra = require("../dist/index");
+import npmExtra = require('../dist/index')
 
-describe("npmextra",function(){
-    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");
-    });
-    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);
-    });
-});
+let testNpmextra: npmExtra.Npmextra
+
+describe('npmextra',function(){
+    it('should create a new Npmtextra instance', function(){
+        testNpmextra = new npmExtra.Npmextra('./test/')
+        should(testNpmextra).be.instanceof(npmExtra.Npmextra)
+    })
+    it('should state wether a npmextra.json exists', function() {
+        should(testNpmextra.npmextraJsonExists).be.true()
+    })
+    it('should pass through default value, if not overriden by config from file',function(){
+        let testData = testNpmextra.dataFor('testTool', {someKey2: 'someValue2'})
+        console.log(testData)
+        should(testData).have.ownProperty('someKey2')
+    })
+    it('should read a config file',function(){
+        let testData = testNpmextra.dataFor(
+            'testTool',
+            {
+                someKey2: 'someValue2'
+            }
+        )
+        should(testData).have.ownProperty('someKey2')
+        should(testData.testValue).equal(2)
+    })
+})

ts/index.ts

@@ -1,55 +1,4 @@
-import * as plugins from "./npmextra.plugins"
-import * as paths from "./npmextra.paths";
+import * as plugins from './npmextra.plugins'
 
-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;
-    };
-
-    // 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 ${optionsArg.toolName}`);
-            return undefined;
-        }
-    } else {
-        return allData;
-    }
-};
-
-export let configFilePresent = ():boolean => {
-    return plugins.smartfile.fs.fileExistsSync(paths.configFile);
-}
+export * from './npmextra.classes.npmextra'
+export * from './npmextra.classes.keyvaluestore'

ts/npmextra.classes.keyvaluestore.ts

@@ -0,0 +1,32 @@
+import * as plugins from './npmextra.plugins'
+
+export type keyValueStoreTypes = 'path' | 'gitProject'
+
+
+export class KeyValueStore {
+    constructor(optionsArg: {
+        type: keyValueStoreTypes
+    }) {
+
+    }
+    /**
+ * reads a keyValueFile from disk
+ */
+    kvRead() {
+
+    }
+
+    /**
+     * writes a key value file to disk
+     */
+    kvWrite() {
+
+    }
+
+    /**
+     * wipes a key value store from disk
+     */
+    kevWipe() {
+
+    }
+}

ts/npmextra.classes.npmextra.ts

@@ -0,0 +1,68 @@
+import * as plugins from './npmextra.plugins'
+import * as paths from './npmextra.paths'
+
+/**
+ * Npmextra class allows easy configuration of tools
+ */
+export class Npmextra {
+    cwd: string
+    lookupPath: string
+    npmextraJsonExists: boolean
+    npmextraJsonData: boolean
+
+    /**
+     * creates instance of Npmextra
+     */
+    constructor(cwdArg?: string) {
+        if (cwdArg) {
+            this.cwd = cwdArg
+        } else {
+            this.cwd = paths.cwd
+        }
+        this.checkLookupPath()
+        this.checkNpmextraJsonExists()
+        this.checkNpmextraJsonData()
+    }
+
+    /**
+     * merges the supplied options with the ones from npmextra.json
+     */
+    dataFor<IToolConfig>(toolnameArg: string, defaultOptionsArg: any): IToolConfig {
+        let npmextraToolOptions
+        if (this.npmextraJsonData[toolnameArg]) {
+            npmextraToolOptions = this.npmextraJsonData[toolnameArg]
+        } else {
+            npmextraToolOptions = {}
+        }
+        let mergedOptions = plugins.lodash.merge({}, defaultOptionsArg, npmextraToolOptions)
+        return mergedOptions
+    }
+
+    /**
+     * checks if the JSON exists
+     */
+    private checkNpmextraJsonExists() {
+        this.npmextraJsonExists = plugins.smartfile.fs.fileExistsSync(this.lookupPath)
+    }
+
+    /**
+     * gets lookupPath
+     */
+    private checkLookupPath() {
+        if (this.cwd) {
+            this.lookupPath = plugins.path.join(this.cwd, 'npmextra.json')
+        } else {
+            this.lookupPath = paths.configFile
+        };
+    }
+
+    /**
+     * get npmextraJsonData
+     */
+    private checkNpmextraJsonData() {
+        if (this.npmextraJsonExists) {
+            this.npmextraJsonData = plugins.smartfile.fs.toObjectSync(this.lookupPath)
+        }
+    }
+
+}

ts/npmextra.paths.ts

@@ -1,8 +1,8 @@
-import * as plugins from "./npmextra.plugins";
+import * as plugins from './npmextra.plugins'
 
 // directories
-export let cwd = process.cwd();
-export let packageDir = plugins.path.join(__dirname,"../");
+export let cwd = process.cwd()
+export let packageDir = plugins.path.join(__dirname,'../')
 
-//
-export let configFile = plugins.path.join(cwd,"npmextra.json"); 
+// files
+export let configFile = plugins.path.join(cwd,'npmextra.json')

ts/npmextra.plugins.ts

@@ -1,6 +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");
+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')

tslint.json

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