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

Strict order of rules in README.md #817

Merged
merged 4 commits into from
Feb 10, 2019

Conversation

IllusionMH
Copy link
Contributor

@IllusionMH IllusionMH commented Feb 9, 2019

PR checklist

Overview of change:

New validation is added to npm test that will check if rules in REAME.md's table are sorted alphabetically.
Updated create-rule script will also add row for new rule in correct place. @next will be used as placeholder for version as was discussed in #648.

Is there anything you'd like reviewers to focus on?

I've used regular expression to work with table in README.md because HTML markup is pretty simple, RegExp is simple enough, and it helps to avoid adding another dependency for temporary solution (should be removed with #575).

Also, looks like VS Code no longer sets environment variable in terminal, so files should be opened by hand.

Please check Releases that was updated to mention @next placeholder.

@IllusionMH IllusionMH changed the title Strict readme order Strict order of rules in README.md Feb 9, 2019
@JoshuaKGoldberg
Copy link

This looks great, thanks @IllusionMH! Confirmed Releases.md's mention of @next is good.

@JoshuaKGoldberg JoshuaKGoldberg merged commit f70d669 into microsoft:master Feb 10, 2019
@IllusionMH IllusionMH deleted the strict-readme-order branch February 19, 2019 02:36
@IllusionMH IllusionMH added this to the 6.1.0-beta milestone Feb 19, 2019
apawast pushed a commit to lupine86/tslint-microsoft-contrib that referenced this pull request Feb 26, 2019
* Validate order of rules in README.md (fixes microsoft#816)

* Fix rules order in README.md

* create-rule task also updates README (fixed microsoft#816)

* Update CONTRIBUTING.md with detais about README.md actions (fixes microsoft#648)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make strict order of rules in README.md Better describe and suggest new rules' version options
2 participants