schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
package.json
licenses
DEPRECATED: Instead, use SPDX expressions, like this: { "license": "ISC" } or { "license": "(MIT OR Apache-2.0)" } see: 'https://docs.npmjs.com/files/package.json#license'.
{"type": "array", "items": {"type": "object", "properties": {"type": {}, "url": {"type": "string", "format": "uri"}}}}
package.json
contributors
A list of people who contributed to this package.
{"type": "array", "items": {}}
package.json
maintainers
A list of people who maintains this package.
{"type": "array", "items": {}}
package.json
files
The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.
{"type": "array", "items": {"type": "string"}}
package.json
main
The main field is a module ID that is the primary entry point to your program.
{"type": "string"}
package.json
exports
The "exports" field is used to restrict external access to non-exported module files, also enables a module to import itself using "name".
{"oneOf": [{}, {"type": "object", "properties": {".": {}}, "patternProperties": {"^\\./.+": {}}, "additionalProperties": false}, {}, {}]}
package.json
exports
The module path that is resolved when the module specifier matches "name", shadows the "main" field.
{}
package.json
.
The module path that is resolved when the module specifier matches "name", shadows the "main" field.
{}
package.json
^\./.+
The module path prefix that is resolved when the module specifier starts with "name/", set to "./*" to allow external modules to import any subpath.
{}
package.json
exports
The module path that is resolved when the module specifier matches "name", shadows the "main" field.
{}
package.json
exports
The module path that is resolved when the module specifier matches "name", shadows the "main" field.
{}
package.json
type
When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.
{"type": "string", "enum": ["commonjs", "module"], "default": "commonjs"}
package.json
types
Set the types property to point to your bundled declaration file.
{"type": "string"}
package.json
typings
Note that the "typings" field is synonymous with "types", and could be used as well.
{"type": "string"}
package.json
typesVersions
The "typesVersions" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.
{"type": "object", "additionalProperties": {"type": "object", "properties": {"*": {"type": "array", "items": {"type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$"}}}, "patternProperties": {"^[^*]+$": {"type": "array", "items": {"type": "string"}}, "^[^*]*\\*[^*]*$": {"type": "array", "items": {"type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$"}}}, "additionalProperties": false}}
package.json
additionalProperties
Contains overrides for the TypeScript version that matches the version range matching the property key.
{"type": "object", "properties": {"*": {"type": "array", "items": {"type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$"}}}, "patternProperties": {"^[^*]+$": {"type": "array", "items": {"type": "string"}}, "^[^*]*\\*[^*]*$": {"type": "array", "items": {"type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$"}}}, "additionalProperties": false}
package.json
*
Maps all file paths to the file paths specified in the array.
{"type": "array", "items": {"type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$"}}
package.json
^[^*]+$
Maps the file path matching the property key to the file paths specified in the array.
{"type": "array", "items": {"type": "string"}}
package.json
^[^*]*\*[^*]*$
Maps file paths matching the pattern specified in property key to file paths specified in the array.
{"type": "array", "items": {"type": "string", "pattern": "^[^*]*(?:\\*[^*]*)?$"}}
package.json
man
Specify either a single file or an array of filenames to put in place for the man program to find.
{"type": ["array", "string"], "items": {"type": "string"}}
package.json
bin
If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.
{"type": "string"}
package.json
doc
Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.
{"type": "string"}
package.json
example
Put example scripts in here. Someday, it might be exposed in some clever way.
{"type": "string"}
package.json
lib
Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.
{"type": "string"}
package.json
man
A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.
{"type": "string"}
package.json
repository
Specify the place where your code lives. This is helpful for people who want to contribute.
{"type": ["object", "string"], "properties": {"type": {"type": "string"}, "url": {"type": "string"}, "directory": {"type": "string"}}}
package.json
scripts
The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.
{"type": "object", "properties": {"lint": {"type": "string"}, "prepublish": {"type": "string"}, "prepare": {"type": "string"}, "prepublishOnly": {"type": "string"}, "prepack": {"type": "string"}, "postpack": {"type": "string"}, "publish": {"type": "string"}, "postpublish": {}, "preinstall": {"type": "string"}, "install": {}, "postinstall": {}, "preuninstall": {}, "uninstall": {}, "postuninstall": {"type": "string"}, "preversion": {}, "version": {}, "postversion": {"type": "string"}, "pretest": {}, "test": {}, "posttest": {}, "prestop": {}, "stop": {}, "poststop": {}, "prestart": {}, "start": {}, "poststart": {}, "prerestart": {}, "restart": {}, "postrestart": {}, "serve": {"type": "string"}}, "additionalProperties": {"type": "string", "tsType": "string | undefined", "x-intellij-language-injection": "Shell Script"}}
package.json
lint
Run code quality tools, e.g. ESLint, TSLint, etc.
{"type": "string"}
package.json
prepublish
Run BEFORE the package is published (Also run on local npm install without any arguments).
{"type": "string"}
package.json
prepare
Run both BEFORE the package is packed and published, and on local npm install without any arguments. This is run AFTER prepublish, but BEFORE prepublishOnly.
{"type": "string"}
package.json
prepublishOnly
Run BEFORE the package is prepared and packed, ONLY on npm publish.
{"type": "string"}
package.json
prepack
run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies).
{"type": "string"}
package.json
postpack
Run AFTER the tarball has been generated and moved to its final destination.
{"type": "string"}
package.json
publish
Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish
{"type": "string"}
package.json
preinstall
Run BEFORE the package is installed.
{"type": "string"}
package.json
postuninstall
Run AFTER the package is uninstalled.
{"type": "string"}
package.json
postversion
Run AFTER bump the package version.
{"type": "string"}
package.json
serve
Start dev server to serve application files
{"type": "string"}
package.json
config
A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.
{"type": "object", "additionalProperties": true}
package.json
peerDependenciesMeta
When a user installs your package, warnings are emitted if packages specified in "peerDependencies" are not already installed. The "peerDependenciesMeta" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": true, "properties": {"optional": {"type": "boolean"}}}}
package.json
optional
Specifies that this peer dependency is optional and should not be installed automatically.
{"type": "boolean"}
package.json
bundledDependencies
Array of package names that will be bundled when publishing the package.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "boolean"}]}
package.json
bundleDependencies
DEPRECATED: This field is honored, but "bundledDependencies" is the correct field name.
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "boolean"}]}
package.json
resolutions
Resolutions is used to support selective version resolutions using yarn, which lets you define custom package versions or ranges inside your dependencies. For npm, use overrides instead. See: https://classic.yarnpkg.com/en/docs/selective-version-resolutions
{"type": "object"}
package.json
overrides
Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies. For yarn, use resolutions instead. See: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides
{"type": "object"}
package.json
packageManager
Defines which package manager is expected to be used when working on the current project. This field is currently experimental and needs to be opted-in; see https://nodejs.org/api/corepack.html
{"type": "string", "pattern": "(npm|pnpm|yarn)@\\d+\\.\\d+\\.\\d+(-.+)?"}
package.json
os
Specify which operating systems your module will run on.
{"type": "array", "items": {"type": "string"}}
package.json
cpu
Specify that your code only runs on certain cpu architectures.
{"type": "array", "items": {"type": "string"}}
package.json
preferGlobal
DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible.
{"type": "boolean"}
package.json
private
If set to true, then npm will refuse to publish it.
{"oneOf": [{"type": "boolean"}, {"enum": ["false", "true"]}]}
package.json
module
An ECMAScript module ID that is the primary entry point to your program.
{"type": "string"}
package.json
esnext
A module ID with untranspiled code that is the primary entry point to your program.
{"type": ["string", "object"], "properties": {"main": {"type": "string"}, "browser": {"type": "string"}}, "additionalProperties": {"type": "string"}}
package.json
workspaces
Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set "private" to true when using this feature.
{"anyOf": [{"type": "array", "items": {"type": "string"}}, {"type": "object", "properties": {"packages": {"type": "array", "items": {"type": "string"}}, "nohoist": {"type": "array", "items": {"type": "string"}}}}]}
package.json
workspaces
Workspace package paths. Glob patterns are supported.
{"type": "array", "items": {"type": "string"}}
package.json
packages
Workspace package paths. Glob patterns are supported.
{"type": "array", "items": {"type": "string"}}
package.json
nohoist
Packages to block from hoisting to the workspace root. Currently only supported in Yarn only.
{"type": "array", "items": {"type": "string"}}
minecraft-pack-mcmeta.json
A pack metadata https://minecraft.fandom.com/wiki/Data_pack
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": {"pack": {"type": "object", "properties": {"pack_format": {"type": "integer", "minimum": 4, "maximum": 15, "default": 4}}, "additionalProperties": false}, "filter": {"type": "object", "additionalProperties": {"type": "object", "properties": {"namespace": {"type": "string"}, "path": {"type": "string"}}, "additionalProperties": false}}}, "type": "object"}
minecraft-pack-mcmeta.json
pack
Options for the current pack https://minecraft.fandom.com/wiki/Data_pack#Contents
{"type": "object", "properties": {"pack_format": {"type": "integer", "minimum": 4, "maximum": 15, "default": 4}}, "additionalProperties": false}
minecraft-pack-mcmeta.json
description
A description for the current pack https://minecraft.fandom.com/wiki/Data_pack#Contents
{}
minecraft-pack-mcmeta.json
pack_format
A version for the current pack https://minecraft.fandom.com/wiki/Data_pack#Contents
{"type": "integer", "minimum": 4, "maximum": 15, "default": 4}
minecraft-pack-mcmeta.json
filter
Filter options for the current pack https://minecraft.fandom.com/wiki/Data_pack
{"type": "object", "additionalProperties": {"type": "object", "properties": {"namespace": {"type": "string"}, "path": {"type": "string"}}, "additionalProperties": false}}
minecraft-pack-mcmeta.json
additionalProperties
A pattern for the current pack https://minecraft.fandom.com/wiki/Data_pack
{"type": "object", "properties": {"namespace": {"type": "string"}, "path": {"type": "string"}}, "additionalProperties": false}
minecraft-pack-mcmeta.json
namespace
A namespace regular expression for the current pack https://minecraft.fandom.com/wiki/Data_pack
{"type": "string"}
minecraft-pack-mcmeta.json
path
A path regular expression for the current pack https://minecraft.fandom.com/wiki/Data_pack
{"type": "string"}
linkinator-config.json
concurrency
The number of connections to make simultaneously.
{"type": "number", "default": 100}
linkinator-config.json
config
The config file path.
{"type": "string"}
linkinator-config.json
recurse
By default, all scans are shallow. Only the top level links on the requested page will be scanned. By setting recurse to true, the crawler will follow all links on the page, and continue scanning links on the same domain for as long as it can go. Results are cached, so no worries about loops.
{"type": "boolean", "default": true}
linkinator-config.json
skip
List of urls in regexy form to not include in the check.
{"type": "string", "default": "www.googleapis.com"}
linkinator-config.json
format
Return the data in CSV or JSON format.
{"type": "string", "default": "json", "enum": ["json", "text", "csv"]}
linkinator-config.json
silent
If true, does not show links
{"type": "boolean", "default": false}
linkinator-config.json
verbosity
The output verbosity
{"type": "string", "default": "error"}
linkinator-config.json
timeout
By default, requests made by linkinator do not time out (or follow the settings of the OS). This option (in milliseconds) will fail requests after the configured amount of time.
{"type": "number", "default": "5000"}
linkinator-config.json
markdown
Automatically parse and scan markdown if scanning from a location on disk.
{"type": "boolean", "default": false}
linkinator-config.json
serverRoot
When scanning a locally directory, customize the location on disk where the server is started. Defaults to the path passed in path.
{"type": "string", "default": "./"}
linkinator-config.json
directoryListing
Automatically serve a static file listing page when serving a directory. Defaults to false.
{"type": "boolean", "default": false}
linkinator-config.json
retry
Automatically retry requests that respond with an HTTP 429, and include a retry-after header. The RetryConfig option is a placeholder for fine-grained controls to be implemented at a later time, and is only included here to signal forward-compatibility.
{"oneOf": [{"type": "boolean"}, {"type": "object"}]}
linkinator-config.json
retryErrors
Automatically retry requests that return 5xx or unknown response.
{"type": "boolean"}
linkinator-config.json
retryErrorsCount
How many times should an error be retried?
{"type": "number"}
linkinator-config.json
retryErrorsJitter
Random jitter applied to error retry.
{"type": "number"}
linkinator-config.json
urlRewriteExpressions
Collection of objects that contain a search pattern, and replacement.
{"type": "array"}
cicstags.json
Super-schema that describes all versions of 'CICS region tagging file JSON Schema.'
{"$schema": "http://json-schema.org/draft-07/schema#", "allOf": [{"if": {"properties": {"schemaVersion": {"const": "regionTagging/1.0.0"}}}, "then": {}}]}
cicstags.json
Schema that describes the contents of a CICS region tagging file.
{"if": {"properties": {"schemaVersion": {"const": "regionTagging/1.0.0"}}}, "then": {}}
browser.i18n.json
translationEntry
Translation key
{"type": "object", "properties": {"message": {"type": "string"}, "placeholders": {}}, "required": ["message"], "additionalProperties": false}
browser.i18n.json
message
Translation string
{"type": "string"}
browser.i18n.json
description
(optional): Description of this string for the translator team
{"type": "string"}
browser.i18n.json
placeholders
(optional): List of placeholders that can be used in the message.
{"type": "object", "additionalProperties": false, "patternProperties": {"^(?!@@)[@a-zA-Z0-9_-]+$": {}}}
browser.i18n.json
placeholder
Placeholder key
{"type": "object", "properties": {"content": {"type": "string"}, "example": {"type": "string"}}, "required": ["content"], "additionalProperties": false}
browser.i18n.json
content
Value to insert. It can contain a variable $1
{"type": "string"}
browser.i18n.json
example
(optional) example of this placeholder
{"type": "string"}
unist.json
Syntactic units in unist syntax trees are called nodes, and implement the Node interface.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": true, "definitions": {"Point": {"type": "object", "properties": {"column": {"type": "integer", "minimum": 1}, "line": {"type": "integer", "minimum": 1}, "offset": {"type": "integer", "minimum": 0}}, "required": ["column", "line"], "additionalProperties": false}, "Position": {"type": "object", "properties": {"end": {}, "start": {}}, "required": ["end", "start"], "additionalProperties": false}}, "properties": {"type": {"type": "string"}, "position": {}, "children": {"type": "array", "items": {}}, "data": {"type": "object", "additionalProperties": true}, "value": {}}, "required": ["type"], "type": "object"}
unist.json
Point
A point represents one place in a source file. The value of the point field implements the Point interface.
{"type": "object", "properties": {"column": {"type": "integer", "minimum": 1}, "line": {"type": "integer", "minimum": 1}, "offset": {"type": "integer", "minimum": 0}}, "required": ["column", "line"], "additionalProperties": false}
unist.json
column
The column field (1-indexed integer) represents a column in a source file.
{"type": "integer", "minimum": 1}
unist.json
line
The line field (1-indexed integer) represents a line in a source file.
{"type": "integer", "minimum": 1}
unist.json
offset
The offset field (0-indexed integer) represents a character in a source file.
{"type": "integer", "minimum": 0}
unist.json
Position
A position represents the location of a node in a source file. The value of the position field implements the Position interface. The position field must not be present if a node is generated.
{"type": "object", "properties": {"end": {}, "start": {}}, "required": ["end", "start"], "additionalProperties": false}
unist.json
end
The end field of Position represents the place of the first character after the parsed source region, whether it exists or not.
{}
unist.json
start
The start field of Position represents the place of the first character of the parsed source region.
{}
unist.json
type
The type field is a non-empty string representing the variant of a node. This field can be used to determine the type a node implements.
{"type": "string"}
unist.json
children
The children field is a list representing the children of a node.
{"type": "array", "items": {}}
unist.json
data
The data field represents information from the ecosystem. The value of the data field implements the Data interface.
{"type": "object", "additionalProperties": true}