Default to check the entire current directory when there is no `Steepfile` #968

ParadoxV5 · 2023-11-24T00:45:47Z

This allows Steep to work out-of-the-box with no further setup required.
Though of course users are encouraged to set up their Steepfile according to their project structure.

May relate to soutaro/steep-vscode#227 (comment)

Tests

Integration Test: no idea where to put it <.<
- DriverHelper: no unit test
- Project: empty unit test
- WorkerProcess: no unit test

Q: Why current directory (rather than `lib` + `sig`)?

This matches the minimum (i.e., least set up) project structure of dumping everything in the project root.

Recommended follow-up

Utilize nilable Steepfile path in tests instead of leaving the Steepfile non-existent.

ParadoxV5 · 2023-11-24T00:53:22Z

lib/steep/drivers/worker.rb

@@ -21,7 +21,7 @@ def initialize(stdout:, stderr:, stdin:)

      def run()
        Steep.logger.tagged("#{worker_type}:#{worker_name}") do
-          project = load_config()
+          project = load_config(warnings: false) # Main process has already emitted any warnings


Unfortunately, Steep spawns entirely new worker processes (likely considering the Ruby GVL and that Windows has no fork) with no parent-child relationship to the main process. This means every worker have to completely reload Steepfile.

Steps to Reproduce

$ mkdir steep_workers $ cd steep_workers $ echo "puts 'hello, world'" > Steepfile $ steep check

Actual

hello, world # Type checking files: hello, world hello, world hello, world hello, world hello, world hello, world hello, world hello, world No type error detected. 🫖

Expected

hello, world # Type checking files: No type error detected. 🫖

Steps to Reproduce

$ mkdir steep_workers $ cd steep_workers $ echo 'target :app do typing_options end' > Steepfile $ steep check

Actual

[Steep 1.6.0] [Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace # Type checking files: [Steep 1.6.0] [typecheck:typecheck@0] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@0] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@1] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@1] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@2] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@2] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@3] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@3] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@4] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@4] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@5] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@5] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@6] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@6] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace [Steep 1.6.0] [typecheck:typecheck@7] [/tmp/steep2/steep_workers/Steepfile] [target=app] #typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting: [Steep 1.6.0] [typecheck:typecheck@7] [/tmp/steep2/steep_workers/Steepfile] [target=app] # D = Steep::Diagnostic # Define a constant to shorten namespace .................................................................................. No type error detected. 🫖

soutaro · 2023-11-27T01:25:45Z

@ParadoxV5 Adding a behavior without Steepfile would make sense.

I'm not sure if type checking everything from the current directory is great or not. It will report many unexpected type errors, from spec, test, or vendor/bundle...

Integration Test:

You can test with cli_test.rb.

soutaro · 2023-11-27T01:26:04Z

lib/steep/drivers/utils/driver_helper.rb

+            end
+          else
+            if warnings # Silence warnings in children worker processes
+              warn "Cannot find a configuration at #{path}: `steep init` to scaffold. Using current directory..."


Steep.logger.error ?

Never realized Steep uses a logger system. I will check it out.

Would this be an error or a warning? This PR sought to support non-mandatory Steepfile after all.

I was afraid if warn is hidden by default, but confirmed the default log level is info.
So, Steep.logger.warn would be the best one.

I’ve replaced it with Steep.logger.warn and written tests but haven’t pushed the changes, for I discovered that Steep.logger.warn doesn’t print whereas both Steep.logger.error and plain warn are fine. Let me know if this is intended and which direction I should move forward.

@ParadoxV5 I'm sorry. It's my bad. ERROR is the default value and it should be Steep.logger.error. 🙇‍♂️

https://github.com/soutaro/steep/blob/master/lib/steep.rb#L158

GitHub blame showed that ’twas changed from WARN to ERROR with #322.

Why though? WARN also sounds quite critical. Whereas INFO – the level below WARN – sounds safe to ignore for default configs.

ParadoxV5 · 2023-11-27T06:43:36Z

I'm not sure if type checking everything from the current directory is great or not. It will report many unexpected type errors, from spec, test, or vendor/bundle...

I was thinking that users would set up a Steepfile if they have a project structure, similar to Gemfile; but sure, they may very well forget to if they’re not reminded about one.

You can test with cli_test.rb.

👍

soutaro · 2023-12-01T03:47:59Z

@ParadoxV5 Ok, I'm not completely sure for the feature, but we can implement this. 👍

ParadoxV5 · 2023-12-01T05:00:01Z

@ParadoxV5 Ok, I'm not completely sure for the feature, but we can implement this. 👍

What are the aspects that you aren’t confident yet?

I gave steep-vscode a try. VSCode attempts to activate it even when there’s no Gemfile and Steepfile which this LSP depends on. Worse, VSCode retries multiple times and all failures are reported (read: spammed) to the user. This motivated me to write this PR and file soutaro/steep-vscode#296.

Fix `Project#initialize` `nil` check

ParadoxV5 added 3 commits November 23, 2023 15:20

Make Project#steepfile_path nilable

c99c4e0

Make Project#base_dir able to handle nil #steepfile_path

02460dc

DriverHelper#load_config stub default configs when 404 steepfile

d015584

ParadoxV5 commented Nov 24, 2023

View reviewed changes

ParadoxV5 mentioned this pull request Nov 25, 2023

Don’t use Bundler if bundle exec fails soutaro/steep-vscode#296

Open

soutaro reviewed Nov 27, 2023

View reviewed changes

ParadoxV5 mentioned this pull request Nov 27, 2023

Ignore the rbs_collection.lock.yaml file if it’s missing or has syntax error #969

Closed

3 tasks

ParadoxV5 added 2 commits December 18, 2023 21:21

Add test_check_no_steepfile & fix

ca14614

Fix `Project#initialize` `nil` check

Use Steep.logger.error over warn

cc5be6c

ParadoxV5 requested a review from soutaro December 19, 2023 04:26

soutaro added this to the Steep 1.7 milestone Dec 27, 2023

soutaro approved these changes Dec 27, 2023

View reviewed changes

soutaro merged commit b5e9ea3 into soutaro:master Dec 27, 2023
15 checks passed

ParadoxV5 deleted the no-Steepfile branch December 28, 2023 05:02

soutaro added Released The PR is already included in a published release and removed Released The PR is already included in a published release labels Jan 30, 2024

soutaro added the Released The PR is already included in a published release label Jun 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Default to check the entire current directory when there is no `Steepfile` #968

Default to check the entire current directory when there is no `Steepfile` #968

ParadoxV5 commented Nov 24, 2023 •

edited

Loading

ParadoxV5 Nov 24, 2023 •

edited

Loading

ParadoxV5 Nov 27, 2023

soutaro commented Nov 27, 2023

soutaro Nov 27, 2023

ParadoxV5 Nov 27, 2023

ParadoxV5 Nov 27, 2023

soutaro Dec 1, 2023

ParadoxV5 Dec 3, 2023

soutaro Dec 4, 2023

ParadoxV5 Dec 4, 2023 •

edited

Loading

ParadoxV5 commented Nov 27, 2023

soutaro commented Dec 1, 2023

ParadoxV5 commented Dec 1, 2023

Default to check the entire current directory when there is no Steepfile #968

Default to check the entire current directory when there is no Steepfile #968

Conversation

ParadoxV5 commented Nov 24, 2023 • edited Loading

Tests

Q: Why current directory (rather than lib + sig)?

Recommended follow-up

ParadoxV5 Nov 24, 2023 • edited Loading

Choose a reason for hiding this comment

Steps to Reproduce

Actual

Expected

ParadoxV5 Nov 27, 2023

Choose a reason for hiding this comment

Steps to Reproduce

Actual

soutaro commented Nov 27, 2023

soutaro Nov 27, 2023

Choose a reason for hiding this comment

ParadoxV5 Nov 27, 2023

Choose a reason for hiding this comment

ParadoxV5 Nov 27, 2023

Choose a reason for hiding this comment

soutaro Dec 1, 2023

Choose a reason for hiding this comment

ParadoxV5 Dec 3, 2023

Choose a reason for hiding this comment

soutaro Dec 4, 2023

Choose a reason for hiding this comment

ParadoxV5 Dec 4, 2023 • edited Loading

Choose a reason for hiding this comment

ParadoxV5 commented Nov 27, 2023

soutaro commented Dec 1, 2023

ParadoxV5 commented Dec 1, 2023

Default to check the entire current directory when there is no `Steepfile` #968

Default to check the entire current directory when there is no `Steepfile` #968

ParadoxV5 commented Nov 24, 2023 •

edited

Loading

Q: Why current directory (rather than `lib` + `sig`)?

ParadoxV5 Nov 24, 2023 •

edited

Loading

ParadoxV5 Dec 4, 2023 •

edited

Loading