Skip to content

Commit 3c5fc64

Browse files
committed
chore: Add README.md to validation attribute directory.
1 parent dcb2599 commit 3c5fc64

File tree

1 file changed

+11
-0
lines changed
  • com.playeveryware.eos/Runtime/Core/Config/Attributes/Validators

1 file changed

+11
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Validator Attributes Usage & Application - HON
2+
3+
This directory contains a variety of attributes that can be applied to classes that derive from `Config`. The attributes are mostly implemented to make effective unit testing of a now-obsolete config class `EOSConfig`, but there are a few additional things to be cognizant of:
4+
5+
The following attributes were implemented to affect the user experience surrounding the entry of configuration values:
6+
7+
- `StringValidationAttribute`
8+
- `RegexValidationAttribute`
9+
- `LengthValidationAttribute`
10+
11+
The attributes above were applied to the `productVersion` field member of the `ProductConfig` class, and enable the user to see immediately when they add an invalid value to the product version field. These attributes and the system can (and likely should) be expanded and be applied to other field members of `ProductConfig`, and the various `PlatformConfig` implementing classes - so as to provide a similar user experience in other fields.

0 commit comments

Comments
 (0)