General improvments #140
Merged
General improvments #140
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This cleaning means that we remove old validators, descriptions, converters and similar from groups.
This allows us to define objects in our extension settings where the keys should not be verified. We can see this as something in the settings to have an actual value as an object, something that is desirable in some cases. Related to rocjs/roc-package-web-component#8
Solved two bugs where we would not validate objects correctly using isObject. Improved isArray and isObject validators to provide better feedback to the user.
andreasrs
approved these changes
Oct 18, 2016
| unmanaged Defaults to false, Roc will not check for mismatches in projects when true. | ||
| ``` | ||
|
|
||
| If `unmanaged` is set to `true` the object will be managed in an unmanaged way where the keys on the object will not be verified by Roc. This is useful if the value for the specific property should be treated as an object. |
There was a problem hiding this comment.
Perhaps better written as the object will not be managed, meaning that Roc will not verify the object keys in this case.
|
|
||
| An important thing is to make sure that a validator always returns a value for it to function correctly. It’s also encouraged that custom validators have support for generating an `infoObject` that will be used for documentation purposes, error messages and in some cases converting values. [Read more below.](#infoObject) | ||
|
|
||
| ### Error object | ||
| For more complex validators one might need to return an error object instead of `false` / error string. This error object can be used to provide better information to user of Roc about exectly where the error occurred. The object can contain 3 properties; `key`, `value` and `message`. |
| @@ -181,68 +181,35 @@ export default function runCli({ | |||
| cwd: dirPath, | |||
| }).catch((error) => { | |||
| process.exitCode = error.getCode ? error.getCode() : 1; | |||
| log.small.error('A problem happened when running the Roc command'); | |||
| log.small.error('An error happened when running command'); | |||
| ``` | ||
| Will validate the input to make sure it’s an object consisting of the possible validator for values. | ||
| Will validate the input to make sure it’s an object consisting of the possible validator for values. Possible to provide an options object, can be the first argument if no validator is used or the second if a validator is used. |
| @@ -209,3 +209,42 @@ function updateStateMeta(name, state, extensionConfigPaths, extensionMetaPaths, | |||
|
|
|||
| return newState.meta; | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
A lot of stuff going on in this module. Perhaps a candidate for more comments and maybe split/naming, as I do find it a bit hard to follow.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
--no-option