Merge pull request #8915 from edx/benp/add-plato-jul2015

Add plato JS static code analysis tool.
This commit is contained in:
Ben Patterson
2015-12-08 11:39:06 -05:00
2 changed files with 23 additions and 1 deletions

View File

@@ -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 <https://radon.readthedocs.org/en/latest/>`__ for Python code complexity.
* To obtain complexity, run
::
paver run_complexity
- `plato <https://github.com/es-analysis/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
---------------------------

View File

@@ -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"
}
}