version 2.4.2b

exakat · Jun 2, 2022 · 8280709 · 8280709
1 parent 60367aa
commit 8280709
Show file tree

Hide file tree

Showing 14 changed files with 2,336 additions and 1,388 deletions.
diff --git a/Annex.rst b/Annex.rst
diff --git a/Changelog.rst b/Changelog.rst
@@ -6,7 +6,7 @@ Release Note
 
 Here is the release note of exakat. 
 
-**Version 2.4.3 (???, 2022-06-02)**
+**Version 2.4.3 (Li Jiancheng, 2022-06-16)**
 
 
 + Architecture
@@ -19,25 +19,52 @@ Here is the release note of exakat.
     + 
 
 + Analysis
-    + Refactored analysis : 'Raised access Level' now supports PDFF files
-    + Refactored analysis : 'Cant Extends Final' also Works with anonymous classes
-    + New analysis : Report 'Lowered access levels'
+    + 
 
 + Tokenizer
     + 
 
-**Version 2.4.2 (Li Chunfeng, 2022-05-18)**
+**Version 2.4.3 (Emperor Gaozu of Tang, 2022-06-02)**
 
 
 + Architecture
-    + 
+    + Doctor failed to copy the tinkergraph configuration files
+    + Removed old connector GSneo4j/Tinkergraph
+    + Refactored starting/emptying of gremlin database
 
 + Cobbler
-    + 
+    + Added suggestions when the -P is not found
+    + New cobbler : add Final to classes
 
 + Report
     + 
 
++ Analysis
+    + Fixed analysis : Undefined Classes and Trait where affected by the recent Complete/Returntyping
+    + Refactored analysis : 'Variables Used Once' not omit inherited parameters.
+    + Refactored analysis : 'Functions without return' not skip methods with Never and methods that throw in the main sequence.
+    + New analysis : 'Parent is not Static', but rather self
+    + Refactored analysis : 'Use This'
+    + Refactored analysis : 'Extension/Extxhprof' to PDFF
+    + Refactored analysis : Removing usage of methods, moving to PDFF
+    + New analysis : 'No magic method for Enums'
+    + Refactored analysis : 'Multiple Identical Keys' now also processes automated index
+    + New analysis : 'Modifying Readonly' (WIP)
+    + Refactored analysis : 'Could use short assignation' skips usage of ??
+    + New analysis : 'Readonly Can only be assigned in defining class'
+    + Refactored analysis : 'Runkit7' was upgraded to PDFF
+    + Refactored analysis : 'Gnupg' was upgraded to PDFF
+    + Refactored analysis : 'xdiff' was upgraded to PDFF
+    + Refactored analysis : 'event' was upgraded to PDFF
+    + New analysis : ext/stomp, ext/csv
+    + New analysis : Suggestion making the default assignation in property definition
+
++ Tokenizer
+    + Added support for PHP 8.2 readonly classes
+
+**Version 2.4.2 (Li Chunfeng, 2022-05-18)**
+
+
 + Analysis
     + Refactored analysis : 'Raised access Level' now supports PDFF files
     + Refactored analysis : 'Cant Extends Final' also Works with anonymous classes

diff --git a/Introduction.rst b/Introduction.rst
@@ -3,7 +3,7 @@
 Introduction
 ============
 
-This is the documentation of the Exakat engine, version 2.4.2 (Build 1315), on Fri, 06 May 2022 10:43:57 +0000.
+This is the documentation of the Exakat engine, version  (Build 1333), on Tue, 31 May 2022 08:05:36 +0000.
 
 What is Exakat ? 
 ----------------

diff --git a/Reference/Cobblers.rst b/Reference/Cobblers.rst
@@ -2017,4 +2017,61 @@ Specs
 +----------------+-----------------------------+
 
 
+.. _classes-addfinalclass:
+
+.. _add-final-class:
+
+Add Final Class
+_______________
+Adds ``final`` keyword to classes that can suppport it.
+
+.. _add-final-class-before:
+
+Before
+^^^^^^
+.. code-block:: php
+
+   <?php
+   
+   class x {
+   }
+   
+   ?>
+
+.. _add-final-class-after:
+
+After
+^^^^^
+.. code-block:: php
+
+   <?php
+   
+   final class x {
+   }
+   
+   ?>
+
+.. _add-final-class-related-cobbler:
+
+Related Cobblers
+^^^^^^^^^^^^^^^^
+
+* :ref:`No anchor for Classes/AddFinalConstant <no-anchor-for-classes-addfinalconstant>`
+
+
+
+.. _add-final-class-specs:
+
+Specs
+^^^^^
+
++----------------+-----------------------+
+| Short Name     | Classes/AddFinalClass |
++----------------+-----------------------+
+| Exakat version | 2.3.0                 |
++----------------+-----------------------+
+| Available in   |                       |
++----------------+-----------------------+
+
+
 
diff --git a/Reference/Reports.rst b/Reference/Reports.rst
@@ -69,6 +69,7 @@ Summary
   * :ref:`CompatibilityPHP80 <report-compatibilityphp80>`
   * :ref:`CompatibilityPHP81 <report-compatibilityphp81>`
   * :ref:`Unused <report-unused>`
+  * :ref:`Weekly <report-weekly>`
 
 
 
@@ -2145,7 +2146,7 @@ For example, `CombinedAssignRector <https://github.com/rectorphp/rector/blob/mas
 
 Not all exakat rules are covered by Rector, and vice-versa. `CompactToVariablesRector <https://github.com/rectorphp/rector/blob/master/docs/AllRectorsOverview.md#compacttovariablesrector>`_ aims à skipping usage of compact(), while `Structures/CouldUseCompact <https://exakat.readthedocs.io/en/latest/Rules.html#could-use-compact>`_ suggest the contrary. 
 
-Rector and Exakat both use different approaches to code review. It is recommended to review the changes before commiting them.
+Rector and Exakat both use different approaches to code review. It is recommended to review the changes before committing them.
 
 Check `RectorPHP <https://getrector.org/>`_ website, its `rector github <https://github.com/rectorphp/rector>`_ repository, and `Tomas Votruba <https://twitter.com/VotrubaT>`_ account.
 
@@ -3695,7 +3696,7 @@ The Unused report reports structures that are defined in the code, but never use
 
 + Constants
 + Functions, methods, properties
-+ Classes, Enumration, traits and interfaces
++ Classes, enumerations, traits and interfaces
 + Return values and parameters
 + Default values
 + Never used
@@ -3725,6 +3726,43 @@ Specs
 +--------------+-------------------------------------+
 
 
+.. _report-weekly:
+
+Weekly
+######
+
+Weekly
+______
+
+Weekly report draw a selection of issues to check in your code, each week. 
+
+The weekly report draws issues from 5 rules, randomly or chosen specially for that week. The rules of a week are stored on exakat.io, and everyone will work on the same errors. You can work on yours, and then, discuss then with your colleagues, cousins and anyone in the community : they are the focus of the week.  
+
+The selections of the previous weeks, and, the next week are offered. Just be aware that next week's selection may change, without warning. 
+
+If your code is already immune to all this week's rules : good job! You can share you experience with others!
+
+
+.. image:: ../images/report.weekly.png
+    :alt: Example of a Weekly report (0)
+
+
+
+Specs
+^^^^^
++--------------+-----------------------------------------------------+
+| Short name   | Weekly                                              |
++--------------+-----------------------------------------------------+
+| Rulesets     | :ref:`ruleset-analyze`, :ref:`ruleset-suggestions`. |
++--------------+-----------------------------------------------------+
+| Type         | HTML                                                |
++--------------+-----------------------------------------------------+
+| Target       | This report is written in 'weekly'.                 |
++--------------+-----------------------------------------------------+
+| Available in |                                                     |
++--------------+-----------------------------------------------------+
+
+