Skip to content
This repository has been archived by the owner on Jul 1, 2021. It is now read-only.

imports

Marcel Kloubert edited this page Nov 1, 2017 · 13 revisions

Home >> Settings >> Imports

Imports

Defines one or more setting files to import.

{
    "deploy": {
        "imports": [
            "${homeDir}/mySettings.json",

            {
                "from": "\\\\MyCompany\\MyProject\\teamSettngs.json",
                "description": "Settings from a shared folder"
            }
        ]
    }
}

A child MUST NOT start with the deploy property, you must define the sub-settings in the root:

{
    "packages": [
        {
            "name": "Version 2.3.5 (anything)",
            "description": "Package version 2.3.5"
        }
    ],

    "targets": [
        {
            "type": "sftp",
            "name": "My SFTP folder",
            "description": "A SFTP folder"
        }
    ]
}

You are also able to define imports in the children.

Name Description
description A description for the entry.
from* The source (file) with the settings to import. If you choose a relative path, you must keep in mind that (in that case) the path is relative to your settings.json file and NOT to the workspace!
if One or more conditions (as JavaScript code) that defines if entry is available or not, similar to values.
isFor A list of one or more (host)names that entry is for.
merge Merge with parent settings or not. Default: (true)
platforms One or more platform names the entry is for. s. process.platform
sortOrder An optional number or object to sort the elements. If this value is an object, it is searched for a property that contains the name of the current machine, by using its value as sort value. Default: 0

* supports placeholders

Clone this wiki locally