Fixed generator ESlint config. Added tests and docs. (plone#5530)

Co-authored-by: Steve Piercy <web@stevepiercy.com>

.github/workflows/acceptance.yml

@@ -1010,6 +1010,18 @@ jobs:
         run: yarn config set -H enableImmutableInstalls false && yarn
         working-directory: ${{env.project-directory}}
 
+      - name: Running lint on a project works
+        run: yarn lint
+        working-directory: ${{env.project-directory}}
+
+      - name: Running prettier on a project works
+        run: yarn prettier
+        working-directory: ${{env.project-directory}}
+
+      - name: Running stylelint on a project works
+        run: yarn stylelint
+        working-directory: ${{env.project-directory}}
+
       - name: Cypress acceptance tests
         uses: cypress-io/github-action@v6
         env:

docs/source/upgrade-guide/index.md

@@ -28,6 +28,34 @@ Thus it is safe to run it on top of your project and answer the prompts.
 
 ## Upgrading to Volto 18.x.x
 
+### ESlint project configuration update
+
+`@plone/registry` and [other packages on which Volto depends](https://github.com/plone/volto/tree/main/packages) are now stand-alone releases in the monorepo structure released in 18.0.0-alpha.4.
+
+You must update the configuration file {file}`.eslintrc.js` in your projects, according to the following `git diff` patch.
+
+```diff
+@@ -18,9 +19,6 @@ if (configFile) {
+     voltoPath = `./${jsConfig.baseUrl}/${pathsConfig['@plone/volto'][0]}`;
+ }
+
+-const AddonConfigurationRegistry = require(
+-  `${voltoPath}/packages/registry/addon-registry.js`,
+-);
+const AddonConfigurationRegistry = require('@plone/registry/src/addon-registry');
+
+@@ -38,9 +36,7 @@ const defaultConfig = {
+       alias: {
+         map: [
+           ['@plone/volto', '@plone/volto/src'],
+-          ['@plone/volto-slate', '@plone/volto/packages/volto-slate/src'],
+-          ['@plone/registry', '@plone/volto/packages/registry/src'],
+-          ['@plone/types', '@plone/volto/packages/types'],
++          ['@plone/volto-slate', '@plone/volto-slate/src'],
+           ...addonAliases,
+           ['@package', `${__dirname}/src`],
+```
+
 ### Upgraded Slate libraries
 
 The support libraries for Slate integration have been upgraded, mainly for bug fixes.

packages/generator-volto/generators/addon/templates/package.json

@@ -29,7 +29,7 @@
     "eslint-config-react-app": "7.0.1",
     "eslint-plugin-flowtype": "8.0.3",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",

packages/generator-volto/generators/app/templates/.eslintrc.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const projectRootPath = __dirname;
 const packageJson = require(path.join(projectRootPath, 'package.json'));
+const AddonConfigurationRegistry = require('@plone/registry/src/addon-registry');
 
 let voltoPath = './node_modules/@plone/volto';
 
@@ -18,9 +19,6 @@ if (configFile) {
     voltoPath = `./${jsConfig.baseUrl}/${pathsConfig['@plone/volto'][0]}`;
 }
 
-const AddonConfigurationRegistry = require(
-  `${voltoPath}/packages/registry/addon-registry.js`,
-);
 const reg = new AddonConfigurationRegistry(__dirname);
 
 // Extends ESlint configuration for adding the aliases to `src` directories in Volto addons
@@ -38,9 +36,7 @@ const defaultConfig = {
       alias: {
         map: [
           ['@plone/volto', '@plone/volto/src'],
-          ['@plone/volto-slate', '@plone/volto/packages/volto-slate/src'],
-          ['@plone/registry', '@plone/volto/packages/registry/src'],
-          ['@plone/types', '@plone/volto/packages/types'],
+          ['@plone/volto-slate', '@plone/volto-slate/src'],
           ...addonAliases,
           ['@package', `${__dirname}/src`],
           ['@root', `${__dirname}/src`],

packages/generator-volto/generators/app/templates/package.json.tpl

@@ -13,8 +13,8 @@
     "prettier": "./node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,ts,tsx,css,scss}'",
     "prettier:fix": "./node_modules/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,ts,tsx,css,scss}'",
     "prettier:ci": "./node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,ts,tsx,css,scss}'",
-    "stylelint": "stylelint 'theme/**/*.{css,scss,less}' 'src/**/*.{css,scss,less}'",
-    "stylelint:overrides": "stylelint 'theme/**/*.overrides' 'src/**/*.overrides'",
+    "stylelint": "stylelint 'theme/**/*.{css,scss,less}' 'src/**/*.{css,scss,less}' --allow-empty-input",
+    "stylelint:overrides": "stylelint 'theme/**/*.overrides' 'src/**/*.overrides' --allow-empty-input",
     "stylelint:fix": "yarn stylelint --fix && yarn stylelint:overrides --fix",
     "test": "razzle test --passWithNoTests",
     "typecheck": "tsc --project tsconfig.json --noEmit",

packages/generator-volto/news/5530.bugfix

@@ -0,0 +1 @@
+Fixed the project generator's ESLint configuration, added code quality checks to the CI to ensure a generated project can run these checks, and added documentation for how to reconfigure ESLint in projects. @sneridagh

packages/volto/news/5530.bugfix

@@ -0,0 +1 @@
+Fixed the project generator's ESLint configuration, added code quality checks to the CI to ensure a generated project can run these checks, and added documentation for how to reconfigure ESLint in projects. @sneridagh

packages/volto/package.json

@@ -222,7 +222,7 @@
     "eslint-import-resolver-alias": "1.1.2",
     "eslint-import-resolver-babel-plugin-root-import": "1.1.1",
     "eslint-plugin-import": "2.28.1",
-    "eslint-plugin-jsx-a11y": "6.7.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
     "eslint-plugin-prettier": "5.0.0",
     "eslint-plugin-react": "7.33.2",
     "eslint-plugin-react-hooks": "4.6.0",