2.0.1

added back ts generics
2.0.0
2016-09-24 16:52:41 +02:00 · 2016-09-24 16:52:38 +02:00 · 2016-09-24 16:44:52 +02:00 · 2016-09-24 16:44:48 +02:00 · 2016-09-23 22:13:06 +02:00 · 2016-09-18 16:10:24 +02:00
17 changed files with 316 additions and 258 deletions
--- a/.gitlab-ci.yml
+++ b/.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
--- a/README.md
+++ b/README.md
@ -4,23 +4,23 @@ 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/npmpage)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmpage)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmpage)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmpage/)
+[![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/npmpage/badges/master/build.svg)](https://gitlab.com/pushrocks/npmpage/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/npmpage/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmpage/commits/master)
-[![Dependency Status](https://david-dm.org/pushrocks/npmpage.svg)](https://david-dm.org/pushrocks/npmpage)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmpage/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmpage/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/npmpage/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmpage)
+[![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
@ -32,16 +32,16 @@ npmextra.json
 ```

 ```typescript
-import * as npmextra from 'npmextra'
+import { Npmextra } from 'npmextra'

-npmextra.dataFor({
-    toolName:'sometool',
-    defaultSettings: { // gets merged with whatever is in the configfile
+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
-    },
-    cwd?: string // lets you specifiy a custom current working directory to look for the npmextra.json
-})
+    }
+)
 ```

 [![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
--- a/dist/index.d.ts
+++ b/dist/index.d.ts
@ -1,16 +1,2 @@
-export interface IDataFor {
-    toolName: string;
-    defaultSettings?: any;
-    cwd?: string;
-}
-/**
- * gets you the configuration data for
- * @executes SYNC
- */
-export declare let dataFor: <IOptions>(optionsArg: IDataFor) => IOptions;
-/**
- * tells you if a configfile is present
- */
-export declare let configFilePresent: (optionsArg: {
-    cwd?: string;
-}) => boolean;
+export * from './npmextra.classes.npmextra';
+export * from './npmextra.classes.keyvaluestore';
--- a/dist/index.js
+++ b/dist/index.js
@ -1,65 +1,7 @@
 "use strict";
-const plugins = require('./npmextra.plugins');
-const paths = require('./npmextra.paths');
-/**
- * gets you the configuration data for
- * @executes SYNC
- */
-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;
-    }
-};
-/**
- * tells you if a configfile is present
- */
-exports.configFilePresent = (optionsArg) => {
-    let lookupPath;
-    if (optionsArg.cwd) {
-        lookupPath = plugins.path.join(optionsArg.cwd, 'npmextra.json');
-    }
-    else {
-        lookupPath = paths.configFile;
-    }
-    ;
-    return plugins.smartfile.fs.fileExistsSync(lookupPath);
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBRXZCLENBQUMsQ0FGd0M7QUFRekM7OztHQUdHO0FBQ1EsZUFBTyxHQUFHLENBQVcsVUFBb0I7SUFFaEQsMEJBQTBCO0lBQzFCLEVBQUUsQ0FBQyxDQUNDLE9BQU8sVUFBVSxDQUFDLFFBQVEsS0FBSyxTQUFTO1dBQ3JDLE9BQU8sVUFBVSxDQUFDLGVBQWUsS0FBSyxTQUM3QyxDQUFDLENBQUMsQ0FBQztRQUNDLElBQUksaUJBQWlCLEdBQUcsRUFBRSxDQUFBO1FBQzFCLGlCQUFpQixDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsR0FBRyxVQUFVLENBQUMsZUFBZSxDQUFBO1FBQ25FLFVBQVUsQ0FBQyxlQUFlLEdBQUcsaUJBQWlCLENBQUE7SUFDbEQsQ0FBQztJQUFBLENBQUM7SUFFRixrQkFBa0I7SUFDbEIsSUFBSSxVQUFrQixDQUFBO0lBQ3RCLEVBQUUsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO1FBQ2pCLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsR0FBRyxFQUFDLGVBQWUsQ0FBQyxDQUFBO0lBQ2xFLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLFVBQVUsR0FBRyxLQUFLLENBQUMsVUFBVSxDQUFBO0lBQ2pDLENBQUM7SUFBQSxDQUFDO0lBRUYsY0FBYztJQUNkLElBQUksT0FBTyxDQUFBO0lBQ1gsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsY0FBYyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNsRCxPQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxFQUFFLENBQUMsWUFBWSxDQUFDLFVBQVUsQ0FBQyxDQUFBO0lBQzNELENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLEdBQUcsVUFBVSxjQUFjLENBQUMsQ0FBQTtRQUNuRCxPQUFPLEdBQUcsRUFBRSxDQUFBO0lBQ2hCLENBQUM7SUFBQSxDQUFDO0lBRUYsa0JBQWtCO0lBQ2xCLE9BQU8sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxFQUFFLEVBQUMsVUFBVSxDQUFDLGVBQWUsRUFBQyxPQUFPLENBQUMsQ0FBQTtJQUNyRSxFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQztRQUN0QixFQUFFLENBQUMsQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUMvQixNQUFNLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQTtRQUN2QyxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyx3QkFBd0IsVUFBVSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUE7WUFDdEUsTUFBTSxDQUFDLFNBQVMsQ0FBQTtRQUNwQixDQUFDO0lBQ0wsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osTUFBTSxDQUFDLE9BQU8sQ0FBQTtJQUNsQixDQUFDO0FBQ0wsQ0FBQyxDQUFBO0FBRUQ7O0dBRUc7QUFDUSx5QkFBaUIsR0FBRyxDQUFDLFVBQTBCO0lBQ3RELElBQUksVUFBa0IsQ0FBQTtJQUN0QixFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNqQixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQTtJQUNsRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQTtJQUNqQyxDQUFDO0lBQUEsQ0FBQztJQUNGLE1BQU0sQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsVUFBVSxDQUFDLENBQUE7QUFDMUQsQ0FBQyxDQUFBIn0=
+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
--- a/dist/npmextra.classes.keyValueStore.d.ts
+++ b/dist/npmextra.classes.keyValueStore.d.ts
@ -3,4 +3,16 @@ 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;
 }
--- a/dist/npmextra.classes.keyValueStore.js
+++ b/dist/npmextra.classes.keyValueStore.js
@ -1,22 +1,22 @@
 "use strict";
-/**
- * reads a keyValueFile from disk
- */
-let kvRead = () => {
-};
-/**
- * writes a key value file to disk
- */
-let kvWrite = () => {
-};
-/**
- * wipes a key value store from disk
- */
-let kevWipe = () => {
-};
 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5rZXlWYWx1ZVN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtZXh0cmEuY2xhc3Nlcy5rZXlWYWx1ZVN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFJQTs7R0FFRztBQUNILElBQUksTUFBTSxHQUFHO0FBRWIsQ0FBQyxDQUFBO0FBRUQ7O0dBRUc7QUFDSCxJQUFJLE9BQU8sR0FBRztBQUVkLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ0gsSUFBSSxPQUFPLEdBQUc7QUFFZCxDQUFDLENBQUE7QUFFRDtJQUNJLFlBQVksVUFFWDtJQUVELENBQUM7QUFDTCxDQUFDO0FBTlkscUJBQWEsZ0JBTXpCLENBQUEifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5rZXl2YWx1ZXN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtZXh0cmEuY2xhc3Nlcy5rZXl2YWx1ZXN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFLQTtJQUNJLFlBQVksVUFFWDtJQUVELENBQUM7SUFDRDs7R0FFRDtJQUNDLE1BQU07SUFFTixDQUFDO0lBRUQ7O09BRUc7SUFDSCxPQUFPO0lBRVAsQ0FBQztJQUVEOztPQUVHO0lBQ0gsT0FBTztJQUVQLENBQUM7Q0FDSjtBQTFCRCxzQ0EwQkMifQ==
--- a/dist/npmextra.classes.npmextra.d.ts
+++ b/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();
+}
--- a/dist/npmextra.classes.npmextra.js
+++ b/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==
--- a/dist/npmextra.paths.js
+++ b/dist/npmextra.paths.js
@ -1,8 +1,8 @@
 "use strict";
-const plugins = require('./npmextra.plugins');
+const plugins = require("./npmextra.plugins");
 // directories
 exports.cwd = process.cwd();
 exports.packageDir = plugins.path.join(__dirname, '../');
 // files
 exports.configFile = plugins.path.join(exports.cwd, 'npmextra.json');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1leHRyYS5wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBR3pCLENBQUMsQ0FINEM7QUFFN0MsY0FBYztBQUNILFdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7QUFDbkIsa0JBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUMsS0FBSyxDQUFDLENBQUE7QUFFMUQsUUFBUTtBQUNHLGtCQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsV0FBRyxFQUFDLGVBQWUsQ0FBQyxDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGF0aHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1leHRyYS5wYXRocy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsOENBQTZDO0FBRTdDLGNBQWM7QUFDSCxRQUFBLEdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7QUFDbkIsUUFBQSxVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLEtBQUssQ0FBQyxDQUFBO0FBRTFELFFBQVE7QUFDRyxRQUFBLFVBQVUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxXQUFHLEVBQUMsZUFBZSxDQUFDLENBQUEifQ==
--- a/dist/npmextra.plugins.js
+++ b/dist/npmextra.plugins.js
@ -1,8 +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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQ1AsQ0FBQyxDQURzQjtBQUNULGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUE7QUFDaEMsY0FBTSxXQUFXLFFBQVEsQ0FBQyxDQUFBO0FBQzFCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQTtBQUN0QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFBO0FBQ2hDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQSJ9
+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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWV4dHJhLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2Qix5Q0FBOEM7QUFDOUMsbUNBQXdDO0FBQ3hDLCtCQUFvQztBQUNwQyx5Q0FBOEM7QUFDOUMseUJBQThCIn0=
--- a/package.json
+++ b/package.json
@ -1,6 +1,6 @@
 {
  "name": "npmextra",
-  "version": "1.0.10",
+  "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"
  }
 }
--- a/test/test.d.ts
+++ b/test/test.d.ts
@ -1,2 +1 @@
-import "typings-test";
-import "should";
+import 'typings-test';
--- a/test/test.js
+++ b/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=
--- a/test/test.ts
+++ b/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)
+    })
+})
--- a/ts/index.ts
+++ b/ts/index.ts
@ -1,68 +1,4 @@
 import * as plugins from './npmextra.plugins'
-import * as paths from './npmextra.paths'

-export interface IDataFor {
-    toolName: string
-    defaultSettings?
-    cwd?: string
-}
-
-/**
- * gets you the configuration data for
- * @executes SYNC
- */
-export let dataFor = <IOptions>(optionsArg: IDataFor): IOptions => {
-
-    // 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
-    }
-}
-
-/**
- * tells you if a configfile is present
- */
-export let configFilePresent = (optionsArg: {cwd?: string}): boolean => {
-    let lookupPath: string
-    if (optionsArg.cwd) {
-        lookupPath = plugins.path.join(optionsArg.cwd,'npmextra.json')
-    } else {
-        lookupPath = paths.configFile
-    };
-    return plugins.smartfile.fs.fileExistsSync(lookupPath)
-}
+export * from './npmextra.classes.npmextra'
+export * from './npmextra.classes.keyvaluestore'
--- a/ts/npmextra.classes.keyvaluestore.ts
+++ b/ts/npmextra.classes.keyvaluestore.ts
@ -2,31 +2,31 @@ import * as plugins from './npmextra.plugins'

 export type keyValueStoreTypes = 'path' | 'gitProject'

-/**
- * reads a keyValueFile from disk
- */
-let kvRead = () => {
-
-}
-
-/**
- * writes a key value file to disk
- */
-let kvWrite = () => {
-
-}
-
-/**
- * wipes a key value store from disk
- */
-let kevWipe = () => {
-
-}

 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() {
+
    }
 }
--- a/ts/npmextra.classes.npmextra.ts
+++ b/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)
+        }
+    }
+
+}
Author	SHA1	Message	Date
PhilKunz	b1f8c79b8d	2.0.1	2016-09-24 16:52:41 +02:00
PhilKunz	b0dbb9b8a0	added back ts generics	2016-09-24 16:52:38 +02:00
PhilKunz	83108ce02d	2.0.0	2016-09-24 16:44:52 +02:00
PhilKunz	2911dd4972	added new NpmExtra class	2016-09-24 16:44:48 +02:00
PhilKunz	16150541b0	update changes	2016-09-23 22:13:06 +02:00
PhilKunz	002f3fc82d	1.0.12	2016-09-18 16:10:24 +02:00
PhilKunz	6925c2dbd0	compiled	2016-09-18 16:10:07 +02:00
PhilKunz	156b64b699	improve README	2016-09-18 16:09:27 +02:00
PhilKunz	77da229633	1.0.11	2016-09-17 18:12:59 +02:00
PhilKunz	0cbea12067	fix README	2016-09-17 18:12:32 +02:00