OurTechCommunity / OurTechCommunity/catchup

Improve hot reload process for Asciidoctor

Open
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

CI/CD enhancement
Dominant language
JavaScript
Stars
19
Forks
18
Avg merge
3d 6h
Merged PRs (30d)
3

Description

  • Nodemon hotreloads the JS changes.
  • The Asciidoctor summary files are not watched by Nodemon and the build is not triggered every time a .adoc file changes. The Asciidoctor build script runs just once when npm test run is executed.
  • Maybe use something like Chokidar to watch over the summary directory and run the build script every time a .adoc file changes.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the existing Nodemon configuration and the build script invoked by npm test run, then compare how changes under the summary directory are handled. Check whether .adoc changes trigger the Asciidoctor build; done means the watcher rebuilds when those files change while preserving existing JavaScript hot reload behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.