useConsistentResponse

JavaScript (and super languages)

Summary

Diagnostic Category: lint/nursery/useConsistentResponse
This rule has an unsafe fix.
The default severity of this rule is information.

Description

Use static Response methods instead of new Response() constructor when possible.

new Response(JSON.stringify({ value: 1 })) can be simplified to Response.json(). new Response(null, { status: 301, headers: { location: 'https://example.com' } }) can be simplified to Response.redirect().

These methods are more concise and emphasize the intent of the code better, however they are not a direct replacement when additional options such as extra headers are needed.

In case of Response.redirect(), the location header must also be a full URL, because server runtimes (Node, Deno, etc.) will throw an error for relative URLs.

Examples

Invalid

1
new Response(JSON.stringify({ value: 1 }));

code-block.js:1:1 lint/nursery/useConsistentResponse  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Use Response.json() instead of new Response(JSON.stringify()).
  
  > 1 │ new Response(JSON.stringify({ value: 1 }));
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Response.json() is more concise and emphasizes the intent of the code better.
  
  ℹ Unsafe fix: Replace with Response.json().
  
    1   │ - new·Response(JSON.stringify({·value:·1·}));
      1 │ + Response.json({·value:·1·});
    2 2 │

1
new Response(JSON.stringify({ value: 0 }), {
2
    headers: {
3
        'Content-Type': 'application/json',
4
    }
5
})

code-block.js:1:1 lint/nursery/useConsistentResponse  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Use Response.json() instead of new Response(JSON.stringify()).
  
  > 1 │ new Response(JSON.stringify({ value: 0 }), {
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  > 2 │     headers: {
  > 3 │         ‘Content-Type’: ‘application/json’,
  > 4 │     }
  > 5 │ })
      │ ^^
    6 │ 
  
  ℹ Response.json() is more concise and emphasizes the intent of the code better.
  
  ℹ Unsafe fix: Replace with Response.json().
  
    1   │ - new·Response(JSON.stringify({·value:·0·}),·{
    2   │ - ····headers:·{
    3   │ - ········‘Content-Type’:·‘application/json’,
    4   │ - ····}
    5   │ - })
      1 │ + Response.json({·value:·0·})
    6 2 │

1
new Response(null, {
2
   headers: {
3
       location: 'https://example.com',
4
   },
5
   status: 302,
6
})

code-block.js:1:1 lint/nursery/useConsistentResponse  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Use Response.redirect() instead of new Response().
  
  > 1 │ new Response(null, {
      │ ^^^^^^^^^^^^^^^^^^^^
  > 2 │    headers: {
  > 3 │        location: ‘https://example.com’,
  > 4 │    },
  > 5 │    status: 302,
  > 6 │ })
      │ ^^
    7 │ 
  
  ℹ Response.redirect() is more concise and emphasizes the intent of the code better.
  
  ℹ Unsafe fix: Replace with Response.redirect().
  
    1   │ - new·Response(null,·{
    2   │ - ···headers:·{
    3   │ - ·······location:·‘https://example.com’,
    4   │ - ···},
    5   │ - ···status:·302,
    6   │ - })
      1 │ + Response.json(“https://example.com”,·302)
    7 2 │

Valid

1
// JSON.stringify() with a replacer function
2
new Response(JSON.stringify({ value: 0 }, () => {}))

1
new Response(null, {
2
   headers: {
3
       location: 'https://example.com',
4
       'x-foo': 'extra-header',
5
   },
6
   status: 302,
7
})

1
new Response(null, {
2
   headers: {
3
       location: '/relative-url',
4
   },
5
   status: 302,
6
})

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useConsistentResponse": "error"
6
      }
7
    }
8
  }
9
}