5,705
edits
Changes
→Getting involved
== Summary ==
== Summary ==
A set of configuration files and scripts to [http://en.wikipedia.org/wiki/Lint_%28software%29 lint] various sugar related code.
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:
Clone sugar-lint repository:
Clone sugar-lint repository:
git clone git://git.sugarlabs.org/sugar-lint/mainline.git ''<install-path>''
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):
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 ''<full-install-path>''/sugar/lint/git-pre-commit-hook ''<project-root>''/.git/hooks/pre-commit
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.
/* sugar-lint: disable */
/* sugar-lint: disable */
== Resources ==
=== 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/projects/sugar-lint sources]
* 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].