Skip to content

feat(eslint-plugin): [no-floating-promises] ignore void operator by default #2003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 10, 2020
Merged

feat(eslint-plugin): [no-floating-promises] ignore void operator by default #2003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/eslint-plugin/docs/rules/no-floating-promises.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ type Options = {
};

const defaults = {
ignoreVoid: false,
ignoreVoid: true,
ignoreIIFE: false,
};
```

Expand All @@ -76,6 +77,8 @@ void returnsPromise();
void Promise.reject('value');
```

With this option set to `true`, and if you are using `no-void`, you should turn on the [`allowAsAStatement`](https://eslint.org/docs/rules/no-void#allowasstatement) option.

### `ignoreIIFE`

This allows you to skip checking of async iife
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint-plugin/src/rules/no-floating-promises.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export default util.createRule<Options, MessageId>({
},
defaultOptions: [
{
ignoreVoid: false,
ignoreVoid: true,
ignoreIIFE: false,
},
],
Expand Down
105 changes: 53 additions & 52 deletions packages/eslint-plugin/tests/rules/no-floating-promises.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,19 +398,19 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand Down Expand Up @@ -450,19 +450,19 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -478,19 +478,19 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -508,19 +508,19 @@ async function test() {
errors: [
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 7,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 8,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -534,11 +534,11 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -553,15 +553,15 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -571,6 +571,7 @@ async function test() {
void Promise.resolve();
}
`,
options: [{ ignoreVoid: false }],
errors: [
{
line: 3,
Expand All @@ -588,7 +589,7 @@ async function test() {
errors: [
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -601,7 +602,7 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -619,19 +620,19 @@ async function test() {
errors: [
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 7,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 8,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -646,7 +647,7 @@ async function test() {
errors: [
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -664,19 +665,19 @@ async function test() {
errors: [
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 7,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 8,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -695,19 +696,19 @@ async function test() {
errors: [
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 7,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 8,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 9,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -728,11 +729,11 @@ async function test() {
errors: [
{
line: 10,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 11,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand Down Expand Up @@ -762,15 +763,15 @@ async function test() {
errors: [
{
line: 18,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 19,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 20,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -783,7 +784,7 @@ async function test() {
errors: [
{
line: 2,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -796,7 +797,7 @@ async function test() {
errors: [
{
line: 2,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -805,7 +806,7 @@ async function test() {
errors: [
{
line: 1,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -818,7 +819,7 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -834,7 +835,7 @@ async function test() {
errors: [
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -847,7 +848,7 @@ async function test() {
errors: [
{
line: 2,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -861,7 +862,7 @@ async function test() {
errors: [
{
line: 3,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand All @@ -879,19 +880,19 @@ async function test() {
errors: [
{
line: 4,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 5,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 6,
messageId: 'floating',
messageId: 'floatingVoid',
},
{
line: 7,
messageId: 'floating',
messageId: 'floatingVoid',
},
],
},
Expand Down