NAME

veda-edit - Edit code with a powerful IDE

SYNOPSIS

veda edit [--workarea path] [--port port] [--gui]

DESCRIPTION

Runs the Veda Edit application server on your project files.

The application can then be used by visiting the allocated HTTP URL (recent version of Chrome or Firefox recommended).

Veda Edit understands many different languages, and has particularly advanced support for Cadence SKILL/SKILL++, including:

• Identifier Completion;

• Jump to Definition;

• Function Parameter Hinting;

• Completion of Structure And Class Members;

• Method Completion;

• Documentation Browsing.

You can try these features by opening the provided demo.il and following the instructions (cf. EXAMPLES).

OPTIONS

--workarea path

Use a specific path as the root of the editor's workarea.

Default: root of the current workarea, or current directory if the former cannot be determined. Cf. veda help new-workarea for more information about Veda's concept of workareas.

--port port

The port number to bind the HTTP server to. (Default: random).

--gui

Display the application server's control panel, which allows GUI-based configuration of editing options.

CONFIGURATION

Veda Edit's code intelligence features can be configured via the file .veda/edit-si-options.json in the workarea (cf. WORKAREA FORMAT in veda help new-workarea for details).

Note: veda new-workarea automatically installs an example configuration file. As the JSON file format does not support comments, the help text is embedded in strings; Edit ignores keys which start with a capital letter.

The following properties are supported:

max-file-count

Limits the total number of files that can be processed for code intelligence of standalone, non-package files (proper dependencies are used for package files). Defaults to 25.

max-file-size

Files larger than this number of bytes will not be parsed. Defaults to 512 KiB.

defs

A list of static API definitions files (in *.il-defs or *.fnd format) to load when initializing the code intelligence engine.

These paths are relative and must point inside the workarea (escapes such as "../foo" or "/foo" are invalid). You can, however, copy or symlink the definitions from .veda/; e.g.:

$ cd $WORKAREA/.veda
.veda$ ls -l *.fnd
lrwxrwxrwx 1 dash dash  42 Mai 31 12:45 sklangref.fnd -> ...
.veda$ grep fnd edit-si-options.json
        ".veda/sklangref.fnd",

exclude-builtin-defs

If true, the static API definitions bundled with Edit will not be used for documentation. This is only useful if you reference an equivalent set of definitions, such as the Cadence-provided sklangref.fnd, from the "defs" property.

EXAMPLES

Running with the default options:

$ veda edit
Veda Edit 0.7.0 ready.
    Browse to: http://localhost:59739/www/

Running on a specific port:

$ veda edit --port 12345
Veda Edit 0.7.0 ready.
    Browse to: http://localhost:12345/www/

An example configuration file, with notes:

$ cat $WORKAREA/.veda/edit-si-options.json
{
    "NOTE-defs": [
        "Always load my-big-package.",
        "No sources for a-context.cxt; use static definitions.",
        "Include DFII stuff."
    ],
    "defs": [
        "pkg/my-big-package/my-big-package.il-defs",
        ".veda/a-context.il-defs",
        ".veda/skdfref.fnd"
    ]
}

Trying the demo:

1. Copy the share/veda/0.7.0/demo/ subdirectory of your Veda installation to a writable location;

2. Run:

   `veda edit --port 12345 --workarea /path/to/copied/demo/`

3. Browse to http://localhost:12345/www/;

4. Open demo.il.

SEE ALSO

Crosstwine Veda on the Web