bpkg
A lightweight Bash package manager
bpkg.json
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
bpkg.json and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
namerequired | string | Where the dependency is located in `deps/`. See more: https://github.com/bpkg/bpkg#name default: "" |
version | string | The current version of the dependency. See more: https://github.com/bpkg/bpkg#version-optional default: "v0.1.0" |
descriptionrequired | string | Human-readable description of the functionality of the package. See more: https://github.com/bpkg/bpkg#description |
globalrequired | string | Whether the package is only intended be installed as a global script. Allows the omission of the `--global` flag when installing. See more: https://github.com/bpkg/bpkg#global default: "" |
installrequired | string | Shell script used to invoke in the install script. Required if package is being installed as a global script. See more: https://github.com/bpkg/bpkg#install-1 default: "make install" |
scriptsrequired | array<string> | An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts |
files | array<string> | An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional |
dependencies | object | Hash of dependencies of this project. Use either a tagged release identifier or `master`. See more: https://github.com/bpkg/bpkg#dependencies-optional |
dependencies-dev | object | Hash of development dependencies of this project. Use either a tagged release identifier or `master`. See more: https://github.com/bpkg/bpkg#dependencies-dev-optional |
commands | object | A hash of runnable commands for `bpkg run`. See more: https://github.com/bpkg/bpkg#commands-optional |
commands-description | object | A hash of descriptions for each command in `commands`. See more: https://github.com/bpkg/bpkg#commands-description-optional |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 11 properties, 100% carrying a description, max nesting depth 4.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
examples | JSON Schema Validation, draft 2020-12 | §9.5 — "examples" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.