Skip to content

Commit

Permalink
Replace commonmarker with Redcarpet::Markdown (#337)
Browse files Browse the repository at this point in the history
**This PR:**
- Replaces [commonmarker](https://github.com/gjtorikian/commonmarker) with [redcarpet](https://github.com/vmg/redcarpet)
- Simplifies the output of `rspec` to only show failures and not display the details of every test

Dependabot wants to upgrade `commonmarker` to a [version after 1.0](#336) but the latest version doesn't work because of [this issue](github/markup#1758).

Redcarpet renders the example app documentation correctly without any additional code changes.
  • Loading branch information
louis-antonopoulos authored Aug 23, 2024
1 parent e0a3519 commit 771fedc
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 4 deletions.
1 change: 0 additions & 1 deletion .rspec
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
--format documentation
--color
--require spec_helper
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ gem "rails"

gem "bootsnap", ">= 1.4.4", require: false
gem "bourbon"
gem "commonmarker", "< 1.0"
gem "github-markup", require: "github/markup"
gem "jsbundling-rails"
gem "pg", ">= 0.18", "< 2.0"
gem "puma", "~> 6.0"
gem "redcarpet"
gem "sass-rails", ">= 6"
gem "sentry-raven"
gem "themoviedb-api"
Expand Down
4 changes: 2 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ GEM
regexp_parser (>= 1.5, < 3.0)
xpath (~> 3.2)
coderay (1.1.3)
commonmarker (0.23.10)
concurrent-ruby (1.3.4)
connection_pool (2.4.1)
crass (1.0.6)
Expand Down Expand Up @@ -234,6 +233,7 @@ GEM
ffi (~> 1.0)
rdoc (6.7.0)
psych (>= 4.0.0)
redcarpet (3.6.0)
regexp_parser (2.9.2)
reline (0.5.9)
io-console (~> 0.5)
Expand Down Expand Up @@ -332,7 +332,6 @@ DEPENDENCIES
bundler (~> 2.3)
byebug
capybara (>= 3.26)
commonmarker (< 1.0)
dotenv-rails
factory_bot_rails
github-markup
Expand All @@ -343,6 +342,7 @@ DEPENDENCIES
puma (~> 6.0)
rails
rake (~> 13.0)
redcarpet
rspec (~> 3.0)
rspec-rails
rspec_junit_formatter (~> 0.4)
Expand Down

0 comments on commit 771fedc

Please sign in to comment.