Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes required to make debugging work again #322

Merged
merged 4 commits into from
Feb 3, 2020
Merged

Changes required to make debugging work again #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
739f441
doc: Updated debugging documentation
obilodeau Jan 30, 2020
a6f703e
Fixed dependencies for interactive debugging
obilodeau Jan 30, 2020
73abd89
Updated CHANGELOG
obilodeau Jan 30, 2020
4e5c6d3
Fix JRuby build
obilodeau Jan 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,14 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/master[

Enhancements::
* Built-in slim templates can now be overridden with `--template-dir` or `-T` ({uri-issue}177[#177], {uri-issue}318[#318])
* Documentation improvements ({uri-issue}322[#322])

Compliance::
* Added support for the `sectnums` AsciiDoc attribute ({uri-issue}185[#185], {uri-issue}317[#317])

Bug Fixes::
* Interactive debugging works again ({uri-issue}322[#322])


== 3.1.0 (2020-01-18)

Expand Down
19 changes: 10 additions & 9 deletions HACKING.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@ Two complementary approaches can be used to explore the context offered by ascii

[NOTE]
--
Starting with v1.1.0 the slim templates are compiled to Ruby in order to
use the same templates from Asciidoctor.js (Javascript / Node.js ecosystem).
Don't forget to recompile the templates if you make changes to them.
Debugging is only supported via the Ruby ecosystem.
You need to recompile the templates when you make changes to them.
This can be done by running:

bundle exec rake build
Expand Down Expand Up @@ -80,6 +79,10 @@ In order to be dropped into the debugger at a specific point in a template simpl
- binding.pry
----

Recompile the templates with:

bundle exec rake build

Then run `asciidoctor-revealjs` from the command-line to generate your document and you'll be dropped in the debugger:

----
Expand Down Expand Up @@ -111,13 +114,11 @@ You can also query asciidoctor's documentation:
If you install the `pry-byebug` gem you get additional debugging capabilities.
See the gem's documentation for details.

Since 1.1.0, templates are compiled. It is easier to inject the debug
triggering statements and use the templates directly instead of debugging
compiled templates. You can call the slim templates directly with:

// TODO it's still not clear whether `-r slim-htag` is required right now (#153)
Since 1.1.0, templates are compiled.
It is easier to inject the debug triggering statements and use the templates directly instead of debugging compiled templates.
You can call the slim templates directly with:

bundle exec asciidoctor --trace -T templates/ examples/customcss.adoc
bundle exec asciidoctor-revealjs --trace -T templates/ examples/customcss.adoc

=== References

Expand Down
3 changes: 2 additions & 1 deletion asciidoctor-revealjs.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ Gem::Specification.new do |s|
s.add_development_dependency 'rake', '~> 13.0.0'
s.add_development_dependency 'asciidoctor-doctest', '= 2.0.0.beta.5'
s.add_development_dependency 'minitest', '~> 5.14'
s.add_development_dependency 'pry', '~> 0.10.4'
if RUBY_ENGINE != 'jruby'
s.add_development_dependency 'pry', '~> 0.12.0'
s.add_development_dependency 'irb'
s.add_development_dependency 'pry-byebug'
s.add_development_dependency 'pygments.rb'
end
Expand Down