TryGhost / TryGhost/NQL

Improve extended debug messsaging logic

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

Nobody has claimed this yet.

cleanup/refactoring
Dominant language
JavaScript
Stars
7
Forks
7
Avg merge
9h 4m
Merged PRs (30d)
22

Description

At the moment, there are multiple places in converter.js that use the following structure:

 if (debugExtended.enabled) {
   debug(`(buildRelationQuery) ...`);
}

This could be extracted to a method like debug(extended) to avoid having if's in multiple
places.


Related discussion

Contributor guide

No contributing guide indexed for this repository

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

Start in converter.js by locating the repeated debugExtended.enabled checks and read the related discussion in pull request 18. Consolidate the repeated conditional behavior behind the proposed debug(extended) method, then verify that extended debug messages still appear when enabled and remain suppressed otherwise.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.