docs: Debug config docs by nzakas · Pull Request #18698 · eslint/eslint

nzakas · 2024-07-17T20:24:00Z

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Added a new page called "Debug Your Configuration" that explains the various ways you can figure out why your configuration isn't working the way you want.

Deploy Preview

Is there anything you'd like reviewers to focus on?

eslint-github-bot · 2024-07-17T20:24:05Z

Hi @nzakas!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.
The first letter of the tag should be in lowercase

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

netlify · 2024-07-17T20:24:20Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`040f5aa`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/66995391a6bc4000090f89cd
😎 Deploy Preview	https://deploy-preview-18698--docs-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Co-authored-by: 唯然 <weiran.zsd@outlook.com>

mdjermanovic · 2024-07-18T16:04:41Z

+**What To Do:** Run ESLint with the `--inspect-config` command line flag and pass the file to check, like this:
+
+```shell
+npx eslint file.js --inspect-config
+```


We aren't passing filenames to check to Config Inspector.

eslint/lib/cli.js

Lines 346 to 360 in 4514424

async calculateInspectConfigFlags(configFile) {

// find the config file

const {

configFilePath,

basePath,

error

} = await locateConfigFileToUse({ cwd: process.cwd(), configFile });

if (error) {

throw error;

}

return ["--config", configFilePath, "--basePath", basePath];

},

Ah right. 👍

…ug-config-docs

mdjermanovic

LGTM, thanks!

nzakas added 2 commits July 17, 2024 11:58

docs: Add Debug Config page

67adde6

docs: Add Debug Your Config page

ce03bc1

nzakas requested a review from a team as a code owner July 17, 2024 20:24

nzakas changed the title ~~Debug config docs~~ docs: Debug config docs Jul 17, 2024

eslint-github-bot Bot added the documentation Relates to ESLint's documentation label Jul 17, 2024

aladdin-add reviewed Jul 18, 2024

View reviewed changes

Comment thread docs/src/use/configure/debug.md Outdated

aladdin-add added the accepted There is consensus among the team that this change meets the criteria for inclusion label Jul 18, 2024

Update docs/src/use/configure/debug.md

48d58d6

Co-authored-by: 唯然 <weiran.zsd@outlook.com>

mdjermanovic reviewed Jul 18, 2024

View reviewed changes

nzakas added 2 commits July 18, 2024 13:40

Remove filename from inspect-config

1a4bc6b

Merge branch 'debug-config-docs' of github.com:eslint/eslint into deb…

040f5aa

…ug-config-docs

mdjermanovic approved these changes Jul 18, 2024

View reviewed changes

mdjermanovic merged commit 53b1ff0 into main Jul 18, 2024

mdjermanovic deleted the debug-config-docs branch July 18, 2024 18:29

leoo1992 mentioned this pull request Aug 17, 2024

[Snyk] Upgrade eslint from 9.7.0 to 9.8.0 leoo1992/sistema_ponto#57

Merged

drwho725 mentioned this pull request Aug 17, 2024

[Snyk] Upgrade eslint from 9.7.0 to 9.8.0 drwho725/slack-link-unfurling#41

Merged

This was referenced Aug 18, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.8.0 nodeshift/kube-service-bindings#213

Closed

[Snyk] Upgrade eslint from 8.45.0 to 9.8.0 nodeshift/openshift-rest-client#431

Closed

abdulrahman305 mentioned this pull request Aug 18, 2024

[Snyk] Upgrade eslint from 9.6.0 to 9.8.0 qenex-ai/dependabot-core-66bb8840#8

Closed

lholmquist mentioned this pull request Aug 18, 2024

[Snyk] Upgrade eslint from 8.51.0 to 9.8.0 nodeshift/opossum#874

Closed

This was referenced Aug 18, 2024

[Snyk] Upgrade @eslint/js from 9.7.0 to 9.8.0 trojs/formdata-parser#24

Closed

[Snyk] Upgrade eslint from 9.7.0 to 9.8.0 trojs/formdata-parser#25

Closed

rbaruccojr mentioned this pull request Aug 18, 2024

[Snyk] Upgrade eslint from 9.7.0 to 9.8.0 Fatal1tyBarucco/ApexTrailhead#81

Open

ekmixon mentioned this pull request Aug 19, 2024

[Snyk] Upgrade eslint from 6.8.0 to 9.8.0 ekmixon/aquasecurity-cloudsploit#140

Open

This was referenced Aug 19, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.8.0 nodeshift/kube-service-bindings#215

Closed

[Snyk] Upgrade eslint from 8.57.0 to 9.8.0 nodeshift/kube-service-bindings#216

Closed

justkmode mentioned this pull request Aug 21, 2024

[Snyk] Upgrade eslint from 9.0.0 to 9.8.0 justkmode/aws-serverless-workshops#4

Open

lholmquist mentioned this pull request Aug 21, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.8.0 nodeshift/kube-service-bindings#217

Closed

AKJUS mentioned this pull request Sep 12, 2024

[Snyk] Upgrade: , , , eslint, eslint-plugin-jsdoc, globals AKJUS/node#19

Open

This was referenced Sep 14, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.9.1 nodeshift/kube-service-bindings#226

Closed

[Snyk] Upgrade eslint from 8.57.0 to 9.9.1 nodeshift/kube-service-bindings#227

Closed

[Snyk] Upgrade eslint from 8.57.0 to 9.9.1 nodeshift/kube-service-bindings#228

Closed

jadsongmatos mentioned this pull request Sep 17, 2024

[Snyk] Upgrade: , , eslint, prisma, sass, typescript jadsongmatos/brasil-search#40

Open

lholmquist mentioned this pull request Sep 18, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.9.1 nodeshift/kube-service-bindings#229

Closed

vinitkumar mentioned this pull request Sep 18, 2024

[Snyk] Upgrade: async, bcrypt, eslint, express-session, moment, mongoose, passport, winston vinitkumar/node-twitter#349

Merged

lholmquist mentioned this pull request Sep 19, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.9.1 nodeshift/kube-service-bindings#230

Closed

This was referenced Sep 23, 2024

[Snyk] Upgrade eslint from 6.8.0 to 9.9.1 ekmixon/aquasecurity-cloudsploit#146

Open

[Snyk] Upgrade eslint from 6.8.0 to 9.10.0 ekmixon/aquasecurity-cloudsploit#147

Open

lholmquist mentioned this pull request Sep 28, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.10.0 nodeshift/kube-service-bindings#232

Closed

This was referenced Sep 29, 2024

[Snyk] Upgrade @eslint/js from 9.3.0 to 9.10.0 tygyh/godot#3

Merged

[Snyk] Upgrade eslint from 9.3.0 to 9.10.0 tygyh/godot#4

Closed

lholmquist mentioned this pull request Oct 1, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.10.0 nodeshift/kube-service-bindings#233

Closed

tygyh mentioned this pull request Oct 2, 2024

[Snyk] Upgrade eslint from 9.3.0 to 9.10.0 tygyh/godot#6

Closed

This was referenced Oct 2, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.10.0 nodeshift/kube-service-bindings#234

Closed

[Snyk] Upgrade eslint from 8.57.0 to 9.10.0 nodeshift/kube-service-bindings#235

Closed

[Snyk] Upgrade eslint from 8.57.0 to 9.10.0 nodeshift/kube-service-bindings#236

Closed

tygyh mentioned this pull request Oct 28, 2024

[Snyk] Upgrade eslint from 9.3.0 to 9.12.0 tygyh/godot#11

Closed

lholmquist mentioned this pull request Oct 28, 2024

[Snyk] Upgrade eslint from 8.57.0 to 9.12.0 nodeshift/kube-service-bindings#241

Closed

ekmixon mentioned this pull request Oct 28, 2024

[Snyk] Upgrade eslint from 6.8.0 to 9.12.0 ekmixon/aquasecurity-cloudsploit#150

Open

This was referenced Oct 29, 2024

[Snyk] Upgrade eslint from 8.57.1 to 9.12.0 nerdy-tech-com-gitub/images#7

Open

[Snyk] Upgrade eslint from 6.8.0 to 9.12.0 nerdy-tech-com-gitub/foreman#2

Open

This was referenced Oct 30, 2024

[Snyk] Upgrade eslint from 8.51.0 to 9.12.0 nodeshift/opossum#899

Closed

[Snyk] Upgrade eslint from 8.46.0 to 9.12.0 nodeshift/faas-js-runtime#369

Closed

[Snyk] Upgrade eslint from 8.57.0 to 9.12.0 nodeshift/kube-service-bindings#244

Closed

sahilbhelkar mentioned this pull request Nov 5, 2024

[Snyk] Upgrade eslint from 9.0.0 to 9.12.0 sahilbhelkar/space#4

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: Debug config docs#18698

docs: Debug config docs#18698
mdjermanovic merged 5 commits intomainfrom
debug-config-docs

nzakas commented Jul 17, 2024 •

edited

Loading

Uh oh!

eslint-github-bot Bot commented Jul 17, 2024

Uh oh!

netlify Bot commented Jul 17, 2024 •

edited

Loading

Uh oh!

Uh oh!

mdjermanovic Jul 18, 2024

Uh oh!

nzakas Jul 18, 2024

Uh oh!

mdjermanovic left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	async calculateInspectConfigFlags(configFile) {

	// find the config file
	const {
	configFilePath,
	basePath,
	error
	} = await locateConfigFileToUse({ cwd: process.cwd(), configFile });

	if (error) {
	throw error;
	}

	return ["--config", configFilePath, "--basePath", basePath];
	},

Uh oh!

Conversation

nzakas commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

Uh oh!

eslint-github-bot Bot commented Jul 17, 2024

Uh oh!

netlify Bot commented Jul 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-eslint ready!

Uh oh!

Uh oh!

mdjermanovic Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

nzakas Jul 18, 2024

Choose a reason for hiding this comment

Uh oh!

mdjermanovic left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nzakas commented Jul 17, 2024 •

edited

Loading

netlify Bot commented Jul 17, 2024 •

edited

Loading