First unified version

.editorconfig

@@ -0,0 +1,35 @@
+
+# EditorConfig Configurtaion file, for more details see:
+# https://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*] # For All Files
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+# Set default charset
+charset = utf-8
+# Indent style default
+indent_style = space
+
+[*.{py,cfg,ini}]
+# 4 space indentation
+indent_size = 4
+
+[*.{html,dtml,pt,zpt,xml,zcml,js,json,ts,less,css,sass,yml,yaml}]
+# 2 space indentation
+indent_size = 2
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
+indent_style = tab
+indent_size = unset
+tab_width = unset

.github/workflows/backend.yml

@@ -0,0 +1,158 @@
+name: Backend CI
+
+on:
+ push:
+ paths:
+ - "backend/**"
+ - ".github/workflows/backend.yml"
+ workflow_dispatch:
+
+env:
+ IMAGE_NAME_PREFIX: ghcr.io/collective/volto-form-block
+ IMAGE_NAME_SUFFIX: backend
+ PYTHON_VERSION: "3.11"
+
+jobs:
+
+ meta:
+ runs-on: ubuntu-latest
+ outputs:
+ PLONE_VERSION: ${{ steps.vars.outputs.PLONE_VERSION }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Set Env Vars
+ id: vars
+ run: |
+ echo "PLONE_VERSION=$(cat backend/version.txt)" >> $GITHUB_OUTPUT
+
+ black:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v4
+
+ - name: Run check
+ uses: plone/code-analysis-action@v2
+ with:
+ base_dir: 'backend'
+ check: 'black'
+
+ flake8:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v4
+
+ - name: Run check
+ uses: plone/code-analysis-action@v2
+ with:
+ base_dir: 'backend'
+ check: 'flake8'
+
+ isort:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v4
+
+ - name: Run check
+ uses: plone/code-analysis-action@v2
+ with:
+ base_dir: 'backend'
+ check: 'isort'
+
+ zpretty:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v4
+
+ - name: Run check
+ uses: plone/code-analysis-action@v2
+ with:
+ base_dir: 'backend'
+ check: 'zpretty'
+
+ tests:
+ runs-on: ubuntu-latest
+ needs:
+ - meta
+ defaults:
+ run:
+ working-directory: ./backend
+
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Setup Plone ${{ needs.meta.outputs.PLONE_VERSION }} with Python ${{ env.PYTHON_VERSION }}
+ uses: plone/[email protected]
+ with:
+ python-version: ${{ env.PYTHON_VERSION }}
+ plone-version: ${{ needs.meta.outputs.PLONE_VERSION }}
+
+ - name: Install package
+ run: |
+ pip install mxdev
+ mxdev -c mx.ini
+ pip install -r requirements-mxdev.txt
+
+ - name: Run tests
+ run: |
+ pytest --disable-warnings src/collective.voltoformblock/tests
+
+ release:
+ runs-on: ubuntu-latest
+ needs:
+ - black
+ - flake8
+ - isort
+ - zpretty
+ - tests
+ permissions:
+ contents: read
+ packages: write
+
+ steps:
+
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Docker meta
+ id: meta
+ uses: docker/metadata-action@v5
+ with:
+ images: |
+ ${{ env.IMAGE_NAME_PREFIX }}-${{ env.IMAGE_NAME_SUFFIX }}
+ labels: |
+ org.label-schema.docker.cmd=docker run -d -p 8080:8080 ${{ env.IMAGE_NAME_PREFIX }}-${{ env.IMAGE_NAME_SUFFIX }}:latest
+ flavor:
+ latest=false
+ tags: |
+ type=ref,event=branch
+ type=sha
+ type=raw,value=latest,enable={{is_default_branch}}
+
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v3
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Login to Container Registry
+ uses: docker/login-action@v3
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Build and push
+ uses: docker/build-push-action@v5
+ with:
+ platforms: linux/amd64
+ context: backend
+ file: backend/Dockerfile
+ push: ${{ github.event_name != 'pull_request' }}
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}

.github/workflows/frontend.yml

@@ -0,0 +1,145 @@
+name: Frontend CI
+
+on:
+ push:
+ paths:
+ - "frontend/**"
+ - ".github/workflows/frontend.yml"
+ workflow_dispatch:
+
+env:
+ IMAGE_NAME_PREFIX: ghcr.io/collective/volto-form-block
+ IMAGE_NAME_SUFFIX: frontend
+ NODE_VERSION: 20.x
+
+defaults:
+ run:
+ working-directory: ./frontend
+
+jobs:
+ meta:
+ runs-on: ubuntu-latest
+ outputs:
+ BASE_TAG: ${{ steps.vars.outputs.BASE_TAG }}
+ VOLTO_VERSION: ${{ steps.vars.outputs.VOLTO_VERSION }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Compute several vars needed for the build
+ id: vars
+ run: |
+ echo 'BASE_TAG=sha-$(git rev-parse --short HEAD)' >> $GITHUB_OUTPUT
+ python3 -c 'import json; data = json.load(open("./mrs.developer.json")); print("VOLTO_VERSION=" + data["core"].get("tag") or "latest")' >> $GITHUB_OUTPUT
+ - name: Test vars
+ run: |
+ echo 'BASE_TAG=${{ steps.vars.outputs.BASE_TAG }}'
+ echo 'VOLTO_VERSION=${{ steps.vars.outputs.VOLTO_VERSION }}'
+
+ code-analysis:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout codebase
+ uses: actions/checkout@v4
+
+ - name: Use Node.js ${{ env.node-version }}
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ env.NODE_VERSION }}
+
+ - name: Enable corepack
+ run: corepack enable
+
+ - name: Get pnpm store directory
+ shell: bash
+ run: |
+ echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+ - uses: actions/cache@v4
+ name: Setup pnpm cache
+ with:
+ path: ${{ env.STORE_PATH }}
+ key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+ restore-keys: |
+ ${{ runner.os }}-pnpm-store-
+
+ - name: Install dependencies
+ run: make install
+
+ - name: Linting
+ id: lint
+ if: ${{ success() || failure() }}
+ run: make lint
+
+ - name: i18n sync
+ id: i18n
+ if: ${{ success() || failure() }}
+ run: make ci-i18n
+
+ - name: Unit Tests
+ id: unit
+ if: ${{ success() || failure() }}
+ run: make test
+
+ - name: Report
+ if: ${{ success() || failure() }}
+ run: |
+ echo '# Code Analysis' >> $GITHUB_STEP_SUMMARY
+ echo '| Test | Status |' >> $GITHUB_STEP_SUMMARY
+ echo '| --- | --- |' >> $GITHUB_STEP_SUMMARY
+ echo '| Lint | ${{ steps.lint.conclusion == 'failure' && '❌' || ' ✅' }} |' >> $GITHUB_STEP_SUMMARY
+ echo '| i18n | ${{ steps.i18n.conclusion == 'failure' && '❌' || ' ✅' }} |' >> $GITHUB_STEP_SUMMARY
+ echo '| Unit Tests | ${{ steps.unit.conclusion == 'failure' && '❌' || ' ✅' }} |' >> $GITHUB_STEP_SUMMARY 
+
+ release:
+ runs-on: ubuntu-latest
+ needs:
+ - meta
+ - code-analysis
+ permissions:
+ contents: read
+ packages: write
+
+ steps:
+
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Docker meta
+ id: meta
+ uses: docker/metadata-action@v5
+ with:
+ images: |
+ ${{ env.IMAGE_NAME_PREFIX }}-${{ env.IMAGE_NAME_SUFFIX }}
+ labels: |
+ org.label-schema.docker.cmd=docker run -d -p 3000:3000 ${{ env.IMAGE_NAME_PREFIX }}-${{ env.IMAGE_NAME_SUFFIX }}:latest
+ flavor:
+ latest=false
+ tags: |
+ type=ref,event=branch
+ type=sha
+ type=raw,value=latest,enable={{is_default_branch}}
+
+ - name: Set up QEMU
+ uses: docker/setup-qemu-action@v3
+
+ - name: Set up Docker Buildx
+ uses: docker/setup-buildx-action@v3
+
+ - name: Login to Container Registry
+ uses: docker/login-action@v3
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Build and push
+ uses: docker/build-push-action@v5
+ with:
+ platforms: linux/amd64
+ context: frontend/
+ file: frontend/Dockerfile
+ push: ${{ github.event_name != 'pull_request' }}
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}
+ build-args: |
+ VOLTO_VERSION=${{ needs.meta.outputs.VOLTO_VERSION }}

.gitignore

@@ -1,13 +1,4 @@
-.*project
-.settings/
-.vscode
-*~
-acceptance/cypress/videos/
-acceptance/node_modules
-.storybook-build
-build
-core
+!.vscode
 node_modules
-results
-yarn.lock
+/core
 /public

.pre-commit-config.yaml

@@ -1,27 +1,16 @@
 repos:
- - repo: local
+ - repo: https://github.com/ddanier/sub-pre-commit.git
+ rev: v3.7.1 # MUST match your pre-commit version
  hooks:
- - id: prettier
- name: prettier
- entry: pnpm exec prettier --write
- language: system
- files: '^packages/.*/src/.*/?.*.(js|jsx|ts|tsx)$'
- types: [file]
- - id: eslint
- name: eslint
- entry: bash -c "VOLTOCONFIG=$(pwd)/volto.config.js pnpm exec eslint --max-warnings=0 --fix"
- language: system
- files: '^packages/.*/src/.*/?.*.(js|jsx|ts|tsx)$'
- types: [file]
- - id: stylelint
- name: stylelint
- entry: pnpm exec stylelint --fix
- language: system
- files: '^packages/.*/src/.*/?.*.(css|scss|less)$'
- types: [file]
- - id: i18n
- name: i18n
- entry: make ci-i18n
- language: system
- files: '^packages/.*/src/.*/?.*.(js|jsx|ts|tsx)$'
- types: [file]
+ - id: sub-pre-commit
+ alias: backend
+ name: "pre-commit for backend/"
+ args: ["-p", "backend/"]
+ files: "^backend/.*"
+ stages: ["commit"]
+ - id: sub-pre-commit
+ alias: frontend
+ name: "pre-commit for frontend"
+ args: ["-p", "frontend"]
+ files: "^frontend/.*"
+ stages: ["commit"]