1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "JSON schema for NPM package.json files",
4 "definitions": {
5 "person": {
6 "description": "A person who has been involved in creating or maintaining this package.",
7 "type": [
8 "object",
9 "string"
10 ],
11 "required": [
12 "name"
13 ],
14 "properties": {
15 "name": {
16 "type": "string"
17 },
18 "url": {
19 "type": "string",
20 "format": "uri"
21 },
22 "email": {
23 "type": "string",
24 "format": "email"
25 }
26 }
27 },
28 "dependency": {
29 "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.",
30 "type": "object",
31 "additionalProperties": {
32 "type": "string"
33 }
34 },
35 "devDependency": {
36 "description": "Specifies dependencies that are required for the development and testing of the project. These dependencies are not needed in the production environment.",
37 "type": "object",
38 "additionalProperties": {
39 "type": "string"
40 }
41 },
42 "optionalDependency": {
43 "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.",
44 "type": "object",
45 "additionalProperties": {
46 "type": "string"
47 }
48 },
49 "peerDependency": {
50 "description": "Specifies dependencies that are required by the package but are expected to be provided by the consumer of the package.",
51 "type": "object",
52 "additionalProperties": {
53 "type": "string"
54 }
55 },
56 "peerDependencyMeta": {
57 "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.",
58 "type": "object",
59 "additionalProperties": {
60 "type": "object",
61 "additionalProperties": true,
62 "properties": {
63 "optional": {
64 "description": "Specifies that this peer dependency is optional and should not be installed automatically.",
65 "type": "boolean"
66 }
67 }
68 }
69 },
70 "license": {
71 "anyOf": [
72 {
73 "type": "string"
74 },
75 {
76 "enum": [
77 "AGPL-3.0-only",
78 "Apache-2.0",
79 "BSD-2-Clause",
80 "BSD-3-Clause",
81 "BSL-1.0",
82 "CC0-1.0",
83 "CDDL-1.0",
84 "CDDL-1.1",
85 "EPL-1.0",
86 "EPL-2.0",
87 "GPL-2.0-only",
88 "GPL-3.0-only",
89 "ISC",
90 "LGPL-2.0-only",
91 "LGPL-2.1-only",
92 "LGPL-2.1-or-later",
93 "LGPL-3.0-only",
94 "LGPL-3.0-or-later",
95 "MIT",
96 "MPL-2.0",
97 "MS-PL",
98 "UNLICENSED"
99 ]
100 }
101 ]
102 },
103 "scriptsInstallAfter": {
104 "description": "Run AFTER the package is installed.",
105 "type": "string",
106 "x-intellij-language-injection": "Shell Script"
107 },
108 "scriptsPublishAfter": {
109 "description": "Run AFTER the package is published.",
110 "type": "string",
111 "x-intellij-language-injection": "Shell Script"
112 },
113 "scriptsRestart": {
114 "description": "Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.",
115 "type": "string",
116 "x-intellij-language-injection": "Shell Script"
117 },
118 "scriptsStart": {
119 "description": "Run by the 'npm start' command.",
120 "type": "string",
121 "x-intellij-language-injection": "Shell Script"
122 },
123 "scriptsStop": {
124 "description": "Run by the 'npm stop' command.",
125 "type": "string",
126 "x-intellij-language-injection": "Shell Script"
127 },
128 "scriptsTest": {
129 "description": "Run by the 'npm test' command.",
130 "type": "string",
131 "x-intellij-language-injection": "Shell Script"
132 },
133 "scriptsUninstallBefore": {
134 "description": "Run BEFORE the package is uninstalled.",
135 "type": "string",
136 "x-intellij-language-injection": "Shell Script"
137 },
138 "scriptsVersionBefore": {
139 "description": "Run BEFORE bump the package version.",
140 "type": "string",
141 "x-intellij-language-injection": "Shell Script"
142 },
143 "packageExportsEntryPath": {
144 "type": [
145 "string",
146 "null"
147 ],
148 "description": "The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.",
149 "pattern": "^\\./"
150 },
151 "packageExportsEntryObject": {
152 "type": "object",
153 "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.",
154 "properties": {
155 "require": {
156 "$ref": "#/definitions/packageExportsEntryOrFallback",
157 "description": "The module path that is resolved when this specifier is imported as a CommonJS module using the `require(...)` function."
158 },
159 "import": {
160 "$ref": "#/definitions/packageExportsEntryOrFallback",
161 "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."
162 },
163 "module-sync": {
164 "$ref": "#/definitions/packageExportsEntryOrFallback",
165 "$comment": "https://nodejs.org/api/packages.html#conditional-exports#:~:text=%22module-sync%22",
166 "description": "The same as `import`, but can be used with require(esm) in Node 20+. This requires the files to not use any top-level awaits."
167 },
168 "node": {
169 "$ref": "#/definitions/packageExportsEntryOrFallback",
170 "description": "The module path that is resolved when this environment is Node.js."
171 },
172 "default": {
173 "$ref": "#/definitions/packageExportsEntryOrFallback",
174 "description": "The module path that is resolved when no other export type matches."
175 },
176 "types": {
177 "$ref": "#/definitions/packageExportsEntryOrFallback",
178 "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."
179 }
180 },
181 "patternProperties": {
182 "^[^.0-9]+$": {
183 "$ref": "#/definitions/packageExportsEntryOrFallback",
184 "description": "The module path that is resolved when this environment matches the property name."
185 },
186 "^types@.+$": {
187 "$ref": "#/definitions/packageExportsEntryOrFallback",
188 "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."
189 }
190 },
191 "additionalProperties": false
192 },
193 "packageExportsEntry": {
194 "oneOf": [
195 {
196 "$ref": "#/definitions/packageExportsEntryPath"
197 },
198 {
199 "$ref": "#/definitions/packageExportsEntryObject"
200 }
201 ]
202 },
203 "packageExportsFallback": {
204 "type": "array",
205 "description": "Used to allow fallbacks in case this environment doesn't support the preceding entries.",
206 "items": {
207 "$ref": "#/definitions/packageExportsEntry"
208 }
209 },
210 "packageExportsEntryOrFallback": {
211 "oneOf": [
212 {
213 "$ref": "#/definitions/packageExportsEntry"
214 },
215 {
216 "$ref": "#/definitions/packageExportsFallback"
217 }
218 ]
219 },
220 "packageImportsEntryPath": {
221 "type": [
222 "string",
223 "null"
224 ],
225 "description": "The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module."
226 },
227 "packageImportsEntryObject": {
228 "type": "object",
229 "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.",
230 "properties": {
231 "require": {
232 "$ref": "#/definitions/packageImportsEntryOrFallback",
233 "description": "The module path that is resolved when this specifier is imported as a CommonJS module using the `require(...)` function."
234 },
235 "import": {
236 "$ref": "#/definitions/packageImportsEntryOrFallback",
237 "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."
238 },
239 "node": {
240 "$ref": "#/definitions/packageImportsEntryOrFallback",
241 "description": "The module path that is resolved when this environment is Node.js."
242 },
243 "default": {
244 "$ref": "#/definitions/packageImportsEntryOrFallback",
245 "description": "The module path that is resolved when no other export type matches."
246 },
247 "types": {
248 "$ref": "#/definitions/packageImportsEntryOrFallback",
249 "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."
250 }
251 },
252 "patternProperties": {
253 "^[^.0-9]+$": {
254 "$ref": "#/definitions/packageImportsEntryOrFallback",
255 "description": "The module path that is resolved when this environment matches the property name."
256 },
257 "^types@.+$": {
258 "$ref": "#/definitions/packageImportsEntryOrFallback",
259 "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."
260 }
261 },
262 "additionalProperties": false
263 },
264 "packageImportsEntry": {
265 "oneOf": [
266 {
267 "$ref": "#/definitions/packageImportsEntryPath"
268 },
269 {
270 "$ref": "#/definitions/packageImportsEntryObject"
271 }
272 ]
273 },
274 "packageImportsFallback": {
275 "type": "array",
276 "description": "Used to allow fallbacks in case this environment doesn't support the preceding entries.",
277 "items": {
278 "$ref": "#/definitions/packageImportsEntry"
279 }
280 },
281 "packageImportsEntryOrFallback": {
282 "oneOf": [
283 {
284 "$ref": "#/definitions/packageImportsEntry"
285 },
286 {
287 "$ref": "#/definitions/packageImportsFallback"
288 }
289 ]
290 },
291 "fundingUrl": {
292 "type": "string",
293 "format": "uri",
294 "description": "URL to a website with details about how to fund the package."
295 },
296 "fundingWay": {
297 "type": "object",
298 "description": "Used to inform about ways to help fund development of the package.",
299 "properties": {
300 "url": {
301 "$ref": "#/definitions/fundingUrl"
302 },
303 "type": {
304 "type": "string",
305 "description": "The type of funding or the platform through which funding can be provided, e.g. patreon, opencollective, tidelift or github."
306 }
307 },
308 "additionalProperties": false,
309 "required": [
310 "url"
311 ]
312 },
313 "devEngineDependency": {
314 "description": "Specifies requirements for development environment components such as operating systems, runtimes, or package managers. Used to ensure consistent development environments across the team.",
315 "type": "object",
316 "required": [
317 "name"
318 ],
319 "properties": {
320 "name": {
321 "type": "string",
322 "description": "The name of the dependency, with allowed values depending on the parent field"
323 },
324 "version": {
325 "type": "string",
326 "description": "The version range for the dependency"
327 },
328 "onFail": {
329 "type": "string",
330 "enum": [
331 "ignore",
332 "warn",
333 "error",
334 "download"
335 ],
336 "description": "What action to take if validation fails"
337 }
338 }
339 }
340 },
341 "type": "object",
342 "patternProperties": {
343 "^_": {
344 "description": "Any property starting with _ is valid.",
345 "tsType": "any"
346 }
347 },
348 "properties": {
349 "name": {
350 "description": "The name of the package.",
351 "type": "string",
352 "maxLength": 214,
353 "minLength": 1,
354 "pattern": "^(?:(?:@(?:[a-z0-9-*~][a-z0-9-*._~]*)?/[a-z0-9-._~])|[a-z0-9-~])[a-z0-9-._~]*$"
355 },
356 "version": {
357 "description": "Version must be parsable by node-semver, which is bundled with npm as a dependency.",
358 "type": "string"
359 },
360 "description": {
361 "description": "This helps people discover your package, as it's listed in 'npm search'.",
362 "type": "string"
363 },
364 "keywords": {
365 "description": "This helps people discover your package as it's listed in 'npm search'.",
366 "type": "array",
367 "items": {
368 "type": "string"
369 }
370 },
371 "homepage": {
372 "description": "The url to the project homepage.",
373 "type": "string"
374 },
375 "bugs": {
376 "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.",
377 "type": [
378 "object",
379 "string"
380 ],
381 "properties": {
382 "url": {
383 "type": "string",
384 "description": "The url to your project's issue tracker.",
385 "format": "uri"
386 },
387 "email": {
388 "type": "string",
389 "description": "The email address to which issues should be reported.",
390 "format": "email"
391 }
392 }
393 },
394 "license": {
395 "$ref": "#/definitions/license",
396 "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."
397 },
398 "licenses": {
399 "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'.",
400 "type": "array",
401 "items": {
402 "type": "object",
403 "properties": {
404 "type": {
405 "$ref": "#/definitions/license"
406 },
407 "url": {
408 "type": "string",
409 "format": "uri"
410 }
411 }
412 }
413 },
414 "author": {
415 "$ref": "#/definitions/person"
416 },
417 "contributors": {
418 "description": "A list of people who contributed to this package.",
419 "type": "array",
420 "items": {
421 "$ref": "#/definitions/person"
422 }
423 },
424 "maintainers": {
425 "description": "A list of people who maintains this package.",
426 "type": "array",
427 "items": {
428 "$ref": "#/definitions/person"
429 }
430 },
431 "files": {
432 "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.",
433 "type": "array",
434 "items": {
435 "type": "string"
436 }
437 },
438 "main": {
439 "description": "The main field is a module ID that is the primary entry point to your program.",
440 "type": "string"
441 },
442 "exports": {
443 "description": "The \"exports\" field is used to restrict external access to non-exported module files, also enables a module to import itself using \"name\".",
444 "oneOf": [
445 {
446 "$ref": "#/definitions/packageExportsEntryPath",
447 "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."
448 },
449 {
450 "type": "object",
451 "properties": {
452 ".": {
453 "$ref": "#/definitions/packageExportsEntryOrFallback",
454 "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."
455 }
456 },
457 "patternProperties": {
458 "^\\./.+": {
459 "$ref": "#/definitions/packageExportsEntryOrFallback",
460 "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."
461 }
462 },
463 "additionalProperties": false
464 },
465 {
466 "$ref": "#/definitions/packageExportsEntryObject",
467 "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."
468 },
469 {
470 "$ref": "#/definitions/packageExportsFallback",
471 "description": "The module path that is resolved when the module specifier matches \"name\", shadows the \"main\" field."
472 }
473 ]
474 },
475 "imports": {
476 "description": "The \"imports\" field is used to create private mappings that only apply to import specifiers from within the package itself.",
477 "type": "object",
478 "patternProperties": {
479 "^#.+$": {
480 "$ref": "#/definitions/packageImportsEntryOrFallback",
481 "description": "The module path that is resolved when this environment matches the property name."
482 }
483 },
484 "additionalProperties": false
485 },
486 "bin": {
487 "type": [
488 "string",
489 "object"
490 ],
491 "additionalProperties": {
492 "type": "string"
493 }
494 },
495 "type": {
496 "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.",
497 "type": "string",
498 "enum": [
499 "commonjs",
500 "module"
501 ],
502 "default": "commonjs"
503 },
504 "types": {
505 "description": "Set the types property to point to your bundled declaration file.",
506 "type": "string"
507 },
508 "typings": {
509 "description": "Note that the \"typings\" field is synonymous with \"types\", and could be used as well.",
510 "type": "string"
511 },
512 "typesVersions": {
513 "description": "The \"typesVersions\" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.",
514 "type": "object",
515 "additionalProperties": {
516 "description": "Contains overrides for the TypeScript version that matches the version range matching the property key.",
517 "type": "object",
518 "properties": {
519 "*": {
520 "description": "Maps all file paths to the file paths specified in the array.",
521 "type": "array",
522 "items": {
523 "type": "string",
524 "pattern": "^[^*]*(?:\\*[^*]*)?$"
525 }
526 }
527 },
528 "patternProperties": {
529 "^[^*]+$": {
530 "description": "Maps the file path matching the property key to the file paths specified in the array.",
531 "type": "array",
532 "items": {
533 "type": "string"
534 }
535 },
536 "^[^*]*\\*[^*]*$": {
537 "description": "Maps file paths matching the pattern specified in property key to file paths specified in the array.",
538 "type": "array",
539 "items": {
540 "type": "string",
541 "pattern": "^[^*]*(?:\\*[^*]*)?$"
542 }
543 }
544 },
545 "additionalProperties": false
546 }
547 },
548 "man": {
549 "type": [
550 "array",
551 "string"
552 ],
553 "description": "Specify either a single file or an array of filenames to put in place for the man program to find.",
554 "items": {
555 "type": "string"
556 }
557 },
558 "directories": {
559 "type": "object",
560 "properties": {
561 "bin": {
562 "description": "If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.",
563 "type": "string"
564 },
565 "doc": {
566 "description": "Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.",
567 "type": "string"
568 },
569 "example": {
570 "description": "Put example scripts in here. Someday, it might be exposed in some clever way.",
571 "type": "string"
572 },
573 "lib": {
574 "description": "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.",
575 "type": "string"
576 },
577 "man": {
578 "description": "A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.",
579 "type": "string"
580 },
581 "test": {
582 "type": "string"
583 }
584 }
585 },
586 "repository": {
587 "description": "Specify the place where your code lives. This is helpful for people who want to contribute.",
588 "type": [
589 "object",
590 "string"
591 ],
592 "properties": {
593 "type": {
594 "type": "string"
595 },
596 "url": {
597 "type": "string"
598 },
599 "directory": {
600 "type": "string"
601 }
602 }
603 },
604 "funding": {
605 "oneOf": [
606 {
607 "$ref": "#/definitions/fundingUrl"
608 },
609 {
610 "$ref": "#/definitions/fundingWay"
611 },
612 {
613 "type": "array",
614 "items": {
615 "oneOf": [
616 {
617 "$ref": "#/definitions/fundingUrl"
618 },
619 {
620 "$ref": "#/definitions/fundingWay"
621 }
622 ]
623 },
624 "minItems": 1,
625 "uniqueItems": true
626 }
627 ]
628 },
629 "scripts": {
630 "description": "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.",
631 "type": "object",
632 "properties": {
633 "lint": {
634 "type": "string",
635 "description": "Run code quality tools, e.g. ESLint, TSLint, etc."
636 },
637 "prepublish": {
638 "type": "string",
639 "description": "Run BEFORE the package is published (Also run on local npm install without any arguments)."
640 },
641 "prepare": {
642 "type": "string",
643 "description": "Runs BEFORE the package is packed, i.e. during \"npm publish\" and \"npm pack\", and on local \"npm install\" without any arguments. This is run AFTER \"prepublish\", but BEFORE \"prepublishOnly\"."
644 },
645 "prepublishOnly": {
646 "type": "string",
647 "description": "Run BEFORE the package is prepared and packed, ONLY on npm publish."
648 },
649 "prepack": {
650 "type": "string",
651 "description": "run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies)."
652 },
653 "postpack": {
654 "type": "string",
655 "description": "Run AFTER the tarball has been generated and moved to its final destination."
656 },
657 "publish": {
658 "type": "string",
659 "description": "Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish"
660 },
661 "postpublish": {
662 "$ref": "#/definitions/scriptsPublishAfter"
663 },
664 "preinstall": {
665 "type": "string",
666 "description": "Run BEFORE the package is installed."
667 },
668 "install": {
669 "$ref": "#/definitions/scriptsInstallAfter"
670 },
671 "postinstall": {
672 "$ref": "#/definitions/scriptsInstallAfter"
673 },
674 "preuninstall": {
675 "$ref": "#/definitions/scriptsUninstallBefore"
676 },
677 "uninstall": {
678 "$ref": "#/definitions/scriptsUninstallBefore"
679 },
680 "postuninstall": {
681 "type": "string",
682 "description": "Run AFTER the package is uninstalled."
683 },
684 "preversion": {
685 "$ref": "#/definitions/scriptsVersionBefore"
686 },
687 "version": {
688 "$ref": "#/definitions/scriptsVersionBefore"
689 },
690 "postversion": {
691 "type": "string",
692 "description": "Run AFTER bump the package version."
693 },
694 "pretest": {
695 "$ref": "#/definitions/scriptsTest"
696 },
697 "test": {
698 "$ref": "#/definitions/scriptsTest"
699 },
700 "posttest": {
701 "$ref": "#/definitions/scriptsTest"
702 },
703 "prestop": {
704 "$ref": "#/definitions/scriptsStop"
705 },
706 "stop": {
707 "$ref": "#/definitions/scriptsStop"
708 },
709 "poststop": {
710 "$ref": "#/definitions/scriptsStop"
711 },
712 "prestart": {
713 "$ref": "#/definitions/scriptsStart"
714 },
715 "start": {
716 "$ref": "#/definitions/scriptsStart"
717 },
718 "poststart": {
719 "$ref": "#/definitions/scriptsStart"
720 },
721 "prerestart": {
722 "$ref": "#/definitions/scriptsRestart"
723 },
724 "restart": {
725 "$ref": "#/definitions/scriptsRestart"
726 },
727 "postrestart": {
728 "$ref": "#/definitions/scriptsRestart"
729 },
730 "serve": {
731 "type": "string",
732 "description": "Start dev server to serve application files"
733 }
734 },
735 "additionalProperties": {
736 "type": "string",
737 "tsType": "string | undefined",
738 "x-intellij-language-injection": "Shell Script"
739 }
740 },
741 "config": {
742 "description": "A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.",
743 "type": "object",
744 "additionalProperties": true
745 },
746 "dependencies": {
747 "$ref": "#/definitions/dependency"
748 },
749 "devDependencies": {
750 "$ref": "#/definitions/devDependency"
751 },
752 "optionalDependencies": {
753 "$ref": "#/definitions/optionalDependency"
754 },
755 "peerDependencies": {
756 "$ref": "#/definitions/peerDependency"
757 },
758 "peerDependenciesMeta": {
759 "$ref": "#/definitions/peerDependencyMeta"
760 },
761 "bundleDependencies": {
762 "description": "Array of package names that will be bundled when publishing the package.",
763 "oneOf": [
764 {
765 "type": "array",
766 "items": {
767 "type": "string"
768 }
769 },
770 {
771 "type": "boolean"
772 }
773 ]
774 },
775 "bundledDependencies": {
776 "description": "DEPRECATED: This field is honored, but \"bundleDependencies\" is the correct field name.",
777 "oneOf": [
778 {
779 "type": "array",
780 "items": {
781 "type": "string"
782 }
783 },
784 {
785 "type": "boolean"
786 }
787 ]
788 },
789 "resolutions": {
790 "description": "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://yarnpkg.com/configuration/manifest#resolutions",
791 "type": "object"
792 },
793 "overrides": {
794 "description": "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",
795 "type": "object"
796 },
797 "packageManager": {
798 "description": "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",
799 "type": "string",
800 "pattern": "(npm|pnpm|yarn|bun)@\\d+\\.\\d+\\.\\d+(-.+)?"
801 },
802 "engines": {
803 "type": "object",
804 "properties": {
805 "node": {
806 "type": "string"
807 }
808 },
809 "additionalProperties": {
810 "type": "string"
811 }
812 },
813 "volta": {
814 "description": "Defines which tools and versions are expected to be used when Volta is installed.",
815 "type": "object",
816 "properties": {
817 "extends": {
818 "description": "The value of that entry should be a path to another JSON file which also has a \"volta\" section",
819 "type": "string"
820 }
821 },
822 "patternProperties": {
823 "(node|npm|pnpm|yarn)": {
824 "type": "string"
825 }
826 }
827 },
828 "engineStrict": {
829 "type": "boolean"
830 },
831 "os": {
832 "description": "Specify which operating systems your module will run on.",
833 "type": "array",
834 "items": {
835 "type": "string"
836 }
837 },
838 "cpu": {
839 "description": "Specify that your code only runs on certain cpu architectures.",
840 "type": "array",
841 "items": {
842 "type": "string"
843 }
844 },
845 "devEngines": {
846 "description": "Define the runtime and package manager for developing the current project.",
847 "type": "object",
848 "properties": {
849 "os": {
850 "oneOf": [
851 {
852 "$ref": "#/definitions/devEngineDependency"
853 },
854 {
855 "type": "array",
856 "items": {
857 "$ref": "#/definitions/devEngineDependency"
858 }
859 }
860 ],
861 "description": "Specifies which operating systems are supported for development"
862 },
863 "cpu": {
864 "oneOf": [
865 {
866 "$ref": "#/definitions/devEngineDependency"
867 },
868 {
869 "type": "array",
870 "items": {
871 "$ref": "#/definitions/devEngineDependency"
872 }
873 }
874 ],
875 "description": "Specifies which CPU architectures are supported for development"
876 },
877 "libc": {
878 "oneOf": [
879 {
880 "$ref": "#/definitions/devEngineDependency"
881 },
882 {
883 "type": "array",
884 "items": {
885 "$ref": "#/definitions/devEngineDependency"
886 }
887 }
888 ],
889 "description": "Specifies which C standard libraries are supported for development"
890 },
891 "runtime": {
892 "oneOf": [
893 {
894 "$ref": "#/definitions/devEngineDependency"
895 },
896 {
897 "type": "array",
898 "items": {
899 "$ref": "#/definitions/devEngineDependency"
900 }
901 }
902 ],
903 "description": "Specifies which JavaScript runtimes (like Node.js, Deno, Bun) are supported for development. Values should use WinterCG Runtime Keys (see https://runtime-keys.proposal.wintercg.org/)"
904 },
905 "packageManager": {
906 "oneOf": [
907 {
908 "$ref": "#/definitions/devEngineDependency"
909 },
910 {
911 "type": "array",
912 "items": {
913 "$ref": "#/definitions/devEngineDependency"
914 }
915 }
916 ],
917 "description": "Specifies which package managers are supported for development"
918 }
919 }
920 },
921 "preferGlobal": {
922 "type": "boolean",
923 "description": "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."
924 },
925 "private": {
926 "description": "If set to true, then npm will refuse to publish it.",
927 "oneOf": [
928 {
929 "type": "boolean"
930 },
931 {
932 "enum": [
933 "false",
934 "true"
935 ]
936 }
937 ]
938 },
939 "publishConfig": {
940 "type": "object",
941 "properties": {
942 "access": {
943 "type": "string",
944 "enum": [
945 "public",
946 "restricted"
947 ]
948 },
949 "tag": {
950 "type": "string"
951 },
952 "registry": {
953 "type": "string",
954 "format": "uri"
955 },
956 "provenance": {
957 "type": "boolean"
958 }
959 },
960 "additionalProperties": true
961 },
962 "dist": {
963 "type": "object",
964 "properties": {
965 "shasum": {
966 "type": "string"
967 },
968 "tarball": {
969 "type": "string"
970 }
971 }
972 },
973 "readme": {
974 "type": "string"
975 },
976 "module": {
977 "description": "An ECMAScript module ID that is the primary entry point to your program.",
978 "type": "string"
979 },
980 "esnext": {
981 "description": "A module ID with untranspiled code that is the primary entry point to your program.",
982 "type": [
983 "string",
984 "object"
985 ],
986 "properties": {
987 "main": {
988 "type": "string"
989 },
990 "browser": {
991 "type": "string"
992 }
993 },
994 "additionalProperties": {
995 "type": "string"
996 }
997 },
998 "workspaces": {
999 "description": "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.",
1000 "anyOf": [
1001 {
1002 "type": "array",
1003 "description": "Workspace package paths. Glob patterns are supported.",
1004 "items": {
1005 "type": "string"
1006 }
1007 },
1008 {
1009 "type": "object",
1010 "properties": {
1011 "packages": {
1012 "type": "array",
1013 "description": "Workspace package paths. Glob patterns are supported.",
1014 "items": {
1015 "type": "string"
1016 }
1017 },
1018 "nohoist": {
1019 "type": "array",
1020 "description": "Packages to block from hoisting to the workspace root. Currently only supported in Yarn only.",
1021 "items": {
1022 "type": "string"
1023 }
1024 }
1025 }
1026 }
1027 ]
1028 },
1029 "jspm": {
1030 "$ref": "#"
1031 },
1032 "eslintConfig": {
1033 "$ref": "https://json.schemastore.org/eslintrc.json"
1034 },
1035 "prettier": {
1036 "$ref": "https://json.schemastore.org/prettierrc.json"
1037 },
1038 "stylelint": {
1039 "$ref": "https://json.schemastore.org/stylelintrc.json"
1040 },
1041 "ava": {
1042 "$ref": "https://json.schemastore.org/ava.json"
1043 },
1044 "release": {
1045 "$ref": "https://json.schemastore.org/semantic-release.json"
1046 },
1047 "jscpd": {
1048 "$ref": "https://json.schemastore.org/jscpd.json"
1049 },
1050 "pnpm": {
1051 "description": "Defines pnpm specific configuration.",
1052 "type": "object",
1053 "properties": {
1054 "overrides": {
1055 "description": "Used to override any dependency in the dependency graph.",
1056 "type": "object"
1057 },
1058 "packageExtensions": {
1059 "description": "Used to extend the existing package definitions with additional information.",
1060 "type": "object",
1061 "patternProperties": {
1062 "^.+$": {
1063 "type": "object",
1064 "properties": {
1065 "dependencies": {
1066 "$ref": "#/definitions/dependency"
1067 },
1068 "optionalDependencies": {
1069 "$ref": "#/definitions/optionalDependency"
1070 },
1071 "peerDependencies": {
1072 "$ref": "#/definitions/peerDependency"
1073 },
1074 "peerDependenciesMeta": {
1075 "$ref": "#/definitions/peerDependencyMeta"
1076 }
1077 },
1078 "additionalProperties": false
1079 }
1080 },
1081 "additionalProperties": false
1082 },
1083 "peerDependencyRules": {
1084 "type": "object",
1085 "properties": {
1086 "ignoreMissing": {
1087 "description": "pnpm will not print warnings about missing peer dependencies from this list.",
1088 "type": "array",
1089 "items": {
1090 "type": "string"
1091 }
1092 },
1093 "allowedVersions": {
1094 "description": "Unmet peer dependency warnings will not be printed for peer dependencies of the specified range.",
1095 "type": "object"
1096 },
1097 "allowAny": {
1098 "description": "Any peer dependency matching the pattern will be resolved from any version, regardless of the range specified in \"peerDependencies\".",
1099 "type": "array",
1100 "items": {
1101 "type": "string"
1102 }
1103 }
1104 },
1105 "additionalProperties": false
1106 },
1107 "neverBuiltDependencies": {
1108 "description": "A list of dependencies to run builds for.",
1109 "type": "array",
1110 "items": {
1111 "type": "string"
1112 }
1113 },
1114 "onlyBuiltDependencies": {
1115 "description": "A list of package names that are allowed to be executed during installation.",
1116 "type": "array",
1117 "items": {
1118 "type": "string"
1119 }
1120 },
1121 "onlyBuiltDependenciesFile": {
1122 "description": "Specifies a JSON file that lists the only packages permitted to run installation scripts during the pnpm install process.",
1123 "type": "string"
1124 },
1125 "ignoredBuiltDependencies": {
1126 "description": "A list of package names that should not be built during installation.",
1127 "type": "array",
1128 "items": {
1129 "type": "string"
1130 }
1131 },
1132 "allowedDeprecatedVersions": {
1133 "description": "A list of deprecated versions that the warnings are suppressed.",
1134 "type": "object"
1135 },
1136 "patchedDependencies": {
1137 "description": "A list of dependencies that are patched.",
1138 "type": "object"
1139 },
1140 "allowNonAppliedPatches": {
1141 "description": "When true, installation won't fail if some of the patches from the \"patchedDependencies\" field were not applied.",
1142 "type": "boolean"
1143 },
1144 "allowUnusedPatches": {
1145 "description": "When true, installation won't fail if some of the patches from the \"patchedDependencies\" field were not applied.",
1146 "type": "boolean"
1147 },
1148 "updateConfig": {
1149 "type": "object",
1150 "properties": {
1151 "ignoreDependencies": {
1152 "description": "A list of packages that should be ignored when running \"pnpm outdated\" or \"pnpm update --latest\".",
1153 "type": "array",
1154 "items": {
1155 "type": "string"
1156 }
1157 }
1158 },
1159 "additionalProperties": false
1160 },
1161 "configDependencies": {
1162 "type": "object",
1163 "description": "Configurational dependencies are installed before all the other types of dependencies (before 'dependencies', 'devDependencies', 'optionalDependencies')."
1164 },
1165 "auditConfig": {
1166 "type": "object",
1167 "properties": {
1168 "ignoreCves": {
1169 "description": "A list of CVE IDs that will be ignored by \"pnpm audit\".",
1170 "type": "array",
1171 "items": {
1172 "type": "string",
1173 "pattern": "^CVE-\\d{4}-\\d{4,7}$"
1174 }
1175 },
1176 "ignoreGhsas": {
1177 "description": "A list of GHSA Codes that will be ignored by \"pnpm audit\".",
1178 "type": "array",
1179 "items": {
1180 "type": "string",
1181 "pattern": "^GHSA(-[23456789cfghjmpqrvwx]{4}){3}$"
1182 }
1183 }
1184 },
1185 "additionalProperties": false
1186 },
1187 "requiredScripts": {
1188 "description": "A list of scripts that must exist in each project.",
1189 "type": "array",
1190 "items": {
1191 "type": "string"
1192 }
1193 },
1194 "supportedArchitectures": {
1195 "description": "Specifies architectures for which you'd like to install optional dependencies, even if they don't match the architecture of the system running the install.",
1196 "type": "object",
1197 "properties": {
1198 "os": {
1199 "type": "array",
1200 "items": {
1201 "type": "string"
1202 }
1203 },
1204 "cpu": {
1205 "type": "array",
1206 "items": {
1207 "type": "string"
1208 }
1209 },
1210 "libc": {
1211 "type": "array",
1212 "items": {
1213 "type": "string"
1214 }
1215 }
1216 },
1217 "additionalProperties": false
1218 },
1219 "ignoredOptionalDependencies": {
1220 "description": "A list of optional dependencies that the install should be skipped.",
1221 "type": "array",
1222 "items": {
1223 "type": "string"
1224 }
1225 },
1226 "executionEnv": {
1227 "type": "object",
1228 "properties": {
1229 "nodeVersion": {
1230 "description": "Specifies which exact Node.js version should be used for the project's runtime.",
1231 "type": "string"
1232 }
1233 },
1234 "additionalProperties": false
1235 }
1236 },
1237 "additionalProperties": false
1238 },
1239 "stackblitz": {
1240 "description": "Defines the StackBlitz configuration for the project.",
1241 "type": "object",
1242 "properties": {
1243 "installDependencies": {
1244 "description": "StackBlitz automatically installs npm dependencies when opening a project.",
1245 "type": "boolean"
1246 },
1247 "startCommand": {
1248 "description": "A terminal command to be executed when opening the project, after installing npm dependencies.",
1249 "type": [
1250 "string",
1251 "boolean"
1252 ]
1253 },
1254 "compileTrigger": {
1255 "description": "The compileTrigger option controls how file changes in the editor are written to the WebContainers in-memory filesystem. ",
1256 "oneOf": [
1257 {
1258 "type": "string",
1259 "enum": [
1260 "auto",
1261 "keystroke",
1262 "save"
1263 ]
1264 }
1265 ]
1266 },
1267 "env": {
1268 "description": "A map of default environment variables that will be set in each top-level shell process.",
1269 "type": "object"
1270 }
1271 },
1272 "additionalProperties": false
1273 }
1274 },
1275 "anyOf": [
1276 {
1277 "type": "object",
1278 "not": {
1279 "required": [
1280 "bundledDependencies",
1281 "bundleDependencies"
1282 ]
1283 }
1284 },
1285 {
1286 "type": "object",
1287 "not": {
1288 "required": [
1289 "bundleDependencies"
1290 ]
1291 },
1292 "required": [
1293 "bundledDependencies"
1294 ]
1295 },
1296 {
1297 "type": "object",
1298 "not": {
1299 "required": [
1300 "bundledDependencies"
1301 ]
1302 },
1303 "required": [
1304 "bundleDependencies"
1305 ]
1306 }
1307 ],
1308 "$id": "https://json.schemastore.org/package.json"
1309}