docs/collection.md in rbs-1.8.1 vs docs/collection.md in rbs-2.0.0.pre1

- old
+ new

@@ -5,11 +5,10 @@ ## Requirements * `git(1)` * `Gemfile.lock` - ## Usage ### Setup First, generate the configuration file, `rbs_collection.yaml`, with `rbs collection init`. @@ -63,13 +62,17 @@ * `rbs collection update` updates `rbs_collection.lock.yaml`. * `rbs collection clean` removes unnecessary rbs from `.gem_rbs_collection` directory. ## Configuration +### `rbs_collection.yaml` + Configure `rbs collection` with editing `rbs_collection.yaml`. ```yaml +# rbs_collection.yaml + # Download sources. # You can add own collection git repository. sources: - name: ruby/gem_rbs_collection remote: https://github.com/ruby/gem_rbs_collection.git @@ -89,9 +92,28 @@ # `rbs collection` avoids to install nokogiri gem's RBS by this change. # It is useful if the nokogiri RBS has a problem, such as compatibility issue with other RBS. - name: nokogiri ignore: true ``` + +### `manifest.yaml` + +If you are a gem maintainer, you can write `manifest.yaml`. +You need to put the file if the gem has implicit dependencies, which don't appear in `Gemfile.lock`. You have to write standard libraries' dependencies in most cases. +For example: + +```yaml +# manifest.yaml + +dependencies: + # If your gem depends on pathname but the gemspec doesn't include pathname, + # you need to write the following. + - name: pathname +``` + +If the gem's RBS is managed with [ruby/gem_rbs_collection](https://github.com/ruby/gem_rbs_collection), put it as `gems/GEM_NAME/VERSION/manifest.yaml`. For example, `gems/activesupport/6.0/manifest.yaml`. +If the gem's RBS is included in the gem package, put it as `sig/manifest.yaml`. + ## Files / Directories * `rbs_collection.yaml` * The configuration file.