Skip to content

log-args.md

Latest commit

 

History

History
84 lines (52 loc) · 1.51 KB

log-args.md

File metadata and controls

84 lines (52 loc) · 1.51 KB

suitescript/log-args

Enforces correct log arguments (title and details) in all Log methods.

Rule Details

If no options are provided, the rule will require both title and details.

✅ The following patterns are correct:

/* eslint suitescript/log-args: "error" */

log.debug({ title: 'Title', details: 'Details' });
/* eslint suitescript/log-args: "error" */

log.audit('Title', 'Details');
/* eslint suitescript/log-args: "error" */

log.error('', 'Details');

❌ The following patterns are incorrect:

/* eslint suitescript/log-args: "error" */

log.debug('Title');
/* eslint suitescript/log-args: "error" */

log.audit({ details: 'Details' });

Rule Options

'suitescript/log-args': [<enabled>, {
  requireTitle: <boolean>,
  requireDetails: <boolean>
}]

Note: Setting both options to false is the same as not using the rule at all. Setting both options to true is the same as not providing options.

requireTitle

default: true

Explicitly requires a title argument no matter what.

/* eslint suitescript/log-args: ["error", { requireTitle: true }] */

log.debug({ title: 'Title' });

requireDetails

default: true

Explicitly requires a details argument no matter what.

/* eslint suitescript/log-args: ["error", { requireDetails: true }] */

log.debug({ details: 'Details' });

Version

This rule was introduced in version 1.0.0.

Source