Refactor monorepo

Makefile

@@ -9,8 +9,8 @@ GREEN=`tput setaf 2`
 RESET=`tput sgr0`
 YELLOW=`tput setaf 3`
 
-TOP_LEVEL_TEMPLATES = add-ons/backend add-ons/frontend projects/monorepo projects/classic
-SUB_TEMPLATES = sub/cache sub/frontend_project sub/project_settings
+TOP_LEVEL_TEMPLATES = add-ons/backend add-ons/frontend add-ons/monorepo projects/monorepo projects/classic
+SUB_TEMPLATES = ci/github sub/cache sub/frontend_project sub/addon_settings sub/classic_project_settings sub/project_settings  sub/vscode
 
 # Python checks
 UV?=uv
@@ -88,3 +88,7 @@ report-keys-usage: $(VENV_FOLDER) ## Generate a report of usage of context keys
 	@echo "$(GREEN)==> Generate a report of usage of context keys$(RESET)"
 	@uv run .scripts/report_keys_usage.py
 
+.PHONY: run
+run: $(VENV_FOLDER) ## Run cookieplone
+	@echo "$(GREEN)==> Run cookieplone$(RESET)"
+	COOKIEPLONE_REPOSITORY=$(CURRENT_DIR) uv run cookieplone

cookiecutter.json

@@ -3,25 +3,31 @@
     "project": {
       "path": "./templates/projects/monorepo",
       "title": "Volto Project",
-      "description": "Create a new Plone project that uses the Volto frontend",
+      "description": "Plone project that uses the Volto frontend",
       "hidden": false
     },
     "classic_project": {
       "path": "./templates/projects/classic",
       "title": "Classic UI Project",
-      "description": "Create a new Plone project that uses Classic UI",
+      "description": "Plone project that uses Classic UI",
+      "hidden": false
+    },
+    "monorepo_addon": {
+      "path": "./templates/add-ons/monorepo",
+      "title": "Add-on for Plone (with backend and frontend)",
+      "description": "Codebase for a Plone add-on with backend and frontend parts",
       "hidden": false
     },
     "backend_addon": {
       "path": "./templates/add-ons/backend",
       "title": "Backend Add-on for Plone",
-      "description": "Create a new Python package to be used with Plone",
+      "description": "Python package to be used with Plone",
       "hidden": false
     },
     "frontend_addon": {
       "path": "./templates/add-ons/frontend",
       "title": "Frontend Add-on for Plone",
-      "description": "Create a new Node package to be used with Volto",
+      "description": "Node package to be used with Volto",
       "hidden": false
     },
     "sub/cache": {
@@ -36,6 +42,12 @@
       "description": "Subtemplate with configuration used in container images for frontend project.",
       "hidden": true
     },
+    "sub/addon_settings": {
+      "path": "./templates/sub/addon_settings",
+      "title": "Settings to be applied on top of a mono repo add-on codebase",
+      "description": "Subtemplate with configuration and settings for a mono repo add-on.",
+      "hidden": true
+    },
     "sub/project_settings": {
       "path": "./templates/sub/project_settings",
       "title": "Project settings to be applied on top of a mono repo project",
@@ -48,11 +60,29 @@
       "description": "Subtemplate with configuration and settings for a Classic UI project.",
       "hidden": true
     },
+    "sub/vscode": {
+      "path": "./templates/sub/vscode",
+      "title": "VSCode settings",
+      "description": "Subtemplate with configuration and settings for VSCode.",
+      "hidden": true
+    },
     "documentation_starter": {
       "path": "./templates/docs/starter",
       "title": "Documentation scaffold for Plone projects",
       "description": "Create a new documentation scaffold for Plone projects",
       "hidden": false
+    },
+    "ci_github": {
+      "path": "./templates/ci/github",
+      "title": "GitHub CI configuration for Plone projects",
+      "description": "Create a new GitHub CI configuration for Plone projects",
+      "hidden": true
+    },
+    "devops_ansible": {
+      "path": "./templates/devops/ansible",
+      "title": "Ansible Playbooks for Plone",
+      "description": "Ansible setup to manage a Docker Swarm cluster for Plone hosting.",
+      "hidden": true
     }
   }
 }

news/+monorepo-calver.feature

@@ -0,0 +1 @@
+Project monorepo uses calendar versioning. @ericof

news/+monorepo-gha.feature

@@ -0,0 +1 @@
+Refactored Github actions for monorepo projects. @ericof

news/+monorepo.feature

@@ -0,0 +1 @@
+Refactor monorepo project to use uv and repoplone. @ericof

pyproject.toml

@@ -5,11 +5,11 @@ description = "Collection of templates for Plone integrators to use through Cook
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "cookieplone>=0.9.7",
+    "cookieplone>=0.9.10",
     "gitpython>=3.1.43",
     "pytest>=8.3.5",
     "pytest-cookies>=0.7.0",
-    "pytest-jsonschema>=1.0.0b1",
+    "pytest-jsonschema>=1.0.0",
     "pytest-md-report>=0.6.3",
     "tomli>=2.0.1",
 ]

templates/add-ons/backend/cookiecutter.json

@@ -8,6 +8,8 @@
   "plone_version": "{{ cookiecutter.use_prerelease_versions | latest_plone }}",
   "python_package_name": "{{ cookiecutter.github_organization|lower }}.{{ cookiecutter.title|replace(' ', '')|replace('-', '_')|replace('.', '')|lower }}",
   "__year": "{% now 'local', '%Y' %}",
+  "initial_version": "1.0.0a0",
+  "configuration_version": "1000",
   "feature_headless": ["1", "0"],
   "initialize_documentation": ["1", "0"],
   "__project_slug": "{{ cookiecutter.python_package_name }}",
@@ -28,8 +30,8 @@
   "__gha_plone_version": "{{ cookiecutter.plone_version }}",
   "__python_version_identifier": "{{ cookiecutter.__supported_versions_python[0] | replace('.', '') }}",
   "__profile_language": "en",
-  "__version_package": "1.0.0a0",
-  "__profile_version": "1000",
+  "__version_package": "{{ cookiecutter.initial_version }}",
+  "__profile_version": "{{ cookiecutter.configuration_version }}",
   "__backend_addon_git_initialize": "1",
   "__backend_addon_format": "1",
   "__prompts__": {
@@ -41,6 +43,8 @@
     "python_package_name": "Python package name",
     "author": "Author",
     "email": "Author E-mail",
+    "initial_version": "Package version",
+    "configuration_version": "Configuration version",
     "feature_headless": {
       "__prompt__": "Support headless Plone?",
       "1": "Yes",

templates/add-ons/backend/{{ cookiecutter.__folder_name }}/.gitignore

@@ -40,5 +40,6 @@ var/
 /reports/
 /sources/
 /venv/
+.mxdev_cache
 constraints*.txt
 requirements*.txt

templates/add-ons/backend/{{ cookiecutter.__folder_name }}/pyproject.toml

@@ -53,7 +53,7 @@ test = [
     "plone.restapi[test]",
     "pytest",
     "pytest-cov",
-    "pytest-plone>=0.5.0",
+    "pytest-plone>=1.0.0a2",
 ]
 release = [
     "zest.releaser[recommended]",

templates/add-ons/frontend/cookiecutter.json

@@ -17,8 +17,11 @@
   "__version_frontend_package": "1.0.0-alpha.0",
   "__version_plone_volto": "{{ cookiecutter.volto_version }}",
   "__version_mrs_developer": "^2.2.0",
-  "__version_pnpm": "9.1.1",
-  "__version_release_it": "^17.1.1",
+  "__version_pnpm": "{{ '10.20.0' if cookiecutter.volto_version >= '19' else '9.1.1' }}",
+  "__version_release_it": "^19.0.5",
+  "__version_testing_library_react": "^16.2.0",
+  "__version_typescript": "^5.7.3",
+  "__version_vitest": "^3.1.2",
   "__node_version": "{{ cookiecutter.volto_version | node_version_for_volto }}",
   "__gha_version_node": "{{ cookiecutter.__node_version }}",
   "__gha_version_checkout": "v4",
@@ -27,6 +30,7 @@
   "__gha_version_background_action": "v1",
   "__gha_version_upload_artifact": "v4",
   "__gha_version_pages_deploy": "v4",
+  "__test_framework": "{{ 'vitest' if cookiecutter.volto_version >= '19' else 'jest'}}",
   "__prompts__": {
     "frontend_addon_name": "Add-on (Short name of the addon)",
     "title": "Add-on Title",

templates/add-ons/frontend/hooks/post_gen_project.py

@@ -32,6 +32,18 @@ def generate_docs_starter(context, output_dir):
     files.remove_files(output_dir / folder_name, DOCUMENTATION_STARTER_REMOVE)
 
 
+def remove_conditional_files(context, output_dir):
+    if context["__test_framework"] == "jest":
+        (
+            output_dir
+            / "packages"
+            / context["frontend_addon_name"]
+            / "vitest.config.mjs"
+        ).unlink()
+    else:
+        (output_dir / "jest-addon.config.js").unlink()
+
+
 def main():
     """Final fixes."""
 
@@ -53,6 +65,8 @@ def main():
         console.print(f" -> {title}")
         func(new_context, output_dir)
 
+    remove_conditional_files(context, output_dir)
+
     msg = """
         [bold blue]{{ cookiecutter.frontend_addon_name }}[/bold blue]
 

templates/add-ons/frontend/hooks/pre_prompt.py

@@ -18,6 +18,7 @@
     "20",
     "21",
     "22",
+    "24",
 ]
 
 

templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/Makefile

@@ -98,8 +98,12 @@ test: ## Run unit tests
 .PHONY: ci-test
 ci-test: ## Run unit tests in CI
 	# Unit Tests need the i18n to be built
-	VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto i18n
-	CI=1 RAZZLE_JEST_CONFIG=$(CURRENT_DIR)/jest-addon.config.js pnpm --filter @plone/volto test -- --passWithNoTests
+	VOLTOCONFIG=$(CURRENT_DIR)/volto.config.js pnpm --filter @plone/volto i18n
+{%- if cookiecutter.__test_framework == 'jest' %}
+	CI=1 RAZZLE_JEST_CONFIG=$(CURRENT_DIR)/jest-addon.config.js pnpm run --filter @plone/volto test --passWithNoTests
+{%- else %}
+	CI=1 pnpm run test --passWithNoTests
+{%- endif %}
 
 .PHONY: backend-docker-start
 backend-docker-start:	## Starts a Docker-based backend for development

templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/cypress/support/index.ts

@@ -0,0 +1,43 @@
+namespace Cypress {
+  export interface Chainable {
+    /**
+     * Custom command to select DOM element by data-cy attribute.
+     * @example cy.dataCy('greeting')
+     */
+    navigate(value: string): Chainable<JQuery<HTMLElement>>;
+    getSlateEditorAndType(value: string): Chainable<JQuery<HTMLElement>>;
+    setSlateSelection(value: string): Chainable<JQuery<HTMLElement>>;
+    clickSlateButton(value: string): Chainable<JQuery<HTMLElement>>;
+    autologin(): Chainable<JQuery<HTMLElement>>;
+    createContent({
+      contentType,
+      contentId,
+      contentTitle,
+      path,
+      bodyModifier,
+      preview_image_link,
+    }: {
+      contentType: string;
+      contentId: string;
+      contentTitle: string;
+      path?: string;
+      bodyModifier?: (body: any) => any;
+      preview_image_link?: { '@id': string };
+    }): Chainable<JQuery<HTMLElement>>;
+    addNewBlock(value: string): Chainable<JQuery<HTMLElement>>;
+    matchImage(): Chainable<JQuery<HTMLElement>>;
+    injectAxe({
+      axeCorePath,
+    }: {
+      axeCorePath: string;
+    }): Chainable<JQuery<HTMLElement>>;
+    checkA11y(
+      context?: Object | string,
+      options?: Object,
+      violationCallback?: (violations: any[]) => void,
+      skipFailures?: boolean,
+    ): Chainable<JQuery<HTMLElement>>;
+    checkAccessibility(): Chainable<JQuery<HTMLElement>>;
+    getSlate(): Chainable<JQuery<HTMLElement>>;
+  }
+}

templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress", "@testing-library/cypress", "node"]
+  },
+  "include": ["**/*.ts"]
+}

templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/package.json

@@ -18,7 +18,11 @@
     "build": "VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto build",
     "build:deps": "pnpm --filter @plone/registry --filter @plone/components build",
     "i18n": "pnpm --filter {{ cookiecutter.__npm_package_name }} i18n && VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto i18n",
+{%- if cookiecutter.__test_framework == 'jest' %}
     "test": "RAZZLE_JEST_CONFIG=$(pwd)/jest-addon.config.js pnpm --filter @plone/volto test -- --passWithNoTests",
+{%- else %}
+    "test": "pnpm --filter {{ cookiecutter.__npm_package_name }} exec vitest",
+{%- endif %}
     "lint": "VOLTOCONFIG=$(pwd)/volto.config.js eslint --max-warnings=0 'packages/**/src/**/*.{js,jsx,ts,tsx}'",
     "lint:fix": "VOLTOCONFIG=$(pwd)/volto.config.js eslint --fix 'packages/**/src/**/*.{js,jsx,ts,tsx}'",
     "prettier": "prettier --check 'packages/**/src/**/*.{js,jsx,ts,tsx}'",
@@ -44,7 +48,21 @@
     "overrides": {
       "@pmmmwh/react-refresh-webpack-plugin": "^0.5.15",
       "react-refresh": "^0.14.2"
-    }
+    }{%- if cookiecutter.volto_version >= '19' %},
+    "ignoredBuiltDependencies": [
+      "@parcel/watcher"
+    ],
+    "onlyBuiltDependencies": [
+      "core-js",
+      "core-js-pure",
+      "cypress",
+      "es5-ext",
+      "esbuild",
+      "full-icu",
+      "lightningcss-cli",
+      "unrs-resolver"
+    ]
+    {%- endif %}
   },
   "packageManager": "pnpm@{{ cookiecutter.__version_pnpm }}"
 }

templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/packages/{{ cookiecutter.frontend_addon_name }}/package.json

@@ -29,13 +29,22 @@
   "addons": [],
   "dependencies": {},
   "peerDependencies": {
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "@plone/registry": "workspace:*",
-    "@plone/types": "workspace:*"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
   },
   "devDependencies": {
+    "@plone/registry": "workspace:*",
     "@plone/scripts": "workspace:*",
+    "@plone/types": "workspace:*",
+    "@types/react": "^18.3.1",
+    "@types/react-dom": "^18.3.1",
+    "typescript": "{{ cookiecutter.__version_typescript }}",
+{%- if cookiecutter.__test_framework == 'jest' %}
     "release-it": "{{ cookiecutter.__version_release_it }}"
+{%- else %}
+    "@testing-library/react": "{{ cookiecutter.__version_testing_library_react }}",
+    "release-it": "{{ cookiecutter.__version_release_it }}",
+    "vitest": "{{ cookiecutter.__version_vitest }}"
+{%- endif %}
   }
 }

templates/add-ons/frontend/{{ cookiecutter.__folder_name }}/packages/{{ cookiecutter.frontend_addon_name }}/vitest.config.mjs

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config';
+import voltoVitestConfig from '@plone/volto/vitest.config.mjs';
+import path from 'path';
+
+export default defineConfig({
+  ...voltoVitestConfig,
+  resolve: {
+    alias: {
+      '@plone/volto': path.resolve(__dirname, '../../core/packages/volto/src'), // Add paths accordingly
+      // 'promise-file-reader': require.resolve('promise-file-reader') // Add to identify dependency from package
+    },
+  },
+});

templates/add-ons/monorepo/.gitignore

@@ -0,0 +1 @@
+addon