Difference between revisions of "Globalyzer Lite"

From Lingoport Wiki
Jump to: navigation, search
(Project Definition Format)
(Project Definition Format)
Line 73: Line 73:
 
<ruleset-name></ruleset-name>
 
<ruleset-name></ruleset-name>
 
<ruleset-owner></ruleset-owner>
 
<ruleset-owner></ruleset-owner>
&lt;!-- optional -->
+
&lt;!-- optional: specify files/directories to scan -->
 
<scan-items>
 
<scan-items>
 
<item></item>
 
<item></item>

Revision as of 19:26, 18 August 2015

Globalyzer Lite is a lightweight version of the Globalyzer Client. It is smaller and faster to install than the Globalyzer Workbench and CLI and requires no database. It is ideal for creating temporary projects and scans on the fly, executing those scans, and generating corresponding reports.

Globalyzer Lite calls the Globalyzer API, but uses an in-memory, temporary database, rather than a physical one. This improves performance and allows multiple Globalyzer Lite programs to be running at the same time. In addition, Globalyzer Lite parses and executes Globalyzer projects that are defined in Globalyzer Project Definition XML files, bypassing the need to create projects and scans using the Globalyzer Workbench, or by writing your own Java program that calls the Globalyzer API.

Globalyzer Lite is useful for scripts and automation routines, as well as continuous integration systems.

Getting Started

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

Globalyzer Lite uses a Project Definition file which is an XML file with all the information for creating and scanning a project.

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

Globalyzer Lite uses the same rule sets that have been created for Globalyzer so that the reports created in either are identical.

Using Globalyzer Lite

Before using Lite i18n teams must have created and refined Globalyzer rule sets to scan for internationalization issues. An i18n knowledgeable developer (or small i18n team) must have also filled in a Project Definition XML file (see below).

Once a Project Definition XML file has been built, it can be executed from a build using 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.

Project Definition Format

  <?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>
       <proxy-user></proxy-user>
       <proxy-password></proxy-password>
       <proxy-host></proxy-host>
       <proxy-port></proxy-port>
    </login>
    <project-path></project-path>
    <project-name></project-name>
    <report-path></report-path>
    <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>