bsconfig.schema.json

{
    "title": "JSON schema for bsconfig.json configuration files",
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "dependencies": {
        "deploy": [
            "host",
            "password"
        ]
    },
    "properties": {
        "extends": {
            "description": "Relative or absolute path to another bsconfig.json file that this file should use as a base, and then override",
            "type": "string"
        },
        "cwd": {
            "description": "A path that will be used to override the current working directory",
            "type": "string"
        },
        "rootDir": {
            "description": "The root directory of your Roku project. Defaults to the current working directory (or cwd property)",
            "type": "string"
        },
        "files": {
            "description": "The list of files that should be used in this project. Supports globs. Optionally, you can specify an object with `src` and `dest` properties to move files from one location into a different destination location",
            "default": [
                "manifest",
                "source/**/*.*",
                "components/**/*.*",
                "images/**/*.*"
            ],
            "items": {
                "anyOf": [{
                        "type": "string",
                        "description": "A file path or file glob"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "src": {
                                "anyOf": [{
                                        "type": "string",
                                        "description": "A file path or glob pattern of source file(s)"
                                    },
                                    {
                                        "type": "array",
                                        "description": "An array of file path or globs",
                                        "items": {
                                            "type": "string",
                                            "description": "A file path or glob pattern of source file(s)"
                                        }
                                    }
                                ]
                            },
                            "dest": {
                                "type": "string",
                                "description": "The destination for the file(s) found in 'src'"
                            }
                        },
                        "required": [
                            "src",
                            "dest"
                        ]
                    }
                ]
            }
        },
        "outFile": {
            "description": "The path where the output zip or package should be placed. This includes the filename. Defaults to \"./out/package\"",
            "type": "string"
        },
        "createPackage": {
            "description": "Creates a zip package. Defaults to true. This setting is ignored when deploy is enabled.",
            "type": "boolean"
        },
        "copyToStaging": {
            "description": "If true, the files are copied to staging. This setting is ignored when deploy is enabled or if createPackage is enabled",
            "type": "boolean"
        },
        "watch": {
            "description": "If true, the server will keep running and will watch and recompile on every file change",
            "type": "boolean",
            "default": false
        },
        "deploy": {
            "description": "If true, after a successful buld, the project will be deployed to the roku specified in host",
            "type": "boolean"
        },
        "host": {
            "description": "The host of the Roku that the package will be deploy to",
            "type": "string"
        },
        "username": {
            "description": "The username to use when deploying to a Roku device",
            "type": "string"
        },
        "password": {
            "description": " The password to use when deploying to a Roku device",
            "type": "string"
        },
        "retainStagingFolder": {
            "type": "boolean",
            "description": "Prevent the staging folder from being deleted after the deployment package is created.  This is helpful for troubleshooting why your package isn't being created the way you expected.",
            "default": false
        },
        "stagingFolderPath": {
            "type": "string",
            "description": "The path to the staging folder (where all files are copied before creating the zip package)"
        },
        "ignoreErrorCodes": {
            "description": "A list of error codes the compiler should NOT emit, even if encountered.",
            "type": "array",
            "items": {
                "anyOf": [{
                    "type": "number",
                    "description": "A BrighterScript error code that will be ignored during compile"
                }]
            }
        },
        "emitFullPaths": {
            "description": " Emit full paths to files when printing diagnostics to the console.",
            "type": "boolean",
            "default": false
        }
    }
}