Devops: Add a YAML and TOML formatter (#331)

.github/workflows/cd.yml

@@ -1,108 +1,108 @@
 name: cd
 
 on:
-    push:
-        tags:
-        -   'v[0-9]+.[0-9]+.[0-9]+*'
+  push:
+    tags:
+    - v[0-9]+.[0-9]+.[0-9]+*
 
 jobs:
 
-    validate-release-tag:
+  validate-release-tag:
 
-        if: github.repository == 'aiidateam/aiida-common-workflows'
-        runs-on: ubuntu-latest
+    if: github.repository == 'aiidateam/aiida-common-workflows'
+    runs-on: ubuntu-latest
 
-        steps:
-        -   name: Checkout source
-            uses: actions/checkout@v2
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v2
 
-        -   name: Set up Python 3.9
-            uses: actions/setup-python@v4
-            with:
-                python-version: '3.9'
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
 
-        -   name: Validate the tag version against the package version
-            run: python .github/workflows/validate_release_tag.py $GITHUB_REF
+    - name: Validate the tag version against the package version
+      run: python .github/workflows/validate_release_tag.py $GITHUB_REF
 
-    pre-commit:
+  pre-commit:
 
-        needs: [validate-release-tag]
-        runs-on: ubuntu-latest
+    needs: [validate-release-tag]
+    runs-on: ubuntu-latest
 
-        steps:
-        -   uses: actions/checkout@v2
+    steps:
+    - uses: actions/checkout@v2
 
-        -   name: Install Python
-            uses: actions/setup-python@v4
-            with:
-                python-version: '3.9'
-                cache: 'pip'
-                cache-dependency-path: pyproject.toml
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+        cache: pip
+        cache-dependency-path: pyproject.toml
 
-        -   name: Update pip and install wheel
-            run: pip install -U pip wheel
+    - name: Update pip and install wheel
+      run: pip install -U pip wheel
 
-        -   name: Install Python package and dependencies
-            run: pip install -e .[docs,pre-commit,tests]
+    - name: Install Python package and dependencies
+      run: pip install -e .[docs,pre-commit,tests]
 
-        -   name: Run pre-commit
-            run: pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
+    - name: Run pre-commit
+      run: pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
 
-    tests:
+  tests:
 
-        needs: [validate-release-tag]
-        runs-on: ubuntu-latest
-        timeout-minutes: 30
+    needs: [validate-release-tag]
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
 
-        strategy:
-            matrix:
-                python-version: ['3.9', '3.10', '3.11', '3.12']
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
-        services:
-            rabbitmq:
-                image: rabbitmq:latest
-                ports:
-                -   5672:5672
+    services:
+      rabbitmq:
+        image: rabbitmq:latest
+        ports:
+        - 5672:5672
 
-        steps:
-        -   uses: actions/checkout@v2
+    steps:
+    - uses: actions/checkout@v2
 
-        -   name: Install Python ${{ matrix.python-version }}
-            uses: actions/setup-python@v4
-            with:
-                python-version: ${{ matrix.python-version }}
-                cache: 'pip'
-                cache-dependency-path: pyproject.toml
+    - name: Install Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+        cache-dependency-path: pyproject.toml
 
-        -   name: Update pip and install wheel
-            run: pip install -U pip wheel
+    - name: Update pip and install wheel
+      run: pip install -U pip wheel
 
-        -   name: Install Python package and dependencies
-            run: pip install -e .[tests]
+    - name: Install Python package and dependencies
+      run: pip install -e .[tests]
 
-        -   name: Run pytest
-            run: pytest -sv tests
+    - name: Run pytest
+      run: pytest -sv tests
 
-    publish:
+  publish:
 
-        name: Publish to PyPI
-        needs: [pre-commit, tests]
-        runs-on: ubuntu-latest
+    name: Publish to PyPI
+    needs: [pre-commit, tests]
+    runs-on: ubuntu-latest
 
-        steps:
-        -   name: Checkout source
-            uses: actions/checkout@v2
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v2
 
-        -   name: Set up Python 3.9
-            uses: actions/setup-python@v4
-            with:
-                python-version: '3.9'
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
 
-        -   name: Install flit
-            run: pip install flit~=3.4
+    - name: Install flit
+      run: pip install flit~=3.4
 
-        -   name: Build and publish
-            run: flit publish
-            env:
-                FLIT_USERNAME: __token__
-                FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}
+    - name: Build and publish
+      run: flit publish
+      env:
+        FLIT_USERNAME: __token__
+        FLIT_PASSWORD: ${{ secrets.PYPI_KEY }}

.github/workflows/ci.yml

@@ -4,61 +4,61 @@ on: [push, pull_request]
 
 jobs:
 
-    pre-commit:
+  pre-commit:
 
-        runs-on: ubuntu-latest
+    runs-on: ubuntu-latest
 
-        steps:
-        -   uses: actions/checkout@v2
+    steps:
+    - uses: actions/checkout@v2
 
-        -   name: Install Python
-            uses: actions/setup-python@v4
-            with:
-                python-version: '3.9'
-                cache: 'pip'
-                cache-dependency-path: pyproject.toml
+    - name: Install Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.9'
+        cache: pip
+        cache-dependency-path: pyproject.toml
 
-        -   name: Update pip and install wheel
-            run: pip install -U pip wheel
+    - name: Update pip and install wheel
+      run: pip install -U pip wheel
 
-        -   name: Install Python package and dependencies
-            run: pip install -e .[docs,pre-commit,tests]
+    - name: Install Python package and dependencies
+      run: pip install -e .[docs,pre-commit,tests]
 
-        -   name: Run pre-commit
-            run: pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
+    - name: Run pre-commit
+      run: pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
 
-    tests:
+  tests:
 
-        runs-on: ubuntu-latest
-        timeout-minutes: 30
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
 
-        strategy:
-            matrix:
-                python-version: ['3.9', '3.10', '3.11', '3.12']
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
 
-        services:
-            rabbitmq:
-                image: rabbitmq:latest
-                ports:
-                -   5672:5672
+    services:
+      rabbitmq:
+        image: rabbitmq:latest
+        ports:
+        - 5672:5672
 
-        steps:
-        -   uses: actions/checkout@v2
+    steps:
+    - uses: actions/checkout@v2
 
-        -   name: Install Python ${{ matrix.python-version }}
-            uses: actions/setup-python@v4
-            with:
-                python-version: ${{ matrix.python-version }}
-                cache: 'pip'
-                cache-dependency-path: pyproject.toml
+    - name: Install Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: pip
+        cache-dependency-path: pyproject.toml
 
-        -   name: Update pip and install wheel
-            run: pip install -U pip wheel
+    - name: Update pip and install wheel
+      run: pip install -U pip wheel
 
-        -   name: Install Python package and dependencies
-            run: pip install -e .[tests]
+    - name: Install Python package and dependencies
+      run: pip install -e .[tests]
 
-        -   name: Run pytest
-            env:
-                AIIDA_WARN_v3: true
-            run: pytest -sv tests
+    - name: Run pytest
+      env:
+        AIIDA_WARN_v3: true
+      run: pytest -sv tests

.pre-commit-config.yaml

@@ -1,25 +1,33 @@
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
-    hooks:
-    -   id: check-merge-conflict
-    -   id: check-yaml
-    -   id: double-quote-string-fixer
-    -   id: end-of-file-fixer
-    -   id: fix-encoding-pragma
-        args: [--remove]
-    -   id: mixed-line-ending
-        args: [--fix=lf]
-    -   id: trailing-whitespace
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: check-merge-conflict
+  - id: check-yaml
+  - id: double-quote-string-fixer
+  - id: end-of-file-fixer
+  - id: fix-encoding-pragma
+    args: [--remove]
+  - id: mixed-line-ending
+    args: [--fix=lf]
+  - id: trailing-whitespace
 
--   repo: https://github.com/ikamensh/flynt/
-    rev: '1.0.1'
-    hooks:
-    -   id: flynt
+- repo: https://github.com/ikamensh/flynt/
+  rev: 1.0.1
+  hooks:
+  - id: flynt
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.1.9
   hooks:
   - id: ruff-format
   - id: ruff
     args: [--fix, --exit-non-zero-on-fix, --show-fixes]
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.11.0
+  hooks:
+  - id: pretty-format-toml
+    args: [--autofix]
+  - id: pretty-format-yaml
+    args: [--autofix]

.readthedocs.yml

@@ -1,17 +1,17 @@
 version: 2
 
 build:
-    apt_packages:
-    -   gfortran  # This is necessary for the `sisl` dependency of `aiida-siesta`
+  apt_packages:
+  - gfortran      # This is necessary for the `sisl` dependency of `aiida-siesta`
 
 python:
-    version: 3.8
-    install:
-    -   method: pip
-        path: .
-        extra_requirements:
-        -   docs
+  version: 3.8
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs
 
 sphinx:
-    builder: html
-    fail_on_warning: true
+  builder: html
+  fail_on_warning: true