Outils de développement

Retour index
Documentation développeur

Tout environnement de développement peut être utilisé. Toutefois voici une liste d'outils fortement recommandés pour leur complétude, leur qualité et la productivité du développement qu'ils apportent. Ils sont utilisés par la plupart des développeurs principaux de Dolibarr. Notons que toutes ces solutions sont gratuites et OpenSource.

Pour tout développeur

Voici le socle de travail recommandé, toutefois tout outil respectant les standards Web, PHP, Mysql peuvent faire l'affaire.

Un serveur AMP

• Apache, MariaDB et PHP

Sur Linux: Ces 3 produits sont disponibles dans toutes distributions.

Sur Windows: Installez [1] (base MariaDB, Apache et PHP tout clé en main). Ce serveur WAMP offre le trio MariaDB + Apache + PHP, avec possibilité de basculer de version pour n'importe lequel de ces composants d'un simple clic).

Chrome ou Firefox et plugins

• Chrome + plugins de votre choix

A télécharger depuis le site http://www.chrome.com

• Firefox + plugins de votre choix

A télécharger depuis le site http://www.firefox.com

Un outil d'accès aux bases de données

Exemple:

• SquirrelSQL pour l'administration de base - A télécharger depuis le site http://squirrel-sql.sf.net
• DBeaver - https://dbeaver.io/

IDE (Eclipse, VSCode) et plugins

Eclipse

Installation d'Eclipse

Nous recommandons la version suivante d'Eclipse:

https://eclipse.org/pdt/

Sinon toute version disponible sur le site Eclipse fait l'affaire.

Une fois Eclipse installé, il est recommandé de modifier/vérifier les paramètres suivants:

• Window - Preferences - General - Workspace - Text file encoding -> UTF8
• Window - Preferences - General - Workspace - New text file line delimiter -> Unix
• Window - Preferences - General - Compare/Patch - Ignore white spaces -> Yes
• Window - Preferences - General - Editor - Text editors - Tab delimiter length -> 4
• Window - Preferences - General - Editor - Text editors - Insert spaces for tab -> No
• Window - Preferences - General - Editor - File Association -> Add *.lang associated to "Text Editor"
• Note: You can also disable Windows - Preferences - Java - Editor - Content Assist - Auto Activation

And if PDT is installed (see later):

• Window - Preferences - PHP - Code Style - Formatter - Tab policy -> Tab
• Window - Preferences - PHP - Code Style - Formatter - Default indentation for wrapped line -> 1
• Window - Preferences - PHP - Code Style - Formatter - Default indentation for array initializer -> 0
• Window - Preferences - PHP - Editor - Typing - Uncheck "When Pasting Adjust Indentation" (keeping this option checked create corruption of text files by adding bad end of line characters)
• Window - Preferences - PHP - Code Style - Formatter - Use the profile provided into dev/setup/eclipse/PSR-12 [built-in].xml as Eclipse syntax formatter.
• Note: You can also disable Windows - Preferences - PHP - Editor - Content Assist - Auto Activation

Installation du plugin Eclipse pour PHP: PDT.

Avec certaines installations d'Eclipse, PDT peut etre installé depuis Help -> Install new software et choisir PDT. Si PDT n'est pas présent, si vous avez installé la version Eclipse ci-dessus, il suffit d'utiliser la procédure Help -> Install new software -> Add -> pour installer le package complémentaire:

https://download.eclipse.org/releases/xxx - xxx = version

Or from the GUI of any Eclipse =>Install New Software =>Work With Kepler => Wait until list display =>General Purpose Tools Check PHP development tools (PDT)=>Install

Une fois PDT installé, il faut aussi le configurer dans Eclipse comme défini dans le chapitre Outils_de_développement_-_Composants_optionnels#Depuis_Eclipse.

Configurer Eclipse pour récupérer les sources

Une fois qu'Eclipse est installé, vous pouvez vous connecter au repository GIT pour y récupérer les dernières versions de développement.

Pour cela, voir la page FAQ Récupérer, mettre à jours les sources GIT du projet.

Codium

Codium est la version Libre de VSCode, la documentation suivante s'appliquera donc probablement à vscode.

Modules complémentaires

Voici la liste des modules complémentaire conseillés:

• PHP Intelephense
• phpdoc-comment
• PHPUnit
• PHP CS Fixer
• EditorConfig for VSCode pour que la configuration du projet définie dans le fichier .editorconfig soit utilisée automatiquement
• Git Graph
• PHP Debug pour utiliser XDebug directement dans Codium

Stubs ou extraits de codes

Si vous développez des modules complémentaires pour dolibarr vous apprécierez d'avoir les définitions des fonctions et autres objets de dolibarr sans avoir à sourcer l'arborescence complète de dolibarr...

Tout ceci se passe par la récupération des stubs depuis https://packagist.org/packages/caprel/dolibarr-stubs-all.

Une fois le stub téléchargé / ou installé en suivant la doc pensez à ajouter le fichier dolibarr-stubs dans la liste des stubs de votre codium, éditez le fichier ~/.config/VSCodium/User/settings.json

"intelephense.stubs": [
 "apache",
 "intl",
 "standard",
 "/media/erics/stockage/tmp/dolibarr/stubs",
],
"intelephense.environment.includePaths": [
 "/media/erics/stockage/tmp/dolibarr/stubs",
],

Git Hooks

Installer le hook git Pre-commit

Vous pouvez utiliser des hooks git pour vérifier la syntaxe du fichier que vous validez et annuler (ou mieux corriger automatiquement) la validation si quelque chose ne va pas.

Les instructions pour installer un tel hook de pré-validation sont disponibles sur ce fichier :

https://github.com/Dolibarr/dolibarr/tree/develop/dev/setup/pre-commit

De tels hooks fonctionneront lors d'une utilisation en ligne de commande, mais peuvent également fonctionner lors d'une validation à l'aide de votre IDE commun (il a été validé avec Eclipse et VSC).

Une fois installé, le hook démarrera lors de votre prochain commit pour reformater votre code, afin que votre code corresponde toujours aux règles de syntaxe de codage. Si tout le monde active ce hook, tout le monde utilisera la même règle de syntaxe de codage, il est donc fortement recommandé de l'activer si vous le pouvez. Si quelque chose ne va pas dans la syntaxe, la validation sera immédiatement annulée. S'il peut être corrigé automatiquement, phpcbf, installé lors de l'installation du hook de pré-validation, le corrigera donc il vous suffira de réessayer le commit une seconde fois pour le valider.

ATTENTION : SUR MACOS, UN COMMIT INCLUANT DES FICHIERS DE LANGUE EMPÊCHERA LE FONCTIONNEMENT DE PRE-COMMIT

Optionnel

Vous pouvez aussi installer des composants optionnels pour avoir le support de technologies suplémentaires. Voir la page Outils de développement - Composants optionnels.