Dependency manifest parsing library for https://libraries.io
Requires Ruby 3.0 or above.
Add this line to your application's Gemfile:
gem 'bibliothecary'
And then execute:
$ bundle
Or install it yourself as:
$ gem install bibliothecary
Identify package manager manifests from a list of files:
Bibliothecary.identify_manifests(['package.json', 'README.md', 'index.js']) #=> 'package.json'
Parse a manifest file for it's dependencies:
Bibliothecary.analyse_file 'bower.json', File.open('bower.json').read
Search a directory for manifest files and parse the contents:
Bibliothecary.analyse('./')
There are a number of parsers that rely on web services to parse the file formats, those urls can be configured like so:
Bibliothecary.configure do |config|
config.carthage_parser_host = 'http://my-carthage-parsing-service.com'
end
All available config options are in: https://github.com/librariesio/bibliothecary/blob/master/lib/bibliothecary/configuration.rb
After checking out the repo, run bin/setup
to install dependencies. Then, run bundle exec rspec
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:
CHANGELOG.md
, move the changes under "Unreleased"
into a new section with your version numberversion.rb
in the main
branchbundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.Bug reports and pull requests are welcome on GitHub at https://github.com/librariesio/bibliothecary. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.