From 4861d0bbfc3a1e93ca9f2c89fffc47f281fdfcbf Mon Sep 17 00:00:00 2001 From: Barbazul Date: Tue, 5 Oct 2021 18:04:01 -0300 Subject: [PATCH 1/2] Began work on Ruleset.md --- docs/Ruleset.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 docs/Ruleset.md diff --git a/docs/Ruleset.md b/docs/Ruleset.md new file mode 100644 index 0000000..05e9e5f --- /dev/null +++ b/docs/Ruleset.md @@ -0,0 +1,95 @@ +# Classes + +Code | Level | Rule +-----|-------|------- +M019 | PATCH | [public] Property overwrite has been added. +M020 | PATCH | [protected] Property overwrite has been added. +M026 | PATCH | [private] Property overwrite has been added. +M028 | PATCH | Method overwrite has been added. +M029 | PATCH | Method overwrite has been removed. +M071 | MINOR | Constant has been added. +M073 | MAJOR | Constant has been removed. +M075 | PATCH | Constant has been moved to parent class or implemented interface. +M091 | PATCH | [public] Method has been moved to parent class. +M093 | PATCH | [public] Property has been moved to parent class. +M094 | PATCH | [protected] Property has been moved to parent class. +M095 | PATCH | [protected] Method has been moved to parent class. +M0122 | MAJOR | Extends has been removed. +M0123 | MAJOR | Implements has been removed. +M0124 | MINOR | Parent has been added. +M0125 | MINOR | Interface has been added. +M0126 | MINOR | New trait has been used. +M0141 | MINOR | @api annotation has been added. +M0142 | MAJOR | @api annotation has been removed. +M100 | MINOR | Removed last method parameter(s). +M101 | PATCH | Removed last constructor parameter(s). +M102 | MINOR | [public,protected] Added optional parameter(s). +M102 | PATCH | [private] Added optional parameter(s). +M103 | MINOR | Added a required constructor object parameter. +M111 | MINOR | Added an optional constructor parameter to extendable @api class. +M112 | PATCH | Added an optional constructor parameter. +M113 | MAJOR | [public] Method parameter typing changed. +M114 | MAJOR | [protected] Method parameter typing changed. +M115 | PATCH | [private] Method parameter typing changed. +M120 | MAJOR | [public] Method return typing changed. +M121 | MAJOR | [protected] Method return typing changed. +M122 | PATCH | [private] Method return typing changed. +M127 | MAJOR | Exception has been superclassed. +M129 | MINOR | Exception has been subclassed. +M131 | MAJOR | Superclassed Exception has been added. + +# Interface + +Code | Level | Rule +-----|-------|------- +M072 | MINOR | Constant has been added. +M074 | MAJOR | Constant has been removed. +M076 | PATCH | Constant has been moved to parent class or implemented interface. +M092 | PATCH | [public] Method has been moved to parent class. +M096 | PATCH | [protected] Method has been moved to parent class. +M0122 | MAJOR | Extends has been removed. +M0127 | MINOR | Added parent to interface. +M100 | MINOR | Removed last method parameter(s). +M102 | MAJOR | Added optional parameter(s). +M116 | MAJOR | Method parameter typing changed. +M123 | MAJOR | Method return typing changed. +M128 | MAJOR | Exception has been superclassed. +M130 | MINOR | Exception has been subclassed. +M132 | MAJOR | Superclassed Exception has been added. + +# Trait + +Code | Level | Rule +-----|-------|------- +M100 | MINOR | Removed last method parameter(s). +M102 | MINOR | Added optional parameter(s). +M117 | MAJOR | [public] Method parameter typing changed. +M118 | MAJOR | [protected] Method parameter typing changed. +M119 | MAJOR | [private] Method parameter typing changed. +M124 | MAJOR | [public] Method return typing changed. +M125 | MAJOR | [protected] Method return typing changed. +M126 | MAJOR | [private] Method return typing changed. + +# Database + +Code | Level | Rule +-----|-------|------- +M104 | MAJOR | Table was dropped +M105 | MAJOR | Table chard was changed from %s to %s +M106 | MINOR | Key was dropped. But it can be used for 3-rd parties foreign keys +M107 | MAJOR | Column was removed +M108 | MAJOR | Foreign key removed from declaration but it may have had business logic in onDelete statement +M108 | MAJOR | Foreign key was removed +M109 | MINOR | Whitelist do not have table %s declared in db_schema.xml +M109 | MAJOR | Db Whitelist from module %s was removed +M110 | MAJOR | Module db schema whitelist reduced (%s). +M202 | MINOR | Table was added +M203 | MINOR | Column was added +M204 | MAJOR | Foreign key was added +M205 | MAJOR | Foreign key was changed +M205 | MAJOR | Primary key was added +M206 | MAJOR | Primary key was changed +M207 | MAJOR | Primary key was removed +M208 | MAJOR | Unique key was added +M209 | MAJOR | Unique key was removed +M210 | MAJOR | Unique key was changed From 7376e45d1383b84b8620f6162a729f9749ef5d2e Mon Sep 17 00:00:00 2001 From: Barbazul Date: Wed, 6 Oct 2021 12:47:19 -0300 Subject: [PATCH 2/2] Finished docomenting all operations --- docs/Ruleset.md | 183 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 183 insertions(+) diff --git a/docs/Ruleset.md b/docs/Ruleset.md index 05e9e5f..652a332 100644 --- a/docs/Ruleset.md +++ b/docs/Ruleset.md @@ -26,6 +26,12 @@ M101 | PATCH | Removed last constructor parameter(s). M102 | MINOR | [public,protected] Added optional parameter(s). M102 | PATCH | [private] Added optional parameter(s). M103 | MINOR | Added a required constructor object parameter. +M109 | MAJOR | Constant visibility has been changed to lower lever from %s to %s +M109 | MINOR | Constant visibility has been changed to higher lever from %s to %s +M109 | MAJOR | Method visibility has been changed to lower lever from %s to %s +M109 | MINOR | Method visibility has been changed to higher lever from %s to %s +M109 | MAJOR | Property visibility has been changed to lower lever from %s to %s +M109 | MINOR | Property visibility has been changed to higher lever from %s to %s M111 | MINOR | Added an optional constructor parameter to extendable @api class. M112 | PATCH | Added an optional constructor parameter. M113 | MAJOR | [public] Method parameter typing changed. @@ -37,6 +43,24 @@ M122 | PATCH | [private] Method return typing changed. M127 | MAJOR | Exception has been superclassed. M129 | MINOR | Exception has been subclassed. M131 | MAJOR | Superclassed Exception has been added. +M134 | MAJOR | [public] Method parameter typehint was moved from doc block annotation to in-line. +M135 | MAJOR | [public] Method parameter typehint was moved from in-line to doc block annotation. +M136 | MAJOR | [public] Method return typehint was moved from doc block annotation to in-line. +M137 | MAJOR | [public] Method return typehint was moved from in-line to doc block annotation. +M146 | MAJOR | [public] Method variable typehint was moved from doc block annotation to in-line. +M149 | MAJOR | [public] Method variable typehint was moved from in-line to doc block annotation. +M152 | MINOR | [protected] Method parameter typehint was moved from doc block annotation to in-line. +M154 | MINOR | [protected] Method parameter typehint was moved from in-line to doc block annotation. +M156 | MINOR | [protected] Method return typehint was moved from doc block annotation to in-line. +M158 | MINOR | [protected] Method return typehint was moved from in-line to doc block annotation. +M160 | MINOR | [protected] Method variable typehint was moved from doc block annotation to in-line. +M162 | MINOR | [protected] Method variable typehint was moved from in-line to doc block annotation. +M164 | PATCH | [private] Method parameter typehint was moved from doc block annotation to in-line. +M166 | PATCH | [private] Method parameter typehint was moved from in-line to doc block annotation. +M168 | PATCH | [private] Method return typehint was moved from doc block annotation to in-line. +M170 | PATCH | [private] Method return typehint was moved from in-line to doc block annotation. +M172 | PATCH | [private] Method variable typehint was moved from doc block annotation to in-line. +M174 | PATCH | [private] Method variable typehint was moved from in-line to doc block annotation. # Interface @@ -51,11 +75,23 @@ M0122 | MAJOR | Extends has been removed. M0127 | MINOR | Added parent to interface. M100 | MINOR | Removed last method parameter(s). M102 | MAJOR | Added optional parameter(s). +M109 | MAJOR | Constant visibility has been changed to lower lever from %s to %s +M109 | MINOR | Constant visibility has been changed to higher lever from %s to %s +M109 | MAJOR | Method visibility has been changed to lower lever from %s to %s +M109 | MINOR | Method visibility has been changed to higher lever from %s to %s +M109 | MAJOR | Property visibility has been changed to lower lever from %s to %s +M109 | MINOR | Property visibility has been changed to higher lever from %s to %s M116 | MAJOR | Method parameter typing changed. M123 | MAJOR | Method return typing changed. M128 | MAJOR | Exception has been superclassed. M130 | MINOR | Exception has been subclassed. M132 | MAJOR | Superclassed Exception has been added. +M138 | MAJOR | Method parameter typehint was moved from doc block annotation to in-line. +M139 | MAJOR | Method parameter typehint was moved from in-line to doc block annotation. +M140 | MAJOR | Method return typehint was moved from doc block annotation to in-line. +M141 | MAJOR | Method return typehint was moved from in-line to doc block annotation. +M147 | MAJOR | Method variable typehint was moved from doc block annotation to in-line. +M150 | MAJOR | Method variable typehint was moved from in-line to doc block annotation. # Trait @@ -69,6 +105,24 @@ M119 | MAJOR | [private] Method parameter typing changed. M124 | MAJOR | [public] Method return typing changed. M125 | MAJOR | [protected] Method return typing changed. M126 | MAJOR | [private] Method return typing changed. +M142 | MAJOR | [public] Method parameter typehint was moved from doc block annotation to in-line. +M143 | MAJOR | [public] Method parameter typehint was moved from in-line to doc block annotation. +M144 | MAJOR | [public] Method return typehint was moved from doc block annotation to in-line. +M145 | MAJOR | [public] Method return typehint was moved from in-line to doc block annotation. +M148 | MAJOR | [public] Method variable typehint was moved from doc block annotation to in-line. +M151 | MAJOR | [public] Method variable typehint was moved from in-line to doc block annotation. +M153 | MINOR | [protected] Method parameter typehint was moved from doc block annotation to in-line. +M155 | MINOR | [protected] Method parameter typehint was moved from in-line to doc block annotation. +M157 | MINOR | [protected] Method return typehint was moved from doc block annotation to in-line. +M159 | MINOR | [protected] Method return typehint was moved from in-line to doc block annotation. +M161 | MINOR | [protected] Method variable typehint was moved from doc block annotation to in-line. +M163 | MINOR | [protected] Method variable typehint was moved from in-line to doc block annotation. +M165 | MINOR | [private] Method parameter typehint was moved from doc block annotation to in-line. +M167 | MINOR | [private] Method parameter typehint was moved from in-line to doc block annotation. +M169 | MINOR | [private] Method return typehint was moved from doc block annotation to in-line. +M171 | MINOR | [private] Method return typehint was moved from in-line to doc block annotation. +M173 | MINOR | [private] Method variable typehint was moved from doc block annotation to in-line. +M175 | MINOR | [private] Method variable typehint was moved from in-line to doc block annotation. # Database @@ -93,3 +147,132 @@ M207 | MAJOR | Primary key was removed M208 | MAJOR | Unique key was added M209 | MAJOR | Unique key was removed M210 | MAJOR | Unique key was changed + +# XSD + +Code | Level | Rule +-----|-------|------- +M0133 | MINOR | An optional node was added +M0134 | MINOR | An optional attribute was added +M0135 | MAJOR | A required node was added +M0136 | MAJOR | A required attribute was added +M0137 | MAJOR | A node was removed +M0138 | MAJOR | An attribute was removed +M0139 | MAJOR | A schema declaration was removed +M0140 | MINOR | A schema declaration was added + +# DI + +Code | Level | Rule +-----|-------|------- +M200 | MAJOR | Virtual Type was removed +M201 | MAJOR | Virtual Type was changed + +# MFTF + +Code | Level | Rule +-----|-------|------- +M200 | MAJOR | \ was removed +M201 | MAJOR | \ \ was removed +M202 | MAJOR | \ \ was removed +M202 | MAJOR | \ \ was changed +M204 | PATCH | \ \ was changed +M205 | MAJOR | Entity was removed +M206 | MAJOR | Entity \ element was removed +M207 | MINOR | Entity \ \ element was removed +M208 | MAJOR | Entity \ element was removed +M209 | MAJOR | Entity \ element was removed +M210 | MAJOR | Entity \ element was removed +M211 | MAJOR | \ was removed +M212 | MAJOR | \ child element was removed +M213 | MAJOR | \ was removed +M214 | MAJOR | \ \ was removed +M215 | MAJOR | \ was removed +M216 | MAJOR | \ \ was removed +M217 | PATCH | \ \ was changed +M218 | PATCH | \ \ type was changed +M218 | MAJOR | \ was removed +M219 | PATCH | \ \ selector was changed +M219 | MAJOR | \ \ was removed +M220 | MAJOR | \ \ \ was removed +M221 | PATCH | \ \ was removed or changed +M222 | PATCH | \ \ was changed +M223 | PATCH | \ \ type was changed +M223 | MAJOR | \ \ sequence was changed +M224 | PATCH | \ \ type was changed +M225 | MINOR | \ was added +M226 | MINOR | \ \ was added +M227 | MAJOR | \ \ was added +M228 | MINOR | \ was added +M229 | MINOR | \ \ was added +M230 | MINOR | Entity \ element was added +M231 | PATCH | \ \ element was added +M232 | MINOR | \ \ element was added +M233 | MINOR | \ was added +M234 | MINOR | \ \ was added +M235 | MINOR | \ was added +M236 | MINOR | \ \ was added +M237 | MINOR | \ was added +M238 | MINOR | \ \ was added +M239 | PATCH | \ \ was added +M240 | MINOR | \ was added +M241 | MINOR | \ was changed +M241 | MINOR | \ \ ref was changed +M242 | MINOR | \ child element was added +M250 | MAJOR | \ \ parameterized was changed +M401 | MAJOR | \ \ was added +M402 | MAJOR | \ \ was removed +M404 | MAJOR | \ \ was added +M406 | MAJOR | \ \ was removed +M407 | MINOR | \ was added +M408 | PATCH | \ was removed +M409 | PATCH | \ \ \ was added +M410 | PATCH | \ \ \ was removed +M412 | MINOR | \ \ \ was added +M415 | MAJOR | \ \ \ was removed +M416 | PATCH | \ \ \ was changed +M417 | MINOR | \ \ \ ref was changed +M418 | MAJOR | \ \ \ sequence was changed +M419 | PATCH | \ \ \ type was changed +M420 | MAJOR | \ \ \ \ was added +M421 | MAJOR | \ \ \ \ was removed + +# Layout + +Code | Level | Rule +-----|-------|------- +M220 | MAJOR | Block was removed +M221 | MAJOR | Container was removed +M222 | MAJOR | An Update was removed + +# System + +Code | Level | Rule +-----|-------|------- +M300 | MINOR | System configuration file was added +M301 | MAJOR | System configuration file was removed +M302 | MINOR | A field-node was added +M303 | MAJOR | A field-node was removed +M304 | MINOR | A group-node was added +M305 | MAJOR | A group-node was removed +M306 | MINOR | A section-node was added +M307 | MAJOR | A section-node was removed + +# Less + +Code | Level | Rule +-----|-------|------- +M400 | MAJOR | A less variable-node was removed +M401 | MAJOR | A less mixin-node was removed +M402 | MAJOR | A less import-node was removed +M403 | MAJOR | A parameter was added to the mixin-node + +# ET Schema + +Code | Level | Rule +-----|-------|------- +T001 | MAJOR | Removed declaration for type %s. +T002 | MAJOR | Removed field %s from type %s. +T003 | MAJOR | Changed field %s declaration in type %s. +T004 | MINOR | Added a new declaration for record %s. +T005 | PATCH | Added field %s to type %s.