| OLD | NEW |
| 1 // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
| 4 | 4 |
| 5 /// Support for client code that wants to consume options contributed to the | 5 /// Support for client code that wants to consume options contributed to the |
| 6 /// analysis options file. | 6 /// analysis options file. |
| 7 library analyzer.plugin.options; | 7 library analyzer.plugin.options; |
| 8 | 8 |
| 9 import 'package:analyzer/error/listener.dart'; |
| 9 import 'package:analyzer/src/generated/engine.dart'; | 10 import 'package:analyzer/src/generated/engine.dart'; |
| 10 import 'package:analyzer/src/plugin/options_plugin.dart'; | 11 import 'package:analyzer/src/plugin/options_plugin.dart'; |
| 11 import 'package:plugin/plugin.dart'; | 12 import 'package:plugin/plugin.dart'; |
| 12 import 'package:yaml/yaml.dart'; | 13 import 'package:yaml/yaml.dart'; |
| 13 | 14 |
| 14 /// The identifier of the extension point that allows plugins to access | 15 /// The identifier of the extension point that allows plugins to access |
| 15 /// options defined in the analysis options file. The object used as an | 16 /// options defined in the analysis options file. The object used as an |
| 16 /// extension must be an [OptionsProcessor]. | 17 /// extension must be an [OptionsProcessor]. |
| 17 final String OPTIONS_PROCESSOR_EXTENSION_POINT_ID = Plugin.join( | 18 final String OPTIONS_PROCESSOR_EXTENSION_POINT_ID = Plugin.join( |
| 18 OptionsPlugin.UNIQUE_IDENTIFIER, | 19 OptionsPlugin.UNIQUE_IDENTIFIER, |
| 19 OptionsPlugin.OPTIONS_PROCESSOR_EXTENSION_POINT); | 20 OptionsPlugin.OPTIONS_PROCESSOR_EXTENSION_POINT); |
| 20 | 21 |
| 22 /// The identifier of the extension point that allows plugins to validate |
| 23 /// options defined in the analysis options file. The object used as an |
| 24 /// extension must be an [OptionsValidator]. |
| 25 final String OPTIONS_VALIDATOR_EXTENSION_POINT_ID = Plugin.join( |
| 26 OptionsPlugin.UNIQUE_IDENTIFIER, |
| 27 OptionsPlugin.OPTIONS_VALIDATOR_EXTENSION_POINT); |
| 28 |
| 21 /// Processes options defined in the analysis options file. | 29 /// Processes options defined in the analysis options file. |
| 22 /// | 30 /// |
| 31 /// Clients may implement this class when implementing plugins. |
| 32 /// |
| 23 /// The options file format is intentionally very open-ended, giving clients | 33 /// The options file format is intentionally very open-ended, giving clients |
| 24 /// utmost flexibility in defining their own options. The only hardfast | 34 /// utmost flexibility in defining their own options. The only hardfast |
| 25 /// expectation is that options files will contain a mapping from Strings | 35 /// expectation is that options files will contain a mapping from Strings |
| 26 /// (identifying 'scopes') to associated options. For example, the given | 36 /// (identifying 'scopes') to associated options. For example, the given |
| 27 /// content | 37 /// content |
| 28 /// | 38 /// |
| 29 /// linter: | 39 /// linter: |
| 30 /// rules: | 40 /// rules: |
| 31 /// camel_case_types: true | 41 /// camel_case_types: true |
| 32 /// compiler: | 42 /// compiler: |
| (...skipping 19 matching lines...) Expand all Loading... |
| 52 /// Called when an options file is processed. | 62 /// Called when an options file is processed. |
| 53 /// | 63 /// |
| 54 /// The options file is processed on analyzer initialization and | 64 /// The options file is processed on analyzer initialization and |
| 55 /// subsequently when the file is changed on disk. In the event of a | 65 /// subsequently when the file is changed on disk. In the event of a |
| 56 /// change notification, note that the notification simply indicates | 66 /// change notification, note that the notification simply indicates |
| 57 /// a change on disk. Content in specific option scopes may or may not | 67 /// a change on disk. Content in specific option scopes may or may not |
| 58 /// be different. It is up to the implementer to check whether specific | 68 /// be different. It is up to the implementer to check whether specific |
| 59 /// options have changed and to handle those changes appropriately. In | 69 /// options have changed and to handle those changes appropriately. In |
| 60 /// addition to the [options] map, the associated analysis [context] is | 70 /// addition to the [options] map, the associated analysis [context] is |
| 61 /// provided as well to allow for context-specific configuration. | 71 /// provided as well to allow for context-specific configuration. |
| 62 void optionsProcessed(AnalysisContext context, Map<String, YamlNode> options); | 72 void optionsProcessed(AnalysisContext context, Map<String, Object> options); |
| 63 } | 73 } |
| 74 |
| 75 /// Validates options as defined in an analysis options file. |
| 76 /// |
| 77 /// Clients may implement this class when implementing plugins. |
| 78 /// |
| 79 /// See [OptionsProcessor] for a description of the options file format. |
| 80 /// |
| 81 abstract class OptionsValidator { |
| 82 /// Validate [options], reporting any errors to the given [reporter]. |
| 83 void validate(ErrorReporter reporter, Map<String, YamlNode> options); |
| 84 } |
| OLD | NEW |