Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
dependabot-2.0.json
replaces-base
For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).
{"type": "boolean"}
dependabot-2.0.json
organization
{"type": "string"}
dependabot-2.0.json
repo
{"type": "string"}
dependabot-2.0.json
auth-key
{"type": "string"}
dependabot-2.0.json
public-key-fingerprint
{"type": "string"}
dependabot-2.0.json
enable-beta-ecosystems
Enable ecosystems that have beta-level support
{"type": "boolean"}
dependabot-2.0.json
items
Element for each one package manager that you want GitHub Dependabot to monitor for new versions
{}
dart-test.json
Configuration for Dart tests
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"timeout": {"oneOf": [{"enum": ["none"]}, {"type": "string", "pattern": "^(?:[^a-df-zA-DF-Z\\s]+(?:[umUM][sS]|[dhmsDHMS])\\s?)+$", "examples": ["1m", "30s", "1m 30s"]}, {"type": "string", "pattern": "^[^a-df-zA-DF-Z\\s]+[xX]$", "examples": ["12x", "1.5X"]}]}, "skip": {"oneOf": [{"type": "boolean"}, {"type": "string"}]}, "executable": {"type": "string"}, "browserAndNodeSettings": {"type": "object", "additionalProperties": false, "properties": {"arguments": {"type": "string"}, "executable": {"oneOf": [{}, {"type": "object", "additionalProperties": false, "properties": {"linux": {}, "mac_os": {}, "windows": {}}}]}, "headless": {"type": "boolean"}}}, "foldStackFrameOptions": {"oneOf": [{"type": "object", "additionalProperties": false, "properties": {"except": {"type": "array", "items": {"type": "string"}}}}, {"type": "object", "additionalProperties": false, "properties": {"only": {"type": "array", "items": {"type": "string"}}}}]}, "testConfiguration": {"type": "object", "properties": {"timeout": {}, "verbose_trace": {"type": "boolean", "default": false}, "chain_stack_traces": {"type": "boolean"}, "js_trace": {"type": "boolean", "default": false}, "skip": {}, "retry": {"type": "number"}, "test_on": {"type": "string", "examples": ["browser && !ie"]}, "tags": {"type": "object", "additionalProperties": {}}, "add_tags": {"type": "array", "items": {"type": "string"}}, "on_platform": {"type": "object", "additionalProperties": {}}}}, "_testConfigurationInner": {"allOf": [{}, {"properties": {"presets": {"type": "object", "additionalProperties": {}}, "on_os": {"type": "object", "additionalProperties": {}}}}]}, "runnerConfiguration": {"allOf": [{}, {"properties": {"include": {"type": "string", "format": "uri"}, "paths": {"type": "array", "items": {"type": "string"}, "default": ["test"]}, "filename": {"type": "string"}, "names": {"type": "array", "items": {"type": "string"}}, "plain_names": {"type": "array", "items": {"type": "string"}}, "include_tags": {"type": "string"}, "exclude_tags": {"type": "string"}, "platforms": {"type": "array", "items": {"type": "string"}, "default": ["vm"]}, "concurrency": {"type": "integer"}, "pause_after_load": {"type": "boolean"}, "run_skipped": {"type": "boolean"}, "reporter": {"type": "string", "examples": ["compact", "expanded", "json"]}, "file_reporters": {"type": "object", "additionalProperties": {"type": "string"}}, "fold_stack_frames": {}, "custom_html_template_path": {"type": "string"}, "presets": {"type": "object", "additionalProperties": {}}, "add_presets": {"type": "array", "items": {"type": "string"}}, "on_os": {"type": "object", "additionalProperties": {}}, "override_platforms": {"type": "object", "additionalProperties": {"type": "object", "properties": {"settings": {}}}}, "define_platforms": {"type": "object", "additionalProperties": {"type": "object", "properties": {"name": {"type": "string"}, "extends": {"type": "string"}, "settings": {}}}}}}]}}}
dart-test.json
timeout
Indicates that tests should never time out.
{"enum": ["none"]}
dart-test.json
timeout
Exact timeout duration for a test.
{"type": "string", "pattern": "^(?:[^a-df-zA-DF-Z\\s]+(?:[umUM][sS]|[dhmsDHMS])\\s?)+$", "examples": ["1m", "30s", "1m 30s"]}
dart-test.json
timeout
Timeout is applied as a multiple of the default value (30 seconds)
{"type": "string", "pattern": "^[^a-df-zA-DF-Z\\s]+[xX]$", "examples": ["12x", "1.5X"]}
dart-test.json
executable
The executable to run. Can be a plain basename, an absolute path or a relative path on Windows.
{"type": "string"}
dart-test.json
arguments
The arguments are parsed in the same way as the POSIX shell
{"type": "string"}
dart-test.json
verbose_trace
This field controls whether or not traces caused by errors are trimmed to remove internal stack frames. This includes frames from the Dart core libraries, the stack_trace package, and the test package itself.
{"type": "boolean", "default": false}
dart-test.json
chain_stack_traces
Disabling stack trace chaining will improve performance for heavily async code at the cost of debuggability.
{"type": "boolean"}
dart-test.json
js_trace
Whether or not stack traces caused by errors while running Dart compiled to JS are converted back to Dart style.
{"type": "boolean", "default": false}
dart-test.json
retry
This field controls how many times a test is retried upon failure.
{"type": "number"}
dart-test.json
add_tags
Adds additional tags. This is usually used in a tag definition to enable tag inheritance.
{"type": "array", "items": {"type": "string"}}
dart-test.json
presets
A preset used in a test configuration can contain test configuration.
{"type": "object", "additionalProperties": {}}
dart-test.json
on_os
Applies test options when a specific operating system is used
{"type": "object", "additionalProperties": {}}
dart-test.json
filename
Filename pattern that the test runner uses to find test files in directories.
{"type": "string"}
dart-test.json
names
Only run tests whose names match the given regular expressions A test's name must match all regular expressions in names in order to be run.
{"type": "array", "items": {"type": "string"}}
dart-test.json
plain_names
This field causes the runner to only run tests whose names contain the given strings. A test's name must contain all strings in order to be run.
{"type": "array", "items": {"type": "string"}}
dart-test.json
include_tags
This field causes the runner to only run tests whose tags match the given boolean selector.
{"type": "string"}
dart-test.json
exclude_tags
This field causes the runner to only run tests whose tags match the given boolean selector. This takes precedence over include_tags
{"type": "string"}
dart-test.json
platforms
The platforms on which tests should be run.
{"type": "array", "items": {"type": "string"}, "default": ["vm"]}
dart-test.json
concurrency
The default number of test suites to run in parallel. This defaults to approximately half the number of processors on the current machine. Setting it to 1 will disable concurrency
{"type": "integer"}
dart-test.json
pause_after_load
Indicates that the test runner should pause for debugging after each test suite is loaded but before its tests are executed. This disables concurrency and timeouts.
{"type": "boolean"}
dart-test.json
run_skipped
Run tests even if they're marked as skipped.
{"type": "boolean"}
dart-test.json
reporter
This field indicates the default reporter to use.
{"type": "string", "examples": ["compact", "expanded", "json"]}
dart-test.json
file_reporters
Specifies additional reporters that will write their output to a file rather than stdout
{"type": "object", "additionalProperties": {"type": "string"}}
dart-test.json
custom_html_template_path
This field specifies the path of the HTML template to be used for tests run in an HTML environment.
{"type": "string"}
dart-test.json
add_presets
Commonly used in a preset, it can be used to enable present inheritance by adding the configuration from another preset.
{"type": "array", "items": {"type": "string"}}
dart-test.json
on_os
Applies test or runner options when a specific operating system is used
{"type": "object", "additionalProperties": {}}
jsinspectrc.json
identifiers
A flag indicating whether to limit the search to nodes with matching identifiers
{"default": false, "type": "boolean"}
jsinspectrc.json
ignore
A regular expression used for matching paths to ignore
{"type": "string"}
jsinspectrc.json
jsx
A flag indicating whether to process JSX files
{"default": false, "type": "boolean"}
jsinspectrc.json
reporter
The name of the reporter to be used
{"default": "default", "enum": ["default", "json", "pmd"], "type": "string"}
jsinspectrc.json
suppress
The number of lines at which diffs should be suppressed. A value of 0 is off.
{"default": 100, "minimum": 0, "type": "integer"}
jsinspectrc.json
threshold
A threshold determining the smallest subset of nodes to analyze
{"default": 15, "type": "integer"}
sfdx-hardis.jsonschema.json
Configuration file definition for sfdx-hardis Salesforce DX plugin
{"$schema": "http://json-schema.org/draft-07/schema", "additionalProperties": false, "properties": {"allowedOrgTypes": {"examples": [["sandbox"]], "items": {"type": "string", "enum": ["sandbox", "scratch"]}, "type": "array"}, "autoCleanTypes": {"examples": [["dashboards", "datadotcom", "destructivechanges"]], "items": {"type": "string", "enum": ["caseentitlement", "dashboards", "datadotcom", "destructivechanges", "localfields", "listViewsMine", "minimizeProfiles", "productrequest", "systemDebug"]}, "type": "array"}, "autoRemoveUserPermissions": {"examples": [["EnableCommunityAppLauncher", "FieldServiceAccess", "OmnichannelInventorySync"]], "items": {"type": "string"}, "type": "array"}, "autoRetrieveWhenPull": {"examples": [["CustomApplication"], ["CustomApplication:MyApp1", "CustomApplication:MyApp2"]], "items": {"type": "string"}, "type": "array"}, "apexTestsMinCoverageOrgWide": {"default": 75.0, "examples": [80.0, 95.0], "type": "number"}, "availableProjects": {"examples": [["sales_cloud", "service_cloud", "community"]], "items": {"type": "string"}, "type": "array"}, "availableTargetBranches": {"examples": [["develop", "develop_next"]], "items": {"type": "string"}, "type": "array"}, "branchPrefixChoices": {"default": [{"value": "feat"}, {"value": "fix"}], "examples": [[{"value": "feat"}, {"value": "fix"}]], "type": "array"}, "cleanXmlPatterns": {"examples": [[{"globPattern": "/**/*.flexipage-meta.xml", "xpaths": ["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]}, {"globPattern": "/**/*.layout-meta.xml", "xpaths": ["//ns:relatedLists//ns:relatedList[contains(text(),'RelatedSolutionList')]"]}]], "items": {"type": "object", "additionalProperties": false, "properties": {"globPattern": {"examples": ["/**/*.flexipage-meta.xml"], "type": "string"}, "xpaths": {"examples": [["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]], "items": {"type": "string"}, "type": "array"}}, "required": ["globPattern", "xpaths"]}, "type": "array"}, "customCommands": {"examples": [[{"id": "custom-menu", "label": "Custom commands", "commands": [{"id": "generate-manifest-xml", "label": "Generate manifest", "icon": "file.svg", "tooltip": "Generates a manifest package.xml using local sfdx source files", "command": "sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest"}, {"id": "list-all-orgs", "label": "List all orgs", "icon": "salesforce.svg", "tooltip": "List all orgs that has already been authenticated using sfdx", "command": "sfdx force:org:list --all"}]}, {"id": "custom-menu-2", "label": "Another custom menu", "commands": [{"id": "echo", "label": "Echo something", "icon": "user.svg", "tooltip": "Useless commands just to show that we can use not sfdx commands too", "command": "echo \"Something\""}]}]], "items": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "commands": {"items": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "icon": {"type": "string"}, "tooltip": {"type": "string"}, "command": {"type": "string"}, "helpUrl": {"type": "string"}}, "required": ["id", "label", "command"]}, "type": "array"}}, "required": ["id", "label"]}, "type": "array"}, "customCommandsPosition": {"default": "first", "enum": ["first", "last"], "examples": ["first", "last"], "type": "string"}, "customOrgColors": {"additionalProperties": true, "type": "object"}, "customPlugins": {"examples": [[{"name": "mo-dx-plugin", "helpUrl": "https://github.com/msrivastav13/mo-dx-plugin"}, {"name": "shane-sfdx-plugins", "helpUrl": "https://github.com/mshanemc/shane-sfdx-plugins"}]], "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"$Id": "#/properties/customPlugins/items/properties/name", "examples": ["mo-dx-plugin", "shane-sfdx-plugins"], "type": "string"}, "helpUrl": {"$Id": "#/properties/customPlugins/items/properties/helpUrl", "examples": ["https://github.com/msrivastav13/mo-dx-plugin", "https://github.com/mshanemc/shane-sfdx-plugins"], "type": "string"}}}, "type": "array"}, "dataPackages": {"items": {"type": "object", "additionalProperties": false, "properties": {"dataPath": {"type": "string"}, "importInScratchOrgs": {"type": "boolean"}}, "required": ["dataPath", "importInScratchOrgs"]}, "type": "array"}, "defaultPackageInstallationKey": {"examples": ["hardis", "myPassword", "dFGGF43656YfdFDG{{{dhgfh:::;FSEDSFd78"], "type": "string"}, "developmentBranch": {"default": "developpement", "examples": ["developpement", "dev_lot2", "hotfixes"], "type": "string"}, "deploymentPlan": {"examples": [{"packages": [{"label": "Import EmailTemplate records", "dataPath": "scripts/data/EmailTemplate", "order": -21}, {"label": "Deploy EmailTemplate", "packageXmlFile": "manifest/splits/packageXmlEmails.xml", "order": -20}, {"label": "Deploy Flow-Workflow", "packageXmlFile": "manifest/splits/packageXmlFlowWorkflow.xml", "order": 6}]}], "properties": {"packages": {"examples": [[{"label": "Import EmailTemplate records", "dataPath": "scripts/data/EmailTemplate", "order": -21}, {"label": "Deploy EmailTemplate", "packageXmlFile": "manifest/splits/packageXmlEmails.xml", "order": -20}]], "items": {"type": "object", "additionalProperties": false, "properties": {"dataPath": {"examples": ["scripts/data/EmailTemplate"], "type": "string"}, "label": {"examples": ["Deploy EmailTemplate", "Import EmailTemplate records"], "type": "string"}, "order": {"examples": [-20, 13, 50], "type": "number"}, "packageXmlFile": {"examples": ["manifest/splits/packageXmlEmails.xml"], "type": "string"}, "waitAfter": {"examples": [10, 20], "type": "number"}}}, "required": ["label", "order"], "type": "array"}}, "type": "object"}, "devHubAlias": {"default": "", "examples": ["DevHub_MyClientMyProject", "DevHub_GoogleGmail", "DevHub_AppleIWatch"], "type": "string"}, "devHubUsername": {"default": "", "examples": ["[email protected]", "[email protected]", "[email protected]"], "type": "string"}, "extends": {"examples": ["https://raw.githubusercontent.com/worldcompany/shared-config/main/.sfdx-hardis.yml"], "type": "string"}, "initPermissionSets": {"examples": [["MyPermissionSet", "MyPermissionSetGroup"]], "items": {"type": ["object", "string"], "additionalProperties": false, "properties": {"name": {"$Id": "#/properties/initPermissionSets/items/properties/name", "examples": [["MyPermissionSet", "MyPermissionSetGroup", "MyPermissionSetGroup2"]], "type": "string"}}}, "type": "array"}, "installedPackages": {"examples": [[{"Id": "0A30N000000ALWrSAO", "SubscriberPackageId": "033b0000000Pf2AAAS", "SubscriberPackageName": "Declarative Lookup Rollup Summaries Tool", "SubscriberPackageNamespace": "dlrs", "SubscriberPackageVersionId": "04t0N000000IyYrQAK", "SubscriberPackageVersionName": "2.11", "SubscriberPackageVersionNumber": "2.11.0.1", "installOnScratchOrgs": false, "installDuringDeployments": true, "installationkey": "MyInstallationKey"}, {"Id": "0A35r000000GveVCAS", "SubscriberPackageId": "0330o000000B3vIAAS", "SubscriberPackageName": "Files Attachment Notes", "SubscriberPackageNamespace": "fan_astrea", "SubscriberPackageVersionId": "04t0o000003nRWAAA2", "SubscriberPackageVersionName": "Summer2021", "SubscriberPackageVersionNumber": "1.22.0.2", "installOnScratchOrgs": true, "installDuringDeployments": true}]], "items": {"type": "object", "additionalProperties": false, "properties": {"Id": {"$Id": "#/properties/install/properties/packages/items/Id", "examples": ["0A35r000000GveVCAS"], "type": "string"}, "SubscriberPackageId": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageId", "examples": ["033b0000000Pf2AAAS"], "type": "string"}, "SubscriberPackageName": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageName", "examples": ["Files Attachment Notes"], "type": "string"}, "SubscriberPackageNamespace": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageNamespace", "examples": ["fan_astrea"], "type": ["string", "null"]}, "SubscriberPackageVersionId": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionId", "examples": ["04t0o000003nRWAAA2"], "type": "string"}, "SubscriberPackageVersionName": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionName", "examples": ["Summer2021"], "type": "string"}, "SubscriberPackageVersionNumber": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionNumber", "examples": ["1.22.0.2"], "type": "string"}, "installDuringDeployments": {"$Id": "#/properties/install/properties/packages/items/installDuringDeployments", "default": false, "examples": [true, false], "type": "boolean"}, "installOnScratchOrgs": {"$Id": "#/properties/install/properties/packages/items/installOnScratchOrgs", "default": false, "examples": [true, false], "type": "boolean"}, "installationkey": {"$Id": "#/properties/install/properties/packages/items/installationkey", "examples": ["MyInstallationKey", "4FzkMzUSwFfP#@"], "type": "string"}}, "required": ["SubscriberPackageVersionId"]}, "type": "array"}, "installPackagesDuringCheckDeploy": {"default": false, "examples": [true], "type": "boolean"}, "instanceUrl": {"default": "", "examples": ["https://myclient.force.com", "https://google.force.com", "https://apple.force.com"], "type": "string"}, "listViewsToSetToMine": {"default": [], "examples": [], "items": {"type": "string"}, "type": "array"}, "sourcesToRetrofit": {"examples": [["CustomField", "Layout", "PermissionSet"]], "items": {"type": "string"}, "type": "array"}, "msTeamsWebhookUrl": {"default": "", "examples": ["https://my.msteams.webhook.url"], "type": "string"}, "msTeamsWebhookUrlCritical": {"default": "", "examples": ["https://my.msteams.webhook.url"], "type": "string"}, "msTeamsWebhookUrlSevere": {"default": "", "examples": ["https://my.msteams.webhook.url"], "type": "string"}, "msTeamsWebhookUrlWarning": {"default": "", "examples": ["https://my.msteams.webhook.url"], "type": "string"}, "msTeamsWebhookUrlInfo": {"default": "", "examples": ["https://my.msteams.webhook.url"], "type": "string"}, "poolConfig": {"examples": [{"maxScratchOrgsNumber": 10, "storageService": "kvdb.io"}], "type": "object", "properties": {"minScratchOrgRemainingDays": {"default": 25, "type": "number"}, "maxScratchOrgsNumber": {"type": "number"}, "maxScratchOrgsNumberToCreateOnce": {"type": "number"}, "storageService": {"type": "string"}}}, "productionBranch": {"default": "", "examples": ["master", "main", "production"], "type": "string"}, "projectName": {"default": "", "examples": ["MyClientMyProject", "GoogleGmail", "AppleIWatch"], "type": "string"}, "retrofitBranch": {"default": "", "examples": ["preprod", "dev", "maintenance"], "type": "string"}, "retrofitIgnoredFiles": {"examples": [["force-app/main/default/applications/MyAppIWantToManageInProduction.app-meta.xml", "force-app/main/default/flexipages/MyFlexipageWithDashboards.flexipage-meta.xml"]], "items": {"type": "string"}, "type": "array"}, "scratchOrgInitApexScripts": {"examples": [["scripts/apex/init-scratch.apex", "scripts/apex/init-custom-settings.apex"]], "items": {"type": "string"}, "type": "array"}, "sfdmuCanModify": {"default": "", "examples": ["myproject.force.com"], "type": "string"}, "skipUpdateForceIgnore": {"default": false, "type": "boolean"}, "skipUpdateGitIgnore": {"default": false, "type": "boolean"}, "targetUsername": {"default": "", "examples": ["[email protected]", "[email protected]", "[email protected]"], "type": "string"}, "linterIgnoreRightMetadataFile": {"default": "", "examples": ["Profile", "Profile:ProfileA", "PermissionSet", "PermissionSet:PermissionSetA, Profile:ProfileA"], "type": "string"}}, "type": "object"}
sfdx-hardis.jsonschema.json
allowedOrgTypes
Types of orgs allowed for config & development. If not set, sandbox and scratch are allowed by default
{"examples": [["sandbox"]], "items": {"type": "string", "enum": ["sandbox", "scratch"]}, "type": "array"}
sfdx-hardis.jsonschema.json
autoCleanTypes
When saving a sfdx-hardis task, the list of cleanings will be automatically applied to sfdx sources
{"examples": [["dashboards", "datadotcom", "destructivechanges"]], "items": {"type": "string", "enum": ["caseentitlement", "dashboards", "datadotcom", "destructivechanges", "localfields", "listViewsMine", "minimizeProfiles", "productrequest", "systemDebug"]}, "type": "array"}
sfdx-hardis.jsonschema.json
autoRemoveUserPermissions
When saving a sfdx-hardis task, these permissions will be removed from profiles
{"examples": [["EnableCommunityAppLauncher", "FieldServiceAccess", "OmnichannelInventorySync"]], "items": {"type": "string"}, "type": "array"}
sfdx-hardis.jsonschema.json
autoRetrieveWhenPull
When calling hardis:scratch:pull, if you define metadatas (named or not), they will also be retrieved using force:source:retrieve
{"examples": [["CustomApplication"], ["CustomApplication:MyApp1", "CustomApplication:MyApp2"]], "items": {"type": "string"}, "type": "array"}
sfdx-hardis.jsonschema.json
apexTestsMinCoverageOrgWide
Minimum percentage of apex code coverage accepted
{"default": 75.0, "examples": [80.0, 95.0], "type": "number"}
sfdx-hardis.jsonschema.json
availableProjects
List of business projects that are managed in the same repository. Will be used to build git branch name when using hardis:work:new
{"examples": [["sales_cloud", "service_cloud", "community"]], "items": {"type": "string"}, "type": "array"}
sfdx-hardis.jsonschema.json
availableTargetBranches
List of git branches that can be used as target for merge requests
{"examples": [["develop", "develop_next"]], "items": {"type": "string"}, "type": "array"}
sfdx-hardis.jsonschema.json
branchPrefixChoices
When calling hardis:work:new, you can override the default branch prefixes. Input title, value and description for each of them
{"default": [{"value": "feat"}, {"value": "fix"}], "examples": [[{"value": "feat"}, {"value": "fix"}]], "type": "array"}
sfdx-hardis.jsonschema.json
default
New feature, evolution of an existing feature... If you don't know, just select Feature
{"value": "feat"}
sfdx-hardis.jsonschema.json
default
A bug has been identified and you are the right person to solve it !
{"value": "fix"}
sfdx-hardis.jsonschema.json
examples
New feature, evolution of an existing feature... If you don't know, just select Feature
{"value": "feat"}
sfdx-hardis.jsonschema.json
examples
A bug has been identified and you are the right person to solve it !
{"value": "fix"}
sfdx-hardis.jsonschema.json
cleanXmlPatterns
List of patterns to automatically clean XML files
{"examples": [[{"globPattern": "/**/*.flexipage-meta.xml", "xpaths": ["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]}, {"globPattern": "/**/*.layout-meta.xml", "xpaths": ["//ns:relatedLists//ns:relatedList[contains(text(),'RelatedSolutionList')]"]}]], "items": {"type": "object", "additionalProperties": false, "properties": {"globPattern": {"examples": ["/**/*.flexipage-meta.xml"], "type": "string"}, "xpaths": {"examples": [["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]], "items": {"type": "string"}, "type": "array"}}, "required": ["globPattern", "xpaths"]}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Clean XML pattern and xpaths
{"type": "object", "additionalProperties": false, "properties": {"globPattern": {"examples": ["/**/*.flexipage-meta.xml"], "type": "string"}, "xpaths": {"examples": [["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]], "items": {"type": "string"}, "type": "array"}}, "required": ["globPattern", "xpaths"]}
sfdx-hardis.jsonschema.json
globPattern
Glob pattern to identify XML files to clean
{"examples": ["/**/*.flexipage-meta.xml"], "type": "string"}
sfdx-hardis.jsonschema.json
xpaths
XPaths to identify elements to remove
{"examples": [["//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"]], "items": {"type": "string"}, "type": "array"}
sfdx-hardis.jsonschema.json
customCommands
List of custom commands for VsCode SFDX-Hardis extension
{"examples": [[{"id": "custom-menu", "label": "Custom commands", "commands": [{"id": "generate-manifest-xml", "label": "Generate manifest", "icon": "file.svg", "tooltip": "Generates a manifest package.xml using local sfdx source files", "command": "sfdx force:source:manifest:create --sourcepath force-app --manifestname myNewManifest"}, {"id": "list-all-orgs", "label": "List all orgs", "icon": "salesforce.svg", "tooltip": "List all orgs that has already been authenticated using sfdx", "command": "sfdx force:org:list --all"}]}, {"id": "custom-menu-2", "label": "Another custom menu", "commands": [{"id": "echo", "label": "Echo something", "icon": "user.svg", "tooltip": "Useless commands just to show that we can use not sfdx commands too", "command": "echo \"Something\""}]}]], "items": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "commands": {"items": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "icon": {"type": "string"}, "tooltip": {"type": "string"}, "command": {"type": "string"}, "helpUrl": {"type": "string"}}, "required": ["id", "label", "command"]}, "type": "array"}}, "required": ["id", "label"]}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Custom command definition
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "commands": {"items": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "icon": {"type": "string"}, "tooltip": {"type": "string"}, "command": {"type": "string"}, "helpUrl": {"type": "string"}}, "required": ["id", "label", "command"]}, "type": "array"}}, "required": ["id", "label"]}
sfdx-hardis.jsonschema.json
id
Identifier of the menu (can be any string)
{"type": "string"}
sfdx-hardis.jsonschema.json
label
Label of the menu
{"type": "string"}
sfdx-hardis.jsonschema.json
commands
List of commands of the menu
{"items": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "icon": {"type": "string"}, "tooltip": {"type": "string"}, "command": {"type": "string"}, "helpUrl": {"type": "string"}}, "required": ["id", "label", "command"]}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Custom command definition
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {"type": "string"}, "icon": {"type": "string"}, "tooltip": {"type": "string"}, "command": {"type": "string"}, "helpUrl": {"type": "string"}}, "required": ["id", "label", "command"]}
sfdx-hardis.jsonschema.json
id
Identifier of the command (can be any string)
{"type": "string"}
sfdx-hardis.jsonschema.json
label
Label of the command that will appear in menu
{"type": "string"}
sfdx-hardis.jsonschema.json
icon
Icon (can be any of svg icons of this list: https://github.com/hardisgroupcom/vscode-sfdx-hardis/tree/master/resources
{"type": "string"}
sfdx-hardis.jsonschema.json
tooltip
Text that will appear when user will hover the command
{"type": "string"}
sfdx-hardis.jsonschema.json
command
Command line to run when clicking on the menu
{"type": "string"}
sfdx-hardis.jsonschema.json
helpUrl
URL for help page of the command
{"type": "string"}
sfdx-hardis.jsonschema.json
customCommandsPosition
Position of custom commands in the menu (first or last)
{"default": "first", "enum": ["first", "last"], "examples": ["first", "last"], "type": "string"}
sfdx-hardis.jsonschema.json
customOrgColors
Custom colors set by VsCode SFDX Hardis
{"additionalProperties": true, "type": "object"}
sfdx-hardis.jsonschema.json
customPlugins
List of additional plugins that will be displayed in VsCode SFDX-Hardis Dependencies panel
{"examples": [[{"name": "mo-dx-plugin", "helpUrl": "https://github.com/msrivastav13/mo-dx-plugin"}, {"name": "shane-sfdx-plugins", "helpUrl": "https://github.com/mshanemc/shane-sfdx-plugins"}]], "items": {"type": "object", "additionalProperties": false, "properties": {"name": {"$Id": "#/properties/customPlugins/items/properties/name", "examples": ["mo-dx-plugin", "shane-sfdx-plugins"], "type": "string"}, "helpUrl": {"$Id": "#/properties/customPlugins/items/properties/helpUrl", "examples": ["https://github.com/msrivastav13/mo-dx-plugin", "https://github.com/mshanemc/shane-sfdx-plugins"], "type": "string"}}}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Plugin definition
{"type": "object", "additionalProperties": false, "properties": {"name": {"$Id": "#/properties/customPlugins/items/properties/name", "examples": ["mo-dx-plugin", "shane-sfdx-plugins"], "type": "string"}, "helpUrl": {"$Id": "#/properties/customPlugins/items/properties/helpUrl", "examples": ["https://github.com/msrivastav13/mo-dx-plugin", "https://github.com/mshanemc/shane-sfdx-plugins"], "type": "string"}}}
sfdx-hardis.jsonschema.json
name
Name of the plugin npm package
{"$Id": "#/properties/customPlugins/items/properties/name", "examples": ["mo-dx-plugin", "shane-sfdx-plugins"], "type": "string"}
sfdx-hardis.jsonschema.json
helpUrl
Url of plugin documentation
{"$Id": "#/properties/customPlugins/items/properties/helpUrl", "examples": ["https://github.com/msrivastav13/mo-dx-plugin", "https://github.com/mshanemc/shane-sfdx-plugins"], "type": "string"}
sfdx-hardis.jsonschema.json
dataPackages
List of data packages
{"items": {"type": "object", "additionalProperties": false, "properties": {"dataPath": {"type": "string"}, "importInScratchOrgs": {"type": "boolean"}}, "required": ["dataPath", "importInScratchOrgs"]}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Data package
{"type": "object", "additionalProperties": false, "properties": {"dataPath": {"type": "string"}, "importInScratchOrgs": {"type": "boolean"}}, "required": ["dataPath", "importInScratchOrgs"]}
sfdx-hardis.jsonschema.json
dataPath
Path to SFDMU project
{"type": "string"}
sfdx-hardis.jsonschema.json
importInScratchOrgs
Path to SFDMU project
{"type": "boolean"}
sfdx-hardis.jsonschema.json
defaultPackageInstallationKey
When generating a new package version protected with password, use this value as default package installation key
{"examples": ["hardis", "myPassword", "dFGGF43656YfdFDG{{{dhgfh:::;FSEDSFd78"], "type": "string"}
sfdx-hardis.jsonschema.json
developmentBranch
When creating a new sfdx-hardis task, this git branch is used as base to create the feature/debug sub branch. The merge request will later have this branch as target.
{"default": "developpement", "examples": ["developpement", "dev_lot2", "hotfixes"], "type": "string"}
sfdx-hardis.jsonschema.json
deploymentPlan
Deployment plan that will be performed during deployments. Can be based on packageXmlFile for sources or on dataPath for sfdmu data deployments
{"examples": [{"packages": [{"label": "Import EmailTemplate records", "dataPath": "scripts/data/EmailTemplate", "order": -21}, {"label": "Deploy EmailTemplate", "packageXmlFile": "manifest/splits/packageXmlEmails.xml", "order": -20}, {"label": "Deploy Flow-Workflow", "packageXmlFile": "manifest/splits/packageXmlFlowWorkflow.xml", "order": 6}]}], "properties": {"packages": {"examples": [[{"label": "Import EmailTemplate records", "dataPath": "scripts/data/EmailTemplate", "order": -21}, {"label": "Deploy EmailTemplate", "packageXmlFile": "manifest/splits/packageXmlEmails.xml", "order": -20}]], "items": {"type": "object", "additionalProperties": false, "properties": {"dataPath": {"examples": ["scripts/data/EmailTemplate"], "type": "string"}, "label": {"examples": ["Deploy EmailTemplate", "Import EmailTemplate records"], "type": "string"}, "order": {"examples": [-20, 13, 50], "type": "number"}, "packageXmlFile": {"examples": ["manifest/splits/packageXmlEmails.xml"], "type": "string"}, "waitAfter": {"examples": [10, 20], "type": "number"}}}, "required": ["label", "order"], "type": "array"}}, "type": "object"}
sfdx-hardis.jsonschema.json
packages
During deployment, main package.xml will be split into these packages. Can also contain data packages
{"examples": [[{"label": "Import EmailTemplate records", "dataPath": "scripts/data/EmailTemplate", "order": -21}, {"label": "Deploy EmailTemplate", "packageXmlFile": "manifest/splits/packageXmlEmails.xml", "order": -20}]], "items": {"type": "object", "additionalProperties": false, "properties": {"dataPath": {"examples": ["scripts/data/EmailTemplate"], "type": "string"}, "label": {"examples": ["Deploy EmailTemplate", "Import EmailTemplate records"], "type": "string"}, "order": {"examples": [-20, 13, 50], "type": "number"}, "packageXmlFile": {"examples": ["manifest/splits/packageXmlEmails.xml"], "type": "string"}, "waitAfter": {"examples": [10, 20], "type": "number"}}}, "required": ["label", "order"], "type": "array"}
sfdx-hardis.jsonschema.json
items
Source or data package to deploy
{"type": "object", "additionalProperties": false, "properties": {"dataPath": {"examples": ["scripts/data/EmailTemplate"], "type": "string"}, "label": {"examples": ["Deploy EmailTemplate", "Import EmailTemplate records"], "type": "string"}, "order": {"examples": [-20, 13, 50], "type": "number"}, "packageXmlFile": {"examples": ["manifest/splits/packageXmlEmails.xml"], "type": "string"}, "waitAfter": {"examples": [10, 20], "type": "number"}}}
sfdx-hardis.jsonschema.json
waitAfter
Delay to wait before installing the next package
{"examples": [10, 20], "type": "number"}
sfdx-hardis.jsonschema.json
devHubAlias
Dev Hub alias, usually DevHub_ProjectName
{"default": "", "examples": ["DevHub_MyClientMyProject", "DevHub_GoogleGmail", "DevHub_AppleIWatch"], "type": "string"}
sfdx-hardis.jsonschema.json
devHubUsername
Dev Hub username, used to authenticate to DevHub from CI jobs
{"default": "", "examples": ["[email protected]", "[email protected]", "[email protected]"], "type": "string"}
sfdx-hardis.jsonschema.json
extends
You can base your local sfdx-hardis configuration on a remote config file. That allows you to have the same config base for all your projects
{"examples": ["https://raw.githubusercontent.com/worldcompany/shared-config/main/.sfdx-hardis.yml"], "type": "string"}
sfdx-hardis.jsonschema.json
initPermissionSets
When creating a scratch org, Admin user will be automatically assigned to those permission sets
{"examples": [["MyPermissionSet", "MyPermissionSetGroup"]], "items": {"type": ["object", "string"], "additionalProperties": false, "properties": {"name": {"$Id": "#/properties/initPermissionSets/items/properties/name", "examples": [["MyPermissionSet", "MyPermissionSetGroup", "MyPermissionSetGroup2"]], "type": "string"}}}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Permission Set or Permission Set Group
{"type": ["object", "string"], "additionalProperties": false, "properties": {"name": {"$Id": "#/properties/initPermissionSets/items/properties/name", "examples": [["MyPermissionSet", "MyPermissionSetGroup", "MyPermissionSetGroup2"]], "type": "string"}}}
sfdx-hardis.jsonschema.json
name
Permission Set or Permission Set Group name
{"$Id": "#/properties/initPermissionSets/items/properties/name", "examples": [["MyPermissionSet", "MyPermissionSetGroup", "MyPermissionSetGroup2"]], "type": "string"}
sfdx-hardis.jsonschema.json
installedPackages
Defines the list of packages installed on the project. Use
{"examples": [[{"Id": "0A30N000000ALWrSAO", "SubscriberPackageId": "033b0000000Pf2AAAS", "SubscriberPackageName": "Declarative Lookup Rollup Summaries Tool", "SubscriberPackageNamespace": "dlrs", "SubscriberPackageVersionId": "04t0N000000IyYrQAK", "SubscriberPackageVersionName": "2.11", "SubscriberPackageVersionNumber": "2.11.0.1", "installOnScratchOrgs": false, "installDuringDeployments": true, "installationkey": "MyInstallationKey"}, {"Id": "0A35r000000GveVCAS", "SubscriberPackageId": "0330o000000B3vIAAS", "SubscriberPackageName": "Files Attachment Notes", "SubscriberPackageNamespace": "fan_astrea", "SubscriberPackageVersionId": "04t0o000003nRWAAA2", "SubscriberPackageVersionName": "Summer2021", "SubscriberPackageVersionNumber": "1.22.0.2", "installOnScratchOrgs": true, "installDuringDeployments": true}]], "items": {"type": "object", "additionalProperties": false, "properties": {"Id": {"$Id": "#/properties/install/properties/packages/items/Id", "examples": ["0A35r000000GveVCAS"], "type": "string"}, "SubscriberPackageId": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageId", "examples": ["033b0000000Pf2AAAS"], "type": "string"}, "SubscriberPackageName": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageName", "examples": ["Files Attachment Notes"], "type": "string"}, "SubscriberPackageNamespace": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageNamespace", "examples": ["fan_astrea"], "type": ["string", "null"]}, "SubscriberPackageVersionId": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionId", "examples": ["04t0o000003nRWAAA2"], "type": "string"}, "SubscriberPackageVersionName": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionName", "examples": ["Summer2021"], "type": "string"}, "SubscriberPackageVersionNumber": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionNumber", "examples": ["1.22.0.2"], "type": "string"}, "installDuringDeployments": {"$Id": "#/properties/install/properties/packages/items/installDuringDeployments", "default": false, "examples": [true, false], "type": "boolean"}, "installOnScratchOrgs": {"$Id": "#/properties/install/properties/packages/items/installOnScratchOrgs", "default": false, "examples": [true, false], "type": "boolean"}, "installationkey": {"$Id": "#/properties/install/properties/packages/items/installationkey", "examples": ["MyInstallationKey", "4FzkMzUSwFfP#@"], "type": "string"}}, "required": ["SubscriberPackageVersionId"]}, "type": "array"}
sfdx-hardis.jsonschema.json
items
Salesforce package info (managed, unlocked or unmanaged)
{"type": "object", "additionalProperties": false, "properties": {"Id": {"$Id": "#/properties/install/properties/packages/items/Id", "examples": ["0A35r000000GveVCAS"], "type": "string"}, "SubscriberPackageId": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageId", "examples": ["033b0000000Pf2AAAS"], "type": "string"}, "SubscriberPackageName": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageName", "examples": ["Files Attachment Notes"], "type": "string"}, "SubscriberPackageNamespace": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageNamespace", "examples": ["fan_astrea"], "type": ["string", "null"]}, "SubscriberPackageVersionId": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionId", "examples": ["04t0o000003nRWAAA2"], "type": "string"}, "SubscriberPackageVersionName": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionName", "examples": ["Summer2021"], "type": "string"}, "SubscriberPackageVersionNumber": {"$Id": "#/properties/install/properties/packages/items/SubscriberPackageVersionNumber", "examples": ["1.22.0.2"], "type": "string"}, "installDuringDeployments": {"$Id": "#/properties/install/properties/packages/items/installDuringDeployments", "default": false, "examples": [true, false], "type": "boolean"}, "installOnScratchOrgs": {"$Id": "#/properties/install/properties/packages/items/installOnScratchOrgs", "default": false, "examples": [true, false], "type": "boolean"}, "installationkey": {"$Id": "#/properties/install/properties/packages/items/installationkey", "examples": ["MyInstallationKey", "4FzkMzUSwFfP#@"], "type": "string"}}, "required": ["SubscriberPackageVersionId"]}
sfdx-hardis.jsonschema.json
installDuringDeployments
If true, during deployments this package will be installed in target org if not installed yet
{"$Id": "#/properties/install/properties/packages/items/installDuringDeployments", "default": false, "examples": [true, false], "type": "boolean"}
sfdx-hardis.jsonschema.json
installOnScratchOrgs
If true, this package will be installed when creating a new scratch org with sfdx-hardis
{"$Id": "#/properties/install/properties/packages/items/installOnScratchOrgs", "default": false, "examples": [true, false], "type": "boolean"}
sfdx-hardis.jsonschema.json
installationkey
Installation key for key-protected package
{"$Id": "#/properties/install/properties/packages/items/installationkey", "examples": ["MyInstallationKey", "4FzkMzUSwFfP#@"], "type": "string"}
sfdx-hardis.jsonschema.json
installPackagesDuringCheckDeploy
When calling deployment check command, installs any package referred within installedPackages property
{"default": false, "examples": [true], "type": "boolean"}
sfdx-hardis.jsonschema.json
instanceUrl
Salesforce instance URL used by CI for deployment or backups
{"default": "", "examples": ["https://myclient.force.com", "https://google.force.com", "https://apple.force.com"], "type": "string"}
sfdx-hardis.jsonschema.json
listViewsToSetToMine
List of ListView items to set to Mine after a delivery (that does not accept value 'Everything')
{"default": [], "examples": [], "items": {"type": "string"}, "type": "array"}
sfdx-hardis.jsonschema.json
sourcesToRetrofit
List of metadata to retrieve for retrofit job
{"examples": [["CustomField", "Layout", "PermissionSet"]], "items": {"type": "string"}, "type": "array"}