@sapphire/eslint-plugin-result

2.0.4 • Public • Published

Sapphire Logo

@sapphire/eslint-plugin-result

A TypeScript ESLint plugin for @sapphire/result

GitHub codecov npm bundle size npm

Description

There's some best practices for using @sapphire/result - such as never discarding a Result returned by a function! This ESLint plugin will help you enforce those best practices.

Features

  • Written in TypeScript
  • Fully tested

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/eslint-plugin-result

Usage

Somewhere in your ESLint configuration:

{
	"extends": ["plugin:@sapphire/result/recommended"]
}

Or

{
	"plugins": ["@sapphire/result"],
	"rules": {
		"@sapphire/result/no-discard-result": "error"
	}
}

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Donate With Address
Open Collective Click Here
Ko-fi Click Here
Patreon Click Here
PayPal Click Here

Contributors

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who already contributed to Sapphire!

Package Sidebar

Install

npm i @sapphire/eslint-plugin-result

Weekly Downloads

532

Version

2.0.4

License

MIT

Unpacked Size

22.7 kB

Total Files

5

Last publish

Collaborators

  • favna
  • vladfrangu
  • kyranet