OLD | NEW |
1 <!doctype html> | 1 <!doctype html> |
2 <html> | 2 <html> |
3 <head> | 3 <head> |
4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
5 <title>Analysis Server Plugin API Specification</title> | 5 <title>Analysis Server Plugin API Specification</title> |
6 </head> | 6 </head> |
7 <body> | 7 <body> |
8 <h1>Analysis Server Plugin API Specification</h1> | 8 <h1>Analysis Server Plugin API Specification</h1> |
9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
10 <version>1.0.0-alpha.0</version> | 10 <version>1.0.0-alpha.0</version> |
(...skipping 21 matching lines...) Expand all Loading... |
32 TODO: Add a notification to the server protocol to inform the client of | 32 TODO: Add a notification to the server protocol to inform the client of |
33 problems related to the execution of plugins. | 33 problems related to the execution of plugins. |
34 </p> | 34 </p> |
35 <request method="versionCheck"> | 35 <request method="versionCheck"> |
36 <p> | 36 <p> |
37 Used to request that the plugin perform a version check to confirm that it | 37 Used to request that the plugin perform a version check to confirm that it |
38 works with the version of the analysis server that is executing it. | 38 works with the version of the analysis server that is executing it. |
39 </p> | 39 </p> |
40 <params> | 40 <params> |
41 <field name="byteStorePath"> | 41 <field name="byteStorePath"> |
42 <ref>String</ref> | 42 <ref>FilePath</ref> |
43 <p> | 43 <p> |
44 The path to the directory containing the on-disk byte store that is to | 44 The path to the directory containing the on-disk byte store that is to |
45 be used by any analysis drivers that are created. | 45 be used by any analysis drivers that are created. |
46 </p> | 46 </p> |
47 </field> | 47 </field> |
48 <field name="sdkPath"> | 48 <field name="sdkPath"> |
49 <ref>String</ref> | 49 <ref>FilePath</ref> |
50 <p> | 50 <p> |
51 The path to the directory containing the SDK that is to be used by any | 51 The path to the directory containing the SDK that is to be used by any |
52 analysis drivers that are created. | 52 analysis drivers that are created. |
53 </p> | 53 </p> |
54 </field> | 54 </field> |
55 <field name="version"> | 55 <field name="version"> |
56 <ref>String</ref> | 56 <ref>String</ref> |
57 <p> | 57 <p> |
58 The version number of the plugin spec supported by the analysis server | 58 The version number of the plugin spec supported by the analysis server |
59 that is executing the plugin. | 59 that is executing the plugin. |
(...skipping 846 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
906 <value><code>OCCURRENCES</code></value> | 906 <value><code>OCCURRENCES</code></value> |
907 <value><code>OUTLINE</code></value> | 907 <value><code>OUTLINE</code></value> |
908 </enum> | 908 </enum> |
909 </type> | 909 </type> |
910 <type name="ContextBuilderOptions"> | 910 <type name="ContextBuilderOptions"> |
911 <p> | 911 <p> |
912 The options used to build an analysis context. | 912 The options used to build an analysis context. |
913 </p> | 913 </p> |
914 <object> | 914 <object> |
915 <field name="dartSdkSummaryPath" optional="true"> | 915 <field name="dartSdkSummaryPath" optional="true"> |
916 <ref>String</ref> | 916 <ref>FilePath</ref> |
917 <p> | 917 <p> |
918 The file path of the file containing the summary of the SDK that | 918 The file path of the file containing the summary of the SDK that |
919 should be used to "analyze" the SDK. The field will be omitted if the | 919 should be used to "analyze" the SDK. The field will be omitted if the |
920 summary should be found in the SDK. | 920 summary should be found in the SDK. |
921 </p> | 921 </p> |
922 </field> | 922 </field> |
923 <field name="defaultAnalysisOptionsFilePath" optional="true"> | 923 <field name="defaultAnalysisOptionsFilePath" optional="true"> |
924 <list> | 924 <list> |
925 <ref>String</ref> | 925 <ref>FilePath</ref> |
926 </list> | 926 </list> |
927 <p> | 927 <p> |
928 The file path of the analysis options file that should be used in | 928 The file path of the analysis options file that should be used in |
929 place of any file in the root directory or a parent of the root | 929 place of any file in the root directory or a parent of the root |
930 directory. The field will be omitted if the normal lookup mechanism | 930 directory. The field will be omitted if the normal lookup mechanism |
931 should be used. | 931 should be used. |
932 </p> | 932 </p> |
933 </field> | 933 </field> |
934 <field name="declaredVariables" optional="true"> | 934 <field name="declaredVariables" optional="true"> |
935 <map> | 935 <map> |
(...skipping 16 matching lines...) Expand all Loading... |
952 <ref>AnalysisOptions</ref> | 952 <ref>AnalysisOptions</ref> |
953 <p> | 953 <p> |
954 The default analysis options that should be used unless some or all of | 954 The default analysis options that should be used unless some or all of |
955 them are overridden in the analysis options file. The field will be | 955 them are overridden in the analysis options file. The field will be |
956 omitted if the default defaults should be used. | 956 omitted if the default defaults should be used. |
957 </p> | 957 </p> |
958 </field> | 958 </field> |
959 --> | 959 --> |
960 <field name="defaultPackageFilePath" optional="true"> | 960 <field name="defaultPackageFilePath" optional="true"> |
961 <list> | 961 <list> |
962 <ref>String</ref> | 962 <ref>FilePath</ref> |
963 </list> | 963 </list> |
964 <p> | 964 <p> |
965 The file path of the .packages file that should be used in place of | 965 The file path of the .packages file that should be used in place of |
966 any file found using the normal (Package Specification DEP) lookup | 966 any file found using the normal (Package Specification DEP) lookup |
967 mechanism. The field will be omitted if the normal lookup mechanism | 967 mechanism. The field will be omitted if the normal lookup mechanism |
968 should be used. | 968 should be used. |
969 </p> | 969 </p> |
970 </field> | 970 </field> |
971 <field name="defaultPackagesDirectoryPath" optional="true"> | 971 <field name="defaultPackagesDirectoryPath" optional="true"> |
972 <list> | 972 <list> |
973 <ref>String</ref> | 973 <ref>FilePath</ref> |
974 </list> | 974 </list> |
975 <p> | 975 <p> |
976 The file path of the packages directory that should be used in place | 976 The file path of the packages directory that should be used in place |
977 of any file found using the normal (Package Specification DEP) lookup | 977 of any file found using the normal (Package Specification DEP) lookup |
978 mechanism. The field will be omitted if the normal lookup mechanism | 978 mechanism. The field will be omitted if the normal lookup mechanism |
979 should be used. | 979 should be used. |
980 </p> | 980 </p> |
981 </field> | 981 </field> |
982 </object> | 982 </object> |
983 </type> | 983 </type> |
984 <type name="ContextRoot"> | 984 <type name="ContextRoot"> |
985 <p> | 985 <p> |
986 A description of an analysis context. | 986 A description of an analysis context. |
987 </p> | 987 </p> |
988 <object> | 988 <object> |
989 <field name="root"> | 989 <field name="root"> |
990 <ref>String</ref> | 990 <ref>FilePath</ref> |
991 <p> | 991 <p> |
992 The absolute path of the root directory containing the files to be | 992 The absolute path of the root directory containing the files to be |
993 analyzed. | 993 analyzed. |
994 </p> | 994 </p> |
995 </field> | 995 </field> |
996 <field name="exclude"> | 996 <field name="exclude"> |
997 <list> | 997 <list> |
998 <ref>String</ref> | 998 <ref>FilePath</ref> |
999 </list> | 999 </list> |
1000 <p> | 1000 <p> |
1001 A list of the absolute paths of files and directories within the root | 1001 A list of the absolute paths of files and directories within the root |
1002 directory that should not be analyzed. | 1002 directory that should not be analyzed. |
1003 </p> | 1003 </p> |
1004 </field> | 1004 </field> |
| 1005 <field name="optionsFile" optional="true"> |
| 1006 <ref>FilePath</ref> |
| 1007 <p> |
| 1008 The absolute path of the analysis options file that should be used to |
| 1009 control the analysis of the files in the context. |
| 1010 </p> |
| 1011 </field> |
1005 </object> | 1012 </object> |
1006 </type> | 1013 </type> |
1007 <type name="PrioritizedSourceChange"> | 1014 <type name="PrioritizedSourceChange"> |
1008 <p> | 1015 <p> |
1009 A source change that has a priority associated with it. | 1016 A source change that has a priority associated with it. |
1010 </p> | 1017 </p> |
1011 <object> | 1018 <object> |
1012 <field name="priority"> | 1019 <field name="priority"> |
1013 <ref>int</ref> | 1020 <ref>int</ref> |
1014 <p> | 1021 <p> |
(...skipping 211 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1226 A watch event sent by the server when the file system has been modified. | 1233 A watch event sent by the server when the file system has been modified. |
1227 </p> | 1234 </p> |
1228 <object> | 1235 <object> |
1229 <field name="type"> | 1236 <field name="type"> |
1230 <ref>WatchEventType</ref> | 1237 <ref>WatchEventType</ref> |
1231 <p> | 1238 <p> |
1232 The type of change represented by this event. | 1239 The type of change represented by this event. |
1233 </p> | 1240 </p> |
1234 </field> | 1241 </field> |
1235 <field name="path"> | 1242 <field name="path"> |
1236 <ref>String</ref> | 1243 <ref>FilePath</ref> |
1237 <p> | 1244 <p> |
1238 The absolute path of the file or directory that changed. | 1245 The absolute path of the file or directory that changed. |
1239 </p> | 1246 </p> |
1240 </field> | 1247 </field> |
1241 </object> | 1248 </object> |
1242 </type> | 1249 </type> |
1243 <type name="WatchEventType"> | 1250 <type name="WatchEventType"> |
1244 <p> | 1251 <p> |
1245 An indication of the type of change associated with a watch event. | 1252 An indication of the type of change associated with a watch event. |
1246 </p> | 1253 </p> |
(...skipping 396 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1643 The name that the element should have after the refactoring. | 1650 The name that the element should have after the refactoring. |
1644 </p> | 1651 </p> |
1645 </field> | 1652 </field> |
1646 </options> | 1653 </options> |
1647 </refactoring> | 1654 </refactoring> |
1648 </refactorings> | 1655 </refactorings> |
1649 <h2 class="domain"><a name="index">Index</a></h2> | 1656 <h2 class="domain"><a name="index">Index</a></h2> |
1650 <index></index> | 1657 <index></index> |
1651 </body> | 1658 </body> |
1652 </html> | 1659 </html> |
OLD | NEW |