fix: add first param titles to logs where missing

lukekarrys · lukekarrys · commit ba6d9a878852 · 2024-05-15T12:05:47.000-07:00
diff --git a/lib/commands/audit.js b/lib/commands/audit.js
@@ -90,7 +90,7 @@ class Audit extends ArboristWorkspaceCmd {
       )
     }
 
-    log.verbose('loading installed dependencies')
+    log.verbose('audit', 'loading installed dependencies')
     const Arborist = require('@npmcli/arborist')
     const opts = {
       ...this.npm.flatOptions,
diff --git a/lib/commands/cache.js b/lib/commands/cache.js
@@ -132,7 +132,7 @@ class Cache extends BaseCommand {
       try {
         entry = await cacache.get(cachePath, key)
       } catch (err) {
-        log.warn(`Not Found: ${key}`)
+        log.warn('cache', `Not Found: ${key}`)
         break
       }
       output.standard(`Deleted: ${key}`)
diff --git a/tap-snapshots/test/lib/commands/shrinkwrap.js.test.cjs b/tap-snapshots/test/lib/commands/shrinkwrap.js.test.cjs
@@ -49,7 +49,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with hidden lockfile ancient upgrad
     "created a lockfile as npm-shrinkwrap.json with version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
   ]
 }
 `
@@ -98,7 +98,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with hidden lockfile existing downg
     "created a lockfile as npm-shrinkwrap.json with version 1"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v2 -> v1"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v1"
   ]
 }
 `
@@ -125,7 +125,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with hidden lockfile existing upgra
     "created a lockfile as npm-shrinkwrap.json with version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v2 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v3"
   ]
 }
 `
@@ -188,7 +188,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json ancient >
     "npm-shrinkwrap.json updated to version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
   ]
 }
 `
@@ -217,7 +217,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json ancient up
     "npm-shrinkwrap.json updated to version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
   ]
 }
 `
@@ -266,7 +266,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json existing d
     "npm-shrinkwrap.json updated to version 1"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v2 -> v1"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v1"
   ]
 }
 `
@@ -295,7 +295,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json existing u
     "npm-shrinkwrap.json updated to version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v2 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v3"
   ]
 }
 `
@@ -322,7 +322,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json ancient > mu
     "package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
   ]
 }
 `
@@ -351,7 +351,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json ancient upgr
     "package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"
   ]
 }
 `
@@ -400,7 +400,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json existing dow
     "package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 1"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v2 -> v1"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v1"
   ]
 }
 `
@@ -429,7 +429,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json existing upg
     "package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 3"
   ],
   "warn": [
-    "Converting lock file (npm-shrinkwrap.json) from v2 -> v3"
+    "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v3"
   ]
 }
 `
diff --git a/workspaces/arborist/lib/shrinkwrap.js b/workspaces/arborist/lib/shrinkwrap.js
@@ -1153,7 +1153,8 @@ class Shrinkwrap {
       && this.originalLockfileVersion !== this.lockfileVersion
     ) {
       log.warn(
-      `Converting lock file (${relative(process.cwd(), this.filename)}) from v${this.originalLockfileVersion} -> v${this.lockfileVersion}`
+        'shrinkwrap',
+        `Converting lock file (${relative(process.cwd(), this.filename)}) from v${this.originalLockfileVersion} -> v${this.lockfileVersion}`
       )
     }
 
diff --git a/workspaces/config/lib/index.js b/workspaces/config/lib/index.js
@@ -585,7 +585,7 @@ class Config {
 
   async #loadFile (file, type) {
     // only catch the error from readFile, not from the loadObject call
-    log.silly(`config:load:file:${file}`)
+    log.silly('config', `load:file:${file}`)
     await readFile(file, 'utf8').then(
       data => {
         const parsedConfig = ini.parse(data)
@@ -684,15 +684,15 @@ class Config {
           if (w === this.localPrefix) {
             // see if there's a .npmrc file in the workspace, if so log a warning
             if (await fileExists(this.localPrefix, '.npmrc')) {
-              log.warn(`ignoring workspace config at ${this.localPrefix}/.npmrc`)
+              log.warn('config', `ignoring workspace config at ${this.localPrefix}/.npmrc`)
             }
 
             // set the workspace in the default layer, which allows it to be overridden easily
             const { data } = this.data.get('default')
             data.workspace = [this.localPrefix]
             this.localPrefix = p
             this.localPackage = hasPackageJson
-            log.info(`found workspace root at ${this.localPrefix}`)
+            log.info('config', `found workspace root at ${this.localPrefix}`)
             // we found a root, so we return now
             return
           }
diff --git a/workspaces/config/test/index.js b/workspaces/config/test/index.js
@@ -1185,7 +1185,8 @@ t.test('workspaces', async (t) => {
     t.same(config.get('workspace'), [join(path, 'workspaces', 'one')], 'set the workspace')
     const info = logs.filter(l => l[0] === 'info')
     t.equal(info.length, 1, 'got one log message')
-    t.match(info[0], ['info', /^found workspace root at/], 'logged info about workspace root')
+    t.match(info[0],
+      ['info', 'config', /^found workspace root at/], 'logged info about workspace root')
   })
 
   t.test('finds other workspace parent', async (t) => {
@@ -1207,7 +1208,8 @@ t.test('workspaces', async (t) => {
     t.same(config.get('workspace'), ['../two'], 'kept the specified workspace')
     const info = logs.filter(l => l[0] === 'info')
     t.equal(info.length, 1, 'got one log message')
-    t.match(info[0], ['info', /^found workspace root at/], 'logged info about workspace root')
+    t.match(info[0],
+      ['info', 'config', /^found workspace root at/], 'logged info about workspace root')
   })
 
   t.test('warns when workspace has .npmrc', async (t) => {
@@ -1229,8 +1231,10 @@ t.test('workspaces', async (t) => {
     t.same(config.get('workspace'), [join(path, 'workspaces', 'three')], 'kept the workspace')
     const filtered = logs.filter(l => l[0] === 'info' || l[0] === 'warn')
     t.equal(filtered.length, 2, 'got two log messages')
-    t.match(filtered[0], ['warn', /^ignoring workspace config/], 'warned about ignored config')
-    t.match(filtered[1], ['info', /^found workspace root at/], 'logged info about workspace root')
+    t.match(filtered[0],
+      ['warn', 'config', /^ignoring workspace config/], 'warned about ignored config')
+    t.match(filtered[1],
+      ['info', 'config', /^found workspace root at/], 'logged info about workspace root')
   })
 
   t.test('prefix skips auto detect', async (t) => {
@@ -1364,7 +1368,8 @@ t.test('workspaces', async (t) => {
     t.same(config.get('workspace'), [join(path, 'workspaces', 'one')], 'set the workspace')
     const filtered = logs.filter(l => l[0] !== 'silly')
     t.equal(filtered.length, 1, 'got one log message')
-    t.match(filtered[0], ['info', /^found workspace root at/], 'logged info about workspace root')
+    t.match(filtered[0],
+      ['info', 'config', /^found workspace root at/], 'logged info about workspace root')
   })
 })
 

Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ class Audit extends ArboristWorkspaceCmd {`
`90`	`90`	`)`
`91`	`91`	`}`
`92`	`92`
`93`		`- log.verbose('loading installed dependencies')`
	`93`	`+ log.verbose('audit', 'loading installed dependencies')`
`94`	`94`	`const Arborist = require('@npmcli/arborist')`
`95`	`95`	`const opts = {`
`96`	`96`	`...this.npm.flatOptions,`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ class Cache extends BaseCommand {`
`132`	`132`	`try {`
`133`	`133`	`entry = await cacache.get(cachePath, key)`
`134`	`134`	`} catch (err) {`
`135`		- log.warn(`Not Found: ${key}`)
	`135`	+ log.warn('cache', `Not Found: ${key}`)
`136`	`136`	`break`
`137`	`137`	`}`
`138`	`138`	output.standard(`Deleted: ${key}`)
Original file line number	Diff line number	Diff line change
@@ -49,7 +49,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with hidden lockfile ancient upgrad
`49`	`49`	`"created a lockfile as npm-shrinkwrap.json with version 3"`
`50`	`50`	`],`
`51`	`51`	`"warn": [`
`52`		`- "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
	`52`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
`53`	`53`	`]`
`54`	`54`	`}`
`55`	`55`	`
@@ -98,7 +98,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with hidden lockfile existing downg
`98`	`98`	`"created a lockfile as npm-shrinkwrap.json with version 1"`
`99`	`99`	`],`
`100`	`100`	`"warn": [`
`101`		`- "Converting lock file (npm-shrinkwrap.json) from v2 -> v1"`
	`101`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v1"`
`102`	`102`	`]`
`103`	`103`	`}`
`104`	`104`	`
@@ -125,7 +125,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with hidden lockfile existing upgra
`125`	`125`	`"created a lockfile as npm-shrinkwrap.json with version 3"`
`126`	`126`	`],`
`127`	`127`	`"warn": [`
`128`		`- "Converting lock file (npm-shrinkwrap.json) from v2 -> v3"`
	`128`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v3"`
`129`	`129`	`]`
`130`	`130`	`}`
`131`	`131`	`
@@ -188,7 +188,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json ancient >
`188`	`188`	`"npm-shrinkwrap.json updated to version 3"`
`189`	`189`	`],`
`190`	`190`	`"warn": [`
`191`		`- "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
	`191`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
`192`	`192`	`]`
`193`	`193`	`}`
`194`	`194`	`
@@ -217,7 +217,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json ancient up
`217`	`217`	`"npm-shrinkwrap.json updated to version 3"`
`218`	`218`	`],`
`219`	`219`	`"warn": [`
`220`		`- "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
	`220`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
`221`	`221`	`]`
`222`	`222`	`}`
`223`	`223`	`
@@ -266,7 +266,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json existing d
`266`	`266`	`"npm-shrinkwrap.json updated to version 1"`
`267`	`267`	`],`
`268`	`268`	`"warn": [`
`269`		`- "Converting lock file (npm-shrinkwrap.json) from v2 -> v1"`
	`269`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v1"`
`270`	`270`	`]`
`271`	`271`	`}`
`272`	`272`	`
@@ -295,7 +295,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with npm-shrinkwrap.json existing u
`295`	`295`	`"npm-shrinkwrap.json updated to version 3"`
`296`	`296`	`],`
`297`	`297`	`"warn": [`
`298`		`- "Converting lock file (npm-shrinkwrap.json) from v2 -> v3"`
	`298`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v3"`
`299`	`299`	`]`
`300`	`300`	`}`
`301`	`301`	`
@@ -322,7 +322,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json ancient > mu
`322`	`322`	`"package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 3"`
`323`	`323`	`],`
`324`	`324`	`"warn": [`
`325`		`- "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
	`325`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
`326`	`326`	`]`
`327`	`327`	`}`
`328`	`328`	`
@@ -351,7 +351,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json ancient upgr
`351`	`351`	`"package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 3"`
`352`	`352`	`],`
`353`	`353`	`"warn": [`
`354`		`- "Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
	`354`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v1 -> v3"`
`355`	`355`	`]`
`356`	`356`	`}`
`357`	`357`	`
@@ -400,7 +400,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json existing dow
`400`	`400`	`"package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 1"`
`401`	`401`	`],`
`402`	`402`	`"warn": [`
`403`		`- "Converting lock file (npm-shrinkwrap.json) from v2 -> v1"`
	`403`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v1"`
`404`	`404`	`]`
`405`	`405`	`}`
`406`	`406`	`
@@ -429,7 +429,7 @@ exports[`test/lib/commands/shrinkwrap.js TAP with package-lock.json existing upg
`429`	`429`	`"package-lock.json has been renamed to npm-shrinkwrap.json and updated to version 3"`
`430`	`430`	`],`
`431`	`431`	`"warn": [`
`432`		`- "Converting lock file (npm-shrinkwrap.json) from v2 -> v3"`
	`432`	`+ "shrinkwrap Converting lock file (npm-shrinkwrap.json) from v2 -> v3"`
`433`	`433`	`]`
`434`	`434`	`}`
`435`	`435`	`
Original file line number	Diff line number	Diff line change
`@@ -1153,7 +1153,8 @@ class Shrinkwrap {`
`1153`	`1153`	`&& this.originalLockfileVersion !== this.lockfileVersion`
`1154`	`1154`	`) {`
`1155`	`1155`	`log.warn(`
`1156`		- `Converting lock file (${relative(process.cwd(), this.filename)}) from v${this.originalLockfileVersion} -> v${this.lockfileVersion}`
	`1156`	`+ 'shrinkwrap',`
	`1157`	+ `Converting lock file (${relative(process.cwd(), this.filename)}) from v${this.originalLockfileVersion} -> v${this.lockfileVersion}`
`1157`	`1158`	`)`
`1158`	`1159`	`}`
`1159`	`1160`