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

Add Steepfile as Ruby filename #5663

Merged
merged 3 commits into from
Feb 16, 2022
Merged

Conversation

mattt
Copy link
Contributor

@mattt mattt commented Nov 29, 2021

steep is a static type checker for Ruby based on RBS.

Users can run the steep check command to type check their Ruby code. This command looks for a file named Steepfile, a Ruby file that configures how type checking is performed.

Example Steepfile
target :lib do
  signature 'sig'

  check 'lib'

  configure_code_diagnostics do |config|
    config[Steep::Diagnostic::Ruby::UnsupportedSyntax] = :hint
  end
end

target :test do
  signature 'sig'

  check 'spec'
end

According to GitHub code search there are currently a few hundred instances of Steepfile in the wild. I expect this number to grow over time as developers start to adopt RBS in their Ruby codebases.

Description

This PR adds Steepfile to the list of Ruby filenames and adds a sample file to samples/Ruby/filenames/Steepfile

Checklist:

@mattt mattt requested a review from a team as a code owner November 29, 2021 14:05
@lildude
Copy link
Member

lildude commented Nov 30, 2021

Looks like usage has a long way to go still:

Total files found: 364
Unique public user/repos: 82
Unique owners: 63

Copy link
Member

@lildude lildude left a comment

Choose a reason for hiding this comment

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

Ooo, I've just realised that you would generally only have one Steepfile per project so the fact we have more than 200 files would suggest it's in use by more than 200 unique :user/:repo. Approving.

@lildude lildude merged commit 61c0835 into github-linguist:master Feb 16, 2022
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.

None yet

2 participants