Setting up Sublime2: Difference between revisions
Juan Leyva (talk | contribs) |
Juan Leyva (talk | contribs) |
||
Line 50: | Line 50: | ||
I recommend to enable only the Linter and the PHP Coding Standard Fixer. Mess Detector and Scheck may help a lot but they not fit well with some Moodle coding rules. | I recommend to enable only the Linter and the PHP Coding Standard Fixer. Mess Detector and Scheck may help a lot but they not fit well with some Moodle coding rules. | ||
The PHP Coding Standard Fixer check the code using the PEAR standard, for installing the Moodle standard you | The PHP Coding Standard Fixer check the code using the PEAR standard, for installing the Moodle standard you can | ||
1 Install the Pear package for PHP CS, pear install PHP_CodeSniffer-2.9.1 (version 3 seems to not be still compatible with the moodle-local_codechecker plugin) | '''Install using pear installer''' | ||
1 Install the Pear package for PHP CS, pear install PHP_CodeSniffer-2.9.1 (version 3 seems to not be still compatible with the moodle-local_codechecker plugin). | |||
2 Download the standard: phpcompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker | 2 Download the standard: phpcompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker | ||
Line 78: | Line 80: | ||
You can put the previous directories in a different directory and change the --standard value to point to that directory | You can put the previous directories in a different directory and change the --standard value to point to that directory | ||
'''Manually install (to avoid dependencies issues)''' | |||
1 Download the phpcs.phar bundle from the author web page: https://github.com/squizlabs/PHP_CodeSniffer/releases/download/2.9.1/phpcs.phar (remember to chmod +x the phpcs.phar file) | |||
2 Clone the https://github.com/moodlehq/moodle-local_codechecker repo into a local directory | |||
3 Edit the settings for the PHP CodeSniffer package, change this: | |||
"phpcs_executable_path": "/path/to/phpcs.phar", | |||
"phpcs_additional_args": { | |||
"--standard": "/path/to/moodle-local_codechecker/moodle", | |||
"-n": "" | |||
}, | |||
=== DockBlockr === | === DockBlockr === |
Revision as of 17:05, 12 December 2019
According Wikipedia Sublime Text is a cross-platform text and source code editor, with a Python API. The chrome was inspired by Vim. Its functionality is also extendable with sublime-packages; Sublime Text is not open source software nor free software, but some of the extending packages have free-software licenses and are community-built and maintained.
Sublime Settings
For Moodle Development:
Preferences -> Settings (default or user)
Tab size and spaces:
"tab_size": 4, // Set to true to insert spaces when tab is pressed "translate_tabs_to_spaces": true, "rulers": [ 132 ],
Sublime plugins for PHP and Moodle Development
For installing new plugins in Sublime2, the best way is to use the Sublime Package Control, see installation instructions
SublimeMoodle
- Auto completion for functions, classes and constants.
- Helper to write testing instructions (Command palette > Moodle: Write testing instructions)
- Open a tracker issue based on user input (Command palette > Moodle: Open a tracker issue)
- Open a tracker issue based on text selection or current branch (Command palette > Moodle: Resolve and open tracker issue)
You need to install it manually or add a new Package Control repository
https://github.com/FMCorz/SublimeMoodle
Trailing Spaces
A Sublime Text 2 and 3 plugin that allows you to highlight trailing spaces and delete them in a flash!
https://github.com/SublimeText/TrailingSpaces
Sublime PHP CS
PHP CodeSniffer, PHP Coding Standard Fixer, Linter, Mess Detector and Facebook Scheck Support for Sublime Text
I recommend to enable only the Linter and the PHP Coding Standard Fixer. Mess Detector and Scheck may help a lot but they not fit well with some Moodle coding rules.
The PHP Coding Standard Fixer check the code using the PEAR standard, for installing the Moodle standard you can
Install using pear installer
1 Install the Pear package for PHP CS, pear install PHP_CodeSniffer-2.9.1 (version 3 seems to not be still compatible with the moodle-local_codechecker plugin).
2 Download the standard: phpcompatibility and moodle directories from https://github.com/moodlehq/moodle-local_codechecker
3 Copy the previous directories to the PHP CS standard path,
- in Mac with Macports is /opt/local/lib/php/PHP/CodeSniffer/Standards/
- In Mac with Homebrew is /usr/local/share/pear\@7.0/PHP/CodeSniffer/Standards/
- in Linux is /usr/share/php/PHP/CodeSniffer/Standards/
4 Edit the settings for the PHP CodeSniffer package, change this:
"phpcs_additional_args": { "--standard": "moodle", "-n": "" },
You can delete the -n option if you want to see also Warnings
// This display warnings also. "phpcs_additional_args": { "--standard": "moodle" },
You can put the previous directories in a different directory and change the --standard value to point to that directory
Manually install (to avoid dependencies issues)
1 Download the phpcs.phar bundle from the author web page: https://github.com/squizlabs/PHP_CodeSniffer/releases/download/2.9.1/phpcs.phar (remember to chmod +x the phpcs.phar file)
2 Clone the https://github.com/moodlehq/moodle-local_codechecker repo into a local directory
3 Edit the settings for the PHP CodeSniffer package, change this:
"phpcs_executable_path": "/path/to/phpcs.phar", "phpcs_additional_args": { "--standard": "/path/to/moodle-local_codechecker/moodle", "-n": "" },
DockBlockr
Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++
Just type /** and tab ... It will preload the fool dock skel (tab between vars for quick editing)
https://github.com/spadgos/sublime-jsdocs
Sidebar Enhancements
Enhancements to Sublime Text sidebar. Files and folders.
https://github.com/titoBouzout/SideBarEnhancements
Bracket Highlighter
Bracket and tag highlighter for Sublime Text 2
https://github.com/facelessuser/BracketHighlighter
Sublime CodeIntel
Full-featured code intelligence and smart autocomplete engine
Avoid to index XML files (it will crash with Moodle), Shift + Click for jumping to function definitions
I recomend you to index only the Moodle lib/ folder (include the folder in your project in order to allo CodeIntel to index it)