@locker/eslint-rule-maker

@locker/eslint-rule-maker

The @locker/eslint-rule-maker package is used to make linting rules for @locker.

Usage

Use createRule(config) when defining an eslint rule.

const { createRule } = require('@locker/eslint-rule-maker');

module.exports = createRule({
    // Add an optional meta object according to
    // https://eslint.org/docs/developer-guide/working-with-rules
    //
    // The following default values are provided:
    // `meta.fixable`: `'code'` (when specifying `rule.fix`)
    // `meta.type`: `'problem'`
    rule: {
        // The message provided to `context.report()`.
        message: 'Use of window.top is prohibited.',
        // The fix provided to `context.report()`.
        fix: 'window',
        // An array of object property paths to search for.
        search: ['window.top'],
    },
});