Platform Team/Sugar Lint: Difference between revisions
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Summary == | == Summary == | ||
A set of configuration files and scripts to [ | A set of configuration files and scripts to [[wikipedia:Lint_%28software%29|lint]] various sugar related code. | ||
During execution, sugar-lint will lint: | During execution, sugar-lint will lint: | ||
| Line 15: | Line 12: | ||
Clone sugar-lint repository: | Clone sugar-lint repository: | ||
git clone git://git.sugarlabs.org/sugar-lint | git clone git://git.sugarlabs.org/sdk/sugar-lint.git ''<install-path>'' | ||
cd ''<install-path>'' | |||
git submodule update --init | |||
Add sugar-lint command to PATH e.g. to ~/.bashrc (you need to relogin): | Add sugar-lint command to PATH e.g. to ~/.bashrc (you need to relogin): | ||
echo PATH=''< | echo PATH=''<full-install-path>'':$PATH >> ~/.bashrc | ||
== Usage == | == Usage == | ||
| Line 41: | Line 40: | ||
To add pre-commit git hook to lint files before commiting to arbitrary project: | To add pre-commit git hook to lint files before commiting to arbitrary project: | ||
ln -s ''< | ln -s ''<full-install-path>''/sugar_lint/git-pre-commit-hook ''<project-root>''/.git/hooks/pre-commit | ||
== Additional syntax == | == Additional syntax in source files == | ||
Various sugar-lint related hints that could be used in source files. | Various sugar-lint related hints that could be used in source files. | ||
| Line 58: | Line 57: | ||
/* sugar-lint: disable */ | /* sugar-lint: disable */ | ||
== | === Ignore pep8.py checks in Python sources === | ||
# pep8: ignore=''code''[,''code''] | |||
== Customize lint configuration == | |||
After cloning sugar-lint sources it contain default configuration files and configuration might be tuned to local need at any time. Configuration files are: | |||
* {{Code|sugar_lint/pylintrc}}<br>pylint config file; | |||
* {{Code|sugar_lint/pep8rc}}<br>pep8.py config file; | |||
* {{Code|sugar_lint/indent.pro}}<br>indent and vala-indent config file. | |||
== Getting involved == | |||
* [http://git.sugarlabs.org/ | * Read the [http://git.sugarlabs.org/sdk/sugar-lint/blobs/master/HACKING HACKING] file to know how to contribute with code. | ||
* Sugar Lint [http://git.sugarlabs.org/sdk/sugar-lint sources]. | |||