plagiarize-me.json

required: to names

description: The path to move the directory to

description: The directories to move

description: Merge json file with jq command line tool pattern matching

required: type path

description: Merge type

description: Path to file to merge

description: JQ pattern of property to replace

description: JQ pattern of property to create if the property does not exist in target project file

description: A set of properties to replace if the condition evaluates to truthy

description: Configuration for property to replace if condition evaluates to truthy

required: condition pattern

description: The condition to evaluate for truthiness. If truthy will replace property matched by pattern

description: JQ pattern of property to replace

description: Set the value of these items to the value. So `'.license':MIT` would set the `license` property of the json file to 'MIT'

description: A list of items to not create, copy, replace, or remove in target file

description: Merge yaml file with yq command line tool pattern matching

description: Merge type

description: Path to file to merge

description: YQ pattern of property to replace

description: YQ pattern of property to create if the property does not exist in target project file

description: YQ pattern of property to replace

description: Set the value of these items to the value. So `'license':MIT` would set the `license` property of the yaml file to 'MIT'

description: Merge file using git merge (use with varied reliability)

description: Merge type

description: Path to file to merge

description: List of Environment variable names to create in target project if they are not already created

description: The Environment variable name

description: plagiarize-me.yaml configuration schema

description: Git repo of where this plagiarizable project is hosted

description: The git repo url of this project

description: The default branch that downstream projects should checkout when plagiarizing this project

default: master

description: Files to move in target project from their previous locations

description: Directories to move from the target repo to the target repo. Useful for refactoring project structures

$ref: #/definitions/moveItems

description: Files to move from the target repo to the target repo. Useful for refactoring

description: Shell commands to run after plagiarize files are done being copied and updated

description: The shell command to run

description: Whether or not to run this command synchronously or in parallel to other commands where `parallel: true`

description: Condition type

description: Run this command only if configured file does not exist in target project

required: type options

description: Condition type

description: Always run this command

description: Condition type

description: Configuration for strings, files, and file paths to replace in target file

description: Strings to find in target project and be replaced with plagiarized project's values

type: string integer boolean

description: Variables available to be used for finding and replacing by variable name. For example `$var_name: hello` would replace string '$var_name' with 'hello' in target project

description: Relative path to target files that will be completely overwritten by source files in the same path

description: Files to copy from plagiarized project if they do not exist in the target project

description: Files to remove commented sections from. Eg code between `// plagiarize:start:always:delete` and `// plagiarize:end:always:delete`

$ref: #/definitions/mergeJson

$ref: #/definitions/mergeYaml

$ref: #/definitions/mergeGit

$ref: #/definitions/mergeEnv

description: Files that are used the have similarities between instances of that that. .env files for example are similar and could be templated

required: name replace

description: The name of the template

description: Values to be used as variables within the target project. So `var_name: hello` in the template configuration and `var_name: world` would replace instances of 'hello' found in the source file with with 'world' found in the target file

description: Values to be used as variables within the target project. So `var_name: hello` would replace instances of '$var_name' with 'hello' in the target file

description: Values to be used as variables within the plagiarize-me.yaml file only. So `var_name: hello` would replace '$var_name' with 'hello' in plagiarize-me.yaml

description: The path to the file to create if it does not already exist

description: Values to set when iterating through each instance

description: A list of removes to push to (if `push: true`)

description: name of the remote

title: Plagiarize Me Configuration


BizTalkServerApplicationSchema.json

description: BizTalk Server Application Inventory Schema

type: array

description: Array of BizTalk Reference Assemblies to be deployed.

type: object

type: string

description: Filename of the BizTalk Referenced Assembly.

description:
Relative output filepath for the Referenced Assembly.
Example: bins\\bts1.dll

description: Array of Binding Files used in Deployment.

description: Filename of the Bindings File.

description:
Relative output filepath for the Bindings File.
Example: bindings\\binding1.xml

description: Array of Reference Assemblies to be deployed.

description: Filename of the Referenced Assembly.

description:
Relative output filepath for the Unmanaged Referenced Assembly.
Example: bins\\bts1.dll

description: Pre-Processing Scripts used in Deployment.

description: Filename of the Pre Processing Script.

description:
Relative output filepath for the Pre Processing Script.
Example: bins\\Script1.vbs

description:
Arguments for the Pre Processing Script .
Example: arg1,arg2

description: Filename of the Post Processing Script.

description:
Relative output filepath for the Post Processing Script.
Example: Script\\Script1.vbs

description:
Arguments for the Post Processing Script .
Example: arg1,arg2

description: File used in Deployment.

description: Name of the File

description:
Relative output filepath for the Files.
Example: File\\File.txt

description: Sequence of Binding Files, Reference Assemblies, Pre-Processing and Post-Processing Scripts used in Deployment.

title: BizTalkServerApplicationInventorySchema


firebase-config.json

description: Number of requests a function can serve at once.

type: number

description:
If true, allows CORS on requests to this function.
If this is a `string` or `RegExp`, allows requests from domains that match the provided value.
If this is an `Array`, allows requests from domains matching at least one entry of the array.
Defaults to true for {@link https.CallableFunction} and false otherwise.

type: string boolean

description: Fractional number of CPUs to allocate to a function.

description: Determines whether Firebase AppCheck is enforced. Defaults to false.

type: boolean

description: Ingress settings which control where this function can be called from.

description: Invoker to set access control on https functions.

$ref: #/definitions/Record<string,string>

description: User labels to set on the function.

description: Max number of instances to be running in parallel.

description: Amount of memory to allocate to a function.

description: Min number of actual instances to be running at a given time.

description: If true, do not deploy or emulate this function.

description: Controls whether function configuration modified outside of function source is preserved. Defaults to false.

description: HTTP functions can override global options and can specify multiple regions to deploy to.

description: Specific service account for the function to run as.

description:
Timeout for the function in seconds, possible values are 0 to 540.
HTTPS functions can specify a higher timeout.

description: Connect cloud function to specified VPC connector.

description: Egress settings for VPC connector.

format: uri

required: instance rules

required: rules target

type: string number

$ref: #/definitions/ExtensionsConfig


hws-config.json

type: integer

enum: all trace debug info warn error fatal off

default: off

enum: http https

description: Forces a specific namespace for connectors that perform namespace auto-detection (Advanced).

default: logs

default: Hardware problem on \${FQDN\} with \${MONITOR_NAME\}.\${NEWLINE\}\${NEWLINE\}\${ALERT_DETAILS\}\${NEWLINE\}\${NEWLINE\}\${FULLREPORT\}

enum: win linux network oob storage aix hpux solaris tru64 vmx

type: number string boolean

description: Sets the collect period that Hardware Sentry uses to collects metrics from the monitored hosts (Default: 2m).

$ref: #/definitions/duration

description: Disables Hardware Sentry's alerts for all the monitored hosts (Default: false).

description: Sets the cycle that Hardware Sentry uses to perform discoveries and detect new components in your monitored environment. By default, Hardware Sentry runs a discovery after 30 collects.

description: Sets Hardware Sentry's internal Exporter configuration.

description: Overrides Hardware Sentry's internal OTLP Exporter configuration.

description: Sets Hardware Sentry's OTLP Exporter headers, such as the `Authorization` header used to authenticate the Exporter with the OTLP gRPC Receiver.

description: Sets Hardware Sentry's OTLP Exporter trusted certificates file (Default: security/otel.crt).

description: Configures the OTLP Receiver endpoint (Default: https://localhost:4317).

description: Adds or overrides the attributes for all the monitored hosts. It is recommended to specify a different `site` label value for each OpenTelemetry Collector running the Hardware Sentry Agent.

$ref: #/definitions/keyValuePairVariables

description: Adds additional static metrics to be exposed by Hardware Sentry.

description: Overrides the default hardware problem template used to build the alert body for all the monitored hosts.

$ref: #/definitions/hardwareProblemTemplate

description: Configures the hosts to monitor.

description: Sets the default collect period that Hardware Sentry uses to collects metrics from the monitored host (Default: 2m).

description: Disables Hardware Sentry's alerts for the monitored host (Default: false).

description: Sets the cycle that Hardware Sentry uses to perform discoveries and detect new components for the specific host. By default, Hardware Sentry runs a discovery after 30 collects.

description: Sets the Connector(s) that must be excluded from the automatic detection.

description: Adds or overrides the attributes of the monitored host.

description: Overrides the default hardware problem template used to build the alert body for the monitored host.

description: Configures a new host to be monitored.

description: Configures the hostname of the host to be monitored.

description: Configures the identifier of the host to be monitored (Optional). By default, the host identifier is the hostname property value.

description: Configures the type of the host to be monitored.

$ref: #/definitions/hostType

required: hostname type

description: Configures several hosts which share the same characteristics.

description: Configures the hostnames of the hosts to be monitored.

description: Configures the type of the hosts to be monitored.

required: hostnames type

description: Configures the HTTP protocol to access the host.

description: Enables HTTPS to access the host (Default: true).

description: Sets the password used to establish the connection with the host through the HTTP protocol.

description: Sets the HTTPS port number used to perform HTTP requests (Default: 443).

description: Sets how long until the HTTP request times out (Default: 120s).

description: Sets the username used to establish the connection with the host through the HTTP protocol.

description: Configures the IPMI protocol to access the host.

description: Sets the password used to establish the connection with the host through the IPMI protocol.

description: Sets how long until the IPMI request times out (Default: 120s).

description: Sets the username used to establish the connection with the host through the IPMI protocol.

description: Enables the debug mode of the core engine on the specific host (Default: off).

$ref: #/definitions/loggerLevel

description: Sets how long until the engine's discovery and collect operations time out.

description: Configures the OS Command protocol to access the host.

description: Sets the sudo command to be used for the host to be monitored (Default: sudo).

default: sudo

description: Sets how long until the local OS Command times out (Default: 120s).

description: Sets if sudo needs to be used for the local OS Command (Default: false).

description: Sets the list of commands for which sudo is required.

description: Sets the debug output directory for the monitored host. By default, the debug output file is saved in the `logs` directory under the Hardware Sentry's home directory.

$ref: #/definitions/outputDirectory

description: Sets the Connector(s) to use to monitor the host. No automatic detection will be performed.

description: Forces all the network calls to be executed in sequential order for the monitored host - NOT RECOMMENDED (Default: false).

$ref: #/definitions/sequential

description: Configures the SNMP protocol to access the host.

description: Sets the SNMP Community string to use to perform SNMP v1 queries (Default: public).

default: public

description: SNMP v3 only - Sets the password to use for performing the SNMP query.

description: Sets the SNMP port number used to perform SNMP queries (Default: 161).

description: SNMP v3 only - Sets the type of encryption protocol.

enum: none aes des

description: SNMP v3 only - Sets the password associated to the privacy protocol.

description: Sets how long until the SNMP request times out (Default: 120s).

description: SNMP v3 only - Sets the username to use for performing the SNMP query.

description: Sets the version of the SNMP protocol (Default: v1).

description: Configures the SSH protocol to access the host.

description: Sets the password to use for performing the SSH query.

description: Sets the private Key File to use to establish the connection to the host through the SSH protocol.

description: Sets the sudo command to be used.

description: Sets how long until the command times out (Default: 120s).

description: Sets if sudo needs to be used for the SSH Command (Default: false).

description: Sets the username to use for performing the SSH query.

description: Configures the WBEM protocol to access the host.

$ref: #/definitions/namespace

description: Sets the password used to establish the connection with the host through the WBEM protocol.

description: Sets the HTTPS port number used to perform WBEM queries (Default: 5989 for HTTPS or 5988 for HTTP).

description: Sets the protocol used to access the host (Default: https).

$ref: #/definitions/transportProtocols

default: https

description: Sets how long until the WBEM request times out (Default: 120s).

description: Sets the username used to establish the connection with the host through the WBEM protocol.

description: Configures the WinRM protocol to access the host.

description: Sets an ordered list of authentication schemes (Default: ["ntlm"]).

description: Sets the password used to establish the connection with the host through the WinRM protocol.

description: Sets the port number used to perform WQL queries and commands (Default: 5985 for HTTP or 5986 for HTTPS).

description: Sets the protocol used to access the host (Default: http).

description: Sets how long until the WinRM request times out (Default: 120s).

description: Sets the username used to establish the connection with the host through the WinRM protocol.

description: Configures the WMI protocol to access the host.

description: Sets the password used to establish the connection with the host through the WMI protocol.

description: Sets how long until the WMI request times out (Default: 120s).

description: Sets the username used to establish the connection with the host through the WMI protocol.

description: Sets the number of jobs that Hardware Sentry can run simultaneously (Default: 20).

description: Enables the debug mode of the core engine (Default: off).

description: Customizes the OpenTelemetry Collector sub-process.

description: Overrides the OpenTelemetry Collector command line.

description: Configures the OpenTelemetry Collector environment variables.

description: Configures where to print the OpenTelemetry Collector's output (Default: log).

description: Configures the working directory of the OpenTelemetry Collector.

description: Disables the OpenTelemetry Collector (Default: false).

description: Sets the debug output directory for all the monitored hosts. By default, the debug output files are saved in the `logs` directory under the Hardware Sentry's home directory.

description: Displays the configured hostname in the Host Resource `host.name` attribute instead of the resolved FQDN (Default: false).

description: Forces all the network calls to be executed in sequential order for all the monitored hosts - NOT RECOMMENDED (Default: false).

title: Hardware Sentry configuration file


event-horizons.json

title: Event Horizons Configuration

description: The event horizons configuration

$ref: #/definitions/eventHorizonConfiguration

description: The configuration of an event horizon

description: The application id of the application which the bounded context you want to communicate belongs to

description: The bounded context id you wish to penetrate to

description: The url where the other bounded context's event horizon lives

format: uri-reference

description: An array of event artifacts that this bounded context is interested in

$ref: #/definitions/artifact

required: application boundedContext url events

$comment: Should become it's own schema file'

description: The configuration of an artifact

description: The artifact id

description: The artifact generation

required: id generation


description: A profile is some template set of checks to run with Qodana analysis

description: The profile name (embedded or located in the project)

description: The path to the profile file relative to the project root

description: The inspections to run in addition to those from the profile

description: The ID of the inspection to be added

description: The inspections or paths to exclude from analysis

description: The ID of the inspection to exclude, or 'All'

description: The path in which to disable the inspection, relative to the project root. Omitting the paths disables the inspection everywhere

description: The default running scenario

description: The name of the script

enum: default php-migration

description: The parameters to pass to the script

description: A license rule to apply for license compatibility checks in Qodana

description: The list of project license SPDX IDs

description: The list of allowed dependency licenses for the project

description: The list of prohibited dependency licenses for the project

description: A dependency to ignore for license checks in Qodana

description: The name of a dependency to ignore

description: A dependency metadata to override for license checks in Qodana

description: The dependency name

description: The dependency version

description: The dependency homepage

description: The dependency licenses

$ref: #/definitions/license

required: name version licenses

description: A dependency to add to license checks to Qodana

description: The dependency name

description: The dependency version

description: The dependency homepage

description: The dependency licenses

description: A license to apply for license compatibility checks in Qodana

description: The SPDX ID of the license

description: The license homepage

description: Configuration for .NET solutions and projects

description: The name of a .NET solution inside the Qodana project

description: The name of a .NET project inside the Qodana project

description: The name of a configuration to be used for .NET solution or project

description: The name of a platform to be used for .NET solution or project

description: A configuration file for Qodana (https://jetbrains.com/qodana), named qodana.yaml or qodana.yml

description: The version of the file format

description: The profile configuration for Qodana analysis

$ref: #/definitions/profile

description: The number of problems that causes Qodana to exit with code 255

description: The run scenario. 'default' by default

$ref: #/definitions/script

description: The inspections and paths that are excluded from analysis

$ref: #/definitions/exclude

description: The inspections and paths that are added to those from the profile

$ref: #/definitions/include

description: The linter (Docker image) to run for Qodana CLI / any CI extensions

description: The command to run inside Docker before the analysis starts

description: Set JVM properties to be used while running Qodana

description: A list of license rules to apply for license checks

$ref: #/definitions/licenseRule

$ref: #/definitions/dependencyIgnore

$ref: #/definitions/dependencyOverride

$ref: #/definitions/customDependency

description: The configuration for .NET solutions and projects

$ref: #/definitions/dot-net

title: Qodana


vsls.json

description: An array of globs which indicate the files that should be completely unavailable to guests when you share (e.g. secrets).

description: Indicates how .gitignore files should be treated with respects to excluding/hiding files from guests.

default: hide

enum: none hide exclude

description: An array of globs which indicate the files that should be hidden from guest's file trees, but still accessible (e.g. when following the host).

title: JSON schema for Visual Studio Live Share config files


codeclimate.json

title: Enabled

title: Config

title: Threshold

description: Configuration file as an alternative for configuring your repository in the settings page.

title: Version

description: Required to adjust maintainability checks.

title: Prepare

title: URL

title: Path

title: Checks

title: Argument Count

$ref: #/definitions/enabled

$ref: #/definitions/config

$ref: #/definitions/threshold

title: Complex Logic

title: File Lines

title: Method Complexity

title: Method Count

title: Method Lines

title: Nested Control Flow

title: Return Statements

title: Similar Code

title: Identical Code

title: Plugins

description: To add a plugin to your analysis. You can find the complete list of available plugins here: https://docs.codeclimate.com/docs/list-of-engines

title: Exclude Patterns

title: Exclude Pattern

title: Code Climate Configuration


$ref: #/definitions/dependencies

$ref: #/definitions/compilationOptions

type: string object

default: default

enum: default build

type: string array

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

description: List of files to exclude from publish output (kpm bundle).

description: Glob pattern to specify all the code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "Folder1\*.cs", "Folder2\*.cs" ]

description: Configurations are named groups of compilation settings. There are 2 defaults built into the runtime namely 'Debug' and 'Release'.

description: Copyright details for the package

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.

description: A link to the license that the package is under

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.

description: A URL for the home page of the package

description: A short description of the package

description: The human-friendly title of the package

description: A description of the changes made in each release of the package.

description: The locale ID for the package, such as en-us.

description: The description of the application

description: Glob pattern to indicate all the code files to be excluded from compilation. (data type: string or array with glob pattern(s)).

$ref: #/definitions/configType

description: Overrides the generated resource names with custom ones.

description: Glob pattern to indicate all the code files to be preprocessed. (data type: string with glob pattern).

description: Glob pattern to indicate all the files that need to be compiled as resources.

description: Scripts to execute during the various stages.

description: Glob pattern to specify the code files to share with dependent projects. Example: [ "Folder1\*.cs", "Folder2\*.cs" ]

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*

description: Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.

title: JSON schema for ASP.NET project.json files


ezd.schema.json

title: ezd

description: The schema for `ezd`

description: Environment variables to set for all tasks

description: Configure and run shell tasks

description: Describes the task for the user

description: Environment variables to set while executing these specific commands

description: A list of commands to execute within the local shell

description: Configure and run `docker-seq` tasks

description: Path to a `docker-seq.yml` file

description: Embedded `docker-seq.yml` configuration

description: Declare docker volumes to use within docker_seq tasks

description: Specify volume driver name

description: Set metadata for a volume

description: Set driver specific options


package.manifest.json

description: This describes details about the editor.

description: This is the full path to the HTML view for your property editor.

description: If set to true, this hides the label for the property editor when used on a document type.

description: This is the type of data you want your property editor to save to the database.

enum: STRING JSON DATETIME TEXT INT

description: Object describing required validators on the editor.

description: If set to true, this makes the property editor read-only.

description: If set to true, this will disable the default read-only overlay and requires the editor to implement support for this instead.

required: name alias editor

description: This must be a unique alias to your property editor.

description: Provides a collection of default configuration values, in cases the property editor is not configured or is used a parameter editor, which doesn't allow configuration. The object is a key/value collection and must match the prevalue fields keys.

$ref: #/definitions/editor

description: Enables the property editor as a macro parameter editor.

description: The friendly name of the property editor, shown in the backoffice.

description: A CSS class for the icon to be used in the 'Select Editor' dialog, e.g. `icon-autofill`.

description: The group to place this editor in within the 'Select Editor' dialog. Use a new group name or alternatively use an existing one such as `Pickers`.

required: name alias view

description: The friendly name of the grid editor, shown in the backoffice.

description: This must be a unique alias to your grid editor.

description: This is backoffice HTML view for your grid editor. Either refers to one of the built-in view (textstring, rte, embed, macro, media) or the full path to a custom view, e.g. `~/App_Plugins/FolderName/editor.html`.

description: This is front end Razor view for your grid editor. Accepts full path to a custom view, e.g. `~/App_Plugins/FolderName/editor.cshtml`.

description: Configuration for the grid editor. Can be used with textstring and media views or for custom configuration properties.

description: If used with the textstring view, this accepts inline CSS to style the textstring box, e.g. `font-size: 30px; line-height: 40px; font-weight: bold;`.

description: If used with the textstring view, this allows wrapping the value in custom markup, e.g. `<h2>#value#</h2>`.

description: If used with the media view, this accepts hight and width key/value pairs for cropping.

description: Height of image in pixels.

description: Width of image in pixels.

description: This is an object that stores an array of prevalue fields or options to configure your property editor.

$ref: #/definitions/fields

description: This is the collection of prevalue fields.

description: A unique key for the prevalue field.

description: The user friendly label for the prevalue.

description: A more detailed description for the user.

description: The type of editor to use for this prevalue field.

description: A dashboard to display contextual information when in a section/application.

required: alias view sections

description: The alias of the dashboard which can be queried via the Dashboard Service API.

description: This is the full path to the HTML view for your dashboard.

description: A list of section/application aliases that the dashboard should be visible in.

description: The weight (sort order) of the dashboard. Defaults to 100 if not specified.

description: A list of what user groups aliases are granted or denied permission to see the dashboard. All users will have access if not specified.

description: A user group alias who is denied access.

description: A user group alias who is granted access.

description: A section/application to extend the backoffice.

required: name alias

description: The friendly name of the section/application, shown in the backoffice.

description: The alias of the section/application which can be queried via the Section Service API.

required: name alias icon view

description: The friendly name of the content app that appears under the icon.

description: A unique alias of the content app.

description: A CSS class for the icon to be used for the content app, e.g. `icon-calculator`.

description: This is the full path to the HTML view for your content app.

description: The weight (sort order) of the content app. Default is 0, use values between -99 and +99 to appear between the existing Content (-100) and Info (100) apps.

description: A list of rules to show or hide the content app based on content, media and member types.

description: See documentation for examples of rules: https://our.umbraco.com/Documentation/Extending/Content-Apps/#limiting-according-to-type.

description: The (NuGet) package ID, shown in the backoffice and included in package telemetry as unique identifier (supported in v12+). Also used to retrieve the assembly informational version if no explicit `version` and `versionAssemlbyName` is set.

description: The (friendly) package name, shown in the backoffice and included in package telemetry. If not specified, uses the directory name instead.

description: The package version, shown in the backoffice and included in package telemetry. If not specified, uses the `versionAssemblyName` or `id` to retrieve the assembly informational version.

description: The assembly name to retrieve the informational version, if no explicit `version` is set. If not specified, uses the `id` instead (supported in v12+).

description: Allows you to opt-out of including your package in telemetry reports if set to false, defaults to true.

description: The full path to an HTML view for your package to help users maintain configuration data when viewing installed packages in the backoffice.

description: Default: The assets will be bundled with the typical packages bundle. None: The assets in the package will not be processed at all and will all be requested as individual assets in debug and production. Independent: The packages assets will be processed as it's own separate bundle (in debug, files will not be processed).

enum: Default None Independent

description: A list of JavaScript files with full path to load in the backoffice.

description: A list of CSS files with full path to load in the backoffice.

description: Returns an array of editor objects, each object specifies an editor to make available to data types as an editor component. These editors are primarily property editors for content, media and members, but can also be made available as a macro parameter editor.

$ref: #/definitions/editors

$ref: #/definitions/preValues

description: Returns an array of editor objects, each object specifies an editor to make available to macro parameters as an editor component. These editors work solely as parameter editors, and will not show up on the property editors list.

description: Returns an array of grid editor objects, each object specifies a grid editor to make available in the Grid Layout property editor.

$ref: #/definitions/gridEditor

description: Returns an array of dashboards, each object specified a dashboard to make available in the backoffice.

$ref: #/definitions/dashboard

description: Returns an array of sections/applications to add to the backoffice.

$ref: #/definitions/section

description: Returns an array of Content Apps to add to the backoffice.

$ref: #/definitions/contentApp

title: JSON schema for Umbraco package.manifest files.


title: Red-DiscordBot Сog Repo metadata file

description: List of names of authors of the cog

description: A long description of the cog or repo. For cogs, this is displayed when a user executes [p]cog info.

description: The message that gets displayed when a cog is installed or a repo is added

description: A short description of the cog or repo. For cogs, this info is displayed when a user executes [p]cog list


jekyll.json

description: Copy of definition from https://json.schemastore.org/base.json#/definitions/nullable-boolean

$id: nullable-boolean

description: Copy of definition from https://json.schemastore.org/base.json#/definitions/nullable-timezone

$id: nullable-timezone

description:
The global permalink format
https://jekyllrb.com/docs/permalinks/#global

default: date

description:
The collection permalink format
https://jekyllrb.com/docs/permalinks/#collections

examples: /:collection /:path /:name /:title /:output_ext

description:
A directory to read files from for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
A directory to write files to for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
Whether to enable non-whitelisted plugins and symbolic links for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

$comment: No default value described, please wait until https://github.com/jekyll/jekyll/issues/8973 is resolved.

description:
Whether to disable caching to disk for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
Whether to ignore a theme configuration for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
Excluded directories and files from the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

default: Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/

description:
An excluded directory or file from the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
Included directories and files in the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
An included directory or file in the conversion for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
Keeped files when clobbering for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

default: .git .svn

description:
A keeped file when clobbering for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
A time zone for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

$ref: #/definitions/nullable-timezone

description:
An encoding for the current site
https://jekyllrb.com/docs/configuration/options/#global-configuration

description:
The front matter defaults
https://jekyllrb.com/docs/configuration/options/#global-configuration

title: front matter default

description:
The front matter default
https://jekyllrb.com/docs/configuration/front-matter-defaults/

title: scope

description:
The scope
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
The file path for this scope
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
The page type for this scope
https://jekyllrb.com/docs/configuration/front-matter-defaults/

title: value

description:
The front matter default values
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
The layout to use
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
Enable/disable output
https://jekyllrb.com/docs/configuration/front-matter-defaults/

$ref: #/definitions/global-permalink

description:
The date for pages
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
The categories for pages
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
The tags for pages
https://jekyllrb.com/docs/configuration/front-matter-defaults/

description:
Plugin directories for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
A plugin directory for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Layout directories for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
A layout directory for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to process and render draft posts for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

$ref: #/definitions/nullable-boolean

title: future

description:
Whether to publish posts or collection documents with a future date for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to publish posts that were marked as unpublished for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to produce an index for related posts for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
A number of posts to publish for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to use polling for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to hide a normal output while building for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to write a verbose output while building for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to enable the experimental incremental build feature for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to render profile generation to help identify performance bottlenecks for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
Whether to fail build if there is a YAML syntax error in a page's front matter for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
A base URL for the current site
https://jekyllrb.com/docs/configuration/options/#build-command-options

description:
A port to listen on for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
A hostname to listen on for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

default: localhost

description:
Whether to reload pages on the browser when its content was changed for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
File glob patterns for LiveReload to ignore for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
A file glob patter for LiveReload to ignore for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
A minimum delay before automatically reloading page for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
A maximum delay before automatically reloading page for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
Whether to open a site's URL in the browser for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
Whether to detach a server from a terminal for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
Whether to skip an initial site build which occurs before the server is started for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
Whether to show directory listing instead of an index file for the current site
https://jekyllrb.com/docs/configuration/options/#serve-command-options

description:
The collections to group several site pages
https://jekyllrb.com/docs/collections/

title: collection

title: collection

description:
The collection
https://jekyllrb.com/docs/collections/#setup

description:
Enable/disable collection rendering
https://jekyllrb.com/docs/collections/#setup

$ref: #/definitions/collection-permalink

description:
The collection's front matter sort key
https://jekyllrb.com/docs/collections/#sort-by-front-matter-key

description:
The page order list in collection
https://jekyllrb.com/docs/collections/#manually-ordering-documents

description:
A directory where to store collections for the current site
https://jekyllrb.com/docs/collections/#setup

description:
A directory to store data files for the current site
https://jekyllrb.com/docs/configuration/default/

description:
An includes directory for the current site
https://jekyllrb.com/docs/configuration/default/

description:
Markdown extensions for the current site
https://jekyllrb.com/docs/configuration/default/

default: markdown,mkdown,mkdn,mkd,md

examples: markdown mkdown mkdn mkd md

description:
Whitelisted plugins for the current site
https://jekyllrb.com/docs/configuration/default/

description:
A whitelisted plugin for the current site
https://jekyllrb.com/docs/configuration/default/

description:
Enabled plugins for the current site
https://jekyllrb.com/docs/configuration/default/

description:
An enabled plugin for the current site
https://jekyllrb.com/docs/configuration/default/

description:
A markdown processor for the current site
https://jekyllrb.com/docs/configuration/default/

default: kramdown

description:
A yntax highlighter for the current site
https://jekyllrb.com/docs/configuration/default/

default: rouge

description:
A post excerpt separator for the current site
https://jekyllrb.com/docs/configuration/default/

description:
A destination of the pagination pages for the current site
https://jekyllrb.com/docs/configuration/default/

$comment: Property order: https://jekyllrb.com/docs/configuration/markdown/, GitHub repositories, kramdown.

title: kramdown options

description:
kramdown options
https://kramdown.gettalong.org/documentation.html

description:
The selected kramdown processor
https://jekyllrb.com/docs/configuration/markdown/

description:
Enable/disable interpreting line breaks literally
https://github.com/kramdown/parser-gfm#options

description:
Enabled GFM quirks
https://github.com/kramdown/parser-gfm#options

description:
Enable/disable rendering emoji amidst GFM
https://github.com/kramdown/parser-gfm#options

title: emoji options

description:
Configuration for rendering emoji amidst GFM
https://github.com/kramdown/parser-gfm#options

description: Remote location of emoji assets

description:
The prefix used for automatically generated header IDs
https://kramdown.gettalong.org/converter/html.html

description:
Strip/leave all formatting from header text for automatic ID generation
https://kramdown.gettalong.org/converter/html.html

description:
Enable/disable automatic header ID generation
https://kramdown.gettalong.org/converter/html.html

description:
The entity output
https://kramdown.gettalong.org/converter/html.html

description:
The text that should be used for the footnote backlinks
https://kramdown.gettalong.org/converter/html.html

description:
Enable/disable inlining of the footnote backlink
https://kramdown.gettalong.org/converter/html.html

description:
The number of the first footnote
https://kramdown.gettalong.org/converter/html.html

description:
The prefix for footnote IDs
https://kramdown.gettalong.org/options.html

description:
The options that may not be set using the {::options} extension
https://kramdown.gettalong.org/options.html

description:
The output offset for headers
https://kramdown.gettalong.org/options.html

description:
Enable/disable HTML elements to native elements conversion
https://kramdown.gettalong.org/parser/kramdown.html

description:
The LaTeX commands for different header levels
https://kramdown.gettalong.org/options.html

examples: section subsection subsubsection paragraph subparagraph

description:
The line width when outputting the document
https://kramdown.gettalong.org/options.html

description: The pre-defined link definitions

title: link options

description: The link identifier

description: The title

description:
The math engine
https://kramdown.gettalong.org/converter/html.html

title: math engine options

description:
The math engine options
https://kramdown.gettalong.org/converter/html.html

description:
Enable/disable processing kramdown syntax in block HTML tags
https://kramdown.gettalong.org/parser/kramdown.html

description:
Enable/disable processing kramdown syntax in span HTML tags
https://kramdown.gettalong.org/parser/kramdown.html

description:
Enable/disable removing block HTML tags
https://kramdown.gettalong.org/options.html

description:
Leave/remove line breaks between CJK characters
https://kramdown.gettalong.org/converter/html.html

description:
Enable/disable removing span HTML tags
https://kramdown.gettalong.org/options.html

description:
The HTML entity names or code points for smart quote output
https://kramdown.gettalong.org/converter/html.html

description:
The syntax highlighter
https://kramdown.gettalong.org/converter/html.html

title: syntax highlighter options

description:
The syntax highlighter options
https://kramdown.gettalong.org/converter/html.html

description:
The name of an ERB template file that should be used to wrap the output or the ERB template itself
https://kramdown.gettalong.org/converter/html.html

description:
The levels that are used for the table of contents
https://kramdown.gettalong.org/converter/html.html

description:
Enable/disable transliterating header text before generating the ID
https://kramdown.gettalong.org/converter/html.html

title: typographical symbol options

description:
The mapping from typographical symbol to output characters
https://kramdown.gettalong.org/converter/html.html

description:
Typographical symbol
https://kramdown.gettalong.org/converter/html.html

title: liquid options

description:
Liquid options
https://jekyllrb.com/docs/configuration/liquid/

description:
The response to errors
https://jekyllrb.com/docs/configuration/liquid/

title: strict filters

description:
Enable/disable non-existing filters catch
https://jekyllrb.com/docs/configuration/liquid/

title: strict variables

description:
Enable/disable non-assigned variables catch
https://jekyllrb.com/docs/configuration/liquid/

title: sass options

description:
Sass options
https://github.com/jekyll/jekyll-sass-converter#configuration-options

description:
The implementation to use
https://github.com/jekyll/jekyll-sass-converter#configuration-options

description:
The style of CSS-output
https://github.com/jekyll/jekyll-sass-converter#configuration-options

description:
The path with Sass partials
https://github.com/jekyll/jekyll-sass-converter#configuration-options

description:
The additional paths with Sass partials
https://github.com/jekyll/jekyll-sass-converter#configuration-options

description:
Enable/disable including line number and filename of the source in compiled CSS file
https://github.com/jekyll/jekyll-sass-converter#configuration-options

description:
Control when source maps shall be generated
https://github.com/jekyll/jekyll-sass-converter#configuration-options

title: webrick options

description:
WEBrick options
https://docs.ruby-lang.org/en/2.4.0/WEBrick.html

title: header options

description:
The custom headers for this site
https://docs.ruby-lang.org/en/2.4.0/WEBrick.html

title: rdiscount options

description:
RDiscount options
https://rdoc.info/github/davidfstr/rdiscount/RDiscount

description:
The enabled extensions
https://rdoc.info/github/davidfstr/rdiscount/RDiscount

title: redcarpet options

description:
Redcarpet options
https://github.com/vmg/redcarpet

description:
The enabled extensions
https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use

title: jekyll config schema


tools-schema.json

title: JSON Schema for AsyncAPI tool discovery file.

required: title filters

description: Human-readable name of the tool that will be visible to people in the list of tools.

examples:
AsyncAPI Generator
Cupid

description: By default scripts read description of repository there project is stored. You can override this behaviour by providing custom description.

description: You can provide URL to the website where your project hosts some demo or project landing page.

description: You can provide URL to project documentation in case you have more than just a readme file.

description: You can provide URL to project codebase in case you have more than one tool present inside single repository.

description: The language referred to is the runtime language selected by the user, not the generator or library language. For example, the Generator written in JavaScript generates Python code from the JavaScript template and the result of generation is a Python app, so the language for Generator is specified as Python. But for the Bundler library, users need to know if it can be integrated into their TypeScript codebase, so its language is specified as TypeScript. If some language in the schema's enum is omitted, it can be added through a pull request to the AsyncAPI website repository.

enum: Go Java JavaScript HTML C/C++ C# Python TypeScript Kotlin Scala Markdown YAML R Rubby Rust Shell Groovy

description: Provide a list of different technologies used in the tool. Put details useful for tool user and tool contributor.

enum:
Node js
Hermes
React JS
.NET
ASP.NET
Springboot
AWS
Docker
Node-red
Maven
Saas
Kubernetes-native
Scala
Azure
Jenkins
Flask

description: Categories are used to group tools by different use case, like documentation or code generation. If have a list of fixed categories. If you use different one that your tool lands under "other" category. Feel free to add your category through a pull request to AsyncAPI website repository.

enum: api code-first code-generator converter directory documentation-generator editor ui-component dsl framework github-action mocking-and-testing validator compare-tool other cli bundler ide-extension

description: Indicate if your tool is open source or commercial offering, like SAAS for example


testenvironments.json

required: name type

$ref: #/definitions/docker

$ref: #/definitions/wsl

$ref: #/definitions/ssh

$ref: #/definitions/remote

description: User-friendly environment name that will appear in the TestExplorer list. It must be unique within a testEnvironments.json file.

description: Path on the local machine (either absolute or relative to the solution directory) which is projected into the remote environment. If not specified, this will default to the repo root within the context of a git repo (on VS 17.1 and above). Outside a git repo, this would default to the solution directory.

description: Name of a docker image to load in a docker env. dockerImage or dockerFile must be specified, but not both.

description: Path to a Dockerfile, relative to the solution directory, to build an image and load in a docker env. dockerImage or dockerFile must be specified, but not both.

description: Name of the local WSL distribution in which to run the test environment.

description: A uri that specifies the connection to the remote machine. e.g. ssh://user@hostname:22

description: A uri that specifies the connection to the remote machine. e.g. tcp://hostname:2358

$ref: #/definitions/config

title: Schema for Visual Studio's test environment config


frogbot-schema.json

title: Frogbot Configuration Schema

description: The configuration required for Frogbot to scan your Git repositories.

title: Project Parameters

description: Includes the configuration of a single Git repository that needs to be scanned. For Azure Repos, Bitbucket Server and GitHub with JFrog Pipelines or Jenkins, you can define multiple 'params' sections one after the other, for scanning multiple Git repositories in the same organization.

$ref: #/$git

$ref: #/$scan

$ref: #/$jfrogPlatform

title: Git Parameter

description: Includes the required Git parameters such as repository name and branches.

required: repoName branches

title: Repository Name

description: The name of the git repository to scan.

title: Repository Branches

description: A list of branches to scan.

title: Repository Branch

examples: fix(dependency) update ${IMPACTED_PACKAGE} to ${FIX_VERSION}

default: false

repoName: repo-name

title: Frogbot Scanning Parameters

description: Includes the scanning parameters such as the required scanning directories.

description: Set to true to display all existing vulnerabilities, including the ones that were not added by the pull request.

title: Include All Vulnerabilities

description: Set to true to fail the job if security issues were found.

title: Fail on Security Issues

description: Set the minimum severity for vulnerabilities that should be fixed and commented on in pull requests.

title: Minimum vulnerability severity to filter

description: Handle vulnerabilities with fix versions only.

description: List of email addresses to receive emails about secrets that has been detected in a pull request scan.

title: Email Address

title: Projects in Git Repository

description: A list of sub-projects / project dirs inside the Git repository.

title: Install Command

description: An installation command to run to resolve the project dependencies.

examples:
nuget restore
dotnet restore

title: Working Directories

description: A list of relative paths to the projects directories in the git repository.

title: Working Directory

examples: . npm-project/ go/project-1/

title: Pip Requirements File

description: The requirements file name that used to install dependencies in case of Pip package manager.

title: Use Gradle Wrapper

description: Set to false to avoid using the Gradle wrapper.

title: Virtual Artifactory Repository

description: Name of a Virtual Repository in Artifactory to resolve (download) the project dependencies from

title: JFrog Platform Parameters

description: Includes the JFrog platform related parameters such as Project Watches.

title: JFrog Project Key

description: The JFrog project. Learn more about it here: https://www.jfrog.com/confluence/display/JFROG/Projects.

title: JFrog Watches

description: JFrog Watches. Learn more about them here: https://www.jfrog.com/confluence/display/JFROG/Configuring+Xray+Watches.

title: JFrog Watch


jscsrc.json

enum: catch do else finally for function if try while

enum: ArrayExpression ArrayPattern ArrowFunctionExpression AssignmentExpression AssignmentPattern BinaryExpression BlockStatement BreakStatement CallExpression CatchClause ClassBody ClassDeclaration ClassExpression ConditionalExpression ContinueStatement DebuggerStatement DoWhileStatement EmptyStatement ExportAllDeclaration ExportDefaultDeclaration ExportNamedDeclaration ExportSpecifier ExpressionStatement ForInStatement ForStatement FunctionDeclaration FunctionExpression Identifier IfStatement ImportDeclaration ImportDefaultSpecifier ImportNamespaceSpecifier ImportSpecifier LabeledStatement Literal LogicalExpression MemberExpression MethodDefinition NewExpression ObjectExpression ObjectPattern Program Property RestElement ReturnStatement SequenceExpression SpreadElement Super SwitchCase SwitchStatement TaggedTemplateExpression TemplateElement TemplateLiteral ThisExpression ThrowStatement TryStatement UnaryExpression UpdateExpression VariableDeclaration VariableDeclarator WhileStatement WithStatement

description: Validate jsdoc comments.

description: Checks whether tag names are valid.

type: boolean null object string

$ref: #/definitions/nullRule

description: By default, any tag from any preset is allowed.  You can pass Object to select preset with preset field and add custom tags with extra field.

description: Add custom tags with the extra field.  The extra field should contain tags in keys with true, false, or "some" for the values.

type: boolean string

description: There are 3 presets:  Closure Compiler, JSDoc3 and JSDuck5.

description: Checks whether all parameters are documented.

description: Checks whether param names in jsdoc and in function declaration are equal.

description: Checks whether params in jsdoc contains type.

description: Reports redundant params in jsdoc.

description: Checks for differences between the jsdoc and actual return types if both exist.

description: Report statements for functions without a return, which are described with an @return tag.

description: Checks whether @returns in jsdoc contains type.

description: Reports invalid types for bunch of tags.

type: boolean null string

description: Can equal "strictNativeCase" or "capitalizedNativeCase".

description: The strictNativeCase mode checks that case of natives is the same as in this list: boolean, number, string, Object, Array, Date, RegExp.

description: The capitalizedNativeCase mode checks that the first letter in all native types and primitives is uppercased except the case with function in google closure format:  {function(...)}.

description: Reports redundant access declarations.

description: If an @access tag is specified, the function name must contain a leading _underscore.

description: If an @access tag is specified, the function name must contain a trailing underscore_.

description: Checks whether access declaration is set for _underscored function names.  Ignores a bunch of popular identifiers: __filename, __dirname, __proto__, __defineGetter__, super_, __constructor, etc.

description: true (means not public).  Report if @private or @protected is absent from _underscored function names.

description: Enforce only @private for all _underscored function names.

description: Enforce only @protected for all _underscored function names.

description: Checks whether jsdoc block exists.

description: An object that contains an "allExcept" key equal to an array of exception values.

description: Array of quoted keywords to exempt.

description: Skip expression functions.

description: Skip module.exports = function () {};

description: Functions without parameters and with empty return statements will be skipped.

description: Deprecated in favor of the object "allExcept": ["exports"] rule format.

description: Skip expression functions.

description: Checks whether a jsdoc param description has a hyphen before it (checks for -).

description: Checks whether a jsdoc comment description has a padding (trailing) newline separator between it and additional @tags.

description: Checks whether a jsdoc comment description has no padding (trailing) newline separator between it and additional @tags.

description: Checks whether a jsdoc comment description is a complete sentence.  A complete sentence is defined as starting with an upper case letter and ending with a period.

description: Checks whether a jsdoc param description exists.

description: Checks whether a jsdoc return description exists.

enum: break case catch continue debugger default delete do else finally for function if in instanceof new return switch this throw try typeof var void while with

type: array boolean null

$ref: #/definitions/keywords

description: Removes the rule.

description: Path to load additional rules

description: Requires that a function expression be named. Named functions provide more information in the error stack trace than anonymous functions.  This option does not help if you use Arrow functions (ES6) which are always anonymous.

description: Disallows arrow functions.

description: Requires the first alphabetical character of a comment to be lowercase.

description: Disallows commas as last token on a line in lists.

type: boolean null object

description: For default behavior (strict mode, comma on the same line).

description: An object that contains an "allExcept" key equal to an array of quoted exceptions.

description: Array of quoted keywords to exempt.

description: Disallows curly braces after statements.

description: Disallows identifiers that start or end in _.  Some popular identifiers are automatically listed as exceptions:  __proto__ (javascript), _ (underscore.js), __filename (node.js global), __dirname (node.js global), super_ (node.js, used by util.inherits).

description: Array of quoted keywords to exempt.

description: Disallows empty blocks (except for catch blocks).

description: For default behavior (strict mode, no empty blocks allowed).

description: Array of quoted keywords to exempt.  Blocks containing only comments would not be considered empty.

description: Disallows function declarations.

description: Disallows identical destructuring names for the key and value in favor of using shorthand destructuring.

description: Disallows a specified set of identifier names.

description: An array of strings, which should be disallowed as identifier names.

description: Disallows implicit type conversion.

enum: numeric boolean binary string

description: Disallows one or more keywords in comments.

type: array boolean null string

description: An array of strings, which should be disallowed keywords in comments.

description: If true, "TODO" and "FIXME" will be disallowed in comments.

description: A valid Regular Expression.

description: Disallows placing the specified keywords on a new line.

description: Disallows usage of the specified keywords.

description: Requires lines to not contain both spaces and tabs consecutively, or spaces after tabs only for alignment if "smart

description: Disallows the test, consequent and alternate to be on separate lines when using the ternary operator.

description: Disallows multiple blank lines in a row.

description: Disallows strings that span multiple lines without using concatenation.

description: Disallows multiple indentation characters (tabs or spaces) between identifiers, keywords, and any other token.

description: An object that contains a "allowEOLComments" key equal to a boolean.

description: Disallows multiple `var` declaration (except for-loop).

description: Array of quoted keywords to exempt.

description: Allows declarations where all variables are importing external modules with require.

description: Allows declarations where all variables are not defined.

description: Disallows unassigned functions to be named inline.

description: Disallows nested ternaries.

description: An object that contains a "maxLevel" property equal to an integer indicating the maximum levels of nesting to be allowed.

description: The maximum levels of ternary nesting to be allowed.

description: Disallows newline before opening curly brace of all block statements.

type: array boolean null object

$ref: #/definitions/blockKeywords

description: A value of true will always disallow newline before curly brace of block statements.

description: An object that contains a "value" key equal to a boolean or an array, and / or an "allExcept" key equal to an array of quoted exceptions.

type: array boolean

description: Array of quoted keywords to exempt.  If `multiline` is specified, when the conditions span on multiple lines, require a new line before the curly brace.

description: Disallow use of certain node types (from Esprima/ESTree).  Value equals an array of parser node types to be disallowed.

$ref: #/definitions/esprimaNodeTypes

description: Disallows the not, not equals, and strict not equals operators in conditionals.

description: Disallows placing object keys on new line.

description: Requires putting certain operators on the next line rather than on the current line before a line break.

$ref: #/definitions/operators

description: Disallow a newline after blocks.

description: Disallow a blank line after 'use strict'; statements.

description: Disallows newline before module.exports.

description: Disallow an empty line above the specified keywords.

description: Disallows newline before line comments.

description: Disallows blocks from beginning or ending with 2 newlines.

description: A value of true validates all non-empty blocks.

description: An object that contains a "open" key equal to a boolean, an "close" key equal to a boolean, and / or an "allExcept" key equal to an array of quoted exceptions.

description: A value of true validates that there is a newline before the closing brace in a block.  A value of false ignores the newline validation before the closing brace in a block.

description: A value of true validates that there is a newline after the opening brace in a block.  A value of false ignores the newline validation after the opening brace in a block.

description: Array of quoted keywords to exempt.  If `conditionals` is specified, conditionals (if, else if, else) blocks are ignored.  If `functions` is specified, function blocks are ignored.

description: Disallows newlines adjacent to curly braces in all object literals.

description: Disallows parentheses around arrow function expressions that contain a single parameter.

description: Disallows quoted keys in object if possible.

description: Set to true for strict mode.

description: Array of quoted keywords to exempt.

description: Allows ES3+ reserved words to remain quoted which is helpful when using this option with JSHint's es3 flag.

description: Deprecated in favor of the object "allExcept": ["reserved"] rule format.

description: Disallows lines from ending in a semicolon.

description: Require arrow functions to use a block statement (explicit return).

description: Requires sticking binary operators to the right.

description: Disallows spaces after commas.

description: A value of true will disallow any spaces after any comma.

description: Array of quoted keywords to exempt.

description: Allow spaces in place of absent values in sparse arrays.

description: Disallows space after the specified keywords.  A value of true will require spaces after all possible keywords.

description: Requires that a line comment (//) not be followed by a space.

description: Disallows space after object keys.

description: Array of quoted keywords to exempt.

description: Ignores objects if the object only takes up a single line.

description: Ignores objects if the object takes up multiple lines.

description: Ignores aligned object properties.

description: Ignores method declarations.

description: Deprecated in favor of the object "allExcept": [] rule format.

description: Requires sticking unary operators to the right.

description: Requires sticking binary operators to the left.

description: Disallows space before block statements (for loops, control structures).

description: Disallows spaces before commas.

description: A value of true will disallow any spaces before any comma.

description: Array of quoted keywords to exempt.

description: Skip expression functions.

description: Disallows space before keyword.

description: Disallows space before object values.

description: Requires sticking unary operators to the left.

description: Disallows spaces before semicolons.

description: A value of true will disallow any spaces before any semicolon.

description: An object that contains an "allExcept" key equal to an array of exception tokens.

description: Array of quoted tokens to exempt (allows whitespace before semicolon if preceded by the specified token).

description: Ensure there are no spaces after argument separators in call expressions.

description: Disallows space before () or {} in anonymous function expressions.

description: Disallows space before () in call expressions.

description: Disallows space before and/or after ? or : in conditional expressions.

description: A value of true will set all properties [afterTest, beforeConsequent, afterConsequent, beforeAlternate] to true.

description: An object that contains keys of type boolean.

description: Disallow spaces in between for statement.

description: Disallows space before `()` or `{}` in function expressions (both named and anonymous) and function declarations.

description: Disallows space before () or {} in function declarations.

description: Disallows space before `()` or `{}` in function expressions (both named and anonymous).

description: Disallow space before or after * in generator functions.

description: At least one of the object properties must be present and it must be set to true.

description: A value of true disallows space before *.

description: A value of true disallows space after *.

description: Disallows space before () or {} in named function expressions

description: Disallows space after opening array square bracket and before closing.  Reports only on arrays, not on property accessors.  Use disallowSpacesInsideBrackets to report on all brackets.

description: Use "all" or true for strict mode.

description: Array of quoted tokens to exempt.  Tokens should consist of an opener with a matching closer () {} [] etc.

description: Tokens should consist of an opener with a matching closer () {} [] etc.

description: Disallows space after opening square bracket and before closing.  Reports on all on brackets, even on property accessors.  Use disallowSpacesInsideArrayBrackets to exclude property accessors.

description: Use true for strict mode.

description: Disallows space after opening object curly brace and before closing.

description: Use "all" or true for strict mode.

description: Array of quoted tokens to exempt.  Applies only to closer tokens:  e.g. ) } ].  If a (closer) token is specified, the rule ignores contiguous (closer) tokens.

description: Tokens should consist of an closer:  ) } ] etc.

description: Disallows space after opening round bracket and before closing.

description: An object that contains an "only" key equal to an array of values which indicate where to apply this rule.

description: Array of quoted values to target.

description: Disallows space after opening and before closing grouping parentheses.

description: If true, always disallow spaces inside grouping parentheses.

description: Array of quoted tokens or items to exempt.  Tokens should consist of an opener with a matching closer () {} [] or `function`.

description: Tokens should consist of an opener with a matching closer () {} [] etc. or `function`.

description: Disallows spaces before and after curly brace inside template string placeholders.

description: Disallows tabs everywhere.

description: Disallows an extra comma following the final element of an array or object literal.

description: Requires all lines to end on a non-whitespace character.

description: Use "ignoreEmptyLines" to allow whitespace on empty lines (default is false).

description: Disallows unused params in function expression and function declaration.

description: Disallows declaring variables with var.

description: Requires the variable to be the left hand operator when doing a boolean comparison.  Array of quoted operators or true to disallow yoda conditions for most possible comparison operators.

description: Disables style checking for specified paths.

description: Requires all lines to be at most the number of characters specified.

description: Lines should be at most the number of characters specified.

description: An object that contains an "allExcept" key equal to an array an array of conditions that will exempt a line, in addition to other attributes.

description: Array of conditions that will exempt a line.

description: Allows comments to break the rule.

description: Allows function definitions to break the rule.

description: Allows regular expression literals to break the rule.

description: Allows require expressions to break the rule.

description: Allows comments with long urls to break the rule.

description: Considered the tab character as number of specified spaces.

description: Requires the file to be at most the number of lines specified.

description: File should be at most the number of lines specified.

description: Allows comments to break the rule.

description: Extends defined rules with preset rules.

enum: airbnb crockford google grunt idiomatic jquery mdcs node-style-guide wikimedia wordpress yandex

description: Enforces indentation of parameters in multiline functions.

description: If true, require parameters to align with the body of the function.

description: The number of columns the parameters should be indented past the function body.

description: Use `firstParam` to require parameters on a new line to be aligned with the first parameter(s) on the previous line.

description: Requires proper alignment in object literals.

description: Use for strict mode.

description: Ignores objects if one of the property values is a function expression.

description: Ignores objects if there are line breaks between properties.

description: Requires that a function expression be anonymous.

description: Array of quoted keywords to exempt.

description: Ignores function declarations.

description: Requires that variable assignment from array values are * destructured.

description: Requires that arrow functions are used instead of anonymous function expressions in callbacks.

description: Requires blocks to begin and end with a newline.

description: If true, validates all non-empty blocks.

description: Specifies a minimum number of lines containing elements in the block before validating.

description: If true, includes comments as part of the validation.

description: Requires identifiers to be camelCased or UPPERCASE_WITH_UNDERSCORES.

description: An object that contains an "allExcept" key equal to an array of exception values, in addition to other attributes.

description: Array of String, RegExp, or ESTree RegExpLiteral values permitted as exceptions.

description: Array of String, RegExp, or ESTree RegExpLiteral values permitted as prefixes.

description: Array of String, RegExp, or ESTree RegExpLiteral values permitted as suffixes.

description: If true, allows an exception for object property names.

description: If true, forces the first character to not be capitalized.

description: Deprecated in favor of the object "ignoreProperties" rule format.

description: Requires the first alphabetical character of a comment to be uppercase, unless it is part of a multi-line textblock.  This rule automatically ignores jscs, jshint, eslint, and istanbul specific comments.

description: An object that contains an "allExcept" key equal to an array of quoted exceptions, in addition to other attributes.

description: Array of quoted keywords to exempt.

description: If true, ignore comments in the middle of the code line.

description: Requires capitalized constructors to to use the new keyword.

description: Array of quoted keywords to exempt.

description: Requires constructors to be capitalized (except for "this")

description: Array of quoted keywords to exempt.

description: Requires commas as last token on a line in lists.

description: Requires curly braces after statements.  A value of true will require curly braces for all the necessary keywords:  if, else, for, while do, try, catch, case, and default.

description: An object that contains a "keywords" or "allExcept" key equal to an array of quoted exceptions.

description: Array of quoted keywords that would require curly braces.

description: Array of quoted keywords to exempt.  Allows not using braces in some instances; ex.  /*allowed:*/ if (x) return; /* not allowed*/ if (x) i++; given "allExcept": ["return", "continue", "break", ...],

description: Require a $ before variable names that are jquery assignments.

description: Requires member expressions to use dot notation when possible.

description: Array of quoted keywords to exempt.

description: Allow quoted identifiers made of reserved words.

description: Allow quoted snake cased identifiers.

description: Deprecated in favor of the object "allExcept": ["snake_case"] rule format.

description: Allow quoted snake cased identifiers.

description: Requires early return in a function.

description: If true, disallow the use of `else` if the corresponding parent `if` block contains a return.

description: Requires declaring objects via ES6 enhanced object literals.

description: Requires function declarations by disallowing assignment of functions expressions to variables. Function expressions are allowed in all other contexts, including when passed as function arguments or immediately invoked.  Assignment of function expressions to object members is also permitted, since these can't be declared.

description: Requires imports to be alphabetized (A-Z).

description: Requires placing the specified keywords on a new line.

description: Requires placing line feed after assigning a variable.

description: Requires placing line feed at file end.

description: Requires function names to match member and property names.  It doesn't affect anonymous functions nor functions assigned to members or properties named with a reserved word.  Assigning to module.exports is also ignored, unless includeModuleExports: true is configured.

description: An object that contains an "includeModuleExports" key of boolean type.

description: Requires the test, consequent and alternate to be on separate lines when using the ternary operator.

description: Requires multiple `var` declaration.

description: If true, it will report only consecutive vars.

description: Array of quoted keywords to exempt.

description: `require` statements are allowed to have a var declaration per variable.

description: If equal to 'onevar', requireMultipleVarDecl will allow only one var per function scope.

description: Require unassigned functions to be named inline.

description: Array of quoted keywords to exempt.

description: Requires newline before opening curly brace of all block statements.  If true, always requires newline before curly brace of block statements.  Array specifies block-type keywords after which newlines are required before curly brace.

description: Requires use of binary, hexadecimal, and octal literals instead of parseInt.

description: Requires variable declarations from objects via destructuring.

description: Requires placing object keys on new line.

description: Array of quoted keywords to exempt.

description: Ignores the rule if all the keys and values are on the same line.

description: Requires operators to appear before line breaks and not after.

description: Requires an extra blank newline after var declarations, as long as it is not the last expression in the current block.

description: Requires newline after blocks.

description: If true, always require a newline after blocks.

description: Array of quoted keywords to exempt.

description: Blocks don't need a line of padding in function argument lists.

description: Blocks don't need a line of padding in constructor argument lists.

description: Blocks don't need a line of padding in arrays.

description: Blocks don't need a line of padding as object properties.

description: Requires a blank line after 'use strict'; statements.

description: If true, require blank line after 'use strict' statements.

description: Array of quoted keywords to exempt.

description: Allows 'require' statements to occur immediately after 'use strict'.

description: Requires newline before module.exports.

description: Requires an empty line above the specified keywords unless the keyword is the first expression in a block.  If true, specifies that the spacedKeywords found in the utils module require an empty line above it.  Array values indicate keywords that require an empty line above it.

description: Requires newline before line comments.

description: If true, always require a newline before line comments.

description: Array of quoted keywords to exempt.

description: Comments may be first line of block without extra padding.

description: Requires blocks to begin and end with 2 newlines.

description: At least one of the object properties must be true.

description: If true, validates that there is a newline after the opening brace in a block.

description: If true, validates that there is a newline before the closing brace in a block.

description: Array of quoted keywords to exempt.

description: Ignores conditional (if, else if, else) blocks.

description: Ignores function blocks.

description: Requires newline inside curly braces of all objects.

description: Requires parentheses around arrow function expressions with a single parameter.

description: Requires parentheses around immediately invoked function expressions.

description: Requires quoted keys in objects.

description: Requires semicolon after:  var declaration, expression statement, return, throw, break, continue, do-while.

description: Require arrow functions to use an expression body when returning a single statement (no block statement, implicit return).

description: Disallows sticking binary operators to the right.

description: Requires space after comma.

description: If true, require a space after any comma.

description: Array of quoted keywords to exempt.

description: Ignore trailing commas.

description: Requires space after the specified keywords.  A value of true will disallow spaces after all possible keywords.

description: Requires that a line comment (`//`) be followed by a space.

description: Array of allowed strings before space.

description: Deprecated in favor of the object "allExcept": ["/"] rule format.

description: Requires space after object keys.

description: Disallows sticking unary operators to the right.

description: Disallows sticking binary operators to the left.

description: Requires space before block statements (for loops, control structures).

description: If true, require at least a single space.

description: Require at least the specified number of spaces.  Value must be greater than or equal to 1.

description: Requires a space before a comma.

description: If true, require a space before any comma.

description: Requires a space before a keyword.

description: If true, report on all possible ES3 keywords except `function`.

description: Array of allowed strings before space.

description: Requires space after object keys.

description: Disallows sticking unary operators to the left.

description: Ensure there are spaces after argument separators in call expressions.

description: Requires space before `()` or `{}` in function expressions (both named and anonymous).

description: An object with the following properties (one of "beforeOpeningRoundBrace" and "beforeOpeningCurlyBrace" must be provided):

description: A boolean or an array of quoted exceptions.

description: If true, enable all configuration exceptions.

description: Array of quoted keywords to exempt.

description: If "shorthand" is provided, spaces will not be required for ES6 method definitions.

description: Requires space before `()` in call expressions.

description: Requires space before and/or after `?` or `:` in conditional expressions.

description: If true, set all properties to true.

description: Requires spaces in between `for` statement.

description: Requires space before `()` or `{}` in function expressions (both named and anonymous) and function declarations.

description: Requires space before `()` or `{}` in function declarations.

description: Requires space before and after `*` in generator functions.

description: An object where at least one of its properties must be present and it must be set to true.

description: If true, validates that there is a space before `*`.

description: If true, validates that there is a space after `*`.

description: Requires space before `()` or `{}` in named function expressions.

description: Requires space after opening array square bracket and before closing.  Reports only on arrays, not on property accessors.  Use requireSpacesInsideBrackets to report on all brackets.

description: Array of quoted tokens that can occur after an opening square bracket or before a closing square bracket without a space.

description: Strict mode.

description: Deprecated in favor of the object "allExcept": ["[", "]"] format.

description: Requires space after opening square bracket and before closing.  Reports on all on brackets, even on property accessors.  Use requireSpacesInsideArrayBrackets to exclude property accessors.

description: For default behavior (strict mode).

description: Requires space after opening object curly brace and before closing.

description: Array of quoted tokens that can occur after an opening object brace or before a closing object brace without a space.

description: Strict mode.

description: Deprecated in favor of the object "allExcept": ["}"] format.

description: Requires space after opening round bracket and before closing.

description: An object that contains an "except" key equal to an array of exception tokens, in addition to other attributes.

description: Array of quoted tokens that can occur after an opening bracket or before a closing bracket without a space.

description: Strict mode.

description: Deprecated in favor of the object "except": ["(", ")"] format.  Ignores nested brackets in a row.

description: Requires space after opening and before closing grouping parentheses.

description: If true, always require spaces inside grouping parentheses.

description: Array of quoted keywords to exempt.

description: Ignore parenthesized objects and functions.

description: Disallows using `.apply` in favor of the spread operator.

description: If true, specifies that apply `.apply` is disallowed.

description: Requires the use of template strings instead of string concatenation.

description: Array of quoted keywords to exempt.

description: Ignores strings concatenated with other strings.

description: Requires an extra comma following the final element of an array or object literal.

description: If true, validates all arrays and objects.

description: If true, allows single property objects and single element arrays to not require a trailing comma.

description: If true, allows objects and arrays on a single line to not require a trailing comma.

description: Requires `var` declaration to be on the top of an enclosing scope.

description: If true, specifies that `var` declarations must occur the top of a function scope.

description: Requires the variable to be the right hand operator when doing a boolean comparison.  An array of quoted operators can be supplied to indicate which operators requires yoda conditions.

description: If true, specifies that yoda conditions are required for most possible comparison operators.

description: Option to check `var that = this` expressions.

description: Array of quoted keywords that can be assigned to `this` context.

description: Represents the keyword that can be assigned to `this` context.

description: Validates proper alignment of function parameters.

description: If true, this is the same as validating the rule using `{lineBreakAfterOpeningBrace: true, lineBreakBeforeClosingBrace: true}`.

description: If true, specifies that the first function parameter must not be on the same line as the opening parenthesis `(` of the function parameters list.

description: If true, specifies that the last function parameter must not be on the same line as the closing parenthesis `)` of the function parameters list.

description: This rule is for validating the positioning of line comments.  Block comments are ignored.  Comments that start with the following keywords are also ignored:  `eslint`, `jshint`, `jslint`, `istanbul`, `global`, `exported`, `jscs`, `falls through` eg. // jshint strict: true

description: Array of quoted exceptions (comments that start with these values will be excepted).

description: Validates indentation for switch statements and block statements.

description: A positive number of spaces.

description: Deprecated.  Require empty lines to be indented.

description: Array of quoted exceptions.

description: Ignores comments.

description: Ignores empty lines, included by default.

description: Option to check line break characters.

description: If true, specifies that validation for the file should stop running upon encountering the first rule violation and return the details of that violation in the report.

description: Setting this is the same as validating the rule using `{character: String, reportOncePerFile: false}`.

description: Requires each element in array on a single line when array length is more than passed maximum number or array fills more than one line.

description: If true, this is the same as validating the rule using `{maximum: Infinity, ignoreBrackets: false}`.

description: Setting this is the same as validating the rule using `{maximum: Integer, ignoreBrackets: false}`.

description: If true, specifies that the `[` and `]` brackets can be placed on the same line as the array elements.

description: Validates the order in object keys.

description: If true, alias to `asc`.

description: Requires sorting in ascending order.

description: Requires sorting in ascending order (case-insensitive).

description: Requires sorting in ascending natural order.

description: Requires sorting in descending order.

description: Requires sorting in descending order (case-insensitive).

description: Requires sorting in descending natural order.

description: Enable validation of separators between function parameters.  Will ignore newlines.

description: Function parameters are immediately followed by a comma.

description: Function parameters are immediately followed by a comma and then a space.

description: Function parameters are immediately followed by a space and then a comma.

description: Function parameters are immediately followed by a space, a comma, and then a space.

description: Requires all quote marks to be either the supplied value, or consistent if `true`.

description: If true, all strings require the quote mark first encountered in the source code.

description: Allow the "other" quote mark to be used, but only to avoid having to escape.

description: The same effect as the non-object values.

description: All strings require double quotes.

description: All strings require single quotes.

description: Ignore JSX nodes.

description: All strings require double quotes.

description: All strings require single quotes.

title: JSON schema for JSCS configuration files


commitlintrc.json

description: A rule

type: array

description: Level: 0 disables the rule. For 1 it will be considered a warning, for 2 an error

description: Applicable: always|never: never inverts the rule

type: string

enum: always never

description: Value: the value for this rule

description: Resolvable ids to commitlint configurations to extend

description: Resolvable id to conventional-changelog parser preset to import and use

type: object

description: Custom URL to show upon failure

description: Resolvable id to package, from node_modules, which formats the output

description: Rules to check against

$ref: #/definitions/rule

description: Resolvable ids of commitlint plugins from node_modules

description: Additional commits to ignore, defined by ignore matchers

description: Whether commitlint uses the default ignore rules