"Include Ignored Files" button in search panel

Development Tools IDE 2.x
1

Arduino IDE 2.1.1

There are several small buttons next to the search box in search panel,
and the description of the last button (eye-like icon) is "Include Ignored Files".

What is this button for?
What are 'Ignored Files'?

I have tried to understand the usage of the button but to fail.

2

Hi @hgycap. There are some established conventions for configuring development tools to ignore certain files in a project. This is done by adding a list of patterns to a configuration file with a special name. The "Include Ignored Files" icon on the right side of the search field of Arduino IDE's Search panel controls whether or not the search results should include any matches found in the files the project is configured for ignoring.

A common example of configuring development tools to ignore specific files in a project is the .gitignore file, which is primarily used to prevent files from being accidentally checked into a Git repository.

The full list of ignore file configuration files that are recognized by the Arduino IDE Search feature:

All these files use the same .gitignore syntax.

There is more detailed information on what ignore configuration files are recognized in the documentation of the ripgrep package that powers the Arduino IDE Search feature:

https://github.com/BurntSushi/ripgrep/blob/master/GUIDE.md#automatic-filtering

3

Hi ptillisch,

Thank you for your detailed explanation.
Now I clearly understood.

Thank you again~

4

You are welcome. I'm glad if I was able to be of assistance.

Regards,
Per

5

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.