carton command
The carton command comes from the carton-tools gem. It reads code with Prism and never runs it, so it needs no RUBY_BOX=1.
carton COMMAND [options] PATH...PATH is a Ruby file or a directory of them, such as main.rb or app. Imports are followed into every Carton they reach. Named imports resolve against -I directories, then the command’s own $LOAD_PATH, so run it under bundle exec in a bundled app.
| Option | Commands | Effect |
|---|---|---|
-I, --include DIR |
both | Add DIR to the load path for named imports |
-o, --output FILE |
rbs |
Where to write the RBS; - for stdout |
--strict |
check |
Fail on warnings too, not only errors |
Exit status is 0 on success, 1 when check finds errors (or warnings with --strict), and 2 for a usage error.
carton rbs
Section titled “carton rbs”Writes RBS for what each import returns, by default to sig/generated/carton.rbs. See Types and checks.
carton check
Section titled “carton check”Prints each problem as file:line: level: message, then a summary line.
| Level | Problem |
|---|---|
| error | An import of a missing path, or of a file inside a Carton |
| error | An import cycle, unless an import in it runs lazily (then a warning) |
| error | A require or require_relative of an imported Carton’s file from outside it, which loads a second copy |
| error | export twice in calls that can both run, export of a Symbol, or a Bare Carton Helper that would hide a Carton::Namespace method |
| error | A Gem Carton importing or requiring a gem its gemspec does not declare |
| error | A key a keyword or Hash literal export does not have, read with fetch or a => pattern |
| error | A private constant of an exported module, such as Billing::Tax when Billing calls private_constant :Tax |
| error | A syntax error |
| warning | A named import not found on the load path, which a gem activated at runtime may provide |
| warning | An import whose path is not a string literal, unless marked # carton:dynamic |
| warning | export in a file inside a Carton, where it does nothing |