[WIP] Project Proposal

.module-readme.rst.j2

@@ -0,0 +1,90 @@
+{%- macro fragment(name, title, sub='=') %}
+{%- if name in fragments %}
+{{- title }}
+{{ sub * title|length }}
+
+{{ fragments[name] }}
+{% endif %}
+{%- endmacro -%}
+
+{{ '=' * manifest.name|length }}
+{{ manifest.name }}
+{{ '=' * manifest.name|length }}
+
+..
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten. !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: {{ source_digest }}
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge_devstat| image:: https://img.shields.io/badge/maturity-{{ development_status | replace("-", "--") | urlencode
+}}-brightgreen.png
+:target: https://odoo-community.org/page/development-status
+:alt: {{ development_status | title }}
+
+.. |badge_license| image:: https://img.shields.io/badge/license-{{ manifest.license | d("Unknown") | replace("-", "--")
+| urlencode }}-blue.png
+:alt: {{ manifest.license | d("Unknown") }}
+
+|badge_devstat| |badge_license|
+
+{{ fragments.get('DESCRIPTION', '') }}
+{% if development_status == 'alpha' -%}
+
+.. IMPORTANT::
+This is an alpha version, the data model and design can change at any time without warning.
+Only for development or testing purpose, do not use in production.
+`More details on development status <https: //odoo-community.org/page/development-status>`_
+
+    {% endif -%}
+
+    **Table of contents**
+
+    .. contents::
+    :local:
+
+    {{ fragment('CONTEXT', 'Use Cases / Context') }}
+    {{- fragment('INSTALL', 'Installation') }}
+    {{- fragment('CONFIGURE', 'Configuration') }}
+    {{- fragment('USAGE', 'Usage') }}
+    {{- fragment('DEVELOP', 'Development') }}
+    {{- fragment('ROADMAP', 'Known issues / Roadmap') -}}
+    {{- fragment('HISTORY', 'Changelog') -}}
+
+    Credits
+    {#- HACK Avoid conflicts with pre-commit's check-merge-conflict #}
+    {{ "=======" }}
+
+    {% if authors -%}
+    Authors
+    {{ level3_underline * 7 }}
+
+    {% for author in authors if author -%}
+    * {{ author }}
+    {% endfor %}
+    {% endif -%}
+
+    {{ fragment('CONTRIBUTORS', 'Contributors', sub=level3_underline) }}
+    {{- fragment('CREDITS', 'Other credits', sub=level3_underline) -}}
+    Maintainers
+    {{ level3_underline * 11 }}
+
+    This module is maintained by {{ org_name }}.
+
+    Contact the maintainer through their official support channels in case you find
+    any issues with this module.
+    {% if manifest.maintainers %}
+
+    {% for maintainer in manifest.maintainers %}
+    .. |maintainer-{{ maintainer }}| image:: https://github.com/{{ maintainer }}.png?size=40px
+    :target: https://github.com/{{ maintainer }}
+    :alt: {{ maintainer}}
+    {%- endfor %}
+
+    Current maintainer{% if manifest.maintainers|length > 1 %}s{% endif %}:
+
+    {% for maintainer in manifest.maintainers %}|maintainer-{{ maintainer }}|{% if not loop.last %} {% endif %}{% endfor
+    %}
+    {% endif %}

.pre-commit-config.yaml

@@ -3,148 +3,76 @@ exclude: |
   # NOT INSTALLABLE ADDONS
   # END NOT INSTALLABLE ADDONS
   # Files and folders generated by bots, to avoid loops
-  ^setup/|/static/description/index\.html$|
-  # We don't want to mess with tool-generated files
-  .svg$|/tests/([^/]+/)?cassettes/|^.copier-answers.yml$|^.github/|
-  # Maybe reactivate this when all README files include prettier ignore tags?
-  ^README\.md$|
+  /static/description/index\.html$|
+  # Files that fail if changed manually
+  .*\.(diff|patch)$|
   # Library files can have extraneous formatting (even minimized)
   /static/(src/)?lib/|
-  # Repos using Sphinx to generate docs don't need prettying
-  ^docs/_templates/.*\.html$|
-  # Don't bother non-technical authors with formatting issues in docs
-  readme/.*\.(rst|md)$|
-  # Ignore build and dist directories in addons
-  /build/|/dist/|
-  # Ignore test files in addons
-  /tests/samples/.*|
   # You don't usually want a bot to modify your legal texts
   (LICENSE.*|COPYING.*)
 default_language_version:
   python: python3
-  node: "16.17.0"
+  node: "18.17.1"
 repos:
   - repo: local
     hooks:
-      # These files are most likely copier diff rejection junks; if found,
-      # review them manually, fix the problem (if needed) and remove them
       - id: forbidden-files
         name: forbidden files
         entry: found forbidden files; remove them
         language: fail
         files: "\\.rej$"
-      - id: en-po-files
-        name: en.po files cannot exist
-        entry: found a en.po file
-        language: fail
-        files: '[a-zA-Z0-9_]*/i18n/en\.po$'
-  - repo: https://github.com/oca/maintainer-tools
-    rev: d5fab7ee87fceee858a3d01048c78a548974d935
+  - &maintainer_tools
+    repo: https://github.com/oca/maintainer-tools
+    rev: 400ffa99242c8b225ab4d34de78721a68b292a61
     hooks:
       # update the NOT INSTALLABLE ADDONS section above
       - id: oca-update-pre-commit-excluded-addons
-      - id: oca-fix-manifest-website
-        args: ["https://github.com/aginix/kmitl"]
-      - id: oca-gen-addon-readme
         args:
-          - --addons-dir=.
-          - --branch=16.0
-          - --org-name=aginix
-          - --repo-name=kmitl
-          - --if-source-changed
-          - --keep-source-digest
+          - --addons-dir
+          - .
   - repo: https://github.com/OCA/odoo-pre-commit-hooks
-    rev: v0.0.25
+    rev: v0.0.29
     hooks:
       - id: oca-checks-odoo-module
       - id: oca-checks-po
-  - repo: https://github.com/myint/autoflake
-    rev: v1.6.1
+        args: ["--fix"]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.3
     hooks:
-      - id: autoflake
-        args:
-          - --expand-star-imports
-          - --ignore-init-module-imports
-          - --in-place
-          - --remove-all-unused-imports
-          - --remove-duplicate-keys
-          - --remove-unused-variables
-  - repo: https://github.com/psf/black
-    rev: 22.8.0
-    hooks:
-      - id: black
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
   - repo: https://github.com/pre-commit/mirrors-prettier
+    # HACK https://github.com/prettier/prettier/issues/15696
     rev: v2.7.1
     hooks:
       - id: prettier
-        name: prettier (with plugin-xml)
+        name: prettier + plugin-xml
+        args: [--plugin=@prettier/plugin-xml]
         additional_dependencies:
-          - "prettier@2.7.1"
-          - "@prettier/plugin-xml@2.2.0"
-        args:
-          - --plugin=@prettier/plugin-xml
-        files: \.(css|htm|html|js|json|jsx|less|md|scss|toml|ts|xml|yaml|yml)$
-  - repo: https://github.com/pre-commit/mirrors-eslint
-    rev: v8.24.0
-    hooks:
-      - id: eslint
-        verbose: true
-        args:
-          - --color
-          - --fix
+          # HACK https://github.com/prettier/pre-commit/issues/16#issuecomment-713474520
+          - prettier@2.7.1
+          - "@prettier/plugin-xml@v2.2.0"
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
-        # exclude autogenerated files
-        exclude: /README\.rst$|\.pot?$
       - id: end-of-file-fixer
-        # exclude autogenerated files
-        exclude: /README\.rst$|\.pot?$
       - id: debug-statements
       - id: fix-encoding-pragma
         args: ["--remove"]
       - id: check-case-conflict
       - id: check-docstring-first
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
-        # exclude files where underlines are not distinguishable from merge conflicts
-        exclude: /README\.rst$|^docs/.*\.rst$
+        args: [--assume-in-merge]
+        exclude: \.rst$ # HACK https://github.com/pre-commit/pre-commit-hooks/issues/985
       - id: check-symlinks
       - id: check-xml
       - id: mixed-line-ending
         args: ["--fix=lf"]
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v2.38.2
-    hooks:
-      - id: pyupgrade
-        args: ["--keep-percent-format"]
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        name: isort except __init__.py
-        args:
-          - --settings=.
-        exclude: /__init__\.py$
-  - repo: https://github.com/acsone/setuptools-odoo
-    rev: 3.1.8
-    hooks:
-      - id: setuptools-odoo-make-default
-      - id: setuptools-odoo-get-requirements
-        args:
-          - --output
-          - requirements.txt
-          - --header
-          - "# generated from manifests external_dependencies"
-  - repo: https://github.com/PyCQA/flake8
-    rev: 3.9.2
-    hooks:
-      - id: flake8
-        name: flake8
-        additional_dependencies: ["flake8-bugbear==21.9.2"]
   - repo: https://github.com/OCA/pylint-odoo
-    rev: v8.0.19
+    rev: v8.0.20
     hooks:
       - id: pylint_odoo
         name: pylint with optional checks
@@ -155,3 +83,24 @@ repos:
       - id: pylint_odoo
         args:
           - --rcfile=.pylintrc-mandatory
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    rev: v8.49.0
+    hooks:
+      - id: eslint
+        verbose: true
+        args:
+          - --color
+          - --fix
+  - <<: *maintainer_tools
+    hooks:
+      # Generate readme is last, so its digest includes changes from above
+      - id: oca-gen-addon-readme
+        args:
+          - --addons-dir=.
+          - --org-name=nopparuts
+          - --repo-name=kmitl
+          - --convert-fragments-to-markdown
+          - --gen-html
+          - --if-fragments-changed
+          - --branch=16.0
+          - --template-filename=.module-readme.rst.j2

account_kmitl/README.rst

@@ -2,54 +2,42 @@
 KMITL - Accounting
 ==================
 
-.. 
-   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! This file is generated by oca-gen-addon-readme !!
-   !! changes will be overwritten.                   !!
-   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:fde09dfb1902e2a26563cdd69baf3fd820dacaabb8377aef7b60b56f6bfe31f3
-   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
-    :target: https://odoo-community.org/page/development-status
-    :alt: Beta
-.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
-    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
-    :alt: License: LGPL-3
-.. |badge3| image:: https://img.shields.io/badge/github-aginix%2Fkmitl-lightgray.png?logo=github
-    :target: https://github.com/aginix/kmitl/tree/16.0/account_kmitl
-    :alt: aginix/kmitl
-
-|badge1| |badge2| |badge3|
+..
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten. !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:375c85c2aad5776222a885b224c73284a57037b9c63a12429b22cff3f0af9c6c
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
-Chart of Accounts for KMITL.
+.. |badge_devstat| image:: https://img.shields.io/badge/maturity-beta-brightgreen.png
+:target: https://odoo-community.org/page/development-status
+:alt: Beta
 
-**Table of contents**
+.. |badge_license| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
+:alt: LGPL-3
 
-.. contents::
-   :local:
+|badge_devstat| |badge_license|
 
-Bug Tracker
-===========
+Chart of Accounts for KMITL.
 
-Bugs are tracked on `GitHub Issues <https://github.com/aginix/kmitl/issues>`_.
-In case of trouble, please check there if your issue has already been reported.
-If you spotted it first, help us to smash it by providing a detailed and welcomed
-`feedback <https://github.com/aginix/kmitl/issues/new?body=module:%20account_kmitl%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+**Table of contents**
 
-Do not contact contributors directly about support or help with technical issues.
+    .. contents::
+    :local:
 
-Credits
-=======
+    Credits
+    =======
 
-Authors
-~~~~~~~
+    Authors
+    -------
 
-* Aginix Technologies
+    * Aginix Technologies
 
-Maintainers
-~~~~~~~~~~~
+    Maintainers
+    -----------
 
-This module is part of the `aginix/kmitl <https://github.com/aginix/kmitl/tree/16.0/account_kmitl>`_ project on GitHub.
+    This module is maintained by nopparuts.
 
-You are welcome to contribute.
+    Contact the maintainer through their official support channels in case you find
+    any issues with this module.

account_kmitl/readme/DESCRIPTION.md

@@ -0,0 +1 @@
+Chart of Accounts for KMITL.