Merge branch 'master' into newerrors

Author: NiumXp

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Issues Fixed
+<!-- List the issues fixed by this PR -->
+- Closes #[issue number]
+- Related to #[issue number] (if applicable)
+
+## Verification Steps
+Please ensure the following steps have been completed:
+- [ ] Added new tests to cover the changes.
+- [ ] Fixed all broken tests.
+- [ ] Ran `poetry run flake8` to check for linting issues.
+- [ ] Verified that all unit tests are passing:
+  - [ ] Ran `poetry run pytest` to ensure unit tests pass.
+  - [ ] Ran `poetry run tox` to validate compatibility across Python versions.
+
+## Additional Notes
+<!-- Add any other relevant information, context, or screenshots -->

.github/PULL_REQUEST_TEMPLATE/bug_fix.md

@@ -0,0 +1,45 @@
+name: Check I18N Changes
+
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  check-i18n:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository (PR branch)
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 0
+
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install -y gettext
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+          poetry install
+
+      - name: Run I18N module
+        run: |
+          poetry run python -m norminette.i18n
+
+      - name: Check for uncommitted .po changes
+        run: |
+          if git diff --ignore-matching-lines='^"POT-Creation-Date:' -- '*.po' | grep -P '^[+-](?![+-]{2} [ab]/)' > /dev/null; then
+            echo "Meaningful I18N changes detected. Please run 'python -m norminette/i18n.py' and commit the changes."
+            git diff -- '*.po'
+            exit 1
+          else
+              echo "No changes detected in I18N files."
+          fi

.github/workflows/check-i18n.yml

@@ -15,25 +15,31 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     timeout-minutes: 5
     steps:
       - uses: actions/checkout@v2
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install poetry
-      - name: Setup package dependencies
-        run: |
           poetry install
+
+      - name: Build package
+        run: |
+          poetry build
+
       - name: Run linter
         run: |
           poetry run flake8
+
       - name: Run tests
         run: |
           poetry run pytest

.github/workflows/python-package.yml

@@ -17,20 +17,21 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: '3.9'
+        python-version: '3.10'
     - name: Install dependencies
       run: |
+        sudo apt-get update && sudo apt-get install -y gettext
         python -m pip install --upgrade pip
         pip install setuptools wheel twine poetry
+    - name: Install norminette package
+      run: |
+        poetry install
+    - name: Compile .mo files
+      run: |
+        poetry run python norminette/i18n.py
     - name: Build and publish
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
         poetry publish --build --username $TWINE_USERNAME --password $TWINE_PASSWORD
-    - name: Build and publish to test_pypi
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_TEST_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_TEST_PASSWORD }}
-      run: |
-        poetry publish --build --repository testpypi --username $TWINE_USERNAME --password $TWINE_PASSWORD

.github/workflows/python-publish.yml

@@ -22,3 +22,5 @@ dist/
 *_cache
 .venv
 .tox
+*.pot
+**/*.mo

.gitignore

@@ -1,16 +1,13 @@
-FROM python:3.12-slim
+FROM python:3.13-alpine
 
 WORKDIR /usr/src/norminette
 
-COPY pyproject.toml poetry.lock ./
+COPY pyproject.toml poetry.lock README.md ./
+COPY norminette/ ./norminette/
 
-RUN pip3 install poetry \
-    && poetry config virtualenvs.create false \
-    && poetry install --no-dev
-
-COPY . .
-
-RUN python3 setup.py install
+RUN pip3 install --no-cache-dir 'poetry>=2,<3' --root-user-action=ignore \
+    && poetry build \
+    && pip3 install dist/*.whl --root-user-action=ignore
 
 WORKDIR /code
 

Dockerfile

@@ -2,14 +2,13 @@
 
 ## Install
 
-Requires python3.8+ (3.8, 3.9, 3.10, 3.11)
+Norminette requires Python >=3.10.
 
 ### Directly inside your global commands
 
 Install using pip.
 ```shell
-python3 -m pip install --upgrade pip setuptools
-python3 -m pip install norminette
+python3 -m pip install -U norminette
 ```
 
 Install using pipx.
@@ -98,3 +97,28 @@ norminette
 # Run tests
 poetry run pytest
 ```
+
+## Github action
+
+Workflow example to check code with github action :
+
+```yaml
+---
+name: Norminette
+
+on:
+  push:
+
+jobs:
+  check-norminette:
+    name: Norminette
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Norminette
+        uses: 42School/norminette@<tag>
+        with:
+          args: '-RCheckForbiddenSourceHeader'
+```

README.md

@@ -0,0 +1,19 @@
+---
+name: 'norminette-action'
+author: '42 School'
+description: 'It is the official github action for 42 school norminette'
+branding:
+  icon: 'check'
+  color: 'gray-dark'
+inputs:
+  args:
+    description: 'Args passed to norminette'
+    required: false
+    default: '.'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  entrypoint: 'sh'
+  args:
+    - '-c'
+    - "norminette ${{ inputs.args }}"