Repository Access Links:

This URL has Read-Only access.
Statistics
| Branch: | Revision:

dolibarr-module-template / composer-comments.md @ ef37f43f

History | View | Annotate | Download (2.9 kB)

1
# composer.json comments
2
Since the JSON format don't allow embedding comments, this file holds them.
3
They are structure just like the composer.json tree.
4

    
5
You can find more informations about Composer at https://getcomposer.org/.  
6
The structure of this file is documented at https://getcomposer.org/doc/04-schema.md. 
7

    
8
## config
9
### process-timeout
10
Set to 3600 seconds because checking PHPCompatibility can take quite some time!
11

    
12
### bin-dir
13
Since our vendor directory is part of the repository and we
14
don't want binaries distributed, we moved them to a developer's
15
directory that is not part of the distribution.
16

    
17
## require
18
### composer/installers
19
This enables to automatically install this module in Dolibarr's ```htdocs/custom``` directory by requiring it in Dolibarr's ```composer.json```.
20

    
21
### [parsedown](http://parsedown.org/)
22
Used to render the Markdown readme in the module's about page.
23

    
24
## require-dev
25
### [php-parallel-lint](https://github.com/JakubOnderka/PHP-Parallel-Lint)
26
PHP code linter used to check syntax correctness.
27

    
28
### php-console-highlighter
29
Optional dependency for php-parallel-lint enabling console highlighting.
30

    
31
### [phpunit](https://phpunit.de/)
32
Unit testing framework.
33

    
34
### [php_codesniffer](https://github.com/squizlabs/PHP_CodeSniffer)
35
Used to check our coding style.
36

    
37
### phpunit-selenium
38
PHPUnit runner for Selenium functional testing.
39

    
40
### [php-compatibility](https://github.com/squizlabs/PHP_CodeSniffer)
41
PHP Codesniffer Coding Standard to check our code's compatibility with various PHP versions.
42

    
43
## scripts
44
You can run these using ```composer [command]```.
45
Since these are run from within composer, they use the binaries from bin-dir,
46
not the host ones, making the process more reliable.
47

    
48
## check
49
A shortcut to run all the checks at once.
50

    
51
### compat_workaround
52
This is a workaround https://github.com/wimg/PHPCompatibility/issues/102
53

    
54
### check_compat
55
If TRAVIS_PHP_VERSION is set, we use it. This way we only check the Travis' matrix
56
PHP version when running this on Travis. Else we set it to all supported PHP versions
57
(5.3 to 7.0).
58

    
59
### check_style
60
We use a custom PSR2 ruleset allowing tab indents.
61

    
62
### test
63
Run PHPunit and Selenium tests.
64

    
65
### test_unit
66
Run PHPunit tests.
67

    
68
### test_functional
69
Run Selenium tests.
70

    
71
### doc
72
Build project documentation.
73

    
74
### doc_dev
75
Builds Doxygen and PHPdoc.  
76
Modify to select your favorite.
77

    
78
### doc_dev_doxygen
79
Build Doxygen developer documentation.  
80
Requires [Doxygen](http://www.doxygen.org/).
81

    
82
### doc_dev_phpdoc
83

    
84
### TODO: doc_user
85
Build Sphinx user documentation.
86

    
87
### release
88
Release a module.
89
Run all checks and tests, remove dev dependencies, builds a zip ready to be published and restores dev dependencies.
90

    
91
### build
92
Builds a module ZIP.  
93
Requires Perl.
94

    
95
### tx*
96
Manages Transifex.  
97
Requires the [transifex client](http://docs.transifex.com/client/).
98

    
99
### git_hooks_*
100
Installs or remove the [provided](dev/git-hooks) GIT hooks.
101

    
102
### git*
103
Provided GIT hooks callbacks.