0.0.5

README.md

@@ -1,2 +1,28 @@
-# pushrocks
-wrapper for all non-gulp npm plugins
+# smartenv
+store things about your environment and let them travel across modules
+
+## Status
+[![Build Status](https://travis-ci.org/pushrocks/smartenv.svg?branch=release)](https://travis-ci.org/pushrocks/smartenv)
+[![Dependency Status](https://david-dm.org/pushrocks/smartenv.svg)](https://david-dm.org/pushrocks/smartenv)
+[![devDependency Status](https://david-dm.org/pushrocks/smartenv/dev-status.svg)](https://david-dm.org/pushrocks/smartenv#info=devDependencies)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartenv/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartenv/master/dependencies/npm)
+[![bitHound Overalll Score](https://www.bithound.io/github/pushrocks/smartenv/badges/score.svg)](https://www.bithound.io/github/pushrocks/smartenv)
+
+## Install
+Install the package through npm
+
+```
+npm install smartenv
+```
+
+## Usage
+
+```javascript
+var smartenv = require("smartenv");
+
+smartenv.info(); //prints an output about your current environment and registered objects
+smartenv.register({akey:"a text"},"somevalue"); // register a new object
+smartenv.makeGlobal() // make smartenv available from gobal.smartenv
+smartenv.get("somevalue").akey; // returns "a text"
+smartenv.items.somevalue.akey; // also returns "a text"
+```

index.js

@@ -8,9 +8,12 @@ smartenv.items = {}; // create the items object to store items to.
 smartenv.makeGlobal = function () {
     addToGlobal(smartenv, "smartenv"); //add object smartenv as global["smartenv"]
 };
-smartenv.info = function () {
+smartenv.info = {};
+smartenv.info.node = {};
+smartenv.info.node.version = process.version;
+smartenv.info.print = function () {
     var pck = require("./package.json");
-    beautylog.log("node version is " + process.version + " and smartenv version is " + pck.version);
+    beautylog.log("node version is " + smartenv.info.node.version + " and smartenv version is " + pck.version);
     beautylog.log("the smartenv module currently holds the following properties:");
     console.log(Object.getOwnPropertyNames(smartenv.items).sort());
 };
@@ -25,4 +28,8 @@ smartenv.register = function (objectArg, paramName) {
 smartenv.get = function (keyName) {
     return smartenv.items[keyName];
 };
+smartenv.exportEnv = function () {
+};
+smartenv.importEnv = function () {
+};
 module.exports = smartenv;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartenv",
-  "version": "0.0.1",
+  "version": "0.0.5",
   "description": "store things about your environment and let them travel across modules",
   "main": "index.js",
   "scripts": {

test.js

@@ -2,10 +2,14 @@
 var smartenv = require("./index.js");
 var beautylog = require("beautylog")("os");
 beautylog.info("Now testing the smartenv module");
-smartenv.info();
+smartenv.info.print();
+beautylog.info("Now testing the smartenv module");
 smartenv.register({ key1: "Peter" }, "docit");
-smartenv.info();
+smartenv.info.print();
 beautylog.log(smartenv.get("docit").key1);
 smartenv.makeGlobal();
 beautylog.log(global.smartenv.get("docit").key1);
+var key2 = "hello";
+smartenv.get("docit").key2 = key2;
+beautylog.log(global.smartenv.get("docit").key2);
 beautylog.success("Success!");

ts/index.js

@@ -8,9 +8,12 @@ smartenv.items = {}; // create the items object to store items to.
 smartenv.makeGlobal = function () {
     addToGlobal(smartenv, "smartenv"); //add object smartenv as global["smartenv"]
 };
-smartenv.info = function () {
+smartenv.info = {};
+smartenv.info.node = {};
+smartenv.info.node.version = process.version;
+smartenv.info.print = function () {
     var pck = require("./package.json");
-    beautylog.log("node version is " + process.version + " and smartenv version is " + pck.version);
+    beautylog.log("node version is " + smartenv.info.node.version + " and smartenv version is " + pck.version);
     beautylog.log("the smartenv module currently holds the following properties:");
     console.log(Object.getOwnPropertyNames(smartenv.items).sort());
 };
@@ -25,5 +28,9 @@ smartenv.register = function (objectArg, paramName) {
 smartenv.get = function (keyName) {
     return smartenv.items[keyName];
 };
+smartenv.exportEnv = function () {
+};
+smartenv.importEnv = function () {
+};
 module.exports = smartenv;
 //# sourceMappingURL=index.js.map

ts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,IAAI,WAAW,GAAG,UAAS,SAAS,EAAC,SAAS;IAC1C,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAClC,CAAC,CAAC;AACF,IAAI,QAAQ,GAAO,EAAE,CAAC,CAAC,wBAAwB;AAC/C,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,6CAA6C;AAClE,QAAQ,CAAC,UAAU,GAAG;IAClB,WAAW,CAAC,QAAQ,EAAC,UAAU,CAAC,CAAC,CAAA,2CAA2C;AAChF,CAAC,CAAC;AAGF,QAAQ,CAAC,IAAI,GAAG;IACZ,IAAI,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpC,SAAS,CAAC,GAAG,CAAC,kBAAkB,GAAG,OAAO,CAAC,OAAO,GAAG,2BAA2B,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAChG,SAAS,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAC;IAC/E,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,QAAQ,CAAC,QAAQ,GAAG,UAAS,SAAS,EAAC,SAAuB;IAAvB,yBAAuB,GAAvB,uBAAuB;IAC1D,EAAE,CAAC,CAAC,SAAS,IAAI,WAAW,CAAC,CAAA,CAAC;QAC1B,SAAS,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC1C,MAAM,CAAC;IACX,CAAC;IACD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAC1C,CAAC,CAAC;AACF,QAAQ,CAAC,GAAG,GAAG,UAAS,OAAO;IAC3B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC,CAAA;AAED,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,IAAI,WAAW,GAAG,UAAS,SAAS,EAAC,SAAS;IAC1C,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAClC,CAAC,CAAC;AACF,IAAI,QAAQ,GAAO,EAAE,CAAC,CAAC,wBAAwB;AAC/C,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,6CAA6C;AAClE,QAAQ,CAAC,UAAU,GAAG;IAClB,WAAW,CAAC,QAAQ,EAAC,UAAU,CAAC,CAAC,CAAA,2CAA2C;AAChF,CAAC,CAAC;AAGF,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAC;AACnB,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;AACxB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;AAC7C,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG;IAClB,IAAI,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpC,SAAS,CAAC,GAAG,CAAC,kBAAkB,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,2BAA2B,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3G,SAAS,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAC;IAC/E,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACnE,CAAC,CAAC;AAEF,QAAQ,CAAC,QAAQ,GAAG,UAAS,SAAS,EAAC,SAAuB;IAAvB,yBAAuB,GAAvB,uBAAuB;IAC1D,EAAE,CAAC,CAAC,SAAS,IAAI,WAAW,CAAC,CAAA,CAAC;QAC1B,SAAS,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC1C,MAAM,CAAC;IACX,CAAC;IACD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;AAC1C,CAAC,CAAC;AACF,QAAQ,CAAC,GAAG,GAAG,UAAS,OAAO;IAC3B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,QAAQ,CAAC,SAAS,GAAG;AAErB,CAAC,CAAC;AAEF,QAAQ,CAAC,SAAS,GAAG;AAErB,CAAC,CAAC;AAEF,MAAM,CAAC,OAAO,GAAG,QAAQ,CAAC"}

ts/index.ts

@@ -10,9 +10,12 @@ smartenv.makeGlobal = function() {
 };
 
 
-smartenv.info = function() {
+smartenv.info = {};
+smartenv.info.node = {};
+smartenv.info.node.version = process.version;
+smartenv.info.print = function() {
     var pck = require("./package.json");
-    beautylog.log("node version is " + process.version + " and smartenv version is " + pck.version);
+    beautylog.log("node version is " + smartenv.info.node.version + " and smartenv version is " + pck.version);
     beautylog.log("the smartenv module currently holds the following properties:");
     console.log(Object.getOwnPropertyNames(smartenv.items).sort());
 };
@@ -26,6 +29,14 @@ smartenv.register = function(objectArg,paramName = "undefined") {
 };
 smartenv.get = function(keyName) {
     return smartenv.items[keyName];
-}
+};
+
+smartenv.exportEnv = function() {
+
+};
+
+smartenv.importEnv = function() {
+
+};
 
 module.exports = smartenv;

ts/test.js

@@ -2,11 +2,15 @@
 var smartenv = require("./index.js");
 var beautylog = require("beautylog")("os");
 beautylog.info("Now testing the smartenv module");
-smartenv.info();
+smartenv.info.print();
+beautylog.info("Now testing the smartenv module");
 smartenv.register({ key1: "Peter" }, "docit");
-smartenv.info();
+smartenv.info.print();
 beautylog.log(smartenv.get("docit").key1);
 smartenv.makeGlobal();
 beautylog.log(global.smartenv.get("docit").key1);
+var key2 = "hello";
+smartenv.get("docit").key2 = key2;
+beautylog.log(global.smartenv.get("docit").key2);
 beautylog.success("Success!");
 //# sourceMappingURL=test.js.map

ts/test.js.map

@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACrC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,OAAO,EAAC,EAAC,OAAO,CAAC,CAAC;AAC1C,QAAQ,CAAC,IAAI,EAAE,CAAC;AAChB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1C,QAAQ,CAAC,UAAU,EAAE,CAAC;AACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AACjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,IAAI,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AACrC,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC;AAC3C,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;AACtB,SAAS,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;AAClD,QAAQ,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAC,OAAO,EAAC,EAAC,OAAO,CAAC,CAAC;AAC1C,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;AACtB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1C,QAAQ,CAAC,UAAU,EAAE,CAAC;AACtB,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAEjD,IAAI,IAAI,GAAG,OAAO,CAAC;AACnB,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC;AAClC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;AAEjD,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC"}

ts/test.ts

@@ -2,10 +2,16 @@
 var smartenv = require("./index.js");
 var beautylog = require("beautylog")("os");
 beautylog.info("Now testing the smartenv module");
-smartenv.info();
+smartenv.info.print();
+beautylog.info("Now testing the smartenv module");
 smartenv.register({key1:"Peter"},"docit");
-smartenv.info();
+smartenv.info.print();
 beautylog.log(smartenv.get("docit").key1);
 smartenv.makeGlobal();
 beautylog.log(global.smartenv.get("docit").key1);
+
+var key2 = "hello";
+smartenv.get("docit").key2 = key2;
+beautylog.log(global.smartenv.get("docit").key2);
+
 beautylog.success("Success!");