Add rootDir setting to eslint-plugin-next (#27918)
## Introduction
This PR enables setting a `rootDir` for a Next.js project, and follows the same pattern used by [`@typescript-eslint/parser`](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#parseroptionsproject).
## Details
Previously, users had to pass paths to the rule itself.
```js
module.exports = {
rules: {
"@next/next/no-html-link-for-pages": [
"error",
// This could be a string, or array of strings.
"/packages/my-app/pages",
],
},
};
```
With this PR, this has been simplified (the previous implementation still works as expected).
```js
module.exports = {
settings: {
next: {
rootDir: "/packages/my-app",
},
},
rules: {
"@next/next/no-html-link-for-pages": "error",
},
};
```
Further, this rule allows the use of globs, again aligning with `@typescript-eslint/parser`.
```js
module.exports = {
settings: {
next: {
// Globs
rootDir: "/packages/*",
rootDir: "/packages/{app-a,app-b}",
// Arrays
rootDir: ["/app-a", "/app-b"],
// Arrays with globs
rootDir: ["/main-app", "/other-apps/*"],
},
};
```
This enables users to either provide per-workspace configuration with overrides, or to use globs for situations like monorepos where the apps share a domain (micro-frontends).
This doesn't solve, but improves https://github.com/vercel/next.js/issues/26330.
## Feature
- [x] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [x] 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
- [x] Make sure the linting passes
2021-08-11 12:37:55 +02:00
const NodeAttributes = require ( '../utils/node-attributes.js' )
2021-05-10 21:08:14 +02:00
module . exports = {
meta : {
docs : {
description :
'Recommend adding custom font in a custom document and not in a specific page' ,
recommended : true ,
} ,
} ,
create : function ( context ) {
2021-08-05 02:58:06 +02:00
let documentImportName
2021-05-10 21:08:14 +02:00
return {
ImportDeclaration ( node ) {
if ( node . source . value === 'next/document' ) {
2021-08-05 02:58:06 +02:00
const documentImport = node . specifiers . find (
( { type } ) => type === 'ImportDefaultSpecifier'
)
if ( documentImport && documentImport . local ) {
documentImportName = documentImport . local . name
2021-05-10 21:08:14 +02:00
}
}
} ,
JSXOpeningElement ( node ) {
const documentClass = context
. getAncestors ( )
. find (
( ancestorNode ) =>
ancestorNode . type === 'ClassDeclaration' &&
ancestorNode . superClass &&
2021-08-05 02:58:06 +02:00
ancestorNode . superClass . name === documentImportName
2021-05-10 21:08:14 +02:00
)
2021-08-05 02:58:06 +02:00
if ( documentClass || node . name . name !== 'link' ) {
2021-05-10 21:08:14 +02:00
return
}
const attributes = new NodeAttributes ( node )
if ( ! attributes . has ( 'href' ) || ! attributes . hasValue ( 'href' ) ) {
return
}
const hrefValue = attributes . value ( 'href' )
2021-05-12 14:24:42 +02:00
const isGoogleFont =
typeof hrefValue === 'string' &&
hrefValue . startsWith ( 'https://fonts.googleapis.com/css' )
2021-05-10 21:08:14 +02:00
if ( isGoogleFont ) {
context . report ( {
node ,
message :
2021-05-20 00:47:38 +02:00
'Custom fonts not added at the document level will only load for a single page. This is discouraged. See https://nextjs.org/docs/messages/no-page-custom-font.' ,
2021-05-10 21:08:14 +02:00
} )
}
} ,
}
} ,
}