Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@locker/eslint-rule-maker

Package Overview
Dependencies
Maintainers
8
Versions
226
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@locker/eslint-rule-maker

Lightning Web Security ESLint rule maker utilities

  • 0.18.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
5.8K
decreased by-8.13%
Maintainers
8
Weekly downloads
 
Created
Source

@locker/eslint-rule-maker

Lightning Web Security ESLint rule maker utilities

Installation

$ yarn add @locker/eslint-rule-maker

Usage

Define a rule using createRule(config).

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

module.exports = createRule({
    rule: {
        // The message provided to `context.report()`.
        message: 'Use of window.top is prohibited.',
        // The array of object property paths to search for.
        search: ['window.top'],
        // The optional fix function or string provided to `context.report()`.
        // https://eslint.org/docs/developer-guide/working-with-rules#contextreport
        fix: 'window',
        // The optional meta object.
        // https://eslint.org/docs/developer-guide/working-with-rules#rule-basics
        meta: {
            // The following default values are provided:
            //     fixable: 'code' (when specifying `rule.fix`)
            //     type: 'problem'
        },
        // Choose an optional match handler from the exported `matchers` object
        // or specify a custom one. The following `matchers` are available:
        //     - `matchers.matchAsNonReadableNonWritable` (default)
        //       Reports access or assignments to matches.
        //
        //     - `matchers.matchAsNonWritable`
        //       Reports assignments to matches.
        //
        //     - `matchers.matchAsNullishAndNonWritable`
        //       Reports property access on, or assignments to, matches.
        //
        // Matchers are passed a match `data` object and should return a
        // boolean indicating whether the match succeeded. Match `data` contains
        // the following properties:
        //     - `data.context`
        //       The ESLint rule context object.
        //       https://eslint.org/docs/developer-guide/working-with-rules#the-context-object
        //
        //     - `data.identifier`
        //       The matched identifier node, e.g. representing `top`.
        //
        //     - `data.node`
        //       The matched node, e.g. representing `window.top`.
        //
        //     - `data.pattern`
        //       The matched search pattern, e.g. 'window.top'.
        onMatch: matchers.matchAsNullishAndNonWritable,
    },
});

Keywords

FAQs

Package last updated on 06 Feb 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc