admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #8939 from issyl0/sorbet-docs-files-dot-yaml

Browse Source 
docs/typechecking: Remove mentions of sorbet/files.yaml
This commit is contained in:
Issy Long 2020-10-17 22:32:58 +01:00 committed by GitHub
commit d8d65171f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/Typechecking.md
View File

@ -27,8 +27,8 @@ file are always passed first (if it exists), followed by arguments provided on t
command line. We use it ignore the `Library/Homebrew/vendor` directory, which command line. We use it ignore the `Library/Homebrew/vendor` directory, which
contains gem definitions which we do not wish to type check. contains gem definitions which we do not wish to type check.
- The `files.yaml` file. It contains a list of every Ruby file in the codebase - Every Ruby file in the codebase is divided into three strictness levels: false,
divided into 3 strictness levels, false, true and strict. The `false` files only true and strict. The `false` files only
report errors related to the syntax, constant resolution and correctness of the report errors related to the syntax, constant resolution and correctness of the
method signatures, and not type errors. We use this file to override strictness method signatures, and not type errors. We use this file to override strictness
on a file-by-file basis. Our longtime goal is to move all `false` files to `true` on a file-by-file basis. Our longtime goal is to move all `false` files to `true`
@ -40,11 +40,12 @@ out the resulting type errors. Read more about Sorbet's strictness levels
## Using `brew typecheck` ## Using `brew typecheck`
When run without any arguments, `brew typecheck`, will run considering the strictness levels When run without any arguments, `brew typecheck`, will run considering the strictness levels
set in the `files.yaml` file. However, when typecheck is run on a specific file set in each of the individual Ruby files in the core Homebrew codebase. However, when
or directory, more errors may show up since Sorbet can not resolve constants defined typecheck is run on a specific file or directory, more errors may show up since Sorbet
outside the scope of the specified file. These problems can be solved with RBI files. cannot resolve constants defined outside the scope of the specified file. These
Currently `brew typecheck` provides `quiet`, `--file`, `--dir` and `--ignore` options problems can be solved with RBI files. Currently `brew typecheck` provides `--quiet`, `--file`,
but you can explore more options with `srb tc --help` and passing them with `srb tc`. `--dir` and `--ignore` options but you can explore more options with `srb tc --help` and
passing them with `srb tc`.
## Resolving Type Errors ## Resolving Type Errors