Add eslint `must-use` flag.

While reading through the docs of Rust’s Result type, I learned that they annotate Result with a compiler attribute that enforces a user to “do something” with the result.

It might be nice to introduce an eslint rule that does this for neverthrow.

It would prevent situations like this:

const doSomethingThatMayFail = async () => {
  await changeUserPassword() // Returns a `Result<null, DbError>`
}

Note that we haven’t checked to see if changeUserPassword actually succeeded.

---

Edit:

Learning Resources:

• https://dev.to/spukas/how-to-write-your-first-eslint-plugin-145
• https://dev.to/alexgomesdev/writing-custom-typescript-eslint-rules-how-i-learned-to-love-the-ast-15pn

[mdbetancourt]

publish eslint-plugin-neverthrow to npm

@supermacro is already published since yesterday, the reported issue was a misconfiguration in the package.json file

I will try out the plugin in our Caribou codebase and test that things are good (hopefully no more tweaks and changes)

perfect i hope hear good news from you soon

send over a well-deserved bounty 😃

thank you 😃 I wrote you on twitter, when you finished we can talk about the payment there

[mdbetancourt]

The eslint-rule must work similarly to how it works in Rust (details here). Basically, the developer must ensure that the Result is not an Err variant, or explicitly do something with an Err variant … you can see examples in the linked Rust document.

Yup i get the idea of create the lib and build the eslint plugin from rust 😃

• call the .match method
• call the .unwrapOr method
• call the ._unsafeUnwrap method

so as long as any of these methods is called eslint should be happy?