From 3a31c35ba06f2fa359b4998e83ce355f098f5ba1 Mon Sep 17 00:00:00 2001 From: Dan Rubel Date: Tue, 15 Aug 2017 08:46:42 -0400 Subject: [PATCH] Rename .analysis_options to analysis_options.yaml (#11594) --- CONTRIBUTING.md | 4 ++-- .analysis_options => analysis_options.yaml | 10 +++++----- .analysis_options_repo => analysis_options_repo.yaml | 8 ++++---- dev/docs/{.analysis_options => analysis_options.yaml} | 0 .../{.analysis_options => analysis_options.yaml} | 0 examples/flutter_gallery/BUILD.gn | 2 +- packages/flutter/BUILD.gn | 2 +- packages/flutter/lib/analysis_options_user.yaml | 6 +++--- packages/flutter_test/BUILD.gn | 2 +- packages/flutter_tools/BUILD.gn | 6 +++--- .../flutter_tools/lib/src/commands/analyze_once.dart | 2 +- .../{.analysis_options => analysis_options.yaml} | 0 .../{.analysis_options => analysis_options.yaml} | 0 .../{.analysis_options => analysis_options.yaml} | 0 .../{.analysis_options => analysis_options.yaml} | 0 .../good/{.analysis_options => analysis_options.yaml} | 0 .../{.analysis_options => analysis_options.yaml} | 0 17 files changed, 21 insertions(+), 21 deletions(-) rename .analysis_options => analysis_options.yaml (95%) rename .analysis_options_repo => analysis_options_repo.yaml (97%) rename dev/docs/{.analysis_options => analysis_options.yaml} (100%) rename dev/missing_dependency_tests/{.analysis_options => analysis_options.yaml} (100%) rename packages/flutter_tools/test/data/dart_dependencies_test/asci_casing/{.analysis_options => analysis_options.yaml} (100%) rename packages/flutter_tools/test/data/dart_dependencies_test/bad_import/{.analysis_options => analysis_options.yaml} (100%) rename packages/flutter_tools/test/data/dart_dependencies_test/bad_package/{.analysis_options => analysis_options.yaml} (100%) rename packages/flutter_tools/test/data/dart_dependencies_test/bad_path/{.analysis_options => analysis_options.yaml} (100%) rename packages/flutter_tools/test/data/dart_dependencies_test/good/{.analysis_options => analysis_options.yaml} (100%) rename packages/flutter_tools/test/data/dart_dependencies_test/syntax_error/{.analysis_options => analysis_options.yaml} (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c791b3a37..c9e947e065 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,11 +76,11 @@ main ways to run it. In either case you will want to run `flutter update-package first, or you will get version conflict issues or bogus error messages about core clases like Offset from `dart:ui`. -For a one-off, use `flutter analyze --flutter-repo`. This uses the `.analysis_options_repo` file +For a one-off, use `flutter analyze --flutter-repo`. This uses the `analysis_options_repo.yaml` file at the root of the repository for its configuration. For continuous analysis, use `flutter analyze --flutter-repo --watch`. This uses normal -`.analysis_options` files, and they can differ from package to package. +`analysis_options.yaml` files, and they can differ from package to package. If you want to see how many members are missing dartdocs, you should use the first option, providing the additional command `--dartdocs`. diff --git a/.analysis_options b/analysis_options.yaml similarity index 95% rename from .analysis_options rename to analysis_options.yaml index dfc6953ab3..a8b2e3e4f7 100644 --- a/.analysis_options +++ b/analysis_options.yaml @@ -8,13 +8,13 @@ # https://github.com/dart-lang/sdk/tree/master/pkg/analyzer#configuring-the-analyzer # # There are four similar analysis options files in the flutter repos: -# - .analysis_options (this file) -# - .analysis_options_repo +# - analysis_options.yaml (this file) +# - analysis_options_repo.yaml # - packages/flutter/lib/analysis_options_user.yaml -# - https://github.com/flutter/plugins/blob/master/.analysis_options +# - https://github.com/flutter/plugins/blob/master/analysis_options.yaml # # This file contains the analysis options used by Flutter editors, such as Atom. -# It is very similar to the .analysis_options_repo file in this same directory; +# It is very similar to the analysis_options_repo.yaml file in this same directory; # the only difference (currently) is the public_member_api_docs option, # which triggers too many messages to be used in editors. # @@ -122,7 +122,7 @@ linter: # - prefer_interpolation_to_compose_strings # not yet tested - prefer_is_empty - prefer_is_not_empty - # - public_member_api_docs # this is the only difference from .analysis_options_repo + # - public_member_api_docs # this is the only difference from analysis_options_repo.yaml # - recursive_getters # https://github.com/dart-lang/linter/issues/452 - slash_for_doc_comments - sort_constructors_first diff --git a/.analysis_options_repo b/analysis_options_repo.yaml similarity index 97% rename from .analysis_options_repo rename to analysis_options_repo.yaml index ff8e9d7dd2..d8159d8298 100644 --- a/.analysis_options_repo +++ b/analysis_options_repo.yaml @@ -8,12 +8,12 @@ # 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) +# - analysis_options.yaml +# - analysis_options_repo.yaml (this file) # - packages/flutter/lib/analysis_options_user.yaml # # 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.yaml; # the only difference (currently) is the public_member_api_docs option, # which is turned on and programmatically reduced to a single output line # indicating the # of violations for that rule. @@ -116,7 +116,7 @@ linter: # - prefer_interpolation_to_compose_strings # not yet tested - prefer_is_empty - prefer_is_not_empty - - public_member_api_docs # this is the only difference from .analysis_options_repo + - public_member_api_docs # this is the only difference from analysis_options_repo.yaml # - recursive_getters # https://github.com/dart-lang/linter/issues/452 - slash_for_doc_comments - sort_constructors_first diff --git a/dev/docs/.analysis_options b/dev/docs/analysis_options.yaml similarity index 100% rename from dev/docs/.analysis_options rename to dev/docs/analysis_options.yaml diff --git a/dev/missing_dependency_tests/.analysis_options b/dev/missing_dependency_tests/analysis_options.yaml similarity index 100% rename from dev/missing_dependency_tests/.analysis_options rename to dev/missing_dependency_tests/analysis_options.yaml diff --git a/examples/flutter_gallery/BUILD.gn b/examples/flutter_gallery/BUILD.gn index 815260a4f3..9869b42980 100644 --- a/examples/flutter_gallery/BUILD.gn +++ b/examples/flutter_gallery/BUILD.gn @@ -9,7 +9,7 @@ assert(is_fuchsia) flutter_app("flutter_gallery") { main_dart = "lib/main.dart" - analysis_options = "//lib/flutter/.analysis_options" + analysis_options = "//lib/flutter/analysis_options.yaml" deps = [ "//lib/flutter/packages/flutter", diff --git a/packages/flutter/BUILD.gn b/packages/flutter/BUILD.gn index 384487adb8..f2ebd623a2 100644 --- a/packages/flutter/BUILD.gn +++ b/packages/flutter/BUILD.gn @@ -7,7 +7,7 @@ import("//build/dart/dart_package.gni") dart_package("flutter") { package_name = "flutter" - analysis_options = "//lib/flutter/.analysis_options" + analysis_options = "//lib/flutter/analysis_options.yaml" deps = [ "//third_party/dart-pkg/pub/async", diff --git a/packages/flutter/lib/analysis_options_user.yaml b/packages/flutter/lib/analysis_options_user.yaml index c595f8fbf5..265c8572c8 100644 --- a/packages/flutter/lib/analysis_options_user.yaml +++ b/packages/flutter/lib/analysis_options_user.yaml @@ -8,8 +8,8 @@ # 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 +# - analysis_options.yaml +# - analysis_options_repo.yaml # - packages/flutter/lib/analysis_options_user.yaml (this file) # # This file contains the analysis options used by "flutter analyze" @@ -17,7 +17,7 @@ # It isn't named 'analysis_options.yaml' because otherwise editors like Atom # 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.yaml consistent. analyzer: language: diff --git a/packages/flutter_test/BUILD.gn b/packages/flutter_test/BUILD.gn index af66a8d97a..281a1660f0 100644 --- a/packages/flutter_test/BUILD.gn +++ b/packages/flutter_test/BUILD.gn @@ -7,7 +7,7 @@ import("//build/dart/dart_package.gni") dart_package("flutter_test") { package_name = "flutter_test" - analysis_options = "//lib/flutter/.analysis_options" + analysis_options = "//lib/flutter/analysis_options.yaml" deps = [ "//lib/flutter/packages/flutter", diff --git a/packages/flutter_tools/BUILD.gn b/packages/flutter_tools/BUILD.gn index 7853b56052..bf5f478965 100644 --- a/packages/flutter_tools/BUILD.gn +++ b/packages/flutter_tools/BUILD.gn @@ -8,7 +8,7 @@ import("//build/dart/dart_tool.gni") dart_package("flutter_tools") { package_name = "flutter_tools" - analysis_options = "//lib/flutter/.analysis_options" + analysis_options = "//lib/flutter/analysis_options.yaml" deps = [ "//dart/pkg/analyzer", @@ -42,7 +42,7 @@ dart_package("flutter_tools") { dart_tool("fuchsia_builder") { main_dart = "bin/fuchsia_builder.dart" - analysis_options = "//lib/flutter/.analysis_options" + analysis_options = "//lib/flutter/analysis_options.yaml" deps = [ ":flutter_tools", @@ -52,7 +52,7 @@ dart_tool("fuchsia_builder") { dart_tool("fuchsia_tester") { main_dart = "bin/fuchsia_tester.dart" - analysis_options = "//lib/flutter/.analysis_options" + analysis_options = "//lib/flutter/analysis_options.yaml" deps = [ ":flutter_tools", diff --git a/packages/flutter_tools/lib/src/commands/analyze_once.dart b/packages/flutter_tools/lib/src/commands/analyze_once.dart index 1034250757..66b374c43f 100644 --- a/packages/flutter_tools/lib/src/commands/analyze_once.dart +++ b/packages/flutter_tools/lib/src/commands/analyze_once.dart @@ -147,7 +147,7 @@ class AnalyzeOnce extends AnalyzeBase { final DriverOptions options = new DriverOptions(); options.dartSdkPath = argResults['dart-sdk']; options.packageMap = packages; - options.analysisOptionsFile = fs.path.join(Cache.flutterRoot, '.analysis_options_repo'); + options.analysisOptionsFile = fs.path.join(Cache.flutterRoot, 'analysis_options_repo.yaml'); final AnalysisDriver analyzer = new AnalysisDriver(options); // TODO(pq): consider error handling diff --git a/packages/flutter_tools/test/data/dart_dependencies_test/asci_casing/.analysis_options b/packages/flutter_tools/test/data/dart_dependencies_test/asci_casing/analysis_options.yaml similarity index 100% rename from packages/flutter_tools/test/data/dart_dependencies_test/asci_casing/.analysis_options rename to packages/flutter_tools/test/data/dart_dependencies_test/asci_casing/analysis_options.yaml diff --git a/packages/flutter_tools/test/data/dart_dependencies_test/bad_import/.analysis_options b/packages/flutter_tools/test/data/dart_dependencies_test/bad_import/analysis_options.yaml similarity index 100% rename from packages/flutter_tools/test/data/dart_dependencies_test/bad_import/.analysis_options rename to packages/flutter_tools/test/data/dart_dependencies_test/bad_import/analysis_options.yaml diff --git a/packages/flutter_tools/test/data/dart_dependencies_test/bad_package/.analysis_options b/packages/flutter_tools/test/data/dart_dependencies_test/bad_package/analysis_options.yaml similarity index 100% rename from packages/flutter_tools/test/data/dart_dependencies_test/bad_package/.analysis_options rename to packages/flutter_tools/test/data/dart_dependencies_test/bad_package/analysis_options.yaml diff --git a/packages/flutter_tools/test/data/dart_dependencies_test/bad_path/.analysis_options b/packages/flutter_tools/test/data/dart_dependencies_test/bad_path/analysis_options.yaml similarity index 100% rename from packages/flutter_tools/test/data/dart_dependencies_test/bad_path/.analysis_options rename to packages/flutter_tools/test/data/dart_dependencies_test/bad_path/analysis_options.yaml diff --git a/packages/flutter_tools/test/data/dart_dependencies_test/good/.analysis_options b/packages/flutter_tools/test/data/dart_dependencies_test/good/analysis_options.yaml similarity index 100% rename from packages/flutter_tools/test/data/dart_dependencies_test/good/.analysis_options rename to packages/flutter_tools/test/data/dart_dependencies_test/good/analysis_options.yaml diff --git a/packages/flutter_tools/test/data/dart_dependencies_test/syntax_error/.analysis_options b/packages/flutter_tools/test/data/dart_dependencies_test/syntax_error/analysis_options.yaml similarity index 100% rename from packages/flutter_tools/test/data/dart_dependencies_test/syntax_error/.analysis_options rename to packages/flutter_tools/test/data/dart_dependencies_test/syntax_error/analysis_options.yaml