1.0.12

.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,4 +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 avoid additional complexity caused by too many configuration files.
+
+npmextra.json
+```json
+{
+    "sometool": {
+        "defaultKey1": "awesomeValueFromConfig"
+    }
+}
+```
+
+```typescript
+import * as npmextra from 'npmextra'
+
+npmextra.dataFor({
+    toolName:'sometool',
+    defaultSettings: { // 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)

dist/index.d.ts

@@ -3,4 +3,14 @@ export interface IDataFor {
     defaultSettings?: any;
     cwd?: string;
 }
-export declare let dataFor: (optionsArg: IDataFor) => any;
+/**
+ * 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;

dist/index.js

@@ -1,10 +1,14 @@
 "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) {
+    if (typeof optionsArg.toolName !== undefined
+        && typeof optionsArg.defaultSettings !== undefined) {
         let newDefaultOptions = {};
         newDefaultOptions[optionsArg.toolName] = optionsArg.defaultSettings;
         optionsArg.defaultSettings = newDefaultOptions;
@@ -13,7 +17,7 @@ exports.dataFor = (optionsArg) => {
     // set lookup path
     let lookupPath;
     if (optionsArg.cwd) {
-        lookupPath = plugins.path.join(optionsArg.cwd, "npmextra.json");
+        lookupPath = plugins.path.join(optionsArg.cwd, 'npmextra.json');
     }
     else {
         lookupPath = paths.configFile;
@@ -29,7 +33,7 @@ exports.dataFor = (optionsArg) => {
         allData = {};
     }
     ;
-    //assign all data
+    // assign all data
     allData = plugins.lodash.merge({}, optionsArg.defaultSettings, allData);
     if (optionsArg.toolName) {
         if (allData[optionsArg.toolName]) {
@@ -44,4 +48,18 @@ exports.dataFor = (optionsArg) => {
         return allData;
     }
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sb0JBQ3pCLENBQUMsQ0FENEM7QUFDN0MsTUFBWSxLQUFLLFdBQU0sa0JBQWtCLENBQUMsQ0FBQTtBQVEvQixlQUFPLEdBQUcsQ0FBQyxVQUFtQjtJQUVyQywwQkFBMEI7SUFDMUIsRUFBRSxDQUFBLENBQ0UsT0FBTyxVQUFVLENBQUMsUUFBUSxJQUFJLFNBQVM7V0FDcEMsT0FBTyxVQUFVLENBQUMsZUFBZSxJQUFJLFNBQzVDLENBQUMsQ0FBQSxDQUFDO1FBQ0UsSUFBSSxpQkFBaUIsR0FBRyxFQUFFLENBQUM7UUFDM0IsaUJBQWlCLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxHQUFHLFVBQVUsQ0FBQyxlQUFlLENBQUM7UUFDcEUsVUFBVSxDQUFDLGVBQWUsR0FBRyxpQkFBaUIsQ0FBQztJQUNuRCxDQUFDO0lBQUEsQ0FBQztJQUVGLGtCQUFrQjtJQUNsQixJQUFJLFVBQWlCLENBQUM7SUFDdEIsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxDQUFBLENBQUM7UUFDZixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQztJQUNuRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQztJQUNsQyxDQUFDO0lBQUEsQ0FBQztJQUVGLGNBQWM7SUFDZCxJQUFJLE9BQU8sQ0FBQztJQUNaLEVBQUUsQ0FBQSxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFBLENBQUM7UUFDaEQsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxHQUFHLFVBQVUsY0FBYyxDQUFDLENBQUM7UUFDcEQsT0FBTyxHQUFHLEVBQUUsQ0FBQztJQUNqQixDQUFDO0lBQUEsQ0FBQztJQUVGLGlCQUFpQjtJQUNqQixPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxFQUFDLFVBQVUsQ0FBQyxlQUFlLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDdEUsRUFBRSxDQUFBLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFBLENBQUM7UUFDcEIsRUFBRSxDQUFBLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFDO1lBQ3ZFLE1BQU0sQ0FBQyxTQUFTLENBQUM7UUFDckIsQ0FBQztJQUNMLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxPQUFPLENBQUM7SUFDbkIsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9
+/**
+ * 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsOENBQTZDO0FBQzdDLDBDQUF5QztBQVF6Qzs7O0dBR0c7QUFDUSxRQUFBLE9BQU8sR0FBRyxDQUFXLFVBQW9CO0lBRWhELDBCQUEwQjtJQUMxQixFQUFFLENBQUMsQ0FDQyxPQUFPLFVBQVUsQ0FBQyxRQUFRLEtBQUssU0FBUztXQUNyQyxPQUFPLFVBQVUsQ0FBQyxlQUFlLEtBQUssU0FDN0MsQ0FBQyxDQUFDLENBQUM7UUFDQyxJQUFJLGlCQUFpQixHQUFHLEVBQUUsQ0FBQTtRQUMxQixpQkFBaUIsQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLEdBQUcsVUFBVSxDQUFDLGVBQWUsQ0FBQTtRQUNuRSxVQUFVLENBQUMsZUFBZSxHQUFHLGlCQUFpQixDQUFBO0lBQ2xELENBQUM7SUFBQSxDQUFDO0lBRUYsa0JBQWtCO0lBQ2xCLElBQUksVUFBa0IsQ0FBQTtJQUN0QixFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNqQixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQTtJQUNsRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQTtJQUNqQyxDQUFDO0lBQUEsQ0FBQztJQUVGLGNBQWM7SUFDZCxJQUFJLE9BQU8sQ0FBQTtJQUNYLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLGNBQWMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDbEQsT0FBTyxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUMzRCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxHQUFHLFVBQVUsY0FBYyxDQUFDLENBQUE7UUFDbkQsT0FBTyxHQUFHLEVBQUUsQ0FBQTtJQUNoQixDQUFDO0lBQUEsQ0FBQztJQUVGLGtCQUFrQjtJQUNsQixPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxFQUFDLFVBQVUsQ0FBQyxlQUFlLEVBQUMsT0FBTyxDQUFDLENBQUE7SUFDckUsRUFBRSxDQUFDLENBQUMsVUFBVSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUM7UUFDdEIsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDL0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsUUFBUSxDQUFDLENBQUE7UUFDdkMsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsd0JBQXdCLFVBQVUsQ0FBQyxRQUFRLEVBQUUsQ0FBQyxDQUFBO1lBQ3RFLE1BQU0sQ0FBQyxTQUFTLENBQUE7UUFDcEIsQ0FBQztJQUNMLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxPQUFPLENBQUE7SUFDbEIsQ0FBQztBQUNMLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ1EsUUFBQSxpQkFBaUIsR0FBRyxDQUFDLFVBQTBCO0lBQ3RELElBQUksVUFBa0IsQ0FBQTtJQUN0QixFQUFFLENBQUMsQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNqQixVQUFVLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsRUFBQyxlQUFlLENBQUMsQ0FBQTtJQUNsRSxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixVQUFVLEdBQUcsS0FBSyxDQUFDLFVBQVUsQ0FBQTtJQUNqQyxDQUFDO0lBQUEsQ0FBQztJQUNGLE1BQU0sQ0FBQyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxjQUFjLENBQUMsVUFBVSxDQUFDLENBQUE7QUFDMUQsQ0FBQyxDQUFBIn0=

dist/npmextra.classes.keyValueStore.d.ts

@@ -0,0 +1,6 @@
+export declare type keyValueStoreTypes = 'path' | 'gitProject';
+export declare class KeyValueStore {
+    constructor(optionsArg: {
+        type: keyValueStoreTypes;
+    });
+}

dist/npmextra.classes.keyValueStore.js

@@ -0,0 +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) {
+    }
+}
+exports.KeyValueStore = KeyValueStore;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtZXh0cmEuY2xhc3Nlcy5rZXlWYWx1ZVN0b3JlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtZXh0cmEuY2xhc3Nlcy5rZXlWYWx1ZVN0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFJQTs7R0FFRztBQUNILElBQUksTUFBTSxHQUFHO0FBRWIsQ0FBQyxDQUFBO0FBRUQ7O0dBRUc7QUFDSCxJQUFJLE9BQU8sR0FBRztBQUVkLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ0gsSUFBSSxPQUFPLEdBQUc7QUFFZCxDQUFDLENBQUE7QUFFRDtJQUNJLFlBQVksVUFFWDtJQUVELENBQUM7Q0FDSjtBQU5ELHNDQU1DIn0=

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.7",
+  "version": "1.0.12",
   "description": "do more with npm",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -18,16 +18,16 @@
   },
   "homepage": "https://gitlab.com/pushrocks/npmextra#README",
   "dependencies": {
-    "@types/q": "^0.0.27",
-    "beautylog": "^5.0.14",
-    "lodash": "^4.13.1",
+    "@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": {
-    "@types/should": "^8.1.26",
-    "should": "^9.0.2",
+    "@types/should": "^8.1.27",
+    "should": "^11.1.0",
     "typings-test": "^1.0.1"
   }
 }

test/test.js

@@ -12,5 +12,14 @@ describe("npmextra", function () {
         });
         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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBTyxJQUFJLFdBQVcsTUFBTSxDQUFDLENBQUM7QUFDOUIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQixNQUFPLFFBQVEsV0FBVyxlQUFlLENBQUMsQ0FBQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDO1lBQzVCLFFBQVEsRUFBQyxVQUFVO1lBQ25CLGVBQWUsRUFBQyxFQUFDLFFBQVEsRUFBQyxZQUFZLEVBQUM7WUFDdkMsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQztTQUN4QyxDQUFDLENBQUM7UUFDSCxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDakQsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFzQjtBQUN0Qiw2QkFBOEI7QUFDOUIsa0JBQWdCO0FBRWhCLDBDQUEyQztBQUUzQyxRQUFRLENBQUMsVUFBVSxFQUFDO0lBQ2hCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixJQUFJLFFBQVEsR0FBRyxRQUFRLENBQUMsT0FBTyxDQUFDO1lBQzVCLFFBQVEsRUFBQyxVQUFVO1lBQ25CLGVBQWUsRUFBQyxFQUFDLFFBQVEsRUFBQyxZQUFZLEVBQUM7WUFDdkMsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQztTQUN4QyxDQUFDLENBQUM7UUFDSCxRQUFRLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsVUFBVSxDQUFDLENBQUM7SUFDakQsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsSUFBSSxRQUFRLEdBQUcsUUFBUSxDQUFDLE9BQU8sQ0FBQztZQUM1QixRQUFRLEVBQUMsVUFBVTtZQUNuQixlQUFlLEVBQUMsRUFBQyxRQUFRLEVBQUMsWUFBWSxFQUFDO1lBQ3ZDLEdBQUcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUM7U0FDeEMsQ0FBQyxDQUFDO1FBQ0gsUUFBUSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBQzdDLFFBQVEsQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2QyxDQUFDLENBQUMsQ0FBQztBQUNQLENBQUMsQ0FBQyxDQUFDIn0=

test/test.ts

@@ -13,4 +13,13 @@ describe("npmextra",function(){
         });
         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,51 +1,68 @@
-import * as plugins from "./npmextra.plugins"
-import * as paths from "./npmextra.paths";
+import * as plugins from './npmextra.plugins'
+import * as paths from './npmextra.paths'
 
 export interface IDataFor {
-    toolName:string;
-    defaultSettings?;
-    cwd?:string
+    toolName: string
+    defaultSettings?
+    cwd?: string
 }
 
-export let dataFor = (optionsArg:IDataFor) => {
-    
+/**
+ * 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;
+    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");
+    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 = {};
+        lookupPath = paths.configFile
     };
 
-    //assign all data
-    allData = plugins.lodash.merge({},optionsArg.defaultSettings,allData);
-    if(optionsArg.toolName){
-        if(allData[optionsArg.toolName]){
-            return allData[optionsArg.toolName];
+    // 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;
+            plugins.beautylog.error(`There is no data for ${optionsArg.toolName}`)
+            return undefined
         }
     } else {
-        return allData;
+        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)
+}

ts/npmextra.classes.keyValueStore.ts

@@ -0,0 +1,32 @@
+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
+    }) {
+
+    }
+}

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"
+}