intuit / accessibility-snippets

VSCode Snippets created to help developers write accessible code.

MIT License

102 stars 37 forks source link

Add tests #44

Closed jeffreyclu closed 2 years ago

jeffreyclu commented 2 years ago

What Changed

https://github.com/intuit/accessibility-snippets/issues/40

Added jest testing framework
Renamed css-snippets.code-snippets to css-snippets.json
Renamed react-snippets.code-snippets to react-snippets.json
Added unit tests for both snippet files

Why

The .code-snippets files had to be renamed as .json files so that they could be imported and tested in the test file.

Todo:

[ ] Add Semantic Version Label
[ ] Add tests
[ ] Add docs

jeffreyclu commented 2 years ago

A couple of follow up comments:

I had to rename the snippets files to .json in order to import them in the test file. I'm not sure if this is 100% necessary but I couldn't use the .code-snippets files as is
Since the files were renamed, it will probably break the code in other places, but I'm not quite sure where 😅
I followed this very helpful example: https://github.com/andys8/vscode-jest-snippets/blob/master/snippets/snippets.test.js where the snippet file was already .json, so I thought it should be fine
Currently the react-snippets aren't sorted alphabetically, and I added a test to account for this, but I think sorting the snippets file is out of scope for this PR
This can probably be added as a CI step

syedareehaquasar commented 2 years ago

Hey! @kendallgassner , @jeffreyclu ! I am not able to verify tests working... I am getting errors in the modules imported as .json not found and when I change it to actual file names it gives me an error in syntax... Can you help me with how to verify these tests?

syedareehaquasar commented 2 years ago

I actually needed there to work before working on automating PR tests...