diff --git a/docs/en_us/internal/testing.rst b/docs/en_us/internal/testing.rst index 4e34692c3b..cab4b4c834 100644 --- a/docs/en_us/internal/testing.rst +++ b/docs/en_us/internal/testing.rst @@ -732,6 +732,27 @@ To view JavaScript code style quality run this command. +Code Complexity Tools +---------------------- + +Two tools are available for evaluating complexity of edx-platform code: + +- `radon `__ for Python code complexity. + * To obtain complexity, run + +:: + + paver run_complexity + +- `plato `__ for JavaScript code complexity. Several options are available on the command line; see documentation. + * Below, the following command will produce an html report in a subdirectory called "jscomplexity" + +:: + + plato -q -x common/static/js/vendor/ -t common -l .jshintrc -r -d jscomplexity common/static/js/ + + + Testing using queue servers --------------------------- diff --git a/package.json b/package.json index c7f7232cb4..62e0affb90 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ }, "devDependencies": { "jshint": "^2.7.0", - "edx-custom-a11y-rules": "edx/edx-custom-a11y-rules" + "edx-custom-a11y-rules": "edx/edx-custom-a11y-rules", + "plato": "1.2.2" } }