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

Update Test Setup and Documentation #263

Merged
merged 1 commit into from
Jul 8, 2022
Merged

Conversation

pjkaufman
Copy link
Collaborator

@platers , does breaking up the tests like this to make them more maintainable make sense to you?

The test.ts file was getting kind of large as we added more rules. To help address this, the tests were moved out to their own separate files in the src/test directory. There is a file for each rule that has extra tests, one for examples, one for empty values, and one for disabled rules. This should make it easier to know where tests are and how to add them without making a multi-thousand line file. I also updated the readme to include the new testing instructions.

Changes Made:

  • Broke tests out into a file per rule tested, examples, disabled rules, and missing rules
  • Updated test based documentation
  • Updated caniuse-lite

… as updating the dependency for browser info
@pjkaufman pjkaufman self-assigned this Jul 8, 2022
@platers
Copy link
Owner

platers commented Jul 8, 2022

LGTM.
Maybe we should move the developer section of the readme to a new file to avoid confusing users.

@pjkaufman
Copy link
Collaborator Author

That sounds good to me. I will plan to do that soon. Hopefully later on today. That should help make it clearer what is for devs and what is for the average user.

@pjkaufman pjkaufman merged commit 1690b42 into platers:master Jul 8, 2022
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.

None yet

2 participants