Simplify site nav generation #1221
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ang-zeyu
commented
May 4, 2020
| const siteNavContent = fs.readFileSync(siteNavPath, 'utf8'); | ||
| if (siteNavContent === '') { |
There was a problem hiding this comment.
handled by navigationElements.length === 0 below
ang-zeyu
force-pushed
the
site-nav-refactor
branch
3 times, most recently
from
9a0a7bf
to
b1ecb97
Compare
The site nav generation algorithm is heavily recursive. Let's remove the recursion in favour of a simple iterative process.
ang-zeyu
force-pushed
the
site-nav-refactor
branch
from
b1ecb97
to
bf1e15f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [ ] Documentation update
• [ ] Bug fix
• [ ] New feature
• [ ] Enhancement to an existing feature
• [x] Other, please explain:
Code maintainability
What is the rationale for this request?
formatSiteNavWhat changes did you make? (Give an overview)
formatSiteNavintoinsertSiteNavsince the recursion is removedulelements one by one, and its directlichild elements, formatting it the same way the old algorithm didconstants.jsTesting instructions:
testshould pass ( no test file updates here )Proposed commit message: (wrap lines at 72 characters)
Simplify site nav generation
The site nav generation algorithm is heavily recursive.
Let's remove the recursion in favour of a simple iterative process.