LDT/User Area/Execution Environment file format

Execution Environment

An Execution Environment, which may also be referred to as EE, is file containing information about the environment where a Lua application could run.

Concept

The idea is to provide a file capable to describe a part of the environment of a Lua application. That is why a Lua application can benefit from several EE. All information provided allows LDT to offer better code completion, code navigation and documentation layout in IDE.

Execution Environment file

You can create your own custom EE, there are just a few rules to follow the type of the file and its inner structure.

File format

An EE is simply a regular .zip file.

File structure

To be a valid EE, a ZIP file root must respect the following tree structure.

• /
  • *.zip
  • *.rockspeck

*.rockspeck enable to specify information about an EE, it follows the Rockspeck format. So far, only source.file field has been added to match LDT needs. *.zip is a regular ZIP archive containing Lua source files documented with the right format. You have to indicates its path relative to the root of the archive in source.file. To be valid an Execution Environment need the following fields:

• package
• version
• source.file

A sample of EE manifest

package = "lua"
version = "5.1"
flags = { sdk = true }
description = {
    summary = "Lua 5.1 Execution Environment"
    detailed =  Lua 5.1 Execution Environment 
    licence = "MIT"
    homepage= "http://www.lua.org/manual/5.1/manual.html"
    documentationdir = "docs"
}
source = {
    file = "api.zip"
}