https://github.com/dadav/jsonnet-bundler-ng
A jsonnet package manager.
https://github.com/dadav/jsonnet-bundler-ng
Last synced: about 1 year ago
JSON representation
A jsonnet package manager.
- Host: GitHub
- URL: https://github.com/dadav/jsonnet-bundler-ng
- Owner: dadav
- License: apache-2.0
- Created: 2023-12-12T14:59:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-16T18:55:40.000Z (over 2 years ago)
- Last Synced: 2025-02-06T16:57:55.375Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 1.8 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonnet-bundler-ng
The jsonnet-bundler-ng is a fork of [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler),
a package manager for [jsonnet](https://jsonnet.org/).
## Install
```
go install -a github.com/dadav/jsonnet-bundler-ng/cmd/jb-ng@latest
```
## Package Install
- [Arch Linux AUR](https://aur.archlinux.org/packages/jsonnet-bundler-ng-bin)
## Features
- Fetches transitive dependencies
- Can vendor subtrees, as opposed to whole repositories
## Current Limitations
- Always downloads entire dependent repositories, even when updating
- If two dependencies depend on the same package (diamond problem), they must require the same version
## Example Usage
Initialize your project:
```sh
mkdir myproject
cd myproject
jb-ng init
```
The existence of the `jsonnetfile.json` file means your directory is now a
jsonnet-bundler package that can define dependencies.
To depend on another package (another Github repository):
_Note that your dependency need not be initialized with a `jsonnetfile.json`.
If it is not, it is assumed it has no transitive dependencies._
```sh
jb-ng install https://github.com/anguslees/kustomize-libsonnet
```
Now write `myconfig.jsonnet`, which can import a file from that package.
Remember to use `-J vendor` when running Jsonnet to include the vendor tree.
```jsonnet
local kustomize = import 'kustomize-libsonnet/kustomize.libsonnet';
local my_resource = {
metadata: {
name: 'my-resource',
},
};
kustomize.namePrefix('staging-')(my_resource)
```
To depend on a package that is in a subtree of a Github repo (this package also
happens to bring in a transitive dependency):
```sh
jb-ng install https://github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator
```
_Note that if you are copy pasting from the Github website's address bar,
remove the `tree/master` from the path._
If pushed to Github, your project can now be referenced from other packages in
the same way, with its dependencies fetched automatically.
## All command line flags
```bash
usage: jb-ng [] [ ...]
A jsonnet package manager
Flags:
-h, --help Show context-sensitive help (also try --help-long and
--help-man).
--version Show application version.
--jsonnetpkg-home="vendor"
The directory used to cache packages in.
-q, --quiet Suppress any output from git command.
Commands:
help [...]
Show help.
init
Initialize a new empty jsonnetfile
registry add [] [] [] []
Add a new registry
registry rm []
Remove a registry
registry update
Update registry data
registry list
List registries
registry search [] []
Search package in registries
install [] [...]
Install new dependencies. Existing ones are silently skipped
update [...]
Update all or specific dependencies.
rewrite
Automatically rewrite legacy imports to absolute ones
```
## Design
This is an implemention of the design specified in this document: https://docs.google.com/document/d/1czRScSvvOiAJaIjwf3CogOULgQxhY9MkiBKOQI1yR14/edit#heading=h.upn4d5pcxy4c