Restore `markdownlint` tests by xtqqczze · Pull Request #12549 · PowerShell/PowerShell

xtqqczze · 2020-05-02T00:12:32Z

PR Summary

PR Context

markdownlint tests were removed in #10163 due to a security issue whoch has since been fixed in a newer version of markdownlint

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
User-facing changes
- Not Applicable
- OR
- Documentation needed
  - Issue filed:
Testing - New and feature
- N/A or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and enumerated concerns in the summary. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode (which runs in a different PS Host).
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).

xtqqczze · 2020-05-02T01:15:00Z

Codacy markdown issues seem to contradict markdownlint issues.

xtqqczze · 2020-05-02T14:01:51Z

test/common/markdown/gulpfile.js

Found non-literal argument in require (security/detect-non-literal-require)

New commits

xtqqczze · 2020-05-02T18:44:03Z

┌───────────────┬──────────────────────────────────────────────────────────────┐
│ low           │ Prototype Pollution                                          │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package       │ yargs-parser                                                 │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in    │ >=13.1.2 <14.0.0 || >=15.0.1 <16.0.0 || >=18.1.2             │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path          │ gulp > gulp-cli > yargs > yargs-parser                       │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info     │ https://www.npmjs.com/advisories/1500                        │
└───────────────┴──────────────────────────────────────────────────────────────┘

The maintainer of the affected package claims the yargs-parser vulnerability does not introduce an attack vector in gulp.

See: gulpjs/gulp#2438

tools/install-powershell.sh-README.md

TravisEz13 · 2020-05-04T18:37:54Z

There mere presence of a high scored vuln on the machine will trigger the same issue that cause this to be removed.

TravisEz13 · 2020-05-04T19:24:54Z

I made a couple of edits to your branch. Please pull your branch if you need to edit something.

TravisEz13 · 2020-05-04T22:12:25Z

That component is not currently generating an alert.

xtqqczze · 2020-05-05T02:50:33Z

The maintainer of gulp says the vulnerable dependency will not be updated until the project releases a new major version, which does not appear to be imminient.

See: yargs/yargs-parser#264 (comment)

xtqqczze · 2020-05-05T03:17:40Z

@TravisEz13 Perhaps we could do without gulp anyway, and use npm-run-script or equivalent?

TravisEz13 · 2020-05-05T19:39:07Z

@xtqqczze I'm not tied to gulp. As long as we still get test results. But if it reduces dependencies, I'm all for it.

TravisEz13 · 2020-05-05T19:39:49Z

Tell me if you want me to merge this as is and then update, or you want to change it first.

xtqqczze · 2020-05-06T00:55:43Z

@TravisEz13 Merge this for now please.

test/common/markdown/markdown.tests.ps1

test/common/markdown/gulpfile.js

xtqqczze · 2020-05-30T20:04:29Z

rebased to resolve conflicts

xtqqczze · 2020-05-30T20:12:42Z

@TravisEz13 I'm not my change in 4180235 to use Write-Host is the best approach (CodeFactor issue), but I think we should log $markdownErrors somehow...

* Split `\install-powershell-readme.md` into `install-powershell.ps1-README.md` and `install-powershell.sh-README.md` to fix `single-h1` * Formatting changes to github issue templates as a result of fixing `single-h1`

xtqqczze · 2020-05-30T20:32:02Z

rebased to fix additionally markdownlint errors

test/common/markdown/gulpfile.js

TravisEz13

One one comment to address

TravisEz13 · 2020-06-02T18:26:02Z

@PoshChan Please remind me in 1 hour

PoshChan · 2020-06-02T19:26:18Z

@TravisEz13, this is the reminder you requested 1 hour ago

ghost · 2020-06-25T19:04:38Z

🎉v7.1.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

ghost assigned daxian-dbw May 2, 2020

xtqqczze requested review from TravisEz13, adityapatwardhan, anmenaga, daxian-dbw and joeyaiello as code owners May 2, 2020 01:02

iSazonov previously approved these changes May 2, 2020

View reviewed changes

iSazonov assigned TravisEz13 and unassigned daxian-dbw May 2, 2020

xtqqczze commented May 2, 2020

View reviewed changes

test/common/markdown/gulpfile.js Outdated

Copy link

Contributor Author

xtqqczze May 2, 2020

Choose a reason for hiding this comment

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

Found non-literal argument in require (security/detect-non-literal-require)

iSazonov self-requested a review May 2, 2020 18:25

TravisEz13 reviewed May 4, 2020

View reviewed changes

tools/install-powershell.sh-README.md Outdated Show resolved Hide resolved

TravisEz13 added the CL-Test Indicates that a PR should be marked as a test change in the Change Log label May 4, 2020

TravisEz13 added this to the 7.1.0-preview.3 milestone May 4, 2020

TravisEz13 reviewed May 6, 2020

View reviewed changes

test/common/markdown/markdown.tests.ps1 Outdated Show resolved Hide resolved

TravisEz13 reviewed May 6, 2020

View reviewed changes

test/common/markdown/gulpfile.js Outdated Show resolved Hide resolved

TravisEz13 modified the milestones: 7.1.0-preview.3, 7.1.0-preview.4 May 14, 2020

xtqqczze force-pushed the restore-markdownlint branch from adb84a0 to 86a86c6 Compare May 24, 2020 18:41

xtqqczze and others added 6 commits May 30, 2020 21:00

update markdownlint to v0.20.2

2412696

Address Codacy issues

bef23d6

Update markdown-link.tests.ps1

f8a767e

Update misc-analysis.yml

8a6b8a7

Update test/common/markdown/markdown.tests.ps1

1f636c6

Fix formatting

d99da83

xtqqczze force-pushed the restore-markdownlint branch from 19e6c61 to 4180235 Compare May 30, 2020 20:01

xtqqczze and others added 4 commits May 30, 2020 21:28

Fix markdownlint errors

00256c6

* Split `\install-powershell-readme.md` into `install-powershell.ps1-README.md` and `install-powershell.sh-README.md` to fix `single-h1` * Formatting changes to github issue templates as a result of fixing `single-h1`

Run yarn upgrade

c56002e

Update misc-analysis.yml

fd56dc7

Write errors to host

3a1a172

xtqqczze force-pushed the restore-markdownlint branch from 4180235 to 3a1a172 Compare May 30, 2020 20:31

TravisEz13 reviewed Jun 2, 2020

View reviewed changes

test/common/markdown/gulpfile.js Show resolved Hide resolved

TravisEz13 requested changes Jun 2, 2020

View reviewed changes

ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jun 2, 2020

ghost removed this from the 7.1.0-preview.4 milestone Jun 2, 2020

Update test/common/markdown/gulpfile.js

ce72a03

TravisEz13 approved these changes Jun 2, 2020

View reviewed changes

TravisEz13 changed the title ~~Restore markdownlint tests~~ Restore markdownlint tests Jun 2, 2020

TravisEz13 merged commit b03b968 into PowerShell:master Jun 2, 2020

iSazonov removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jun 3, 2020

iSazonov added this to the 7.1.0-preview.4 milestone Jun 3, 2020

ghost mentioned this pull request Jun 25, 2020

Restore markdownlint tests #12539

Closed

xtqqczze deleted the restore-markdownlint branch June 29, 2020 13:19

Conversation

xtqqczze commented May 2, 2020

PR Summary

PR Context

PR Checklist

Uh oh!

xtqqczze commented May 2, 2020

Uh oh!

xtqqczze May 2, 2020

Choose a reason for hiding this comment

Uh oh!

xtqqczze commented May 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

TravisEz13 commented May 4, 2020

Uh oh!

TravisEz13 commented May 4, 2020

Uh oh!

TravisEz13 commented May 4, 2020

Uh oh!

xtqqczze commented May 5, 2020

Uh oh!

xtqqczze commented May 5, 2020

Uh oh!

TravisEz13 commented May 5, 2020

Uh oh!

TravisEz13 commented May 5, 2020

Uh oh!

xtqqczze commented May 6, 2020

Uh oh!

Uh oh!

Uh oh!

xtqqczze commented May 30, 2020

Uh oh!

xtqqczze commented May 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xtqqczze commented May 30, 2020

Uh oh!

Uh oh!

TravisEz13 left a comment

Choose a reason for hiding this comment

Uh oh!

TravisEz13 commented Jun 2, 2020

Uh oh!

PoshChan commented Jun 2, 2020

Uh oh!

ghost commented Jun 25, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Comments

xtqqczze commented May 2, 2020 •

edited

Loading

xtqqczze commented May 30, 2020 •

edited

Loading