extend eslint to lint mdx files, snippets. enable in vscode #6958
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
* Updates to Vite + React quickstart * Update src/fragments/gen2/quickstart/build-a-backend.mdx Co-authored-by: Kevin Old <kevold@amazon.com> * Update build-a-backend.mdx * Update build-a-backend.mdx * Update build-a-backend.mdx --------- Co-authored-by: Kevin Old <kevold@amazon.com>
…atform (aws-amplify#6947) Co-authored-by: Tim Nguyen <54393192+timngyn@users.noreply.github.com>
…ctive pl…" (aws-amplify#6955) This reverts commit 5998b22.
…mplify#6954) * chore: more layout refactoring * remove unused prop, alphabetize props
* include usage for multi-page apps * improve multi-page app docs * use Hub syntax * update imports in examples
* chore: Clean up broken Amplify JS API reference links. * Cleaned up language.
* update build image settings for Gen 2 * remove callout and add fragment to vite guide
* chore: add unit test for YoutubeEmbed component * add code coverage stats --------- Co-authored-by: katiegoines <katiegoines@gmail.com>
* chore: add unit tests for Accordion component * issue with window properties * fixed tracking test * working on animation issue * accordion tests * fix testing errors * added test for closing accordion * add code coverage stats --------- Co-authored-by: katiegoines <katiegoines@gmail.com>
* Add algolia env vars to next.config * Remove extra code string
…; add build step to docs (aws-amplify#6970) * fix(data): update React Native minimum iOS deployment target; add build step to docs * address PR feedback * remove deployment target guidance * add React Native version deployment target callout * fix unrecognized syntax * replace callout with accordion * move 'upgrading' callout
* chore: add unit tests for MigrationAlert component * chore: add unit tests for MigrationAlert component --------- Co-authored-by: katiegoines <katiegoines@gmail.com>
Co-authored-by: katiegoines <katiegoines@gmail.com>
Co-authored-by: katiegoines <katiegoines@gmail.com>
* chore: add unit test for CLICommands * chore: add unit test for Columns * Update Command.test.tsx triggering checks --------- Co-authored-by: katiegoines <katiegoines@gmail.com>
* Update relative urls * Update url
* Updating link checker to account for duplicate urls from different pages and link text * Update slack formatting * Remove console.log * Add comments to function * Remove extra console.logs()
* update redirects * updated redirects --------- Co-authored-by: katiegoines <katiegoines@gmail.com>
* fix(v5): update aws-amplify v5 dependency * chore: remove extra '0' number from versions * chore: remove vue2 block * chore: update version reference
josefaidt
requested review from
ykethan,
Jay2113,
chrisbonifacio,
aspittel,
renebrandel,
swaminator,
dbanksdesign,
ErikCH,
arundna and
hdworld11
as code owners
josefaidt
added
the
amplify/docs-engineering
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.
Description of changes:
In an effort to align authoring styles for code snippets and general Markdown across MDX pages, this PR adds a few plugins and tweaks the ESLint configuration to extend to linting markdown/mdx files and their code snippets.
@typescript-eslint/parsereslint-plugin-mdxremark-lintand supporting plugins, presets*.mdxfrom prettierignorelint:contentcommand sincenext lintdoes not support additional file extensionsTodo
Related GitHub issue #, if available:
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.