@leostacowski/pkgs 0.0.0 → 0.0.1

package/README.md

@@ -1,35 +1,74 @@
 # @leostacowski/pkgs
 
-_"It's ugly but it's mine"._
+_"It's ugly but it's mine."_
 
 \- _Me describing my code._
 
+## Table of Contents
+
+- [Motivation](#motivation)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Modules](#modules)
+  - [@leostacowski/pkgs/logger](#leostacowskipkgslogger)
+
 ## Motivation
 
-After a long time repeatedly starting things from scratch:
+After repeatedly starting things from scratch for a long time:
 
 ```text
 I decided to finally create a centralized repo for my scripts.
 ```
 
-This decision was directly inspired by Eskil Steenberg's talk: "_[You should finish your software](https://youtu.be/EGLoKbBn-VI?si=uFVlbKIcRolcOzCy)_" from BSC 2025.
+This decision was directly inspired by Eskil Steenberg's talk: "_[You should finish your software](https://youtu.be/EGLoKbBn-VI?si=uFVlbKIcRolcOzCy)_".
 
-If you are using any of these packages and:
+If you are using any of these modules and something is breaking, or if you have a suggestion, please [open an issue](https://github.com/leostacowski/pkgs/issues/).
 
-1. Something is breaking;
-2. Have any suggestions.
+I intend to keep adding stuff to this repo as long as I continue to reinvent the wheel!
 
-Please reach out via:
+## Requirements
 
-- [Linkedin](https://www.linkedin.com/in/leonardo-ribeiro-stacowski/);
-- [Opening an Issue](https://github.com/leostacowski/pkgs/issues/).
+`node >= 22.12.0` is a _safe choice_, but let me know your luck on older releases.
 
-I intend to keep adding stuff to this repo as long as I continue to reinvent the wheel!
+## Installation
+
+```bash
+npm i @leostacowski/pkgs
+```
+
+## Usage
+
+Everything begins at the `@leostacowski/pkgs` package:
+
+```js
+import pkgs from '@leostacowski/pkgs'
+// or
+const pkgs = require('@leostacowski/pkgs').default
+```
+
+Then import what you need:
+
+```js
+import { ModuleX } from '@leostacowski/pkgs'
+// or
+const { ModuleX } = require('@leostacowski/pkgs')
+```
+
+Or import a specific module and ignore the rest:
+
+```js
+import ModuleY from '@leostacowski/pkgs/ModuleY'
+// or
+const ModuleY = require('@leostacowski/pkgs/ModuleY')
+```
+
+For usage details on each module, refer to [Modules](#modules).
 
-## Packages
+## Modules
 
-### @leostacowski/pkgs/Logger
+### @leostacowski/pkgs/logger
 
-Simple Logger that supports aliases, types, colors and other knobs.
+A simple logger that supports aliases, types, colors and other knobs.
 
-Check it's [README.md](/modules/logger/README.md) for details.
+Check its [README.md](https://github.com/leostacowski/pkgs/blob/main/modules/logger/README.md) for details.

package/modules/index.js

@@ -1 +1,7 @@
-export { default as Logger } from './logger/index.js'
+import LoggerModule from './logger/index.js'
+
+export const Logger = LoggerModule
+
+export default {
+  Logger,
+}

package/modules/logger/README.md

@@ -1 +1,240 @@
 # @leostacowski/pkgs/logger
+
+Simple Logger that supports aliases, types, colors and other knobs.
+
+> For the main package `@leostacowski/pkgs`: See the [main README.md](/README.md).
+
+# Table of Contents
+
+- [Usage](#usage)
+  - [Import](#import)
+  - [Options](#options)
+    - [_prefix_: `string`](#prefix-string)
+    - [_group_: `boolean`](#group-boolean)
+    - [_colors_: `boolean`](#colors-boolean)
+    - [_text_color_: `string`](#text_color-string)
+    - [_level_: `number`](#level-number)
+  - [Types](#types)
+  - [Examples](#examples)
+    - [Basic](#basic)
+    - [Prefix](#prefix)
+    - [Same Line](#same-line)
+    - [Level Filtering](#level-filtering)
+
+# Usage
+
+## Import
+
+From `@leostacowski/pkgs`:
+
+```js
+import { Logger } from '@leostacowski/pkgs'
+// or
+const { Logger } = require('@leostacowski/pkgs')
+```
+
+Or straight from the source:
+
+```js
+import Logger from '@leostacowski/pkgs/logger'
+// or
+const Logger = require('@leostacowski/pkgs/logger')
+```
+
+## Options
+
+When calling `Logger()`, you can customize your instance. Here are the defaults:
+
+```js
+const logger = Logger({
+  prefix: '',
+  group: true,
+  colors: true,
+  text_color: '',
+  level: 0,
+})
+```
+
+Alternatively, pass a single `string` argument, and set just `prefix`:
+
+```js
+const logger = Logger('My prefix 😉')
+```
+
+You could just ignore everything:
+
+```js
+const logger = Logger()
+```
+
+### _prefix_: `string`
+
+Defines a value to append to the output prefix.
+
+### _group_: `boolean`
+
+Toggles the use of [group](https://nodejs.org/api/console.html#consolegrouplabel) and [groupEnd](https://nodejs.org/api/console.html#consolegroupend).
+
+If `true`, uses [_prefix_](#prefix-string) as the group label.
+
+### _colors_: `boolean`
+
+Toggles the use of [ANSI colors](https://en.wikipedia.org/wiki/ANSI_escape_code) on console output. Here are the defaults:
+
+```js
+{
+  RED: {
+    code: '\x1b[91m',
+  },
+  GREEN: {
+    code: '\x1b[92m',
+  },
+  YELLOW: {
+    code: '\x1b[93m',
+  },
+  DEFAULT: {
+    code: '\x1b[94m',
+  },
+  RESET: {
+    code: '\x1b[0m',
+  },
+}
+```
+
+### _text_color_: `string`
+
+Specify your own ANSI color code for console output text.
+
+If [colors](#colors-boolean) is `false`, this option is ignored.
+
+### _level_: `number`
+
+One of:
+
+- `0`: Allows [ `DEBUG`, `SUCCESS`, `WARNING`, `ERROR` ]
+- `1`: Allows [ `WARNING`, `ERROR` ]
+- `2`: Allows [ `ERROR` ]
+
+## Types
+
+The logger supports four types of output:
+
+- **DEBUG**;
+- **SUCCESS**;
+- **WARNING**;
+- **ERROR**.
+
+Each level is aliased to support multiple ways of being emitted:
+
+- **DEBUG**:
+  - `log`;
+  - `info`;
+  - `debug`;
+  - `l`;
+  - `i`;
+  - `d`.
+- **SUCCESS**:
+  - `success`;
+  - `s`.
+- **WARNING**:
+  - `warning`;
+  - `warn`;
+  - `w`.
+- **ERROR**:
+  - `error`;
+  - `err`;
+  - `e`.
+
+This means that all of this is game:
+
+```js
+logger.log('"log" emits DEBUG')
+logger.info('"info" emits DEBUG')
+logger.debug('"debug" emits DEBUG')
+logger.l('"l" emits DEBUG')
+logger.i('"i" emits DEBUG')
+logger.d('"d" emits DEBUG')
+logger.success('"success" emits SUCESS')
+logger.s('"s" emits SUCESS')
+logger.warning('"warning" emits WARNING')
+logger.warn('"warn" emits WARNING')
+logger.w('"w" emits WARNING')
+logger.error('"error" emits ERROR')
+logger.err('"err" emits ERROR')
+logger.e('"e" emits ERROR')
+```
+
+## Examples
+
+### Basic
+
+```js
+import Logger from '@leostacowski/pkgs/logger'
+
+const logger = Logger()
+
+logger.log('Hello World!')
+```
+
+Outputs:
+
+```bash
+ > [2026-11-07T04:30:28.965Z] DEBUG:
+  Hello World!
+```
+
+### Prefix
+
+```js
+import Logger from '@leostacowski/pkgs/logger'
+
+const logger = Logger('Hello')
+
+logger.warn('World!')
+```
+
+Outputs:
+
+```bash
+ > [2026-11-07T05:23:15.708Z] WARNING Hello:
+  World!
+```
+
+### Same Line
+
+```js
+import Logger from '@leostacowski/pkgs/logger'
+
+const logger = Logger({
+  group: false,
+})
+
+logger.info('Hello World!')
+```
+
+Outputs:
+
+```bash
+ > [2026-11-07T05:25:23.193Z] DEBUG: Hello World!
+```
+
+### Level Filtering
+
+```js
+import Logger from '@leostacowski/pkgs/logger'
+
+const logger = Logger({
+  level: 2,
+})
+
+logger.log('0')
+logger.warn('1')
+logger.error('2')
+```
+
+Outputs:
+
+```bash
+ > [2026-11-07T05:30:44.055Z] ERROR:
+  2
+```

package/modules/logger/index.js

@@ -11,9 +11,6 @@ const LOGGER_COLORS = {
   DEFAULT: {
     code: '\x1b[94m',
   },
-  WHITE: {
-    code: '\x1b[37m',
-  },
   RESET: {
     code: '\x1b[0m',
   },

package/package.json

@@ -1,8 +1,16 @@
 {
   "name": "@leostacowski/pkgs",
-  "version": "0.0.0",
-  "description": "Centralized package of reusable javascript tools.",
-  "homepage": "https://github.com/leostacowski/pkgs#readme",
+  "version": "0.0.1",
+  "description": "Centralized package of reusable JavaScript tools.",
+  "homepage": "https://www.npmjs.com/package/@leostacowski/pkgs",
+  "keywords": [
+    "nodejs",
+    "javascript",
+    "npm"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
   "bugs": {
     "url": "https://github.com/leostacowski/pkgs/issues"
   },