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

eslint-plugin-neverthrow

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-plugin-neverthrow

**forked from [mysticatea/template-eslint-plugin](https://github.com/mysticatea/template-eslint-plugin)**

  • 1.0.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
11K
decreased by-1.51%
Maintainers
1
Weekly downloads
 
Created
Source

forked from mysticatea/template-eslint-plugin


This is a trial of GitHub Repository Template.

Please update package.json after you created new repository with this template.

File Structure:

  • docs/rules/ is the directory to put documentation.
  • src/rules/ is the directory to put rule definitions.
  • scripts/ is the directory to put development scripts.
  • tests/ is the directory to put tests for src/.
  • .eslintignore and .eslintrc.js are the configuration to lint this repository.

Dependencies:

This template uses Jest and GitHub Actions for tests, as same as ESLint itself. If you want to use other tools, customize it.

Development Tools:

  • npm run add-rule foo command adds a rule definition.
  • npm update command updates the following stuff by the meta property of rules:
    • the header of docs/rules/*.md.
    • lib/configs/recommended.ts file.
    • lib/index.ts file.
    • the rule table in README.md file.

Below is an example of README.


eslint-plugin-neverthrow

A template for ESLint plugins.

Installation

Use npm or a compatibility tool to install.

$ npm install --save-dev eslint eslint-plugin-neverthrow

Requirements

  • Node.js v8.10.0 or newer versions.
  • ESLint v5.16.0 or newer versions.

Usage

Write your config file such as .eslintrc.yml.

plugins:
  - neverthrow
rules:
  neverthrow/must-use-result: error

See also Configuring ESLint.

Configs

  • neverthrow/recommended ... enables the recommended rules.

Rules

Possible Errors

Rule IDDescription
neverthrow/must-use-resultNot handling neverthrow result is a possible error because errors could remain unhandleds.⭐️

Semantic Versioning Policy

This plugin follows Semantic Versioning and ESLint's Semantic Versioning Policy.

Changelog

Contributing

Welcome your contribution!

See also ESLint Contribution Guide.

Development Tools

  • npm test runs tests.
  • npm run update updates the package version. And it updates src/configs/recommended.ts, lib/index.ts, and README.md's rule table. See also npm version CLI command.
  • npm run add-rule <RULE_ID> creates three files to add a new rule.

Keywords

FAQs

Package last updated on 01 Nov 2021

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