5211ac5cae
* Adds consistency to ESLint rules. * Fixes lint errors. * Fixes manifest. * Adds missing title. * Fixes copy / paste error. Co-authored-by: Lee Robinson <me@leerob.io> * Update errors/no-script-in-document.md Co-authored-by: Lee Robinson <me@leerob.io> * Update errors/no-sync-scripts.md Co-authored-by: Lee Robinson <me@leerob.io> * Updates a couple of rule descriptions. * Adds redirects. * Fixes unit tests. * Removes duplicated section. * Updates `no-before-interactive-script-outside-document` description. * Fixes lint. * Fixes integration tests. * Adds description to `no-before-interactive-script-outside-document` documentation. * Removes `link-passhref` from rules list. * Updates remaining `pages/_middleware.js` references. * Adds consistancy to messaging in new `no-styled-jsx-in-document` rule. * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Lee Robinson <me@leerob.io> Co-authored-by: Tim Neutkens <tim@timneutkens.nl> Co-authored-by: JJ Kasper <jj@jjsweb.site>
132 lines
3.5 KiB
TypeScript
132 lines
3.5 KiB
TypeScript
import rule from '@next/eslint-plugin-next/lib/rules/no-before-interactive-script-outside-document'
|
|
import { RuleTester } from 'eslint'
|
|
;(RuleTester as any).setDefaultConfig({
|
|
parserOptions: {
|
|
ecmaVersion: 2018,
|
|
sourceType: 'module',
|
|
ecmaFeatures: {
|
|
modules: true,
|
|
jsx: true,
|
|
},
|
|
},
|
|
})
|
|
const ruleTester = new RuleTester()
|
|
|
|
ruleTester.run('no-before-interactive-script-outside-document', rule, {
|
|
valid: [
|
|
{
|
|
code: `
|
|
import Document, { Html, Main, NextScript } from 'next/document'
|
|
import Script from 'next/script'
|
|
|
|
class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
<Head>
|
|
<meta charSet="utf-8" />
|
|
</Head>
|
|
<body>
|
|
<Main />
|
|
<NextScript />
|
|
<Script
|
|
id="scriptBeforeInteractive"
|
|
src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js?a=scriptBeforeInteractive"
|
|
strategy="beforeInteractive"
|
|
></Script>
|
|
</body>
|
|
</Html>
|
|
)
|
|
}
|
|
}
|
|
|
|
export default MyDocument
|
|
`,
|
|
filename: 'pages/_document.js',
|
|
},
|
|
{
|
|
code: `
|
|
import Document, { Html, Main, NextScript } from 'next/document'
|
|
import ScriptComponent from 'next/script'
|
|
|
|
class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
<Head>
|
|
<meta charSet="utf-8" />
|
|
</Head>
|
|
<body>
|
|
<Main />
|
|
<NextScript />
|
|
<ScriptComponent
|
|
id="scriptBeforeInteractive"
|
|
src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js?a=scriptBeforeInteractive"
|
|
strategy="beforeInteractive"
|
|
></ScriptComponent>
|
|
</body>
|
|
</Html>
|
|
)
|
|
}
|
|
}
|
|
|
|
export default MyDocument
|
|
`,
|
|
filename: 'pages/_document.tsx',
|
|
},
|
|
{
|
|
code: `
|
|
import Document, { Html, Main, NextScript } from 'next/document'
|
|
import ScriptComponent from 'next/script'
|
|
|
|
class MyDocument extends Document {
|
|
render() {
|
|
return (
|
|
<Html>
|
|
<Head>
|
|
<meta charSet="utf-8" />
|
|
</Head>
|
|
<body>
|
|
<Main />
|
|
<NextScript />
|
|
<ScriptComponent
|
|
id="scriptBeforeInteractive"
|
|
src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js?a=scriptBeforeInteractive"
|
|
></ScriptComponent>
|
|
</body>
|
|
</Html>
|
|
)
|
|
}
|
|
}
|
|
|
|
export default MyDocument
|
|
`,
|
|
filename: 'pages/_document.tsx',
|
|
},
|
|
],
|
|
|
|
invalid: [
|
|
{
|
|
code: `
|
|
import Head from "next/head";
|
|
import Script from "next/script";
|
|
|
|
export default function Index() {
|
|
return (
|
|
<Script
|
|
id="scriptBeforeInteractive"
|
|
src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.20/lodash.min.js?a=scriptBeforeInteractive"
|
|
strategy="beforeInteractive"
|
|
></Script>
|
|
);
|
|
}`,
|
|
filename: 'pages/index.js',
|
|
errors: [
|
|
{
|
|
message:
|
|
"`next/script`'s `beforeInteractive` strategy should not be used outside of `pages/_document.js`. See: https://nextjs.org/docs/messages/no-before-interactive-script-outside-document",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
})
|