Skip to content

Rewrite the Ameba configuration. Add CGI alias.#101

Merged
tamdaz merged 5 commits into
mainfrom
ameba-configuration
Dec 29, 2025
Merged

Rewrite the Ameba configuration. Add CGI alias.#101
tamdaz merged 5 commits into
mainfrom
ameba-configuration

Conversation

@tamdaz
Copy link
Copy Markdown
Owner

@tamdaz tamdaz commented Dec 29, 2025

Description

In order to make the code understandable and less complex, several Ameba rules are explicitly added to its configuration file. Finally, the CGI alias 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 Nil to 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.

@tamdaz tamdaz added this to the v1.3.0 milestone Dec 29, 2025
@tamdaz tamdaz self-assigned this Dec 29, 2025
@tamdaz tamdaz added fixed Functionnality to be fixed / refactored / optimized documentation Documentation to write / improve labels Dec 29, 2025
@tamdaz tamdaz changed the title Rewrite the Ameba configuration; Add CGI alias. Rewrite the Ameba configuration. Add CGI alias. Dec 29, 2025
@tamdaz tamdaz merged commit c4d6ea6 into main Dec 29, 2025
6 checks passed
@tamdaz tamdaz deleted the ameba-configuration branch December 29, 2025 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation to write / improve fixed Functionnality to be fixed / refactored / optimized

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant