Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added dead-link checking #79

Closed
wants to merge 1 commit into from
Closed

added dead-link checking #79

wants to merge 1 commit into from

Conversation

maxwondercorn
Copy link
Contributor

Resolves #77. Broken links can now be detected via npm run lint:links. This can be run manually as needed. It does not run in Travis-CI because it will always fail on http://localhost:4200. I will work on a PR for whitelisting in Remark - no timetable - and then can add the check to the other markdown linting.

npn run lint:md now has the --frail parameter and will fail in Travis-CI if spellchecking or other linting presets generate a warning.

Updated readme on markdown linting. We're probably 95% covered on spelling and I'm sure we will catch additional words with new pull requests.

If you like, I can do PRs on other guides to add spellchecking/linting.

@Gaurav0 Gaurav0 requested a review from mansona December 7, 2018 16:35
@Gaurav0
Copy link
Contributor

Gaurav0 commented Dec 7, 2018

Looks good to me. @mansona ?

Copy link
Member

@mansona mansona left a comment

Choose a reason for hiding this comment

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

It seems like we are actually adding two things with this PR, one of which I would like to solve before we merge it.

a) adding the frail flag so remark will fail CI
b) implementing link checking (in a way that fails CI if it fails)

@mansona
Copy link
Member

mansona commented Dec 7, 2018

hey @maxwondercorn 👋

My point that I made on #77 (comment) was more along the lines of "if remark doesn't support it then maybe we can support it directly". I understand the benefits of having a command that we can run locally to check links but in a project that is 100% maintained by volunteers I know that we will have times where links sneak through, or indeed links break externally 🙈

I would prefer if we split this up into 2 PRs and kept the "external link checking" PR open until we had a solution that works in CI so that we don't silently assume that it's "done" because we merged the PR related to it.

I hope this all makes sense 😖

@maxwondercorn
Copy link
Contributor Author

I understand the logic, so I'll close this pr and open a new one for error generation on lint fails.My goal it to have the checking done and anything that forces it is good.

You see something similar at work, a process that works until the current person(s) moves on and then it doesn't get done anymore... 😄

@maxwondercorn maxwondercorn deleted the feat/deadlink-lint branch December 7, 2018 18:52
This was referenced Dec 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants