roast-ai 0.4.4 → 0.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (231) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS +2 -0
  3. data/.github/workflows/ci.yaml +1 -0
  4. data/.gitignore +0 -26
  5. data/.rubocop.yml +13 -0
  6. data/.rubocop_todo.yml +21 -0
  7. data/CHANGELOG.md +29 -0
  8. data/Gemfile +4 -0
  9. data/Gemfile.lock +43 -1
  10. data/bin/rubocop +27 -0
  11. data/bin/spoom +27 -0
  12. data/bin/srb +27 -0
  13. data/bin/srb-rbi +27 -0
  14. data/bin/tapioca +27 -0
  15. data/docs/INSTRUMENTATION.md +3 -3
  16. data/dsl/simple.rb +10 -0
  17. data/lib/roast/dsl/executor.rb +26 -0
  18. data/lib/roast/dsl.rb +7 -0
  19. data/lib/roast/errors.rb +1 -0
  20. data/lib/roast/factories/api_provider_factory.rb +1 -0
  21. data/lib/roast/helpers/function_caching_interceptor.rb +3 -0
  22. data/lib/roast/helpers/logger.rb +6 -9
  23. data/lib/roast/helpers/metadata_access.rb +1 -0
  24. data/lib/roast/helpers/minitest_coverage_runner.rb +1 -0
  25. data/lib/roast/helpers/path_resolver.rb +8 -18
  26. data/lib/roast/helpers/prompt_loader.rb +3 -2
  27. data/lib/roast/helpers/timeout_handler.rb +3 -5
  28. data/lib/roast/initializers.rb +1 -0
  29. data/lib/roast/resources/api_resource.rb +4 -3
  30. data/lib/roast/resources/base_resource.rb +1 -0
  31. data/lib/roast/resources/directory_resource.rb +1 -0
  32. data/lib/roast/resources/file_resource.rb +1 -0
  33. data/lib/roast/resources/none_resource.rb +1 -0
  34. data/lib/roast/resources/url_resource.rb +2 -1
  35. data/lib/roast/resources.rb +1 -2
  36. data/lib/roast/services/context_threshold_checker.rb +1 -0
  37. data/lib/roast/services/token_counting_service.rb +1 -0
  38. data/lib/roast/tools/apply_diff.rb +1 -0
  39. data/lib/roast/tools/ask_user.rb +1 -0
  40. data/lib/roast/tools/bash.rb +1 -0
  41. data/lib/roast/tools/cmd.rb +1 -0
  42. data/lib/roast/tools/coding_agent.rb +1 -0
  43. data/lib/roast/tools/context_summarizer.rb +1 -0
  44. data/lib/roast/tools/grep.rb +1 -0
  45. data/lib/roast/tools/helpers/coding_agent_message_formatter.rb +1 -0
  46. data/lib/roast/tools/read_file.rb +1 -0
  47. data/lib/roast/tools/search_file.rb +1 -0
  48. data/lib/roast/tools/swarm.rb +1 -0
  49. data/lib/roast/tools/update_files.rb +1 -0
  50. data/lib/roast/tools/write_file.rb +1 -0
  51. data/lib/roast/tools.rb +2 -0
  52. data/lib/roast/value_objects/api_token.rb +1 -0
  53. data/lib/roast/value_objects/step_name.rb +1 -0
  54. data/lib/roast/value_objects/uri_base.rb +1 -0
  55. data/lib/roast/value_objects/workflow_path.rb +1 -0
  56. data/lib/roast/value_objects.rb +1 -0
  57. data/lib/roast/version.rb +2 -1
  58. data/lib/roast/workflow/agent_step.rb +1 -0
  59. data/lib/roast/workflow/api_configuration.rb +1 -0
  60. data/lib/roast/workflow/base_iteration_step.rb +1 -0
  61. data/lib/roast/workflow/base_step.rb +1 -0
  62. data/lib/roast/workflow/base_workflow.rb +1 -0
  63. data/lib/roast/workflow/case_executor.rb +1 -0
  64. data/lib/roast/workflow/case_step.rb +1 -0
  65. data/lib/roast/workflow/command_executor.rb +1 -0
  66. data/lib/roast/workflow/conditional_executor.rb +1 -0
  67. data/lib/roast/workflow/conditional_step.rb +1 -0
  68. data/lib/roast/workflow/configuration.rb +9 -0
  69. data/lib/roast/workflow/configuration_loader.rb +4 -1
  70. data/lib/roast/workflow/context_manager.rb +1 -0
  71. data/lib/roast/workflow/context_path_resolver.rb +1 -0
  72. data/lib/roast/workflow/dot_access_hash.rb +1 -0
  73. data/lib/roast/workflow/each_step.rb +1 -0
  74. data/lib/roast/workflow/error_handler.rb +7 -1
  75. data/lib/roast/workflow/expression_evaluator.rb +1 -0
  76. data/lib/roast/workflow/expression_utils.rb +1 -0
  77. data/lib/roast/workflow/file_state_repository.rb +2 -1
  78. data/lib/roast/workflow/input_executor.rb +1 -0
  79. data/lib/roast/workflow/input_step.rb +1 -0
  80. data/lib/roast/workflow/interpolator.rb +2 -1
  81. data/lib/roast/workflow/iteration_executor.rb +1 -0
  82. data/lib/roast/workflow/llm_boolean_coercer.rb +1 -0
  83. data/lib/roast/workflow/metadata_manager.rb +1 -0
  84. data/lib/roast/workflow/output_handler.rb +1 -0
  85. data/lib/roast/workflow/output_manager.rb +1 -0
  86. data/lib/roast/workflow/parallel_executor.rb +1 -0
  87. data/lib/roast/workflow/prompt_step.rb +1 -0
  88. data/lib/roast/workflow/repeat_step.rb +1 -0
  89. data/lib/roast/workflow/replay_handler.rb +1 -0
  90. data/lib/roast/workflow/resource_resolver.rb +2 -6
  91. data/lib/roast/workflow/session_manager.rb +1 -0
  92. data/lib/roast/workflow/shell_script_step.rb +1 -0
  93. data/lib/roast/workflow/sqlite_state_repository.rb +1 -0
  94. data/lib/roast/workflow/state_manager.rb +1 -0
  95. data/lib/roast/workflow/state_repository.rb +1 -0
  96. data/lib/roast/workflow/state_repository_factory.rb +4 -2
  97. data/lib/roast/workflow/step_completion_reporter.rb +1 -0
  98. data/lib/roast/workflow/step_executor_coordinator.rb +9 -5
  99. data/lib/roast/workflow/step_executor_factory.rb +1 -0
  100. data/lib/roast/workflow/step_executor_registry.rb +2 -3
  101. data/lib/roast/workflow/step_executor_with_reporting.rb +1 -0
  102. data/lib/roast/workflow/step_executors/base_step_executor.rb +1 -0
  103. data/lib/roast/workflow/step_executors/hash_step_executor.rb +1 -0
  104. data/lib/roast/workflow/step_executors/parallel_step_executor.rb +1 -0
  105. data/lib/roast/workflow/step_executors/string_step_executor.rb +1 -0
  106. data/lib/roast/workflow/step_factory.rb +1 -0
  107. data/lib/roast/workflow/step_finder.rb +1 -0
  108. data/lib/roast/workflow/step_loader.rb +1 -0
  109. data/lib/roast/workflow/step_name_extractor.rb +1 -0
  110. data/lib/roast/workflow/step_runner.rb +1 -0
  111. data/lib/roast/workflow/step_type_resolver.rb +1 -0
  112. data/lib/roast/workflow/validation_command.rb +1 -0
  113. data/lib/roast/workflow/validator.rb +1 -0
  114. data/lib/roast/workflow/validators/base_validator.rb +1 -0
  115. data/lib/roast/workflow/validators/dependency_validator.rb +1 -0
  116. data/lib/roast/workflow/validators/linting_validator.rb +1 -0
  117. data/lib/roast/workflow/validators/schema_validator.rb +1 -0
  118. data/lib/roast/workflow/validators/step_collector.rb +1 -0
  119. data/lib/roast/workflow/validators/validation_orchestrator.rb +1 -0
  120. data/lib/roast/workflow/workflow_context.rb +1 -0
  121. data/lib/roast/workflow/workflow_execution_context.rb +1 -0
  122. data/lib/roast/workflow/workflow_executor.rb +2 -1
  123. data/lib/roast/workflow/workflow_initializer.rb +1 -0
  124. data/lib/roast/workflow/workflow_runner.rb +66 -55
  125. data/lib/roast/workflow.rb +1 -0
  126. data/lib/roast/workflow_diagram_generator.rb +3 -2
  127. data/lib/roast.rb +23 -8
  128. data/sorbet/config +8 -0
  129. data/sorbet/rbi/dsl/.gitattributes +1 -0
  130. data/sorbet/rbi/dsl/active_support/callbacks.rbi +21 -0
  131. data/sorbet/rbi/gems/.gitattributes +1 -0
  132. data/sorbet/rbi/gems/activesupport@8.0.2.rbi +19107 -0
  133. data/sorbet/rbi/gems/addressable@2.8.7.rbi +1994 -0
  134. data/sorbet/rbi/gems/ast@2.4.3.rbi +585 -0
  135. data/sorbet/rbi/gems/base64@0.3.0.rbi +545 -0
  136. data/sorbet/rbi/gems/benchmark@0.4.1.rbi +619 -0
  137. data/sorbet/rbi/gems/bigdecimal@3.2.2.rbi +62 -0
  138. data/sorbet/rbi/gems/cgi@0.5.0.rbi +2961 -0
  139. data/sorbet/rbi/gems/claude_swarm@0.1.19.rbi +568 -0
  140. data/sorbet/rbi/gems/cli-kit@5.0.1.rbi +1991 -0
  141. data/sorbet/rbi/gems/cli-ui@2.3.0.rbi +3181 -0
  142. data/sorbet/rbi/gems/coderay@1.1.3.rbi +9 -0
  143. data/sorbet/rbi/gems/concurrent-ruby@1.3.5.rbi +11657 -0
  144. data/sorbet/rbi/gems/connection_pool@2.5.3.rbi +9 -0
  145. data/sorbet/rbi/gems/crack@1.0.0.rbi +145 -0
  146. data/sorbet/rbi/gems/diff-lcs@1.6.2.rbi +972 -0
  147. data/sorbet/rbi/gems/dotenv@3.1.8.rbi +295 -0
  148. data/sorbet/rbi/gems/drb@2.2.3.rbi +1661 -0
  149. data/sorbet/rbi/gems/dry-configurable@1.3.0.rbi +672 -0
  150. data/sorbet/rbi/gems/dry-core@1.1.0.rbi +1894 -0
  151. data/sorbet/rbi/gems/dry-inflector@1.2.0.rbi +659 -0
  152. data/sorbet/rbi/gems/dry-initializer@3.2.0.rbi +781 -0
  153. data/sorbet/rbi/gems/dry-logic@1.6.0.rbi +1127 -0
  154. data/sorbet/rbi/gems/dry-schema@1.14.1.rbi +3727 -0
  155. data/sorbet/rbi/gems/dry-types@1.8.3.rbi +3969 -0
  156. data/sorbet/rbi/gems/erubi@1.13.1.rbi +155 -0
  157. data/sorbet/rbi/gems/event_stream_parser@1.0.0.rbi +49 -0
  158. data/sorbet/rbi/gems/faraday-multipart@1.1.1.rbi +283 -0
  159. data/sorbet/rbi/gems/faraday-net_http@3.4.1.rbi +147 -0
  160. data/sorbet/rbi/gems/faraday-retry@2.3.2.rbi +9 -0
  161. data/sorbet/rbi/gems/faraday@2.13.1.rbi +2977 -0
  162. data/sorbet/rbi/gems/fast-mcp-annotations@1.5.3.rbi +1588 -0
  163. data/sorbet/rbi/gems/ffi@1.17.2.rbi +9 -0
  164. data/sorbet/rbi/gems/formatador@1.1.0.rbi +9 -0
  165. data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +102 -0
  166. data/sorbet/rbi/gems/guard-minitest@2.4.6.rbi +402 -0
  167. data/sorbet/rbi/gems/guard@2.19.1.rbi +2283 -0
  168. data/sorbet/rbi/gems/hashdiff@1.2.0.rbi +355 -0
  169. data/sorbet/rbi/gems/i18n@1.14.7.rbi +2359 -0
  170. data/sorbet/rbi/gems/json-schema@5.1.1.rbi +1466 -0
  171. data/sorbet/rbi/gems/json@2.12.2.rbi +2051 -0
  172. data/sorbet/rbi/gems/language_server-protocol@3.17.0.5.rbi +9 -0
  173. data/sorbet/rbi/gems/lint_roller@1.1.0.rbi +9 -0
  174. data/sorbet/rbi/gems/listen@3.9.0.rbi +1206 -0
  175. data/sorbet/rbi/gems/logger@1.7.0.rbi +963 -0
  176. data/sorbet/rbi/gems/lumberjack@1.2.10.rbi +1830 -0
  177. data/sorbet/rbi/gems/method_source@1.1.0.rbi +9 -0
  178. data/sorbet/rbi/gems/mime-types-data@3.2025.0617.rbi +136 -0
  179. data/sorbet/rbi/gems/mime-types@3.7.0.rbi +1342 -0
  180. data/sorbet/rbi/gems/minitest-rg@5.3.0.rbi +160 -0
  181. data/sorbet/rbi/gems/minitest@5.25.5.rbi +1640 -0
  182. data/sorbet/rbi/gems/mocha@2.7.1.rbi +12 -0
  183. data/sorbet/rbi/gems/multipart-post@2.4.1.rbi +244 -0
  184. data/sorbet/rbi/gems/nenv@0.3.0.rbi +147 -0
  185. data/sorbet/rbi/gems/net-http@0.6.0.rbi +4247 -0
  186. data/sorbet/rbi/gems/netrc@0.11.0.rbi +159 -0
  187. data/sorbet/rbi/gems/notiffany@0.1.3.rbi +1079 -0
  188. data/sorbet/rbi/gems/open_router@0.3.3.rbi +230 -0
  189. data/sorbet/rbi/gems/ostruct@0.6.2.rbi +354 -0
  190. data/sorbet/rbi/gems/parallel@1.27.0.rbi +291 -0
  191. data/sorbet/rbi/gems/parser@3.3.8.0.rbi +5535 -0
  192. data/sorbet/rbi/gems/prism@1.4.0.rbi +41732 -0
  193. data/sorbet/rbi/gems/pry@0.15.2.rbi +9 -0
  194. data/sorbet/rbi/gems/public_suffix@6.0.2.rbi +936 -0
  195. data/sorbet/rbi/gems/racc@1.8.1.rbi +158 -0
  196. data/sorbet/rbi/gems/rack@2.2.17.rbi +5659 -0
  197. data/sorbet/rbi/gems/rainbow@3.1.1.rbi +9 -0
  198. data/sorbet/rbi/gems/raix@1.0.2.rbi +1104 -0
  199. data/sorbet/rbi/gems/rake@13.3.0.rbi +3036 -0
  200. data/sorbet/rbi/gems/rb-fsevent@0.11.2.rbi +9 -0
  201. data/sorbet/rbi/gems/rb-inotify@0.11.1.rbi +9 -0
  202. data/sorbet/rbi/gems/rbi@0.3.6.rbi +6893 -0
  203. data/sorbet/rbi/gems/rbs@3.9.4.rbi +6978 -0
  204. data/sorbet/rbi/gems/regexp_parser@2.10.0.rbi +9 -0
  205. data/sorbet/rbi/gems/rexml@3.4.1.rbi +5346 -0
  206. data/sorbet/rbi/gems/rubocop-ast@1.45.1.rbi +9 -0
  207. data/sorbet/rbi/gems/rubocop-shopify@2.17.1.rbi +9 -0
  208. data/sorbet/rbi/gems/rubocop@1.77.0.rbi +9 -0
  209. data/sorbet/rbi/gems/ruby-graphviz@1.2.5.rbi +1333 -0
  210. data/sorbet/rbi/gems/ruby-openai@8.1.0.rbi +758 -0
  211. data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +9 -0
  212. data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +9 -0
  213. data/sorbet/rbi/gems/securerandom@0.4.1.rbi +75 -0
  214. data/sorbet/rbi/gems/shellany@0.0.1.rbi +102 -0
  215. data/sorbet/rbi/gems/spoom@1.6.3.rbi +6985 -0
  216. data/sorbet/rbi/gems/sqlite3@2.7.0.rbi +1900 -0
  217. data/sorbet/rbi/gems/tapioca@0.16.11.rbi +3628 -0
  218. data/sorbet/rbi/gems/thor@1.4.0.rbi +4399 -0
  219. data/sorbet/rbi/gems/tzinfo@2.0.6.rbi +5918 -0
  220. data/sorbet/rbi/gems/unicode-display_width@3.1.4.rbi +9 -0
  221. data/sorbet/rbi/gems/unicode-emoji@4.0.4.rbi +9 -0
  222. data/sorbet/rbi/gems/uri@1.0.3.rbi +2349 -0
  223. data/sorbet/rbi/gems/vcr@6.3.1.rbi +3040 -0
  224. data/sorbet/rbi/gems/webmock@3.25.1.rbi +1792 -0
  225. data/sorbet/rbi/gems/yard-sorbet@0.9.0.rbi +435 -0
  226. data/sorbet/rbi/gems/yard@0.9.37.rbi +18492 -0
  227. data/sorbet/rbi/gems/zeitwerk@2.7.3.rbi +1429 -0
  228. data/sorbet/tapioca/config.yml +13 -0
  229. data/sorbet/tapioca/require.rb +36 -0
  230. metadata +113 -2
  231. data/lib/roast/workflow/configuration_parser.rb +0 -54
@@ -0,0 +1,2283 @@
1
+ # typed: true
2
+
3
+ # DO NOT EDIT MANUALLY
4
+ # This is an autogenerated file for types exported from the `guard` gem.
5
+ # Please instead update this file by running `bin/tapioca gem guard`.
6
+
7
+
8
+ # Guard is the main module for all Guard related modules and classes.
9
+ # Also Guard plugins should use this namespace.
10
+ #
11
+ # source://guard//lib/guard/config.rb#3
12
+ module Guard
13
+ extend ::Guard::Deprecated::Guard::ClassMethods
14
+ extend ::Guard::Internals::Helpers
15
+
16
+ class << self
17
+ # Asynchronously trigger changes
18
+ #
19
+ # Currently supported args:
20
+ #
21
+ # @example Old style hash:
22
+ # async_queue_add(modified: ['foo'], added: ['bar'], removed: [])
23
+ #
24
+ # @example New style signals with args:
25
+ # async_queue_add([:guard_pause, :unpaused ])
26
+ #
27
+ # source://guard//lib/guard.rb#87
28
+ def async_queue_add(changes); end
29
+
30
+ # source://guard//lib/guard.rb#73
31
+ def init(cmdline_options); end
32
+
33
+ # Returns the value of attribute interactor.
34
+ #
35
+ # source://guard//lib/guard.rb#24
36
+ def interactor; end
37
+
38
+ # Returns the value of attribute listener.
39
+ #
40
+ # source://guard//lib/guard.rb#23
41
+ def listener; end
42
+
43
+ # Returns the value of attribute queue.
44
+ #
45
+ # source://guard//lib/guard.rb#22
46
+ def queue; end
47
+
48
+ # Initializes the Guard singleton:
49
+ #
50
+ # * Initialize the internal Guard state;
51
+ # * Create the interactor
52
+ # * Select and initialize the file change listener.
53
+ #
54
+ # @option options
55
+ # @option options
56
+ # @option options
57
+ # @option options
58
+ # @option options
59
+ # @option options
60
+ # @param options [Hash] a customizable set of options
61
+ # @return [Guard] the Guard singleton
62
+ #
63
+ # source://guard//lib/guard.rb#44
64
+ def setup(cmdline_options = T.unsafe(nil)); end
65
+
66
+ # Returns the value of attribute state.
67
+ #
68
+ # source://guard//lib/guard.rb#21
69
+ def state; end
70
+
71
+ private
72
+
73
+ # source://guard//lib/guard.rb#132
74
+ def _evaluate(options); end
75
+
76
+ # TODO: remove at some point
77
+ # TODO: not tested because collides with ongoing refactoring
78
+ #
79
+ # source://guard//lib/guard.rb#152
80
+ def _guardfile_deprecated_check(modified); end
81
+
82
+ # source://guard//lib/guard.rb#113
83
+ def _listener_callback; end
84
+
85
+ # TODO: obsoleted? (move to Dsl?)
86
+ #
87
+ # @return [Boolean]
88
+ #
89
+ # source://guard//lib/guard.rb#128
90
+ def _pluginless_guardfile?; end
91
+
92
+ # source://guard//lib/guard.rb#109
93
+ def _relative_pathnames(paths); end
94
+
95
+ # Check if any of the changes are actually watched for
96
+ # TODO: why iterate twice? reuse this info when running tasks
97
+ #
98
+ # @return [Boolean]
99
+ #
100
+ # source://guard//lib/guard.rb#99
101
+ def _relevant_changes?(changes); end
102
+ end
103
+ end
104
+
105
+ # source://guard//lib/guard/config.rb#9
106
+ class Guard::Config < ::Nenv::Environment
107
+ # @return [Config] a new instance of Config
108
+ #
109
+ # source://guard//lib/guard/config.rb#10
110
+ def initialize; end
111
+
112
+ # @return [Boolean]
113
+ #
114
+ # source://guard//lib/guard/config.rb#14
115
+ def silence_deprecations?; end
116
+ end
117
+
118
+ # @deprecated Every method in this module is deprecated
119
+ #
120
+ # source://guard//lib/guard/deprecated/watcher.rb#5
121
+ module Guard::Deprecated; end
122
+
123
+ # source://guard//lib/guard/deprecated/dsl.rb#6
124
+ module Guard::Deprecated::Dsl
125
+ class << self
126
+ # source://guard//lib/guard/deprecated/dsl.rb#7
127
+ def add_deprecated(dsl_klass); end
128
+ end
129
+ end
130
+
131
+ # source://guard//lib/guard/deprecated/dsl.rb#16
132
+ module Guard::Deprecated::Dsl::ClassMethods
133
+ # source://guard//lib/guard/deprecated/dsl.rb#35
134
+ def evaluate_guardfile(options = T.unsafe(nil)); end
135
+ end
136
+
137
+ # `Guard::Guardfile::Evaluator.new(options).evaluate_guardfile`
138
+ # instead.
139
+ #
140
+ # to upgrade for Guard 2.0
141
+ #
142
+ # @deprecated Use
143
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How
144
+ #
145
+ # source://guard//lib/guard/deprecated/dsl.rb#24
146
+ Guard::Deprecated::Dsl::ClassMethods::EVALUATE_GUARDFILE = T.let(T.unsafe(nil), String)
147
+
148
+ # source://guard//lib/guard/deprecated/dsl.rb#11
149
+ Guard::Deprecated::Dsl::MORE_INFO_ON_UPGRADING_TO_GUARD_2 = T.let(T.unsafe(nil), String)
150
+
151
+ # source://guard//lib/guard/deprecated/evaluator.rb#8
152
+ module Guard::Deprecated::Evaluator
153
+ # source://guard//lib/guard/deprecated/evaluator.rb#26
154
+ def evaluate_guardfile; end
155
+
156
+ # source://guard//lib/guard/deprecated/evaluator.rb#31
157
+ def reevaluate_guardfile; end
158
+
159
+ class << self
160
+ # source://guard//lib/guard/deprecated/evaluator.rb#9
161
+ def add_deprecated(klass); end
162
+ end
163
+ end
164
+
165
+ # source://guard//lib/guard/deprecated/evaluator.rb#13
166
+ Guard::Deprecated::Evaluator::EVALUATE_GUARDFILE = T.let(T.unsafe(nil), String)
167
+
168
+ # source://guard//lib/guard/deprecated/evaluator.rb#18
169
+ Guard::Deprecated::Evaluator::REEVALUATE_GUARDFILE = T.let(T.unsafe(nil), String)
170
+
171
+ # source://guard//lib/guard/deprecated/guard.rb#14
172
+ module Guard::Deprecated::Guard
173
+ class << self
174
+ # source://guard//lib/guard/deprecated/guard.rb#15
175
+ def add_deprecated(klass); end
176
+ end
177
+ end
178
+
179
+ # source://guard//lib/guard/deprecated/guard.rb#19
180
+ module Guard::Deprecated::Guard::ClassMethods
181
+ # source://guard//lib/guard/deprecated/guard.rb#251
182
+ def add_group(name, options = T.unsafe(nil)); end
183
+
184
+ # source://guard//lib/guard/deprecated/guard.rb#57
185
+ def add_guard(*args); end
186
+
187
+ # source://guard//lib/guard/deprecated/guard.rb#261
188
+ def add_plugin(name, options = T.unsafe(nil)); end
189
+
190
+ # source://guard//lib/guard/deprecated/guard.rb#179
191
+ def evaluate_guardfile; end
192
+
193
+ # source://guard//lib/guard/deprecated/guard.rb#152
194
+ def evaluator; end
195
+
196
+ # source://guard//lib/guard/deprecated/guard.rb#79
197
+ def get_guard_class(name, fail_gracefully = T.unsafe(nil)); end
198
+
199
+ # source://guard//lib/guard/deprecated/guard.rb#271
200
+ def group(filter); end
201
+
202
+ # source://guard//lib/guard/deprecated/guard.rb#291
203
+ def groups(filter); end
204
+
205
+ # source://guard//lib/guard/deprecated/guard.rb#116
206
+ def guard_gem_names; end
207
+
208
+ # source://guard//lib/guard/deprecated/guard.rb#38
209
+ def guards(filter = T.unsafe(nil)); end
210
+
211
+ # source://guard//lib/guard/deprecated/guard.rb#143
212
+ def listener=(_); end
213
+
214
+ # source://guard//lib/guard/deprecated/guard.rb#97
215
+ def locate_guard(name); end
216
+
217
+ # source://guard//lib/guard/deprecated/guard.rb#135
218
+ def lock; end
219
+
220
+ # source://guard//lib/guard/deprecated/guard.rb#195
221
+ def options; end
222
+
223
+ # source://guard//lib/guard/deprecated/guard.rb#281
224
+ def plugin(filter); end
225
+
226
+ # source://guard//lib/guard/deprecated/guard.rb#301
227
+ def plugins(filter); end
228
+
229
+ # source://guard//lib/guard/deprecated/guard.rb#162
230
+ def reset_evaluator(_options); end
231
+
232
+ # source://guard//lib/guard/deprecated/guard.rb#170
233
+ def runner; end
234
+
235
+ # source://guard//lib/guard/deprecated/guard.rb#126
236
+ def running; end
237
+
238
+ # source://guard//lib/guard/deprecated/guard.rb#311
239
+ def scope; end
240
+
241
+ # source://guard//lib/guard/deprecated/guard.rb#321
242
+ def scope=(scope); end
243
+ end
244
+
245
+ # source://guard//lib/guard/deprecated/guard.rb#246
246
+ Guard::Deprecated::Guard::ClassMethods::ADD_GROUP = T.let(T.unsafe(nil), String)
247
+
248
+ # @deprecated Use `Guard.add_plugin(name, options = {})` instead.
249
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
250
+ # upgrade for Guard 2.0
251
+ #
252
+ # source://guard//lib/guard/deprecated/guard.rb#48
253
+ Guard::Deprecated::Guard::ClassMethods::ADD_GUARD = T.let(T.unsafe(nil), String)
254
+
255
+ # source://guard//lib/guard/deprecated/guard.rb#256
256
+ Guard::Deprecated::Guard::ClassMethods::ADD_PLUGIN = T.let(T.unsafe(nil), String)
257
+
258
+ # source://guard//lib/guard/deprecated/guard.rb#175
259
+ Guard::Deprecated::Guard::ClassMethods::EVALUATE_GUARDFILE = T.let(T.unsafe(nil), String)
260
+
261
+ # source://guard//lib/guard/deprecated/guard.rb#148
262
+ Guard::Deprecated::Guard::ClassMethods::EVALUATOR = T.let(T.unsafe(nil), String)
263
+
264
+ # @deprecated Use
265
+ # `Guard::PluginUtil.new(name).plugin_class(fail_gracefully:
266
+ # fail_gracefully)` instead.
267
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
268
+ # upgrade for Guard 2.0
269
+ #
270
+ # source://guard//lib/guard/deprecated/guard.rb#69
271
+ Guard::Deprecated::Guard::ClassMethods::GET_GUARD_CLASS = T.let(T.unsafe(nil), String)
272
+
273
+ # source://guard//lib/guard/deprecated/guard.rb#266
274
+ Guard::Deprecated::Guard::ClassMethods::GROUP = T.let(T.unsafe(nil), String)
275
+
276
+ # source://guard//lib/guard/deprecated/guard.rb#286
277
+ Guard::Deprecated::Guard::ClassMethods::GROUPS = T.let(T.unsafe(nil), String)
278
+
279
+ # @deprecated Use `Guard.plugins(filter)` instead.
280
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
281
+ # upgrade for Guard 2.0
282
+ #
283
+ # source://guard//lib/guard/deprecated/guard.rb#30
284
+ Guard::Deprecated::Guard::ClassMethods::GUARDS = T.let(T.unsafe(nil), String)
285
+
286
+ # Deprecator message for the `Guard.guard_gem_names` method
287
+ #
288
+ # @deprecated Use `Guard::PluginUtil.plugin_names` instead.
289
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
290
+ # upgrade for Guard 2.0
291
+ #
292
+ # source://guard//lib/guard/deprecated/guard.rb#108
293
+ Guard::Deprecated::Guard::ClassMethods::GUARD_GEM_NAMES = T.let(T.unsafe(nil), String)
294
+
295
+ # source://guard//lib/guard/deprecated/guard.rb#139
296
+ Guard::Deprecated::Guard::ClassMethods::LISTENER_ASSIGN = T.let(T.unsafe(nil), String)
297
+
298
+ # @deprecated Use `Guard::PluginUtil.new(name).plugin_location` instead.
299
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
300
+ # upgrade for Guard 2.0
301
+ #
302
+ # source://guard//lib/guard/deprecated/guard.rb#89
303
+ Guard::Deprecated::Guard::ClassMethods::LOCATE_GUARD = T.let(T.unsafe(nil), String)
304
+
305
+ # source://guard//lib/guard/deprecated/guard.rb#131
306
+ Guard::Deprecated::Guard::ClassMethods::LOCK = T.let(T.unsafe(nil), String)
307
+
308
+ # source://guard//lib/guard/deprecated/guard.rb#20
309
+ Guard::Deprecated::Guard::ClassMethods::MORE_INFO_ON_UPGRADING_TO_GUARD_2 = T.let(T.unsafe(nil), String)
310
+
311
+ # source://guard//lib/guard/deprecated/guard.rb#188
312
+ Guard::Deprecated::Guard::ClassMethods::OPTIONS = T.let(T.unsafe(nil), String)
313
+
314
+ # source://guard//lib/guard/deprecated/guard.rb#276
315
+ Guard::Deprecated::Guard::ClassMethods::PLUGIN = T.let(T.unsafe(nil), String)
316
+
317
+ # source://guard//lib/guard/deprecated/guard.rb#296
318
+ Guard::Deprecated::Guard::ClassMethods::PLUGINS = T.let(T.unsafe(nil), String)
319
+
320
+ # source://guard//lib/guard/deprecated/guard.rb#158
321
+ Guard::Deprecated::Guard::ClassMethods::RESET_EVALUATOR = T.let(T.unsafe(nil), String)
322
+
323
+ # source://guard//lib/guard/deprecated/guard.rb#166
324
+ Guard::Deprecated::Guard::ClassMethods::RUNNER = T.let(T.unsafe(nil), String)
325
+
326
+ # source://guard//lib/guard/deprecated/guard.rb#121
327
+ Guard::Deprecated::Guard::ClassMethods::RUNNING = T.let(T.unsafe(nil), String)
328
+
329
+ # source://guard//lib/guard/deprecated/guard.rb#306
330
+ Guard::Deprecated::Guard::ClassMethods::SCOPE = T.let(T.unsafe(nil), String)
331
+
332
+ # source://guard//lib/guard/deprecated/guard.rb#316
333
+ Guard::Deprecated::Guard::ClassMethods::SCOPE_ASSIGN = T.let(T.unsafe(nil), String)
334
+
335
+ # source://guard//lib/guard/deprecated/watcher.rb#6
336
+ module Guard::Deprecated::Watcher
337
+ class << self
338
+ # source://guard//lib/guard/deprecated/watcher.rb#7
339
+ def add_deprecated(klass); end
340
+ end
341
+ end
342
+
343
+ # source://guard//lib/guard/deprecated/watcher.rb#11
344
+ module Guard::Deprecated::Watcher::ClassMethods
345
+ # @return [Boolean]
346
+ #
347
+ # source://guard//lib/guard/deprecated/watcher.rb#16
348
+ def match_guardfile?(files); end
349
+ end
350
+
351
+ # source://guard//lib/guard/deprecated/watcher.rb#12
352
+ Guard::Deprecated::Watcher::ClassMethods::MATCH_GUARDFILE = T.let(T.unsafe(nil), String)
353
+
354
+ # The Dsl class provides the methods that are used in each `Guardfile` to
355
+ # describe the behaviour of Guard.
356
+ #
357
+ # The main keywords of the DSL are {#guard} and {#watch}. These are necessary
358
+ # to define the used Guard plugins and the file changes they are watching.
359
+ #
360
+ # You can optionally group the Guard plugins with the {#group} keyword and
361
+ # ignore and filter certain paths with the {#ignore} and {#filter} keywords.
362
+ #
363
+ # You can set your preferred system notification library with {#notification}
364
+ # and pass some optional configuration options for the library. If you don't
365
+ # configure a library, Guard will automatically pick one with default options
366
+ # (if you don't want notifications, specify `:off` as library). Please see
367
+ # {Notifier} for more information about the supported libraries.
368
+ #
369
+ # A more advanced DSL use is the {#callback} keyword that allows you to
370
+ # execute arbitrary code before or after any of the {Plugin#start},
371
+ # {Plugin#stop}, {Plugin#reload}, {Plugin#run_all},
372
+ # {Plugin#run_on_changes}, {Plugin#run_on_additions},
373
+ # {Plugin#run_on_modifications} and {Plugin#run_on_removals}
374
+ # Guard plugins method.
375
+ # You can even insert more hooks inside these methods. Please [checkout the
376
+ # Wiki page](https://github.com/guard/guard/wiki/Hooks-and-callbacks) for
377
+ # more details.
378
+ #
379
+ # The DSL will also evaluate normal Ruby code.
380
+ #
381
+ # There are two possible locations for the `Guardfile`:
382
+ #
383
+ # * The `Guardfile` or `guardfile.rb` in the current directory where Guard
384
+ # has been started
385
+ # * The `.Guardfile` in your home directory.
386
+ #
387
+ # In addition, if a user configuration `.guard.rb` in your home directory is
388
+ # found, it will be appended to the current project `Guardfile`.
389
+ #
390
+ # @see https://github.com/guard/guard/wiki/Guardfile-examples
391
+ #
392
+ # source://guard//lib/guard/dsl.rb#49
393
+ class Guard::Dsl
394
+ extend ::Guard::Deprecated::Dsl::ClassMethods
395
+
396
+ # Defines a callback to execute arbitrary code before or after any of
397
+ # the `start`, `stop`, `reload`, `run_all`, `run_on_changes`,
398
+ # `run_on_additions`, `run_on_modifications` and `run_on_removals` plugin
399
+ # method.
400
+ #
401
+ # @example Add callback before the `reload` action.
402
+ # callback(:reload_begin) { puts "Let's reload!" }
403
+ # @example Add callback before the `start` and `stop` actions.
404
+ #
405
+ # my_lambda = lambda do |plugin, event, *args|
406
+ # puts "Let's #{event} #{plugin} with #{args}!"
407
+ # end
408
+ #
409
+ # callback(my_lambda, [:start_begin, :start_end])
410
+ # @param args [Array] the callback arguments
411
+ # @yield a callback block
412
+ #
413
+ # source://guard//lib/guard/dsl.rb#246
414
+ def callback(*args, &block); end
415
+
416
+ # Sets Guard to clear the screen before every task is run
417
+ #
418
+ # @example switching clearing the screen on
419
+ # clearing(:on)
420
+ # @param on [Symbol] ':on' to turn on, ':off' (default) to turn off
421
+ #
422
+ # source://guard//lib/guard/dsl.rb#408
423
+ def clearing(on); end
424
+
425
+ # Sets the directories to pass to Listen
426
+ #
427
+ # @example watch only given directories
428
+ # directories %w(lib specs)
429
+ # @param directories [Array] directories for Listen to watch
430
+ #
431
+ # source://guard//lib/guard/dsl.rb#394
432
+ def directories(directories); end
433
+
434
+ # :nodoc
435
+ #
436
+ # source://guard//lib/guard/dsl.rb#377
437
+ def evaluate(contents, filename, lineno); end
438
+
439
+ # Ignores certain paths globally.
440
+ # TODO: deprecate
441
+ #
442
+ # @example Ignore some paths
443
+ # ignore %r{^ignored/path/}, /man/
444
+ # @param regexps [Regexp] a pattern (or list of patterns) for ignoring paths
445
+ #
446
+ # source://guard//lib/guard/dsl.rb#267
447
+ def filter(*regexps); end
448
+
449
+ # Replaces ignored paths globally
450
+ # TODO: deprecate
451
+ #
452
+ # @example Ignore only these paths
453
+ # ignore! %r{^ignored/path/}, /man/
454
+ # @param regexps [Regexp] a pattern (or list of patterns) for ignoring paths
455
+ #
456
+ # source://guard//lib/guard/dsl.rb#282
457
+ def filter!(*regexps); end
458
+
459
+ # Declares a group of Guard plugins to be run with `guard start --group
460
+ # group_name`.
461
+ #
462
+ # @example Declare two groups of Guard plugins
463
+ # group :backend do
464
+ # guard :spork
465
+ # guard :rspec
466
+ # end
467
+ #
468
+ # group :frontend do
469
+ # guard :passenger
470
+ # guard :livereload
471
+ # end
472
+ # @param name [Symbol, String, Array<Symbol, String>] the group name called
473
+ # from the CLI
474
+ # @param options [Hash] the options accepted by the group
475
+ # @see Group
476
+ # @see Guard.add_group
477
+ # @see #guard
478
+ # @yield a block where you can declare several Guard plugins
479
+ #
480
+ # source://guard//lib/guard/dsl.rb#124
481
+ def group(*args); end
482
+
483
+ # Declares a Guard plugin to be used when running `guard start`.
484
+ #
485
+ # The name parameter is usually the name of the gem without
486
+ # the 'guard-' prefix.
487
+ #
488
+ # The available options are different for each Guard implementation.
489
+ #
490
+ # @example Declare a Guard without `watch` patterns
491
+ # guard :rspec
492
+ # @example Declare a Guard with a `watch` pattern
493
+ # guard :rspec do
494
+ # watch %r{.*_spec.rb}
495
+ # end
496
+ # @param name [String] the Guard plugin name
497
+ # @param options [Hash] the options accepted by the Guard plugin
498
+ # @see Plugin
499
+ # @see Guard.add_plugin
500
+ # @see #watch
501
+ # @see #group
502
+ # @yield a block where you can declare several watch patterns and actions
503
+ #
504
+ # source://guard//lib/guard/dsl.rb#176
505
+ def guard(name, options = T.unsafe(nil)); end
506
+
507
+ # Ignores certain paths globally.
508
+ #
509
+ # @example Ignore some paths
510
+ # ignore %r{^ignored/path/}, /man/
511
+ # @param regexps [Regexp] a pattern (or list of patterns) for ignoring paths
512
+ #
513
+ # source://guard//lib/guard/dsl.rb#267
514
+ def ignore(*regexps); end
515
+
516
+ # Replaces ignored paths globally
517
+ #
518
+ # @example Ignore only these paths
519
+ # ignore! %r{^ignored/path/}, /man/
520
+ # @param regexps [Regexp] a pattern (or list of patterns) for ignoring paths
521
+ #
522
+ # source://guard//lib/guard/dsl.rb#282
523
+ def ignore!(*regexps); end
524
+
525
+ # Sets the interactor options or disable the interactor.
526
+ #
527
+ # @example Pass options to the interactor
528
+ # interactor option1: 'value1', option2: 'value2'
529
+ # @example Turn off interactions
530
+ # interactor :off
531
+ # @param options [Symbol, Hash] either `:off` or a Hash with interactor
532
+ # options
533
+ #
534
+ # source://guard//lib/guard/dsl.rb#91
535
+ def interactor(options); end
536
+
537
+ # Configures the Guard logger.
538
+ #
539
+ # * Log level must be either `:debug`, `:info`, `:warn` or `:error`.
540
+ # * Template supports the following placeholders: `:time`, `:severity`,
541
+ # `:progname`, `:pid`, `:unit_of_work_id` and `:message`.
542
+ # * Time format directives are the same as `Time#strftime` or
543
+ # `:milliseconds`.
544
+ # * The `:only` and `:except` options must be a `RegExp`.
545
+ #
546
+ # @example Set the log level
547
+ # logger level: :warn
548
+ # @example Set a custom log template
549
+ # logger template: '[Guard - :severity - :progname - :time] :message'
550
+ # @example Set a custom time format
551
+ # logger time_format: '%h'
552
+ # @example Limit logging to a Guard plugin
553
+ # logger only: :jasmine
554
+ # @example Log all but not the messages from a specific Guard plugin
555
+ # logger except: :jasmine
556
+ # @option options
557
+ # @option options
558
+ # @option options
559
+ # @option options
560
+ # @option options
561
+ # @param options [Hash] the log options
562
+ #
563
+ # source://guard//lib/guard/dsl.rb#325
564
+ def logger(options); end
565
+
566
+ # Set notification options for the system notifications.
567
+ # You can set multiple notifications, which allows you to show local
568
+ # system notifications and remote notifications with separate libraries.
569
+ # You can also pass `:off` as library to turn off notifications.
570
+ #
571
+ # @example Define multiple notifications
572
+ # notification :ruby_gntp
573
+ # notification :ruby_gntp, host: '192.168.1.5'
574
+ # @param notifier [Symbol, String] the name of the notifier to use
575
+ # @param opts [Hash] the notification library options
576
+ # @see Guard::Notifier for available notifier and its options.
577
+ #
578
+ # source://guard//lib/guard/dsl.rb#76
579
+ def notification(notifier, opts = T.unsafe(nil)); end
580
+
581
+ # Sets the default scope on startup
582
+ #
583
+ # @example Scope Guard to a single group
584
+ # scope group: :frontend
585
+ # @example Scope Guard to multiple groups
586
+ # scope groups: [:specs, :docs]
587
+ # @example Scope Guard to a single plugin
588
+ # scope plugin: :test
589
+ # @example Scope Guard to multiple plugins
590
+ # scope plugins: [:jasmine, :rspec]
591
+ # @param scope [Hash] the scope for the groups and plugins
592
+ #
593
+ # source://guard//lib/guard/dsl.rb#372
594
+ def scope(scope = T.unsafe(nil)); end
595
+
596
+ # Defines a pattern to be watched in order to run actions on file
597
+ # modification.
598
+ #
599
+ # modification
600
+ #
601
+ # @example Declare global watchers outside of a Guard
602
+ # watch(%r{^(.+)$}) { |m| puts "#{m[1]} changed." }
603
+ # @example Declare watchers for a Guard
604
+ # guard :rspec do
605
+ # watch('spec/spec_helper.rb')
606
+ # watch(%r{^.+_spec.rb})
607
+ # watch(%r{^app/controllers/(.+).rb}) do |m|
608
+ # 'spec/acceptance/#{m[1]}s_spec.rb'
609
+ # end
610
+ # end
611
+ # @param pattern [String, Regexp] the pattern that Guard must watch for
612
+ # @see #guard
613
+ # @see Guard::Watcher
614
+ # @yield a block to be run when the pattern is matched
615
+ # @yieldparam m [MatchData] matches of the pattern
616
+ # @yieldreturn a directory, a filename, an array of
617
+ # directories / filenames, or nothing (can be an arbitrary command)
618
+ #
619
+ # source://guard//lib/guard/dsl.rb#218
620
+ def watch(pattern, &action); end
621
+
622
+ private
623
+
624
+ # source://guard//lib/guard/dsl.rb#414
625
+ def _cleanup_backtrace(backtrace); end
626
+ end
627
+
628
+ # Wrap exceptions during parsing Guardfile
629
+ #
630
+ # source://guard//lib/guard/dsl.rb#53
631
+ class Guard::Dsl::Error < ::RuntimeError; end
632
+
633
+ # source://guard//lib/guard/dsl.rb#56
634
+ Guard::Dsl::WARN_INVALID_LOG_LEVEL = T.let(T.unsafe(nil), String)
635
+
636
+ # source://guard//lib/guard/dsl.rb#59
637
+ Guard::Dsl::WARN_INVALID_LOG_OPTIONS = T.let(T.unsafe(nil), String)
638
+
639
+ # TODO: this should probably be a base class for Dsl instead (in Guard 3.x)
640
+ #
641
+ # source://guard//lib/guard/dsl_reader.rb#5
642
+ class Guard::DslReader < ::Guard::Dsl
643
+ # @return [DslReader] a new instance of DslReader
644
+ #
645
+ # source://guard//lib/guard/dsl_reader.rb#8
646
+ def initialize; end
647
+
648
+ # source://guard//lib/guard/dsl_reader.rb#30
649
+ def callback(*_args, &_block); end
650
+
651
+ # source://guard//lib/guard/dsl_reader.rb#48
652
+ def clearing(_on); end
653
+
654
+ # source://guard//lib/guard/dsl_reader.rb#45
655
+ def directories(_directories); end
656
+
657
+ # source://guard//lib/guard/dsl_reader.rb#24
658
+ def group(*_args); end
659
+
660
+ # source://guard//lib/guard/dsl_reader.rb#13
661
+ def guard(name, _options = T.unsafe(nil)); end
662
+
663
+ # source://guard//lib/guard/dsl_reader.rb#33
664
+ def ignore(*_regexps); end
665
+
666
+ # source://guard//lib/guard/dsl_reader.rb#36
667
+ def ignore!(*_regexps); end
668
+
669
+ # source://guard//lib/guard/dsl_reader.rb#21
670
+ def interactor(_options); end
671
+
672
+ # source://guard//lib/guard/dsl_reader.rb#39
673
+ def logger(_options); end
674
+
675
+ # Stub everything else
676
+ #
677
+ # source://guard//lib/guard/dsl_reader.rb#18
678
+ def notification(_notifier, _opts = T.unsafe(nil)); end
679
+
680
+ # Returns the value of attribute plugin_names.
681
+ #
682
+ # source://guard//lib/guard/dsl_reader.rb#6
683
+ def plugin_names; end
684
+
685
+ # source://guard//lib/guard/dsl_reader.rb#42
686
+ def scope(_scope = T.unsafe(nil)); end
687
+
688
+ # source://guard//lib/guard/dsl_reader.rb#27
689
+ def watch(_pattern, &_action); end
690
+ end
691
+
692
+ # A group of Guard plugins. There are two reasons why you want to group your
693
+ # Guard plugins:
694
+ #
695
+ # * You can start only certain groups from the command line by passing the
696
+ # `--group` option to `guard start`.
697
+ # * Abort task execution chain on failure within a group with the
698
+ # `:halt_on_fail` option.
699
+ #
700
+ # @example Group that aborts on failure
701
+ #
702
+ # group :frontend, halt_on_fail: true do
703
+ # guard 'coffeescript', input: 'spec/coffeescripts',
704
+ # output: 'spec/javascripts'
705
+ # guard 'jasmine-headless-webkit' do
706
+ # watch(%r{^spec/javascripts/(.*)\..*}) do |m|
707
+ # newest_js_file("spec/javascripts/#{m[1]}_spec")
708
+ # end
709
+ # end
710
+ # end
711
+ # @see Guard::CLI
712
+ #
713
+ # source://guard//lib/guard/group.rb#24
714
+ class Guard::Group
715
+ # Initializes a Group.
716
+ #
717
+ # @option options
718
+ # @param name [String] the name of the group
719
+ # @param options [Hash] the group options
720
+ # @return [Group] a new instance of Group
721
+ #
722
+ # source://guard//lib/guard/group.rb#35
723
+ def initialize(name, options = T.unsafe(nil)); end
724
+
725
+ # Returns the value of attribute name.
726
+ #
727
+ # source://guard//lib/guard/group.rb#25
728
+ def name; end
729
+
730
+ # Sets the attribute name
731
+ #
732
+ # @param value the value to set the attribute name to.
733
+ #
734
+ # source://guard//lib/guard/group.rb#25
735
+ def name=(_arg0); end
736
+
737
+ # Returns the value of attribute options.
738
+ #
739
+ # source://guard//lib/guard/group.rb#25
740
+ def options; end
741
+
742
+ # Sets the attribute options
743
+ #
744
+ # @param value the value to set the attribute options to.
745
+ #
746
+ # source://guard//lib/guard/group.rb#25
747
+ def options=(_arg0); end
748
+
749
+ # Returns the group title.
750
+ #
751
+ # @example Title for a group named 'backend'
752
+ # > Guard::Group.new('backend').title
753
+ # => "Backend"
754
+ # @return [String]
755
+ #
756
+ # source://guard//lib/guard/group.rb#48
757
+ def title; end
758
+
759
+ # String representation of the group.
760
+ #
761
+ # @example String representation of a group named 'backend'
762
+ # > Guard::Group.new('backend').to_s
763
+ # => "#<Guard::Group @name=backend @options={}>"
764
+ # @return [String] the string representation
765
+ #
766
+ # source://guard//lib/guard/group.rb#60
767
+ def to_s; end
768
+ end
769
+
770
+ # source://guard//lib/guard/guardfile/evaluator.rb#11
771
+ module Guard::Guardfile; end
772
+
773
+ # This class is responsible for evaluating the Guardfile. It delegates to
774
+ # Guard::Dsl for the actual objects generation from the Guardfile content.
775
+ #
776
+ # TODO: rename this to a Locator or Loader or something
777
+ #
778
+ # @see Guard::Dsl
779
+ #
780
+ # source://guard//lib/guard/guardfile/evaluator.rb#18
781
+ class Guard::Guardfile::Evaluator
782
+ include ::Guard::Deprecated::Evaluator
783
+
784
+ # Initializes a new Guard::Guardfile::Evaluator object.
785
+ #
786
+ # content of a valid Guardfile
787
+ #
788
+ # @option opts
789
+ # @option opts
790
+ # @param opts [Hash] a customizable set of options
791
+ # @return [Evaluator] a new instance of Evaluator
792
+ #
793
+ # source://guard//lib/guard/guardfile/evaluator.rb#57
794
+ def initialize(opts = T.unsafe(nil)); end
795
+
796
+ # @return [Boolean]
797
+ #
798
+ # source://guard//lib/guard/guardfile/evaluator.rb#121
799
+ def custom?; end
800
+
801
+ # Evaluates the DSL methods in the `Guardfile`.
802
+ #
803
+ # path
804
+ #
805
+ # options = { guardfile: '/Users/guardfile/MyAwesomeGuardfile' }
806
+ # Guard::Guardfile::Evaluator.new(options).evaluate
807
+ #
808
+ # @example Programmatically evaluate a Guardfile
809
+ # Guard::Guardfile::Evaluator.new.evaluate
810
+ # @example Programmatically evaluate a Guardfile with a custom Guardfile
811
+ # @example Programmatically evaluate a Guardfile with an inline Guardfile
812
+ #
813
+ # options = { contents: 'guard :rspec' }
814
+ # Guard::Guardfile::Evaluator.new(options).evaluate
815
+ #
816
+ # source://guard//lib/guard/guardfile/evaluator.rb#89
817
+ def evaluate; end
818
+
819
+ # Gets the content of the `Guardfile` concatenated with the global
820
+ # user configuration file.
821
+ #
822
+ # @example Programmatically get the content of the current Guardfile
823
+ # Guard::Guardfile::Evaluator.new.guardfile_contents
824
+ # => "guard :rspec"
825
+ # @return [String] the Guardfile content
826
+ #
827
+ # source://guard//lib/guard/guardfile/evaluator.rb#134
828
+ def guardfile_contents; end
829
+
830
+ # Tests if the current `Guardfile` contains a specific Guard plugin.
831
+ #
832
+ # plugin
833
+ #
834
+ # File.read('Guardfile')
835
+ # => "guard :rspec"
836
+ #
837
+ # Guard::Guardfile::Evaluator.new.guardfile_include?('rspec)
838
+ # => true
839
+ #
840
+ # TODO: rename this method to it matches RSpec examples better
841
+ #
842
+ # @example Programmatically test if a Guardfile contains a specific Guard
843
+ # @param plugin_name [String] the name of the Guard
844
+ # @return [Boolean] whether the Guard plugin has been declared
845
+ #
846
+ # source://guard//lib/guard/guardfile/evaluator.rb#113
847
+ def guardfile_include?(plugin_name); end
848
+
849
+ # Returns the value of attribute guardfile_path.
850
+ #
851
+ # source://guard//lib/guard/guardfile/evaluator.rb#30
852
+ def guardfile_path; end
853
+
854
+ # source://guard//lib/guard/guardfile/evaluator.rb#47
855
+ def guardfile_source; end
856
+
857
+ # @return [Boolean]
858
+ #
859
+ # source://guard//lib/guard/guardfile/evaluator.rb#139
860
+ def inline?; end
861
+
862
+ # Returns the value of attribute options.
863
+ #
864
+ # source://guard//lib/guard/guardfile/evaluator.rb#30
865
+ def options; end
866
+
867
+ # Returns the value of attribute path.
868
+ #
869
+ # source://guard//lib/guard/guardfile/evaluator.rb#119
870
+ def path; end
871
+
872
+ private
873
+
874
+ # source://guard//lib/guard/guardfile/evaluator.rb#156
875
+ def _fetch_guardfile_contents; end
876
+
877
+ # source://guard//lib/guard/guardfile/evaluator.rb#223
878
+ def _from_deprecated(opts); end
879
+
880
+ # source://guard//lib/guard/guardfile/evaluator.rb#212
881
+ def _guardfile_contents; end
882
+
883
+ # @return [Boolean]
884
+ #
885
+ # source://guard//lib/guard/guardfile/evaluator.rb#219
886
+ def _guardfile_contents_usable?; end
887
+
888
+ # source://guard//lib/guard/guardfile/evaluator.rb#145
889
+ def _guardfile_contents_without_user_config; end
890
+
891
+ # source://guard//lib/guard/guardfile/evaluator.rb#149
892
+ def _instance_eval_guardfile(contents); end
893
+
894
+ # source://guard//lib/guard/guardfile/evaluator.rb#200
895
+ def _read(path); end
896
+
897
+ # source://guard//lib/guard/guardfile/evaluator.rb#186
898
+ def _use_default!; end
899
+
900
+ # source://guard//lib/guard/guardfile/evaluator.rb#165
901
+ def _use_inline; end
902
+
903
+ # source://guard//lib/guard/guardfile/evaluator.rb#178
904
+ def _use_provided; end
905
+ end
906
+
907
+ # source://guard//lib/guard/guardfile/evaluator.rb#21
908
+ Guard::Guardfile::Evaluator::DEFAULT_GUARDFILES = T.let(T.unsafe(nil), Array)
909
+
910
+ # source://guard//lib/guard/guardfile/evaluator.rb#27
911
+ Guard::Guardfile::Evaluator::ERROR_NO_GUARDFILE = T.let(T.unsafe(nil), String)
912
+
913
+ # source://guard//lib/guard/guardfile/evaluator.rb#32
914
+ Guard::Guardfile::Evaluator::ERROR_NO_PLUGINS = T.let(T.unsafe(nil), String)
915
+
916
+ # source://guard//lib/guard/guardfile/evaluator.rb#35
917
+ class Guard::Guardfile::Evaluator::Error < ::RuntimeError; end
918
+
919
+ # source://guard//lib/guard/guardfile/evaluator.rb#41
920
+ class Guard::Guardfile::Evaluator::NoCustomGuardfile < ::Guard::Guardfile::Evaluator::Error; end
921
+
922
+ # source://guard//lib/guard/guardfile/evaluator.rb#38
923
+ class Guard::Guardfile::Evaluator::NoGuardfileError < ::Guard::Guardfile::Evaluator::Error; end
924
+
925
+ # source://guard//lib/guard/guardfile/evaluator.rb#44
926
+ class Guard::Guardfile::Evaluator::NoPluginsError < ::Guard::Guardfile::Evaluator::Error; end
927
+
928
+ # source://guard//lib/guard/interactor.rb#4
929
+ class Guard::Interactor
930
+ extend ::Forwardable
931
+
932
+ # Initializes the interactor. This configures
933
+ # Pry and creates some custom commands and aliases
934
+ # for Guard.
935
+ #
936
+ # @return [Interactor] a new instance of Interactor
937
+ #
938
+ # source://guard//lib/guard/interactor.rb#9
939
+ def initialize(no_interaction = T.unsafe(nil)); end
940
+
941
+ # source://forwardable/1.3.3/forwardable.rb#231
942
+ def background(*args, **_arg1, &block); end
943
+
944
+ # source://forwardable/1.3.3/forwardable.rb#231
945
+ def foreground(*args, **_arg1, &block); end
946
+
947
+ # source://forwardable/1.3.3/forwardable.rb#231
948
+ def handle_interrupt(*args, **_arg1, &block); end
949
+
950
+ # @return [Boolean]
951
+ #
952
+ # source://guard//lib/guard/interactor.rb#20
953
+ def interactive?; end
954
+
955
+ private
956
+
957
+ # Returns the value of attribute idle_job.
958
+ #
959
+ # source://guard//lib/guard/interactor.rb#51
960
+ def idle_job; end
961
+
962
+ class << self
963
+ # TODO: allow custom user idle jobs, e.g. [:pry, :sleep, :exit, ...]
964
+ #
965
+ # @return [Boolean]
966
+ #
967
+ # source://guard//lib/guard/interactor.rb#39
968
+ def enabled; end
969
+
970
+ # TODO: handle switching interactors during runtime?
971
+ #
972
+ # source://guard//lib/guard/interactor.rb#46
973
+ def enabled=(_arg0); end
974
+
975
+ # TODO: allow custom user idle jobs, e.g. [:pry, :sleep, :exit, ...]
976
+ #
977
+ # @return [Boolean]
978
+ #
979
+ # source://guard//lib/guard/interactor.rb#39
980
+ def enabled?; end
981
+
982
+ # source://guard//lib/guard/interactor.rb#31
983
+ def options; end
984
+
985
+ # Pass options to interactor's job when it's created
986
+ #
987
+ # source://guard//lib/guard/interactor.rb#36
988
+ def options=(_arg0); end
989
+ end
990
+ end
991
+
992
+ # @private api
993
+ #
994
+ # source://guard//lib/guard/internals/groups.rb#5
995
+ module Guard::Internals; end
996
+
997
+ # source://guard//lib/guard/internals/debugging.rb#12
998
+ class Guard::Internals::Debugging
999
+ class << self
1000
+ # Sets up debugging:
1001
+ #
1002
+ # * aborts on thread exceptions
1003
+ # * Set the logging level to `:debug`
1004
+ # * traces execution of Kernel.system and backtick calls
1005
+ #
1006
+ # source://guard//lib/guard/internals/debugging.rb#26
1007
+ def start; end
1008
+
1009
+ # source://guard//lib/guard/internals/debugging.rb#38
1010
+ def stop; end
1011
+
1012
+ private
1013
+
1014
+ # source://guard//lib/guard/internals/debugging.rb#46
1015
+ def _notify(*args); end
1016
+
1017
+ # reset singleton - called by tests
1018
+ #
1019
+ # source://guard//lib/guard/internals/debugging.rb#51
1020
+ def _reset; end
1021
+
1022
+ # source://guard//lib/guard/internals/debugging.rb#58
1023
+ def _trace(mod, meth, &block); end
1024
+
1025
+ # source://guard//lib/guard/internals/debugging.rb#62
1026
+ def _untrace(mod, meth); end
1027
+ end
1028
+ end
1029
+
1030
+ # source://guard//lib/guard/internals/groups.rb#6
1031
+ class Guard::Internals::Groups
1032
+ # @return [Groups] a new instance of Groups
1033
+ #
1034
+ # source://guard//lib/guard/internals/groups.rb#9
1035
+ def initialize; end
1036
+
1037
+ # source://guard//lib/guard/internals/groups.rb#19
1038
+ def add(name, options = T.unsafe(nil)); end
1039
+
1040
+ # source://guard//lib/guard/internals/groups.rb#13
1041
+ def all(filter = T.unsafe(nil)); end
1042
+
1043
+ private
1044
+
1045
+ # source://guard//lib/guard/internals/groups.rb#28
1046
+ def matcher_for(filter); end
1047
+ end
1048
+
1049
+ # source://guard//lib/guard/internals/groups.rb#7
1050
+ Guard::Internals::Groups::DEFAULT_GROUPS = T.let(T.unsafe(nil), Array)
1051
+
1052
+ # source://guard//lib/guard/internals/helpers.rb#4
1053
+ module Guard::Internals::Helpers
1054
+ # source://guard//lib/guard/internals/helpers.rb#5
1055
+ def _relative_pathname(path); end
1056
+ end
1057
+
1058
+ # source://guard//lib/guard/internals/plugins.rb#8
1059
+ class Guard::Internals::Plugins
1060
+ # @return [Plugins] a new instance of Plugins
1061
+ #
1062
+ # source://guard//lib/guard/internals/plugins.rb#9
1063
+ def initialize; end
1064
+
1065
+ # TODO: should it allow duplicates? (probably yes because of different
1066
+ # configs or groups)
1067
+ #
1068
+ # source://guard//lib/guard/internals/plugins.rb#25
1069
+ def add(name, options); end
1070
+
1071
+ # source://guard//lib/guard/internals/plugins.rb#13
1072
+ def all(filter = T.unsafe(nil)); end
1073
+
1074
+ # source://guard//lib/guard/internals/plugins.rb#19
1075
+ def remove(plugin); end
1076
+
1077
+ private
1078
+
1079
+ # source://guard//lib/guard/internals/plugins.rb#31
1080
+ def matcher_for(filter); end
1081
+ end
1082
+
1083
+ # source://guard//lib/guard/internals/queue.rb#3
1084
+ class Guard::Internals::Queue
1085
+ # @return [Queue] a new instance of Queue
1086
+ #
1087
+ # source://guard//lib/guard/internals/queue.rb#4
1088
+ def initialize(commander); end
1089
+
1090
+ # source://guard//lib/guard/internals/queue.rb#31
1091
+ def <<(changes); end
1092
+
1093
+ # @return [Boolean]
1094
+ #
1095
+ # source://guard//lib/guard/internals/queue.rb#27
1096
+ def pending?; end
1097
+
1098
+ # Process the change queue, running tasks within the main Guard thread
1099
+ #
1100
+ # source://guard//lib/guard/internals/queue.rb#10
1101
+ def process; end
1102
+
1103
+ private
1104
+
1105
+ # source://guard//lib/guard/internals/queue.rb#37
1106
+ def _run_actions(actions); end
1107
+ end
1108
+
1109
+ # source://guard//lib/guard/internals/scope.rb#6
1110
+ class Guard::Internals::Scope
1111
+ # @return [Scope] a new instance of Scope
1112
+ #
1113
+ # source://guard//lib/guard/internals/scope.rb#7
1114
+ def initialize; end
1115
+
1116
+ # source://guard//lib/guard/internals/scope.rb#51
1117
+ def from_interactor(scope); end
1118
+
1119
+ # TODO: refactor
1120
+ #
1121
+ # source://guard//lib/guard/internals/scope.rb#20
1122
+ def grouped_plugins(scope = T.unsafe(nil)); end
1123
+
1124
+ # source://guard//lib/guard/internals/scope.rb#56
1125
+ def titles(scope = T.unsafe(nil)); end
1126
+
1127
+ # source://guard//lib/guard/internals/scope.rb#12
1128
+ def to_hash; end
1129
+
1130
+ private
1131
+
1132
+ # source://guard//lib/guard/internals/scope.rb#108
1133
+ def _find_non_empty_scope(type, local_scope); end
1134
+
1135
+ # source://guard//lib/guard/internals/scope.rb#112
1136
+ def _groups; end
1137
+
1138
+ # TODO: let the Plugins and Groups classes handle this?
1139
+ # TODO: why even instantiate?? just to check if it exists?
1140
+ #
1141
+ # source://guard//lib/guard/internals/scope.rb#77
1142
+ def _hashify_scope(type); end
1143
+
1144
+ # source://guard//lib/guard/internals/scope.rb#102
1145
+ def _instantiate(meth, obj); end
1146
+
1147
+ # source://guard//lib/guard/internals/scope.rb#116
1148
+ def _plugins; end
1149
+
1150
+ # TODO: move to session
1151
+ #
1152
+ # source://guard//lib/guard/internals/scope.rb#68
1153
+ def _scope_names(new_scope, name); end
1154
+ end
1155
+
1156
+ # TODO: split into a commandline class and session (plugins, groups)
1157
+ # TODO: swap session and metadata
1158
+ #
1159
+ # source://guard//lib/guard/internals/session.rb#11
1160
+ class Guard::Internals::Session
1161
+ # @return [Session] a new instance of Session
1162
+ #
1163
+ # source://guard//lib/guard/internals/session.rb#51
1164
+ def initialize(new_options); end
1165
+
1166
+ # @return [Boolean]
1167
+ #
1168
+ # source://guard//lib/guard/internals/session.rb#102
1169
+ def clear?; end
1170
+
1171
+ # source://guard//lib/guard/internals/session.rb#98
1172
+ def clearing(on); end
1173
+
1174
+ # @return [Boolean]
1175
+ #
1176
+ # source://guard//lib/guard/internals/session.rb#102
1177
+ def clearing?; end
1178
+
1179
+ # source://guard//lib/guard/internals/session.rb#43
1180
+ def cmdline_groups; end
1181
+
1182
+ # source://guard//lib/guard/internals/session.rb#47
1183
+ def cmdline_plugins; end
1184
+
1185
+ # TODO: call this from within action, not within interactor command
1186
+ #
1187
+ # source://guard//lib/guard/internals/session.rb#162
1188
+ def convert_scope(entries); end
1189
+
1190
+ # @return [Boolean]
1191
+ #
1192
+ # source://guard//lib/guard/internals/session.rb#108
1193
+ def debug?; end
1194
+
1195
+ # source://guard//lib/guard/internals/session.rb#136
1196
+ def evaluator_options; end
1197
+
1198
+ # Returns the value of attribute groups.
1199
+ #
1200
+ # source://guard//lib/guard/internals/session.rb#13
1201
+ def groups; end
1202
+
1203
+ # TODO: create a EvaluatorResult class?
1204
+ #
1205
+ # source://guard//lib/guard/internals/session.rb#89
1206
+ def guardfile_group_scope; end
1207
+
1208
+ # Returns the value of attribute guardfile_ignore.
1209
+ #
1210
+ # source://guard//lib/guard/internals/session.rb#93
1211
+ def guardfile_ignore; end
1212
+
1213
+ # source://guard//lib/guard/internals/session.rb#94
1214
+ def guardfile_ignore=(ignores); end
1215
+
1216
+ # Returns the value of attribute guardfile_ignore_bang.
1217
+ #
1218
+ # source://guard//lib/guard/internals/session.rb#91
1219
+ def guardfile_ignore_bang; end
1220
+
1221
+ # Sets the attribute guardfile_ignore_bang
1222
+ #
1223
+ # @param value the value to set the attribute guardfile_ignore_bang to.
1224
+ #
1225
+ # source://guard//lib/guard/internals/session.rb#91
1226
+ def guardfile_ignore_bang=(_arg0); end
1227
+
1228
+ # source://guard//lib/guard/internals/session.rb#155
1229
+ def guardfile_notification=(config); end
1230
+
1231
+ # Returns the value of attribute guardfile_plugin_scope.
1232
+ #
1233
+ # source://guard//lib/guard/internals/session.rb#90
1234
+ def guardfile_plugin_scope; end
1235
+
1236
+ # source://guard//lib/guard/internals/session.rb#74
1237
+ def guardfile_scope(scope); end
1238
+
1239
+ # Returns the value of attribute interactor_name.
1240
+ #
1241
+ # source://guard//lib/guard/internals/session.rb#159
1242
+ def interactor_name; end
1243
+
1244
+ # source://guard//lib/guard/internals/session.rb#123
1245
+ def listener_args; end
1246
+
1247
+ # source://guard//lib/guard/internals/session.rb#145
1248
+ def notify_options; end
1249
+
1250
+ # Returns the value of attribute plugins.
1251
+ #
1252
+ # source://guard//lib/guard/internals/session.rb#12
1253
+ def plugins; end
1254
+
1255
+ # source://guard//lib/guard/internals/session.rb#112
1256
+ def watchdirs; end
1257
+
1258
+ # set by Dsl with :directories() command
1259
+ #
1260
+ # source://guard//lib/guard/internals/session.rb#118
1261
+ def watchdirs=(dirs); end
1262
+ end
1263
+
1264
+ # source://guard//lib/guard/internals/session.rb#15
1265
+ Guard::Internals::Session::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash)
1266
+
1267
+ # source://guard//lib/guard/internals/state.rb#10
1268
+ class Guard::Internals::State
1269
+ # Minimal setup for non-interactive commands (list, init, show, etc.)
1270
+ #
1271
+ # @return [State] a new instance of State
1272
+ #
1273
+ # source://guard//lib/guard/internals/state.rb#12
1274
+ def initialize(cmdline_opts); end
1275
+
1276
+ # Returns the value of attribute scope.
1277
+ #
1278
+ # source://guard//lib/guard/internals/state.rb#21
1279
+ def scope; end
1280
+
1281
+ # Returns the value of attribute session.
1282
+ #
1283
+ # source://guard//lib/guard/internals/state.rb#22
1284
+ def session; end
1285
+ end
1286
+
1287
+ # source://guard//lib/guard/internals/tracing.rb#3
1288
+ module Guard::Internals::Tracing
1289
+ class << self
1290
+ # source://guard//lib/guard/internals/tracing.rb#4
1291
+ def trace(mod, meth); end
1292
+
1293
+ # source://guard//lib/guard/internals/tracing.rb#19
1294
+ def untrace(mod, meth); end
1295
+ end
1296
+ end
1297
+
1298
+ # source://guard//lib/guard/internals/traps.rb#3
1299
+ module Guard::Internals::Traps
1300
+ class << self
1301
+ # source://guard//lib/guard/internals/traps.rb#4
1302
+ def handle(signal, &block); end
1303
+ end
1304
+ end
1305
+
1306
+ # source://guard//lib/guard/notifier.rb#5
1307
+ class Guard::Notifier
1308
+ class << self
1309
+ # source://guard//lib/guard/notifier.rb#6
1310
+ def connect(options = T.unsafe(nil)); end
1311
+
1312
+ # Used by dsl describer
1313
+ #
1314
+ # source://guard//lib/guard/notifier.rb#65
1315
+ def detected; end
1316
+
1317
+ # source://guard//lib/guard/notifier.rb#18
1318
+ def disconnect; end
1319
+
1320
+ # source://guard//lib/guard/notifier.rb#27
1321
+ def notify(message, options = T.unsafe(nil)); end
1322
+
1323
+ # Used by dsl describer
1324
+ #
1325
+ # source://guard//lib/guard/notifier.rb#60
1326
+ def supported; end
1327
+
1328
+ # source://guard//lib/guard/notifier.rb#44
1329
+ def toggle; end
1330
+
1331
+ # source://guard//lib/guard/notifier.rb#40
1332
+ def turn_on; end
1333
+ end
1334
+ end
1335
+
1336
+ # source://guard//lib/guard/notifier.rb#23
1337
+ Guard::Notifier::DEPRECATED_IMPLICIT_CONNECT = T.let(T.unsafe(nil), String)
1338
+
1339
+ # A class that holds options. Can be instantiated with default options.
1340
+ #
1341
+ # source://guard//lib/guard/options.rb#6
1342
+ class Guard::Options < ::Thor::CoreExt::HashWithIndifferentAccess
1343
+ # Initializes an Guard::Options object. `default_opts` is merged into
1344
+ # `opts`.
1345
+ #
1346
+ # @param opts [Hash] the options
1347
+ # @param default_opts [Hash] the default options
1348
+ # @return [Options] a new instance of Options
1349
+ #
1350
+ # source://guard//lib/guard/options.rb#13
1351
+ def initialize(opts = T.unsafe(nil), default_opts = T.unsafe(nil)); end
1352
+
1353
+ # workaround for: https://github.com/erikhuda/thor/issues/504
1354
+ #
1355
+ # source://guard//lib/guard/options.rb#18
1356
+ def fetch(name); end
1357
+ end
1358
+
1359
+ # Base class from which every Guard plugin implementation must inherit.
1360
+ #
1361
+ # Guard will trigger the {#start}, {#stop}, {#reload}, {#run_all} and
1362
+ # {#run_on_changes} ({#run_on_additions}, {#run_on_modifications} and
1363
+ # {#run_on_removals}) task methods depending on user interaction and file
1364
+ # modification.
1365
+ #
1366
+ # {#run_on_changes} could be implemented to handle all the changes task case
1367
+ # (additions, modifications, removals) in once, or each task can be
1368
+ # implemented separately with a specific behavior.
1369
+ #
1370
+ # In each of these Guard task methods you have to implement some work when
1371
+ # you want to support this kind of task. The return value of each Guard task
1372
+ # method is not evaluated by Guard, but it'll be passed to the "_end" hook
1373
+ # for further evaluation. You can throw `:task_has_failed` to indicate that
1374
+ # your Guard plugin method was not successful, and successive Guard plugin
1375
+ # tasks will be aborted when the group has set the `:halt_on_fail` option.
1376
+ #
1377
+ # Each Guard plugin should provide a template Guardfile located within the Gem
1378
+ # at `lib/guard/guard-name/templates/Guardfile`.
1379
+ #
1380
+ # Watchers for a Guard plugin should return a file path or an array of files
1381
+ # paths to Guard, but if your Guard plugin wants to allow any return value
1382
+ # from a watcher, you can set the `any_return` option to true.
1383
+ #
1384
+ # If one of those methods raises an exception other than `:task_has_failed`,
1385
+ # the `Guard::GuardName` instance will be removed from the active Guard
1386
+ # plugins.
1387
+ #
1388
+ # @example Throw :task_has_failed
1389
+ #
1390
+ # def run_all
1391
+ # if !runner.run(['all'])
1392
+ # throw :task_has_failed
1393
+ # end
1394
+ # end
1395
+ # @see Guard::Group
1396
+ #
1397
+ # source://guard//lib/guard/plugin.rb#44
1398
+ class Guard::Plugin
1399
+ # Initializes a Guard plugin.
1400
+ # Don't do any work here, especially as Guard plugins get initialized even
1401
+ # if they are not in an active group!
1402
+ #
1403
+ # @option options
1404
+ # @option options
1405
+ # @option options
1406
+ # @param options [Hash] the Guard plugin options
1407
+ # @return [Plugin] a new instance of Plugin
1408
+ #
1409
+ # source://guard//lib/guard/plugin.rb#285
1410
+ def initialize(options = T.unsafe(nil)); end
1411
+
1412
+ # Returns the value of attribute callbacks.
1413
+ #
1414
+ # source://guard//lib/guard/plugin.rb#129
1415
+ def callbacks; end
1416
+
1417
+ # Sets the attribute callbacks
1418
+ #
1419
+ # @param value the value to set the attribute callbacks to.
1420
+ #
1421
+ # source://guard//lib/guard/plugin.rb#129
1422
+ def callbacks=(_arg0); end
1423
+
1424
+ # Returns the value of attribute group.
1425
+ #
1426
+ # source://guard//lib/guard/plugin.rb#129
1427
+ def group; end
1428
+
1429
+ # Sets the attribute group
1430
+ #
1431
+ # @param value the value to set the attribute group to.
1432
+ #
1433
+ # source://guard//lib/guard/plugin.rb#129
1434
+ def group=(_arg0); end
1435
+
1436
+ # When event is a Symbol, {#hook} will generate a hook name
1437
+ # by concatenating the method name from where {#hook} is called
1438
+ # with the given Symbol.
1439
+ #
1440
+ # Here, when {Guard::Plugin#run_all} is called, {#hook} will notify
1441
+ # callbacks registered for the "run_all_foo" event.
1442
+ #
1443
+ # When event is a String, {#hook} will directly turn the String
1444
+ # into a Symbol.
1445
+ #
1446
+ # When {Guard::Plugin::run_all} is called, {#hook} will notify
1447
+ # callbacks registered for the "foo_bar" event.
1448
+ #
1449
+ # @example Add a hook with a Symbol
1450
+ #
1451
+ # def run_all
1452
+ # hook :foo
1453
+ # end
1454
+ # @example Add a hook with a String
1455
+ #
1456
+ # def run_all
1457
+ # hook "foo_bar"
1458
+ # end
1459
+ # @param event [Symbol, String] the name of the Guard event
1460
+ # @param args [Array] the parameters are passed as is to the callbacks
1461
+ # registered for the given event.
1462
+ #
1463
+ # source://guard//lib/guard/plugin.rb#116
1464
+ def hook(event, *args); end
1465
+
1466
+ # Returns the plugin's name (without "guard-").
1467
+ #
1468
+ # @example Name for Guard::RSpec
1469
+ # Guard::RSpec.new.name
1470
+ # #=> "rspec"
1471
+ # @return [String]
1472
+ #
1473
+ # source://guard//lib/guard/plugin.rb#240
1474
+ def name; end
1475
+
1476
+ # Returns the value of attribute options.
1477
+ #
1478
+ # source://guard//lib/guard/plugin.rb#129
1479
+ def options; end
1480
+
1481
+ # Sets the attribute options
1482
+ #
1483
+ # @param value the value to set the attribute options to.
1484
+ #
1485
+ # source://guard//lib/guard/plugin.rb#129
1486
+ def options=(_arg0); end
1487
+
1488
+ # Returns the plugin's class name without the Guard:: namespace.
1489
+ #
1490
+ # @example Title for Guard::RSpec
1491
+ # Guard::RSpec.new.title
1492
+ # #=> "RSpec"
1493
+ # @return [String]
1494
+ #
1495
+ # source://guard//lib/guard/plugin.rb#252
1496
+ def title; end
1497
+
1498
+ # String representation of the plugin.
1499
+ #
1500
+ # @example String representation of an instance of the Guard::RSpec plugin
1501
+ #
1502
+ # Guard::RSpec.new.title
1503
+ # #=> "#<Guard::RSpec @name=rspec @group=#<Guard::Group @name=default
1504
+ # @options={}> @watchers=[] @callbacks=[] @options={all_after_pass:
1505
+ # true}>"
1506
+ # @return [String] the string representation
1507
+ #
1508
+ # source://guard//lib/guard/plugin.rb#267
1509
+ def to_s; end
1510
+
1511
+ # Returns the value of attribute watchers.
1512
+ #
1513
+ # source://guard//lib/guard/plugin.rb#129
1514
+ def watchers; end
1515
+
1516
+ # Sets the attribute watchers
1517
+ #
1518
+ # @param value the value to set the attribute watchers to.
1519
+ #
1520
+ # source://guard//lib/guard/plugin.rb#129
1521
+ def watchers=(_arg0); end
1522
+
1523
+ private
1524
+
1525
+ # Add all the Guard::Plugin's callbacks to the global @callbacks array
1526
+ # that's used by Guard to know which callbacks to notify.
1527
+ #
1528
+ # source://guard//lib/guard/plugin.rb#297
1529
+ def _register_callbacks; end
1530
+
1531
+ class << self
1532
+ # Add a callback.
1533
+ #
1534
+ # @param listener [Block] the listener to notify
1535
+ # @param guard_plugin [Guard::Plugin] the Guard plugin to add the callback
1536
+ # @param events [Array<Symbol>] the events to register
1537
+ #
1538
+ # source://guard//lib/guard/plugin.rb#62
1539
+ def add_callback(listener, guard_plugin, events); end
1540
+
1541
+ # Get all callbacks registered for all Guard plugins present in the
1542
+ # Guardfile.
1543
+ #
1544
+ # source://guard//lib/guard/plugin.rb#52
1545
+ def callbacks; end
1546
+
1547
+ # Returns the non-namespaced class name of the plugin
1548
+ #
1549
+ # @example Non-namespaced class name for Guard::RSpec
1550
+ # Guard::RSpec.non_namespaced_classname
1551
+ # #=> "RSpec"
1552
+ # @return [String]
1553
+ #
1554
+ # source://guard//lib/guard/plugin.rb#140
1555
+ def non_namespaced_classname; end
1556
+
1557
+ # Returns the non-namespaced name of the plugin
1558
+ #
1559
+ # @example Non-namespaced name for Guard::RSpec
1560
+ # Guard::RSpec.non_namespaced_name
1561
+ # #=> "rspec"
1562
+ # @return [String]
1563
+ #
1564
+ # source://guard//lib/guard/plugin.rb#153
1565
+ def non_namespaced_name; end
1566
+
1567
+ # Notify a callback.
1568
+ #
1569
+ # @param guard_plugin [Guard::Plugin] the Guard plugin to add the callback
1570
+ # @param event [Symbol] the event to trigger
1571
+ # @param args [Array] the arguments for the listener
1572
+ #
1573
+ # source://guard//lib/guard/plugin.rb#74
1574
+ def notify(guard_plugin, event, *args); end
1575
+
1576
+ # Reset all callbacks.
1577
+ #
1578
+ # TODO: remove (not used anywhere)
1579
+ #
1580
+ # source://guard//lib/guard/plugin.rb#83
1581
+ def reset_callbacks!; end
1582
+
1583
+ # Specify the source for the Guardfile template.
1584
+ # Each Guard plugin can redefine this method to add its own logic.
1585
+ #
1586
+ # @param plugin_location [String] the plugin location
1587
+ #
1588
+ # source://guard//lib/guard/plugin.rb#162
1589
+ def template(plugin_location); end
1590
+ end
1591
+ end
1592
+
1593
+ # source://guard//lib/guard/plugin.rb#45
1594
+ Guard::Plugin::TEMPLATE_FORMAT = T.let(T.unsafe(nil), String)
1595
+
1596
+ # This class contains useful methods to:
1597
+ #
1598
+ # * Fetch all the Guard plugins names;
1599
+ # * Initialize a plugin, get its location;
1600
+ # * Return its class name;
1601
+ # * Add its template to the Guardfile.
1602
+ #
1603
+ # source://guard//lib/guard/plugin_util.rb#11
1604
+ class Guard::PluginUtil
1605
+ # Initializes a new `Guard::PluginUtil` object.
1606
+ #
1607
+ # @param name [String] the name of the Guard plugin
1608
+ # @return [PluginUtil] a new instance of PluginUtil
1609
+ #
1610
+ # source://guard//lib/guard/plugin_util.rb#36
1611
+ def initialize(name); end
1612
+
1613
+ # Adds a plugin's template to the Guardfile.
1614
+ #
1615
+ # source://guard//lib/guard/plugin_util.rb#126
1616
+ def add_to_guardfile; end
1617
+
1618
+ # Initializes a new `Guard::Plugin` with the given `options` hash. This
1619
+ # methods handles plugins that inherit from the deprecated `Guard::Guard`
1620
+ # class as well as plugins that inherit from `Guard::Plugin`.
1621
+ #
1622
+ # upgrade for Guard 2.0
1623
+ #
1624
+ # @return [Guard::Plugin] the initialized plugin
1625
+ # @return [Guard::Guard] the initialized plugin. This return type is
1626
+ # deprecated and the plugin's maintainer should update it to be
1627
+ # compatible with Guard 2.0. For more information on how to upgrade for
1628
+ # Guard 2.0, please head over to:
1629
+ # https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0
1630
+ # @see Guard::Plugin
1631
+ # @see https://github.com/guard/guard/wiki/Upgrading-to-Guard-2.0 How to
1632
+ #
1633
+ # source://guard//lib/guard/plugin_util.rb#55
1634
+ def initialize_plugin(options); end
1635
+
1636
+ # Returns the value of attribute name.
1637
+ #
1638
+ # source://guard//lib/guard/plugin_util.rb#18
1639
+ def name; end
1640
+
1641
+ # Sets the attribute name
1642
+ #
1643
+ # @param value the value to set the attribute name to.
1644
+ #
1645
+ # source://guard//lib/guard/plugin_util.rb#18
1646
+ def name=(_arg0); end
1647
+
1648
+ # Tries to load the Guard plugin main class. This transforms the supplied
1649
+ # plugin name into a class name:
1650
+ #
1651
+ # * `guardname` will become `Guard::Guardname`
1652
+ # * `dashed-guard-name` will become `Guard::DashedGuardName`
1653
+ # * `underscore_guard_name` will become `Guard::UnderscoreGuardName`
1654
+ #
1655
+ # When no class is found with the strict case sensitive rules, another
1656
+ # try is made to locate the class without matching case:
1657
+ #
1658
+ # * `rspec` will find a class `Guard::RSpec`
1659
+ #
1660
+ # not be printed
1661
+ #
1662
+ # @option options
1663
+ # @param options [Hash] a customizable set of options
1664
+ # @return [Class, nil] the loaded class
1665
+ #
1666
+ # source://guard//lib/guard/plugin_util.rb#96
1667
+ def plugin_class(options = T.unsafe(nil)); end
1668
+
1669
+ # Locates a path to a Guard plugin gem.
1670
+ #
1671
+ # @return [String] the full path to the plugin gem
1672
+ #
1673
+ # source://guard//lib/guard/plugin_util.rb#73
1674
+ def plugin_location; end
1675
+
1676
+ private
1677
+
1678
+ # Guesses the most probable name for the current plugin based on its name.
1679
+ #
1680
+ # @example Returns the most probable name for a plugin
1681
+ # > Guard::PluginUtil.new('rspec').send(:_constant_name)
1682
+ # => "Rspec"
1683
+ #
1684
+ # source://guard//lib/guard/plugin_util.rb#172
1685
+ def _constant_name; end
1686
+
1687
+ # source://guard//lib/guard/plugin_util.rb#177
1688
+ def _full_gem_path(name); end
1689
+
1690
+ # Returns the constant for the current plugin.
1691
+ #
1692
+ # @example Returns the constant for a plugin
1693
+ # > Guard::PluginUtil.new('rspec').send(:_plugin_constant)
1694
+ # => Guard::RSpec
1695
+ #
1696
+ # source://guard//lib/guard/plugin_util.rb#160
1697
+ def _plugin_constant; end
1698
+
1699
+ class << self
1700
+ # @return [Boolean]
1701
+ #
1702
+ # source://guard//lib/guard/plugin_util.rb#182
1703
+ def _gem_valid?(gem); end
1704
+
1705
+ # Returns a list of Guard plugin Gem names installed locally.
1706
+ #
1707
+ # @return [Array<String>] a list of Guard plugin gem names
1708
+ #
1709
+ # source://guard//lib/guard/plugin_util.rb#24
1710
+ def plugin_names; end
1711
+ end
1712
+ end
1713
+
1714
+ # source://guard//lib/guard/plugin_util.rb#12
1715
+ Guard::PluginUtil::ERROR_NO_GUARD_OR_CLASS = T.let(T.unsafe(nil), String)
1716
+
1717
+ # source://guard//lib/guard/plugin_util.rb#15
1718
+ Guard::PluginUtil::INFO_ADDED_GUARD_TO_GUARDFILE = T.let(T.unsafe(nil), String)
1719
+
1720
+ # The runner is responsible for running all methods defined on each plugin.
1721
+ #
1722
+ # source://guard//lib/guard/runner.rb#9
1723
+ class Guard::Runner
1724
+ # Run a Guard plugin task, but remove the Guard plugin when his work leads
1725
+ # to a system failure.
1726
+ #
1727
+ # When the Group has `:halt_on_fail` disabled, we've to catch
1728
+ # `:task_has_failed` here in order to avoid an uncaught throw error.
1729
+ #
1730
+ # @param plugin [Guard::Plugin] guard the Guard to execute
1731
+ # @param task [Symbol] the task to run
1732
+ # @param args [Array] the arguments for the task
1733
+ # @raise [:task_has_failed] when task has failed
1734
+ #
1735
+ # source://guard//lib/guard/runner.rb#78
1736
+ def _supervise(plugin, task, *args); end
1737
+
1738
+ # Runs a Guard-task on all registered plugins.
1739
+ #
1740
+ # on
1741
+ #
1742
+ # @param task [Symbol] the task to run
1743
+ # @param scope_hash [Hash] either the Guard plugin or the group to run the task
1744
+ #
1745
+ # source://guard//lib/guard/runner.rb#17
1746
+ def run(task, scope_hash = T.unsafe(nil)); end
1747
+
1748
+ # Runs the appropriate tasks on all registered plugins
1749
+ # based on the passed changes.
1750
+ #
1751
+ # @param modified [Array<String>] the modified paths.
1752
+ # @param added [Array<String>] the added paths.
1753
+ # @param removed [Array<String>] the removed paths.
1754
+ #
1755
+ # source://guard//lib/guard/runner.rb#44
1756
+ def run_on_changes(modified, added, removed); end
1757
+
1758
+ private
1759
+
1760
+ # source://guard//lib/guard/runner.rb#116
1761
+ def _run_group_plugins(plugins); end
1762
+
1763
+ class << self
1764
+ # Returns the symbol that has to be caught when running a supervised task.
1765
+ #
1766
+ # @note If a Guard group is being run and it has the `:halt_on_fail`
1767
+ # option set, this method returns :no_catch as it will be caught at the
1768
+ # group level.
1769
+ # @param guard [Guard::Plugin] the Guard plugin to execute
1770
+ # @return [Symbol] the symbol to catch
1771
+ #
1772
+ # source://guard//lib/guard/runner.rb#110
1773
+ def stopping_symbol_for(guard); end
1774
+ end
1775
+ end
1776
+
1777
+ # source://guard//lib/guard/runner.rb#34
1778
+ Guard::Runner::ADDITION_TASKS = T.let(T.unsafe(nil), Array)
1779
+
1780
+ # source://guard//lib/guard/runner.rb#30
1781
+ Guard::Runner::MODIFICATION_TASKS = T.let(T.unsafe(nil), Array)
1782
+
1783
+ # source://guard//lib/guard/runner.rb#28
1784
+ Guard::Runner::PLUGIN_FAILED = T.let(T.unsafe(nil), String)
1785
+
1786
+ # source://guard//lib/guard/runner.rb#35
1787
+ Guard::Runner::REMOVAL_TASKS = T.let(T.unsafe(nil), Array)
1788
+
1789
+ # source://guard//lib/guard/terminal.rb#4
1790
+ class Guard::Terminal
1791
+ class << self
1792
+ # source://guard//lib/guard/terminal.rb#6
1793
+ def clear; end
1794
+ end
1795
+ end
1796
+
1797
+ # The UI class helps to format messages for the user. Everything that is
1798
+ # logged through this class is considered either as an error message or a
1799
+ # diagnostic message and is written to standard error ($stderr).
1800
+ #
1801
+ # If your Guard plugin does some output that is piped into another process
1802
+ # for further processing, please just write it to STDOUT with `puts`.
1803
+ #
1804
+ # source://guard//lib/guard/ui/colors.rb#2
1805
+ module Guard::UI
1806
+ include ::Guard::UI::Colors
1807
+
1808
+ class << self
1809
+ # Show a scoped action message.
1810
+ #
1811
+ # @param action [String] the action to show
1812
+ # @param scope [Hash] hash with a guard or a group scope
1813
+ #
1814
+ # source://guard//lib/guard/ui.rb#161
1815
+ def action_with_scopes(action, scope); end
1816
+
1817
+ # Clear the output if clearable.
1818
+ #
1819
+ # source://guard//lib/guard/ui.rb#131
1820
+ def clear(opts = T.unsafe(nil)); end
1821
+
1822
+ # Allow the screen to be cleared again.
1823
+ #
1824
+ # source://guard//lib/guard/ui.rb#152
1825
+ def clearable; end
1826
+
1827
+ # Show a debug message that is prefixed with DEBUG and a timestamp.
1828
+ #
1829
+ # @option options
1830
+ # @option options
1831
+ # @param message [String] the message to show
1832
+ # @param options [Hash] a customizable set of options
1833
+ #
1834
+ # source://guard//lib/guard/ui.rb#119
1835
+ def debug(message, options = T.unsafe(nil)); end
1836
+
1837
+ # Show a red deprecation message that is prefixed with DEPRECATION.
1838
+ # It has a log level of `warn`.
1839
+ #
1840
+ # @option options
1841
+ # @option options
1842
+ # @param message [String] the message to show
1843
+ # @param options [Hash] a customizable set of options
1844
+ #
1845
+ # source://guard//lib/guard/ui.rb#105
1846
+ def deprecation(message, options = T.unsafe(nil)); end
1847
+
1848
+ # Show a red error message that is prefixed with ERROR.
1849
+ #
1850
+ # @option options
1851
+ # @option options
1852
+ # @param message [String] the message to show
1853
+ # @param options [Hash] a customizable set of options
1854
+ #
1855
+ # source://guard//lib/guard/ui.rb#94
1856
+ def error(message, options = T.unsafe(nil)); end
1857
+
1858
+ # Show an info message.
1859
+ #
1860
+ # @option options
1861
+ # @option options
1862
+ # @param message [String] the message to show
1863
+ # @param options [Hash] a customizable set of options
1864
+ #
1865
+ # source://guard//lib/guard/ui.rb#74
1866
+ def info(message, options = T.unsafe(nil)); end
1867
+
1868
+ # Assigns a log level
1869
+ #
1870
+ # source://guard//lib/guard/ui.rb#63
1871
+ def level=(new_level); end
1872
+
1873
+ # Get the Guard::UI logger instance
1874
+ #
1875
+ # source://guard//lib/guard/ui.rb#26
1876
+ def logger; end
1877
+
1878
+ # Get the logger options
1879
+ #
1880
+ # @return [Hash] the logger options
1881
+ #
1882
+ # source://guard//lib/guard/ui.rb#46
1883
+ def options; end
1884
+
1885
+ # Set the logger options
1886
+ #
1887
+ # TODO: deprecate?
1888
+ #
1889
+ # @option options
1890
+ # @option options
1891
+ # @option options
1892
+ # @param options [Hash] the logger options
1893
+ #
1894
+ # source://guard//lib/guard/ui.rb#58
1895
+ def options=(options); end
1896
+
1897
+ # TODO: arguments: UI uses Guard::options anyway
1898
+ #
1899
+ # @private api
1900
+ #
1901
+ # source://guard//lib/guard/ui.rb#145
1902
+ def reset_and_clear; end
1903
+
1904
+ # Reset a line.
1905
+ #
1906
+ # source://guard//lib/guard/ui.rb#125
1907
+ def reset_line; end
1908
+
1909
+ # Since logger is global, for Aruba in-process to properly
1910
+ # separate output between calls, we need to reset
1911
+ #
1912
+ # We don't use logger=() since it's expected to be a Lumberjack instance
1913
+ #
1914
+ # source://guard//lib/guard/ui.rb#38
1915
+ def reset_logger; end
1916
+
1917
+ # Show a yellow warning message that is prefixed with WARNING.
1918
+ #
1919
+ # @option options
1920
+ # @option options
1921
+ # @param message [String] the message to show
1922
+ # @param options [Hash] a customizable set of options
1923
+ #
1924
+ # source://guard//lib/guard/ui.rb#84
1925
+ def warning(message, options = T.unsafe(nil)); end
1926
+
1927
+ private
1928
+
1929
+ # Tries to extract the calling Guard plugin name
1930
+ # from the call stack.
1931
+ #
1932
+ # @param depth [Integer] the stack depth
1933
+ # @return [String] the Guard plugin name
1934
+ #
1935
+ # source://guard//lib/guard/ui.rb#203
1936
+ def _calling_plugin_name; end
1937
+
1938
+ # Filters log messages depending on either the
1939
+ # `:only`` or `:except` option.
1940
+ #
1941
+ # @param plugin [String] the calling plugin name
1942
+ # @yield When the message should be logged
1943
+ # @yieldparam param [String] the calling plugin name
1944
+ #
1945
+ # source://guard//lib/guard/ui.rb#175
1946
+ def _filter(plugin); end
1947
+
1948
+ # @private
1949
+ #
1950
+ # source://guard//lib/guard/ui.rb#188
1951
+ def _filtered_logger_message(message, method, color_name, options = T.unsafe(nil)); end
1952
+
1953
+ # Colorizes a text message. See the constant in the UI class for possible
1954
+ # color_options parameters. You can pass optionally :bright, a foreground
1955
+ # color and a background color.
1956
+ #
1957
+ # @example
1958
+ #
1959
+ # color('Hello World', :red, :bright)
1960
+ # @param text [String] the text to colorize
1961
+ # @param color_options [Array] the color options
1962
+ #
1963
+ # source://guard//lib/guard/ui.rb#247
1964
+ def color(text, *color_options); end
1965
+
1966
+ # Checks if color output can be enabled.
1967
+ #
1968
+ # @return [Boolean] whether color is enabled or not
1969
+ #
1970
+ # source://guard//lib/guard/ui.rb#217
1971
+ def color_enabled?; end
1972
+ end
1973
+ end
1974
+
1975
+ # source://guard//lib/guard/ui/colors.rb#3
1976
+ module Guard::UI::Colors; end
1977
+
1978
+ # Black background color
1979
+ #
1980
+ # source://guard//lib/guard/ui/colors.rb#32
1981
+ Guard::UI::Colors::ANSI_ESCAPE_BGBLACK = T.let(T.unsafe(nil), String)
1982
+
1983
+ # Blue background color
1984
+ #
1985
+ # source://guard//lib/guard/ui/colors.rb#44
1986
+ Guard::UI::Colors::ANSI_ESCAPE_BGBLUE = T.let(T.unsafe(nil), String)
1987
+
1988
+ # Cyan background color
1989
+ #
1990
+ # source://guard//lib/guard/ui/colors.rb#50
1991
+ Guard::UI::Colors::ANSI_ESCAPE_BGCYAN = T.let(T.unsafe(nil), String)
1992
+
1993
+ # Green background color
1994
+ #
1995
+ # source://guard//lib/guard/ui/colors.rb#38
1996
+ Guard::UI::Colors::ANSI_ESCAPE_BGGREEN = T.let(T.unsafe(nil), String)
1997
+
1998
+ # Magenta background color
1999
+ #
2000
+ # source://guard//lib/guard/ui/colors.rb#47
2001
+ Guard::UI::Colors::ANSI_ESCAPE_BGMAGENTA = T.let(T.unsafe(nil), String)
2002
+
2003
+ # Red background color
2004
+ #
2005
+ # source://guard//lib/guard/ui/colors.rb#35
2006
+ Guard::UI::Colors::ANSI_ESCAPE_BGRED = T.let(T.unsafe(nil), String)
2007
+
2008
+ # White background color
2009
+ #
2010
+ # source://guard//lib/guard/ui/colors.rb#53
2011
+ Guard::UI::Colors::ANSI_ESCAPE_BGWHITE = T.let(T.unsafe(nil), String)
2012
+
2013
+ # Yellow background color
2014
+ #
2015
+ # source://guard//lib/guard/ui/colors.rb#41
2016
+ Guard::UI::Colors::ANSI_ESCAPE_BGYELLOW = T.let(T.unsafe(nil), String)
2017
+
2018
+ # Black foreground color
2019
+ #
2020
+ # source://guard//lib/guard/ui/colors.rb#8
2021
+ Guard::UI::Colors::ANSI_ESCAPE_BLACK = T.let(T.unsafe(nil), String)
2022
+
2023
+ # Blue foreground color
2024
+ #
2025
+ # source://guard//lib/guard/ui/colors.rb#20
2026
+ Guard::UI::Colors::ANSI_ESCAPE_BLUE = T.let(T.unsafe(nil), String)
2027
+
2028
+ # Brighten the color
2029
+ #
2030
+ # source://guard//lib/guard/ui/colors.rb#5
2031
+ Guard::UI::Colors::ANSI_ESCAPE_BRIGHT = T.let(T.unsafe(nil), String)
2032
+
2033
+ # Cyan foreground color
2034
+ #
2035
+ # source://guard//lib/guard/ui/colors.rb#26
2036
+ Guard::UI::Colors::ANSI_ESCAPE_CYAN = T.let(T.unsafe(nil), String)
2037
+
2038
+ # Green foreground color
2039
+ #
2040
+ # source://guard//lib/guard/ui/colors.rb#14
2041
+ Guard::UI::Colors::ANSI_ESCAPE_GREEN = T.let(T.unsafe(nil), String)
2042
+
2043
+ # Magenta foreground color
2044
+ #
2045
+ # source://guard//lib/guard/ui/colors.rb#23
2046
+ Guard::UI::Colors::ANSI_ESCAPE_MAGENTA = T.let(T.unsafe(nil), String)
2047
+
2048
+ # Red foreground color
2049
+ #
2050
+ # source://guard//lib/guard/ui/colors.rb#11
2051
+ Guard::UI::Colors::ANSI_ESCAPE_RED = T.let(T.unsafe(nil), String)
2052
+
2053
+ # White foreground color
2054
+ #
2055
+ # source://guard//lib/guard/ui/colors.rb#29
2056
+ Guard::UI::Colors::ANSI_ESCAPE_WHITE = T.let(T.unsafe(nil), String)
2057
+
2058
+ # Yellow foreground color
2059
+ #
2060
+ # source://guard//lib/guard/ui/colors.rb#17
2061
+ Guard::UI::Colors::ANSI_ESCAPE_YELLOW = T.let(T.unsafe(nil), String)
2062
+
2063
+ # source://guard//lib/guard/ui/config.rb#6
2064
+ class Guard::UI::Config < ::Guard::Options
2065
+ # @return [Config] a new instance of Config
2066
+ #
2067
+ # source://guard//lib/guard/ui/config.rb#20
2068
+ def initialize(options = T.unsafe(nil)); end
2069
+
2070
+ # source://guard//lib/guard/ui/config.rb#48
2071
+ def [](name); end
2072
+
2073
+ # source://guard//lib/guard/ui/config.rb#35
2074
+ def device; end
2075
+
2076
+ # source://guard//lib/guard/ui/config.rb#44
2077
+ def except; end
2078
+
2079
+ # Returns the value of attribute logger_config.
2080
+ #
2081
+ # source://guard//lib/guard/ui/config.rb#18
2082
+ def logger_config; end
2083
+
2084
+ # source://guard//lib/guard/ui/config.rb#40
2085
+ def only; end
2086
+
2087
+ # source://guard//lib/guard/ui/config.rb#59
2088
+ def with_progname(name); end
2089
+ end
2090
+
2091
+ # source://guard//lib/guard/ui/config.rb#7
2092
+ Guard::UI::Config::DEFAULTS = T.let(T.unsafe(nil), Hash)
2093
+
2094
+ # source://guard//lib/guard/ui/config.rb#16
2095
+ Guard::UI::Config::DEPRECATED_OPTS = T.let(T.unsafe(nil), Array)
2096
+
2097
+ # source://guard//lib/guard/ui/logger.rb#5
2098
+ class Guard::UI::Logger; end
2099
+
2100
+ # source://guard//lib/guard/ui/logger.rb#6
2101
+ class Guard::UI::Logger::Config < ::Guard::Options
2102
+ # @return [Config] a new instance of Config
2103
+ #
2104
+ # source://guard//lib/guard/ui/logger.rb#20
2105
+ def initialize(options = T.unsafe(nil)); end
2106
+
2107
+ # source://guard//lib/guard/ui/logger.rb#24
2108
+ def level=(value); end
2109
+ end
2110
+
2111
+ # source://guard//lib/guard/ui/logger.rb#7
2112
+ Guard::UI::Logger::Config::DEFAULTS = T.let(T.unsafe(nil), Hash)
2113
+
2114
+ # The watcher defines a RegExp that will be matched against file system
2115
+ # modifications.
2116
+ # When a watcher matches a change, an optional action block is executed to
2117
+ # enable processing the file system change result.
2118
+ #
2119
+ # source://guard//lib/guard/watcher/pattern/match_result.rb#2
2120
+ class Guard::Watcher
2121
+ extend ::Guard::Deprecated::Watcher::ClassMethods
2122
+
2123
+ # Initializes a file watcher.
2124
+ #
2125
+ # @param pattern [String, Regexp] the pattern to be watched by the Guard
2126
+ # plugin
2127
+ # @param action [Block] the action to execute before passing the result to
2128
+ # the Guard plugin
2129
+ # @return [Watcher] a new instance of Watcher
2130
+ #
2131
+ # source://guard//lib/guard/watcher.rb#24
2132
+ def initialize(pattern, action = T.unsafe(nil)); end
2133
+
2134
+ # Compare with other watcher
2135
+ #
2136
+ # @param other [Guard::Watcher] other watcher for comparing
2137
+ # @return [true, false] equal or not
2138
+ #
2139
+ # source://guard//lib/guard/watcher.rb#32
2140
+ def ==(other); end
2141
+
2142
+ # Returns the value of attribute action.
2143
+ #
2144
+ # source://guard//lib/guard/watcher.rb#15
2145
+ def action; end
2146
+
2147
+ # Sets the attribute action
2148
+ #
2149
+ # @param value the value to set the attribute action to.
2150
+ #
2151
+ # source://guard//lib/guard/watcher.rb#15
2152
+ def action=(_arg0); end
2153
+
2154
+ # Executes a watcher action.
2155
+ #
2156
+ # @param matches [String, MatchData] the matched path or the match from the
2157
+ # Regex
2158
+ # @return [String] the final paths
2159
+ #
2160
+ # source://guard//lib/guard/watcher.rb#81
2161
+ def call_action(matches); end
2162
+
2163
+ # source://guard//lib/guard/watcher.rb#70
2164
+ def match(string_or_pathname); end
2165
+
2166
+ # Returns the value of attribute pattern.
2167
+ #
2168
+ # source://guard//lib/guard/watcher.rb#15
2169
+ def pattern; end
2170
+
2171
+ # Sets the attribute pattern
2172
+ #
2173
+ # @param value the value to set the attribute pattern to.
2174
+ #
2175
+ # source://guard//lib/guard/watcher.rb#15
2176
+ def pattern=(_arg0); end
2177
+
2178
+ class << self
2179
+ # Finds the files that matches a Guard plugin.
2180
+ #
2181
+ # @param guard [Guard::Plugin] the Guard plugin which watchers are used
2182
+ # @param files [Array<String>] the changed files
2183
+ # @return [Array<Object>] the matched watcher response
2184
+ #
2185
+ # source://guard//lib/guard/watcher.rb#42
2186
+ def match_files(guard, files); end
2187
+ end
2188
+ end
2189
+
2190
+ # source://guard//lib/guard/watcher/pattern/match_result.rb#3
2191
+ class Guard::Watcher::Pattern
2192
+ class << self
2193
+ # source://guard//lib/guard/watcher/pattern.rb#12
2194
+ def create(pattern); end
2195
+ end
2196
+ end
2197
+
2198
+ # TODO: remove before Guard 3.x
2199
+ #
2200
+ # source://guard//lib/guard/watcher/pattern/deprecated_regexp.rb#7
2201
+ class Guard::Watcher::Pattern::DeprecatedRegexp
2202
+ # @return [DeprecatedRegexp] a new instance of DeprecatedRegexp
2203
+ #
2204
+ # source://guard//lib/guard/watcher/pattern/deprecated_regexp.rb#8
2205
+ def initialize(pattern); end
2206
+
2207
+ # @return [Boolean]
2208
+ #
2209
+ # source://guard//lib/guard/watcher/pattern/deprecated_regexp.rb#16
2210
+ def deprecated?; end
2211
+
2212
+ class << self
2213
+ # source://guard//lib/guard/watcher/pattern/deprecated_regexp.rb#12
2214
+ def convert(pattern); end
2215
+
2216
+ # source://guard//lib/guard/watcher/pattern/deprecated_regexp.rb#21
2217
+ def show_deprecation(pattern); end
2218
+ end
2219
+ end
2220
+
2221
+ # source://guard//lib/guard/watcher/pattern/match_result.rb#4
2222
+ class Guard::Watcher::Pattern::MatchResult
2223
+ # @return [MatchResult] a new instance of MatchResult
2224
+ #
2225
+ # source://guard//lib/guard/watcher/pattern/match_result.rb#5
2226
+ def initialize(match_result, original_value); end
2227
+
2228
+ # source://guard//lib/guard/watcher/pattern/match_result.rb#10
2229
+ def [](index); end
2230
+ end
2231
+
2232
+ # source://guard//lib/guard/watcher/pattern/matcher.rb#4
2233
+ class Guard::Watcher::Pattern::Matcher
2234
+ # @return [Matcher] a new instance of Matcher
2235
+ #
2236
+ # source://guard//lib/guard/watcher/pattern/matcher.rb#7
2237
+ def initialize(obj); end
2238
+
2239
+ # Compare with other matcher
2240
+ #
2241
+ # @param other [Guard::Watcher::Pattern::Matcher] other matcher for comparing
2242
+ # @return [true, false] equal or not
2243
+ #
2244
+ # source://guard//lib/guard/watcher/pattern/matcher.rb#15
2245
+ def ==(other); end
2246
+
2247
+ # source://guard//lib/guard/watcher/pattern/matcher.rb#19
2248
+ def match(string_or_pathname); end
2249
+
2250
+ # Returns the value of attribute matcher.
2251
+ #
2252
+ # source://guard//lib/guard/watcher/pattern/matcher.rb#5
2253
+ def matcher; end
2254
+
2255
+ private
2256
+
2257
+ # source://guard//lib/guard/watcher/pattern/matcher.rb#25
2258
+ def normalized(string_or_pathname); end
2259
+ end
2260
+
2261
+ # source://guard//lib/guard/watcher/pattern/pathname_path.rb#6
2262
+ class Guard::Watcher::Pattern::PathnamePath < ::Guard::Watcher::Pattern::SimplePath
2263
+ protected
2264
+
2265
+ # source://guard//lib/guard/watcher/pattern/pathname_path.rb#9
2266
+ def normalize(string_or_pathname); end
2267
+ end
2268
+
2269
+ # source://guard//lib/guard/watcher/pattern/simple_path.rb#4
2270
+ class Guard::Watcher::Pattern::SimplePath
2271
+ # @return [SimplePath] a new instance of SimplePath
2272
+ #
2273
+ # source://guard//lib/guard/watcher/pattern/simple_path.rb#5
2274
+ def initialize(string_or_pathname); end
2275
+
2276
+ # source://guard//lib/guard/watcher/pattern/simple_path.rb#9
2277
+ def match(string_or_pathname); end
2278
+
2279
+ protected
2280
+
2281
+ # source://guard//lib/guard/watcher/pattern/simple_path.rb#17
2282
+ def normalize(string_or_pathname); end
2283
+ end