{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/redhat-developer/vscode-extension-tester/main/packages/extester/resources/extester.schema.json", "title": "ExTester Configuration", "description": "Configuration file for vscode-extension-tester (extester.config.json)", "type": "object", "additionalProperties": false, "properties": { "$schema": { "type": "string", "description": "Path or URL to the JSON Schema for this file." }, "extends": { "description": "Path(s) to base config file(s) to inherit from. Relative paths resolve against this file's directory. Later entries override earlier ones; this file overrides all bases. Objects deep-merge; arrays and scalars are replaced whole.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 1 } ], "examples": ["../../extester.base.json"] }, "setup": { "type": "object", "description": "Setup options: controls VS Code + ChromeDriver download and extension packaging/installation.", "additionalProperties": false, "properties": { "vscodeVersion": { "type": "string", "description": "Version of VS Code to test against. Accepts 'latest', 'min', 'max', or a specific version string (e.g. '1.131.0').", "default": "latest", "examples": ["latest", "min", "max", "1.131.0"] }, "type": { "type": "string", "description": "Type of VS Code release stream.", "enum": ["stable", "insider"], "default": "stable" }, "storage": { "type": "string", "description": "Folder used for all test resources (VS Code binary, ChromeDriver, logs). Defaults to $TEST_RESOURCES or $TMPDIR/test-resources.", "examples": ["./test-resources"] }, "extensionsDir": { "type": "string", "description": "VS Code extensions directory override.", "examples": ["./test-extensions"] }, "packageOptions": { "type": "object", "description": "vsce packaging options forwarded directly to vsce.createVSIX(). Mirrors @vscode/vsce IPackageOptions — any field vsce supports is accepted, even if not listed here.", "properties": { "packagePath": { "type": "string", "description": "Destination path of the packaged .vsix file (vsce: --out). Defaults to -.vsix in the extension directory.", "examples": ["./out/extension.vsix"] }, "version": { "type": "string", "description": "Bump the extension to this version before packaging (equivalent to 'vsce package ').", "examples": ["1.2.3", "patch", "minor", "major"] }, "target": { "type": "string", "description": "Target platform for a platform-specific extension (vsce: --target).", "enum": [ "win32-x64", "win32-arm64", "linux-x64", "linux-arm64", "linux-armhf", "darwin-x64", "darwin-arm64", "alpine-x64", "alpine-arm64", "web" ] }, "ignoreOtherTargetFolders": { "type": "boolean", "description": "Ignore files inside folders named after other targets (vsce: --ignore-other-target-folders). Only valid when 'target' is set.", "default": false }, "followSymlinks": { "type": "boolean", "description": "Recurse into symlinked directories instead of treating them as files (vsce: --follow-symlinks).", "default": false }, "commitMessage": { "type": "string", "description": "Commit message used when calling 'npm version' (vsce: --message). Only applies when 'version' is set." }, "gitTagVersion": { "type": "boolean", "description": "Create a version commit and tag when calling 'npm version'. Set to false for vsce --no-git-tag-version. Only applies when 'version' is set.", "default": true }, "updatePackageJson": { "type": "boolean", "description": "Update package.json when bumping the version. Set to false for vsce --no-update-package-json. Only applies when 'version' is set.", "default": true }, "cwd": { "type": "string", "description": "Directory of the extension to package. Defaults to the current working directory." }, "readmePath": { "type": "string", "description": "Path to the README file shown on the marketplace (vsce: --readme-path). Defaults to README.md.", "examples": ["./docs/README.md"] }, "changelogPath": { "type": "string", "description": "Path to the CHANGELOG file (vsce: --changelog-path). Defaults to CHANGELOG.md.", "examples": ["./docs/CHANGELOG.md"] }, "githubBranch": { "type": "string", "description": "GitHub branch used to infer relative links in README.md (vsce: --githubBranch). Can be overridden by baseContentUrl and baseImagesUrl.", "examples": ["main"] }, "gitlabBranch": { "type": "string", "description": "GitLab branch used to infer relative links in README.md (vsce: --gitlabBranch). Can be overridden by baseContentUrl and baseImagesUrl.", "examples": ["main"] }, "rewriteRelativeLinks": { "type": "boolean", "description": "Rewrite relative links in README.md into absolute URLs. Set to false for vsce --no-rewrite-relative-links.", "default": true }, "baseContentUrl": { "type": "string", "description": "Prepend all relative links in README.md with this URL (vsce: --baseContentUrl)." }, "baseImagesUrl": { "type": "string", "description": "Prepend all relative image links in README.md with this URL (vsce: --baseImagesUrl)." }, "useYarn": { "type": "boolean", "description": "Use yarn instead of npm when packaging (vsce: --yarn / --no-yarn). When not set, vsce infers it from the presence of yarn.lock or .yarnrc." }, "dependencyEntryPoints": { "type": "array", "description": "Select packages that should be included when packaging (vsce: --packagedDependencies).", "items": { "type": "string" } }, "ignoreFile": { "type": "string", "description": "Path to an alternative .vscodeignore file (vsce: --ignoreFile).", "examples": ["./.vscodeignore-test"] }, "gitHubIssueLinking": { "type": "boolean", "description": "Automatically expand GitHub-style issue syntax (#123) into links in README.md. Set to false for vsce --no-gitHubIssueLinking.", "default": true }, "gitLabIssueLinking": { "type": "boolean", "description": "Automatically expand GitLab-style issue syntax into links in README.md. Set to false for vsce --no-gitLabIssueLinking.", "default": true }, "dependencies": { "type": "boolean", "description": "Detect and include npm/yarn dependencies in the package. Set to false for the vsce --no-dependencies flag — typically needed together with useYarn, for yarn/npm workspaces, or when the extension is fully bundled.", "default": true }, "preRelease": { "type": "boolean", "description": "Mark the packaged extension as a pre-release (vsce: --pre-release).", "default": false }, "allowStarActivation": { "type": "boolean", "description": "Allow the use of * in activationEvents (vsce: --allow-star-activation).", "default": false }, "allowMissingRepository": { "type": "boolean", "description": "Skip the check for a repository field in package.json (vsce: --allow-missing-repository).", "default": false }, "allowUnusedFilesPattern": { "type": "boolean", "description": "Allow 'files' patterns in package.json that match no files (vsce: --allow-unused-files-pattern).", "default": false }, "allowPackageSecrets": { "type": "array", "description": "Allow packaging specific kinds of detected secrets (vsce: --allow-package-secrets). Secret names are reported in the packaging error message.", "items": { "type": "string" }, "examples": [["npm"]] }, "allowPackageAllSecrets": { "type": "boolean", "description": "Allow packaging even when secrets are detected (vsce: --allow-package-all-secrets).", "default": false }, "allowPackageEnvFile": { "type": "boolean", "description": "Allow packaging .env files (vsce: --allow-package-env-file).", "default": false }, "skipLicense": { "type": "boolean", "description": "Skip adding a LICENSE file to the package (vsce: --skip-license).", "default": false }, "signTool": { "type": "string", "description": "Path to a VSIX signing tool (vsce: --sign-tool). Invoked with the signature manifest and .p7s file as arguments." } }, "additionalProperties": true }, "settings": { "type": "string", "description": "Path to a custom VS Code settings.json file to apply before setup-phase CLI steps (e.g. proxy settings for marketplace installs).", "examples": ["./vscode-settings.json"] }, "installDependencies": { "type": "boolean", "description": "Automatically install extensions your extension depends on from the marketplace.", "default": false }, "noCache": { "type": "boolean", "description": "Skip using a cached download and fetch a fresh copy.", "default": false } } }, "run": { "type": "object", "description": "Run options: controls test execution inside VS Code.", "additionalProperties": false, "properties": { "testFiles": { "type": "array", "description": "Glob pattern(s) for test files to run. Used as CLI positional arguments when none are provided on the command line.", "items": { "type": "string" }, "examples": [["./out/test/**/*.test.js"]], "minItems": 1 }, "vscodeVersion": { "type": "string", "description": "Version of VS Code to test against. Accepts 'latest', 'min', 'max', or a specific version string (e.g. '1.131.0').", "default": "latest", "examples": ["latest", "min", "max", "1.131.0"] }, "type": { "type": "string", "description": "Type of VS Code release stream.", "enum": ["stable", "insider"], "default": "stable" }, "storage": { "type": "string", "description": "Folder used for all test resources. Defaults to $TEST_RESOURCES or $TMPDIR/test-resources.", "examples": ["./test-resources"] }, "extensionsDir": { "type": "string", "description": "VS Code extensions directory override.", "examples": ["./test-extensions"] }, "settings": { "type": "string", "description": "Path to a custom VS Code settings.json file to apply during the test run.", "examples": ["./vscode-settings.json"] }, "keybindings": { "type": "string", "description": "Path to a custom VS Code keybindings.json file (JSONC array) seeded into the test instance.", "examples": ["./vscode-keybindings.json"] }, "snippets": { "type": "string", "description": "Path to a folder of snippet files seeded into the test instance's User/snippets directory.", "examples": ["./my-snippets"] }, "cleanup": { "type": "boolean", "description": "Uninstall the extension under test after the test run completes.", "default": false }, "mochaConfig": { "type": "string", "description": "Path to a Mocha configuration file.", "examples": ["./.mocharc.js", "./.mocharc.json"] }, "logLevel": { "type": "string", "description": "Webdriver log level.", "enum": ["Debug", "Info", "Warning", "Severe", "OFF", "ALL"], "default": "Info" }, "offline": { "type": "boolean", "description": "Run without an internet connection. All required resources must be pre-downloaded.", "default": false }, "coverage": { "type": "boolean", "description": "Enable c8 code coverage collection.", "default": false }, "resources": { "type": "array", "description": "File or folder paths to open in VS Code at startup.", "items": { "type": "string" }, "examples": [["."], ["./test-workspace"]] }, "customPageObjects": { "type": "string", "description": "Path to a compiled JS locator contribution file for custom page objects.", "examples": ["./out/test/customPageObjects/locators.js"] }, "locale": { "type": "string", "description": "Display language locale for VS Code (e.g. 'ru', 'zh-cn', 'fr'). Requires the matching language pack extension to be installed.", "examples": ["ru", "zh-cn", "fr", "de", "es", "ja", "ko", "pt-br", "tr"] } } } } }