- Ruby 98.9%
- Shell 1.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| bin | ||
| lib | ||
| sig | ||
| spec | ||
| .gitignore | ||
| .rspec | ||
| .rubocop.yml | ||
| CHANGELOG.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE.txt | ||
| Rakefile | ||
| README.md | ||
| zigpack.gemspec | ||
Zig Package (zigpack)
Welcome to zigpack! The main purpose of this gem is to inspect Zig packages and their (transitive) dependencies.
Stay tuned for more!
Installation
TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
If bundler is not being used to manage dependencies, install the gem by executing:
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
Usage
Create a Package instance
To create a new Package instance, call Zigpack::Package.new and provide a path to
a Zig package.
p = Zigpack::Package.new "../keylib"
Fetch all (transitive) dependencies
To fetch all (transitive) dependencies of a Zigpack::Package one can call the fetch_dependencies method.
deps = p.fetch_dependencies
This method will return a Hash with Zig package hashes (String) as keys and Hashes containing a Package instance, as well as the relative path to the local Zig package, as values.
When you call fetch_dependencies, zigpack is going to create a local .zigpack folder where all dependencies are downloaded to.
SBOM
One you have fetched the dependencies of a package, you can use the collected data to output a Software Bill of Materials.
CycloneDX
The CycloneDX SBOM standard is maintained by the OWASP-project.
Currently, this gem supports CycloneDX SBOMs with the following versions:
The below steps show how to generate a CycloneDX SBOM.
p = Zigpack::Package.new "../PassKeeZ"
deps = p.fetch_dependencies
p.cyclonedx deps
Development
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zigpkg.
License
The gem is available as open source under the terms of the MIT License.