Skip to content
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.

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

docs: add info about dot files and dir in flat config #18239

Merged
merged 2 commits into from Apr 1, 2024

Conversation

Tanujkanti4441
Copy link
Contributor

Prerequisites checklist

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 the information that flat config doesn't ignore files or directories with name starts from dot.
some issue had been opened that mentions this #18214 and #18236

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

@Tanujkanti4441 Tanujkanti4441 requested a review from a team as a code owner March 28, 2024 08:44
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Mar 28, 2024
Copy link

netlify bot commented Mar 28, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit d5b202b
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/6607a81dd4a3620008389654
😎 Deploy Preview https://deploy-preview-18239--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Member

@aladdin-add aladdin-add left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it was mentioned in the migration guide , I'm 👍 to add it(if it helps.)

i flat config

a typo in the title. (should be in flat config?)

@Tanujkanti4441 Tanujkanti4441 changed the title docs: add info about dot files and dir i flat config docs: add info about dot files and dir flat config Mar 28, 2024
@Tanujkanti4441 Tanujkanti4441 changed the title docs: add info about dot files and dir flat config docs: add info about dot files and dir in flat config Mar 28, 2024
@@ -173,6 +173,8 @@ This configuration specifies that all of the files in the `.config` directory sh

For more information on configuring rules, see [Ignore Files](ignore).

**Note:** Unlike legecy config, by default flat config doesn't ignore files or directories having a name starts with a dot, such as `.fileName` or `.directoryName`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit of cleanup:

Suggested change
**Note:** Unlike legecy config, by default flat config doesn't ignore files or directories having a name starts with a dot, such as `.fileName` or `.directoryName`.
::: important
Glob patterns always match files and directories that begin with a dot, such as `.foo.js` or `.fixtures`, unless those files are explicitly ignored. The only dot directory ignored by default is `.git`.
:::

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! Leaving open for @nzakas to verify.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to ESLint's documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

4 participants