@cto.af/log 0.0.1

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright® 2025 The @cto.af/log Authors and Contributors
+
+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,45 @@
+# @cto.af/log
+
+A thin wrapper around [Pino](https://getpino.io/#/) to insulate multiple
+projects from the dependency, and to normalize a common pattern in those
+projects.
+
+In particular:
+
+- Singleton log object.
+- Write pretty output to stdout, JSON to a file, both, or neither.
+
+## Installation
+
+```sh
+npm install @cto.af/log
+```
+
+## API
+
+Full [API documentation](http://cto-af.github.io/log/) is available.  Options
+are the Pino [options](https://getpino.io/#/docs/api?id=options) plus:
+
+- logLevel: Suitable for -v and -q CLI arguments:
+  - -3: fatal
+  - -2: error
+  - -1: warn
+  - 0: info
+  - 1: debug
+  - 2: trace.
+- logFile: Write to this file, creating the directory if needed.
+- mute: Disable stdout logging if true.
+- prettyIgnore: Ignore these comma-separated fields in the stdout.
+  Default: 'pid,hostname,name,host,port'
+
+Example:
+
+```js
+const log = getLog();
+log.info('foo');
+log.warn({clientId: 17}, 'Client %d did things', 17);
+```
+
+---
+[![Build Status](https://github.com/cto-af/log/workflows/Tests/badge.svg)](https://github.com/cto-af/log/actions?query=workflow%3ATests)
+[![codecov](https://codecov.io/github/cto-af/log/graph/badge.svg?token=tWlUsafC9g)](https://codecov.io/github/cto-af/log)

package/lib/index.d.ts

@@ -0,0 +1,40 @@
+import { pino } from 'pino';
+
+interface LogOptions extends pino.LoggerOptions<never, false> {
+    /**
+     * Increase (or decrease if negative) log verbosity by this much.
+     * -3: fatal, -2: error, -1: warn, 0: info, 1: debug, 2: trace.
+     * Useful for -qqqvvvv option processing.
+     */
+    logLevel?: number;
+    /** If a string, create this log file and write to it. */
+    logFile?: string | null;
+    /** If true, do not log to stdout. */
+    mute?: boolean;
+    /** If logFile is set, write synchronously if true (for testing). */
+    sync?: boolean;
+    /**
+     * Ignore this set of comma-separated fields when pretty printing logs
+     * to stdout.  Default: 'pid,hostname,name,host,port'.
+     */
+    prettyIgnore?: string;
+}
+/**
+ * Create a new log instance.  Mostly useful for testing.
+ *
+ * @param opts Logging options.
+ * @param bindings Extra fields to put into every log item.
+ * @returns Logging object.
+ */
+declare function createLog(opts?: LogOptions, bindings?: pino.Bindings): pino.Logger;
+/**
+ * Get a singleton logging object.  Opts and bindings are used the first time,
+ * and ignored thereafter.
+ *
+ * @param opts Logging options.
+ * @param bindings Extra fields to put into every log item.
+ * @returns Singleton logging object.
+ */
+declare function getLog(opts: LogOptions, bindings?: pino.Bindings): pino.Logger;
+
+export { type LogOptions, createLog, getLog };

package/lib/index.js

@@ -0,0 +1 @@
+import{Writable as m}from"node:stream";import{pino as o}from"pino";import u from"pino-pretty";var p=class extends m{_write(i,s,r){r(null)}};function c(l={},i){let{logLevel:s,logFile:r,mute:d=!1,sync:a=!1,prettyIgnore:f="pid,hostname,name,host,port",...n}=l;if(s!==void 0){let e=Math.round(3-s);e<1?e=1:e>6&&(e=6),n.level=o.levels.labels[e*10]}let t;if(d&&!r)t=o(n,new p);else if(r){let e=o.destination({dest:r,sync:a,append:!0,mkdir:!0});d?t=o(n,e):t=o(n,o.multistream([{level:n.level,stream:e},{level:n.level,stream:u({ignore:f})}]))}else t=o(n,u({ignore:f}));return i&&t.setBindings(i),t}var g;function y(l,i={}){return g||(g=c(l,i)),g}export{c as createLog,y as getLog};

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@cto.af/log",
+  "version": "0.0.1",
+  "decription": "",
+  "main": "lib/index.js",
+  "files": [
+    "lib/*"
+  ],
+  "type": "module",
+  "keywords": [],
+  "author": "Joe Hildebrand <joe-github@cursive.net>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cto-af/log.git"
+  },
+  "homepage": "https://github.com/cto-af/log#readme",
+  "bugs": {
+    "url": "https://github.com/cto-af/log/issues"
+  },
+  "dependencies": {
+    "pino": "9.6.0",
+    "pino-pretty": "13.0.0"
+  },
+  "packageManager": "pnpm@10.4.1",
+  "engines": {
+    "node": ">=18.13 >=19.1"
+  }
+}