Unverified Commit 73b47399 authored by Balázs Orbán's avatar Balázs Orbán Committed by GitHub

chore: add build step to `eslint-plugin-next` (#38647)

Follow-up on https://github.com/vercel/next.js/pull/38534#pullrequestreview-1035020450

This lets us use modern JS/TS syntax in ESLint rules and avoid issues like #38530 and #36693

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
Co-authored-by: 's avatarJJ Kasper <22380829+ijjk@users.noreply.github.com>
parent 05c2fe0b
{
"$schema": "https://json.schemastore.org/swcrc",
"jsc": {
"parser": {
"syntax": "typescript"
}
},
"module": {
"type": "commonjs"
}
}
\ No newline at end of file
const url = 'https://nextjs.org/docs/messages/no-img-element'
module.exports = {
meta: {
docs: {
description: 'Prevent usage of `<img>` element to prevent layout shift.',
category: 'HTML',
recommended: true,
url,
},
type: 'problem',
schema: [],
},
create: function (context) {
return {
JSXOpeningElement(node) {
if (node.name.name !== 'img') {
return
}
if (node.attributes.length === 0) {
return
}
if (
node.parent &&
node.parent.openingElement &&
node.parent.parent.openingElement &&
node.parent.parent.openingElement.name &&
node.parent.parent.openingElement.name.name === 'picture'
) {
return
}
context.report({
node,
message: `Do not use \`<img>\` element. Use \`<Image />\` from \`next/image\` instead. See: ${url}`,
})
},
}
},
}
...@@ -2,19 +2,23 @@ ...@@ -2,19 +2,23 @@
"name": "@next/eslint-plugin-next", "name": "@next/eslint-plugin-next",
"version": "12.3.2-canary.15", "version": "12.3.2-canary.15",
"description": "ESLint plugin for NextJS.", "description": "ESLint plugin for NextJS.",
"main": "lib/index.js", "main": "dist/index.js",
"license": "MIT", "license": "MIT",
"repository": { "repository": {
"url": "vercel/next.js", "url": "vercel/next.js",
"directory": "packages/eslint-plugin-next" "directory": "packages/eslint-plugin-next"
}, },
"files": [ "files": [
"lib" "dist"
], ],
"dependencies": { "dependencies": {
"glob": "7.1.7" "glob": "7.1.7"
}, },
"devDependencies": { "devDependencies": {
"@types/eslint": "7.28.0" "eslint": "7.24.0"
},
"scripts": {
"build": "swc -d dist src",
"prepublishOnly": "cd ../../ && turbo run build"
} }
} }
import type { Rule } from 'eslint'
const url = 'https://nextjs.org/docs/messages/no-img-element'
export const meta: Rule.RuleMetaData = {
docs: {
description: 'Prevent usage of `<img>` element to prevent layout shift.',
category: 'HTML',
recommended: true,
url,
},
type: 'problem',
schema: [],
}
export const create: Rule.RuleModule['create'] = (context) => {
return {
JSXOpeningElement(node) {
if (node.name.name !== 'img') {
return
}
if (node.attributes.length === 0) {
return
}
if (node.parent?.parent?.openingElement?.name?.name === 'picture') {
return
}
context.report({
node,
message: `Do not use \`<img>\` element. Use \`<Image />\` from \`next/image\` instead. See: ${url}`,
})
},
}
}
...@@ -3,5 +3,6 @@ ...@@ -3,5 +3,6 @@
"module": "commonjs", "module": "commonjs",
"target": "es2019" "target": "es2019"
}, },
"include": ["src/**/*"],
"exclude": ["node_modules"] "exclude": ["node_modules"]
} }
...@@ -419,12 +419,12 @@ importers: ...@@ -419,12 +419,12 @@ importers:
packages/eslint-plugin-next: packages/eslint-plugin-next:
specifiers: specifiers:
'@types/eslint': 7.28.0 eslint: 7.24.0
glob: 7.1.7 glob: 7.1.7
dependencies: dependencies:
glob: 7.1.7 glob: 7.1.7
devDependencies: devDependencies:
'@types/eslint': 7.28.0 eslint: 7.24.0
packages/font: packages/font:
specifiers: {} specifiers: {}
......
import rule from '@next/eslint-plugin-next/lib/rules/google-font-display' import rule from '@next/eslint-plugin-next/dist/rules/google-font-display'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/google-font-preconnect' import rule from '@next/eslint-plugin-next/dist/rules/google-font-preconnect'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
...@@ -3,7 +3,7 @@ import glob from 'glob' ...@@ -3,7 +3,7 @@ import glob from 'glob'
import index from '@next/eslint-plugin-next' import index from '@next/eslint-plugin-next'
const getRuleNameFromRulePath = (path) => basename(path, '.js') const getRuleNameFromRulePath = (path) => basename(path, '.js')
const rulePaths = glob.sync('packages/eslint-plugin-next/lib/rules/*js', { const rulePaths = glob.sync('packages/eslint-plugin-next/dist/rules/*js', {
absolute: true, absolute: true,
}) })
...@@ -15,7 +15,8 @@ describe('@next/eslint-plugin-next index', () => { ...@@ -15,7 +15,8 @@ describe('@next/eslint-plugin-next index', () => {
}) })
rulePaths.forEach((rulePath) => { rulePaths.forEach((rulePath) => {
const rule = require(rulePath) let rule = require(rulePath)
rule = rule.default ?? rule
const ruleName = getRuleNameFromRulePath(rulePath) const ruleName = getRuleNameFromRulePath(rulePath)
const { recommended = false } = rule.meta.docs const { recommended = false } = rule.meta.docs
......
import rule from '@next/eslint-plugin-next/lib/rules/inline-script-id' import rule from '@next/eslint-plugin-next/dist/rules/inline-script-id'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/next-script-for-ga' import rule from '@next/eslint-plugin-next/dist/rules/next-script-for-ga'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-assign-module-variable' import rule from '@next/eslint-plugin-next/dist/rules/no-assign-module-variable'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-before-interactive-script-outside-document' import rule from '@next/eslint-plugin-next/dist/rules/no-before-interactive-script-outside-document'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-css-tags' import rule from '@next/eslint-plugin-next/dist/rules/no-css-tags'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import path from 'path' import path from 'path'
import rule from '@next/eslint-plugin-next/lib/rules/no-document-import-in-page' import rule from '@next/eslint-plugin-next/dist/rules/no-document-import-in-page'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-duplicate-head' import rule from '@next/eslint-plugin-next/dist/rules/no-duplicate-head'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-head-element' import rule from '@next/eslint-plugin-next/dist/rules/no-head-element'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-head-import-in-document' import rule from '@next/eslint-plugin-next/dist/rules/no-head-import-in-document'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
/* eslint-env jest */ /* eslint-env jest */
import rule from '@next/eslint-plugin-next/lib/rules/no-html-link-for-pages' import rule from '@next/eslint-plugin-next/dist/rules/no-html-link-for-pages'
import { Linter } from 'eslint' import { Linter } from 'eslint'
import assert from 'assert' import assert from 'assert'
import path from 'path' import path from 'path'
......
import rule from '@next/eslint-plugin-next/lib/rules/no-img-element' import * as rule from '@next/eslint-plugin-next/dist/rules/no-img-element'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-page-custom-font' import rule from '@next/eslint-plugin-next/dist/rules/no-page-custom-font'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-script-component-in-head' import rule from '@next/eslint-plugin-next/dist/rules/no-script-component-in-head'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-styled-jsx-in-document' import rule from '@next/eslint-plugin-next/dist/rules/no-styled-jsx-in-document'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-sync-scripts' import rule from '@next/eslint-plugin-next/dist/rules/no-sync-scripts'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-title-in-document-head' import rule from '@next/eslint-plugin-next/dist/rules/no-title-in-document-head'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-typos' import rule from '@next/eslint-plugin-next/dist/rules/no-typos'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
import rule from '@next/eslint-plugin-next/lib/rules/no-unwanted-polyfillio' import rule from '@next/eslint-plugin-next/dist/rules/no-unwanted-polyfillio'
import { RuleTester } from 'eslint' import { RuleTester } from 'eslint'
;(RuleTester as any).setDefaultConfig({ ;(RuleTester as any).setDefaultConfig({
parserOptions: { parserOptions: {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment