Skip to content

Commit 5a3d287

Browse files
CitymonstretCitymonstret
authored
feat: 2.0.0 beta.2 docs (#29)
<!-- readthedocs-preview incendocloud start --> ---- 📚 Documentation preview 📚: https://incendocloud--29.org.readthedocs.build/en/29/ <!-- readthedocs-preview incendocloud end -->
1 parent 4c3b7fc commit 5a3d287

41 files changed

Lines changed: 1489 additions & 671 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 243 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,246 @@ indent_size = 2
77
end_of_line = lf
88
charset = utf-8
99
trim_trailing_whitespace = true
10-
insert_final_newline = true
10+
insert_final_newline = true
11+
12+
[*.py]
13+
indent_size = 4
14+
15+
[*.java]
16+
indent_size = 2
17+
max_line_length = 130
18+
tab_width = 2
19+
ij_continuation_indent_size = 2
20+
ij_formatter_off_tag = @formatter:off
21+
ij_formatter_on_tag = @formatter:on
22+
ij_formatter_tags_enabled = false
23+
ij_smart_tabs = false
24+
ij_wrap_on_typing = true
25+
ij_java_align_consecutive_assignments = false
26+
ij_java_align_consecutive_variable_declarations = false
27+
ij_java_align_group_field_declarations = false
28+
ij_java_align_multiline_annotation_parameters = false
29+
ij_java_align_multiline_array_initializer_expression = false
30+
ij_java_align_multiline_assignment = false
31+
ij_java_align_multiline_binary_operation = false
32+
ij_java_align_multiline_chained_methods = false
33+
ij_java_align_multiline_extends_list = false
34+
ij_java_align_multiline_for = true
35+
ij_java_align_multiline_method_parentheses = false
36+
ij_java_align_multiline_parameters = true
37+
ij_java_align_multiline_parameters_in_calls = false
38+
ij_java_align_multiline_parenthesized_expression = false
39+
ij_java_align_multiline_records = true
40+
ij_java_align_multiline_resources = true
41+
ij_java_align_multiline_ternary_operation = false
42+
ij_java_align_multiline_text_blocks = false
43+
ij_java_align_multiline_throws_list = false
44+
ij_java_align_subsequent_simple_methods = false
45+
ij_java_align_throws_keyword = false
46+
ij_java_annotation_parameter_wrap = off
47+
ij_java_array_initializer_new_line_after_left_brace = false
48+
ij_java_array_initializer_right_brace_on_new_line = false
49+
ij_java_array_initializer_wrap = off
50+
ij_java_assert_statement_colon_on_next_line = false
51+
ij_java_assert_statement_wrap = off
52+
ij_java_assignment_wrap = off
53+
ij_java_binary_operation_sign_on_next_line = false
54+
ij_java_binary_operation_wrap = off
55+
ij_java_blank_lines_after_anonymous_class_header = 0
56+
ij_java_blank_lines_after_class_header = 1
57+
ij_java_blank_lines_after_imports = 1
58+
ij_java_blank_lines_after_package = 1
59+
ij_java_blank_lines_around_class = 1
60+
ij_java_blank_lines_around_field = 0
61+
ij_java_blank_lines_around_field_in_interface = 0
62+
ij_java_blank_lines_around_initializer = 1
63+
ij_java_blank_lines_around_method = 1
64+
ij_java_blank_lines_around_method_in_interface = 1
65+
ij_java_blank_lines_before_class_end = 0
66+
ij_java_blank_lines_before_imports = 1
67+
ij_java_blank_lines_before_method_body = 0
68+
ij_java_blank_lines_before_package = 0
69+
ij_java_block_brace_style = end_of_line
70+
ij_java_block_comment_at_first_column = true
71+
ij_java_call_parameters_new_line_after_left_paren = true
72+
ij_java_call_parameters_right_paren_on_new_line = true
73+
ij_java_call_parameters_wrap = on_every_item
74+
ij_java_case_statement_on_separate_line = true
75+
ij_java_catch_on_new_line = false
76+
ij_java_class_annotation_wrap = split_into_lines
77+
ij_java_class_brace_style = end_of_line
78+
ij_java_class_count_to_use_import_on_demand = 100000
79+
ij_java_class_names_in_javadoc = 1
80+
ij_java_do_not_indent_top_level_class_members = false
81+
ij_java_do_not_wrap_after_single_annotation = false
82+
ij_java_do_while_brace_force = always
83+
ij_java_doc_add_blank_line_after_description = true
84+
ij_java_doc_add_blank_line_after_param_comments = false
85+
ij_java_doc_add_blank_line_after_return = false
86+
ij_java_doc_add_p_tag_on_empty_lines = true
87+
ij_java_doc_align_exception_comments = true
88+
ij_java_doc_align_param_comments = true
89+
ij_java_doc_do_not_wrap_if_one_line = false
90+
ij_java_doc_enable_formatting = true
91+
ij_java_doc_enable_leading_asterisks = true
92+
ij_java_doc_indent_on_continuation = true
93+
ij_java_doc_keep_empty_lines = true
94+
ij_java_doc_keep_empty_parameter_tag = true
95+
ij_java_doc_keep_empty_return_tag = true
96+
ij_java_doc_keep_empty_throws_tag = true
97+
ij_java_doc_keep_invalid_tags = false
98+
ij_java_doc_param_description_on_new_line = false
99+
ij_java_doc_preserve_line_breaks = false
100+
ij_java_doc_use_throws_not_exception_tag = true
101+
ij_java_else_on_new_line = false
102+
ij_java_enum_constants_wrap = split_into_lines
103+
ij_java_extends_keyword_wrap = off
104+
ij_java_extends_list_wrap = normal
105+
ij_java_field_annotation_wrap = split_into_lines
106+
ij_java_finally_on_new_line = false
107+
ij_java_for_brace_force = always
108+
ij_java_for_statement_new_line_after_left_paren = false
109+
ij_java_for_statement_right_paren_on_new_line = false
110+
ij_java_for_statement_wrap = off
111+
ij_java_generate_final_locals = true
112+
ij_java_generate_final_parameters = true
113+
ij_java_if_brace_force = always
114+
ij_java_imports_layout = *,|,$*
115+
ij_java_indent_case_from_switch = true
116+
ij_java_insert_inner_class_imports = false
117+
ij_java_insert_override_annotation = true
118+
ij_java_keep_blank_lines_before_right_brace = 0
119+
ij_java_keep_blank_lines_between_package_declaration_and_header = 2
120+
ij_java_keep_blank_lines_in_code = 2
121+
ij_java_keep_blank_lines_in_declarations = 2
122+
ij_java_keep_control_statement_in_one_line = true
123+
ij_java_keep_first_column_comment = true
124+
ij_java_keep_indents_on_empty_lines = false
125+
ij_java_keep_line_breaks = true
126+
ij_java_keep_multiple_expressions_in_one_line = false
127+
ij_java_keep_simple_blocks_in_one_line = false
128+
ij_java_keep_simple_classes_in_one_line = false
129+
ij_java_keep_simple_lambdas_in_one_line = false
130+
ij_java_keep_simple_methods_in_one_line = false
131+
ij_java_label_indent_absolute = false
132+
ij_java_label_indent_size = 0
133+
ij_java_lambda_brace_style = end_of_line
134+
ij_java_layout_static_imports_separately = true
135+
ij_java_line_comment_add_space = false
136+
ij_java_line_comment_at_first_column = true
137+
ij_java_method_annotation_wrap = split_into_lines
138+
ij_java_method_brace_style = end_of_line
139+
ij_java_method_call_chain_wrap = on_every_item
140+
ij_java_method_parameters_new_line_after_left_paren = true
141+
ij_java_method_parameters_right_paren_on_new_line = true
142+
ij_java_method_parameters_wrap = on_every_item
143+
ij_java_modifier_list_wrap = false
144+
ij_java_names_count_to_use_import_on_demand = 100000
145+
ij_java_new_line_after_lparen_in_record_header = false
146+
ij_java_parameter_annotation_wrap = off
147+
ij_java_parentheses_expression_new_line_after_left_paren = false
148+
ij_java_parentheses_expression_right_paren_on_new_line = false
149+
ij_java_place_assignment_sign_on_next_line = false
150+
ij_java_prefer_longer_names = false
151+
ij_java_prefer_parameters_wrap = true
152+
ij_java_record_components_wrap = normal
153+
ij_java_repeat_synchronized = true
154+
ij_java_replace_instanceof_and_cast = false
155+
ij_java_replace_null_check = true
156+
ij_java_replace_sum_lambda_with_method_ref = true
157+
ij_java_resource_list_new_line_after_left_paren = false
158+
ij_java_resource_list_right_paren_on_new_line = false
159+
ij_java_resource_list_wrap = off
160+
ij_java_rparen_on_new_line_in_record_header = false
161+
ij_java_space_after_closing_angle_bracket_in_type_argument = false
162+
ij_java_space_after_colon = true
163+
ij_java_space_after_comma = true
164+
ij_java_space_after_comma_in_type_arguments = true
165+
ij_java_space_after_for_semicolon = true
166+
ij_java_space_after_quest = true
167+
ij_java_space_after_type_cast = true
168+
ij_java_space_before_annotation_array_initializer_left_brace = false
169+
ij_java_space_before_annotation_parameter_list = false
170+
ij_java_space_before_array_initializer_left_brace = false
171+
ij_java_space_before_catch_keyword = true
172+
ij_java_space_before_catch_left_brace = true
173+
ij_java_space_before_catch_parentheses = true
174+
ij_java_space_before_class_left_brace = true
175+
ij_java_space_before_colon = true
176+
ij_java_space_before_colon_in_foreach = true
177+
ij_java_space_before_comma = false
178+
ij_java_space_before_do_left_brace = true
179+
ij_java_space_before_else_keyword = true
180+
ij_java_space_before_else_left_brace = true
181+
ij_java_space_before_finally_keyword = true
182+
ij_java_space_before_finally_left_brace = true
183+
ij_java_space_before_for_left_brace = true
184+
ij_java_space_before_for_parentheses = true
185+
ij_java_space_before_for_semicolon = false
186+
ij_java_space_before_if_left_brace = true
187+
ij_java_space_before_if_parentheses = true
188+
ij_java_space_before_method_call_parentheses = false
189+
ij_java_space_before_method_left_brace = true
190+
ij_java_space_before_method_parentheses = false
191+
ij_java_space_before_opening_angle_bracket_in_type_parameter = false
192+
ij_java_space_before_quest = true
193+
ij_java_space_before_switch_left_brace = true
194+
ij_java_space_before_switch_parentheses = true
195+
ij_java_space_before_synchronized_left_brace = true
196+
ij_java_space_before_synchronized_parentheses = true
197+
ij_java_space_before_try_left_brace = true
198+
ij_java_space_before_try_parentheses = true
199+
ij_java_space_before_type_parameter_list = false
200+
ij_java_space_before_while_keyword = true
201+
ij_java_space_before_while_left_brace = true
202+
ij_java_space_before_while_parentheses = true
203+
ij_java_space_inside_one_line_enum_braces = false
204+
ij_java_space_within_empty_array_initializer_braces = false
205+
ij_java_space_within_empty_method_call_parentheses = false
206+
ij_java_space_within_empty_method_parentheses = false
207+
ij_java_spaces_around_additive_operators = true
208+
ij_java_spaces_around_assignment_operators = true
209+
ij_java_spaces_around_bitwise_operators = true
210+
ij_java_spaces_around_equality_operators = true
211+
ij_java_spaces_around_lambda_arrow = true
212+
ij_java_spaces_around_logical_operators = true
213+
ij_java_spaces_around_method_ref_dbl_colon = false
214+
ij_java_spaces_around_multiplicative_operators = true
215+
ij_java_spaces_around_relational_operators = true
216+
ij_java_spaces_around_shift_operators = true
217+
ij_java_spaces_around_type_bounds_in_type_parameters = true
218+
ij_java_spaces_around_unary_operator = false
219+
ij_java_spaces_within_angle_brackets = false
220+
ij_java_spaces_within_annotation_parentheses = false
221+
ij_java_spaces_within_array_initializer_braces = false
222+
ij_java_spaces_within_braces = false
223+
ij_java_spaces_within_brackets = false
224+
ij_java_spaces_within_cast_parentheses = false
225+
ij_java_spaces_within_catch_parentheses = false
226+
ij_java_spaces_within_for_parentheses = false
227+
ij_java_spaces_within_if_parentheses = false
228+
ij_java_spaces_within_method_call_parentheses = false
229+
ij_java_spaces_within_method_parentheses = false
230+
ij_java_spaces_within_parentheses = false
231+
ij_java_spaces_within_switch_parentheses = false
232+
ij_java_spaces_within_synchronized_parentheses = false
233+
ij_java_spaces_within_try_parentheses = false
234+
ij_java_spaces_within_while_parentheses = false
235+
ij_java_special_else_if_treatment = true
236+
ij_java_subclass_name_suffix = Impl
237+
ij_java_ternary_operation_signs_on_next_line = true
238+
ij_java_ternary_operation_wrap = on_every_item
239+
ij_java_test_name_suffix = Test
240+
ij_java_throws_keyword_wrap = off
241+
ij_java_throws_list_wrap = normal
242+
ij_java_use_external_annotations = false
243+
ij_java_use_fq_class_names = false
244+
ij_java_use_relative_indents = false
245+
ij_java_use_single_class_imports = true
246+
ij_java_variable_annotation_wrap = off
247+
ij_java_visibility = public
248+
ij_java_while_brace_force = always
249+
ij_java_while_on_new_line = false
250+
ij_java_wrap_comments = false
251+
ij_java_wrap_first_method_in_call_chain = true
252+
ij_java_wrap_long_lines = false

‎.github/workflows/gradle.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Gradle Build
2+
on:
3+
push:
4+
branches: ["**"]
5+
tags-ignore: ["**"]
6+
pull_request:
7+
release:
8+
types: [published]
9+
jobs:
10+
build:
11+
# Only run on PRs if the source branch is on someone else's repo
12+
if: ${{ github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name }}
13+
runs-on: "ubuntu-latest"
14+
defaults:
15+
run:
16+
working-directory: code
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: gradle/wrapper-validation-action@v1
20+
- name: Set up JDK
21+
uses: actions/setup-java@v4
22+
with:
23+
distribution: "temurin"
24+
java-version: 17
25+
- uses: gradle/gradle-build-action@v2
26+
with:
27+
# allow master and *-dev branches to write caches (default is only master/main)
28+
cache-read-only: ${{ github.ref != 'refs/heads/master' && !(endsWith(github.ref, '-dev') && startsWith(github.ref, 'refs/heads/')) }}
29+
- name: Build
30+
run: ./gradlew build

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,9 @@ then you may run prettier using:
4040
```shell
4141
$ npx prettier . --write
4242
```
43+
44+
### Snippets
45+
46+
The `code` directory contains a Gradle project with compiled examples.
47+
Snippets from these docs are used in the examples using the `{{ snippet("File.java") }}` macro.
48+
The project will be built by the CI pipeline to validate that the snippets compile.

‎code/build.gradle.kts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
plugins {
2+
alias(libs.plugins.indra)
3+
}
4+
5+
dependencies {
6+
implementation(libs.cloud.core)
7+
implementation(libs.cloud.minecraft.extras)
8+
}
9+
10+
indra {
11+
javaVersions {
12+
minimumToolchain(8)
13+
target(8)
14+
}
15+
}
16+
17+
tasks {
18+
withType<JavaCompile> {
19+
options.compilerArgs.addAll(listOf("-Xlint:-processing,-classfile,-serial", "-Werror"))
20+
}
21+
}

‎code/gradle.properties‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
group=org.incendo
2+
version=1.0.0-SNAPSHOT
3+
description=cloud-docs snippets
4+
org.gradle.caching=true
5+
org.gradle.parallel=true

‎code/gradle/libs.versions.toml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[versions]
2+
indra = "3.1.3"
3+
4+
cloud = "2.0.0-beta.2"
5+
cloudMinecraft = "2.0.0-beta.2"
6+
7+
[plugins]
8+
indra = { id = "net.kyori.indra", version.ref = "indra" }
9+
10+
[libraries]
11+
cloud-core = { group = "org.incendo", name = "cloud-core", version.ref = "cloud" }
12+
cloud-minecraft-extras = { group = "org.incendo", name = "cloud-minecraft-extras", version.ref = "cloudMinecraft" }

‎code/gradle/wrapper/gradle-wrapper.jar‎

62.2 KB
Binary file not shown.

‎code/gradle/wrapper/gradle-wrapper.properties‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
distributionBase=GRADLE_USER_HOME
2+
distributionPath=wrapper/dists
3+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
4+
networkTimeout=10000
5+
validateDistributionUrl=true
6+
zipStoreBase=GRADLE_USER_HOME
7+
zipStorePath=wrapper/dists

0 commit comments

Comments
 (0)