Skip to content
This repository has been archived by the owner on Nov 13, 2023. It is now read-only.

Fix Markdown special characters not being escaped in web help #621

Merged
merged 9 commits into from
Jun 21, 2021

Conversation

t1m0thyj
Copy link
Member

@t1m0thyj t1m0thyj commented Jun 17, 2021

Fixes #620 and #323

  • Fixed inconsistent behavior in DefaultHelpGenerator where Markdown special characters weren't always escaped in descriptions
  • Fixed URL autolinking which stopped working in web help, by passing linkify option to markdown-it
  • Fixed command descriptions not being detected if they begin with non-alphanumeric character (e.g., in the sample plugin)
  • Fixed subgroups not being displayed under their own heading (e.g., in the @broadcom/caview-for-zowe-cli plugin)
  • Updated Jenkinsfile to use npm@7 so that package-lock will stay at lockfile version 2 rather than getting reverted to version 1

@codecov
Copy link

codecov bot commented Jun 17, 2021

Codecov Report

Merging #621 (32e87e0) into master (03a3772) will increase coverage by 0.25%.
The diff coverage is 97.82%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #621      +/-   ##
==========================================
+ Coverage   82.13%   82.39%   +0.25%     
==========================================
  Files         162      163       +1     
  Lines        7768     7854      +86     
  Branches     1342     1367      +25     
==========================================
+ Hits         6380     6471      +91     
+ Misses       1384     1379       -5     
  Partials        4        4              
Impacted Files Coverage Δ
packages/utilities/src/ImperativeConfig.ts 85.96% <ø> (ø)
packages/logger/src/Logger.ts 83.67% <88.88%> (-0.47%) ⬇️
packages/rest/src/client/AbstractRestClient.ts 81.10% <91.66%> (+1.36%) ⬆️
packages/cmd/src/CommandPreparer.ts 96.82% <100.00%> (ø)
packages/cmd/src/help/DefaultHelpGenerator.ts 97.38% <100.00%> (+0.04%) ⬆️
packages/cmd/src/help/WebHelpGenerator.ts 95.74% <100.00%> (+0.18%) ⬆️
packages/cmd/src/help/WebHelpManager.ts 93.75% <100.00%> (ø)
packages/cmd/src/response/CommandResponse.ts 97.04% <100.00%> (+1.50%) ⬆️
...erative/src/plugins/cmd/install/install.handler.ts 93.75% <100.00%> (ø)
...mperative/src/plugins/cmd/update/update.handler.ts 90.62% <100.00%> (ø)
... and 12 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 18e4073...32e87e0. Read the comment docs.

Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes look cool! 😋
I haven't approved it yet 😋
Will approve after generating the web help : )

@t1m0thyj t1m0thyj linked an issue Jun 18, 2021 that may be closed by this pull request
Signed-off-by: Timothy Johnson <[email protected]>
@zFernand0
Copy link
Member

zFernand0 commented Jun 21, 2021

thanks for fixing
image

Copy link
Member

@gejohnston gejohnston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

t1m0thyj added 2 commits June 21, 2021 11:29
Signed-off-by: Timothy Johnson <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Jun 21, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

92.9% 92.9% Coverage
0.0% 0.0% Duplication

@t1m0thyj t1m0thyj merged commit 8ba6e7a into master Jun 21, 2021
@t1m0thyj t1m0thyj deleted the fix-web-help branch June 21, 2021 15:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
4 participants