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

Confirm README has all example config keys in it #50

Merged
merged 8 commits into from
Oct 30, 2023
Merged

Confirm README has all example config keys in it #50

merged 8 commits into from
Oct 30, 2023

Conversation

aquarat
Copy link
Collaborator

@aquarat aquarat commented Oct 27, 2023 •
edited
Loading

Resolves:

Parse the README file and expect all configuration keys of the airseeker.example.json to be present.

Closes #42

@aquarat aquarat requested review from Siegrift and vponline October 27, 2023 11:08
@aquarat aquarat self-assigned this Oct 27, 2023
@aquarat aquarat marked this pull request as ready for review October 27, 2023 11:09
Siegrift
Siegrift reviewed Oct 27, 2023
View reviewed changes
test/readme.test.ts Outdated Show resolved Hide resolved
Siegrift
Siegrift reviewed Oct 27, 2023
View reviewed changes
test/readme.test.ts Outdated Show resolved Hide resolved
Siegrift
Siegrift reviewed Oct 27, 2023
View reviewed changes
src/config/index.ts Outdated Show resolved Hide resolved
Siegrift
Siegrift reviewed Oct 27, 2023
View reviewed changes
test/readme.test.ts Outdated Show resolved Hide resolved
@aquarat aquarat requested a review from Siegrift October 30, 2023 10:07
Siegrift
Siegrift reviewed Oct 30, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
src/config/index.ts Outdated Show resolved Hide resolved
@aquarat aquarat requested a review from Siegrift October 30, 2023 13:13
@aquarat
Copy link
Collaborator Author

aquarat commented Oct 30, 2023 •
edited
Loading

I've reverted the README changes, implemented your regex based search and mocked the readFileSync calls so the config loader will work with the example config without requiring extra arguments :) @Siegrift

Siegrift
Siegrift approved these changes Oct 30, 2023
View reviewed changes
Copy link
Collaborator

@Siegrift Siegrift left a comment

Choose a reason for hiding this comment

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

👍 LGTM

@aquarat aquarat merged commit 62585a0 into main Oct 30, 2023
@aquarat aquarat deleted the 42-check-readme branch October 30, 2023 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Siegrift Siegrift Siegrift approved these changes

@vponline vponline Awaiting requested review from vponline

Assignees

@aquarat aquarat

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a test that ensures configuration is documented in README
2 participants
@aquarat @Siegrift