1161 lines · 38.4 KB · JSON
RawDownload
{  "$schema": "http://json-schema.org/draft-07/schema#",  "title": "JSON schema for NPM package.json files",  "definitions": {    "person": {      "description": "A person who has been involved in creating or maintaining this package.",      "type": [        "object",        "string"      ],      "required": [        "name"      ],      "properties": {        "name": {          "type": "string"        },        "url": {          "type": "string",          "format": "uri"        },        "email": {          "type": "string",          "format": "email"        }      }    },    "dependency": {      "description": "Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.",      "type": "object",      "additionalProperties": {        "type": "string"      }    },    "devDependency": {      "description": "Specifies dependencies that are required for the development and testing of the project. These dependencies are not needed in the production environment.",      "type": "object",      "additionalProperties": {        "type": "string"      }    },    "optionalDependency": {      "description": "Specifies dependencies that are optional for your project. These dependencies are attempted to be installed during the npm install process, but if they fail to install, the installation process will not fail.",      "type": "object",      "additionalProperties": {        "type": "string"      }    },    "peerDependency": {      "description": "Specifies dependencies that are required by the package but are expected to be provided by the consumer of the package.",      "type": "object",      "additionalProperties": {        "type": "string"      }    },    "peerDependencyMeta": {      "description": "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": {            "description": "Specifies that this peer dependency is optional and should not be installed automatically.",            "type": "boolean"          }        }      }    },    "license": {      "anyOf": [        {          "type": "string"        },        {          "enum": [            "AGPL-3.0-only",            "Apache-2.0",            "BSD-2-Clause",            "BSD-3-Clause",            "BSL-1.0",            "CC0-1.0",            "CDDL-1.0",            "CDDL-1.1",            "EPL-1.0",            "EPL-2.0",            "GPL-2.0-only",            "GPL-3.0-only",            "ISC",            "LGPL-2.0-only",            "LGPL-2.1-only",            "LGPL-2.1-or-later",            "LGPL-3.0-only",            "LGPL-3.0-or-later",            "MIT",            "MPL-2.0",            "MS-PL",            "UNLICENSED"          ]        }      ]    },    "scriptsInstallAfter": {      "description": "Run AFTER the package is installed.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsPublishAfter": {      "description": "Run AFTER the package is published.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsRestart": {      "description": "Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsStart": {      "description": "Run by the 'npm start' command.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsStop": {      "description": "Run by the 'npm stop' command.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsTest": {      "description": "Run by the 'npm test' command.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsUninstallBefore": {      "description": "Run BEFORE the package is uninstalled.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "scriptsVersionBefore": {      "description": "Run BEFORE bump the package version.",      "type": "string",      "x-intellij-language-injection": "Shell Script"    },    "packageExportsEntryPath": {      "type": [        "string",        "null"      ],      "description": "The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.",      "pattern": "^\\./"    },    "packageExportsEntryObject": {      "type": "object",      "description": "Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.",      "properties": {        "require": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved when this specifier is imported as a CommonJS module using the `require(...)` function."        },        "import": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved when this specifier is imported as an ECMAScript module using an `import` declaration or the dynamic `import(...)` function."        },        "node": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved when this environment is Node.js."        },        "default": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved when no other export type matches."        },        "types": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved for TypeScript types when this specifier is imported. Should be listed before other conditions. Additionally, versioned \"types\" condition in the form \"types@{selector}\" are supported."        }      },      "patternProperties": {        "^[^.0-9]+$": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved when this environment matches the property name."        },        "^types@.+$": {          "$ref": "#/definitions/packageExportsEntryOrFallback",          "description": "The module path that is resolved for TypeScript types when this specifier is imported. Should be listed before other conditions. Additionally, versioned \"types\" condition in the form \"types@{selector}\" are supported."        }      },      "additionalProperties": false    },    "packageExportsEntry": {      "oneOf": [        {          "$ref": "#/definitions/packageExportsEntryPath"        },        {          "$ref": "#/definitions/packageExportsEntryObject"        }      ]    },    "packageExportsFallback": {      "type": "array",      "description": "Used to allow fallbacks in case this environment doesn't support the preceding entries.",      "items": {        "$ref": "#/definitions/packageExportsEntry"      }    },    "packageExportsEntryOrFallback": {      "oneOf": [        {          "$ref": "#/definitions/packageExportsEntry"        },        {          "$ref": "#/definitions/packageExportsFallback"        }      ]    },    "packageImportsEntryPath": {      "type": [        "string",        "null"      ],      "description": "The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module."    },    "packageImportsEntryObject": {      "type": "object",      "description": "Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.",      "properties": {        "require": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved when this specifier is imported as a CommonJS module using the `require(...)` function."        },        "import": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved when this specifier is imported as an ECMAScript module using an `import` declaration or the dynamic `import(...)` function."        },        "node": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved when this environment is Node.js."        },        "default": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved when no other export type matches."        },        "types": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved for TypeScript types when this specifier is imported. Should be listed before other conditions. Additionally, versioned \"types\" condition in the form \"types@{selector}\" are supported."        }      },      "patternProperties": {        "^[^.0-9]+$": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved when this environment matches the property name."        },        "^types@.+$": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved for TypeScript types when this specifier is imported. Should be listed before other conditions. Additionally, versioned \"types\" condition in the form \"types@{selector}\" are supported."        }      },      "additionalProperties": false    },    "packageImportsEntry": {      "oneOf": [        {          "$ref": "#/definitions/packageImportsEntryPath"        },        {          "$ref": "#/definitions/packageImportsEntryObject"        }      ]    },    "packageImportsFallback": {      "type": "array",      "description": "Used to allow fallbacks in case this environment doesn't support the preceding entries.",      "items": {        "$ref": "#/definitions/packageImportsEntry"      }    },    "packageImportsEntryOrFallback": {      "oneOf": [        {          "$ref": "#/definitions/packageImportsEntry"        },        {          "$ref": "#/definitions/packageImportsFallback"        }      ]    },    "fundingUrl": {      "type": "string",      "format": "uri",      "description": "URL to a website with details about how to fund the package."    },    "fundingWay": {      "type": "object",      "description": "Used to inform about ways to help fund development of the package.",      "properties": {        "url": {          "$ref": "#/definitions/fundingUrl"        },        "type": {          "type": "string",          "description": "The type of funding or the platform through which funding can be provided, e.g. patreon, opencollective, tidelift or github."        }      },      "additionalProperties": false,      "required": [        "url"      ]    }  },  "type": "object",  "patternProperties": {    "^_": {      "description": "Any property starting with _ is valid.",      "tsType": "any"    }  },  "properties": {    "name": {      "description": "The name of the package.",      "type": "string",      "maxLength": 214,      "minLength": 1,      "pattern": "^(?:(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)?/[a-z0-9-._~])|[a-z0-9-~])[a-z0-9-._~]*$"    },    "version": {      "description": "Version must be parsable by node-semver, which is bundled with npm as a dependency.",      "type": "string"    },    "description": {      "description": "This helps people discover your package, as it's listed in 'npm search'.",      "type": "string"    },    "keywords": {      "description": "This helps people discover your package as it's listed in 'npm search'.",      "type": "array",      "items": {        "type": "string"      }    },    "homepage": {      "description": "The url to the project homepage.",      "type": "string"    },    "bugs": {      "description": "The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.",      "type": [        "object",        "string"      ],      "properties": {        "url": {          "type": "string",          "description": "The url to your project's issue tracker.",          "format": "uri"        },        "email": {          "type": "string",          "description": "The email address to which issues should be reported.",          "format": "email"        }      }    },    "license": {      "$ref": "#/definitions/license",      "description": "You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it."    },    "licenses": {      "description": "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": {            "$ref": "#/definitions/license"          },          "url": {            "type": "string",            "format": "uri"          }        }      }    },    "author": {      "$ref": "#/definitions/person"    },    "contributors": {      "description": "A list of people who contributed to this package.",      "type": "array",      "items": {        "$ref": "#/definitions/person"      }    },    "maintainers": {      "description": "A list of people who maintains this package.",      "type": "array",      "items": {        "$ref": "#/definitions/person"      }    },    "files": {      "description": "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"      }    },    "main": {      "description": "The main field is a module ID that is the primary entry point to your program.",      "type": "string"    },    "exports": {      "description": "The \"exports\" field is used to restrict external access to non-exported module files, also enables a module to import itself using \"name\".",      "oneOf": [        {          "$ref": "#/definitions/packageExportsEntryPath",          "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."        },        {          "type": "object",          "properties": {            ".": {              "$ref": "#/definitions/packageExportsEntryOrFallback",              "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."            }          },          "patternProperties": {            "^\\./.+": {              "$ref": "#/definitions/packageExportsEntryOrFallback",              "description": "The module path prefix that is resolved when the module specifier starts with \"name/\", set to \"./*\" to allow external modules to import any subpath."            }          },          "additionalProperties": false        },        {          "$ref": "#/definitions/packageExportsEntryObject",          "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."        },        {          "$ref": "#/definitions/packageExportsFallback",          "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."        }      ]    },    "imports": {      "description": "The \"imports\" field is used to create private mappings that only apply to import specifiers from within the package itself.",      "type": "object",      "patternProperties": {        "^#.+$": {          "$ref": "#/definitions/packageImportsEntryOrFallback",          "description": "The module path that is resolved when this environment matches the property name."        }      },      "additionalProperties": false    },    "bin": {      "type": [        "string",        "object"      ],      "additionalProperties": {        "type": "string"      }    },    "type": {      "description": "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"    },    "types": {      "description": "Set the types property to point to your bundled declaration file.",      "type": "string"    },    "typings": {      "description": "Note that the \"typings\" field is synonymous with \"types\", and could be used as well.",      "type": "string"    },    "typesVersions": {      "description": "The \"typesVersions\" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.",      "type": "object",      "additionalProperties": {        "description": "Contains overrides for the TypeScript version that matches the version range matching the property key.",        "type": "object",        "properties": {          "*": {            "description": "Maps all file paths to the file paths specified in the array.",            "type": "array",            "items": {              "type": "string",              "pattern": "^[^*]*(?:\\*[^*]*)?$"            }          }        },        "patternProperties": {          "^[^*]+$": {            "description": "Maps the file path matching the property key to the file paths specified in the array.",            "type": "array",            "items": {

Lines 1–500 of 1161.