Javascript

New code must be written in typescript.

Typescript code should always go in “scripts” folders.

  • For the core, it should go in “src/www/scripts/”

  • For plugins, it should go in “plugins/<my-plugin>/scripts/”

Build the typescript files

From the root directory of the Tuleap sources (you must have npm installed):

$ npm install
$ npm run build

This command will install the tools needed, transpile the javascript to make it compatible with Internet Explorer 11 and minify (compress) it.

Important

  • you have to run npm run build each time you edit a Javascript file.

  • Built javascript files go to the “assets” folder. You should never modify files in “assets” folders as they are removed when you rebuild.

While you are working, in the appropriate “scripts” folder, run the following command:

$ npm run watch

Important

  • npm run watch will automatically rebuild Javascript after changes. It will also run the unit tests.

  • npm test will run the unit tests once. It is used by the Continuous integration to validate changes.

  • npm test -- --coverage will run the unit tests and generate a coverage report.

Where can I run npm commands ?

Tuleap has a long history and the more functionalities are added, the more javascript is added. Nowadays, it can get hard to know where to run npm run watch in all those plugins. The safest way to know is to find package.json files. Here’s a bash command to let you do that:

$ find . -type f -name 'package.json' -print -o -path '*/node_modules' -prune

This command returns all the folders containing a package.json file. You can run npm commands in them. Remember that not all npm scripts will be implemented, some of these folder may only have a “build” script.

Best-practices for Tuleap

When you submit a patch for review, we may request changes to better match the following best practices. Please try to follow them.

  • Always write new code in typescript.

  • Always use a Javascript file. No manual <script> tags.

  • Always name javascript files with dash-case.

  • Whenever you need to run code when the page is loaded, do it like this:

    /** index.js */
document.addEventListener("DOMContentLoaded", () => {
    // Your initialization code
});

  • Always manipulate the DOM in only one place. For example when using Vue, do not change datasets or class names in .vue files. Do it in “index.js”

  • Leverage ES6 and later versions! We have setup Babel to let you use the full power of ES6 and beyond AND still have code compatible with the older browsers.

  • In Burning Parrot pages, you can rely on the DOM4 APIs as we already include a polyfill.

  • Always make sure the Browser APIs you are using (for example DOM, Location, CustomEvent, etc.) work on our list of supported browsers. To do that you can check with the Can I use website.

Resources