noDocumentCookie

Diagnostic Category: lint/nursery/noDocumentCookie

JavaScript (and super languages)

Since: v1.9.4

Sources:

Same as: unicorn/no-document-cookie

Description

Disallow direct assignments to document.cookie.

It’s not recommended to use document.cookie directly as it’s easy to get the string wrong. Instead, you should use the Cookie Store API.

Examples

Invalid

document.cookie = "foo=bar";

code-block.js:1:1 lint/nursery/noDocumentCookie ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Direct assigning to document.cookie is not recommended.
  
  > 1 │ document.cookie = “foo=bar”;
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Consider using the Cookie Store API.

document.cookie += "; foo=bar";

code-block.js:1:1 lint/nursery/noDocumentCookie ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Direct assigning to document.cookie is not recommended.
  
  > 1 │ document.cookie += ”; foo=bar”;
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ Consider using the Cookie Store API.

Valid

const array = document.cookie.split("; ");

await cookieStore
  .set({
    name: "foo",
    value: "bar",
    expires: Date.now() + 24 * 60 * 60,
    domain: "example.com",
})

import Cookies from 'js-cookie';

Cookies.set('foo', 'bar');

How to configure

{
  "linter": {
    "rules": {
      "nursery": {
        "noDocumentCookie": "error"
      }
    }
  }
}