Update config files to use plain JS instead of JSON #149
+27
−35
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates configuration files from JSON to plain JavaScript in order to simplify code, enable synchronous loading, and support browser contexts.
- Removed asynchronous JSON file reading and replaced it with ES module imports of JS config files.
- Introduced new config files: style/accessibility.js and style/base.js.
- Updated index.js to use these JS configs in a synchronous init function.
Reviewed Changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/accessibility-rules.test.js | Updated to import the JS accessibility config. |
| style/base.js | New file exporting the base config object. |
| style/accessibility.js | New file exporting the accessibility config object. |
| index.js | Updated to import JS configs and use a synchronous init. |
Files not reviewed (2)
- style/accessibility.json: Language not supported
- style/base.json: Language not supported
Comments suppressed due to low confidence (1)
index.js:9
- The init function is now synchronous; please verify that all consumers expecting a Promise are updated accordingly, or document this breaking change.
export function init(consumerConfig) {
JoyceZhu
approved these changes
Apr 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This package was recently updated to read the JSON files asynchronously using Node
fs. This makes the plugin unusable in browser contexts, breaking linting that would run in a browser like https://github.com/iansan5653/github-markdown-a11y-extension.While we can't (yet) import JSON directly in browsers using ESModules, we can just import JS. There's no reason these config files have to be JSON, and by changing them to JS we can simplify the code and change the extension back to a synchronous method. It should also be faster.