Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:recommended_tools
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
development:recommended_tools [2015/12/11 18:45] – ↷ Page moved from vufind2:recommended_tools to development:recommended_tools demiankatz | development:recommended_tools [2021/04/13 05:50] – [Tests] emaijala | ||
---|---|---|---|
Line 7: | Line 7: | ||
Some developers prefer to use a simple text editor to quickly and easily edit individual files. Others prefer a full-fledged IDE (Integrated Development Environment) which imposes a "whole project" | Some developers prefer to use a simple text editor to quickly and easily edit individual files. Others prefer a full-fledged IDE (Integrated Development Environment) which imposes a "whole project" | ||
- | At Villanova, Demian uses the [[https://netbeans.org/|Netbeans IDE]] for most of his work, while Chris uses the [[https:// | + | At Villanova, Demian uses the free, open source |
===== Version Control ===== | ===== Version Control ===== | ||
- | It is strongly recommended that you use some sort of version control software to keep track of revisions while programming. This provides a valuable safety net for reverting bad changes, remembering why particular adjustments were made, etc. In the case of [[Git]], the tool used by VuFind, it also offers powerful collaboration and sharing capabilities. Whether you plan to work locally or share with the local community, [[Git]] is a tool worth learning more about, as is the [[http:// | + | It is strongly recommended that you use some sort of version control software to keep track of revisions while programming. This provides a valuable safety net for reverting bad changes, remembering why particular adjustments were made, etc. In the case of [[development: |
+ | ===== Dependency Management ===== | ||
+ | |||
+ | VuFind loads its external dependencies using [[development: | ||
+ | |||
+ | ===== Grunt ===== | ||
+ | |||
+ | VuFind, as of version 3.1, ships with a Gruntfile to help manage front end tasks like compiling less/scss, compressing js, and checking coding standards. [[development: | ||
===== Meeting Project Standards ===== | ===== Meeting Project Standards ===== | ||
Line 20: | Line 27: | ||
The [[development: | The [[development: | ||
+ | |||
+ | To quickly check the tests that are run e.g. when a pull request is submitted, try the following command: | ||
+ | |||
+ | < | ||
+ | vendor/ | ||
+ | </ | ||
==== Style ==== | ==== Style ==== | ||
- | For style compliance, | + | For style compliance, |
- | To test style compliance with PHP_CodeSniffer, | + | To test style compliance with PHP_CodeSniffer |
< | < | ||
- | phpcs --standard=PEAR [file] | + | vendor/bin/phpcs --standard=PEAR [file] |
</ | </ | ||
- | To automatically fix certain PHP_CodeSniffer issues, you can run: | + | Or, through [[https:// |
< | < | ||
- | phpcbf | + | vendor/ |
</ | </ | ||
- | To automatically fix additional | + | To automatically fix certain PHP_CodeSniffer |
< | < | ||
- | phing php-cs-fixer | + | vendor/bin/phing phpcbf |
</ | </ | ||
- | (Note that this assumes that the php-cs-fixer | + | To automatically fix additional issues with php-cs-fixer, from the base of your VuFind directory, run: |
+ | |||
+ | < | ||
+ | vendor/ | ||
+ | </ | ||
If you are unwilling or unable to run these tools locally, note that if you open a pull request against the [[https:// | If you are unwilling or unable to run these tools locally, note that if you open a pull request against the [[https:// |
development/recommended_tools.txt · Last modified: 2023/10/20 12:02 by demiankatz