Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable RBS collection feature #420

Merged
merged 1 commit into from
Sep 10, 2021
Merged

Conversation

pocke
Copy link
Contributor

@pocke pocke commented Aug 28, 2021

This PR introduces rbs collection feature, ruby/rbs#589, to Steep.

Usage

  • If rbs_collection.yaml exists in the same directory as Steepfile, Steep loads libraries' RBSs from the config file.
  • If collection_config path is specified in Steepfile, Steep loads libraries' RBSs from the specified file.
    • I suppose the configuration will be used like collection_config '../other/path/rbs_collection.yaml' in many cases.
  • If disable_collection is specified in Steepfile, Steep ignores rbs_collection.yaml.
  • If rbs_collection.yaml doesn't exist and no options are specified, Steep does nothing about rbs collection feature.

@@ -131,4 +131,80 @@ def test_diagnostics
end
end
end

def test_collection_implicit
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The added test cases check that the collection_lock is set (or not), but it doesn't test the libs' RBSs are loaded to the environment. I'm not sure where should I write a test to check it. Could you help me?

By the way, I've tested that Steep loads the libs, by hand.

@pocke pocke marked this pull request as ready for review September 9, 2021 15:18
@pocke pocke changed the title WIP enable RBS collection feature Enable RBS collection feature Sep 9, 2021
Copy link
Owner

@soutaro soutaro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 🍔

@soutaro soutaro merged commit 0673d88 into soutaro:master Sep 10, 2021
@pocke pocke deleted the rbs_collection branch September 17, 2021 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants