README.md in missing_rspec-0.0.2 vs README.md in missing_rspec-0.1.0

- old
+ new

@@ -8,18 +8,14 @@ ```ruby gem 'missing_rspec', group: :development ``` -## Usage +## How to use the preview ### How to specify rails path as an argument to rake -```shell -bin/rails runner "puts Rails.root.to_s" -``` - Example when rails path is /app ```shell bin/rails missing_rspec[/app] ``` @@ -39,17 +35,26 @@ ``` ```shell bin/rails missing_rspec ``` -## Execution example +### The second argument can be used to narrow down the target. + +The following is an example of specifying models, controllers and jobs. + ```shell -root@be31b61b9f18:/app/missing_rspec# bin/rails missing_rspec +bin/rails missing_rspec[/app,models;controllers;jobs] +``` +### Execution example +```shell +bin/rails missing_rspec + + The following folders are targeted: ["channels", "controllers", "forms", "helpers", "jobs", "lib", "mailers", "models", "presenters", "services"] <channels> └<application_cable> ├channel.rb └connection.rb @@ -153,9 +158,37 @@ │ ├allowed_sources_deleter.rb ├<customer> │ ├authenticator.rb │ └entry_acceptor.rb └<staff> +``` + +## How to use the creator +Note: Due to the large number of rspec files to be written, It is recommended that you git-commit the file before executing it so that you can revert it. +### Create all RSpecs shown in preview. + +Example when rails path is /app + +```shell +bin/rails missing_rspec_create[/app] +``` + +Example .env file when rails path is /app + +```shell +RAILS_APP_PATH=/app +``` + +```shell +bin/rails missing_rspec_create +``` + +### The second argument can be used to narrow down the target. + +The following is an example of specifying models, controllers and jobs. + +```shell +bin/rails missing_rspec_create[/app,models;controllers;jobs] ``` ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/kayamak/missing_rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kayamak/missing_rspec).