x++ / Documents / Configuration

Table of Contents

Catalog

M

About

The configuration file defines what the project would do on execution. It is always placed in the .xconfig file and should be written as if it is within a *.json file. If one is not found in the project, the default configuration is used internally instead:

{
    "main": "main.xpp"
}

The configuration file can also contain non-essential information, such as the author, version, or description of your project:

{
    "author": "my-name",
    "contributors": [
        "contributor A", "contributor B"
    ],
    "description": "This is my x++ project",
    "main": "main.xpp",
    "name": "my-xpp-project",
    "version": "1.0.0"
}

This is part of the official .xconfig specification. In fact, xpp --show <module> will use this spec.

Documentation

Main

{
    "main": <path>
}

Defines the path of the main entry file.

ParameterTypeDefaultDescription
PathString<JSON>"main.xpp"Entrypoint relative to the current package (or cwd if it's a file)

Last Updated: March 9th, 2024 by iiPython

↑ Go To Top