Development

This page will give you a short overview about the project and how it is built.

This content is currently outdated

Overview

Log4js is currently one JavaScript file and can be modified by any editor. All the environment arount this file is not nessessarily required to continue development, but will support us in having some 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

Building Project

Core Javascript log4js library

'''' cd log4js npm install grunt build ''''

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 Java^TM first. After that, you can download Ant from the download section of the project pages. Please follow the given installation instructions there.

  <table>
  	<caption>Main Ant Tasks</caption>
  	<tr><th>Task</th><th>Description</th></tr>
  	<tr><td>clean</td><td>Cleans the project from generated files</td></tr>
  	<tr><td>dist</td><td>distributes and compiles to target directory <code>/build</code>.</td></tr>
  	<tr><td>doc</td><td>Create the JSDoc files to the directory <code>/build/doc/api</code>.</td></tr>
  	<tr><td>jsLint</td><td>verifies all JavaScript files.</td></tr>
  	<tr><td>release</td><td>Creates release archives.</td></tr>
  	<tr><td>site</td><td>Generates the web site using Apache Forrest.</td></tr>
  	<tr><td>download-dependencies</td><td>tries to download all required libraries, like JSDoc, JSLint and extract them to the <code>/tools</code>directory.</td></tr>
  </table>

Coding Guide

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

How can I contribute?

Every contribution is welcome! There are several ways. Create for example an pull request or provide bugfix to the project.