feat: createLogger, logger

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

.attw.json

@@ -2,6 +2,10 @@
   "color": true,
   "emoji": true,
   "format": "ascii",
-  "ignoreRules": ["cjs-resolves-to-esm", "internal-resolution-error"],
+  "ignoreRules": [
+    "cjs-resolves-to-esm",
+    "internal-resolution-error",
+    "no-resolution"
+  ],
   "summary": true
 }

.codecov.yml

@@ -84,4 +84,5 @@ ignore:
   - src/internal/*.browser.mts
 
 profiling:
-  critical_files_paths: []
+  critical_files_paths:
+    - src/lib/create-logger.mts

.commitlintrc.ts

@@ -15,7 +15,10 @@ import { scopes } from '@flex-development/commitlint-config'
 const config: UserConfig = {
   extends: ['@flex-development'],
   rules: {
-    'scope-enum': [RuleConfigSeverity.Error, 'always', scopes(['chore'])]
+    'scope-enum': [RuleConfigSeverity.Error, 'always', scopes([
+      'chore',
+      'reporters'
+    ])]
   }
 }
 

.dictionary.txt

@@ -13,12 +13,13 @@ gpgsign
 hmarr
 jchen
 kaisugi
+ksort
+mkbuild
 nvmrc
 pkgs
 remarkrc
 sarif
 shfmt
-smob
 unstub
 vates
 vitest

.github/infrastructure.yml

@@ -165,7 +165,7 @@ repository:
   automated_security_fixes: true
   default_branch: main
   delete_branch_on_merge: true
-  description: logging utilities
+  description: ':knot: a small logging library'
   has_issues: true
   has_projects: true
   has_wiki: false

README.md

@@ -1,4 +1,4 @@
-# log
+# \:knot: log
 
 [![github release](https://img.shields.io/github/v/release/flex-development/log.svg?include_prereleases\&sort=semver)](https://github.com/flex-development/log/releases/latest)
 [![npm](https://img.shields.io/npm/v/@flex-development/log.svg)](https://npmjs.com/package/@flex-development/log)
@@ -10,7 +10,7 @@
 [![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat\&logo=vitest\&logoColor=ffffff)](https://vitest.dev)
 [![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat\&logo=yarn\&logoColor=ffffff)](https://yarnpkg.com)
 
-Logging utilities
+Log messages in the terminal and browser
 
 ## Contents
 
@@ -23,13 +23,15 @@ Logging utilities
 
 ## What is this?
 
-**TODO**: what is this?
+This is a small, but useful, library for logging messages in the terminal and browser consoles.
+
+Colorful messages can be logged in the terminal and browser consoles that support ANSI colors.
 
 ## Install
 
 This package is [ESM only][esm].
 
-In Node.js (version 18+) with [yarn][]:
+In Node.js with [yarn][]:
 
 ```sh
 yarn add @flex-development/log
@@ -52,7 +54,7 @@ In browsers with [`esm.sh`][esmsh]:
 
 ```html
 <script type="module">
-  import { createLogger } from 'https://esm.sh/@flex-development/log'
+  import { logger } from 'https://esm.sh/@flex-development/log'
 </script>
 ```
 

__tests__/reporters/verbose.mts

@@ -4,9 +4,9 @@
  * @see https://vitest.dev/advanced/reporters#exported-reporters
  */
 
+import colors, { type Colors } from '@flex-development/colors'
 import type { Task, TaskResultPack } from '@vitest/runner'
 import { getNames, getTests } from '@vitest/runner/utils'
-import colors, { type Colors } from 'tinyrainbow'
 import type { RunnerTask, RunnerTestFile } from 'vitest'
 import type { ConfigEnv } from 'vitest/config'
 import { DefaultReporter, type Reporter } from 'vitest/reporters'

eslint.base.config.mjs

@@ -633,6 +633,7 @@ export default [
       'no-redeclare': 0,
       'no-restricted-imports': 0,
       'no-return-await': 0,
+      'no-setter-return': 0,
       'no-shadow': 0,
       'no-sparse-arrays': 0,
       'no-throw-literal': 0,
@@ -1036,7 +1037,9 @@ export default [
   },
   {
     files: [
+      '**/*.abstract.+(mts|ts)',
       '**/*.interface.+(mts|ts)',
+      '**/abstract.*.+(mts|ts)',
       '**/interfaces/*.+(mts|ts)',
       '**/types/*.+(mts|ts)'
     ],

eslint.config.mjs

@@ -28,5 +28,17 @@ export default [
       '**/dist/',
       '**/tsconfig*temp.json'
     ]
+  },
+  {
+    files: ['src/enums/log-levels.mts'],
+    rules: {
+      'sort-keys': 0
+    }
+  },
+  {
+    files: ['src/interfaces/log-function.mts'],
+    rules: {
+      '@typescript-eslint/unified-signatures': 0
+    }
   }
 ]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flex-development/log",
-  "description": "Logging utilities",
+  "description": "Log messages in the terminal and browser",
   "version": "4.0.1-dev.3",
   "keywords": [
     "log",
@@ -41,9 +41,21 @@
       "log": "./src/index.mts",
       "default": "./dist/index.mjs"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./reporters": {
+      "log": "./src/reporters/index.mts",
+      "default": "./dist/reporters/index.mjs"
+    },
+    "./utils": {
+      "log": "./src/utils/index.mts",
+      "default": "./dist/utils/index.mjs"
+    }
   },
   "imports": {
+    "#enums/*": {
+      "log": "./src/enums/*.mts",
+      "default": "./dist/enums/*.mjs"
+    },
     "#interfaces/*": {
       "log": "./src/interfaces/*.mts",
       "default": "./dist/interfaces/*.d.mts"
@@ -61,6 +73,18 @@
       "log": "./src/internal/*.mts",
       "default": "./dist/internal/*.mjs"
     },
+    "#lib/*": {
+      "log": "./src/lib/*.mts",
+      "default": "./dist/lib/*.mjs"
+    },
+    "#logger": {
+      "log": "./src/logger.mts",
+      "default": "./dist/logger.mjs"
+    },
+    "#reporters/*": {
+      "log": "./src/reporters/*.mts",
+      "default": "./dist/reporters/*.mjs"
+    },
     "#tests/*": "./__tests__/*.mts",
     "#types/*": {
       "log": "./src/types/*.mts",
@@ -70,7 +94,7 @@
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
   "scripts": {
-    "build": "yarn clean:build; tsc -p tsconfig.build.json --noEmit false; trash ./dist/internal/*.d.mts && trash ./dist/{interfaces,types}/*.mjs",
+    "build": "yarn clean:build; tsc -p tsconfig.build.json --noEmit false; trash ./dist/{enums,internal}/*.d.*; trash ./dist/{interfaces,types}/*.mjs",
     "check:ci": "yarn dedupe --check && yarn check:format && yarn check:lint && yarn check:spelling && yarn typecheck && yarn test:cov && yarn pack && yarn check:types:build && attw package.tgz && yarn clean:pack",
     "check:format": "dprint check --incremental=false",
     "check:lint": "eslint --exit-on-fatal-error --max-warnings 0 .",
@@ -108,11 +132,10 @@
     "typecheck:ui": "yarn test:ui --typecheck --mode=typecheck"
   },
   "dependencies": {
-    "@flex-development/pathe": "4.0.1",
+    "@flex-development/colors": "1.0.0",
     "@flex-development/tutils": "6.0.0-alpha.25",
-    "is-unicode-supported": "2.1.0",
-    "smob": "1.5.0",
-    "tinyrainbow": "2.0.0"
+    "devlop": "1.1.0",
+    "is-unicode-supported": "2.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.17.3",
@@ -121,6 +144,7 @@
     "@eslint/js": "9.19.0",
     "@flex-development/commitlint-config": "1.0.1",
     "@flex-development/grease": "3.0.0-alpha.9",
+    "@flex-development/pathe": "4.0.1",
     "@stylistic/eslint-plugin": "2.13.0",
     "@tsconfig/strictest": "2.0.5",
     "@types/eslint": "9.6.1",
@@ -136,7 +160,6 @@
     "@vitest/ui": "3.0.4",
     "cross-env": "7.0.3",
     "cspell": "8.17.2",
-    "devlop": "1.1.0",
     "dprint": "0.48.0",
     "editorconfig": "2.0.0",
     "eslint": "9.19.0",