Skip to content

Commit

Permalink
version 2.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
christopheexakat committed Oct 29, 2023
1 parent 0d56e07 commit b58dee1
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 28 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ SPHINXBUILD ?= sphinx-build
#SPHINXBUILD = /Users/famille/Library/Python/2.7/bin/sphinx-build
SPHINXBUILD = /opt/homebrew/bin/sphinx-build
PAPER =
BUILDDIR = build
BUILDDIR = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
Expand Down
86 changes: 70 additions & 16 deletions Reference/Rules.rst

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions Reference/Rulesets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Rulesets
Introduction
------------------------

Exakat provides unique 1596 rules to detect BUGS, CODE SMELLS, SECURITY OR QUALITY ISSUES in your PHP code.
Exakat provides unique 1597 rules to detect BUGS, CODE SMELLS, SECURITY OR QUALITY ISSUES in your PHP code.

For more smoothly usage, the ruleset concept allow you to run a set of rules based on a decidated focus. Beawre that a Ruleset run all the associated rules and any needed dependencies.

Expand Down Expand Up @@ -130,7 +130,7 @@ All

All is a dummy ruleset, which includes all the rules. It is mostly used internally.

Total : 1594 analysis
Total : 1595 analysis

* :ref:`adding-zero`
* :ref:`ambiguous-array-index`
Expand Down Expand Up @@ -1726,6 +1726,7 @@ Total : 1594 analysis
* :ref:`multiline-expressions`
* :ref:`typed-class-constants-usage`
* :ref:`favorite-casting-method`
* :ref:`structures-getclasswithoutarg`

Specs
_____
Expand Down
8 changes: 4 additions & 4 deletions User/Overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Overview
Summary
-------

* `1596 analyzers`
* `1597 analyzers`
* `Compatible with PHP 5.2 to 8.2`_
* `Migration guide from 5.2 to 8.2`_
* `Modernize your code`_
Expand All @@ -18,15 +18,15 @@ Summary
* `Code visualizations`_


1596 analyzers
1597 analyzers
-----------------------------

There are currently 1596 different analyzers that check the PHP code to report code smells. Analyzers are inspired by PHP manual, migration documents, community good practices, computer science or simple logic.
There are currently 1597 different analyzers that check the PHP code to report code smells. Analyzers are inspired by PHP manual, migration documents, community good practices, computer science or simple logic.

Some of them track rare occurrences, and some are frequent. Some track careless mistakes and some are highly complex situations. In any case, exakat has your back, and will warn you.

.. image:: ../images/dashboard.748.png
:alt: 1596 analysis with faceted search
:alt: 1597 analysis with faceted search


Compatible with PHP 5.2 to 8.2
Expand Down
2 changes: 1 addition & 1 deletion User/Rule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Rule
Rules
----------------------------------

Exakat provides unique 1596 rules to detect BUGS, CODE SMELLS, SECURITY OR QUALITY ISSUES in your PHP code.
Exakat provides unique 1597 rules to detect BUGS, CODE SMELLS, SECURITY OR QUALITY ISSUES in your PHP code.

Each rule is documented with :
* a PHP version : The version of PHP to wich the rule apply
Expand Down
2 changes: 2 additions & 0 deletions User/Scoping.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1363,6 +1363,7 @@ INI configuration for built-in rulesets. Copy them in config/rulesets.ini, and e
analyzer[] = "Structures/ForgottenWhiteSpace";
analyzer[] = "Structures/FunctionPreSubscripting";
analyzer[] = "Structures/FunctionSubscripting";
analyzer[] = "Structures/GetClassWithoutArg";
analyzer[] = "Structures/GlobalInGlobal";
analyzer[] = "Structures/GlobalOutsideLoop";
analyzer[] = "Structures/GlobalUsage";
Expand Down Expand Up @@ -2972,6 +2973,7 @@ YAML configuration for built-in rulesets. Copy them in your code, with the name
- 'Structures/ForgottenWhiteSpace'
- 'Structures/FunctionPreSubscripting'
- 'Structures/FunctionSubscripting'
- 'Structures/GetClassWithoutArg'
- 'Structures/GlobalInGlobal'
- 'Structures/GlobalOutsideLoop'
- 'Structures/GlobalUsage'
Expand Down
12 changes: 8 additions & 4 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,24 +48,24 @@

# General information about the project.
project = u'Exakat'
copyright = u'2015-2023, Damien Seguy – Exakat SAS <contact(at)exakat.io>'
copyright = u'2015-2022, Damien Seguy – Exakat SAS <contact(at)exakat.io>'
author = u'Damien Seguy'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'2.6.1'
version = u'2.3.6'
# The full version, including alpha/beta/rc tags.
release = u'2'
release = u'1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -286,6 +286,10 @@
#texinfo_no_detailmenu = False


import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# Set up PHP syntax highlights
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer
Expand Down

0 comments on commit b58dee1

Please sign in to comment.