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.

Sign up for GitHub

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

Jump to bottom

Add option --init-rule-docs #240

Merged
merged 10 commits into from
Nov 18, 2022
Merged

Add option --init-rule-docs #240

merged 10 commits into from
Nov 18, 2022

Conversation

JoshuaKGoldberg
Copy link
Contributor

Fixes #79

@bmish bmish added the enhancement New feature or request label Nov 18, 2022
@bmish bmish changed the title feat: added --init-rule-docs option Add option --init-rule-docs Nov 18, 2022
bmish
bmish requested changes Nov 18, 2022
View reviewed changes
Copy link
Owner

@bmish bmish left a comment

Choose a reason for hiding this comment

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

Looking good.

  1. Can you update the list of options in the README?
  2. There's one more requirement, but it can be a follow-up PR if needed. Fail if there are no rule docs to create so this option isn't left in place indefinitely.

lib/generator.ts Outdated Show resolved Hide resolved
lib/cli.ts Outdated Show resolved Hide resolved
JoshuaKGoldberg and others added 2 commits November 18, 2022 13:07
@JoshuaKGoldberg @bmish
Update lib/cli.ts
5e95fc8 
Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
@JoshuaKGoldberg
README.md entry and removed last arg
0b72bf0
@bmish
Copy link
Owner

bmish commented Nov 18, 2022 •
edited
Loading

One other thing, I finally split up the massive test file in #239. The missing rule doc test has moved to file-paths-test.ts, can you move the new test to there?

JoshuaKGoldberg
JoshuaKGoldberg commented Nov 18, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
bmish
bmish reviewed Nov 18, 2022
View reviewed changes
test/lib/generate/file-paths-test.ts Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@bmish
Copy link
Owner

bmish commented Nov 18, 2022

I'm working on fixing the stuck tests.

@bmish
Copy link
Owner

bmish commented Nov 18, 2022

Tests should be fixed but GitHub Actions have been queued for an hour. Might be a GitHub issue. Will merge and release this when the tests complete.

bmish
bmish approved these changes Nov 18, 2022
View reviewed changes
Copy link
Owner

@bmish bmish left a comment

Choose a reason for hiding this comment

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

Thanks so much for this!

@bmish bmish merged commit 50167bc into bmish:main Nov 18, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the init-rule-docs branch November 18, 2022 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmish bmish bmish approved these changes

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add option to create missing rule docs
2 participants
@JoshuaKGoldberg @bmish