You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
# ConfigMe Changelog
2
2
3
3
## ConfigMe 1.x
4
-
####1.4.1 (2023-08-28)
4
+
### 1.4.1 (2023-08-28)
5
5
-`@ExportName` can be added on bean fields (previously, it was only possible on accessor methods) ([#366](https://github.com/AuthMe/ConfigMe/issues/366))
6
6
- Bug fix: unique comment is repeated if it's in a MapProperty, ListProperty or similar ([#362](https://github.com/AuthMe/ConfigMe/issues/362))
7
7
- Bug fix: Property at root path `""` could be defined with other properties ([#363](https://github.com/AuthMe/ConfigMe/issues/363))
8
8
- Add getter for property type in TypeBasedProperty ([#333](https://github.com/AuthMe/ConfigMe/issues/333))
9
9
10
10
:blue_book:[All changes in 1.4.1](https://github.com/AuthMe/ConfigMe/milestone/16?closed=1)
11
11
12
-
####1.4.0 (2023-08-12)
12
+
### 1.4.0 (2023-08-12)
13
13
- Annotated all methods with `@NotNull` and `@Nullable` for better type inference in Kotlin ([#235](https://github.com/AuthMe/ConfigMe/pull/235), [#318](https://github.com/AuthMe/ConfigMe/issues/318))
14
14
- Support `@Comment` on fields of bean properties ([#18](https://github.com/AuthMe/ConfigMe/issues/18))
15
15
- Please read about [breaking changes](https://github.com/AuthMe/ConfigMe/issues/18#issuecomment-1663973493) if you extend `YamlFileResource` or other internals.
@@ -22,13 +22,13 @@
22
22
23
23
:blue_book:[All changes in 1.4.0](https://github.com/AuthMe/ConfigMe/milestone/13?closed=1)
24
24
25
-
####1.3.1 (2023-06-20)
25
+
### 1.3.1 (2023-06-20)
26
26
- Update SnakeYAML dependency for security reasons ([#310](https://github.com/AuthMe/ConfigMe/issues/310))
27
-
- Introduce ShortProperty, LongProperty and FloatProperty for convenience ([#260](https://github.com/AuthMe/ConfigMe/issues/268))
27
+
- Introduce ShortProperty, LongProperty and FloatProperty for convenience ([#260](https://github.com/AuthMe/ConfigMe/issues/268))
28
28
29
29
:blue_book:[All changes in 1.3.1](https://github.com/AuthMe/ConfigMe/milestone/14?closed=1)
30
30
31
-
####1.3.0 (2021-10-17)
31
+
### 1.3.0 (2021-10-17)
32
32
- Introduce option to NOT split paths that contain dots in the YAML file ([#214](https://github.com/AuthMe/ConfigMe/issues/214))
33
33
- Add support for BigInteger and BigDecimal in bean properties ([#182](https://github.com/AuthMe/ConfigMe/issues/182))
34
34
- Support map properties at root path-level properly when they are empty ([#191](https://github.com/AuthMe/ConfigMe/issues/191))
@@ -37,7 +37,7 @@
37
37
38
38
:blue_book:[All changes in 1.3.0](https://github.com/AuthMe/ConfigMe/milestone/11?closed=1)
39
39
40
-
####1.2.0 (2020-09-04)
40
+
### 1.2.0 (2020-09-04)
41
41
- Better ability to trigger a resave for partially valid values ([#19](https://github.com/AuthMe/ConfigMe/issues/19))
42
42
- See [comment about breaking changes](https://github.com/AuthMe/ConfigMe/issues/19#issuecomment-569066960)
43
43
- Indentation size and number of empty lines are now configurable in YamlFileResourceOptions ([#127](https://github.com/AuthMe/ConfigMe/issues/127))
@@ -48,7 +48,7 @@
48
48
49
49
:blue_book:[All changes in 1.2.0](https://github.com/AuthMe/ConfigMe/milestone/9?closed=1)
50
50
51
-
####1.1.0 (2019-02-27)
51
+
### 1.1.0 (2019-02-27)
52
52
- New property structure allowing to easily define maps and lists, see PropertyInitializer
53
53
- Support paths written together (e.g. "path.foo") in YML files
54
54
- Fix bug in which paths with special sequences (like numbers) cannot be read
@@ -58,15 +58,15 @@
58
58
59
59
:blue_book:[All changes in 1.1.0](https://github.com/AuthMe/ConfigMe/milestone/6?closed=1)
60
60
61
-
####1.0.1 (2018-09-08)
61
+
### 1.0.1 (2018-09-08)
62
62
- Support all Collection types for export values (not only lists)
63
63
- Fixes built-in lowercase String Set property creating output which cannot be read again
64
64
- Add getter on ConfigurationData to get all comments
65
65
- If not defined, SettingsManagerBuilder creates a manager that uses no migration service (instead of the default one)
66
66
67
67
:blue_book:[All changes in 1.0.1](https://github.com/AuthMe/ConfigMe/milestone/10?closed=1)
68
68
69
-
####1.0 (2018-09-08)
69
+
### 1.0 (2018-09-08)
70
70
- Large refactoring: see [Migrating from 0.x to 1.x](https://github.com/AuthMe/ConfigMe/wiki/Migrating-from-0.x-to-1.x) for migration guide
71
71
- Improve codebase, especially the export of values and the bean mapper ([#56](https://github.com/AuthMe/ConfigMe/issues/56))
72
72
- Fix serialization of nested beans ([#55](https://github.com/AuthMe/ConfigMe/issues/55))
@@ -80,12 +80,12 @@
80
80
:blue_book:[All changes in 1.0](https://github.com/AuthMe/ConfigMe/milestone/8?closed=1)
81
81
82
82
## ConfigMe 0.x
83
-
####0.4.1 (2018-01-14)
83
+
### 0.4.1 (2018-01-14)
84
84
- Fix `Optional` fields not being able to be saved in bean properties ([#51](https://github.com/AuthMe/ConfigMe/issues/51))
85
85
86
86
:blue_book:[All changes in 0.4.1](https://github.com/AuthMe/ConfigMe/milestone/7?closed=1)
87
87
88
-
####0.4 (2017-02-19)
88
+
### 0.4 (2017-02-19)
89
89
- Add support for `Optional`
90
90
- New optional property type `OptionalProperty`
91
91
- Support `Optional<?>` fields in beans
@@ -98,7 +98,7 @@
98
98
99
99
:blue_book:[All changes in 0.4](https://github.com/AuthMe/ConfigMe/milestone/4?closed=1)
100
100
101
-
####0.3 (2016-12-23)
101
+
### 0.3 (2016-12-23)
102
102
- Now available from Maven Central!
103
103
- The project package is now `ch.jalu.configme`
104
104
- Enhance handling of bean properties
@@ -116,7 +116,7 @@
116
116
117
117
:blue_book:[All changes in 0.3](https://github.com/AuthMe/ConfigMe/milestone/3?closed=1)
118
118
119
-
####0.2.1 (2016-10-22)
119
+
### 0.2.1 (2016-10-22)
120
120
Bugfix release:
121
121
- Fix YAML export of a beans property at root path
122
122
- Allow values of bean properties to be set via SettingsManager
@@ -125,14 +125,14 @@ Bugfix release:
125
125
:blue_book:[All changes in 0.2.1](https://github.com/AuthMe/ConfigMe/milestone/5?closed=1)
126
126
127
127
128
-
####0.2 (2016-10-16)
128
+
### 0.2 (2016-10-16)
129
129
- Allow mapping of configurations to JavaBeans classes
130
130
- Allow to provide comments for sections
131
131
132
132
:blue_book:[All changes in 0.2](https://github.com/AuthMe/ConfigMe/milestone/2?closed=1)
133
133
134
134
135
-
####0.1 (2016-09-04)
135
+
### 0.1 (2016-09-04)
136
136
Initial release:
137
137
- Cleanup of previously internally used configuration management
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ ConfigMe is managed heavily based on GitHub issues, so you're invited to open a
10
10
code changes first, either by creating an issue or by writing in the [`#configme` channel](https://discord.com/channels/295623711485198357/1143605240520769547)
11
11
of the AuthMe Discord server.
12
12
13
-
# General conventions
13
+
##General conventions
14
14
15
15
- If you're using IntelliJ, please install the Checkstyle plugin and configure it to use the rules from
16
16
`.checkstyle.xml`, located in the project's root directory.
@@ -20,7 +20,7 @@ of the AuthMe Discord server.
20
20
21
21
No sweat if some points aren't met since they can be addressed in pull requests, and PRs can be squashed.
22
22
23
-
# Code style
23
+
##Code style
24
24
25
25
Please try to match the current code style. A few pointers:
26
26
- Indent with spaces, not tabs
@@ -29,13 +29,13 @@ Please try to match the current code style. A few pointers:
29
29
- Use camel-case as defined in the [Google Java style guide](https://google.github.io/styleguide/javaguide.html#s5.3-camel-case)
30
30
(i.e. use names like `setHttpLink`, not `setHTTPLink`)
31
31
32
-
## Javadoc
32
+
###Javadoc
33
33
34
34
- Use the third-person form of verbs and not the imperative: "Gets all properties" and not "Get all properties".
35
35
- Avoid `@link` to common JDK types like `Map` or `String`. These types are visible from the method signature—manually
36
36
linking them adds no value.
37
-
- Try to provide context rather than just un-camel-case-ing the thing you're describing
38
-
(e.g. "Gets the result" on a method "getResult" does not provide any additional information).
37
+
- Try to provide context rather than just un-camel-case-ing the thing you're describing
38
+
(e.g. "Gets the result" on a method "getResult" does not provide any additional information).
39
39
- Do not close `<p>` tags in Javadoc text. This is in line with the JDK and Oracle's [recommendations](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format).
40
40
- Do not align parameter descriptions (in the form of `@param name the name` because of
0 commit comments