Initial Commit

Author: Ambratolm

.gitignore

@@ -0,0 +1,45 @@
+# Project
+# ...
+
+# Editor
+.vscode
+*.sublime-*
+
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ambratolm
+
+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,32 @@
+# 👀 0inspect
+
+[![NPM version](https://badge.fury.io/js/0inspect.svg)](https://npmjs.org/package/0inspect)
+
+Simple utility for displaying a pretty eye-friendly colorful representation of an object for inspection purposes.
+
+![Screenshot](./screenshot.jpg?raw=true)
+
+# 📥 Install
+
+```
+npm i 0inspect
+```
+
+# 🏁 Use
+
+```js
+const $inspect = require("0inspect");
+
+$inspect(someObj);
+```
+
+# 📕 API
+
+`$inspect(obj?: Any, options?: Object);`
+- `obj: Any`: Object to inspect.
+- `options: Object` Options object.
+  - `color: Boolean`: If true, colorful output. Default: `true`.
+
+# 📃 License
+
+[MIT](./LICENSE) © [Ambratolm](https://github.com/Ambratolm)

index.js

@@ -0,0 +1,19 @@
+///══════════════════════════════════════════════════════════════════════════════
+// ■ Inspect (inspect/index.js)
+//┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
+//     Pretty string representation of object.
+//══════════════════════════════════════════════════════════════════════════════
+const check  = require("check-types");
+const chalk = require("chalk");
+
+//──────────────────────────────────────────────────────────────────────────────
+// ● Inspect
+//──────────────────────────────────────────────────────────────────────────────
+function inspect(obj, options = {}) {
+  console.log(obj);
+}
+
+//──────────────────────────────────────────────────────────────────────────────
+// ► Exports
+//──────────────────────────────────────────────────────────────────────────────
+module.exports = inspect;

package-lock.json

@@ -0,0 +1,34 @@
+{
+  "name": "0inspect",
+  "version": "0.0.0",
+  "description": "Pretty string representation of object",
+  "main": "index.js",
+  "scripts": {
+    "test": "nodemon test.js"
+  },
+  "keywords": [
+    "inspect",
+    "util",
+    "object",
+    "string",
+    "stringify",
+    "pretty",
+    "log",
+    "color"
+  ],
+  "author": "Ambratolm <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "check-types": "^11.1.2"
+  },
+  "devDependencies": {},
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/simple-works/0inspect.git"
+  },
+  "bugs": {
+    "url": "https://github.com/simple-works/0inspect/issues"
+  },
+  "homepage": "https://github.com/simple-works/0inspect#readme"
+}

package.json

@@ -0,0 +1,28 @@
+///══════════════════════════════════════════════════════════════════════════════
+// ■ Test (test.js)
+//┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
+//     This file is for test purposes only.
+//══════════════════════════════════════════════════════════════════════════════
+const inspect = require("./index");
+const values = require("./values.test");
+
+//──────────────────────────────────────────────────────────────────────────────
+// ● Test
+//──────────────────────────────────────────────────────────────────────────────
+function test() {
+  for (const key in values) {
+    console.log("─".repeat(80));
+    console.log("■", key, ":");
+    console.log("-".repeat(80));
+    for (const value of values[key]) {
+      inspect(value);
+    }
+    console.log();
+  }
+}
+
+//──────────────────────────────────────────────────────────────────────────────
+// ► Execute
+//──────────────────────────────────────────────────────────────────────────────
+process.stdout.write("\x1Bc");
+test();

test.js

@@ -0,0 +1,71 @@
+///══════════════════════════════════════════════════════════════════════════════
+// ■ Test-Values (values.test.js)
+//┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
+//     This file is for test purposes only.
+//══════════════════════════════════════════════════════════════════════════════
+
+///──────────────────────────────────────────────────────────────────────────────
+// ► Exports
+//──────────────────────────────────────────────────────────────────────────────
+module.exports = {
+  void: [undefined],
+  booleans: [false, true, new Boolean(), new Boolean("Peace")],
+  numbers: [0, 7_000_000_000, new Number(), new Number(7), Infinity, NaN],
+  strings: ["", "Peace upon You!", new String(), new String("Peace")],
+  symbols: [Symbol(), Symbol("Be in Peace :)")],
+  objects: [
+    null,
+    {},
+    {
+      a: "A",
+      b: "B",
+      c: {
+        x: "X",
+        z() {
+          return "Z";
+        },
+      },
+      o() {
+        return "O";
+      },
+    },
+    new Object(),
+    new Object({ a: "A", b: "B" }),
+  ],
+  arrays: [
+    [],
+    [undefined, undefined, undefined],
+    [null, null, null],
+    [{}, {}, {}],
+    [undefined, null, {}],
+    [
+      {
+        a: "A",
+        b: "B",
+        c: {
+          x: "X",
+          z() {
+            return "Z";
+          },
+        },
+        o() {
+          return "O";
+        },
+      },
+      null,
+      {
+        a: "A",
+        b: "B",
+      },
+    ],
+  ],
+  functions: [
+    () => {},
+    () => "Peaceful arrow function",
+    function () {},
+    function fn() {},
+    function fn() {
+      return "Peaceful function";
+    },
+  ],
+};