Rewrite the Ameba configuration. Add CGI alias.#101
Merged
Conversation
CGI alias.CGI alias.
This file contains hidden or 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
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.
Description
In order to make the code understandable and less complex, several Ameba rules are explicitly added to its configuration file. Finally, the
CGIalias is added to write the namespace shortly for interface(s).Documentation/Documentation
For this project, it will be mandatory to write documentation for all classes, methods, enumerations, and modules. If it is missing, Ameba will detect it. Adding comments for unit tests and helpers is optional.
Layout/LineLength
It would be interesting to limit the number of characters per line. For this shard, it is set to a maximum of 110.
Lint/VoidOutsideLib
As the keyword “Void” is mainly used for C bindings, it would be preferable to use the keyword
Nilto validate this rule.Style/HeredocIndent
Indenting heredocs makes it easier to view their content (TBD).
Style/RedundantSelf
This rule is enabled to avoid redundancy in variable names, in particular for unit tests.