NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] CLI: adapt cloc doc to new behavior

Browse Source 
since https://github.com/odoo/odoo/pull/85854 cloc
also count stylesheet file and frontend file in
imported module

closes odoo/documentation#1733

X-original-commit: d2de65a15a
Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Thibault Francois 2022-03-07 13:25:48 +00:00
parent a458ae05e1
commit fe41dec3e9
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
content/developer/misc/other/cmdline.rst
View File

@ -729,7 +729,7 @@ Cloc
.. program:: odoo-bin cloc .. program:: odoo-bin cloc
Odoo Cloc is a tool to count the number of relevant lines written in Odoo Cloc is a tool to count the number of relevant lines written in
Python, Javascript or XML. This can be used as a rough metric for pricing Python, Javascript, CSS, SCSS, or XML. This can be used as a rough metric for pricing
maintenance of extra modules. maintenance of extra modules.
Command-line options Command-line options
@ -807,14 +807,15 @@ With the :option:`--database` option
Odoo Cloc counts the lines in each file of extra installed modules in a Odoo Cloc counts the lines in each file of extra installed modules in a
given database. In addition, it counts the Python lines of server actions and given database. In addition, it counts the Python lines of server actions and
custom computed fields that have been directly created in the database or custom computed fields that have been directly created in the database or
imported. imported. Finally, it counts the lines of code of Javascript, CSS, and SCSS files,
and of QWeb views from imported modules.
Some files are excluded from the count by default: Some files are excluded from the count by default:
- The manifest (:file:`__manifest__.py` or :file:`__openerp__.py`) - The manifest (:file:`__manifest__.py` or :file:`__openerp__.py`)
- The contents of the folder :file:`static/lib` - The contents of the folder :file:`static/lib`
- The tests defined in the folder :file:`tests` and :file:`static/tests` - The tests defined in the folder :file:`tests` and :file:`static/tests`
- The migrations scripts defined in the folder :file:`migrations` - The migrations scripts defined in the folder :file:`migrations` and `upgrades`
- The XML files declared in the ``demo`` or ``demo_xml`` sections of the manifest - The XML files declared in the ``demo`` or ``demo_xml`` sections of the manifest
For special cases, a list of files that should be ignored by Odoo Cloc can be defined For special cases, a list of files that should be ignored by Odoo Cloc can be defined
@ -826,6 +827,7 @@ per module. This is specified by the ``cloc_exclude`` entry of the manifest:
"lib/common.py", # exclude a single file "lib/common.py", # exclude a single file
"data/*.xml", # exclude all XML files in a specific folder "data/*.xml", # exclude all XML files in a specific folder
"example/**/*", # exclude all files in a folder hierarchy recursively "example/**/*", # exclude all files in a folder hierarchy recursively
"**/*.scss", # exclude all scss file from the module
] ]
| The pattern ``**/*`` can be used to ignore an entire module. This can be useful | The pattern ``**/*`` can be used to ignore an entire module. This can be useful