Initial commit

Author: 32graham

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Josh Graham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,35 @@
+# Yule
+
+Yule is a ES2016 decorator that helps you debug methods by logging information to
+the console both before and after invocation.
+
+## Example
+When debugging a method it is common to put console log statements at the top and bottom to observe when it is getting called and what parameters were passed to it. Yule makes the process easier, just import Yule and decorate the method(s) you want to observe.
+
+```js
+import yule from "yule";
+
+class Cat {
+  @yule
+  meow(tone) {
+    if (tone === "sassy") {
+      console.log("me-oooow");
+    } else {
+      console.log("meow");
+    }
+
+    return "purr";
+  }
+}
+
+let cat = new Cat();
+cat.meow("sassy");
+```
+
+Open up the console and you will see the following.
+
+```
+Yule: Starting method meow with args ["sassy"]
+me-oooow
+Yule: Finished method meow with result purr
+```

index.js

@@ -0,0 +1,28 @@
+const style = "color: #00B0FF"
+
+module.exports = function yule(target, key, descriptor) {
+  const original = descriptor.value;
+
+  descriptor.value = function(...args) {
+    const self = this;
+
+    return function() {
+      const methodCallback = function() {
+        console.log(`%cYule: Starting method ${key} with args`, style, args);
+
+        const result = original.apply(self, args);
+
+        if (result) {
+          console.log(`%cYule: Finished method ${key} with result`, style, result);
+        } else {
+          console.log(`%cYule: Finished method ${key}`, style)
+        }
+
+        return result;
+      };
+      return methodCallback();
+    }();
+  };
+
+  return descriptor;
+}

package.json

@@ -0,0 +1,17 @@
+{
+  "name": "yule",
+  "version": "0.1.0",
+  "description": "A function decorator that logs enter and exit to the console.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "decorator",
+    "console",
+    "log"
+  ],
+  "author": "Josh Graham",
+  "license": "MIT",
+  "registry": "npm"
+}