ESLINT(1)

✨ ESLINT(1) ✨

okay so bestie, welcome to the ESLINT(1) manual page, aka the group chat where your JavaScript gets read for filth (affectionately) 💅

---

🌸 NAME 🌸

eslint — JavaScript

literally that's it, that's the whole name. she contains multitudes 💖

---

🦋 DESCRIPTION 🦋

okay so the vibe is: you run

eslint [options] file.js [file.js] [dir]

and eslint goes through your files and tells you what's up. you can pass one file, a bunch of files, or whole directories — she's flexible like that 🫶

🎀 Basic configuration 🎀

• --no-eslintrc — turns OFF using config from .eslintrc.*. like, ignore the config files entirely, we're doing this raw ✨
• -c, --config path::String — use THIS config instead, and it overrides whatever .eslintrc.* options were there if any exist
• --env [String] — specify environments
• --ext [String] — specify JavaScript file extensions — default: .js
• --global [String] — define global variables
• --parser String — specify the parser to be used
• --parser-options Object — specify parser options
• --resolve-plugins-relative-to path::String — a folder where plugins should be resolved from, CWD by default

💜 Specifying rules and plugins 💜

• --rulesdir [path::String] — use additional rules from this directory
• --plugin [String] — specify plugins
• --rule Object — specify rules

🔥 Fixing problems 🔥

• --fix — automatically fix problems. she's not just judging, she's helping 😭
• --fix-dry-run — automatically fix problems WITHOUT saving the changes to the file system. like a rehearsal, no commitment bestie
• --fix-type Array — specify the types of fixes to apply (problem, suggestion, layout)

🧚 Ignoring files 🧚

• --ignore-path path::String — specify path of ignore file
• --no-ignore — disable use of ignore files and patterns
• --ignore-pattern [String] — pattern of files to ignore (in addition to those in .eslintignore)

🍓 Using stdin 🍓

• --stdin — lint code provided on <STDIN> — default: false
• --stdin-filename String — specify filename to process STDIN as

💀 Handling warnings 💀

• --quiet — report errors only — default: false. sorry to the warnings, they're being silenced 🙈
• --max-warnings Int — number of warnings to trigger nonzero exit code — default: -1

🌈 Output 🌈

• -o, --output-file path::String — specify file to write report to
• -f, --format String — use a specific output format — default: stylish
• --color, --no-color — force enabling/disabling of color

⭐ Inline configuration comments ⭐

• --no-inline-config — prevent comments from changing config or rules
• --report-unused-disable-directives — adds reported errors for unused eslint-disable directives

🎀 Caching 🎀

• --cache — only check changed files — default: false
• --cache-file path::String — path to the cache file. Deprecated: use --cache-location — default: .eslintcache
• --cache-location path::String — path to the cache file or directory

👑 Miscellaneous 👑

• --init — run config initialization wizard — default: false
• --debug — output debugging information
• -h, --help — show help
• -v, --version — output the version number
• --print-config path::String — print the configuration for the given file

ngl bestie, that --cache-file one is deprecated, so maybe slide over to --cache-location instead 👀

---

that's the whole page, no cap 💖 tysm for reading, go lint something and slay ✨ this was eslint v6.4.0, dated June 2024 — mwah, periodt 🎀🦋