Skip to content

Commit e0ca0aa

Browse files
committed
Improve jt help and use groups for related commands
1 parent c9ca9ad commit e0ca0aa

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

tool/jt.rb

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -808,23 +808,30 @@ def help
808808
jt gem shortcut for `jt ruby -S gem`, to install Ruby gems, etc
809809
jt e 14 + 2 evaluate an expression
810810
jt puts 14 + 2 evaluate and print an expression
811-
jt cextc directory compile the C extension in directory
812-
jt test run all mri tests, specs and integration tests
813-
jt test basictest run MRI's basictest suite
814-
jt test bootstraptest run MRI's bootstraptest suite
815-
jt test mri run mri tests
816-
#{MRI_TEST_MODULES.map { |k, h| format ' ' * 4 + '%-16s%s', k, h[:help] }.join("\n")}
817-
jt test mri test/mri/tests/test_find.rb [-- <MRI runner options>]
818-
run tests in given file, -n option of the runner can be used to further
819-
limit executed test methods
820-
jt lint run all lints, used in CI
821-
jt lint fast run fast lints, recommended as a git hook (see tool/hooks/lint-check.sh)
811+
---
812+
ruby/spec commands:
822813
jt test specs [fast] [mspec arguments] [-- ruby options]
823814
jt test specs run all specs
824-
jt test specs fast run all specs except sub-processes, GC, sleep, ...
815+
jt test fast run all specs except sub-processes, GC, sleep, ...
825816
jt test spec/ruby/language run specs in this directory
826817
jt test spec/ruby/language/while_spec.rb run specs in this file
827818
jt test ... -- --jdebug run specs with the Java debugger
819+
jt tag PATH tag failing specs
820+
jt tag all FILE tag all specs in this file, without running them
821+
jt untag ... untag passing specs
822+
jt purge ... remove tags without specs
823+
jt mspec ... run MSpec with the TruffleRuby configuration and custom arguments
824+
---
825+
MRI tests commands:
826+
jt test mri run MRI tests
827+
#{MRI_TEST_MODULES.map { |k, h| format ' ' * 4 + '%-16s%s', k, h[:help] }.join("\n")}
828+
jt test mri test/mri/tests/test_find.rb [-- <MRI runner options>]
829+
run tests in given file, -n option of the runner can be used to further
830+
limit executed test methods
831+
jt retag FILE Remove MRI excludes and re-add as necessary for MRI tests
832+
---
833+
jt test basictest run MRI's basictest suite
834+
jt test bootstraptest run MRI's bootstraptest suite
828835
jt test compiler run compiler tests
829836
jt test integration [TESTS] run integration tests
830837
jt test bundle [--jdebug] tests using bundler
@@ -834,14 +841,12 @@ def help
834841
run C extension tests (set GEM_HOME)
835842
jt test unit [unittest flags] [-- mx options] run Java unittests
836843
jt test tck run tck tests
837-
jt gem-test-pack check that the gem test pack is downloaded, or download it for you, and print the path
844+
---
845+
jt lint run all lints, used in CI
846+
jt lint fast run fast lints, recommended as a git hook (see tool/hooks/lint-check.sh)
838847
jt rubocop [rubocop options] run rubocop rules (using ruby available in the environment)
839-
jt tag spec/ruby/language tag failing specs in this directory
840-
jt tag spec/ruby/language/while_spec.rb tag failing specs in this file
841-
jt tag all spec/ruby/language tag all specs in this file, without running them
842-
jt untag ... untag passing specs
843-
jt purge ... remove tags without specs
844-
jt mspec ... run MSpec with the TruffleRuby configuration and custom arguments
848+
---
849+
jt gem-test-pack check that the gem test pack is downloaded, or download it for you, and print the path
845850
jt metrics alloc [--json] ... how much memory is allocated running a program
846851
jt metrics instructions ... how many CPU instructions are used to run a program
847852
jt metrics minheap ... what is the smallest heap you can use to run an application

0 commit comments

Comments
 (0)