cypress-on-rails 1.18.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/claude-code-review.yml +57 -0
  3. data/.github/workflows/claude.yml +50 -0
  4. data/CHANGELOG.md +399 -98
  5. data/README.md +139 -19
  6. data/RELEASING.md +200 -0
  7. data/Rakefile +1 -4
  8. data/cypress-on-rails.gemspec +3 -2
  9. data/docs/BEST_PRACTICES.md +678 -0
  10. data/docs/DX_IMPROVEMENTS.md +163 -0
  11. data/docs/PLAYWRIGHT_GUIDE.md +554 -0
  12. data/docs/RELEASE.md +124 -0
  13. data/docs/TROUBLESHOOTING.md +351 -0
  14. data/docs/VCR_GUIDE.md +499 -0
  15. data/lib/cypress_on_rails/command_executor.rb +24 -0
  16. data/lib/cypress_on_rails/configuration.rb +32 -0
  17. data/lib/cypress_on_rails/railtie.rb +7 -0
  18. data/lib/cypress_on_rails/server.rb +258 -0
  19. data/lib/cypress_on_rails/state_reset_middleware.rb +58 -0
  20. data/lib/cypress_on_rails/version.rb +1 -1
  21. data/lib/generators/cypress_on_rails/install_generator.rb +2 -2
  22. data/lib/generators/cypress_on_rails/templates/config/initializers/cypress_on_rails.rb.erb +14 -2
  23. data/lib/generators/cypress_on_rails/templates/spec/cypress/e2e/rails_examples/using_factory_bot.cy.js +2 -2
  24. data/lib/generators/cypress_on_rails/templates/spec/cypress/e2e/rails_examples/using_scenarios.cy.js +1 -1
  25. data/lib/generators/cypress_on_rails/templates/spec/cypress/support/on-rails.js +1 -1
  26. data/lib/tasks/cypress.rake +33 -0
  27. data/rakelib/release.rake +80 -0
  28. data/rakelib/task_helpers.rb +23 -0
  29. data/rakelib/update_changelog.rake +63 -0
  30. data/spec/cypress_on_rails/configuration_spec.rb +6 -0
  31. data/spec/generators/install_generator_spec.rb +222 -0
  32. metadata +34 -4
data/CHANGELOG.md CHANGED
@@ -1,245 +1,546 @@
1
- ## [1.17.0]
2
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.16.0...v1.17.0
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+ This project adheres to [Semantic Versioning](https://semver.org/).
5
+
6
+ ---
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Fixed
11
+ * **BREAKING: Generator folder structure**: Fixed install generator to create `e2e_helper.rb` and `app_commands/` at the install folder root (e.g., `e2e/`) instead of inside the framework subdirectory (e.g., `e2e/cypress/`). This ensures compatibility between Cypress/Playwright config file location and middleware expectations. [#201]
12
+
13
+ ### Migration Guide for Folder Structure Change
14
+
15
+ #### Breaking Change Notice
16
+ If you previously ran the install generator (versions prior to 1.20.0), the file structure created was incorrect. The generator placed helper and command files in the framework subdirectory when they should be at the install folder root.
17
+
18
+ **Old (Incorrect) Structure:**
19
+ ```
20
+ e2e/
21
+ cypress.config.js
22
+ cypress/
23
+ e2e_helper.rb ← Wrong location
24
+ app_commands/ ← Wrong location
25
+ support/
26
+ e2e/
27
+ ```
28
+
29
+ **New (Correct) Structure:**
30
+ ```
31
+ e2e/
32
+ cypress.config.js
33
+ e2e_helper.rb ← Correct location
34
+ app_commands/ ← Correct location
35
+ fixtures/
36
+ vcr_cassettes/ ← VCR cassettes also at root
37
+ cypress/
38
+ support/
39
+ e2e/
40
+ ```
41
+
42
+ #### How to Migrate
43
+
44
+ **Option 1: Fresh Installation (Recommended for new projects)**
45
+ ```bash
46
+ # Remove old structure
47
+ rm -rf e2e/
48
+
49
+ # Re-run generator
50
+ bin/rails g cypress_on_rails:install --force
51
+ ```
52
+
53
+ **Option 2: Manual Migration (For existing projects with custom code)**
54
+ ```bash
55
+ # Move files to correct location
56
+ mv e2e/cypress/e2e_helper.rb e2e/
57
+ mv e2e/cypress/app_commands e2e/
58
+
59
+ # Update VCR cassettes path if using VCR
60
+ mv e2e/cypress/fixtures e2e/
61
+
62
+ # Verify your initializer has the correct path
63
+ # Should be: c.install_folder = File.expand_path("#{__dir__}/../../e2e")
64
+ # Not: c.install_folder = File.expand_path("#{__dir__}/../../e2e/cypress")
65
+ ```
66
+
67
+ **Option 3: Update Initializer Only (Quick fix, not recommended)**
68
+ If you cannot migrate files immediately, you can temporarily update your initializer:
69
+ ```ruby
70
+ # config/initializers/cypress_on_rails.rb
71
+ c.install_folder = File.expand_path("#{__dir__}/../../e2e/cypress")
72
+ ```
73
+ However, this means Cypress may have issues finding config files. We recommend migrating to the correct structure.
74
+
75
+ #### Why This Change?
76
+ The middleware expects to find `e2e_helper.rb` at `#{install_folder}/e2e_helper.rb` and commands at `#{install_folder}/app_commands/`. Meanwhile, Cypress/Playwright expect config files at the install_folder root when using `--project` flag. The previous structure created a conflict where these requirements couldn't both be satisfied.
77
+
78
+ #### Testing Your Migration
79
+ After migrating, verify:
80
+ 1. Run `bin/rails cypress:open` or `bin/rails playwright:open` - should open successfully
81
+ 2. Run a test that uses app commands - should execute without "file not found" errors
82
+ 3. Check that VCR cassettes (if used) are being created/loaded correctly
83
+
84
+ ---
85
+
86
+ ## [1.19.0] - 2025-10-01
87
+
88
+ ### Added
89
+ * **Rake tasks for test execution**: Added `cypress:open` and `cypress:run` rake tasks for seamless test execution, similar to cypress-rails functionality. Also added `playwright:open` and `playwright:run` tasks.
90
+ * **Server lifecycle hooks**: Added configuration hooks for test server management:
91
+ - `before_server_start`: Run code before Rails server starts
92
+ - `after_server_start`: Run code after Rails server is ready
93
+ - `after_transaction_start`: Run code after database transaction begins
94
+ - `after_state_reset`: Run code after application state is reset
95
+ - `before_server_stop`: Run code before Rails server stops
96
+ * **State reset endpoint**: Added `/cypress_rails_reset_state` and `/__cypress__/reset_state` endpoints for compatibility with cypress-rails
97
+ * **Transactional test mode**: Added support for automatic database transaction rollback between tests
98
+ * **Environment configuration**: Support for `CYPRESS_RAILS_HOST` and `CYPRESS_RAILS_PORT` environment variables
99
+ * **Automatic server management**: Test server automatically starts and stops with test execution
100
+
101
+ ### Migration Guide
102
+
103
+ #### From Manual Server Management (Old Way)
104
+ If you were previously running tests manually:
105
+
106
+ **Before (Manual Process):**
107
+ ```bash
108
+ # Terminal 1: Start Rails server
109
+ CYPRESS=1 bin/rails server -p 5017
110
+
111
+ # Terminal 2: Run tests
112
+ yarn cypress open --project ./e2e
113
+ # or
114
+ npx cypress run --project ./e2e
115
+ ```
116
+
117
+ **After (Automated with Rake Tasks):**
118
+ ```bash
119
+ # Single command - server managed automatically!
120
+ bin/rails cypress:open
121
+ # or
122
+ bin/rails cypress:run
123
+ ```
124
+
125
+ #### From cypress-rails Gem
126
+ If migrating from the `cypress-rails` gem:
127
+
128
+ 1. Update your Gemfile:
129
+ ```ruby
130
+ # Remove
131
+ gem 'cypress-rails'
132
+
133
+ # Add
134
+ gem 'cypress-on-rails', '~> 1.0'
135
+ ```
136
+
137
+ 2. Run bundle and generator:
138
+ ```bash
139
+ bundle install
140
+ rails g cypress_on_rails:install
141
+ ```
142
+
143
+ 3. Configure hooks in `config/initializers/cypress_on_rails.rb` (optional):
144
+ ```ruby
145
+ CypressOnRails.configure do |c|
146
+ # These hooks match cypress-rails functionality
147
+ c.before_server_start = -> { DatabaseCleaner.clean }
148
+ c.after_server_start = -> { Rails.application.load_seed }
149
+ c.transactional_server = true
150
+ end
151
+ ```
152
+
153
+ 4. Use the same commands you're familiar with:
154
+ ```bash
155
+ bin/rails cypress:open
156
+ bin/rails cypress:run
157
+ ```
158
+
159
+ ---
160
+
161
+ ## [1.18.0] — 2025-08-27
162
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.17.0...v1.18.0
163
+
164
+ ### Added
165
+ * **VCR middleware (use_cassette)**: optional middleware that wraps each request with `VCR.use_cassette` (GraphQL supported). Includes configuration via `config/cypress_on_rails.rb` and Cypress commands. [PR 167]
166
+ * **Rails 8 example app & CI job** to validate against the newest framework version. [PR 174]
167
+
168
+ ### Changed
169
+ * **Rails 7.2 example app** updates and CI wiring. [PR 171]
170
+ * Updated JetBrains logo/assets in README. [PR 177]
171
+
172
+ ### Removed
173
+ * Dropped Rails 4 and 5 from CI matrix. [PR 172]
174
+
175
+ ---
176
+
177
+ ## [1.17.0] — 2024-01-28
178
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.16.0...v1.17.0
3
179
 
4
180
  ### Changed
5
- * Removed the update generator and reduced options for install generator [PR 149](https://github.com/shakacode/cypress-on-rails/pull/149)
181
+ * Removed the update generator and reduced options for install generator [PR 149]
6
182
 
7
183
  ### Fixed
8
- * fix update index.js in install generator [PR 147](https://github.com/shakacode/cypress-on-rails/pull/147) by [Judahmeek]
9
- * Support rails 7.1 by adding content-type header to generated on-rails.js file [PR 148](https://github.com/shakacode/cypress-on-rails/pull/148) by [anark]
10
- * Rewind body before reading it [PR 150](https://github.com/shakacode/cypress-on-rails/pull/150)
184
+ * Fix update `index.js` in install generator [PR 147] by [Judahmeek]
185
+ * Support Rails 7.1 by adding `content-type` header to generated `on-rails.js` file [PR 148] by [anark]
186
+ * Rewind body before reading it [PR 150]
187
+
188
+ ---
11
189
 
12
190
  ## [1.16.0]
13
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.15.1...v1.16.0
191
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.15.1...v1.16.0
14
192
 
15
193
  ### Added
16
- * Add support for `before_request` options on the middleware, for authentication [PR 138](https://github.com/shakacode/cypress-on-rails/pull/138) by [RomainEndelin]
194
+ * Add support for `before_request` options on the middleware, for authentication [PR 138] by [RomainEndelin]
195
+
196
+ ---
17
197
 
18
198
  ## [1.15.1]
19
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.15.0...v1.15.1
199
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.15.0...v1.15.1
20
200
 
21
201
  ### Fixed
22
- * fix cypress_folder deprecation warning by internal code [PR 136](https://github.com/shakacode/cypress-on-rails/pull/136)
202
+ * Fix `cypress_folder` deprecation warning by internal code [PR 136]
203
+
204
+ ---
23
205
 
24
206
  ## [1.15.0]
25
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.14.0...v1.15.0
207
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.14.0...v1.15.0
26
208
 
27
209
  ### Changed
28
- * Add support for any e2e testing framewrok starting with Playwright [PR 131](https://github.com/shakacode/cypress-on-rails/pull/131) by [KhaledEmaraDev]
210
+ * Add support for any e2e testing framework starting with Playwright [PR 131] by [KhaledEmaraDev]
211
+
212
+ ---
29
213
 
30
214
  ## [1.14.0]
31
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.13.1...v1.14.0
215
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.13.1...v1.14.0
32
216
 
33
217
  ### Changed
34
- * Add support for proxy routes through `api_prefix` [PR 130](https://github.com/shakacode/cypress-on-rails/pull/130) by [RomainEndelin]
218
+ * Add support for proxy routes through `api_prefix` [PR 130] by [RomainEndelin]
35
219
 
36
220
  ### Fixed
37
- * Properly copies the cypress_helper file when running the update generator [PR 117](https://github.com/shakacode/cypress-on-rails/pull/117) by [alvincrespo]
221
+ * Properly copies the cypress_helper file when running the update generator [PR 117] by [alvincrespo]
38
222
 
39
223
  ### Tasks
40
- * pass cypress record key to github action [PR 110](https://github.com/shakacode/cypress-on-rails/pull/110)
224
+ * Pass Cypress record key to GitHub Action [PR 110]
225
+
226
+ ---
41
227
 
42
228
  ## [1.13.1]
43
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.13.0...v1.13.1
229
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.13.0...v1.13.1
44
230
 
45
231
  ### Fixed
46
- * use_vcr_middleware disabled by default [PR 109](https://github.com/shakacode/cypress-on-rails/pull/109)
232
+ * `use_vcr_middleware` disabled by default [PR 109]
233
+
234
+ ---
47
235
 
48
236
  ## [1.13.0]
49
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.12.1...v1.13.0
237
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.12.1...v1.13.0
50
238
 
51
239
  ### Changed
52
240
  * Add support for matching npm package and VCR
53
- * generate for cypress 10 [PR 108](https://github.com/shakacode/cypress-on-rails/pull/108)
241
+ * Generate for Cypress 10 [PR 108]
242
+
243
+ ---
54
244
 
55
245
  ## [1.12.1]
56
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.12.0...v1.12.1
246
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.12.0...v1.12.1
57
247
 
58
248
  ### Tasks
59
- * Documenting how to setup Factory Associations [PR 100](https://github.com/shakacode/cypress-on-rails/pull/100)
249
+ * Document how to setup Factory Associations [PR 100]
60
250
 
61
251
  ### Fixed
62
- * keep track of factory manual reloads to prevent auto_reload from reloading again [PR 98](https://github.com/shakacode/cypress-on-rails/pull/98)
252
+ * Keep track of factory manual reloads to prevent auto_reload from reloading again [PR 98]
253
+
254
+ ---
63
255
 
64
256
  ## [1.12.0]
65
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.11.0...v1.12.0
257
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.11.0...v1.12.0
66
258
 
67
259
  ### Changed
68
- * only reload factories on clean instead of every factory create request [PR 95](https://github.com/shakacode/cypress-on-rails/pull/95)
69
- * alternative command added for get tail of logs [PR 89](https://github.com/shakacode/cypress-on-rails/pull/89) by [ccrockett]
260
+ * Only reload factories on clean instead of every factory create request [PR 95]
261
+ * Alternative command added for get tail of logs [PR 89] by [ccrockett]
70
262
 
71
263
  ### Tasks
72
- * switch from travis to github actions [PR 96]
264
+ * Switch from Travis to GitHub Actions [PR 96]
265
+
266
+ ---
73
267
 
74
268
  ## [1.11.0]
75
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.10.1...v1.11.0
269
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.10.1...v1.11.0
76
270
 
77
271
  ### Changed
78
- * improve app command logging on cypress
79
- * Allow build and build_list commands to be executed against factory bot [PR 87](https://github.com/shakacode/cypress-on-rails/pull/87) by [Alexander-Blair]
272
+ * Improve app command logging on Cypress
273
+ * Allow build and build_list commands to be executed against FactoryBot [PR 87] by [Alexander-Blair]
274
+
275
+ ---
80
276
 
81
277
  ## [1.10.1]
82
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.9.1...v1.10.1
278
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.9.1...v1.10.1
83
279
 
84
280
  ### Changed
85
- * improve error message received from failed command
281
+ * Improve error message received from failed command
282
+
283
+ ---
86
284
 
87
285
  ## [1.9.1]
88
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.9.0...v1.9.1
286
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.9.0...v1.9.1
89
287
 
90
288
  ### Fixed
91
- * fix using `load` in command files
289
+ * Fix using `load` in command files
290
+
291
+ ---
92
292
 
93
293
  ## [1.9.0]
94
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.8.1...v1.9.0
294
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.8.1...v1.9.0
95
295
 
96
296
  ### Changed
97
- * Update default generated folder to cypress instead of spec/cypress
98
- * Add a generator option to not install cypress
99
- * generator by default does not include examples
100
- * default on local to run cypress in development mode
297
+ * Update default generated folder to `cypress` instead of `spec/cypress`
298
+ * Add a generator option to not install Cypress
299
+ * Generator by default does not include examples
300
+ * Default on local to run Cypress in development mode
301
+
302
+ ---
101
303
 
102
304
  ## [1.8.1]
103
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.8.0...v1.8.1
305
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.8.0...v1.8.1
104
306
 
105
307
  ### Fixed
106
- * remove "--silent" option when adding cypress [PR 76](https://github.com/shakacode/cypress-on-rails/pull/76)
107
- * update cypress examples to use "preserve" instead of "whitelist" [PR 75](https://github.com/shakacode/cypress-on-rails/pull/75) by [alvincrespo](https://github.com/alvincrespo)
308
+ * Remove `--silent` option when adding Cypress [PR 76]
309
+ * Update Cypress examples to use "preserve" instead of "whitelist" [PR 75] by [alvincrespo]
310
+
311
+ ---
108
312
 
109
313
  ## [1.8.0]
110
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.7.0...v1.8.0
314
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.7.0...v1.8.0
111
315
 
112
316
  ### Changed
113
- * Use `FactoryBo#reload` to reset factory bot
317
+ * Use `FactoryBot#reload` to reset FactoryBot
318
+
319
+ ---
114
320
 
115
321
  ## [1.7.0]
116
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.6.0...v1.7.0
322
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.6.0...v1.7.0
117
323
 
118
324
  ### Changed
119
- * Improve eval() in command executor [PR 46](https://github.com/shakacode/cypress-on-rails/pull/46) by [Systho](https://github.com/Systho)
325
+ * Improve eval() in command executor [PR 46] by [Systho]
120
326
 
121
327
  ### Fixed
122
- * Add middleware after load_config_initializers [PR 62](https://github.com/shakacode/cypress-on-rails/pull/62) by [duytd](https://github.com/duytd)
328
+ * Add middleware after load_config_initializers [PR 62] by [duytd]
329
+
330
+ ---
123
331
 
124
332
  ## [1.6.0]
125
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.5.1...v1.6.0
333
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.5.1...v1.6.0
126
334
 
127
335
  ### Changed
128
- * Change default port to 5017 [PR 49](https://github.com/shakacode/cypress-on-rails/pull/49) by [vfonic](https://github/vfonic)
336
+ * Change default port to 5017 [PR 49] by [vfonic]
129
337
 
130
338
  ### Fixed
131
- * fix file location warning message in clean.rb [PR 54](https://github.com/shakacode/cypress-on-rails/pull/54) by [ootoovak](https://github.com/ootoovak)
339
+ * Fix file location warning message in clean.rb [PR 54] by [ootoovak]
340
+
341
+ ---
132
342
 
133
343
  ## [1.5.1]
134
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.5.0...v1.5.1
344
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.5.0...v1.5.1
135
345
 
136
346
  ### Fixed
137
- * fix FactoryBot Trait not registered error [PR 43](https://github.com/shakacode/cypress-on-rails/pull/43)
347
+ * Fix FactoryBot Trait not registered error [PR 43]
348
+
349
+ ---
138
350
 
139
351
  ## [1.5.0]
140
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.4.2...v1.5.0
352
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.4.2...v1.5.0
141
353
 
142
354
  ### Added
143
- * Serialize and return responses to be used in tests [PR 34](https://github.com/shakacode/cypress-on-rails/pull/34).
144
- * Update generator to make it easier to update core generated files [PR 35](https://github.com/shakacode/cypress-on-rails/pull/35).
355
+ * Serialize and return responses to be used in tests [PR 34]
356
+ * Update generator to make it easier to update core generated files [PR 35]
145
357
 
146
358
  ### Tasks
147
- * Update integration tests [PR 36](https://github.com/shakacode/cypress-on-rails/pull/36).
359
+ * Update integration tests [PR 36]
360
+
361
+ ---
148
362
 
149
363
  ## [1.4.2]
150
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.4.1...v1.4.2
364
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.4.1...v1.4.2
151
365
 
152
366
  ### Fixed
153
- * update generator to use full paths for Factory files [PR 33](https://github.com/shakacode/cypress-on-rails/pull/33).
367
+ * Update generator to use full paths for Factory files [PR 33]
368
+
369
+ ---
154
370
 
155
371
  ## [1.4.1]
156
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.4.0...v1.4.1
372
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.4.0...v1.4.1
157
373
 
158
374
  ### Fixed
159
- * fix install generator when using npm [PR 22](https://github.com/shakacode/cypress-on-rails/pull/22) by [josephan](https://github.com/josephan).
375
+ * Fix install generator when using npm [PR 22] by [josephan]
160
376
 
161
377
  ### Tasks
162
- * Fix typo in authentication docs [PR 29](https://github.com/shakacode/cypress-on-rails/pull/27) by [badimalex](https://github.com/badimalex)
163
- * Gemspec: Drop EOL'd property rubyforge_project [PR 27](https://github.com/shakacode/cypress-on-rails/pull/27) by [olleolleolle](https://github.com/olleolleolle)
164
- * Update Travis CI badge in README [PR 31](https://github.com/shakacode/cypress-on-rails/pull/31)
165
- * Fix CI by Installing cypress dependencies on Travis CI [PR 31](https://github.com/shakacode/cypress-on-rails/pull/31)
378
+ * Fix typo in authentication docs [PR 29] by [badimalex]
379
+ * Gemspec: Drop EOL'd property `rubyforge_project` [PR 27] by [olleolleolle]
380
+ * Update Travis CI badge in README [PR 31]
381
+ * Fix CI by installing Cypress dependencies on Travis CI [PR 31]
382
+
383
+ ---
166
384
 
167
385
  ## [1.4.0]
168
- [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.3.0...v1.4.0
386
+ [Compare]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.3.0...v1.4.0
169
387
 
170
- * Accept an options argument for scenarios. [PR 18](https://github.com/shakacode/cypress-on-rails/pull/18) by [ericraio](https://github.com/ericraio).
388
+ * Accept an options argument for scenarios [PR 18] by [ericraio]
171
389
 
172
390
  ### Changed
173
- * renamed CypressDev to CypressOnRails
391
+ * Renamed CypressDev to CypressOnRails
392
+
393
+ ---
174
394
 
175
395
  ## [1.3.0]
176
396
  ### Added
177
- * Send any arguments to simple rails factory, not only hashes by [grantspeelman](https://github.com/grantspeelman).
397
+ * Send any arguments to simple Rails factory, not only hashes by [grantspeelman]
178
398
 
179
399
  ### Improved
180
- * stop running cypress examples on CI
400
+ * Stop running Cypress examples on CI
401
+
402
+ ---
181
403
 
182
404
  ## [1.2.1]
183
405
  ### Fixed
184
- * simple factory fails silently, changed to use create!
406
+ * Simple factory fails silently, changed to use `create!`
407
+
408
+ ---
185
409
 
186
410
  ## [1.2.0]
187
411
  ### Tasks
188
- * adding additional log failure logging
412
+ * Add additional log failure logging
413
+
414
+ ---
189
415
 
190
416
  ## [1.1.1]
191
417
  ### Fixed
192
- * smart factory wrapper can handle when factory files get deleted
418
+ * Smart factory wrapper can handle when factory files get deleted
419
+
420
+ ---
193
421
 
194
422
  ## [1.1.0]
195
423
  ### Tasks
196
- * add cypress examples to install generator
197
- * add active record integration specs
424
+ * Add Cypress examples to install generator
425
+ * Add ActiveRecord integration specs
426
+
427
+ ---
198
428
 
199
429
  ## 1.0.1
200
430
  ### Fixed
201
- * install generator adding on-rails.js to import.js
431
+ * Install generator adding `on-rails.js` to `import.js`
432
+
433
+ ---
202
434
 
203
435
  ## 1.0.0
204
- * renamed to CypressDev
205
- * middleware stripped down to make it more flexible and generic
206
- * concept of generic commands introduced that can have any ruby in it
207
- * and lots of other changes
436
+ * Renamed to CypressDev
437
+ * Middleware stripped down to make it more flexible and generic
438
+ * Concept of generic commands introduced that can have any Ruby in it
439
+ * And lots of other changes
440
+
441
+ ---
208
442
 
209
443
  ## 0.2.2 (2018-03-24)
210
444
  ### Fixed
211
- * fix major bug when using scenarios
445
+ * Fix major bug when using scenarios
446
+
447
+ ---
212
448
 
213
449
  ## 0.2.1 (2017-11-05)
214
450
  ### Fixed
215
- * fix failure in api tests
451
+ * Fix failure in API tests
452
+
453
+ ---
216
454
 
217
455
  ## 0.2.0 (2017-11-05)
218
456
  ### Changed
219
- * remove the need for a seperate port for the setup calls. Requires rerunning `cypress:install` generator
457
+ * Remove the need for a separate port for the setup calls. Requires rerunning `cypress:install` generator
220
458
 
221
- ## 0.1.5 (2017-11-01)
459
+ ---
222
460
 
461
+ ## 0.1.5 (2017-11-01)
223
462
  ### Added
224
- * `cy.rails` command for executing raw ruby on the backend
463
+ * `cy.rails` command for executing raw Ruby on the backend
225
464
  * `cy.setupRails` command for resetting application state
226
465
  * `cypress:install` generator now adds a `beforeEach` call to `cy.setupRails`
227
466
  * `cypress:install` generator configures the `cache_classes` setting in `config/environments/test.rb`
228
- * configuration option to include further modules in your runcontext
467
+ * Configuration option to include further modules in your runcontext
468
+
469
+ ---
229
470
 
230
471
  ## 0.1.2 (2017-10-31)
231
472
  * First release.
232
473
 
233
- [1.8.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.7.0...v1.8.0
234
- [1.7.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.6.0...v1.7.0
235
- [1.6.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.5.1...v1.6.0
236
- [1.5.1]: https://github.com/shakacode/cypress-on-rails/compare/v1.5.0...v1.5.1
237
- [1.5.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.4.2...v1.5.0
238
- [1.4.2]: https://github.com/shakacode/cypress-on-rails/compare/v1.4.1...v1.4.2
239
- [1.4.1]: https://github.com/shakacode/cypress-on-rails/compare/v1.4.0...v1.4.1
240
- [1.4.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.3.0...v1.4.0
241
- [1.3.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.2.1...v1.3.0
242
- [1.2.1]: https://github.com/shakacode/cypress-on-rails/compare/v1.2.0...v1.2.1
243
- [1.2.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.1.1...v1.2.0
244
- [1.1.1]: https://github.com/shakacode/cypress-on-rails/compare/v1.1.0...v1.1.1
245
- [1.1.0]: https://github.com/shakacode/cypress-on-rails/compare/v1.0.0...v1.1.0
474
+ ---
475
+
476
+ [PR 167]: https://github.com/shakacode/cypress-playwright-on-rails/pull/167
477
+ [PR 174]: https://github.com/shakacode/cypress-playwright-on-rails/pull/174
478
+ [PR 171]: https://github.com/shakacode/cypress-playwright-on-rails/pull/171
479
+ [PR 177]: https://github.com/shakacode/cypress-playwright-on-rails/pull/177
480
+ [PR 172]: https://github.com/shakacode/cypress-playwright-on-rails/pull/172
481
+ [PR 149]: https://github.com/shakacode/cypress-playwright-on-rails/pull/149
482
+ [PR 147]: https://github.com/shakacode/cypress-playwright-on-rails/pull/147
483
+ [PR 148]: https://github.com/shakacode/cypress-playwright-on-rails/pull/148
484
+ [PR 150]: https://github.com/shakacode/cypress-playwright-on-rails/pull/150
485
+ [PR 138]: https://github.com/shakacode/cypress-playwright-on-rails/pull/138
486
+ [PR 136]: https://github.com/shakacode/cypress-playwright-on-rails/pull/136
487
+ [PR 131]: https://github.com/shakacode/cypress-playwright-on-rails/pull/131
488
+ [PR 130]: https://github.com/shakacode/cypress-playwright-on-rails/pull/130
489
+ [PR 117]: https://github.com/shakacode/cypress-playwright-on-rails/pull/117
490
+ [PR 110]: https://github.com/shakacode/cypress-playwright-on-rails/pull/110
491
+ [PR 109]: https://github.com/shakacode/cypress-playwright-on-rails/pull/109
492
+ [PR 108]: https://github.com/shakacode/cypress-playwright-on-rails/pull/108
493
+ [PR 100]: https://github.com/shakacode/cypress-playwright-on-rails/pull/100
494
+ [PR 98]: https://github.com/shakacode/cypress-playwright-on-rails/pull/98
495
+ [PR 95]: https://github.com/shakacode/cypress-playwright-on-rails/pull/95
496
+ [PR 89]: https://github.com/shakacode/cypress-playwright-on-rails/pull/89
497
+ [PR 96]: https://github.com/shakacode/cypress-playwright-on-rails/pull/96
498
+ [PR 87]: https://github.com/shakacode/cypress-playwright-on-rails/pull/87
499
+ [PR 76]: https://github.com/shakacode/cypress-playwright-on-rails/pull/76
500
+ [PR 75]: https://github.com/shakacode/cypress-playwright-on-rails/pull/75
501
+ [PR 46]: https://github.com/shakacode/cypress-playwright-on-rails/pull/46
502
+ [PR 62]: https://github.com/shakacode/cypress-playwright-on-rails/pull/62
503
+ [PR 49]: https://github.com/shakacode/cypress-playwright-on-rails/pull/49
504
+ [PR 54]: https://github.com/shakacode/cypress-playwright-on-rails/pull/54
505
+ [PR 43]: https://github.com/shakacode/cypress-playwright-on-rails/pull/43
506
+ [PR 34]: https://github.com/shakacode/cypress-playwright-on-rails/pull/34
507
+ [PR 35]: https://github.com/shakacode/cypress-playwright-on-rails/pull/35
508
+ [PR 36]: https://github.com/shakacode/cypress-playwright-on-rails/pull/36
509
+ [PR 33]: https://github.com/shakacode/cypress-playwright-on-rails/pull/33
510
+ [PR 22]: https://github.com/shakacode/cypress-playwright-on-rails/pull/22
511
+ [PR 29]: https://github.com/shakacode/cypress-playwright-on-rails/pull/29
512
+ [PR 27]: https://github.com/shakacode/cypress-playwright-on-rails/pull/27
513
+ [PR 31]: https://github.com/shakacode/cypress-playwright-on-rails/pull/31
514
+ [PR 18]: https://github.com/shakacode/cypress-playwright-on-rails/pull/18
515
+ [#201]: https://github.com/shakacode/cypress-playwright-on-rails/issues/201
516
+
517
+ <!-- Version diff reference list -->
518
+ [1.19.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.18.0...v1.19.0
519
+ [1.18.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.17.0...v1.18.0
520
+ [1.17.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.16.0...v1.17.0
521
+ [1.16.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.15.1...v1.16.0
522
+ [1.15.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.15.0...v1.15.1
523
+ [1.15.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.14.0...v1.15.0
524
+ [1.14.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.13.1...v1.14.0
525
+ [1.13.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.13.0...v1.13.1
526
+ [1.13.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.12.1...v1.13.0
527
+ [1.12.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.12.0...v1.12.1
528
+ [1.12.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.11.0...v1.12.0
529
+ [1.11.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.10.1...v1.11.0
530
+ [1.10.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.9.1...v1.10.1
531
+ [1.9.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.9.0...v1.9.1
532
+ [1.9.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.8.1...v1.9.0
533
+ [1.8.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.8.0...v1.8.1
534
+ [1.8.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.7.0...v1.8.0
535
+ [1.7.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.6.0...v1.7.0
536
+ [1.6.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.5.1...v1.6.0
537
+ [1.5.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.5.0...v1.5.1
538
+ [1.5.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.4.2...v1.5.0
539
+ [1.4.2]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.4.1...v1.4.2
540
+ [1.4.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.4.0...v1.4.1
541
+ [1.4.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.3.0...v1.4.0
542
+ [1.3.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.2.1...v1.3.0
543
+ [1.2.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.2.0...v1.2.1
544
+ [1.2.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.1.1...v1.2.0
545
+ [1.1.1]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.1.0...v1.1.1
546
+ [1.1.0]: https://github.com/shakacode/cypress-playwright-on-rails/compare/v1.0.0...v1.1.0