Commit ea74e076 authored by Dan Rubel's avatar Dan Rubel Committed by GitHub

move flutter user analysis options file (#8091)

* move flutter user analysis options file
* add comments referencing each of the analysis options files
parent 0d92db20
...@@ -7,8 +7,13 @@ ...@@ -7,8 +7,13 @@
# See the configuration guide for more # See the configuration guide for more
# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer # https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer
# #
# There are three similar analysis options files in the flutter repo:
# - .analysis_options (this file)
# - .analysis_options_repo
# - packages/flutter/lib/analysis_options_user.yaml
#
# This file contains the analysis options used by Flutter editors, such as Atom. # This file contains the analysis options used by Flutter editors, such as Atom.
# It is very similar to .analysis_options_flutter_analyze; # It is very similar to the .analysis_options_repo file in this same directory;
# the only difference (currently) is the public_member_api_docs option, # the only difference (currently) is the public_member_api_docs option,
# which triggers too many messages to be used in editors. # which triggers too many messages to be used in editors.
......
...@@ -7,6 +7,11 @@ ...@@ -7,6 +7,11 @@
# See the configuration guide for more # See the configuration guide for more
# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer # https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer
# #
# There are three similar analysis options files in the flutter repo:
# - .analysis_options
# - .analysis_options_repo (this file)
# - packages/flutter/lib/analysis_options_user.yaml
#
# This file contains the analysis options used by 'flutter analyze' when analyzing # This file contains the analysis options used by 'flutter analyze' when analyzing
# the flutter repository. It is very similar to .analysis_options; # the flutter repository. It is very similar to .analysis_options;
# the only difference (currently) is the public_member_api_docs option, # the only difference (currently) is the public_member_api_docs option,
......
...@@ -7,9 +7,14 @@ ...@@ -7,9 +7,14 @@
# See the configuration guide for more # See the configuration guide for more
# https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer # https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer
# #
# There are three similar analysis options files in the flutter repo:
# - .analysis_options
# - .analysis_options_repo
# - packages/flutter/lib/analysis_options_user.yaml (this file)
#
# This file contains the analysis options used by "flutter analyze" # This file contains the analysis options used by "flutter analyze"
# when analyzing code outside the flutter repository. # and the dartanalyzer when analyzing code outside the flutter repository.
# It isn't named '.analysis_options' because otherwise editors like Atom # It isn't named 'analysis_options.yaml' because otherwise editors like Atom
# would use it when analyzing the flutter tool itself. # would use it when analyzing the flutter tool itself.
# #
# When editing, make sure you keep /.analysis_options consistent. # When editing, make sure you keep /.analysis_options consistent.
......
...@@ -148,7 +148,7 @@ class AnalyzeOnce extends AnalyzeBase { ...@@ -148,7 +148,7 @@ class AnalyzeOnce extends AnalyzeBase {
options.packageMap = packages; options.packageMap = packages;
options.analysisOptionsFile = flutterRepo options.analysisOptionsFile = flutterRepo
? path.join(Cache.flutterRoot, '.analysis_options_repo') ? path.join(Cache.flutterRoot, '.analysis_options_repo')
: path.join(Cache.flutterRoot, '.analysis_options_user'); : path.join(Cache.flutterRoot, 'packages', 'flutter', 'lib', 'analysis_options_user.yaml');
AnalysisDriver analyzer = new AnalysisDriver(options); AnalysisDriver analyzer = new AnalysisDriver(options);
// TODO(pq): consider error handling // TODO(pq): consider error handling
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment