@squeep/log-helper 1.0.1 → 1.0.2

package/README.md

@@ -30,10 +30,10 @@ Utilities for standardized logging.
   - `prefix` A field included before the package name.
 
   Defaults, based on directory existing in project:
-  |                | `src` | `lib` | other |
+  |  precedence -> | `lib` | `src` | other |
   |----------------|-------|-------|-------|
-  | includePackage | false | true  | false |
-  | includeVersion | false | true  | false |
+  | includePackage | true  | false | false |
+  | includeVersion | true  | false | false |
   | includePath    | true  | true  | false |
   | leftTrim       | 4     | 4     | 0     |
 

package/lib/file-scope.js

@@ -8,6 +8,32 @@
 const path = require('node:path');
 const fs = require('node:fs');
 
+
+/**
+ * @typedef {object} FileScopeOptions
+ * @property {boolean=} includePackage full package name
+ * @property {boolean=} includeVersion package version
+ * @property {boolean=} includePath when indicating filename
+ * @property {string=} prefix static string to include
+ * @property {number=} leftTrim characters to omit from start of path/filename
+ * @property {string=} errorPrefix string to include at start if an error was encountered
+ * @property {string=} delimiter joining selected components
+ */
+
+
+/**
+ * @typedef {FileScopeOptions} FileScopeOptionsInternal
+ * @property {boolean=} _errorEncountered flag if error while setting defaults
+ */
+
+
+/**
+ * @typedef {object} PackageDetails
+ * @property {string} name package name
+ * @property {string} version package version
+ */
+
+
 /**
  * Internal exception
  */
@@ -23,14 +49,9 @@ class FileScopeError extends Error {
 }
 
 
-/**
- * @typedef {object} PackageDetails
- * @property {string} name - package name
- * @property {string} version - package version
- */
 /**
  * Read and parse package.json from a path.
- * @param {string} packagePath - path to package.json
+ * @param {string} packagePath path to package.json
  * @returns {PackageDetails} selected details from package.json
  */
 function readPackageJSON(packagePath) {
@@ -47,7 +68,7 @@ function readPackageJSON(packagePath) {
 
 
 /**
- * Returns whether path p exists.
+ * Returns whether path p exists and is accessible.
  * @param {string} p path
  * @returns {boolean} exists
  */
@@ -56,7 +77,7 @@ function pathExists(p) {
     fs.statSync(p); // eslint-disable-line security/detect-non-literal-fs-filename
     return true;
   } catch (e) {
-    if (e.code !== 'ENOENT') {
+    if (!(['ENOENT', 'EACCES'].includes(e.code))) {
       throw e;
     }
     return false;
@@ -74,13 +95,8 @@ function locatePackageBase(filename) {
   let currentPath = filename;
   do {
     const d = path.dirname(currentPath);
-    try {
-      fs.statSync(path.join(d, 'package.json')); // eslint-disable-line security/detect-non-literal-fs-filename
+    if (pathExists(path.join(d, 'package.json'))) {
       return d + '/';
-    } catch (e) {
-      if (e.code !== 'ENOENT') {
-        throw e;
-      }
     }
     currentPath = d;
   } while (currentPath !== '/');
@@ -91,7 +107,7 @@ function locatePackageBase(filename) {
 /**
  * Get default options based on package directory structure.
  * @param {string} packageBase path to package root
- * @returns {object} options
+ * @returns {FileScopeOptionsInternal} options
  */
 function defaultOptions(packageBase) {
   const options = {
@@ -128,15 +144,8 @@ function defaultOptions(packageBase) {
  * Returns a function suitable for decorating a function name with
  * package information and details of the source file.
  * @param {string} filepath full path from __filename
- * @param {object=} options controlling component inclusion
- * @param {boolean=} options.includePackage full package name
- * @param {boolean=} options.includeVersion package version
- * @param {boolean=} options.includePath when indicating filename
- * @param {string=} options.prefix static string to include
- * @param {number=} options.leftTrim characters to omit from start of path/filename
- * @param {string=} options.errorPrefix string to include at start if an error was encountered
- * @param {string=} options.delimiter joining selected components
- * @returns {Function} marks up provided string with selected components
+ * @param {FileScopeOptions=} options controlling component inclusion
+ * @returns {(name: string) => string} marks up provided string with selected components
  */
 function fileScope(filepath, options) {
   let errorEncountered = false;
@@ -181,7 +190,7 @@ function fileScope(filepath, options) {
   const trimmedFilename = rightTrimmed.slice(trim);
 
   const components = [errorEncountered ? errorPrefix : '', prefix, packageIdentifier, trimmedFilename]
-    .filter((x) => x);
+    .filter(Boolean);
 
   const scope = components.join(delimiter);
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@squeep/log-helper",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Simple helpers for standardized logging",
   "main": "index.js",
   "engines": {
-    "node": ">=14.13.1"
+    "node": ">=20.13.0"
   },
   "files": [
     "lib/*.js"
@@ -14,23 +14,17 @@
     "coverage": "nyc npm test",
     "coverage-check": "nyc check-coverage",
     "eslint": "eslint index.js lib test",
-    "test": "mocha --recursive"
+    "test": "node --test",
+    "prepare": "husky"
   },
   "keywords": [],
   "author": "Justin Wind <jwind-npm@squeep.com>",
   "license": "ISC",
-  "pre-commit": [
-    "audit",
-    "eslint",
-    "coverage",
-    "coverage-check"
-  ],
   "devDependencies": {
     "@squeep/eslint-config": "^1",
     "eslint": "^9",
-    "mocha": "^10",
-    "nyc": "^15",
-    "pre-commit": "^1",
-    "sinon": "^17"
+    "husky": "^9",
+    "nyc": "^17",
+    "sinon": "^21"
   }
 }