Add new prefer-ideal-image eslint rule #8826
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import rule from '../prefer-ideal-image'; | ||
| import {RuleTester} from './testUtils'; | ||
|
|
||
| const errorsJSX = [{messageId: 'image'}] as const; | ||
|
|
||
| const ruleTester = new RuleTester({ | ||
| parser: '@typescript-eslint/parser', | ||
| parserOptions: { | ||
| ecmaFeatures: { | ||
| jsx: true, | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| ruleTester.run('prefer-ideal-image', rule, { | ||
| valid: [ | ||
| { | ||
| code: "<IdealImage img='./path/to/img.png' />", | ||
| }, | ||
| { | ||
| code: "<IdealImage img={require('./path/to/img.png')} />", | ||
| }, | ||
| { | ||
| code: "<IdealImage img={{ src: { src: './path/to/img.png', preSrc: '', images: [{ width: 100 }]}, preSrc: './path/to/placeholder.png'}} />", | ||
| }, | ||
| ], | ||
| invalid: [ | ||
| { | ||
| code: "<img src='./path/to/img.png' alt='some alt text' />", | ||
| errors: errorsJSX, | ||
| }, | ||
| { | ||
| code: "<img src={require('./path/to/img.png')} alt='some alt text' />", | ||
| errors: errorsJSX, | ||
| }, | ||
| { | ||
| code: "<img src='./path/to/img.png' srcset='./path/to/img-480w.jpg 480w, ./path/to/img-800w.png 800w' sizes='(max-width: 600px) 480px, 800px' alt='some alt text' />", | ||
| errors: errorsJSX, | ||
|
Comment on lines
+44
to
+45
|
||
| }, | ||
| ], | ||
| }); | ||
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import {createRule} from '../util'; | ||
| import type {TSESTree} from '@typescript-eslint/types/dist/ts-estree'; | ||
|
|
||
| type Options = []; | ||
| type MessageIds = 'image'; | ||
|
|
||
| const docsUrl = | ||
| 'https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-ideal-image'; | ||
|
|
||
| export default createRule<Options, MessageIds>({ | ||
| name: 'prefer-ideal-image', | ||
| meta: { | ||
| type: 'suggestion', | ||
| docs: { | ||
| description: | ||
| 'enforce using Docusaurus IdealImage plugin component instead of <img> tags', | ||
| recommended: false, | ||
| }, | ||
| schema: [], | ||
| messages: { | ||
| image: `Do not use an \`<img>\` element to embed images. Use the \`<IdealImage />\` component from \`@theme/IdealImage\` instead. See ${docsUrl}`, | ||
| }, | ||
| }, | ||
| defaultOptions: [], | ||
|
|
||
| create(context) { | ||
| return { | ||
| JSXOpeningElement(node) { | ||
| const elementName = (node.name as TSESTree.JSXIdentifier).name; | ||
|
|
||
| if (elementName !== 'img') { | ||
| return; | ||
| } | ||
|
|
||
| context.report({node, messageId: 'image'}); | ||
| }, | ||
| }; | ||
| }, | ||
| }); |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| slug: /api/misc/@docusaurus/eslint-plugin/prefer-ideal-image | ||
| --- | ||
|
|
||
| # prefer-ideal-image | ||
|
|
||
| Ensure that the `<IdealImage />` component provided by [`@theme/IdealImage`](../../plugins/plugin-ideal-image.mdx) Docusaurus plugin is used instead of `<img>` tags. | ||
|
|
||
| The `@theme/IdealImage` Docusaurus plugin generates an almost ideal image (responsive, lazy-loading, and low quality placeholder). | ||
|
|
||
| ## Rule Details {#details} | ||
|
|
||
| Examples of **incorrect** code for this rule: | ||
|
|
||
| ```html | ||
| <img src="./path/to/img.png" alt="some alt text" /> | ||
|
|
||
| <img src={require('./path/to/img.png')} alt='some alt text' /> | ||
|
|
||
| <img | ||
| src="./path/to/img.png" | ||
| srcset="./path/to/img-480w.jpg 480w, ./path/to/img-800w.png 800w" | ||
| sizes="(max-width: 600px) 480px, 800px" | ||
| alt="some alt text" /> | ||
| ``` | ||
|
|
||
| Examples of **correct** code for this rule: | ||
|
|
||
| ```javascript | ||
| import Image from '@theme/IdealImage'; | ||
|
|
||
| <IdealImage img='./path/to/img.png' /> | ||
|
|
||
| <IdealImage img={require('./path/to/img.png')} /> | ||
|
|
||
| <IdealImage | ||
| img={{ | ||
| src: { | ||
| src: './path/to/img.png', | ||
| preSrc: '', | ||
| images: [{ width: 100 }] | ||
| }, | ||
| preSrc: './path/to/placeholder.png' | ||
| }} | ||
| /> | ||
| ``` |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,10 +31,10 @@ function HeroBanner() { | |
| <div className={styles.hero} data-theme="dark"> | ||
| <div className={styles.heroInner}> | ||
| <Heading as="h1" className={styles.heroProjectTagline}> | ||
| <Image | ||
| alt={translate({message: 'Docusaurus with Keytar'})} | ||
| className={styles.heroLogo} | ||
| img={useBaseUrl('/img/docusaurus_keytar.svg')} | ||
|
Comment on lines
-34
to
+37
There was a problem hiding this comment. the ideal image plugin is not designed to work with SVGs Eventually we could import the svgs and use them as components instead of using |
||
| width="200" | ||
| height="200" | ||
| /> | ||
|
|
@@ -190,12 +190,12 @@ function Feature({ | |
|
|
||
| return ( | ||
| <div className={clsx('col', className)}> | ||
| <Image | ||
| className={styles.featureImage} | ||
| alt={feature.title} | ||
| width={Math.floor(feature.image.width)} | ||
| height={Math.floor(feature.image.height)} | ||
| img={withBaseUrl(feature.image.src)} | ||
|
Comment on lines
+193
to
+198
There was a problem hiding this comment. the ideal image plugin is not designed to work with SVGs Eventually we could import the svgs and use them as components instead of using There was a problem hiding this comment.
I had noticed that it only works with JPEGs and PNGs but somehow completely missed out in this case 😅
@slorber Should I address this change in this PR? |
||
| loading="lazy" | ||
| /> | ||
| <Heading as="h3" className={clsx(styles.featureHeading)}> | ||
|
|
||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should not be rejected?