What is devtools_options.yaml?

[osaxma]

A devtools_options.yaml file appeared in my project out of nowhere, and I couldn't find any information about it except that it's mentioned in #1632 .. only four results in Google when I searched for it:

I think it'd be helpful if the file had a documentation explaining what is it, what does it do, how it can be used, should it be checked in, etc.

Something Similar to pubspec.yaml and analysis_options.yaml where they have a header explaining the purpose of the files, then documentation for their tags where optional tags are commented out to know about their existence and so on.

For reference, the file I have looks like this:

Cheers

[feinstein]

@kenzieschmoll should devtools_options.yaml go into the .gitignore?

[kenzieschmoll]

@feinstein this is up to the user. This is documented here: https://docs.flutter.dev/tools/devtools/extensions#configure-extension-enablement-states

[kuchaguangjie]

So ... do you guys ignore devtools_options.yaml or not ?

[rahul-chaudhary]

From the Flutter website

Extension enablement states are stored in a devtools_options.yaml file in the root of the user's project (similar to analysis_options.yaml). This file stores per-project (or optionally, per user) settings for DevTools.

If this file is checked into source control, the specified options are configured for the project. This means that anyone who pulls a project's source code and works on the project uses the same settings.

If this file is omitted from source control, for example by adding devtools_options.yaml as an entry in the .gitignore file, then the specified options are configured separately for each user. Since each user or contributor to the project uses a local copy of the devtools_options.yaml file in this case, the specified options might differ between project contributors.