chore(eslint): payload-logger proper usage works with template literals (#8660)
Improves this https://github.com/payloadcms/payload/pull/8578 to work with template literals as well, This is invalid: ```ts this.payload.logger.error('Failed to create database', err) ``` But this is valid: ```ts this.payload.logger.error(`Failed to create database ${dbName}`, err) ``` This PR fixes that <img width="577" alt="image" src="https://github.com/user-attachments/assets/b867da53-4f81-4b1b-8423-598e0419946a">
This commit is contained in:
@@ -88,7 +88,10 @@ export const connect: Connect = async function connect(
|
||||
return
|
||||
}
|
||||
} else {
|
||||
this.payload.logger.error(`Error: cannot connect to Postgres. Details: ${err.message}`, err)
|
||||
this.payload.logger.error({
|
||||
err,
|
||||
msg: `Error: cannot connect to Postgres. Details: ${err.message}`,
|
||||
})
|
||||
}
|
||||
|
||||
if (typeof this.rejectInitializing === 'function') {
|
||||
|
||||
@@ -51,7 +51,10 @@ export const connect: Connect = async function connect(
|
||||
return
|
||||
}
|
||||
} else {
|
||||
this.payload.logger.error(`Error: cannot connect to Postgres. Details: ${err.message}`, err)
|
||||
this.payload.logger.error({
|
||||
err,
|
||||
msg: `Error: cannot connect to Postgres. Details: ${err.message}`,
|
||||
})
|
||||
}
|
||||
|
||||
if (typeof this.rejectInitializing === 'function') {
|
||||
|
||||
@@ -84,7 +84,7 @@ export async function migrateReset(this: DrizzleAdapter): Promise<void> {
|
||||
},
|
||||
})
|
||||
} catch (err: unknown) {
|
||||
payload.logger.error({ error: err, msg: 'Error deleting dev migration' })
|
||||
payload.logger.error({ err, msg: 'Error deleting dev migration' })
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -98,10 +98,10 @@ export const createDatabase = async function (this: BasePostgresAdapter, args: A
|
||||
|
||||
return true
|
||||
} catch (err) {
|
||||
this.payload.logger.error(
|
||||
`Error: failed to create database ${dbName}. Details: ${err.message}`,
|
||||
this.payload.logger.error({
|
||||
err,
|
||||
)
|
||||
msg: `Error: failed to create database ${dbName}. Details: ${err.message}`,
|
||||
})
|
||||
|
||||
return false
|
||||
} finally {
|
||||
|
||||
@@ -34,11 +34,11 @@ export const rule = {
|
||||
if (isPayloadLoggerError(callee)) {
|
||||
const args = node.arguments
|
||||
|
||||
// Case 1: Single string is passed as the argument
|
||||
// Case 1: Single string / templated string is passed as the argument
|
||||
if (
|
||||
args.length === 1 &&
|
||||
args[0].type === 'Literal' &&
|
||||
typeof args[0].value === 'string'
|
||||
((args[0].type === 'Literal' && typeof args[0].value === 'string') ||
|
||||
args[0].type === 'TemplateLiteral')
|
||||
) {
|
||||
return // Valid: single string argument
|
||||
}
|
||||
@@ -67,11 +67,11 @@ export const rule = {
|
||||
return // Valid object, checked for 'err'/'error' keys
|
||||
}
|
||||
|
||||
// Case 3: Improper usage (string + error or additional err/error)
|
||||
// Case 3: Improper usage (string / templated string + error or additional err/error)
|
||||
if (
|
||||
args.length > 1 &&
|
||||
args[0].type === 'Literal' &&
|
||||
typeof args[0].value === 'string' &&
|
||||
((args[0].type === 'Literal' && typeof args[0].value === 'string') ||
|
||||
args[0].type === 'TemplateLiteral') &&
|
||||
args[1].type === 'Identifier' &&
|
||||
(args[1].name === 'err' || args[1].name === 'error')
|
||||
) {
|
||||
|
||||
@@ -14,6 +14,10 @@ ruleTester.run('no-improper-payload-logger-error', rule, {
|
||||
{
|
||||
code: "payload.logger.error('Some error message')",
|
||||
},
|
||||
// Valid: payload.logger.error with a templated string
|
||||
{
|
||||
code: 'payload.logger.error(`Some error message`)',
|
||||
},
|
||||
// Valid: *.payload.logger.error with object
|
||||
{
|
||||
code: "this.payload.logger.error({ msg: 'another message', err })",
|
||||
@@ -33,6 +37,15 @@ ruleTester.run('no-improper-payload-logger-error', rule, {
|
||||
},
|
||||
],
|
||||
},
|
||||
// Invalid: payload.logger.error with both templated string and error
|
||||
{
|
||||
code: 'payload.logger.error(`Some error message`, err)',
|
||||
errors: [
|
||||
{
|
||||
messageId: 'improperUsage',
|
||||
},
|
||||
],
|
||||
},
|
||||
// Invalid: *.payload.logger.error with both string and error
|
||||
{
|
||||
code: "this.payload.logger.error('Some error message', error)",
|
||||
|
||||
@@ -62,6 +62,6 @@ export async function migrateReset(this: BaseDatabaseAdapter): Promise<void> {
|
||||
},
|
||||
})
|
||||
} catch (err: unknown) {
|
||||
payload.logger.error({ error: err, msg: 'Error deleting dev migration' })
|
||||
payload.logger.error({ err, msg: 'Error deleting dev migration' })
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user