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

What is devtools_options.yaml? #7051

Closed
osaxma opened this issue Jan 17, 2024 · 4 comments · Fixed by #7052
Closed

What is devtools_options.yaml? #7051

osaxma opened this issue Jan 17, 2024 · 4 comments · Fixed by #7052
Assignees
Labels
devtools extensions Issues related to DevTools extensions

Comments

@osaxma
Copy link

osaxma commented Jan 17, 2024

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:

Screen Shot 2024-01-17 at 11 25 18 AM

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:

Screen Shot 2024-01-17 at 11 38 44 AM

Cheers

@feinstein
Copy link

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

@kenzieschmoll
Copy link
Member

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

@kuchaguangjie
Copy link

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

@rahul-chaudhary
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devtools extensions Issues related to DevTools extensions
Projects
None yet
5 participants