| Rev | Line | |
|---|
| [483] | 1 | The checkstyle tool is provided to help Dojo developers conform to the Dojo style guides. |
|---|
| 2 | |
|---|
| 3 | Read the help by running the command: |
|---|
| 4 | checkstyle.sh help |
|---|
| 5 | or |
|---|
| 6 | checkstyle.bat.help |
|---|
| 7 | |
|---|
| 8 | If you want to use the checkstyleReport.html tool to fix style errors and save the files, |
|---|
| 9 | make a copy of the file 'checkstyle.php.rename.html', and call it 'checkstyle.php'. |
|---|
| 10 | This script will then be used to save fixed files. |
|---|
| 11 | |
|---|
| 12 | All fixed files end in '.checkstyle.js', e.g. dojo/back.js.checkstyle.js. |
|---|
| 13 | Cnce you are satisfied with the changes, commit them all by typing: |
|---|
| 14 | checkstyle.sh commit |
|---|
| 15 | |
|---|
| 16 | |
|---|
| 17 | Troubleshooting |
|---|
| 18 | --------------- |
|---|
| 19 | 1. It says the file was saved but nothing was saved |
|---|
| 20 | |
|---|
| 21 | Use firebug's NET tab to see the result return from the checkstyle.php call. If it's a |
|---|
| 22 | permission denied error, probably your webserver is running as a different user and |
|---|
| 23 | can't write into your workspace. I solved this problem by doing: |
|---|
| 24 | |
|---|
| 25 | $ find . -type d -exec chmod 777 {} \; |
|---|
| 26 | |
|---|
| 27 | from the root of my project. Probably there's a better way. |
|---|
Note: See
TracBrowser
for help on using the repository browser.
