This rule checks the .yarnrc.yml file to ensure that each version defined in the packageExtensions are aligned with the one used in the package.json files of the project.
The linter is dedicated to YAML files and requires the setup of the yaml-eslint-parser.
Example of an ESLint flat configuration:
Example :import yamlParser from 'yaml-eslint-parser';
import o3rPlugin from '@o3r/eslint-plugin';
export default [
{
files: ['yarnrc.y{a,}ml'],
languageOptions: {
parser: yamlParser
},
plugins: {
'@o3r': o3rPlugin
}
rules: {
'@o3r/yarnrc-package-extensions-harmonize': 'error'
}
}
]Example of an ESLint legacy configuration:
Example :{
"parser": "yaml-eslint-parser",
"plugins": [
"@o3r"
],
"files": [
"**/.yarnrc.yml"
],
"extends": [
"@o3r:yarn-recommended"
]
}List of dependency types to check in the package.json
Default: ['optionalDependencies', 'dependencies', 'devDependencies', 'peerDependencies', 'generatorDependencies']*
Usage:
Example :{
"@o3r/yarnrc-package-extensions-harmonize": [
"error",
{
"dependencyTypesInPackages": ["dependencies", "peerDependencies"]
}
]
}List of dependencies to ignore.
Default: []
Usage:
Example :{
"@o3r/yarnrc-package-extensions-harmonize": [
"error",
{
"ignoredDependencies": ["rxjs", "@angular/*"]
}
]
}List of package name to ignore when determining the dependencies versions.
Default: []
Usage:
Example :{
"@o3r/yarnrc-package-extensions-harmonize": [
"error",
{
"excludePackages": ["@o3r/core"]
}
]
}List of package extension types to check in the yarnrc.
Default: ['peerDependencies', 'dependencies']
Usage:
Example :{
"@o3r/yarnrc-package-extensions-harmonize": [
"error",
{
"yarnrcDependencyTypes": ["dependencies"]
}
]
}