smallog 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tim
+
+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.

package/README.md

@@ -0,0 +1,60 @@
+# Node.js Hackathon Project
+
+### Reason For Existence 
+Regular logging bores me. Stack traces in the terminal are long,
+annoying and the dark grey colour is condescending.
+I wanted to shorten the functions themselves so I can save miliseconds aswell.
+This is just a basic wrapper.
+
+### How To Install
+Just run ```npm i smallog```
+
+### How To Use
+Put this at the top of your file
+```javascript
+const log = require('smallog');
+```
+
+Instead of your regular 
+```javascript
+console.log("Here is text" === 1);
+```
+
+Use this instead
+```javascript
+log("here is text" === 1);
+```
+
+For successes
+```javascript
+log.win("this will be green with a SUCCESS message to show you did the thing correctly!);
+```
+
+For bad bigmad
+```javascript
+log.fail("this will be red with a FAIL message and a short two-line stack trace so your whole terminal doesn't clog up.");
+```
+
+And a contrived try/ catch
+```javascript
+// example failure in action
+try {
+  a == 1 / 0;
+  log.win(a);
+} catch (e) {
+  log.fail(e);
+}
+```
+
+How about some grouping
+```javascript
+log("base");
+log.nest("nested");
+log("level 2");
+log.nest("nested");
+log("level 3");
+log.nestEnd();
+log.fail("Something went wrong");
+log.nestEnd();
+log.win("Back to base");
+```

package/index.js

@@ -0,0 +1,39 @@
+// Globals because I am evil
+
+const blue = "\x1b[34m";
+const green = "\x1b[32m";
+const red = "\x1b[31m";
+const magenta = "\x1b[95m";
+
+// this is to shorten those lengthy stack traces
+function shortStack() {
+  const stack = new Error().stack.split("\n");
+  return stack.slice(2, 4).join("\n");
+}
+
+// Generic log function
+function log(arg) {
+  return console.log(blue + arg);
+}
+
+// Success function
+log.win = function (arg) {
+  console.log(green + "[-- SUCCESS --] " + "\n" + arg);
+};
+
+// failure log function with short stack trace
+log.fail = function (arg) {
+  const trace = shortStack();
+  console.error(red + "[-- FAIL --]" + "\n" + arg + "\n" + trace);
+};
+
+// log grouping if you're into that sort of thing
+log.nest = function(arg) {
+  console.group(magenta + arg);
+}
+
+log.nestEnd = function() {
+  console.groupEnd();
+}
+
+module.exports = log;

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "smallog",
+  "version": "1.0.0",
+  "description": "Minimal console formatter",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tim-maastricht/nodejs-hackathon-project.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/tim-maastricht/nodejs-hackathon-project/issues"
+  },
+  "homepage": "https://github.com/tim-maastricht/nodejs-hackathon-project#readme"
+}