feat(lint): improve deprecated api migration rules #58
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -36,7 +36,7 @@ function template(theme: '' | 'dark' = '') { | |
| </style> | ||
| <nve-page> | ||
| <nve-page-header slot="header"> | ||
| <nve-logo slot="prefix" size="sm">NV</nve-logo> | ||
| <h2 nve-text="heading" slot="prefix">•︎•︎•︎•︎•︎•︎</h2> | ||
| </nve-page-header> | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -66,7 +66,7 @@ export const Dropdown = { | |
| render: () => { | ||
| return html` | ||
| <nve-page-header> | ||
| <nve-logo slot="prefix" size="sm">NV</nve-logo> | ||
| <h2 slot="prefix" nve-text="heading sm">NVIDIA</h2> | ||
| <nve-icon-button slot="suffix" icon-name="gear" size="sm" popovertarget="preferences-input"></nve-icon-button> | ||
| </nve-page-header> | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ import { describe, it, expect, beforeEach } from 'vitest'; | |
| import { RuleTester } from 'eslint'; | ||
| import type { JSRuleDefinition } from 'eslint'; | ||
| import css from '@eslint/css'; | ||
| import noDeprecatedCssImports, { deprecatedImports } from './no-deprecated-css-imports.js'; | ||
|
|
||
| const rule = noDeprecatedCssImports as unknown as JSRuleDefinition; | ||
|
|
||
|
|
@@ -54,6 +54,13 @@ describe('noDeprecatedCssImports', () => { | |
| }); | ||
| }); | ||
|
|
||
| it('should cover CSS entrypoints documented in the migration guide', () => { | ||
| expect(deprecatedImports['@maglev/elements/index.css']).toContain( | ||
| `@import '@nvidia-elements/styles/view-transitions.css';` | ||
| ); | ||
| expect(deprecatedImports['@maglev/elements/inter.css']).toBe(`@import '@nvidia-elements/themes/fonts/inter.css';`); | ||
| }); | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| it('should not allow use of deprecated CSS import paths', () => { | ||
| tester.run('should not allow use of deprecated CSS import paths', rule, { | ||
| valid: [], | ||
|
|
@@ -62,9 +69,14 @@ describe('noDeprecatedCssImports', () => { | |
| code: `@import '@maglev/elements/index.css';`, | ||
| output: `@import '@nvidia-elements/themes/fonts/inter.css'; | ||
| @import '@nvidia-elements/themes/index.css'; | ||
| @import '@nvidia-elements/themes/high-contrast.css'; | ||
| @import '@nvidia-elements/themes/reduced-motion.css'; | ||
| @import '@nvidia-elements/themes/compact.css'; | ||
| @import '@nvidia-elements/themes/dark.css'; | ||
| @import '@nvidia-elements/themes/debug.css'; | ||
| @import '@nvidia-elements/styles/typography.css'; | ||
| @import '@nvidia-elements/styles/layout.css'; | ||
| @import '@nvidia-elements/styles/view-transitions.css';`, | ||
| errors: [ | ||
| { | ||
| messageId: 'deprecated-css-import', | ||
|
|
@@ -73,9 +85,27 @@ describe('noDeprecatedCssImports', () => { | |
| alternative: ` | ||
| @import '@nvidia-elements/themes/fonts/inter.css'; | ||
| @import '@nvidia-elements/themes/index.css'; | ||
| @import '@nvidia-elements/themes/high-contrast.css'; | ||
| @import '@nvidia-elements/themes/reduced-motion.css'; | ||
| @import '@nvidia-elements/themes/compact.css'; | ||
| @import '@nvidia-elements/themes/dark.css'; | ||
| @import '@nvidia-elements/themes/debug.css'; | ||
| @import '@nvidia-elements/styles/typography.css'; | ||
| @import '@nvidia-elements/styles/layout.css'; | ||
| @import '@nvidia-elements/styles/view-transitions.css';`.trim() | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| code: `@import '@maglev/elements/inter.css';`, | ||
| output: `@import '@nvidia-elements/themes/fonts/inter.css';`, | ||
| errors: [ | ||
| { | ||
| messageId: 'deprecated-css-import', | ||
| data: { | ||
| value: '@maglev/elements/inter.css', | ||
| alternative: `@import '@nvidia-elements/themes/fonts/inter.css';` | ||
| } | ||
| } | ||
| ] | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,11 +5,23 @@ import type { Rule } from 'eslint'; | |
| import type { CssAtRuleNode } from '../rule-types.js'; | ||
|
|
||
| declare const __ELEMENTS_PAGES_BASE_URL__: string; | ||
| const themeAndStyleImports = `@import '@nvidia-elements/themes/fonts/inter.css'; | ||
| @import '@nvidia-elements/themes/index.css'; | ||
| @import '@nvidia-elements/themes/high-contrast.css'; | ||
| @import '@nvidia-elements/themes/reduced-motion.css'; | ||
| @import '@nvidia-elements/themes/compact.css'; | ||
| @import '@nvidia-elements/themes/dark.css'; | ||
| @import '@nvidia-elements/themes/debug.css'; | ||
| @import '@nvidia-elements/styles/typography.css'; | ||
| @import '@nvidia-elements/styles/layout.css'; | ||
| @import '@nvidia-elements/styles/view-transitions.css';`; | ||
|
|
||
| export const deprecatedImports: Record<string, string> = { | ||
| '@nvidia-elements/core/index.css': themeAndStyleImports, | ||
| '@nvidia-elements/core/css/module.layout.css': `@import '@nvidia-elements/styles/layout.css';`, | ||
| '@nvidia-elements/core/css/module.typography.css': `@import '@nvidia-elements/styles/typography.css';`, | ||
| '@maglev/elements/index.css': themeAndStyleImports, | ||
| '@maglev/elements/inter.css': `@import '@nvidia-elements/themes/fonts/inter.css';`, | ||
| '@maglev/elements/css/module.layout.css': `@import '@nvidia-elements/styles/layout.css';`, | ||
| '@maglev/elements/css/module.typography.css': `@import '@nvidia-elements/styles/typography.css';` | ||
| }; | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ import { beforeEach, describe, expect, it } from 'vitest'; | |
| import { RuleTester } from 'eslint'; | ||
| import json from '@eslint/json'; | ||
| import type { JSRuleDefinition } from 'eslint'; | ||
| import noDeprecatedPackages, { DEPRECATED_PACKAGES } from './no-deprecated-packages.js'; | ||
|
|
||
| const rule = noDeprecatedPackages as unknown as JSRuleDefinition; | ||
|
|
||
|
|
@@ -46,6 +46,24 @@ describe('noUnexpectedLibraryDependencies', () => { | |
| }); | ||
| }); | ||
|
|
||
| it('should cover every package documented in the migration guide', () => { | ||
| expect(DEPRECATED_PACKAGES['@nve/elements']).toBe('@nvidia-elements/core'); | ||
| expect(DEPRECATED_PACKAGES['@nve/styles']).toBe('@nvidia-elements/styles'); | ||
| expect(DEPRECATED_PACKAGES['@nve/themes']).toBe('@nvidia-elements/themes'); | ||
| expect(DEPRECATED_PACKAGES['@nve/monaco']).toBe('@nvidia-elements/monaco'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/forms']).toBe('@nvidia-elements/forms'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/cli']).toBe('@nvidia-elements/cli'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/code']).toBe('@nvidia-elements/code'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/create']).toBe('@nvidia-elements/create'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/markdown']).toBe('@nvidia-elements/markdown'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/media']).toBe('@nvidia-elements/media'); | ||
| expect(DEPRECATED_PACKAGES['@nve-labs/lint']).toBe('@nvidia-elements/lint'); | ||
| expect(DEPRECATED_PACKAGES['@maglev/elements']).toBe( | ||
| '@nvidia-elements/core + @nvidia-elements/themes + @nvidia-elements/styles' | ||
| ); | ||
| expect(DEPRECATED_PACKAGES['@nve/testing']).toBe('project-supported test utilities'); | ||
| }); | ||
|
|
||
| it('should not allow deprecated dependencies', () => { | ||
| tester.run('should not allow deprecated dependencies', rule, { | ||
| valid: [], | ||
|
|
@@ -83,4 +101,49 @@ describe('noUnexpectedLibraryDependencies', () => { | |
| ] | ||
| }); | ||
| }); | ||
|
|
||
| it('should not allow deprecated packages from the migration guide', () => { | ||
| tester.run('should not allow deprecated packages from the migration guide', rule, { | ||
| valid: [], | ||
| invalid: [ | ||
| { | ||
| code: `{ "dependencies": { "@nve/elements": "1.0.0", "@nve-labs/forms": "1.0.0" } }`, | ||
| filename: 'package.json', | ||
| errors: [ | ||
| { | ||
| messageId: 'unexpected-deprecated-package', | ||
| data: { package: '@nve/elements', alternative: '@nvidia-elements/core' } | ||
| }, | ||
| { | ||
| messageId: 'unexpected-deprecated-package', | ||
| data: { package: '@nve-labs/forms', alternative: '@nvidia-elements/forms' } | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| code: `{ "devDependencies": { "@nve/testing": "1.0.0" } }`, | ||
| filename: 'package.json', | ||
| errors: [ | ||
| { | ||
| messageId: 'unexpected-deprecated-package', | ||
| data: { package: '@nve/testing', alternative: 'project-supported test utilities' } | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| code: `{ "peerDependencies": { "@maglev/elements": "1.0.0" } }`, | ||
| filename: 'package.json', | ||
| errors: [ | ||
| { | ||
| messageId: 'unexpected-deprecated-package', | ||
| data: { | ||
| package: '@maglev/elements', | ||
| alternative: '@nvidia-elements/core + @nvidia-elements/themes + @nvidia-elements/styles' | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }); | ||
| }); | ||
|
coryrylan marked this conversation as resolved.
|
||
| }); | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,23 @@ import type { Rule } from 'eslint'; | |
| import type { HtmlTagNode } from '../rule-types.js'; | ||
|
|
||
| declare const __ELEMENTS_PAGES_BASE_URL__: string; | ||
| export const DEPRECATED_PACKAGES: Record<string, string> = { | ||
| '@nve/elements': '@nvidia-elements/core', | ||
| '@nve/styles': '@nvidia-elements/styles', | ||
| '@nve/themes': '@nvidia-elements/themes', | ||
| '@nve/monaco': '@nvidia-elements/monaco', | ||
| '@nve-labs/forms': '@nvidia-elements/forms', | ||
| '@nve-labs/cli': '@nvidia-elements/cli', | ||
| '@nve-labs/code': '@nvidia-elements/code', | ||
| '@nve-labs/create': '@nvidia-elements/create', | ||
| '@nve-labs/markdown': '@nvidia-elements/markdown', | ||
| '@nve-labs/media': '@nvidia-elements/media', | ||
| '@nve-labs/lint': '@nvidia-elements/lint', | ||
| '@maglev/elements': '@nvidia-elements/core + @nvidia-elements/themes + @nvidia-elements/styles', | ||
| '@mlv/elements': '@nvidia-elements/core', | ||
| '@nve/testing': 'project-supported test utilities' | ||
| }; | ||
|
|
||
| const rule = { | ||
| meta: { | ||
| type: 'problem' as const, | ||
|
|
@@ -26,20 +43,20 @@ const rule = { | |
| const dependencies = Object.keys(packageJson.dependencies ?? {}); | ||
| const devDependencies = Object.keys(packageJson.devDependencies ?? {}); | ||
| const peerDependencies = Object.keys(packageJson.peerDependencies ?? {}); | ||
| const deprecatedDependencies = [...dependencies, ...devDependencies, ...peerDependencies].filter( | ||
| dependency => dependency in DEPRECATED_PACKAGES | ||
| ); | ||
|
coryrylan marked this conversation as resolved.
|
||
|
|
||
| deprecatedDependencies.forEach(dependency => { | ||
| context.report({ | ||
| messageId: 'unexpected-deprecated-package', | ||
| loc: node.loc!, | ||
| data: { | ||
| package: dependency, | ||
| alternative: DEPRECATED_PACKAGES[dependency] | ||
| } | ||
| }); | ||
| }); | ||
|
coryrylan marked this conversation as resolved.
|
||
| } | ||
| } | ||
| }; | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -55,6 +55,10 @@ describe('noMissingSlottedElements', () => { | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `<nve-button> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| button | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| </nve-button>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `<nve-logo> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <img src="./logo.svg" alt="NVIDIA" /> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| </nve-logo>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `<nve-logo>NV</nve-logo>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `<nve-input>\${}</nve-input>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `<nve-input>{{ }}</nve-input>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `<nve-input>{% %}</nve-input>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -139,6 +143,22 @@ describe('noMissingSlottedElements', () => { | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| it('should report logos missing default slot content', () => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tester.run('logos missing default slot content', rule, { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valid: [], | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| invalid: [ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code: `<nve-logo></nve-logo>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errors: [{ messageId: 'missing-default-slot-content', data: { tagName: 'nve-logo' } }] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| code: `<nve-logo><span slot="prefix">NV</span></nve-logo>`, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| errors: [{ messageId: 'missing-default-slot-content', data: { tagName: 'nve-logo' } }] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+146
to
+160
There was a problem hiding this comment. Add a whitespace-only You already enforce this for Proposed test diff it('should report logos missing default slot content', () => {
tester.run('logos missing default slot content', rule, {
valid: [],
invalid: [
{
code: `<nve-logo></nve-logo>`,
errors: [{ messageId: 'missing-default-slot-content', data: { tagName: 'nve-logo' } }]
},
+ {
+ code: `<nve-logo> </nve-logo>`,
+ errors: [{ messageId: 'missing-default-slot-content', data: { tagName: 'nve-logo' } }]
+ },
{
code: `<nve-logo><span slot="prefix">NV</span></nve-logo>`,
errors: [{ messageId: 'missing-default-slot-content', data: { tagName: 'nve-logo' } }]
}
]
});
});📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| it('should report custom required elements', () => { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tester.run('unexpected use of missing slotted elements', rule, { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| valid: [], | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Oops, something went wrong.
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.
Consider adding aria-label to the snippet template.
Since these snippets establish patterns for developers, including
aria-label="NVIDIA"would promote accessible implementations.♿ Suggested accessibility improvement
📝 Committable suggestion
🤖 Prompt for AI Agents