Globalyzer Lite

Globalyzer Lite scans source code for internationalization issues. It is well suited for use within automation routines and Continuous Integration (CI) systems. Additionally, it is designed to be used as an external tool from within Integrated Development Environments (IDEs) such as Visual Studio, IntelliJ IDEA, and Eclipse.

Globalyzer Lite generates scan reports to a directory specified via command line arguments / a project definition file. Scan reports are available in a variety of formats.

Globalyzer Lite is a product that requires special licensing. It is delivered in a zip file.

Using Globalyzer Lite from an Integrated Development Environment

Lite may be used within many IDEs that support external tools, including Visual Studio, IntelliJ IDEA, and Eclipse. Configuring Lite as an external tool takes some initial setup, but is relatively easy to accomplish. Once configured, Lite may be used through the IDE's external tool menu, with the click of a button. The recommended, documented tools:

1. Scan the currently selected file/directory.
2. Scan everything within the parent directory of the currently selected file/directory.
3. Scan the entire project.

Demonstration videos are available for:

• Visual Studio
• IntelliJ IDEA
• Eclipse

The developer can then use the power of the IDE to refactor the relevant issues or to mark false positives in the code using Globalyzer ignore comments, such as NON-NLS-L. For more information, see the Globalyzer Comment Tags in False Positives .

Those refactoring and the comment tags are now part of the code: The Continuous Globalization System using the same Lite project definition file will show the same results in the Dashboard.

Using Globalyzer Lite in a Continuous Globalization System

Globalyzer Lite is easy to integrate into Continuous Integration (CI) systems. For instance, using Lite from Jenkins can be done through the following steps:

1. Check in a project definition file into source control (or, if you prefer, place one in the Jenkins server's filesystem).
2. Run the following from Jenkins' shell:

   java -jar globalyzer-lite.jar -f "${WORKSPACE}/GlobalyzerProjectDefinitionFile.xml" --project-path "${WORKSPACE}" --report-path "globalyzer-lite-reports"

3. Use the Lingoport Dashboard to display the results from the generated reports.

You may also pass the reports to your own reporting system.

Using Globalyzer Lite from the Command Prompt / Shell

Globalyzer Lite can be executed from a command prompt or shell via the following command:

java -jar globalyzer-lite.jar some_location/YourProjectDefinitionFile.xml

After lite finishes each scan, a relevant Globalyzer report is created at the location specified in the Project Definition's report path.

Lite also allows for altering the following parameters via command line options:

• The Project Path
• The Report Path
• The Files/Directories to scan

Ease of Installation

Installing Lite is easy. To install:

1. Unzip the Globalyzer Lite zip file at a desired location
2. Run either lite-setup.bat or lite-setup.sh depending on your system.

Configuration & Rule Sets

Before use of Globalyzer Lite, rule sets will need to be configured on the Globalyzer Server. Properly configured rule sets better detect i18n issues, and cut down the rate of false positives.

A Project Definition File will then need to be created for the given project. This file may be distributed to multiple users working on the same project.

The project definition file will need to make use of the correct rule sets relevant to the project, and to specify which directories to scan with each rule set. It is recommended that this file be configured by an i18n knowledgeable developer or i18n specialist.

Project Definition Format

Here is the template for a project definition file. For the full instructions to setup a project definition file, see our help page.

  <?xml version="1.0" encoding="UTF-8" standalone="no"?>
  <!-- All items should be allowed anywhere in the xml as long as the hierarchy
    is preserved -->
  <gzproject>
    <login>
       <username></username>
       <password></password>
       <server></server>
       <!-- Optional Parameters -->
       <optional>
           <proxy-user></proxy-user>
           <proxy-password></proxy-password>
           <proxy-host></proxy-host>
           <proxy-port></proxy-port>
       <optional>
    </login>
    <project-path></project-path> <!-- May instead be specified from command line -->
    <project-name></project-name>
    <report-path></report-path>   <!-- May instead be specified from command line -->
    <report-type></report-type>
    <scans>
       <scan>
          <!-- create and execute a single scan with this info -->
          <scan-name></scan-name>
          <ruleset-name></ruleset-name>
          <ruleset-owner></ruleset-owner>
       </scan>
       <scan>
       <!-- create and execute a single scan with this info -->
          <scan-name></scan-name>
          <ruleset-name></ruleset-name>
          <ruleset-owner></ruleset-owner>
          <!-- optional: specify files/directories to scan -->
          <scan-items>
             <item></item>
             <item></item>
          </scan-items>
       </scan>
    </scans>
 </gzproject>

Exit Error Codes

Type
Name	Exit Code
Normal
EXIT_NORMAL	0
XML Issues
NO_PATH_TO_XML_FILE	10
DUPLICATE_PARAMETER_IN_XML	11
XML_PARAMETER_BLANK	12
XML_INVALID_PARAMETER	13
UNABLE_TO_READ_SCHEMA	14
Globalyzer API compatibility
GLOBALYZER_API_REPORT_TYPE_NOT_MATCHED	30
GLOBALYZER_API_EXCEPTION	31
Input issues
IMPROPER_INPUT	51
INVALID_COMMANDS	52
PROJECT_PATH_DOES_NOT_EXIST	53
Output Issues
SCAN_FAILED	60

Language Support

Globalyzer Lite supports the same languages as the full Globalyzer product. It allows users to scan a number of source code in different programming languages:

• ActionScript,
• C#,
• C/C++ (many variations),
• Delphi,
• HTML (in various web files),
• Java,
• JavaScript, (includes AngularJS, NodeJS, and other libraries)
• Objective-C,
• MXML,
• Perl,
• PHP,
• Qt,
• SQL (Oracle, MS SQL, MySQL, PostgreSQL),
• Visual Basic (Classic, .NET),
• VBScript, and
• XML

Lite vs the Globalyzer API

Globalyzer Lite utilizes the Globalyzer API. Using the API directly is more powerful, but also requires writing a custom java application.

Lite vs the Globalyzer Workbench

In comparison to the Globalyzer Workbench, Globalyzer Lite is smaller, faster to install and does not require a database. Lite supports direct integration with IDEs, while the Workbench is its own standalone program. Additionally, unlike the workbench, multiple instances of Lite may be run concurrently. This allows Continuous Integration systems to use Lite to provision the scanning of multiple projects.