Development
This page will give you a short overview about the project and how it is built.
This content is currently outdated
Log4js is currently one JavaScript file (in release). In the sources it is splitted into several files wich can be modified by any editor.
All the environment around will support us in having stable processes in
- verify sources using jsLint
- run unit tests to have stable versions using JSUnit
- regenerate API documetnations from sources using JSDoc
- generate the fully website for publishing
- generate the archives for releases
To build the JavaScript library we use npm and grunt.
cd log4js
npm install
grunt build
Include then include the target/log4js.min.js file in your project.
Coming from Java development, the Apache Ant is used building the project. Ant supports several targets which can be invoked.
To use Ant it is first required to have installed JavaTM first. After that, you can download Ant from the download section of the project pages. Please follow the given installation instructions there.
| Task | Description |
|---|---|
| clean | Cleans the project from generated files. |
| dist | distributes and compiles to target directory /build. |
| doc | Create the JSDoc files to the directory /build/doc/api. |
| release | Creates release archives. |
| site | Generates the web site using Apache Forrest. |
| download-dependencies | tries to download all required libraries, like JSDoc, JSLint and extract them to the /toolsdirectory. |
There are only some coding guidelines:
- Use tabs for intentions to save characters.
- Use descreptive names
- appropriate JSDoc is required
- jsLint should not raise errors
- in future all should be unit tested
Every contribution is welcome! There are several ways. Create for example an pull request or provide bugfix to the project.