AddCustomCodeEverywhere module for DOLIBARR ERP & CRM

It's sometimes difficult to work on Dolibarr codebase, this module allow you to add EASILY custom code in Dolibarr front-end. The assumed spirit is :

No pain to develop, no pain to deploy, no pain to maintain.

• Work on any Dolibarr version
• Support multi-company module
• Problem solving oriented
• Translate in English and French

Disclaimer

This module is not an insult to the development team who are doing incredible work. It's just a tool to simplify small modifications, allow tinkering or allow deployment of temporary problem resolution.

Use cases

• Improve UX : add custom JS Code to make life easier, JQuery is your new best friend man
• Beautify design : add custom CSS Code to make users' eyes bleed less
• Hot fix bug in production : don't need to wait for a new release, just add a custom JS code to fix it or find a workaround
• Dolibarr Hook give you nightmare : AddCustomCodeEverywhere can avoid you to use hook most of the time
• Avoid version mess : Tired to maintain a fork of Dolibarr for your custom need ? Just use AddCustomCodeEverywhere
   

Concrete use cases

• Hide any unwanted element to reduce interface complexity
• Add html element to inform user on specific location
• Reorder element
• Enhance existing html element  
• Improve CSS on specific location
• Form Field entry automation with business rule
• Add JS function to sort or search in table 
• Hot fix in production 

Features

This module allow you to add as many custom JS code or CSS code you want in different places of Dolibarr without creating custom version of Dolibarr. You can work in a conformable way with :

• code syntax highlighting
• code completion (CTRL+SPACE)
• code linting
• code folding
• code search and replace (CTRL+F / CTRL+H)

You can choose specific scope for each code :

• everywhere
• include in specific pages
• exclude on specific pages

Filtering is done on page path. When using multiple URL, don't forget to separate them with a comma. Regex will be supported in the future.

Keep information in CustomCode description to remember what you did and why you did it.

CustomCode can be activated or set to draft, duplicated, deleted like any Dolibarr object.

CustomCode is only accessible to admin user.

Translations

Translations can be completed manually by editing files in the module directories under langs.

Installation

From the ZIP file and GUI interface

If the module is a ready-to-deploy zip file, so with a name module_xxx-version.zip (e.g., when downloading it from a marketplace like Dolistore), go to menu Home> Setup> Modules> Deploy external module and upload the zip file.

From a GIT repository

Clone the repository in $dolibarr_main_document_root_alt/addcustomcodeeverywhere

cd ....../custom
git clone git@github.com:gitlogin/addcustomcodeeverywhere.git addcustomcodeeverywhere

Final steps

Using your browser:

• Log into Dolibarr as a administrator
• Go to "Setup"> "Modules"
• You should now be able to find and enable the module

Usages

• Go to the config page of the module from your module list
• Or go to YOUR_DOLI_URL/custom/addcustomcodeeverywhere/admin/setup.php
• WARNING : If your js code is not correct (like syntax error), it can break all the other CustomCode, so be careful and test your code before activating it.

Roadmap

• Add regex support for URL filtering
• Fine graining filtering with user permission, user right, entity, ...
• Add device filtering (desktop, mobile, tablet)
• IDE feeling on JS and CSS editor
• Support SCSS

Licenses

Main code

GPLv3 or (at your option) any later version. See file COPYING for more information.

Documentation

All texts and readme's are licensed under GFDL.

Contributors

• Tetras Libre SARL, https://tetras-libre.fr/
• contact@tetras-libre.fr