feat: @sapphire/eslint-plugin-result

[didinele]

No description provided.

[favna]

Also needs updating:

• /.npm-deprecaterc.yml
• I see that now we have to prefix the whole of @sapphire/eslint-plugin, whereas if the package would just be named eslint-plugin-result (which is in fact available) then it could just be result. Adding to my other comment about the usage that would also allow "extends": ["result/recommended"] iirc
  @vladfrangu wdyt about dropping our org prefix for this? Or alternatively eslint-plugin-sapphire-result.

Didn't review the actual code yet, just did this while waiting for a compile at work

---

Edit: So I looked up what the naming requirements are and with the current name we'd could do:

"plugins": ["@sapphire/result"]

See: https://eslint.org/docs/latest/use/configure/plugins#include-a-plugin

That has some appeal to it because it matches the actual package name, but at the same time I'm not if that very fact is a good idea. Again I defer to @vladfrangu for his input.

[vladfrangu]

• @vladfrangu wdyt about dropping our org prefix for this?

Not a fan of this, @favna. Also, doesn't using just @sapphire/result work too? (we should name this @sapphire/eslint-plugin-result too). I know it works for eslint rules (extends @sapphire)

[favna]

• @vladfrangu wdyt about dropping our org prefix for this?

Not a fan of this, @favna. Also, doesn't using just @sapphire/result work too? (we should name this @sapphire/eslint-plugin-result too). I know it works for eslint rules (extends @sapphire)

Further resolved on Discord. We're sticking to @sapphire/eslint-plugin-result.

[favna]

There appear to still be some bugs in the plugin. You can repro the error with:

1. Build all (required) packages with yarn build in the root folder
2. Add to /.eslintrc extends: "plugin:@sapphire/result/recommended"
3. cd packages/result
4. Run yarn lint
5. Observe the error:

Oops! Something went wrong! :(

ESLint: 8.28.0

TypeError: Cannot read properties of undefined (reading 'flags')
Occurred while linting /Users/favna/workspace/sapphire/utilities/packages/result/tests/Option.test.ts:832
Rule: "@sapphire/result/no-discard-result"
    at Object.getObjectFlags (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:19894:21)
    at couldContainTypeVariables (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:69657:34)
    at Object.some (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:748:25)
    at couldContainTypeVariables (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:69665:167)
    at instantiateTypeWithAlias (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:65125:18)
    at instantiateType (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:65122:37)
    at instantiateList (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:64712:34)
    at instantiateTypes (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:64726:20)
    at instantiateTypeWorker (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:65166:32)
    at instantiateTypeWithAlias (/Users/favna/workspace/sapphire/utilities/node_modules/typescript/lib/typescript.js:65139:26)