diff --git a/.codacy.yaml b/.codacy.yaml index 3a31bdb7be..cab97400c0 100644 --- a/.codacy.yaml +++ b/.codacy.yaml @@ -1,3 +1,3 @@ exclude_paths: - 'tests/**' - - 'docs/**' \ No newline at end of file + - 'docs/**' diff --git a/.flake8 b/.flake8 deleted file mode 100644 index 73998f1162..0000000000 --- a/.flake8 +++ /dev/null @@ -1,4 +0,0 @@ -[flake8] -exclude = .git,__pycache__,docs/source/conf.py,old,build,dist -max-complexity = 10 -max-line-length = 100 diff --git a/.github/.codecov.yml b/.github/.codecov.yml new file mode 100644 index 0000000000..85b43f3fef --- /dev/null +++ b/.github/.codecov.yml @@ -0,0 +1,7 @@ +coverage: + status: + project: + default: + # minimum of 97% (real 96%) + target: 97% + threshold: 1% diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..5d29c85b70 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @woile @Lee-W @noirbizarre diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000000..68203f28bd --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# These are supported funding model platforms + +open_collective: commitizen-tools +github: commitizen-tools diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..5eac443f29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,69 @@ +name: 🛠 Bug report +description: Create a report to help us improve +title: Good bug title tells us about precise symptom, not about the root cause. +labels: ['type: bug'] +body: + - type: textarea + id: description + attributes: + label: Description + description: | + A clear and concise description of what the bug is + validations: + required: true + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Run ... + 2. ... + 3. ... + validations: + required: true + - type: textarea + id: current-behavior + attributes: + label: Current behavior + description: What happens actually so you think this is a bug. + validations: + required: true + - type: textarea + id: desired-behavior + attributes: + label: Desired behavior + description: | + A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: | + If applicable, add screenshots to help explain your problem. + - type: textarea + id: environment + attributes: + label: Environment + description: | + Please use the following command to retrieve environment information + + ```bash + cz version --report + ``` + + If `cz version --report` is not available, please run the following commands to retrieve your environment information: + + ```bash + echo "Commitizen Version: $(cz version)" + echo "Python Version: $(python3 -c 'import sys; print(sys.version)')" + echo "Operating System: $(python3 -c 'import platform; print(platform.system())')" + ``` + placeholder: | + Commitizen Version: 4.0.0 + Python Version: 3.13.3 (main, Apr 8 2025, 13:54:08) [Clang 16.0.0 (clang-1600.0.26.6)] + Operating System: Darwin + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..e624b37579 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +# Configuration: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository + +blank_issues_enabled: false +contact_links: + - name: Security Contact + url: https://github.com/woile + about: Please report security vulnerabilities to santiwilly@gmail.com diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml new file mode 100644 index 0000000000..8fe40136c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -0,0 +1,29 @@ +name: 📖 Documentation +description: Suggest an improvement for the documentation of this project +title: Content to be added or fixed +labels: ['type: documentation'] +body: + - type: checkboxes + id: type + attributes: + label: Type + options: + - label: Content inaccurate + - label: Content missing + - label: Typo + - type: input + id: url + attributes: + label: URL + placeholder: | + URL to the code we did not clearly describe or the document page where the content is inaccurate + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: | + A clear and concise description of what content should be added or fixed + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000000..da3bd5af8a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +name: 🚀 Feature request +description: Suggest an idea for this project +title: "" +labels: ['type: feature'] +body: + - type: textarea + id: description + attributes: + label: Description + description: | + A clear and concise description for us to know your idea. + validations: + required: true + - type: textarea + id: possible-solution + attributes: + label: Possible Solution + description: | + A clear and concise description of what you want to happen. + - type: textarea + id: additional-context + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. + - type: textarea + id: related-issue + attributes: + label: Related issues + description: | + If applicable, add link to existing issue also help us know better. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000000..82fb674f7f --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,24 @@ +version: 2 +updates: + - + # Maintain dependencies for GitHub Actions + package-ecosystem: github-actions + directory: / + schedule: + interval: daily + labels: + - dependencies + commit-message: + prefix: "ci" + include: "scope" + - + # Maintain python dependencies + package-ecosystem: pip + directory: / + schedule: + interval: daily + labels: + - dependencies + commit-message: + prefix: "build" + include: "scope" diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000000..5f3f5b82dc --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,3 @@ +'pr-status: wait-for-review': +- changed-files: + - any-glob-to-any-file: '**' diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..87189d131c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,66 @@ + + +## Description + + + +## Checklist + +- [ ] I have read the [contributing guidelines](https://commitizen-tools.github.io/commitizen/contributing/contributing) + +### Was generative AI tooling used to co-author this PR? + + + +- [ ] Yes (please specify the tool below) + + + +### Code Changes + +- [ ] Add test cases to all the changes you introduce +- [ ] Run `uv run poe all` locally to ensure this change passes linter check and tests +- [ ] Manually test the changes: + - [ ] Verify the feature/bug fix works as expected in real-world scenarios + - [ ] Test edge cases and error conditions + - [ ] Ensure backward compatibility is maintained + - [ ] Document any manual testing steps performed +- [ ] Update the documentation for the changes + +### Documentation Changes + + + +- [ ] Run `uv run poe doc` locally to ensure the documentation pages renders correctly +- [ ] Check and fix any broken links (internal or external) + + + +## Expected Behavior + + + +## Steps to Test This Pull Request + + + +## Additional Context + diff --git a/.github/workflows/bumpversion.yml b/.github/workflows/bumpversion.yml new file mode 100644 index 0000000000..0ac511afd7 --- /dev/null +++ b/.github/workflows/bumpversion.yml @@ -0,0 +1,29 @@ +name: Bump version + +on: + push: + branches: + - master + +jobs: + bump-version: + if: ${{ github.repository == 'commitizen-tools/commitizen' && !startsWith(github.event.head_commit.message, 'bump:') }} + runs-on: ubuntu-latest + name: "Bump version and create changelog with commitizen" + steps: + - name: Check out + uses: actions/checkout@v6 + with: + fetch-depth: 0 + token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" + - name: Create bump and changelog + uses: commitizen-tools/commitizen-action@master + with: + github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + changelog_increment_filename: body.md + - name: Release + uses: ncipollo/release-action@v1 + with: + tag: v${{ env.REVISION }} + bodyFile: "body.md" + skipIfReleaseExists: true diff --git a/.github/workflows/docspublish.yml b/.github/workflows/docspublish.yml new file mode 100644 index 0000000000..a84079fd64 --- /dev/null +++ b/.github/workflows/docspublish.yml @@ -0,0 +1,82 @@ +name: Publish documentation + +on: + push: + branches: + - master + workflow_dispatch: + +jobs: + update-cli-screenshots: + if: ${{ github.repository == 'commitizen-tools/commitizen' }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + with: + token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + fetch-depth: 0 + - name: Set up Python + uses: astral-sh/setup-uv@v7 + - name: Set up Go + uses: actions/setup-go@v6 + with: + go-version: '1.25.8' + - name: Set up VHS + run: | + sudo apt update + sudo apt install -y ffmpeg ttyd + go install github.com/charmbracelet/vhs@latest + - name: Install dependencies + run: | + uv --version + uv sync --frozen --group base --group script + - name: Update CLI screenshots + run: | + uv run --no-sync poe doc:screenshots + - name: Commit and push updated CLI screenshots + run: | + git config --global user.name "github-actions[bot]" + git config --global user.email "github-actions[bot]@users.noreply.github.com" + git add docs/images/cli_help docs/images/cli_interactive + + if [[ -n "$(git status --porcelain)" ]]; then + git commit -m "docs(cli/screenshots): update CLI screenshots" -m "[skip ci]" + git push + else + echo "No changes to commit. Skipping." + fi + + publish-documentation: + if: ${{ github.repository == 'commitizen-tools/commitizen' }} + runs-on: ubuntu-latest + needs: update-cli-screenshots + steps: + - uses: actions/checkout@v6 + with: + token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" + fetch-depth: 0 + - name: Pull latest changes + run: | + git pull origin master + - name: Set up Python + uses: astral-sh/setup-uv@v7 + - name: Install dependencies + run: | + uv --version + uv sync --frozen --only-group base --only-group documentation + - name: Generate Sponsors 💖 + uses: JamesIves/github-sponsors-readme-action@v1 + with: + token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }} + file: "docs/README.md" + organization: true + - name: Build docs + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + uv run --no-sync poe doc:build + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@v4 + with: + folder: ./site # The folder the action should deploy. + branch: gh-pages diff --git a/.github/workflows/homebrewpublish.yml b/.github/workflows/homebrewpublish.yml new file mode 100644 index 0000000000..3a4d2cd3d2 --- /dev/null +++ b/.github/workflows/homebrewpublish.yml @@ -0,0 +1,29 @@ +name: Publish to Homebrew + +on: + workflow_run: + workflows: ["Upload Python Package"] + types: + - completed + +jobs: + deploy: + runs-on: macos-latest + if: ${{ github.repository == 'commitizen-tools/commitizen' && github.event.workflow_run.conclusion == 'success' }} + steps: + - name: Checkout + uses: actions/checkout@v6 + - name: Set up Python + uses: astral-sh/setup-uv@v7 + - name: Install dependencies + run: uv pip install -U commitizen + - name: Set Project version env variable + run: | + echo "project_version=$(cz version --project)" >> $GITHUB_ENV + - name: Update Homebrew formula + uses: dawidd6/action-homebrew-bump-formula@v7 + with: + token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + formula: commitizen + tag: v${{ env.project_version }} + force: true diff --git a/.github/workflows/label_issues.yml b/.github/workflows/label_issues.yml new file mode 100644 index 0000000000..359c50d65a --- /dev/null +++ b/.github/workflows/label_issues.yml @@ -0,0 +1,46 @@ +name: Label issues + +on: + issues: + types: + - opened + - reopened + +jobs: + label-issue: + permissions: + issues: write + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v8 + with: + script: | + const issue = await github.rest.issues.get({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + }); + + const body = issue.data.body || ''; + + const osLabels = new Set(); // Use a Set to avoid duplicates + + // Parse the "Environment" section, output of `cz version --report` + if (body.includes('Operating System: Darwin')) { + osLabels.add('os: macOS'); + } + + if (body.includes('Operating System: Linux')) { + osLabels.add('os: Linux'); + } + + if (body.includes('Operating System: Windows')) { + osLabels.add('os: Windows'); + } + + await github.rest.issues.addLabels({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + labels: ['issue-status: needs-triage', ...osLabels], + }); diff --git a/.github/workflows/label_pr.yml b/.github/workflows/label_pr.yml new file mode 100644 index 0000000000..8e2d674f2b --- /dev/null +++ b/.github/workflows/label_pr.yml @@ -0,0 +1,47 @@ +name: "Label Pull Request" +on: +- pull_request_target + +jobs: + label-pr: + permissions: + contents: read + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + with: + sparse-checkout: | + .github/labeler.yml + sparse-checkout-cone-mode: false + - uses: actions/labeler@v6 + with: + configuration-path: .github/labeler.yml + - name: Label based on PR title + uses: actions/github-script@v8 + with: + script: | + const title = context.payload.pull_request.title.toLowerCase(); + const labels = []; + + if (title.includes("fix") || title.includes("bug")) { + labels.push("type: bug"); + } + if (title.includes("feat")) { + labels.push("type: feature"); + } + if (title.includes("doc")) { + labels.push("type: documentation"); + } + if (title.includes("refactor")) { + labels.push("type: refactor"); + } + + if (labels.length > 0) { + await github.rest.issues.addLabels({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.pull_request.number, + labels + }); + } diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 0000000000..8bd275ffab --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,41 @@ +name: Links + +on: + repository_dispatch: + workflow_dispatch: + pull_request: + schedule: + - cron: "00 18 * * *" + +jobs: + check-links: + runs-on: ubuntu-latest + permissions: + issues: write # required for Broken Links Report + steps: + - uses: actions/checkout@v6 + + - name: Link Checker + id: lychee + uses: lycheeverse/lychee-action@v2 + with: + args: --config lychee.toml . + fail: false + + - name: Broken Links Report + if: steps.lychee.outputs.exit_code != 0 && github.event_name == 'schedule' + uses: actions/github-script@v8 + with: + script: | + const fs = require('fs'); + + // Read the markdown file + // Ensure the path is correct relative to the workspace root + const reportBody = fs.readFileSync('./lychee/out.md', 'utf8'); + + await github.rest.issues.create({ + owner: context.repo.owner, + repo: context.repo.repo, + title: 'Broken Links Report', + body: reportBody + }); diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml index 2e0171a5f5..0667e255cd 100644 --- a/.github/workflows/pythonpackage.yml +++ b/.github/workflows/pythonpackage.yml @@ -1,35 +1,70 @@ name: Python package -on: [pull_request] +on: + push: + branches: + - master + pull_request: + workflow_dispatch: jobs: - build: - + detect_changes: runs-on: ubuntu-latest + outputs: + relevant: ${{ steps.filter.outputs.relevant }} + steps: + - uses: actions/checkout@v6 + with: + fetch-depth: 0 + - id: filter + uses: dorny/paths-filter@v4 + with: + filters: | + relevant: + - "commitizen/**" + - "tests/**" + - ".github/workflows/**" + python-check: + needs: detect_changes strategy: - max-parallel: 4 matrix: - python-version: [3.6, 3.7, 3.8] - + python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"] + platform: [ubuntu-22.04, macos-latest, windows-latest] + runs-on: ${{ matrix.platform }} steps: - - uses: actions/checkout@v1 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v1 - with: - python-version: ${{ matrix.python-version }} - - name: Install dependencies - run: | - python -m pip install --pre -U poetry - poetry --version - poetry install - - name: Run tests - run: | - ./scripts/test - - name: Upload coverage to Codecov - if: runner.os == 'Linux' - uses: codecov/codecov-action@v1.0.3 - with: - token: ${{secrets.CODECOV_TOKEN}} - file: ./coverage.xml - flags: unittests - name: codecov-umbrella + - name: No relevant changes, fast-path success + if: ${{ needs.detect_changes.outputs.relevant != 'true' }} + run: | + echo "No relevant file changes; skipping tests and linters." + - uses: actions/checkout@v6 + if: ${{ needs.detect_changes.outputs.relevant == 'true' }} + with: + fetch-depth: 0 + - name: Set up Python ${{ matrix.python-version }} + uses: astral-sh/setup-uv@v7 + if: ${{ needs.detect_changes.outputs.relevant == 'true' }} + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + if: ${{ needs.detect_changes.outputs.relevant == 'true' }} + run: | + uv --version + uv sync --frozen --group base --group test --group linters + - name: Run tests and linters + if: ${{ needs.detect_changes.outputs.relevant == 'true' }} + run: | + git config --global user.email "action@github.com" + git config --global user.name "GitHub Action" + uv run --no-sync poe ci + shell: bash + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v6 + if: ${{ needs.detect_changes.outputs.relevant == 'true' }} + with: + token: ${{ secrets.CODECOV_TOKEN }} + - name: Upload test results to Codecov + uses: codecov/codecov-action@v6 + if: ${{ needs.detect_changes.outputs.relevant == 'true' && !cancelled() }} + with: + token: ${{ secrets.CODECOV_TOKEN }} + report_type: test_results diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml new file mode 100644 index 0000000000..a829ef9470 --- /dev/null +++ b/.github/workflows/pythonpublish.yml @@ -0,0 +1,25 @@ +name: Upload Python Package + +on: + push: + tags: + - "v*" + +jobs: + deploy: + if: ${{ github.repository == 'commitizen-tools/commitizen' }} + runs-on: ubuntu-latest + permissions: + id-token: write + contents: read + steps: + - uses: actions/checkout@v6 + with: + token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" + fetch-depth: 0 + - name: Set up Python + uses: astral-sh/setup-uv@v7 + - name: Build + run: uv build + - name: Publish package to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/.gitignore b/.gitignore index 5cec5fb4a0..fb467da46c 100644 --- a/.gitignore +++ b/.gitignore @@ -46,6 +46,7 @@ coverage.xml *.cover .hypothesis/ .pytest_cache +junit.xml # Translations *.mo @@ -104,8 +105,12 @@ venv.bak/ # mypy .mypy_cache/ +.idea .vscode/ *.bak -# build -poetry.lock +# macOSX +.DS_Store + +# ruff +.ruff_cache diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000000..4ec740e2fd --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,85 @@ +default_install_hook_types: + - pre-commit + - commit-msg + - pre-push + +default_stages: + - pre-commit + +repos: + - repo: meta + hooks: + - id: check-hooks-apply + - id: check-useless-excludes + + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v5.0.0 + hooks: + - id: check-vcs-permalinks + - id: end-of-file-fixer + exclude: "tests/((commands|data|providers/test_uv_provider)/|test_).+" + - id: trailing-whitespace + args: [ --markdown-linebreak-ext=md ] + exclude: '\.svg$' + - id: debug-statements + - id: no-commit-to-branch + - id: check-merge-conflict + - id: check-toml # TOML linter (syntax checker) + - id: check-yaml + args: [ '--unsafe' ] # for mkdocs.yml + - id: detect-private-key + + - repo: https://github.com/astral-sh/uv-pre-commit + rev: 0.9.18 + hooks: + - id: uv-lock + - id: uv-sync + args: [ --frozen, --all-groups ] + stages: [ pre-commit, post-checkout, post-merge, post-rewrite ] + + - repo: https://github.com/asottile/blacken-docs + rev: 1.19.1 + hooks: + - id: blacken-docs + additional_dependencies: [ black~=23.11 ] + + - repo: https://github.com/codespell-project/codespell + rev: v2.4.1 + hooks: + - id: codespell + name: Run codespell to check for common misspellings in files + # config section is within pyproject.toml + language: python + types: [ text ] + args: [ "--write-changes" ] + additional_dependencies: + - tomli + + - repo: https://github.com/commitizen-tools/commitizen + rev: v4.13.9 # automatically updated by Commitizen + hooks: + - id: commitizen + - id: commitizen-branch + stages: + - post-commit + + - repo: https://github.com/ComPWA/taplo-pre-commit + rev: v0.9.3 + hooks: + - id: taplo-format + + - repo: local + hooks: + - id: format + name: Format Python code + language: system + pass_filenames: false + entry: uv run --no-sync poe format + types: [ python ] + + - id: linter and test + name: Linters + language: system + pass_filenames: false + entry: uv run --no-sync poe lint + types: [ python ] diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml new file mode 100644 index 0000000000..d57006f153 --- /dev/null +++ b/.pre-commit-hooks.yaml @@ -0,0 +1,28 @@ +- id: commitizen + name: commitizen check + description: > + Check whether the current commit message follows committing rules. Allow + empty commit messages by default, because they typically indicate to Git + that the commit should be aborted. + entry: cz check + args: [--allow-abort, --commit-msg-file] + stages: [commit-msg] + language: python + language_version: python3 + minimum_pre_commit_version: "1.4.3" + +- id: commitizen-branch + name: commitizen check branch + description: > + Check all commit messages that are already on the current branch but not the + default branch on the origin repository. Useful for checking messages after + the fact (e.g., pre-push or in CI) without an expensive check of the entire + repository history. + entry: cz check + args: [--rev-range, "$PRE_COMMIT_FROM_REF..$PRE_COMMIT_TO_REF"] + always_run: true + pass_filenames: false + language: python + language_version: python3 + minimum_pre_commit_version: "3.2.0" + stages: [pre-push] diff --git a/.taplo.toml b/.taplo.toml new file mode 100644 index 0000000000..36a3453ac9 --- /dev/null +++ b/.taplo.toml @@ -0,0 +1,4 @@ +include = ["pyproject.toml", ".taplo.toml"] + +[formatting] +indent_string = " " diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8ecc162156..0000000000 --- a/.travis.yml +++ /dev/null @@ -1,16 +0,0 @@ -language: python -python: - - "3.6" - - "3.7" - - "3.8" -dist: xenial -sudo: true -install: - - pip install -U poetry - - poetry install - -script: - - ./scripts/test - -after_success: - - codecov \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000000..c2d0e98ae7 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,54 @@ +# AGENTS instructions + +## Purpose + +This file provides **project-specific guidance for AI agents** (and other automated tools) working on the `commitizen` repository. +Follow these instructions in addition to any higher-level system or tool rules. + +## Project Overview + +- **Project**: `commitizen` - a tool to help enforce and automate conventional commits, version bumps, and changelog generation. +- **Primary language**: Python (library + CLI). +- **Key entrypoints**: + - `commitizen/cli.py` - main CLI implementation. + - `commitizen/commands/` - subcommands such as `bump`, `commit`, `changelog`, `check`, etc. + - `commitizen/config/` - configuration discovery and loading. + - `commitizen/providers/` - version providers (e.g., `pep621`, `poetry`, `npm`, `uv`). + +## General Expectations + +- **Preserve public behavior and CLI UX.** +- **Avoid breaking changes** (APIs, CLI flags, exit codes) unless explicitly requested. +- **Keep changes small and focused.** +- **Update or add tests/docs** when you change user-facing behavior. + +## How to Explore and Validate Changes + +- **Code entrypoints**: + - CLI behavior: `commitizen/cli.py` and `commitizen/commands/`. + - Config resolution: `commitizen/config/factory.py` and config modules. + - Bump/changelog/versioning: `commitizen/bump.py`, `commitizen/changelog.py`, `commitizen/version_schemes.py`, `commitizen/providers/`. +- **Docs to consult** (before larger changes): + - `docs/README.md` + - `docs/contributing.md` + - `docs/commands/` and `docs/config/` +- **Tests**: + - Prefer targeted runs, e.g. `uv run pytest tests/test_cli.py` or a specific `tests/commands/` file. + +## Coding Guidelines (for AI tools) + +- **Style**: Follow patterns in nearby code; keep functions focused. +- **Types**: Preserve or improve existing type hints. +- **Errors**: Prefer `commitizen/exceptions.py` error types; keep messages clear for CLI users. +- **Output**: Use `commitizen/out.py`; do not add noisy logging. + +## Common Task Pointers + +- **CLI commands**: edit `commitizen/commands/.py`, wire via `commitizen/cli.py`, and adjust `tests/commands/` + `docs/commands/`. +- **Version bumps / changelog**: use `commitizen/bump.py`, `commitizen/changelog.py`, `commitizen/version_schemes.py`, and `commitizen/providers/` (+ matching tests). +- **Config resolution**: use `commitizen/config/factory.py` and config modules; update `tests/test_conf.py` and related tests. + +## When Unsure + +- Prefer **reading tests and documentation first** to understand the expected behavior. +- When behavior is ambiguous, **assume backward compatibility** with current tests and docs is required. diff --git a/CHANGELOG.md b/CHANGELOG.md index a248316d0d..31bbd5a29f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,87 +1,2348 @@ -# CHANGELOG +## v4.13.9 (2026-02-25) -## v1.8.0 +### Fix + +- avoid raising an exception when a change_type is not defined (#1879) + +## v4.13.8 (2026-02-18) + +### Fix + +- **config**: fix contains_commitizen_section failing for completely empty files + +## v4.13.7 (2026-02-09) + +### Fix + +- **provider**: use encoding settings in config (#1857) + +## v4.13.6 (2026-02-07) + +### Fix + +- **bump**: preserve existing changelog header when `changelog_merge_prerelease` is used with `cz bump --changelog` (#1850) + +## v4.13.5 (2026-02-05) + +### Fix + +- **changelog**: add incremental parameter to changelog generation (#1808) + +## v4.13.4 (2026-02-04) + +### Fix + +- **pre-commit-hooks**: correct rev-range syntax in commitizen-branch (#1841) + +## v4.13.3 (2026-02-04) + +### Refactor + +- **version_schemes**: shorten generate_prerelease (#1838) + +## v4.13.2 (2026-02-03) + +### Refactor + +- simplify code with pathlib Path object (#1840) +- **tags**: extract version resolution method (#1839) + +## v4.13.1 (2026-02-03) + +### Refactor + +- **config**: replace is_empty_config with contains_commitizen_section, improve multi config resolution algorithm (#1842) + +## v4.13.0 (2026-02-01) + +### Feat + +- **bump**: add --version-files-only and deprecate --files-only (#1802) +- **version**: add --tag tag to version command (#1819) +- **cli**: add description when choosing a commit rule (#1825) +- **tags**: enable version schemes with less than 3 components (#1705) + +### Fix + +- **config**: include pyproject.toml in multi config file warning (#1803) +- add pytest ruff rule PT and fix missing deprecation warning (#1826) +- **message_length_limit**: align the behavior of message_length_limit (#1813) +- **cli**: capitalize the first characters of help texts and fix minor grammar errors + +### Refactor + +- replace hard-coded string "cz_conventional_commits" with DEFAULT_SETTINGS (#1830) +- **bump**: fix unbounded variable type issue + +## v4.12.1 (2026-01-22) + +### Fix + +- **pre-commit-hooks**: remove magic constants on pre-push hook (#1815) + +## v4.12.0 (2026-01-19) + +### Feat + +- **prek**: supporting prek as an alternative to pre-commit and switching to prek (#1799) + +## v4.11.6 (2026-01-15) + +### Fix + +- **git**: commit bodies with carriage returns are correctly split by … (#1780) + +## v4.11.5 (2026-01-15) + +### Fix + +- **config**: ensure the actually used config file is correct, better test coverage (#1784) + +## v4.11.4 (2026-01-15) + +### Fix + +- **cli**: move sys.excepthook override to correct line, rename 'type' parameter, fix no argv test (#1791) + +## v4.11.3 (2026-01-13) + +### Fix + +- **bump**: fix the issue that changelog_merge_prerelease not working on cz bump + +## v4.11.2 (2026-01-12) + +### Fix + +- **config**: add warning for multiple configuration files and update documentation (#1773) + +## v4.11.1 (2026-01-03) + +### Fix + +- **providers**: normalize package names in uv provider for uv.lock matching + +## v4.11.0 (2025-12-29) + +### Feat + +- Drop support for Python 3.9 as EOL reached and add Python 3.14 support +- add custom validation + +## v4.10.1 (2025-12-11) + +### Fix + +- **version**: fix the behavior of cz version --major +- **cli**: debug and no_raise can be used together in sys.excepthook +- **git**: replace lstrip with strip for compatibility issue +- **bump**: remove NotAllowed related to --get-next option, other related refactoring + +### Refactor + +- **version**: rename class member to align with other classes +- **cargo_provider**: cleanup and get rid of potential type errors +- **bump**: extract option validation and new version resolution to new functions +- **changelog**: raise NotAllow when file_name not passed instead of using assert +- **bump**: rename parameter and variables + +### Perf + +- **ruff**: enable ruff rules TC001~TC006 +- add TYPE_CHECKING to CzQuestion imports + +## v4.10.0 (2025-11-10) + +### Feat + +- add config option for line length warning +- **conventional_commits**: allow exclamation in title on BC +- **version**: add the ability to just print major or minor version +- allow `amend!` prefix as created by `git --fixup=reword:` + +### Fix + +- **commands/version**: add missing return +- **test**: set terminal width for cli tests +- **Init**: raise InitFailedError on keyboard interrupt on pre-commit hook question, simplify logic, remove unreachable code path + +### Refactor + +- **bump**: cleanup related to update_version_file +- **RestructuredTest**: rename variable, fix typo and remove unnecessary string copy +- **TomlConfig**: minor cleanups for DX +- **Commit**: refactor _prompt_commit_questions and fix some type hint +- **hooks**: refactor to improve readability +- **Init**: make project_info a module and remove self.project_info +- **BaseConfig**: update docstring, extract factory method and remove unnecessary variable assignment +- remove self.encoding for better maintainability +- **utils**: make get_backup_file_path to return a path for semantic correctness +- remove unnecessary class member tag_format +- **Bump**: remove use of getattr +- **ConventionalCommitsCz**: rewrite message method to make the pattern more clear +- **cmd**: unnest try except +- **BaseCommitizen**: remove NotImplementedError and make them abstract method +- **BaseCommitizen**: construct Style object directly to get rid of potential type error + +## v4.9.1 (2025-09-10) + +### Fix + +- **dependency**: move deprecated to project.dependencies + +## v4.9.0 (2025-09-09) + +### Feat + +- **check**: add check against default branch + +### Fix + +- **changelog**: mark get_smart_tag_range as deprecated +- **init**: use pre-push as pre-commit stage +- **init**: use pre-push as pre-commit stage +- **init**: make welcome message easier to read +- **Init**: fix a typo in _ask_version_provider options and remove unnecessary filter, use named tuple for options +- **ExitCode**: add from_str in ExitCode and replace parse_no_raise with it +- raise NoVersionSpecifiedError if version is None, and adjust call sites of get_version +- **Changelog**: fix _export_template variable type +- **Bump**: rewrite --get-next NotAllowed error message for consistency + +### Refactor + +- **changelog**: add get_next_tag_name_after_version and test, mark unused for get_smart_tag_range +- **changelog**: simplify logic for get_oldest_and_newest_rev +- **changelog**: shorten generate_tree_from_commits +- **Init**: remove the variable values_to_add and the update_config function for readability +- **Init**: remove unnecessary methods from ProjectInfo and refactor _ask_tag +- **Init**: fix unbounded variable in _ask_tag_format +- **init**: remote extra words +- **process_commit_message**: better type and early return +- **Init**: extract _get_config_data for readability +- **changelog**: shorten condition expression and early return +- **Changelog**: remove unnecessary intermediate variables for better readability +- **bump**: use a loop to shorten a series of similar NotAllowed exceptions +- **Init**: use ternary operator +- **TagRules**: extract tag_formats property and simplify list comprehension +- **git**: remove redundant if branch +- **ScmProvider**: replace sorted with max +- **ExpectedExit**: make the constructor more compact +- **ParseArgs**: simplify __call__ function body + +## v4.8.4 (2025-09-05) + +### Fix + +- members in workspace, use exclude +- cargo workspaces + +### Refactor + +- reduce code indentation + +## v4.8.3 (2025-06-09) + +### Fix + +- **cli**: update description for deprecate warning +- **commit**: emit deprecated warning of cz commit -s +- **Check**: make parameters backward compatible +- **BaseConfig**: mypy error +- **deprecated**: mark deprecate in v5 +- **defaults**: add non-capitalized default constants back and deprecated warning + +### Refactor + +- **jira**: refactor message +- **conventional_commits**: use TypedDict for answers +- **conventional_commits**: make schema_pattern more readable +- do not guess if changelog format is provided +- **check**: compile once and rename variable +- **questions**: type questions with TypedDict +- **bump**: simplify nested if +- **git**: retype get_commits parameter to make it more friendly to call sites +- **git**: simplify tag logic +- **bump**: eliminate similar patterns in code +- **bump**: use any to replace 'or' chain +- remove unnecessary bool() and remove Any type from TypedDict get +- **bump**: improve readability and still bypass mypy check +- **commands**: remove unused args, type version command args +- **commit**: type commit args +- **check**: type CheckArgs arguments +- **check**: remove unused argument +- **changelog**: type untyped arguments +- **bump**: TypedDict for bump argument +- make methods protected, better type +- **conventional_commits**: remove unnecessary checks +- fix mypy output and better type +- **BaseCommitizen**: remove unused process_commit +- remove `TypeError` handling since `Python >=3.9` is required +- add comment clarifying `no_raise` parsing to `list[int]` +- **cli.py**: add type hints +- **mypy**: remove `unused-ignore` +- **changelog**: better typing, yield +- **cli**: early return and improve test coverage +- **git**: extract _create_commit_cmd_string +- misc cleanup +- **bump**: clean up +- **bump**: add type for out, replace function with re escape +- **BaseConfig**: use setter +- **changelog**: minor cleanup +- **git**: refactor get_tag_names +- **EOLType**: add eol enum back and reorganize methods +- **git**: code cleanup and better test coverage +- **commit**: simplify call +- **version_scheme**: cleanup +- improve readability and fix typos + +### Perf + +- **bump**: avoid unnecessary list construction and rename variable to avoid confusion +- **tags**: use set + +## v4.8.2 (2025-05-22) + +### Refactor + +- **check**: simplify code +- **check**: remove unnecessary variable + +## v4.8.1 (2025-05-22) + +### Refactor + +- **customize**: improve code readability + +## v4.8.0 (2025-05-20) + +### Feat + +- **cli**: add --tag-format argument to changelog command + +## v4.7.2 (2025-05-18) + +### Refactor + +- **default**: capitalize all constants and remove unnecessary variable + +## v4.7.1 (2025-05-16) + +### Fix + +- **bump**: don't fail if an invalid version tag is present (fix #1410) (#1418) + +## v4.7.0 (2025-05-10) + +### Feat + +- **providers**: add support for `Cargo.lock` + +### Refactor + +- **tests**: increase verbosity of variables + +## v4.6.3 (2025-05-07) + +### Fix + +- **changelog.py**: cross-platform path handling using os.path.join and modify the path linter and test parameter +- **changelog.py**: modify the CHANGELOG.md generated by cz bump --changelog to the right place + +## v4.6.2 (2025-05-05) + +### Fix + +- **docs**: fix url link and table formatting in the customization docs (#1399) + +## v4.6.1 (2025-05-05) + +### Fix + +- **commit**: use os.unlink to remove temp file + +## v4.6.0 (2025-04-13) + +### Feat + +- **changelog**: expose commit parents' digests when processing commits +- **git**: add parents' digests in commit information + +## v4.5.1 (2025-04-09) + +### Fix + +- print which tag is invalid + +## v4.5.0 (2025-04-04) + +### Feat + +- **init**: set uv to default value if both pyproject.toml and uv.lock present + +### Fix + +- **commands/init**: add missing uv provider to "cz init" + +## v4.4.1 (2025-03-02) + +### Fix + +- **tags**: fixes ImportError on Python >=3.11 (#1363) (#1364) + +## v4.4.0 (2025-03-02) + +### Feat + +- **tags**: adds `legacy_tag_formats` and `ignored_tag_formats` settings + +### Refactor + +- **get_tag_regexes**: dedup tag regexes definition + +## v4.3.0 (2025-02-28) + +### Feat + +- **providers**: add uv_provider + +## v4.2.2 (2025-02-18) + +### Fix + +- **bump**: manual version bump if prerelease offset is configured + +## v4.2.1 (2025-02-08) + +### Fix + +- **bump**: add debugging to bump + +## v4.2.0 (2025-02-07) + +### Feat + +- draft of the --empty parameter + +### Refactor + +- **bump**: rename --empty as --allow-no-commit + +## v4.1.1 (2025-01-26) + +### Fix + +- **get-next-bump**: add a test case +- **get-next-bump**: fix to permit usage of --get-next options even when update_changelog_on_bump is set to true + +## v4.1.0 (2024-12-06) + +### Feat + +- **commit**: allow '-- --allow-empty' to create empty commits + +## v4.0.0 (2024-11-26) + +## v3.31.0 (2024-11-16) + +### Feat + +- **commitizen**: document '--' double dash in '--help' + +### Fix + +- **commit**: avoid warnings with 'always_signoff' configuration +- **commit**: resolve 'always_signoff' configuration and '-s' CLI issues + +## v3.30.1 (2024-11-10) + +### Refactor + +- **cli**: replace magic number 0 with ExitCode.EXPECTED_EXIT +- **defaults**: disallow style as None +- **cz_customize**: return empty string for info, example, schema and schema_pattern if not provided + +## v3.30.0 (2024-10-23) + +### Feat + +- **commands/commit**: add force-edit functionality after answering questions + +### Refactor + +- remove redundant return None + +## v3.29.1 (2024-09-26) + +### Fix + +- **changelog**: Factorized TAG_FORMAT_REGEXES +- **changelog**: Handle tag format without version pattern +- **changelog**: handle custom tag_format in changelog generation + +### Refactor + +- Use format strings + +## v3.29.0 (2024-08-11) + +### Feat + +- **bump**: add functionality to write the next version to stdout + +## v3.28.0 (2024-07-17) + +### Feat + +- add argument to limit length of commit message in checks + +## v3.27.0 (2024-05-22) + +### Feat + +- **config_files**: add support for "cz.toml" config file + +## v3.26.2 (2024-05-22) + +### Fix + +- **base.py**: add encoding when open changlelog_file + +## v3.26.1 (2024-05-22) + +### Fix + +- **cli/commands**: add description for subcommands + +### Refactor + +- **KNOWN_SCHEMES**: replace set comprehension for list comprehension +- **tests/commands**: move "other" tests for the correspondent file + +## v3.26.0 (2024-05-18) + +### Feat + +- **ci/cd**: automates the generation of CLI screenshots + +## v3.25.1 (2024-05-15) + +### Refactor + +- strip possessive from note about ci option + +## v3.25.0 (2024-04-30) + +### Feat + +- add an argument to limit the length of commit message + +### Fix + +- strip the commit message for calculating length +- resolve test error by removing defaults + +### Refactor + +- **commands/commit**: replace comparison with chained comparison +- check the length in Commit instead of Commitizen + +## v3.24.0 (2024-04-18) + +### Feat + +- **schemes**: adds support for SemVer 2.0 (dot in pre-releases) (fix #1025) (#1072) + +## v3.23.0 (2024-04-18) + +### Feat + +- **bump**: `version_files` now support glob patterns (fix #1067) (#1070) + +## v3.22.0 (2024-04-11) + +### Feat + +- **cli**: add config option to specify config file path + +## v3.21.3 (2024-03-30) + +### Refactor + +- **defaults**: move cz_conventional_commit defaults out of defaults.py + +## v3.21.2 (2024-03-30) + +### Fix + +- **commitizen/git.py,-tests/test_git.py**: Resolve tempfile path spaces issue in git commit function + +## v3.21.1 (2024-03-30) + +### Fix + +- **command-init**: "cz init" should list existing tag in reverse order + +## v3.21.0 (2024-03-30) + +### Feat + +- **commit**: add retry_after_failure config option and --no-retry flag + +### Refactor + +- **utils**: convert git project root to posix path for backup file name +- **commit**: use Optional[str] instead of str | None +- **commit**: remove unused tempfile import +- **git-hooks**: make git hooks use get_backup_file_path +- **utils**: move backup path creation to utils + +## v3.20.0 (2024-03-19) + +### Feat + +- **changelog**: expose commits `sha1`, `author` and `author_email` in changelog tree (fix #987) (#1013) + +## v3.19.0 (2024-03-19) + +### Feat + +- **changelog**: adds a `changelog_release_hook` called for each release in the changelog (#1018) + +## v3.18.4 (2024-03-14) + +### Fix + +- **changelog**: include latest change when dry run and incremental + +## v3.18.3 (2024-03-11) + +### Fix + +- **warnings**: all warnings should go to `stdout` + +## v3.18.2 (2024-03-11) + +### Fix + +- **git**: force the default git locale on methods relying on parsing the output (#1012) + +## v3.18.1 (2024-03-11) + +### Fix + +- **changelog**: changelog hook was not called on dry run + +## v3.18.0 (2024-03-07) + +### Feat + +- **changelog**: `changelog_message_build_hook` can now generate multiple changelog entries from a single commit (#1003) + +## v3.17.2 (2024-03-07) + +### Fix + +- **changelog**: ensure `changelog_message_builder_hook` can access and modify `change_type` (#1002) + +## v3.17.1 (2024-03-07) + +### Fix + +- **bump**: pre and post bump hooks were failing when an increment was provided (fix #1004) + +## v3.17.0 (2024-03-06) + +### Feat + +- **changelog**: `changelog_message_build_hook` can remove message by returning a falsy value + +## v3.16.0 (2024-02-26) + +### Feat + +- **commands**: add bump --exact + +### Fix + +- **bump**: change --exact-increment to --increment-mode +- **bump**: only get and validate commits if increment is not provided +- Improve type annotations + +## v3.15.0 (2024-02-17) + +### Feat + +- **bump**: functionality to add build-metadata to version string + +## v3.14.1 (2024-02-04) + +### Fix + +- **bump**: remove unused method +- **scm**: only search tags that are reachable by the current commit + +## v3.14.0 (2024-02-01) + +### Feat + +- properly bump versions between prereleases (#799) + +## v3.13.0 (2023-12-03) + +### Feat + +- **commands-bump**: automatically create annotated tag if message is given +- add tag message argument to cli +- **git**: add get tag message function +- add custom message to annotated git tag + +### Fix + +- **test-bump-command**: typo in --annotated-tag option inside test +- **commitizen-git**: add quotes for tag message + +### Refactor + +- **commands-bump**: make changelog variable in 1 line +- **commands-bump**: cast str to bool + +## v3.12.0 (2023-10-18) + +### Feat + +- **formats**: expose some new customizable changelog formats on the `commitizen.changelog_format` endpoint (Textile, AsciiDoc and RestructuredText) +- **template**: add `changelog --export-template` command +- **template**: allow to override the template from cli, configuration and plugins +- **cli.py**: Added support for extra git CLI args after -- separator for `cz commit` command + +### Fix + +- **filename**: ensure `file_name` can be passed to `changelog` from `bump` command + +### Refactor + +- **git.py**: Removed 'extra_args' from git.commit +- **extra_args**: Fixed broken code due to rebase and finalized tests +- Code Review - round 1 changes +- **Commit**: Added deprecation on git signoff mechanic + +## v3.10.1 (2023-10-14) + +### Fix + +- **bump**: add bump support with custom type + scope + exclamation mark +- **bump**: version bumping + +## v3.10.0 (2023-09-25) + +### Feat + +- Drop support for Python 3.7 (#858) + +## v3.9.1 (2023-09-22) + +### Fix + +- **conf**: handle parse error when init (#856) + +## v3.9.0 (2023-09-15) + +### Feat + +- **commands**: add arg of cz commit to execute git add + +### Fix + +- **tests**: modify the arg of commit from add to all +- **commitizen**: Modify the function of the arg a of commit from git add all to git add update + +### Refactor + +- **commitizen**: add return type hint of git add function + +## v3.8.2 (2023-09-09) + +### Refactor + +- **provider**: split provider code and related tests into individual files for maintainability (#830) + +## v3.8.1 (2023-09-08) + +### Fix + +- add sponsors to README + +## v3.8.0 (2023-09-05) + +### Feat + +- **defaults.py**: add always_signoff config option for commits + +## v3.7.1 (2023-09-04) + +### Fix + +- empty error on bump failure + +## v3.7.0 (2023-08-26) + +### Feat + +- **provider**: add npm2 provider to update package.json, package-lock.json, and npm-shrinkwrap.json + +### Fix + +- **provider**: fix npm version provider to update package-lock.json and npm-shrinkwrap.json if they exist +- **provider**: fix npm provider to update package-lock.json and npm-shrinkwrap.json if they exist +- **test**: pass correct type to get_package_version tests +- **tests**: completed test coverage for npm2 + +## v3.6.0 (2023-08-01) + +### Feat + +- **changelog.py**: add encoding to get_metadata +- **unicode**: add unicode support + +### Fix + +- add missing `encoding` parameter +- **out.py**: `TextIOWrapper.reconfigure` typing +- correct type hinting +- use base config for encoding + +### Refactor + +- **defaults.py**: use variables in `DEFAULT_SETTINGS` + +## v3.5.4 (2023-07-29) + +### Refactor + +- replace SemVer type literals by respective constants + +## v3.5.3 (2023-07-15) + +### Fix + +- Treat $version the same as unset tag_format in ScmProvider + +### Refactor + +- Make tag_format properly default to $version + +## v3.5.2 (2023-06-25) + +### Fix + +- **typing**: no_raise is declared as optional + +## v3.5.1 (2023-06-24) + +### Fix + +- only use version tags when generating a changelog + +## v3.5.0 (2023-06-23) + +### Feat + +- Add option in bump command to redirect git output to stderr + +## v3.4.1 (2023-06-23) + +### Fix + +- **veresion_schemes**: import missing Self for python 3.11 + +## v3.4.0 (2023-06-20) + +### Feat + +- **version-schemes**: expose `version_schemes` as a `commitizen.scheme` endpoint. + +## v3.3.0 (2023-06-13) + +### Feat + +- add support for cargo workspaces + +## v3.2.2 (2023-05-11) + +### Fix + +- **init**: fix is_pre_commit_installed method + +## v3.2.1 (2023-05-03) + +### Fix + +- add support for importlib_metadata 6 + +## v3.2.0 (2023-05-01) + +### Feat + +- **hooks**: add prepare-commit-msg and post-commit hooks +- **commit**: add --write-message-to-file option + +### Fix + +- **bump**: better match for change_type when finding increment +- **changelog**: breaking change on additional types for conventional commits +- **bump**: breaking changes on additional types for conventional commits +- improve errors message when empty .cz.json found +- **init**: poetry detection +- bump decli which is type hinted + +### Refactor + +- **commit**: change type of write_message_to_file to path + +## v3.1.1 (2023-04-28) + +### Fix + +- bump changelog for prerelease without commits + +## v3.1.0 (2023-04-25) + +### Feat + +- make `major_version_zero` customizable by third parties + +## v3.0.1 (2023-04-23) + +### Fix + +- typo in hook + +### Refactor + +- set default_install_hook_types + +## v3.0.0 (2023-04-23) + +### BREAKING CHANGE + +- Plugins are now exposed as `commitizen.plugin` entrypoints +- Python 3.6 is not officially supported anymore. Please migrate from 3.6 to 3.7 or greater. + +### Feat + +- **init**: add new settings +- add semver support through version provider new api (#686) +- **changelog**: add merge_prereleases flag +- **providers**: add a `scm` version provider +- **providers**: add support for some JSON-based version providers (NPM, Composer) +- **providers**: add support for some TOML-based versions (PEP621, Poetry, Cargo) +- **providers**: add a `commitizen.provider` endpoint for alternative versions providers +- **plugins**: Switch to an importlib.metadata.EntryPoint-based plugin loading + +### Fix + +- **init**: welcome message +- small corrections and clean up +- major version zero message +- update dependencies +- **commands/changelog**: use topological order for commit ordering +- **excepthook**: ensure traceback can only be a `TracebackType` or `None` + +## v2.42.1 (2023-02-25) + +### Fix + +- **bump**: fixed environment variables in bump hooks + +## v2.42.0 (2023-02-11) + +### Feat + +- **bump**: support prereleases with start offset + +## v2.41.0 (2023-02-08) + +### Feat + +- **bump**: added support for running arbitrary hooks during bump + +## v2.40.0 (2023-01-23) + +### Feat + +- **yaml_config**: add explicit_start for yaml output + +## v2.39.1 (2022-12-31) + +### Fix + +- filter git diff from commit message + +## v2.39.0 (2022-12-31) + +### Feat + +- **init**: allow user to select which type of pre commit hooks to install + +### Fix + +- **init**: space between `--hook-type` options +- **init**: report error when hook installation failed + +### Refactor + +- **init**: `_install_pre_commit_hook` raise error when failed + +## v2.38.0 (2022-12-12) + +### Feat + +- **poetry**: relax packaging version + +## v2.37.1 (2022-11-30) + +### Fix + +- **changelog**: allow rev range lookups without a tag format + +## v2.37.0 (2022-10-28) + +### Feat + +- add major-version-zero option to support initial package development + +## v2.36.0 (2022-10-28) + +### Feat + +- **scripts**: remove `venv/bin/` +- **scripts**: add error message to `test` + +### Fix + +- **scripts/test**: MinGW64 workaround +- **scripts/test**: use double-quotes +- **scripts**: pydocstyle and cz +- **bump.py**: use `sys.stdin.isatty()` +- **scripts**: use cross-platform POSIX +- **scripts**: use portable shebang +- **pythonpackage.yml**: undo indent reformatting +- **pythonpackage.yml**: use `bash` + +## v2.35.0 (2022-09-23) + +### Feat + +- allow fixup! and squash! in commit messages + +## v2.34.0 (2022-09-19) + +### Feat + +- **bump**: support optional manual version argument + +### Fix + +- **bump**: fix type hint +- **bump**: fix typos + +## v2.33.1 (2022-09-16) + +### Fix + +- **bump.py**: `CHANGELOG.md` gets git added and committed correctly + +## v2.33.0 (2022-09-15) + +### Feat + +- add functionality for dev-releases + +## v2.32.7 (2022-09-14) + +### Fix + +- **README.md**: fix pre-commit install command + +## v2.32.6 (2022-09-14) + +### Fix + +- **bump**: log git commit stderr and stdout during bump + +## v2.32.5 (2022-09-10) + +### Fix + +- **command_changelog**: Fixed issue #561 cz bump could not find the latest version tag with custom tag_format + +## v2.32.4 (2022-09-08) + +### Refactor + +- **bump**: Remove a redundant join call + +## v2.32.3 (2022-09-07) + +### Fix + +- **bump**: Search for version number line by line + +## v2.32.2 (2022-08-22) + +### Fix + +- **bump**: Support regexes containing colons + +## v2.32.1 (2022-08-21) + +### Fix + +- **git**: Improves error checking in get_tags +- **git**: improves git error checking in get_commits + +### Refactor + +- **git**: test the git log parser behaves properly when the repository has no commits +- **changelog**: fixes logic issue made evident by latest fix(git) commit + +## v2.32.0 (2022-08-21) + +### Feat + +- **pre-commit**: Add commitizen-branch hook + +## v2.31.0 (2022-08-14) + +### Feat + +- new file + +### Fix + +- **pyproject.toml**: remove test added configurations +- **changelog**: use defaults.change_type_order in conventional commit +- capitalize types in default change_type_order + +## v2.30.0 (2022-08-14) + +### Feat + +- Determine newline to write with Git + +## v2.29.6 (2022-08-13) + +### Fix + +- **cmd**: improve character encoding detection for sub-commands + +## v2.29.5 (2022-08-07) + +### Fix + +- **git**: use "git tag -v" return_code to check whether a tag is signed + +## v2.29.4 (2022-08-05) + +### Refactor + +- **tool**: use charset_normalizer instead of chardet + +## v2.29.3 (2022-08-02) + +### Refactor + +- **changelog**: removes unused code. duplicates are found in changelog_parser + +## v2.29.2 (2022-07-27) + +### Fix + +- **bump**: send changelog to stdout when `dry-run` is paired with `changelog-to-stdout` + +## v2.29.1 (2022-07-26) + +### Fix + +- **Check**: process empty commit message +- **ConventionalCommitsCz**: cz's schema validates the whole commit message now + +### Refactor + +- **Check**: remove the extra preprocessing of commit message file + +## v2.29.0 (2022-07-22) + +### Feat + +- use chardet to get correct encoding +- **bump**: add signed tag support for bump command + +### Fix + +- avoid that pytest overrides existing gpg config +- **test**: set git to work with gpg + +## v2.28.1 (2022-07-22) + +### Fix + +- **changelog**: skip non-compliant commit subjects when building changelog + +## v2.28.0 (2022-07-03) + +### Feat + +- **bump**: make increment option case insensitive + +## v2.27.1 (2022-05-22) + +### Fix + +- **pre-commit**: Use new --allow-abort option +- **pre-commit**: Confine hook to commit-msg stage +- **pre-commit**: Set min pre-commit to v1.4.3 +- **pre-commit**: Don't require serial execution + +## v2.27.0 (2022-05-16) + +### Feat + +- **bump**: let it respect pre-commit reformats when bumping + +## v2.26.0 (2022-05-14) + +### Feat + +- **check**: Add --allow-abort option + +## v2.25.0 (2022-05-10) + +### Feat + +- **changelog**: Improve whitespace in changelog + +### Refactor + +- **changelog**: Simplify incremental_build + +## v2.24.0 (2022-04-15) + +### Feat + +- add --no-raise to avoid raising error codes + +### Fix + +- change error code for NoneIncrementExit + +## v2.23.0 (2022-03-29) + +### Feat + +- **customize.py**: adding support for commit_parser, changelog_pattern, change_type_map + +## v2.22.0 (2022-03-29) + +### Feat + +- **changelog**: add support for single version and version range + +### Refactor + +- speed up testing and wait for tags +- **git**: use date as a function in GitTag to easily patch + +## v2.21.2 (2022-02-22) + +### Fix + +- remove type ignore + +## v2.21.1 (2022-02-22) + +### Refactor + +- Switch to issue forms +- Switch to issue forms +- Switch to issue forms + +## v2.21.0 (2022-02-17) + +### Feat + +- skip merge messages that start with Pull request + +## v2.20.5 (2022-02-07) + +### Fix + +- Ignore packages that are not plugins + +### Refactor + +- iter_modules only accepts str + +## v2.20.4 (2022-01-17) + +### Fix + +- **bump**: raise non zero error code when there's no eligible commit to bump + +## v2.20.3 (2021-12-20) + +### Fix + +- **check**: filter out comment message when checking + +## v2.20.2 (2021-12-14) + +### Fix + +- **poetry**: add typing-exteions to dev + +## v2.20.1 (2021-12-14) + +### Fix + +- import TypedDict from type_extensions for backward compatibility + +### Refactor + +- **conventional_commits**: remove duplicate patterns and import from defaults +- **config**: add CzSettings and Questions TypedDict +- **defaults**: add Settings typeddict +- **defaults**: move bump_map, bump_pattern, commit_parser from defaults to ConventionalCommitsCz + +## v2.20.0 (2021-10-06) + +### Feat + +- **cli.py**: add shortcut for signoff command +- add signoff parameter to commit command + +## v2.19.0 (2021-09-27) + +### Feat + +- utility for showing system information + +## v2.18.2 (2021-09-27) + +### Fix + +- **cli**: handle argparse different behavior after python 3.9 + +## v2.18.1 (2021-09-12) + +### Fix + +- **commit**: correct the stage checker before committing + +## v2.18.0 (2021-08-13) + +### Feat + +- **prompt**: add keyboard shortcuts with config option + +### Refactor + +- **shortcuts**: move check for shortcut config setting to apply to any list select + +## v2.17.13 (2021-07-14) + +## v2.17.12 (2021-07-06) + +### Fix + +- **git.py**: ensure signed commits in changelog when git config log.showsignature=true + +## v2.17.11 (2021-06-24) + +### Fix + +- correct indentation for json config for better readability + +## v2.17.10 (2021-06-22) + +### Fix + +- add support for jinja2 v3 + +## v2.17.9 (2021-06-11) + +### Fix + +- **changelog**: generating changelog after a pre-release + +## v2.17.8 (2021-05-28) + +### Fix + +- **changelog**: annotated tags not generating proper changelog + +## v2.17.7 (2021-05-26) + +### Fix + +- **bump**: fix error due to bumping version file without eol through regex +- **bump**: fix offset error due to partially match + +## v2.17.6 (2021-05-06) + +### Fix + +- **cz/conventional_commits**: optionally expect '!' right before ':' in schema_pattern + +## v2.17.5 (2021-05-06) + +## v2.17.4 (2021-04-22) + +### Fix + +- version update in a docker-compose.yaml file + +## v2.17.3 (2021-04-19) + +### Fix + +- fix multiple versions bumps when version changes the string size + +## v2.17.2 (2021-04-10) + +### Fix + +- **bump**: replace all occurrences that match regex +- **wip**: add test for current breaking change + +## v2.17.1 (2021-04-08) + +### Fix + +- **commands/init**: fix toml config format error + +## v2.17.0 (2021-04-02) + +### Feat + +- Support versions on random positions + +## v2.16.0 (2021-03-08) + +### Feat + +- **bump**: send incremental changelog to stdout and bump output to stderr + +## v2.15.3 (2021-02-26) + +### Fix + +- add utf-8 encode when write toml file + +## v2.15.2 (2021-02-24) + +### Fix + +- **git**: fix get_commits deliminator + +## v2.15.1 (2021-02-21) + +### Fix + +- **config**: change read mode from `r` to `rb` + +## v2.15.0 (2021-02-21) + +### Feat + +- **changelog**: add support for multiline BREAKING paragraph + +## v2.14.2 (2021-02-06) + +### Fix + +- **git**: handle the empty commit and empty email cases + +## v2.14.1 (2021-02-02) + +### Fix + +- remove yaml warnings when using '.cz.yaml' + +## v2.14.0 (2021-01-20) + +### Feat + +- **#271**: enable creation of annotated tags when bumping + +## v2.13.0 (2021-01-01) + +### Feat + +- **#319**: add optional change_type_order + +### Refactor + +- raise an InvalidConfigurationError +- **#323**: address PR feedback +- move expected COMMITS_TREE to global + +## v2.12.1 (2020-12-30) + +### Fix + +- read commit_msg_file with utf-8 + +## v2.12.0 (2020-12-30) + +### Feat + +- **deps**: Update and relax tomlkit version requirement + +## v2.11.1 (2020-12-16) + +### Fix + +- **commit**: attach user info to backup for permission denied issue + +## v2.11.0 (2020-12-10) + +### Feat + +- add yaml as a config option +- **config**: add support for the new class YAMLConfig at the root of the confi internal package +- **init**: add support for yaml config file at init + +### Fix + +- **YAMLConfig**: add a TypeError exception to handle in _parse_settings method + +## v2.10.0 (2020-12-02) + +### Feat + +- **commitizen/cli**: add the integration with argcomplete + +## v2.9.0 (2020-12-02) + +### Feat + +- **Init**: add the json config support as an option at Init +- **commitizen/config/json_config**: add json support for configuration + +### Fix + +- **json_config**: fix the emtpy_config_content method + +## v2.8.2 (2020-11-21) + +### Fix + +- support `!` in cz check command + +## v2.8.1 (2020-11-21) + +### Fix + +- prevent prerelease from creating a bump when there are no commits + +## v2.8.0 (2020-11-15) + +### Feat + +- allow files-only to set config version and create changelog + +## v2.7.0 (2020-11-14) + +### Feat + +- **bump**: add flag `--local-version` that supports bumping only the local version instead of the public + +## v2.6.0 (2020-11-04) + +### Feat + +- **commands/bump**: add config option to create changelog on bump + +## v2.5.0 (2020-11-04) + +### Feat + +- **commands/changelog**: add config file options for start_rev and incremental + +## v2.4.2 (2020-10-26) + +### Fix + +- **init.py**: mypy error (types) +- **commands/bump**: Add NoneIncrementExit to fix git fatal error when creating existing tag + +### Refactor + +- **commands/bump**: Remove comment and changed ... for pass + +## v2.4.1 (2020-10-04) + +### Fix + +- **cz_customize**: make schema_pattern customiziable through config for cz_customize + +## v2.4.0 (2020-09-18) + +### Feat + +- **cz_check**: cz check can read commit message from pipe + +## v2.3.1 (2020-09-07) + +### Fix + +- conventional commit schema + +## v2.3.0 (2020-09-03) + +### Feat + +- **cli**: rewrite cli instructions to be more succinct about what they require + +### Fix + +- **cli**: add guideline for subject input +- **cli**: wrap the word enter with brackets + +## v2.2.0 (2020-08-31) + +### Feat + +- **cz_check**: cz check can read from a string input + +## v2.1.0 (2020-08-06) + +### Feat + +- **cz_check**: Add rev to all displayed ill-formatted commits +- **cz_check**: Update to show all ill-formatted commits + +### Refactor + +- **cz_check**: Refactor _get_commits to return GitCommit instead of dict + +## v2.0.2 (2020-08-03) + +### Fix + +- **git**: use double quotation mark in get_tags + +## v2.0.1 (2020-08-02) + +### Fix + +- **commands/changelog**: add exception message when failing to find an incremental revision +- **commands/bump**: display message variable properly + +## v2.0.0 (2020-07-26) + +### BREAKING CHANGE + +- setup.cfg, .cz and .cz.cfg are no longer supported +- Use "cz version" instead +- "cz --debug" will no longer work + #47 + +### Feat + +- **init**: enable setting up pre-commit hook through "cz init" + +### Fix + +- add missing `pyyaml` dependency +- **cli**: make command required for commitizen + +### Refactor + +- **config**: drop "files" configure support. Please use "version_files" instead +- **config**: remove ini configuration support +- **cli**: remove "--version" argument + +## v1.25.0 (2020-07-26) + +### Feat + +- **conventional_commits**: use and proper support for conventional commits v1.0.0 + +## v1.24.0 (2020-07-26) + +### Feat + +- add author and author_email to git commit + +## v1.23.4 (2020-07-26) + +### Refactor + +- **changelog**: remove pkg_resources dependency + +## v1.23.3 (2020-07-25) + +### Fix + +- **commands/bump**: use `return_code` in commands used by bump +- **commands/commit**: use return_code to raise commit error, not stderr + +### Refactor + +- **cmd**: add return code to Command + +## v1.23.2 (2020-07-25) + +### Fix + +- **bump**: add changelog file into stage when running `cz bump --changelog` + +## v1.23.1 (2020-07-14) + +### Fix + +- Raise NotAGitProjectError only in git related command + +## v1.23.0 (2020-06-14) + +### Feat + +- **cli**: enable displaying all traceback for CommitizenException when --debug flag is used + +### Refactor + +- **exception**: rename MissingConfigError as MissingCzCustomizeConfigError +- **exception**: Rename CommitFailedError and TagFailedError with Bump prefix +- **commands/init**: add test case and remove unaccessible code +- **exception**: move output message related to exception into exception +- **exception**: implement message handling mechanism for CommitizenException +- **cli**: do not show traceback if the raised exception is CommitizenException +- introduce DryRunExit, ExpectedExit, NoCommandFoundError, InvalidCommandArgumentError +- use custom exception for error handling +- **error_codes**: remove unused NO_COMMIT_MSG error code + +## v1.22.3 (2020-06-10) + +## v1.22.2 (2020-05-29) + +### Fix + +- **changelog**: empty lines at the beginning of the CHANGELOG + +## v1.22.1 (2020-05-23) + +### Fix + +- **templates**: remove trailing space in keep_a_changelog + +## v1.22.0 (2020-05-13) + +### Feat + +- **changelog**: add support for `changelog_hook` when changelog finishes the generation +- **changelog**: add support for `message_hook` method +- **changelog**: add support for modifying the change_type in the title of the changelog + +### Fix + +- **changelog**: rename `message_hook` -> `changelog_message_builder_hook` + +## v1.21.0 (2020-05-09) + +### Feat + +- **commands/bump**: add "--check-consistency" optional + +## v1.20.0 (2020-05-06) + +### Feat + +- **bump**: add optional --no-verify argument for bump command + +## v1.19.3 (2020-05-04) + +### Fix + +- **docs**: change old url woile.github.io to commitizen-tools.github.io +- **changelog**: generate today's date when using an unreleased_version + +## v1.19.2 (2020-05-03) + +### Fix + +- **changelog**: sort the commits properly to their version + +## v1.19.1 (2020-05-03) + +### Fix + +- **commands/check**: Show warning if no commit to check when running `cz check --rev-range` + +### Refactor + +- **cli**: add explicit category for deprecation warnings + +## v1.19.0 (2020-05-02) + +### Feat + +- **changelog**: add support for any commit rule system +- **changelog**: add incremental flag +- **commands/changelog**: make changelog_file an option in config +- **commands/changelog**: exit when there is no commit exists +- **commands/changelog**: add --start-rev argument to `cz changelog` +- **changelog**: generate changelog based on git log +- **commands/changelog**: generate changelog_tree from all past commits +- **cz/conventinal_commits**: add changelog_map, changelog_pattern and implement process_commit +- **cz/base**: add default process_commit for processing commit message +- **changelog**: changelog tree generation from markdown + +### Fix + +- **git**: missing dependency removed +- **changelog**: check get_metadata for existing changelog file +- **cz/conventional_commits**: fix schema_pattern break due to rebase +- **changelog_template**: fix list format +- **commitizen/cz**: set changelog_map, changelog_pattern to none as default +- **commands/changelog**: remove --skip-merge argument +- **cli**: add changelog arguments + +### Refactor + +- **changelog**: use functions from changelog.py +- **changelog**: rename category to change_type to fit 'keep a changelog' +- **templates**: rename as "keep_a_changelog_template.j2" +- **templates**: remove unneeded __init__ file +- **cli**: reorder commands +- **templates**: move changelog_template from cz to templates +- **tests/utils**: move create_file_and_commit to tests/utils +- **commands/changelog**: remove redundant if statement +- **commands/changelog**: use jinja2 template instead of string concatenation to build changelog + +## v1.18.3 (2020-04-22) + +### Refactor + +- **commands/init**: fix typo + +## v1.18.2 (2020-04-22) + +### Fix + +- **git**: fix returned value for GitCommit.message when body is empty + +### Refactor + +- **git**: replace GitCommit.message code with one-liner + +## v1.18.1 (2020-04-16) + +### Fix + +- **config**: display ini config deprecation warning only when commitizen config is inside + +## v1.18.0 (2020-04-13) + +### Feat + +- **bump**: support for ! as BREAKING change in commit message + +### Fix + +- **cz/customize**: add error handling when customize detail is not set + +### Refactor + +- **cz/customize**: remove unused mypy ignore +- **mypy**: fix mypy check by checking version.pre exists +- **cz**: add type annotation to registry +- **commands/check**: fix type annotation +- **config/base**: use Dict to replace dict in base_config +- **cz/base**: fix config type used in base cz +- **cz**: add type annotation for each function in cz +- **config**: fix mypy warning for _conf + +## v1.17.1 (2020-03-24) + +### Fix + +- **commands/check**: add help text for check command without argument + +### Refactor + +- **cli**: fix typo + +## v1.17.0 (2020-03-15) + +### Feat + +- **commands/check**: add --rev-range argument for checking commits within some range + +### Fix + +- **bump**: fix bump find_increment error + +### Refactor + +- **cz/connventional_commit**: use \S to check scope +- **git**: remove unnecessary dot between git range +- **tests/bump**: use parameterize to group similliar tests + +## v1.16.4 (2020-03-03) + +### Fix + +- **commands/init**: fix clean up file when initialize commitizen config + +### Refactor + +- **defaults**: split config files into long term support and deprecated ones + +## v1.16.3 (2020-02-20) + +### Fix + +- replace README.rst with docs/README.md in config files + +### Refactor + +- **docs**: remove README.rst and use docs/README.md + +## v1.16.2 (2020-02-01) + +### Fix + +- **commands/check**: add bump into valid commit message of convention commit pattern + +## v1.16.1 (2020-02-01) + +### Fix + +- **pre-commit**: set pre-commit check stage to commit-msg + +## v1.16.0 (2020-01-21) + +### Feat + +- **git**: get_commits default from first_commit + +### Refactor + +- **commands/bump**: rename parameter into bump_setting to distinguish bump_setting and argument +- **git**: rename get tag function to distinguish return str and GitTag +- **cmd**: reimplement how cmd is run +- **git**: Use GitCommit, GitTag object to store commit and git information +- **git**: make arguments other then start and end in get_commit keyword arguments +- **git**: Change get_commits into returning commits instead of lines of messages + +## v1.15.1 (2020-01-20) + +### Fix + +- **cli**: fix --version not functional + +### Refactor + +- **tests/commands/bump**: use tmp_dir to replace self implemented tmp dir behavior +- **test_bump_command**: rename camel case variables +- **tests/commands/check**: use pytest fixture tmpdir replace self implemented contextmanager +- **test/commands/other**: replace unit test style mock with mocker fixture +- **tests/commands**: separate command unit tests into modules +- **tests/commands**: make commands related tests a module + +## v1.15.0 (2020-01-20) + +### Feat + +- **config**: look up configuration in git project root +- **git**: add find_git_project_root + +### Fix + +- **git**: remove breakline in the return value of find_git_project_root + +### Refactor + +- **git**: make find_git_project_root return None if it's not a git project +- **config/base_config**: make set_key not implemented +- **error_codes**: move all the error_codes to a module +- **config**: replace string type path with pathlib.Path + +## v1.14.2 (2020-01-14) + +### Fix + +- **github_workflow/pythonpublish**: use peaceiris/actions-gh-pages@v2 to publish docs + +## v1.14.1 (2020-01-11) + +### Fix + +- **cli**: fix the way default handled for name argument +- **cli**: fix name cannot be overwritten through config in newly refactored config design + +## v1.14.0 (2020-01-06) + +### Feat + +- **pre-commit-hooks**: add pre-commit hook + +### Refactor + +- **pre-commit-hooks**: add metadata for the check hook + +## v1.13.1 (2019-12-31) -### Feature +### Fix + +- **github_workflow/pythonpackage**: set git config for unit testing +- **scripts/test**: ensure the script fails once the first failure happens + +## v1.13.0 (2019-12-30) + +### Feat + +- add project version to command init + +## v1.12.0 (2019-12-30) + +### Feat + +- new init command + +## v1.10.3 (2019-12-29) + +### Refactor + +- **commands/bump**: use "version_files" internally +- **config**: set "files" to alias of "version_files" + +## v1.10.2 (2019-12-27) + +### Fix + +- **config**: handle empty config file +- **config**: fix load global_conf even if it doesn't exist +- **config/ini_config**: replace outdated _parse_ini_settings with _parse_settings + +### Refactor + +- new config system where each config type has its own class +- **config**: add type annotation to config property +- **config**: fix wrongly type annotated functions +- **config/ini_config**: move deprecation warning into class initialization +- **config**: use add_path instead of directly assigning _path +- **all**: replace all the _settings invoke with settings.update +- **cz/customize**: remove unnecessary statement "raise NotImplementedError("Not Implemented yet")" +- **config**: move default settings back to defaults +- **config**: Make config a class and each type of config (e.g., toml, ini) a child class + +## v1.10.1 (2019-12-10) + +### Fix + +- **cli**: overwrite "name" only when it's not given +- **config**: fix typo + +## v1.10.0 (2019-11-28) + +### Feat + +- support for different commitizens in `cz check` +- **bump**: new argument --files-only + +## v1.9.2 (2019-11-23) + +### Fix + +- **commands/check.py**: --commit-msg-file is now a required argument + +## v1.9.1 (2019-11-23) + +### Fix + +- **cz/exceptions**: exception AnswerRequiredException not caught (#89) -- new custom exception for commitizen -- commit is aborted if nothing in staging +## v1.9.0 (2019-11-22) -## v1.7.0 +### Feat -### Feature +- **Commands/check**: enforce the project to always use conventional commits +- **config**: add deprecation warning for loading config from ini files +- **cz/customize**: add jinja support to enhance template flexibility +- **cz/filters**: add required_validator and multiple_line_breaker +- **Commands/commit**: add ´--dry-run´ flag to the Commit command +- **cz/cz_customize**: implement info to support info and info_path +- **cz/cz_customize**: enable bump_pattern bump_map customization +- **cz/cz_customize**: implement customizable cz +- new 'git-cz' entrypoint -- new styles for the prompt -- new configuration option for the prompt styles +### Fix + +- commit dry-run doesn't require staging to be clean +- **scripts**: add back the delete poetry prefix +- correct typo to spell "convention" +- removing folder in windows throwing a PermissionError +- **test_cli**: testing the version command + +### Refactor + +- **config**: remove has_pyproject which is no longer used +- **cz/customize**: make jinja2 a custom requirement. if not installed use string.Template instead +- **cz/utils**: rename filters as utils +- **cli**: add back --version and remove subcommand required constraint + +## v1.8.0 (2019-11-12) + +### Feat + +- **cz**: add a base exception for cz customization +- **commands/commit**: abort commit if there is nothing to commit +- **git**: add is_staging_clean to check if there is any file in git staging + +### Fix + +- **commands/commit**: catch exception raised by customization cz +- **cli**: handle the exception that command is not given +- **cli**: enforce subcommand as required + +### Refactor + +- **cz/conventional_commit**: make NoSubjectException inherit CzException and add error message +- **command/version**: use out.write instead of out.line +- **command**: make version a command instead of an argument + +## v1.7.0 (2019-11-08) + +### Feat + +- **config**: update style instead of overwrite +- **config**: parse style in config +- **commit**: make style configurable for commit command + +### Fix + +- **cz**: fix bug in BaseCommitizen.style +- **cz**: fix merge_style usage error +- **cz**: remove breakpoint + +### Refactor + +- **cz**: change the color of default style -## v1.6.0 +## v1.6.0 (2019-11-05) -### Feature +### Feat -- new retry argument to execute previous commit again +- **commit**: new retry argument to execute previous commit again -## v1.5.1 +## v1.5.1 (2019-06-04) ### Fix -- issue in poetry add preventing the installation in py36 +- #28 allows poetry add on py36 envs -## v1.5.0 +## v1.5.0 (2019-05-11) -### Feature +### Feat -- it is possible to specify a pattern to be matched in configuration `files` when doing bump. +- **bump**: it is now possible to specify a pattern in the files attr to replace the version -## v1.4.0 +## v1.4.0 (2019-04-26) -### Feature +### Feat -- new argument (--yes) in bump to accept prompt questions +- added argument yes to bump in order to accept questions ### Fix -- error is shown when commiting fails. +- **bump**: handle commit and create tag failure -## v1.3.0 +## v1.3.0 (2019-04-24) -### Feature +### Feat -- bump: new commit message template, useful when having to skip ci. +- **bump**: new commit message template -## v1.2.1 +## v1.2.1 (2019-04-21) ### Fix -- prefixes like docs, build, etc no longer generate a PATCH +- **bump**: prefixes like docs, build, etc no longer generate a PATCH -## v1.2.0 +## v1.2.0 (2019-04-19) -### Feature +### Feat - custom cz plugins now support bumping version -## v1.1.1 +## v1.1.1 (2019-04-18) + +### Fix + +- **bump**: commit message now fits better with semver +- conventional commit 'breaking change' in body instead of title + +### Refactor + +- changed stdout statements +- **schema**: command logic removed from commitizen base +- **info**: command logic removed from commitizen base +- **example**: command logic removed from commitizen base +- **commit**: moved most of the commit logic to the commit command + +## v1.1.0 (2019-04-14) + +### Feat + +- new working bump command +- create version tag +- update given files with new version +- **config**: new set key, used to set version to cfg +- support for pyproject.toml +- first semantic version bump implementation + +### Fix + +- removed all from commit +- fix config file not working + +### Refactor + +- added commands folder, better integration with decli + +## v1.0.0 (2019-03-01) + +### Refactor + +- removed delegator, added decli and many tests + +## 1.0.0b2 (2019-01-18) + +## v1.0.0b1 (2019-01-17) + +### Feat + +- py3 only, tests and conventional commits 1.0 + +## v0.9.11 (2018-12-17) + +### Fix + +- **config**: load config reads in order without failing if there is no commitizen section + +## v0.9.10 (2018-09-22) + +### Fix + +- parse scope (this is my punishment for not having tests) + +## v0.9.9 (2018-09-22) + +### Fix + +- parse scope empty + +## v0.9.8 (2018-09-22) + +### Fix + +- **scope**: parse correctly again + +## v0.9.7 (2018-09-22) + +### Fix + +- **scope**: parse correctly + +## v0.9.6 (2018-09-19) + +### Fix + +- **manifest**: included missing files + +### Refactor + +- **conventionalCommit**: moved filters to questions instead of message + +## v0.9.5 (2018-08-24) + +### Fix + +- **config**: home path for python versions between 3.0 and 3.5 + +## v0.9.4 (2018-08-02) + +### Feat + +- **cli**: added version + +## v0.9.3 (2018-07-28) + +### Feat + +- **committer**: conventional commit is a bit more intelligent now + +## v0.9.2 (2017-11-11) + +## v0.9.1 (2017-11-11) ### Fix -- breaking change is now part of the body, instead of being in the subject +- **setup.py**: future is now required for every python version + +## v0.9.0 (2017-11-08) + +### Refactor + +- python 2 support + +## v0.8.6 (2017-11-08) + +## v0.8.5 (2017-11-08) + +## v0.8.4 (2017-11-08) + +## v0.8.3 (2017-11-08) + +## v0.8.2 (2017-10-08) + +## v0.8.1 (2017-10-08) + +## v0.8.0 (2017-10-08) + +### Feat + +- **cz**: jira smart commits + +## v0.7.0 (2017-10-08) + +### Refactor + +- **cli**: renamed all to ls command +- **cz**: renamed angular cz to conventional changelog cz + +## v0.6.0 (2017-10-08) + +### Feat + +- info command for angular -## v1.1.0 +## v0.5.0 (2017-10-07) -### Features +## v0.4.0 (2017-10-07) -- auto bump version based on conventional commits using sem ver -- pyproject support (see [pyproject.toml](./pyproject.toml) for usage) +## v0.3.0 (2017-10-07) -## v1.0.0 +## v0.2.0 (2017-10-07) -### Features +### Feat -- more documentation -- added tests -- support for conventional commits 1.0.0 +- **config**: new loads from ~/.cz and working project .cz .cz.cfg and setup.cfg +- package discovery -### BREAKING CHANGES +### Refactor -- use of questionary to generate the prompt (so we depend on promptkit 2.0) -- python 3 only +- **cz_angular**: improved messages diff --git a/LICENSE b/LICENSE index 881035d1d0..05cf267ae5 100644 --- a/LICENSE +++ b/LICENSE @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file +SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in index b78dd2e964..4c07f07c31 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,4 @@ include .bumpversion.cfg -include README.rst include LICENSE include commitizen/cz/*.txt global-exclude *.py[cod] __pycache__ *.so *.dylib diff --git a/README.rst b/README.rst deleted file mode 100644 index acedde15fd..0000000000 --- a/README.rst +++ /dev/null @@ -1,182 +0,0 @@ -============= -Commitizen -============= - - Python 3 command line utility to standardize commit messages and bump version - - -.. image:: https://github.com/Woile/commitizen/workflows/Python%20package/badge.svg - :alt: Github Actions - :target: https://github.com/Woile/commitizen/actions - -.. image:: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square - :alt: Conventional Commits - :target: https://conventionalcommits.org - -.. image:: https://img.shields.io/pypi/v/commitizen.svg?style=flat-square - :alt: PyPI Package latest release - :target: https://pypi.org/project/commitizen/ - -.. image:: https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square - :alt: Supported versions - :target: https://pypi.org/project/commitizen/ - -.. image:: https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square - :alt: Codecov - :target: https://codecov.io/gh/Woile/commitizen - -.. image:: docs/images/demo.gif - :alt: Example running commitizen - --------------- - -**Documentation**: https://Woile.github.io/commitizen/ - --------------- - -.. contents:: - :depth: 2 - - -About -========== - -Commitizen is a tool designed for teams. - -Its main purpose is to define a standard way of commiting rules -and communicating it (using the cli provided by commitizen). - -The reasoning behind it is that is easier to read, and enforces writing -descriptive commits. - -Besides that, having a convetion on your commits, makes it possible to -parse them and use them for something else, like generating automatically -the version or a changelog. - - -Installation -============= - -:: - - pip install -U commitizen - -:: - - poetry add commitizen --dev - - -**Global installation** - -:: - - sudo pip3 install -U commitizen - -Features -======== - -- Command line utility to create commits with your rules. Defaults: `conventional commits`_ -- Display information about your commit rules (commands: schema, example, info) -- Bump version automatically using semantic verisoning based on the commits. `Read More <./docs/bump.md>`_ -- Generate a changelog using "Keep a changelog" (Planned feature) - - -Commit rules -============ - -This client tool prompts the user with information about the commit. - -Based on `conventional commits`_ - -This is an example of how the git messages history would look like: - -:: - - fix: minor typos in code - feat: new command update - docs: improved commitizens tab in readme - feat(cz): jira smart commits - refactor(cli): renamed all to ls command - feat: info command for angular - docs(README): added badges - docs(README): added about, installation, creating, etc - feat(config): new loads from ~/.cz and working project .cz .cz.cfg and setup.cfg - -And then using ``cz bump`` you can change the version of your project - -``feat`` to ``MINOR`` -``fix`` to ``PATCH`` - - -Commitizens -=========== - -These are the available commiting styles by default: - -* cz_conventional_commits: `conventional commits`_ -* cz_jira: `jira smart commits `_ - - -The installed ones can be checked with: - -:: - - cz ls - - - -Commiting -========= - -Run in your terminal - -:: - - cz commit - -or the shortcut - -:: - - cz c - - -Usage -===== - -:: - - $ cz --help - usage: cz [-h] [--debug] [-n NAME] [--version] - {ls,commit,c,example,info,schema,bump} ... - - Commitizen is a cli tool to generate conventional commits. - For more information about the topic go to https://conventionalcommits.org/ - - optional arguments: - -h, --help show this help message and exit - --debug use debug mode - -n NAME, --name NAME use the given commitizen - --version get the version of the installed commitizen - - commands: - {ls,commit,c,example,info,schema,bump} - ls show available commitizens - commit (c) create new commit - example show commit example - info show information about the cz - schema show commit schema - bump bump semantic version based on the git log - -Contributing -============ - -Feel free to create a PR. - -1. Clone the repo. -2. Add your modifications -3. Create a virtualenv -4. Run :code:`./scripts/test` - - -.. _conventional commits: https://conventionalcommits.org/ \ No newline at end of file diff --git a/commitizen/__version__.py b/commitizen/__version__.py index 29654eec0a..c7a3dc0c86 100644 --- a/commitizen/__version__.py +++ b/commitizen/__version__.py @@ -1 +1 @@ -__version__ = "1.8.0" +__version__ = "4.13.9" diff --git a/commitizen/bump.py b/commitizen/bump.py index 64ae2e469e..cb572d3612 100644 --- a/commitizen/bump.py +++ b/commitizen/bump.py @@ -1,186 +1,141 @@ +from __future__ import annotations + +import os import re -from collections import defaultdict -from itertools import zip_longest +from collections import OrderedDict +from glob import iglob +from logging import getLogger from string import Template -from typing import List, Optional, Union +from typing import TYPE_CHECKING, cast -from packaging.version import Version +from commitizen.defaults import BUMP_MESSAGE, MAJOR, MINOR, PATCH +from commitizen.exceptions import CurrentVersionNotFoundError +from commitizen.git import GitCommit, smart_open -from commitizen.defaults import ( - MAJOR, - MINOR, - PATCH, - bump_map, - bump_message, - bump_pattern, -) +if TYPE_CHECKING: + from collections.abc import Generator, Iterable + from commitizen.version_schemes import Increment, Version -def find_increment( - messages: List[str], regex: str = bump_pattern, increments_map: dict = bump_map -) -> Optional[str]: +VERSION_TYPES = [None, PATCH, MINOR, MAJOR] - # Most important cases are major and minor. - # Everything else will be considered patch. - increments_map_default = defaultdict(lambda: None, increments_map) - pattern = re.compile(regex) - increment = None - - for message in messages: - result = pattern.search(message) - if not result: - continue - found_keyword = result.group(0) - new_increment = increments_map_default[found_keyword] - if new_increment == "MAJOR": - increment = new_increment - break - elif increment == "MINOR" and new_increment == "PATCH": - continue - increment = new_increment - - return increment - - -def prerelease_generator(current_version: str, prerelease: Optional[str] = None) -> str: - """ - X.YaN # Alpha release - X.YbN # Beta release - X.YrcN # Release Candidate - X.Y # Final +logger = getLogger("commitizen") - This function might return something like 'alpha1' - but it will be handled by Version. - """ - if not prerelease: - return "" - - version = Version(current_version) - new_prerelease_number: int = 0 - if version.is_prerelease and prerelease.startswith(version.pre[0]): - prev_prerelease: int = list(version.pre)[1] - new_prerelease_number = prev_prerelease + 1 - pre_version = f"{prerelease}{new_prerelease_number}" - return pre_version - - -def semver_generator(current_version: str, increment: str = None) -> str: - version = Version(current_version) - prev_release = list(version.release) - increments = [MAJOR, MINOR, PATCH] - increments_version = dict(zip_longest(increments, prev_release, fillvalue=0)) - - # This flag means that current version - # must remove its prerelease tag, - # so it doesn't matter the increment. - # Example: 1.0.0a0 with PATCH/MINOR -> 1.0.0 - if not version.is_prerelease: - - if increment == MAJOR: - increments_version[MAJOR] += 1 - increments_version[MINOR] = 0 - increments_version[PATCH] = 0 - elif increment == MINOR: - increments_version[MINOR] += 1 - increments_version[PATCH] = 0 - elif increment == PATCH: - increments_version[PATCH] += 1 - - return str( - f"{increments_version['MAJOR']}." - f"{increments_version['MINOR']}." - f"{increments_version['PATCH']}" - ) - - -def generate_version( - current_version: str, increment: str, prerelease: Optional[str] = None -) -> Version: - """Based on the given increment a proper semver will be generated. - - For now the rules and versioning scheme is based on - python's PEP 0440. - More info: https://www.python.org/dev/peps/pep-0440/ - - Example: - PATCH 1.0.0 -> 1.0.1 - MINOR 1.0.0 -> 1.1.0 - MAJOR 1.0.0 -> 2.0.0 - """ - pre_version = prerelease_generator(current_version, prerelease=prerelease) - semver = semver_generator(current_version, increment=increment) - # TODO: post version - # TODO: dev version - return Version(f"{semver}{pre_version}") +def find_increment( + commits: list[GitCommit], regex: str, increments_map: dict | OrderedDict +) -> Increment | None: + if isinstance(increments_map, dict): + increments_map = OrderedDict(increments_map) -def update_version_in_files(current_version: str, new_version: str, files: list): + # Most important cases are major and minor. + # Everything else will be considered patch. + select_pattern = re.compile(regex) + increment: str | None = None + + for commit in commits: + for message in commit.message.split("\n"): + result = select_pattern.search(message) + + if result: + found_keyword = result.group(1) + new_increment = None + for match_pattern in increments_map.keys(): + if re.match(match_pattern, found_keyword): + new_increment = increments_map[match_pattern] + break + + if new_increment is None: + logger.debug( + f"no increment needed for '{found_keyword}' in '{message}'" + ) + + if VERSION_TYPES.index(increment) < VERSION_TYPES.index(new_increment): + logger.debug( + f"increment detected is '{new_increment}' due to '{found_keyword}' in '{message}'" + ) + increment = new_increment + + if increment == MAJOR: + break + + return cast("Increment", increment) + + +def update_version_in_files( + current_version: str, + new_version: str, + version_files: Iterable[str], + *, + check_consistency: bool, + encoding: str, +) -> list[str]: """Change old version to the new one in every file given. Note that this version is not the tag formatted one. So for example, your tag could look like `v1.0.0` while your version in the package like `1.0.0`. + + Returns the list of updated files. """ - for location in files: - filepath, *regex = location.split(":", maxsplit=1) - if len(regex) > 0: - regex = regex[0] - - # Read in the file - filedata = [] - with open(filepath, "r") as f: - for line in f: - if regex: - is_match = re.search(regex, line) - if not is_match: - filedata.append(line) - continue - - # Replace the target string - filedata.append(line.replace(current_version, new_version)) + updated_files = [] - # Write the file out again - with open(filepath, "w") as file: - file.write("".join(filedata)) + for path, pattern in _resolve_files_and_regexes(version_files, current_version): + current_version_found = False + bumped_lines = [] + + with open(path, encoding=encoding) as version_file: + for line in version_file: + bumped_line = ( + line.replace(current_version, new_version) + if pattern.search(line) + else line + ) + current_version_found = current_version_found or bumped_line != line + bumped_lines.append(bumped_line) -def create_tag(version: Union[Version, str], tag_format: Optional[str] = None): - """The tag and the software version might be different. + if check_consistency and not current_version_found: + raise CurrentVersionNotFoundError( + f"Current version {current_version} is not found in {path}.\n" + "The version defined in commitizen configuration and the ones in " + "version_files are possibly inconsistent." + ) - That's why this function exists. + bumped_version_file_content = "".join(bumped_lines) - Example: + # Write the file out again + with smart_open(path, "w", encoding=encoding) as file: + file.write(bumped_version_file_content) + updated_files.append(path) - | tag | version (PEP 0440) | - | --- | ------- | - | v0.9.0 | 0.9.0 | - | ver1.0.0 | 1.0.0 | - | ver1.0.0.a0 | 1.0.0a0 | + return updated_files - """ - if isinstance(version, str): - version = Version(version) - if not tag_format: - return version.public +def _resolve_files_and_regexes( + patterns: Iterable[str], version: str +) -> Generator[tuple[str, re.Pattern], None, None]: + """ + Resolve all distinct files with their regexp from a list of glob patterns with optional regexp + """ + filepath_set: set[tuple[str, str]] = set() + for pattern in patterns: + drive, tail = os.path.splitdrive(pattern) + path, _, regex = tail.partition(":") + filepath = drive + path + regex = regex or re.escape(version) - major, minor, patch = version.release - prerelease = "" - if version.is_prerelease: - prerelease = f"{version.pre[0]}{version.pre[1]}" + filepath_set.update((path, regex) for path in iglob(filepath)) - t = Template(tag_format) - return t.safe_substitute( - version=version, major=major, minor=minor, patch=patch, prerelease=prerelease - ) + return ((path, re.compile(regex)) for path, regex in sorted(filepath_set)) def create_commit_message( - current_version: Union[Version, str], - new_version: Union[Version, str], - message_template: str = None, + current_version: Version | str, + new_version: Version | str, + message_template: str | None = None, ) -> str: if message_template is None: - message_template = bump_message + message_template = BUMP_MESSAGE t = Template(message_template) return t.safe_substitute(current_version=current_version, new_version=new_version) diff --git a/commitizen/changelog.py b/commitizen/changelog.py new file mode 100644 index 0000000000..d8b8acccae --- /dev/null +++ b/commitizen/changelog.py @@ -0,0 +1,369 @@ +"""Design + +## Metadata CHANGELOG.md + +1. Identify irrelevant information (possible: changelog title, first paragraph) +2. Identify Unreleased area +3. Identify latest version (to be able to write on top of it) + +## Parse git log + +1. get commits between versions +2. filter commits with the current cz rules +3. parse commit information +4. yield tree nodes +5. format tree nodes +6. produce full tree +7. generate changelog + +Extra: +- [x] Generate full or partial changelog +- [x] Include in tree from file all the extra comments added manually +- [x] Add unreleased value +- [x] hook after message is parsed (add extra information like hyperlinks) +- [x] hook after changelog is generated (api calls) +- [x] add support for change_type maps +""" + +from __future__ import annotations + +import re +from collections import OrderedDict, defaultdict +from dataclasses import dataclass +from datetime import date +from itertools import chain +from typing import TYPE_CHECKING, Any + +from deprecated import deprecated +from jinja2 import ( + BaseLoader, + ChoiceLoader, + Environment, + FileSystemLoader, + Template, +) + +from commitizen.exceptions import InvalidConfigurationError, NoCommitsFoundError +from commitizen.tags import TagRules + +if TYPE_CHECKING: + from collections.abc import Generator, Iterable, Mapping, MutableMapping, Sequence + + from commitizen.cz.base import ChangelogReleaseHook, MessageBuilderHook + from commitizen.git import GitCommit, GitTag + + +@dataclass +class Metadata: + """ + Metadata extracted from the changelog produced by a plugin + """ + + unreleased_start: int | None = None + unreleased_end: int | None = None + latest_version: str | None = None + latest_version_position: int | None = None + latest_version_tag: str | None = None + + def __post_init__(self) -> None: + if self.latest_version and not self.latest_version_tag: + # Test syntactic sugar + # latest version tag is optional if same as latest version + self.latest_version_tag = self.latest_version + + +@dataclass +class IncrementalMergeInfo: + """ + Information regarding the last non-pre-release, parsed from the changelog. + + Required to merge pre-releases on bump. + Separate from Metadata to not mess with the interface. + """ + + name: str | None = None + index: int | None = None + + +def get_commit_tag(commit: GitCommit, tags: list[GitTag]) -> GitTag | None: + return next((tag for tag in tags if tag.rev == commit.rev), None) + + +def generate_tree_from_commits( + commits: list[GitCommit], + tags: list[GitTag], + commit_parser: str, + changelog_pattern: str, + unreleased_version: str | None = None, + change_type_map: dict[str, str] | None = None, + changelog_message_builder_hook: MessageBuilderHook | None = None, + changelog_release_hook: ChangelogReleaseHook | None = None, + rules: TagRules | None = None, + during_version_bump: bool = False, +) -> Generator[dict[str, Any], None, None]: + pat = re.compile(changelog_pattern) + map_pat = re.compile(commit_parser, re.MULTILINE) + body_map_pat = re.compile(commit_parser, re.MULTILINE | re.DOTALL) + rules = rules or TagRules() + + # Check if the latest commit is not tagged + if during_version_bump and rules.merge_prereleases: + current_tag = None + else: + current_tag = get_commit_tag(commits[0], tags) if commits else None + current_tag_name = unreleased_version or "Unreleased" + current_tag_date = ( + date.today().isoformat() if unreleased_version is not None else "" + ) + + used_tags: set[GitTag] = set() + if current_tag: + used_tags.add(current_tag) + if current_tag.name: + current_tag_name = current_tag.name + current_tag_date = current_tag.date + + commit_tag: GitTag | None = None + changes: dict = defaultdict(list) + for commit in commits: + if ( + (commit_tag := get_commit_tag(commit, tags)) + and commit_tag not in used_tags + and rules.include_in_changelog(commit_tag) + ): + used_tags.add(commit_tag) + release = { + "version": current_tag_name, + "date": current_tag_date, + "changes": changes, + } + if changelog_release_hook: + release = changelog_release_hook(release, commit_tag) + yield release + current_tag_name = commit_tag.name + current_tag_date = commit_tag.date + changes = defaultdict(list) + + if not pat.match(commit.message): + continue + + # Process subject and body from commit message + for message in chain( + [map_pat.match(commit.message)], + (body_map_pat.match(block) for block in commit.body.split("\n\n")), + ): + if message: + process_commit_message( + changelog_message_builder_hook, + message, + commit, + changes, + change_type_map, + ) + + release = { + "version": current_tag_name, + "date": current_tag_date, + "changes": changes, + } + if changelog_release_hook: + release = changelog_release_hook(release, commit_tag) + yield release + + +def process_commit_message( + hook: MessageBuilderHook | None, + parsed: re.Match[str], + commit: GitCommit, + ref_changes: MutableMapping[str | None, list], + change_type_map: Mapping[str, str] | None = None, +) -> None: + message: dict[str, Any] = { + "sha1": commit.rev, + "parents": commit.parents, + "author": commit.author, + "author_email": commit.author_email, + **parsed.groupdict(), + } + + processed_msg = hook(message, commit) if hook else message + if not processed_msg: + return + + messages = [processed_msg] if isinstance(processed_msg, dict) else processed_msg + for msg in messages: + change_type = msg.pop("change_type", None) + if change_type_map and change_type: + change_type = change_type_map.get(change_type, change_type) + ref_changes[change_type].append(msg) + + +def generate_ordered_changelog_tree( + tree: Iterable[Mapping[str, Any]], change_type_order: list[str] +) -> Generator[dict[str, Any], None, None]: + if len(set(change_type_order)) != len(change_type_order): + raise InvalidConfigurationError( + f"Change types contain duplicated types ({change_type_order})" + ) + + for entry in tree: + yield { + **entry, + "changes": _calculate_sorted_changes(change_type_order, entry["changes"]), + } + + +def _calculate_sorted_changes( + change_type_order: list[str], changes: Mapping[str, Any] +) -> OrderedDict[str, Any]: + remaining_change_types = set(changes.keys()) - set(change_type_order) + sorted_change_types = change_type_order + sorted(remaining_change_types) + return OrderedDict((ct, changes[ct]) for ct in sorted_change_types if ct in changes) + + +def get_changelog_template(loader: BaseLoader, template: str) -> Template: + loader = ChoiceLoader( + [ + FileSystemLoader("."), + loader, + ] + ) + env = Environment(loader=loader, trim_blocks=True) + return env.get_template(template) + + +def render_changelog( + tree: Iterable, + loader: BaseLoader, + template: str, + **kwargs: Any, +) -> str: + jinja_template = get_changelog_template(loader, template) + changelog: str = jinja_template.render(tree=tree, **kwargs) + return changelog + + +def incremental_build( + new_content: str, lines: list[str], metadata: Metadata +) -> list[str]: + """Takes the original lines and updates with new_content. + + The metadata governs how to remove the old unreleased section and where to place the + new content. + + Args: + lines: The lines from the changelog + new_content: This should be placed somewhere in the lines + metadata: Information about the changelog + + Returns: + Updated lines + """ + unreleased_start = metadata.unreleased_start + unreleased_end = metadata.unreleased_end + latest_version_position = metadata.latest_version_position + + skip = False + output_lines: list[str] = [] + for index, line in enumerate(lines): + if index == unreleased_start: + skip = True + elif index == unreleased_end: + skip = False + if ( + latest_version_position is None + or latest_version_position > unreleased_end + ): + continue + + if skip: + continue + + if index == latest_version_position: + output_lines.extend([new_content, "\n"]) + output_lines.append(line) + + if latest_version_position is not None: + return output_lines + + if output_lines and output_lines[-1].strip(): + # Ensure at least one blank line between existing and new content. + output_lines.append("\n") + output_lines.append(new_content) + return output_lines + + +def get_next_tag_name_after_version(tags: Iterable[GitTag], version: str) -> str | None: + it = iter(tag.name for tag in tags) + for name in it: + if name == version: + return next(it, None) + + raise NoCommitsFoundError(f"Could not find a valid revision range. {version=}") + + +@deprecated( + reason="This function is unused and will be removed in v5", + version="5.0.0", + category=DeprecationWarning, +) +def get_smart_tag_range( + tags: Sequence[GitTag], newest: str, oldest: str | None = None +) -> list[GitTag]: + """Smart because it finds the N+1 tag. + + This is because we need to find until the next tag + """ + accumulator = [] + keep = False + if not oldest: + oldest = newest + for index, tag in enumerate(tags): + if tag.name == newest: + keep = True + if keep: + accumulator.append(tag) + if tag.name == oldest: + keep = False + try: + accumulator.append(tags[index + 1]) + except IndexError: + pass + break + return accumulator + + +def get_oldest_and_newest_rev( + tags: Iterable[GitTag], + version: str, + rules: TagRules, +) -> tuple[str | None, str]: + """Find the tags for the given version. + + `version` may come in different formats: + - `0.1.0..0.4.0`: as a range + - `0.3.0`: as a single version + """ + oldest_version, sep, newest_version = version.partition("..") + if not sep: + newest_version = version + oldest_version = "" + + def get_tag_name(v: str) -> str: + if tag := rules.find_tag_for(tags, v): + return tag.name + raise NoCommitsFoundError("Could not find a valid revision range.") + + newest_tag_name = get_tag_name(newest_version) + oldest_tag_name = get_tag_name(oldest_version) if oldest_version else None + + oldest_rev = get_next_tag_name_after_version( + tags, oldest_tag_name or newest_tag_name + ) + + # Return None for oldest_rev if: + # 1. The oldest tag is the last tag in the list and matches the requested oldest tag + # 2. The oldest and the newest tag are the same + if oldest_rev == newest_tag_name: + return None, newest_tag_name + return oldest_rev, newest_tag_name diff --git a/commitizen/changelog_formats/__init__.py b/commitizen/changelog_formats/__init__.py new file mode 100644 index 0000000000..26e697cadd --- /dev/null +++ b/commitizen/changelog_formats/__init__.py @@ -0,0 +1,110 @@ +from __future__ import annotations + +import warnings +from importlib import metadata +from typing import TYPE_CHECKING, ClassVar, Protocol + +from commitizen.exceptions import ChangelogFormatUnknown + +if TYPE_CHECKING: + from collections.abc import Callable + + from commitizen.changelog import IncrementalMergeInfo, Metadata + from commitizen.config.base_config import BaseConfig + +CHANGELOG_FORMAT_ENTRYPOINT = "commitizen.changelog_format" +TEMPLATE_EXTENSION = "j2" + + +class ChangelogFormat(Protocol): + extension: ClassVar[str] + """Standard known extension associated with this format""" + + alternative_extensions: ClassVar[set[str]] + """Known alternatives extensions for this format""" + + config: BaseConfig + + def __init__(self, config: BaseConfig) -> None: + self.config = config + + @property + def ext(self) -> str: + """Dotted version of extensions, as in `pathlib` and `os` modules""" + return f".{self.extension}" + + @property + def template(self) -> str: + """Expected template name for this format""" + return f"CHANGELOG.{self.extension}.{TEMPLATE_EXTENSION}" + + @property + def default_changelog_file(self) -> str: + return f"CHANGELOG.{self.extension}" + + def get_metadata(self, filepath: str) -> Metadata: + """ + Extract the changelog metadata. + """ + raise NotImplementedError + + def get_latest_full_release(self, filepath: str) -> IncrementalMergeInfo: + """ + Extract metadata for the last non-pre-release. + """ + raise NotImplementedError + + +KNOWN_CHANGELOG_FORMATS: dict[str, type[ChangelogFormat]] = { + ep.name: ep.load() + for ep in metadata.entry_points(group=CHANGELOG_FORMAT_ENTRYPOINT) +} + + +def get_changelog_format( + config: BaseConfig, filename: str | None = None +) -> ChangelogFormat: + """ + Get a format from its name + + :raises FormatUnknown: if a non-empty name is provided but cannot be found in the known formats + """ + name: str | None = config.settings.get("changelog_format") + format = ( + name and KNOWN_CHANGELOG_FORMATS.get(name) or _guess_changelog_format(filename) + ) + + if not format: + raise ChangelogFormatUnknown(f"Unknown changelog format '{name}'") + + return format(config) + + +def _guess_changelog_format(filename: str | None) -> type[ChangelogFormat] | None: + """ + Try guessing the file format from the filename. + + Algorithm is basic, extension-based, and won't work + for extension-less file names like `CHANGELOG` or `NEWS`. + """ + if not filename or not isinstance(filename, str): + return None + for format in KNOWN_CHANGELOG_FORMATS.values(): + if filename.endswith(f".{format.extension}"): + return format + for alt_extension in format.alternative_extensions: + if filename.endswith(f".{alt_extension}"): + return format + return None + + +def __getattr__(name: str) -> Callable[[str], type[ChangelogFormat] | None]: + if name == "guess_changelog_format": + warnings.warn( + "guess_changelog_format is deprecated and will be removed in v5. " + "Use _guess_changelog_format instead.", + DeprecationWarning, + stacklevel=2, + ) + return _guess_changelog_format + raise AttributeError(f"module {__name__} has no attribute {name}") diff --git a/commitizen/changelog_formats/asciidoc.py b/commitizen/changelog_formats/asciidoc.py new file mode 100644 index 0000000000..ed3e8607bd --- /dev/null +++ b/commitizen/changelog_formats/asciidoc.py @@ -0,0 +1,28 @@ +from __future__ import annotations + +import re +from typing import TYPE_CHECKING + +from .base import BaseFormat + +if TYPE_CHECKING: + from commitizen.tags import VersionTag + + +class AsciiDoc(BaseFormat): + extension = "adoc" + + RE_TITLE = re.compile(r"^(?P=+) (?P.*)$") + + def parse_version_from_title(self, line: str) -> VersionTag | None: + m = self.RE_TITLE.match(line) + if not m: + return None + # Capture last match as AsciiDoc use postfixed URL labels + return self.tag_rules.search_version(m.group("title"), last=True) + + def parse_title_level(self, line: str) -> int | None: + m = self.RE_TITLE.match(line) + if not m: + return None + return len(m.group("level")) diff --git a/commitizen/changelog_formats/base.py b/commitizen/changelog_formats/base.py new file mode 100644 index 0000000000..dcddb5d7e0 --- /dev/null +++ b/commitizen/changelog_formats/base.py @@ -0,0 +1,113 @@ +from __future__ import annotations + +from abc import ABCMeta +from pathlib import Path +from typing import IO, TYPE_CHECKING, Any, ClassVar + +from commitizen.changelog import IncrementalMergeInfo, Metadata +from commitizen.config.base_config import BaseConfig +from commitizen.git import GitTag +from commitizen.tags import TagRules, VersionTag +from commitizen.version_schemes import get_version_scheme + +from . import ChangelogFormat + +if TYPE_CHECKING: + from commitizen.config.base_config import BaseConfig + + +class BaseFormat(ChangelogFormat, metaclass=ABCMeta): + """ + Base class to extend to implement a changelog file format. + """ + + extension: ClassVar[str] = "" + alternative_extensions: ClassVar[set[str]] = set() + + def __init__(self, config: BaseConfig) -> None: + # Constructor needs to be redefined because `Protocol` prevent instantiation by default + # See: https://bugs.python.org/issue44807 + self.config = config + self.tag_rules = TagRules( + scheme=get_version_scheme(self.config.settings), + tag_format=self.config.settings["tag_format"], + legacy_tag_formats=self.config.settings["legacy_tag_formats"], + ignored_tag_formats=self.config.settings["ignored_tag_formats"], + ) + + def get_metadata(self, filepath: str) -> Metadata: + file = Path(filepath) + if not file.is_file(): + return Metadata() + + with file.open(encoding=self.config.settings["encoding"]) as changelog_file: + return self.get_metadata_from_file(changelog_file) + + def get_metadata_from_file(self, file: IO[Any]) -> Metadata: + meta = Metadata() + unreleased_level: int | None = None + for index, line in enumerate(file): + line = line.strip().lower() + + unreleased: int | None = None + if "unreleased" in line: + unreleased = self.parse_title_level(line) + # Try to find beginning and end lines of the unreleased block + if unreleased: + meta.unreleased_start = index + unreleased_level = unreleased + continue + elif unreleased_level and self.parse_title_level(line) == unreleased_level: + meta.unreleased_end = index + + # Try to find the latest release done + parsed_version = self.parse_version_from_title(line) + if parsed_version: + meta.latest_version = parsed_version.version + meta.latest_version_tag = parsed_version.tag + meta.latest_version_position = index + break # there's no need for more info + if meta.unreleased_start is not None and meta.unreleased_end is None: + meta.unreleased_end = index + + return meta + + def get_latest_full_release(self, filepath: str) -> IncrementalMergeInfo: + file = Path(filepath) + if not file.is_file(): + return IncrementalMergeInfo() + + with file.open(encoding=self.config.settings["encoding"]) as changelog_file: + return self.get_latest_full_release_from_file(changelog_file) + + def get_latest_full_release_from_file(self, file: IO[Any]) -> IncrementalMergeInfo: + latest_version_index: int | None = None + for index, line in enumerate(file): + latest_version_index = index + line = line.strip().lower() + + parsed_version = self.parse_version_from_title(line) + if ( + parsed_version + and not self.tag_rules.extract_version( + GitTag(parsed_version.tag, "", "") + ).is_prerelease + ): + return IncrementalMergeInfo(name=parsed_version.tag, index=index) + return IncrementalMergeInfo(index=latest_version_index) + + def parse_version_from_title(self, line: str) -> VersionTag | None: + """ + Extract the version from a title line if any + """ + raise NotImplementedError( + "Default `get_metadata_from_file` requires `parse_version_from_changelog` to be implemented" + ) + + def parse_title_level(self, line: str) -> int | None: + """ + Get the title level/type of a line if any + """ + raise NotImplementedError( + "Default `get_metadata_from_file` requires `parse_title_type_of_line` to be implemented" + ) diff --git a/commitizen/changelog_formats/markdown.py b/commitizen/changelog_formats/markdown.py new file mode 100644 index 0000000000..e3d30fe174 --- /dev/null +++ b/commitizen/changelog_formats/markdown.py @@ -0,0 +1,29 @@ +from __future__ import annotations + +import re +from typing import TYPE_CHECKING + +from .base import BaseFormat + +if TYPE_CHECKING: + from commitizen.tags import VersionTag + + +class Markdown(BaseFormat): + extension = "md" + + alternative_extensions = {"markdown", "mkd"} + + RE_TITLE = re.compile(r"^(?P<level>#+) (?P<title>.*)$") + + def parse_version_from_title(self, line: str) -> VersionTag | None: + m = self.RE_TITLE.match(line) + if not m: + return None + return self.tag_rules.search_version(m.group("title")) + + def parse_title_level(self, line: str) -> int | None: + m = self.RE_TITLE.match(line) + if not m: + return None + return len(m.group("level")) diff --git a/commitizen/changelog_formats/restructuredtext.py b/commitizen/changelog_formats/restructuredtext.py new file mode 100644 index 0000000000..e8ce411e80 --- /dev/null +++ b/commitizen/changelog_formats/restructuredtext.py @@ -0,0 +1,88 @@ +from __future__ import annotations + +from itertools import zip_longest +from typing import IO + +from commitizen.changelog import Metadata + +from .base import BaseFormat + + +class RestructuredText(BaseFormat): + extension = "rst" + + def get_metadata_from_file(self, file: IO[str]) -> Metadata: + """ + RestructuredText section titles are not one-line-based, + they spread on 2 or 3 lines and levels are not predefined + but determined by their occurrence order. + + It requires its own algorithm. + + For a more generic approach, you need to rely on `docutils`. + """ + out_metadata = Metadata() + unreleased_title_kind: str | tuple[str, str] | None = None + is_overlined_title = False + lines = [line.strip().lower() for line in file.readlines()] + + for index, (first, second, third) in enumerate( + zip_longest(lines, lines[1:], lines[2:], fillvalue="") + ): + title: str | None = None + kind: str | tuple[str, str] | None = None + if _is_overlined_title(first, second, third): + title = second + kind = (first[0], third[0]) + is_overlined_title = True + elif not is_overlined_title and _is_underlined_title(first, second): + title = first + kind = second[0] + else: + is_overlined_title = False + + if not title: + continue + + if "unreleased" in title: + unreleased_title_kind = kind + out_metadata.unreleased_start = index + continue + + if unreleased_title_kind and unreleased_title_kind == kind: + out_metadata.unreleased_end = index + # Try to find the latest release done + if version := self.tag_rules.search_version(title): + out_metadata.latest_version = version[0] + out_metadata.latest_version_tag = version[1] + out_metadata.latest_version_position = index + break + + if ( + out_metadata.unreleased_start is not None + and out_metadata.unreleased_end is None + ): + out_metadata.unreleased_end = ( + out_metadata.latest_version_position + if out_metadata.latest_version + else len(lines) + ) + + return out_metadata + + +def _is_overlined_title(first: str, second: str, third: str) -> bool: + return ( + len(first) == len(third) >= len(second) + and first[0] == third[0] + and all(char == first[0] for char in first) + and _is_underlined_title(second, third) + ) + + +def _is_underlined_title(first: str, second: str) -> bool: + return ( + len(second) >= len(first) + and not second.isalnum() + and all(char == second[0] for char in second) + ) diff --git a/commitizen/changelog_formats/textile.py b/commitizen/changelog_formats/textile.py new file mode 100644 index 0000000000..6693e5e002 --- /dev/null +++ b/commitizen/changelog_formats/textile.py @@ -0,0 +1,26 @@ +from __future__ import annotations + +import re +from typing import TYPE_CHECKING + +from .base import BaseFormat + +if TYPE_CHECKING: + from commitizen.tags import VersionTag + + +class Textile(BaseFormat): + extension = "textile" + + RE_TITLE = re.compile(r"^h(?P<level>\d)\. (?P<title>.*)$") + + def parse_version_from_title(self, line: str) -> VersionTag | None: + if not self.RE_TITLE.match(line): + return None + return self.tag_rules.search_version(line) + + def parse_title_level(self, line: str) -> int | None: + m = self.RE_TITLE.match(line) + if not m: + return None + return int(m.group("level")) diff --git a/commitizen/cli.py b/commitizen/cli.py index 620707c588..79988fb5cb 100644 --- a/commitizen/cli.py +++ b/commitizen/cli.py @@ -1,150 +1,693 @@ +from __future__ import annotations + import argparse import logging import sys -import warnings +from copy import deepcopy +from functools import partial +from pathlib import Path +from types import TracebackType +from typing import TYPE_CHECKING, cast +import argcomplete from decli import cli -from commitizen import commands, config, out - +from commitizen import commands, config, out, version_schemes +from commitizen.defaults import DEFAULT_SETTINGS +from commitizen.exceptions import ( + CommitizenException, + ExitCode, + ExpectedExit, + InvalidCommandArgumentError, + NoCommandFoundError, +) logger = logging.getLogger(__name__) + + +class ParseKwargs(argparse.Action): + """ + Parse arguments in the for `key=value`. + + Quoted strings are automatically unquoted. + Can be submitted multiple times: + + ex: + -k key=value -k double-quotes="value" -k single-quotes='value' + + will result in + + namespace["opt"] == { + "key": "value", + "double-quotes": "value", + "single-quotes": "value", + } + """ + + def __call__( + self, + parser: argparse.ArgumentParser, + namespace: argparse.Namespace, + values: object, + option_string: str | None = None, + ) -> None: + if not isinstance(values, str): + return + + key, sep, value = values.partition("=") + if not key or not sep: + raise InvalidCommandArgumentError( + f"Option {option_string} expect a key=value format" + ) + kwargs = getattr(namespace, self.dest, None) or {} + kwargs[key] = value.strip("'\"") + setattr(namespace, self.dest, kwargs) + + +tpl_arguments = ( + { + "name": ["--template", "-t"], + "help": ( + "Changelog template file name (relative to the current working directory)." + ), + }, + { + "name": ["--extra", "-e"], + "action": ParseKwargs, + "dest": "extras", + "metavar": "EXTRA", + "help": "Changelog extra variables (in the form 'key=value').", + }, +) + data = { "prog": "cz", "description": ( - "Commitizen is a cli tool to generate conventional commits.\n" - "For more information about the topic go to " - "https://conventionalcommits.org/" + "Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management.\n" + "For more information, please visit https://commitizen-tools.github.io/commitizen" ), "formatter_class": argparse.RawDescriptionHelpFormatter, "arguments": [ - {"name": "--debug", "action": "store_true", "help": "use debug mode"}, - {"name": ["-n", "--name"], "help": "use the given commitizen"}, { - "name": ["--version"], - "action": "store_true", - "help": "get the version of the installed commitizen", + "name": "--config", + "help": "The path to the configuration file.", + }, + {"name": "--debug", "action": "store_true", "help": "Use debug mode."}, + { + "name": ["-n", "--name"], + "help": "Use the given commitizen (default: cz_conventional_commits).", + }, + { + "name": ["-nr", "--no-raise"], + "type": str, + "required": False, + "help": "Comma-separated error codes that won't raise error, e.g., cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/", }, ], "subcommands": { "title": "commands", - # TODO: Add this constraint back in 2.0 - # "required": True, + "required": True, "commands": [ { - "name": "ls", - "help": "show available commitizens", - "func": commands.ListCz, + "name": ["init"], + "description": "Initialize commitizen configuration", + "help": "Initialize commitizen configuration.", + "func": commands.Init, }, { "name": ["commit", "c"], - "help": "create new commit", + "description": "Create new commit", + "help": "Create new commit.", "func": commands.Commit, "arguments": [ { "name": ["--retry"], "action": "store_true", - "help": "retry last commit", - } + "help": "Retry the last commit.", + }, + { + "name": ["--no-retry"], + "action": "store_true", + "default": False, + "help": "Skip retry if --retry or `retry_after_failure` is set to true.", + }, + { + "name": "--dry-run", + "action": "store_true", + "help": "Perform a dry run, without committing or modifying files.", + }, + { + "name": "--write-message-to-file", + "type": Path, + "metavar": "FILE_PATH", + "help": "Write message to FILE_PATH before committing (can be used with --dry-run).", + }, + { + "name": ["-s", "--signoff"], + "action": "store_true", + "help": "Deprecated, use `cz commit -- -s` instead.", + }, + { + "name": ["-a", "--all"], + "action": "store_true", + # The help text aligns with the description of git commit --all + "help": "Automatically stage files that have been modified and deleted, but new files you have not told Git about are not affected.", + }, + { + "name": ["-e", "--edit"], + "action": "store_true", + "default": False, + "help": "Edit the commit message before committing.", + }, + { + "name": ["-l", "--message-length-limit"], + "type": int, + "help": "Set the length limit of the commit message; 0 for no limit.", + }, + { + "name": ["--"], + "action": "store_true", + "dest": "double_dash", + "help": "Positional arguments separator (recommended).", + }, ], }, + { + "name": "ls", + "description": "Show available Commitizens", + "help": "Show available Commitizens.", + "func": commands.ListCz, + }, { "name": "example", - "help": "show commit example", + "description": "Show commit example", + "help": "Show commit example.", "func": commands.Example, }, { "name": "info", - "help": "show information about the cz", + "description": "Show information about the cz", + "help": "Show information about the cz.", "func": commands.Info, }, - {"name": "schema", "help": "show commit schema", "func": commands.Schema}, + { + "name": "schema", + "description": "Show commit schema", + "help": "Show commit schema.", + "func": commands.Schema, + }, { "name": "bump", - "help": "bump semantic version based on the git log", + "description": "Bump semantic version based on the git log", + "help": "Bump semantic version based on the git log.", "func": commands.Bump, "arguments": [ { "name": "--dry-run", "action": "store_true", - "help": "show output to stdout, no commit, no modified files", + "help": "Perform a dry run, without committing or modifying files.", + }, + { + "name": "--files-only", # TODO: rename to --version-files-only + "action": "store_true", + "help": "Bump version in the `version_files` specified in the configuration file only(deprecated; use --version-files-only instead).", + }, + { + "name": "--version-files-only", + "action": "store_true", + "help": "Bump version in the files from the config", + }, + { + "name": "--local-version", + "action": "store_true", + "help": "Bump version only the local version portion (ignoring the public version).", + }, + { + "name": ["--changelog", "-ch"], + "action": "store_true", + "default": False, + "help": "Generate the changelog for the latest version.", + }, + { + "name": ["--no-verify"], + "action": "store_true", + "default": False, + # The help text aligns with the description of git commit --no-verify + "help": "Bypass the pre-commit and commit-msg hooks.", }, { "name": "--yes", "action": "store_true", - "help": "accept automatically questions done", + "help": "Accept automatically answered questions.", }, { "name": "--tag-format", "help": ( - "format used to tag the commmit and read it, " - "use it in existing projects, " - "wrap around simple quotes" + "The format used to tag the commit and read it. " + "Use it in existing projects, and wrap around simple quotes." ), }, { "name": "--bump-message", "help": ( - "template used to create the release commmit, " - "useful when working with CI" + "Template used to create the release commit, useful when working with CI." ), }, { "name": ["--prerelease", "-pr"], - "help": "choose type of prerelease", + "help": "Type of prerelease.", "choices": ["alpha", "beta", "rc"], }, + { + "name": ["--devrelease", "-d"], + "help": "Specify non-negative integer for dev release.", + "type": int, + }, { "name": ["--increment"], - "help": "manually specify the desired increment", + "help": "Specify the desired increment.", "choices": ["MAJOR", "MINOR", "PATCH"], + "type": str.upper, + }, + { + "name": ["--increment-mode"], + "choices": ["linear", "exact"], + "default": "linear", + "help": ( + "Set the method by which the new version is chosen. " + "'linear' (default) resolves the next version based on typical linear version progression, " + "where bumping of a pre-release with lower precedence than the current pre-release " + "phase maintains the current phase of higher precedence. " + "'exact' applies the changes that have been specified (or determined from the commit log) " + "without interpretation, ensuring the increment and pre-release are always honored." + ), + }, + { + "name": ["--check-consistency", "-cc"], + "help": ( + "Check consistency among versions defined in Commitizen configuration file and `version_files`." + ), + "action": "store_true", + }, + { + "name": ["--annotated-tag", "-at"], + "help": "Create annotated tag instead of lightweight one.", + "action": "store_true", + }, + { + "name": ["--annotated-tag-message", "-atm"], + "help": "Create annotated tag message.", + "type": str, + }, + { + "name": ["--gpg-sign", "-s"], + "help": "Sign tag instead of lightweight one.", + "default": False, + "action": "store_true", + }, + { + "name": ["--changelog-to-stdout"], + "action": "store_true", + "default": False, + "help": "Output changelog to stdout.", + }, + { + "name": ["--git-output-to-stderr"], + "action": "store_true", + "default": False, + "help": "Redirect git output to stderr.", + }, + { + "name": ["--retry"], + "action": "store_true", + "default": False, + "help": "Retry commit if it fails for the first time.", + }, + { + "name": ["--major-version-zero"], + "action": "store_true", + "default": None, + "help": "Keep major version at zero, even for breaking changes.", + }, + *deepcopy(tpl_arguments), + { + "name": "--file-name", + "help": "File name of changelog (default: 'CHANGELOG.md').", + }, + { + "name": ["--prerelease-offset"], + "type": int, + "default": None, + "help": "Start pre-releases with this offset.", + }, + { + "name": ["--version-scheme"], + "help": "Choose version scheme.", + "default": None, + "choices": version_schemes.KNOWN_SCHEMES, + }, + { + "name": ["--version-type"], + "help": "Deprecated, use `--version-scheme` instead.", + "default": None, + "choices": version_schemes.KNOWN_SCHEMES, + }, + { + "name": "manual_version", + "type": str, + "nargs": "?", + "help": "Bump to the given version (e.g., 1.5.3).", + "metavar": "MANUAL_VERSION", + }, + { + "name": ["--build-metadata"], + "help": "Add additional build-metadata to the version-number.", + "default": None, + }, + { + "name": ["--get-next"], + "action": "store_true", + "help": "Determine the next version and write to stdout.", + "default": False, + }, + { + "name": ["--allow-no-commit"], + "default": False, + "help": "Bump version without eligible commits.", + "action": "store_true", + }, + ], + }, + { + "name": ["changelog", "ch"], + "description": ( + "Generate changelog (note that it will overwrite existing files)" + ), + "help": ( + "Generate changelog (note that it will overwrite existing files)." + ), + "func": commands.Changelog, + "arguments": [ + { + "name": "--dry-run", + "action": "store_true", + "default": False, + "help": "Show changelog to stdout.", + }, + { + "name": "--file-name", + "help": "File name of changelog (default: 'CHANGELOG.md').", + }, + { + "name": "--unreleased-version", + "help": ( + "Set the value for the new version (use the tag value), " + "instead of using unreleased versions." + ), + }, + { + "name": "--incremental", + "action": "store_true", + "default": False, + "help": ( + "Generate changelog from the last created version, " + "useful if the changelog has been manually modified." + ), + }, + { + "name": "rev_range", + "type": str, + "nargs": "?", + "help": "Generate changelog for the given version (e.g., 1.5.3) or version range (e.g., 1.5.3..1.7.9).", + }, + { + "name": "--start-rev", + "default": None, + "help": ( + "Start rev of the changelog. " + "If not set, it will generate changelog from the beginning." + ), + }, + { + "name": "--merge-prerelease", + "action": "store_true", + "default": False, + "help": ( + "Collect all changes from prereleases into the next non-prerelease. " + "If not set, it will include prereleases in the changelog." + ), + }, + { + "name": ["--version-scheme"], + "help": "Choose version scheme.", + "default": None, + "choices": version_schemes.KNOWN_SCHEMES, + }, + { + "name": "--export-template", + "default": None, + "help": "Export the changelog template into this file instead of rendering it.", + }, + *deepcopy(tpl_arguments), + { + "name": "--tag-format", + "help": "The format of the tag, wrap around simple quotes.", + }, + ], + }, + { + "name": ["check"], + "description": "Validate that a commit message matches the commitizen schema", + "help": "Validate that a commit message matches the commitizen schema.", + "func": commands.Check, + "arguments": [ + { + "name": "--commit-msg-file", + "help": ( + "Ask for the name of the temporary file that contains the commit message. " + "Use it in a git hook script: MSG_FILE=$1." + ), + "exclusive_group": "group1", + }, + { + "name": "--rev-range", + "help": "Validate the commits in the given range of git rev, e.g., master..HEAD.", + "exclusive_group": "group1", + }, + { + "name": ["-d", "--use-default-range"], + "action": "store_true", + "default": False, + "help": "Validate the commits from the default branch to HEAD, e.g., refs/remotes/origin/master..HEAD.", + "exclusive_group": "group1", + }, + { + "name": ["-m", "--message"], + "help": "Validate the given commit message.", + "exclusive_group": "group1", + }, + { + "name": ["--allow-abort"], + "action": "store_true", + "default": False, + "help": "Allow empty commit messages, which typically abort a commit.", + }, + { + "name": ["--allowed-prefixes"], + "nargs": "*", + "help": "Skip validation for commit messages that start with the specified prefixes.", + }, + { + "name": ["-l", "--message-length-limit"], + "type": int, + "help": "Restrict the length of the **first line** of the commit message; 0 for no limit.", }, ], }, { "name": ["version"], - "help": "get the version of the installed commitizen", + "description": ( + "Get the version of the installed commitizen or the current project (default: installed commitizen)" + ), + "help": ( + "Get the version of the installed commitizen or the current project (default: installed commitizen)." + ), "func": commands.Version, + "arguments": [ + { + "name": ["-r", "--report"], + "help": "Output the system information for reporting bugs.", + "action": "store_true", + "exclusive_group": "group1", + }, + { + "name": ["-p", "--project"], + "help": "Output the version of the current project.", + "action": "store_true", + "exclusive_group": "group1", + }, + { + "name": ["-c", "--commitizen"], + "help": "Output the version of the installed commitizen.", + "action": "store_true", + "exclusive_group": "group1", + }, + { + "name": ["-v", "--verbose"], + "help": ( + "Output the version of both the installed commitizen and the current project." + ), + "action": "store_true", + "exclusive_group": "group1", + }, + { + "name": ["--major"], + "help": "Output just the major version. Must be used with --project or --verbose.", + "action": "store_true", + "exclusive_group": "group2", + }, + { + "name": ["--minor"], + "help": "Output just the minor version. Must be used with --project or --verbose.", + "action": "store_true", + "exclusive_group": "group2", + }, + { + "name": ["--tag"], + "help": "get the version with tag prefix. Need to be used with --project or --verbose.", + "action": "store_true", + "exclusive_group": "group2", + }, + ], }, ], }, } -def main(): - conf = config.read_cfg() - parser = cli(data) +def commitizen_excepthook( + exctype: type[BaseException], + value: BaseException, + traceback: TracebackType | None, + debug: bool = False, + no_raise: list[int] | None = None, +) -> None: + traceback = traceback if isinstance(traceback, TracebackType) else None + if not isinstance(value, CommitizenException): + sys.__excepthook__(exctype, value, traceback) + return + + if value.message: + value.output_method(value.message) + if debug: + sys.__excepthook__(exctype, value, traceback) + exit_code = value.exit_code + if no_raise is not None and exit_code in no_raise: + sys.exit(ExitCode.EXPECTED_EXIT) + sys.exit(exit_code) + + +def parse_no_raise(comma_separated_no_raise: str) -> list[int]: + """Convert the given string to exit codes. + + Receives digits and strings and outputs the parsed integer which + represents the exit code found in exceptions. + """ + def exit_code_from_str_or_skip(s: str) -> ExitCode | None: + try: + return ExitCode.from_str(s) + except (KeyError, ValueError): + out.warn(f"WARN: no_raise value `{s}` is not a valid exit code. Skipping.") + return None + + return [ + code.value + for s in comma_separated_no_raise.split(",") + if (code := exit_code_from_str_or_skip(s)) is not None + ] + + +if TYPE_CHECKING: + + class Args(argparse.Namespace): + config: str | None = None + debug: bool = False + name: str | None = None + no_raise: str | None = None # comma-separated string, later parsed as list[int] + report: bool = False + project: bool = False + commitizen: bool = False + verbose: bool = False + func: type[ + commands.Init # init + | commands.Commit # commit (c) + | commands.ListCz # ls + | commands.Example # example + | commands.Info # info + | commands.Schema # schema + | commands.Bump # bump + | commands.Changelog # changelog (ch) + | commands.Check # check + | commands.Version # version + ] + + +def main() -> None: + sys.excepthook = commitizen_excepthook + + parser: argparse.ArgumentParser = cli(data) + argcomplete.autocomplete(parser) # Show help if no arg provided if len(sys.argv) == 1: parser.print_help(sys.stderr) - raise SystemExit() + raise ExpectedExit() + # This is for the command required constraint in 2.0 try: - args = parser.parse_args() - except TypeError: - out.error("Command is required") - raise SystemExit() + args, unknown_args = parser.parse_known_args() + except SystemExit as e: + if e.code == 2: + raise NoCommandFoundError() + raise e + arguments = vars(args) + if unknown_args: + # Raise error for extra-args without -- separation + if "--" not in unknown_args: + raise InvalidCommandArgumentError( + f"Invalid commitizen arguments were found: `{' '.join(unknown_args)}`. " + "Please use -- separator for extra git args" + ) + # Raise error for extra-args before -- + elif unknown_args[0] != "--": + pos = unknown_args.index("--") + raise InvalidCommandArgumentError( + f"Invalid commitizen arguments were found before -- separator: `{' '.join(unknown_args[:pos])}`. " + ) + # Log warning for -- without any extra args + elif len(unknown_args) == 1: + logger.warning( + "\nWARN: Incomplete commit command: received -- separator without any following git arguments\n" + ) + extra_args = " ".join(unknown_args[1:]) + arguments["extra_cli_args"] = extra_args + + conf = config.read_cfg(args.config) + args = cast("Args", args) if args.name: conf.update({"name": args.name}) - - if args.version: - warnings.warn( - "'cz --version' will be deprecated in next major version. " - "Please use 'cz version' command from your scripts" - ) - logging.getLogger("commitizen").setLevel(logging.DEBUG) + elif not conf.path: + conf.update({"name": DEFAULT_SETTINGS["name"]}) if args.debug: - warnings.warn( - "Debug will be deprecated in next major version. " - "Please remove it from your scripts" - ) logging.getLogger("commitizen").setLevel(logging.DEBUG) + sys.excepthook = partial(sys.excepthook, debug=True) + if args.no_raise: + sys.excepthook = partial(sys.excepthook, no_raise=parse_no_raise(args.no_raise)) - # TODO: This try block can be removed after command is required in 2.0 - try: - args.func(conf, vars(args))() - except AttributeError: - out.error("Command is required") + args.func(conf, arguments)() # type: ignore[arg-type] + + +if __name__ == "__main__": + main() diff --git a/commitizen/cmd.py b/commitizen/cmd.py index 17c81ed7af..fe70da9c9b 100644 --- a/commitizen/cmd.py +++ b/commitizen/cmd.py @@ -1,5 +1,15 @@ +from __future__ import annotations + +import os import subprocess -from typing import NamedTuple +from typing import TYPE_CHECKING, NamedTuple + +from charset_normalizer import from_bytes + +from commitizen.exceptions import CharacterSetDecodeError + +if TYPE_CHECKING: + from collections.abc import Mapping class Command(NamedTuple): @@ -7,12 +17,41 @@ class Command(NamedTuple): err: str stdout: bytes stderr: bytes + return_code: int -def run(cmd: str) -> Command: - cmd.split() +def _try_decode(bytes_: bytes) -> str: + try: + return bytes_.decode("utf-8") + except UnicodeDecodeError: + pass + + charset_match = from_bytes(bytes_).best() + if charset_match is None: + raise CharacterSetDecodeError() + try: + return bytes_.decode(charset_match.encoding) + except UnicodeDecodeError as e: + raise CharacterSetDecodeError() from e + + +def run(cmd: str, env: Mapping[str, str] | None = None) -> Command: + if env is not None: + env = {**os.environ, **env} process = subprocess.Popen( - cmd.split(), stdout=subprocess.PIPE, stderr=subprocess.PIPE + cmd, + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + stdin=subprocess.PIPE, + env=env, ) stdout, stderr = process.communicate() - return Command(stdout.decode(), stderr.decode(), stdout, stderr) + return_code = process.returncode + return Command( + _try_decode(stdout), + _try_decode(stderr), + stdout, + stderr, + return_code, + ) diff --git a/commitizen/commands/__init__.py b/commitizen/commands/__init__.py index 644356a759..58b18297dc 100644 --- a/commitizen/commands/__init__.py +++ b/commitizen/commands/__init__.py @@ -1,9 +1,23 @@ from .bump import Bump +from .changelog import Changelog +from .check import Check from .commit import Commit from .example import Example from .info import Info +from .init import Init from .list_cz import ListCz from .schema import Schema from .version import Version -__all__ = ("Bump", "Commit", "Example", "Info", "ListCz", "Schema", "Version") +__all__ = ( + "Bump", + "Changelog", + "Check", + "Commit", + "Example", + "Info", + "Init", + "ListCz", + "Schema", + "Version", +) diff --git a/commitizen/commands/bump.py b/commitizen/commands/bump.py index 5b30caf4ff..6084c8c151 100644 --- a/commitizen/commands/bump.py +++ b/commitizen/commands/bump.py @@ -1,131 +1,442 @@ -from typing import Optional +from __future__ import annotations + +import warnings +from logging import getLogger +from typing import TYPE_CHECKING, cast import questionary -from packaging.version import Version -from commitizen import bump, config, factory, git, out +from commitizen import bump, factory, git, hooks, out +from commitizen.changelog_formats import get_changelog_format +from commitizen.commands.changelog import Changelog +from commitizen.defaults import Settings +from commitizen.exceptions import ( + BumpCommitFailedError, + BumpTagFailedError, + DryRunExit, + ExpectedExit, + InvalidManualVersion, + NoCommitsFoundError, + NoneIncrementExit, + NoPatternMapError, + NotAGitProjectError, + NotAllowed, +) +from commitizen.providers import get_provider +from commitizen.tags import TagRules +from commitizen.version_schemes import ( + Increment, + InvalidVersion, + Prerelease, + VersionProtocol, + get_version_scheme, +) + +if TYPE_CHECKING: + from commitizen.config import BaseConfig + +logger = getLogger("commitizen") -NO_COMMITS_FOUND = 3 -NO_VERSION_SPECIFIED = 4 -NO_PATTERN_MAP = 7 -COMMIT_FAILED = 8 -TAG_FAILED = 9 + +class BumpArgs(Settings, total=False): + allow_no_commit: bool | None + annotated_tag_message: str | None + build_metadata: str | None + changelog_to_stdout: bool + changelog: bool + check_consistency: bool + devrelease: int | None + dry_run: bool + file_name: str + files_only: bool | None + version_files_only: bool | None + get_next: bool # TODO: maybe rename to `next_version_to_stdout` + git_output_to_stderr: bool + increment_mode: str + increment: Increment | None + local_version: bool + manual_version: str | None + no_verify: bool + prerelease: Prerelease | None + retry: bool + yes: bool class Bump: """Show prompt for the user to create a guided commit.""" - def __init__(self, config: dict, arguments: dict): - self.config: dict = config - self.arguments: dict = arguments - self.parameters: dict = { - **config, - **{ - key: arguments[key] - for key in [ - "dry_run", - "tag_format", - "prerelease", - "increment", - "bump_message", - ] - if arguments[key] is not None - }, - } - self.cz = factory.commiter_factory(self.config) + def __init__(self, config: BaseConfig, arguments: BumpArgs) -> None: + if not git.is_git_project(): + raise NotAGitProjectError() - def is_initial_tag(self, current_tag_version: str, is_yes: bool = False) -> bool: - """Check if reading the whole git tree up to HEAD is needed.""" - is_initial = False - if not git.tag_exist(current_tag_version): - if is_yes: - is_initial = True - else: - out.info(f"Tag {current_tag_version} could not be found. ") - out.info( - ( - "Possible causes:\n" - "- version in configuration is not the current version\n" - "- tag_format is missing, check them using 'git tag --list'\n" + self.config: BaseConfig = config + self.arguments = arguments + self.bump_settings = cast( + "BumpArgs", + { + **config.settings, + **{ + k: v + for k in ( + "annotated_tag_message", + "annotated_tag", + "bump_message", + "file_name", + "gpg_sign", + "increment_mode", + "increment", + "major_version_zero", + "prerelease_offset", + "prerelease", + "tag_format", + "template", ) + if (v := arguments.get(k)) is not None + }, + }, + ) + self.cz = factory.committer_factory(self.config) + self.changelog_flag = arguments["changelog"] + self.changelog_to_stdout = arguments["changelog_to_stdout"] + self.git_output_to_stderr = arguments["git_output_to_stderr"] + self.no_verify = arguments["no_verify"] + self.check_consistency = arguments["check_consistency"] + self.retry = arguments["retry"] + self.pre_bump_hooks = self.config.settings["pre_bump_hooks"] + self.post_bump_hooks = self.config.settings["post_bump_hooks"] + deprecated_version_type = arguments.get("version_type") + if deprecated_version_type: + warnings.warn( + DeprecationWarning( + "`--version-type` parameter is deprecated and will be removed in v5. " + "Please use `--version-scheme` instead" ) - is_initial = questionary.confirm("Is this the first tag created?").ask() - return is_initial + ) + self.scheme = get_version_scheme( + self.config.settings, arguments["version_scheme"] or deprecated_version_type + ) + self.file_name = arguments["file_name"] or self.config.settings.get( + "changelog_file" + ) + self.changelog_format = get_changelog_format(self.config, self.file_name) - def __call__(self): - """Steps executed to bump.""" - try: - current_version_instance: Version = Version(self.parameters["version"]) - except TypeError: - out.error("[NO_VERSION_SPECIFIED]") - out.error("Check if current version is specified in config file, like:") - out.error("version = 0.4.3") - raise SystemExit(NO_VERSION_SPECIFIED) - - # Initialize values from sources (conf) - current_version: str = self.config["version"] - tag_format: str = self.parameters["tag_format"] - bump_commit_message: str = self.parameters["bump_message"] - current_tag_version: str = bump.create_tag( - current_version, tag_format=tag_format + self.template = ( + arguments["template"] + or self.config.settings.get("template") + or self.changelog_format.template ) - files: list = self.parameters["files"] - dry_run: bool = self.parameters["dry_run"] + self.extras = arguments["extras"] + + def _is_initial_tag( + self, current_tag: git.GitTag | None, is_yes: bool = False + ) -> bool: + """Check if reading the whole git tree up to HEAD is needed.""" + if current_tag: + return False + if is_yes: + return True - is_yes: bool = self.arguments["yes"] - prerelease: str = self.arguments["prerelease"] - increment: Optional[str] = self.arguments["increment"] + out.info("No tag matching configuration could be found.") + out.info( + "Possible causes:\n" + "- version in configuration is not the current version\n" + "- tag_format or legacy_tag_formats is missing, check them using 'git tag --list'\n" + ) + return bool(questionary.confirm("Is this the first tag created?").ask()) - is_initial = self.is_initial_tag(current_tag_version, is_yes) - commits = git.get_commits(current_tag_version, from_beginning=is_initial) + def _find_increment(self, commits: list[git.GitCommit]) -> Increment | None: + # Update the bump map to ensure major version doesn't increment. + # self.cz.bump_map = defaults.bump_map_major_version_zero + bump_map = ( + self.cz.bump_map_major_version_zero + if self.bump_settings["major_version_zero"] + else self.cz.bump_map + ) + bump_pattern = self.cz.bump_pattern - # No commits, there is no need to create an empty tag. - # Unless we previously had a prerelease. - if not commits and not current_version_instance.is_prerelease: - out.error("[NO_COMMITS_FOUND]") - out.error("No new commits found.") - raise SystemExit(NO_COMMITS_FOUND) + if not bump_map or not bump_pattern: + raise NoPatternMapError( + f"'{self.config.settings['name']}' rule does not support bump" + ) + return bump.find_increment(commits, regex=bump_pattern, increments_map=bump_map) + + def _validate_arguments(self, current_version: VersionProtocol) -> None: + errors: list[str] = [] + if self.arguments["manual_version"]: + for val, option in ( + (self.arguments["increment"], "--increment"), + (self.arguments["prerelease"], "--prerelease"), + (self.arguments["devrelease"] is not None, "--devrelease"), + (self.arguments["local_version"], "--local-version"), + (self.arguments["build_metadata"], "--build-metadata"), + (self.arguments["major_version_zero"], "--major-version-zero"), + ): + if val: + errors.append(f"{option} cannot be combined with MANUAL_VERSION") + + if self.arguments["major_version_zero"] and current_version.release[0]: + errors.append( + f"--major-version-zero is meaningless for current version {current_version}" + ) + if self.arguments["build_metadata"] and self.arguments["local_version"]: + errors.append("--local-version cannot be combined with --build-metadata") + + if errors: + raise NotAllowed("\n".join(errors)) + + def _resolve_increment_and_new_version( + self, current_version: VersionProtocol, current_tag: git.GitTag | None + ) -> tuple[Increment | None, VersionProtocol]: + increment = self.arguments["increment"] + if manual_version := self.arguments["manual_version"]: + try: + return increment, self.scheme(manual_version) + except InvalidVersion as exc: + raise InvalidManualVersion( + "[INVALID_MANUAL_VERSION]\n" + f"Invalid manual version: '{manual_version}'" + ) from exc if increment is None: - bump_pattern = self.cz.bump_pattern - bump_map = self.cz.bump_map - if not bump_map or not bump_pattern: - out.error(f"'{self.config['name']}' rule does not support bump") - raise SystemExit(NO_PATTERN_MAP) - increment = bump.find_increment( - commits, regex=bump_pattern, increments_map=bump_map + commits = git.get_commits(current_tag.name if current_tag else None) + + # No commits, there is no need to create an empty tag. + # Unless we previously had a prerelease. + if ( + not commits + and not current_version.is_prerelease + and not self.arguments["allow_no_commit"] + ): + raise NoCommitsFoundError("[NO_COMMITS_FOUND]\nNo new commits found.") + + increment = self._find_increment(commits) + + # It may happen that there are commits, but they are not eligible + # for an increment, this generates a problem when using prerelease (#281) + if ( + self.arguments["prerelease"] + and increment is None + and not current_version.is_prerelease + ): + raise NoCommitsFoundError( + "[NO_COMMITS_FOUND]\n" + "No commits found to generate a pre-release.\n" + "To avoid this error, manually specify the type of increment with `--increment`" ) - # Increment is removed when current and next version - # are expected to be prereleases. - if prerelease and current_version_instance.is_prerelease: - increment = None + # we create an empty PATCH increment for empty tag + if increment is None and self.arguments["allow_no_commit"]: + increment = "PATCH" - new_version = bump.generate_version( - current_version, increment, prerelease=prerelease + return increment, current_version.bump( + increment, + prerelease=self.arguments["prerelease"], + prerelease_offset=self.bump_settings["prerelease_offset"], + devrelease=self.arguments["devrelease"], + is_local_version=self.arguments["local_version"], + build_metadata=self.arguments["build_metadata"], + exact_increment=self.arguments["increment_mode"] == "exact", ) - new_tag_version = bump.create_tag(new_version, tag_format=tag_format) - message = bump.create_commit_message( - current_version, new_version, bump_commit_message + + def __call__(self) -> None: + """Steps executed to bump.""" + provider = get_provider(self.config) + current_version = self.scheme(provider.get_version()) + self._validate_arguments(current_version) + + next_version_to_stdout = self.arguments["get_next"] + if next_version_to_stdout: + for value, option in ( + (self.changelog_flag, "--changelog"), + (self.changelog_to_stdout, "--changelog-to-stdout"), + ): + if value: + warnings.warn(f"{option} has no effect when used with --get-next") + + # If user specified changelog_to_stdout, they probably want the + # changelog to be generated as well, this is the most intuitive solution + self.changelog_flag = any( + ( + self.changelog_flag, + self.changelog_to_stdout, + self.config.settings.get("update_changelog_on_bump"), + ) + ) + + rules = TagRules.from_settings(cast("Settings", self.bump_settings)) + current_tag = rules.find_tag_for(git.get_tags(), current_version) + current_tag_version = ( + current_tag.name if current_tag else rules.normalize_tag(current_version) ) + is_initial = self._is_initial_tag(current_tag, self.arguments["yes"]) + + increment, new_version = self._resolve_increment_and_new_version( + current_version, current_tag + ) + + new_tag_version = rules.normalize_tag(new_version) + if next_version_to_stdout: + if increment is None and new_tag_version == current_tag_version: + raise NoneIncrementExit( + "[NO_COMMITS_TO_BUMP]\n" + "The commits found are not eligible to be bumped" + ) + out.write(str(new_version)) + raise DryRunExit() + + message = bump.create_commit_message( + current_version, new_version, self.bump_settings["bump_message"] + ) # Report found information - out.write(message) - out.write(f"tag to create: {new_tag_version}") - out.write(f"increment detected: {increment}") + information = f"{message}\ntag to create: {new_tag_version}\n" + if increment: + information += f"increment detected: {increment}\n" + + if self.changelog_to_stdout: + # When the changelog goes to stdout, we want to send + # the bump information to stderr, this way the + # changelog output can be captured + out.diagnostic(information) + else: + out.write(information) + + if increment is None and new_tag_version == current_tag_version: + raise NoneIncrementExit( + "[NO_COMMITS_TO_BUMP]\nThe commits found are not eligible to be bumped" + ) + + updated_files: list[str] = [] + changelog_file_name = None + dry_run = self.arguments["dry_run"] + if self.changelog_flag: + changelog_args = { + "unreleased_version": new_tag_version, + "template": self.template, + "extras": self.extras, + "incremental": True, + "dry_run": dry_run, + # governs logic for merge_prerelease + "during_version_bump": self.arguments["prerelease"] is None, + } + if self.changelog_to_stdout: + try: + Changelog( + self.config, + {**changelog_args, "dry_run": True}, # type: ignore[typeddict-item] + )() + except DryRunExit: + pass + + changelog_cmd = Changelog( + self.config, + {**changelog_args, "file_name": self.file_name}, # type: ignore[typeddict-item] + ) + changelog_cmd() + changelog_file_name = changelog_cmd.file_name + updated_files.append(changelog_file_name) # Do not perform operations over files or git. if dry_run: - raise SystemExit() - - config.set_key("version", new_version.public) - bump.update_version_in_files(current_version, new_version.public, files) - c = git.commit(message, args="-a") - if c.err: - out.error(c.err) - raise SystemExit(COMMIT_FAILED) - c = git.tag(new_tag_version) - if c.err: - out.error(c.err) - raise SystemExit(TAG_FAILED) - out.success("Done!") + raise DryRunExit() + + updated_files.extend( + bump.update_version_in_files( + str(current_version), + str(new_version), + self.bump_settings["version_files"], + check_consistency=self.check_consistency, + encoding=self.config.settings["encoding"], + ) + ) + + provider.set_version(str(new_version)) + + if self.pre_bump_hooks: + hooks.run( + self.pre_bump_hooks, + _env_prefix="CZ_PRE_", + is_initial=is_initial, + current_version=str(current_version), + current_tag_version=current_tag_version, + new_version=new_version.public, + new_tag_version=new_tag_version, + message=message, + increment=increment, + changelog_file_name=changelog_file_name, + ) + + if self.arguments.get("files_only"): + warnings.warn( + "--files-only is deprecated and will be removed in v5. Use --version-files-only instead.", + DeprecationWarning, + ) + raise ExpectedExit() + + if self.arguments.get("version_files_only"): + raise ExpectedExit() + + # FIXME: check if any changes have been staged + git.add(*updated_files) + c = git.commit(message, args=self._get_commit_args()) + if self.retry and c.return_code != 0 and self.changelog_flag: + # Maybe pre-commit reformatted some files? Retry once + logger.debug("1st git.commit error: %s", c.err) + logger.info("1st commit attempt failed; retrying once") + git.add(*updated_files) + c = git.commit(message, args=self._get_commit_args()) + if c.return_code != 0: + err = c.err.strip() or c.out + raise BumpCommitFailedError(f'2nd git.commit error: "{err}"') + + for msg in (c.out, c.err): + if msg: + out_func = out.diagnostic if self.git_output_to_stderr else out.write + out_func(msg) + + c = git.tag( + new_tag_version, + signed=any( + ( + self.bump_settings.get("gpg_sign"), + self.config.settings.get("gpg_sign"), + ) + ), + annotated=any( + ( + self.bump_settings.get("annotated_tag"), + self.config.settings.get("annotated_tag"), + self.bump_settings.get("annotated_tag_message"), + ) + ), + msg=self.bump_settings.get("annotated_tag_message", None), + # TODO: also get from self.config.settings? + ) + if c.return_code != 0: + raise BumpTagFailedError(c.err) + + if self.post_bump_hooks: + hooks.run( + self.post_bump_hooks, + _env_prefix="CZ_POST_", + was_initial=is_initial, + previous_version=str(current_version), + previous_tag_version=current_tag_version, + current_version=new_version.public, + current_tag_version=new_tag_version, + message=message, + increment=increment, + changelog_file_name=changelog_file_name, + ) + + # TODO: For v3 output this only as diagnostic and remove this if + if self.changelog_to_stdout: + out.diagnostic("Done!") + else: + out.success("Done!") + + def _get_commit_args(self) -> str: + commit_args = ["-a"] + if self.no_verify: + commit_args.append("--no-verify") + return " ".join(commit_args) diff --git a/commitizen/commands/changelog.py b/commitizen/commands/changelog.py new file mode 100644 index 0000000000..5093ed9f29 --- /dev/null +++ b/commitizen/commands/changelog.py @@ -0,0 +1,307 @@ +from __future__ import annotations + +from difflib import SequenceMatcher +from operator import itemgetter +from pathlib import Path +from typing import TYPE_CHECKING, Any, TypedDict, cast + +from commitizen import changelog, defaults, factory, git, out +from commitizen.changelog_formats import get_changelog_format +from commitizen.cz.utils import strip_local_version +from commitizen.exceptions import ( + DryRunExit, + NoCommitsFoundError, + NoPatternMapError, + NoRevisionError, + NotAGitProjectError, + NotAllowed, +) +from commitizen.git import GitTag, smart_open +from commitizen.tags import TagRules +from commitizen.version_schemes import get_version_scheme + +if TYPE_CHECKING: + from collections.abc import Generator, Iterable + + from commitizen.config import BaseConfig + + +class ChangelogArgs(TypedDict, total=False): + change_type_map: dict[str, str] + change_type_order: list[str] + current_version: str + dry_run: bool + file_name: str + incremental: bool + merge_prerelease: bool + rev_range: str + start_rev: str + tag_format: str + unreleased_version: str | None + version_scheme: str + template: str + extras: dict[str, Any] + export_template: str + during_version_bump: bool | None + + +class Changelog: + """Generate a changelog based on the commit history.""" + + def __init__(self, config: BaseConfig, arguments: ChangelogArgs) -> None: + if not git.is_git_project(): + raise NotAGitProjectError() + + self.config = config + + changelog_file_name = arguments.get("file_name") or self.config.settings.get( + "changelog_file" + ) + if not isinstance(changelog_file_name, str): + raise NotAllowed( + "Changelog file name is broken.\n" + "Check the flag `--file-name` in the terminal " + f"or the setting `changelog_file` in {self.config.path}" + ) + self.file_name = ( + Path(self.config.path.parent, changelog_file_name).as_posix() + if self.config.path is not None + else changelog_file_name + ) + + self.cz = factory.committer_factory(self.config) + + self.start_rev = arguments.get("start_rev") or self.config.settings.get( + "changelog_start_rev" + ) + + self.changelog_format = get_changelog_format(self.config, self.file_name) + + self.incremental = bool( + arguments.get("incremental") + or self.config.settings.get("changelog_incremental") + ) + self.dry_run = bool(arguments.get("dry_run")) + + self.scheme = get_version_scheme( + self.config.settings, arguments.get("version_scheme") + ) + + current_version = ( + arguments.get("current_version") + or self.config.settings.get("version") + or "" + ) + self.current_version = self.scheme(current_version) if current_version else None + + self.unreleased_version = arguments["unreleased_version"] + self.change_type_map = ( + self.config.settings.get("change_type_map") or self.cz.change_type_map + ) + self.change_type_order = cast( + "list[str]", + self.config.settings.get("change_type_order") + or self.cz.change_type_order + or defaults.CHANGE_TYPE_ORDER, + ) + self.rev_range = arguments.get("rev_range") + self.tag_rules = TagRules( + scheme=self.scheme, + tag_format=arguments.get("tag_format") + or self.config.settings["tag_format"], + legacy_tag_formats=self.config.settings["legacy_tag_formats"], + ignored_tag_formats=self.config.settings["ignored_tag_formats"], + merge_prereleases=arguments.get("merge_prerelease") + or self.config.settings["changelog_merge_prerelease"], + ) + + self.template = ( + arguments.get("template") + or self.config.settings.get("template") + or self.changelog_format.template + ) + self.extras = arguments.get("extras") or {} + self.export_template_to = arguments.get("export_template") + + self.during_version_bump: bool = arguments.get("during_version_bump") or False + + def _find_incremental_rev(self, latest_version: str, tags: Iterable[GitTag]) -> str: + """Try to find the 'start_rev'. + + We use a similarity approach. We know how to parse the version from the markdown + changelog, but not the whole tag, we don't even know how's the tag made. + + This 'smart' function tries to find a similarity between the found version number + and the available tag. + + The SIMILARITY_THRESHOLD is an empirical value, it may have to be adjusted based + on our experience. + """ + SIMILARITY_THRESHOLD = 0.89 + scores_and_tag_names: Generator[tuple[float, str]] = ( + ( + score, + tag.name, + ) + for tag in tags + if ( + score := SequenceMatcher( + None, latest_version, strip_local_version(tag.name) + ).ratio() + ) + >= SIMILARITY_THRESHOLD + ) + try: + _, start_rev = max(scores_and_tag_names, key=itemgetter(0)) + except ValueError: + raise NoRevisionError() + return start_rev + + def _write_changelog( + self, changelog_out: str, lines: list[str], changelog_meta: changelog.Metadata + ) -> None: + with smart_open( + self.file_name, "w", encoding=self.config.settings["encoding"] + ) as changelog_file: + partial_changelog: str | None = None + if self.incremental: + new_lines = changelog.incremental_build( + changelog_out, lines, changelog_meta + ) + changelog_out = "".join(new_lines) + partial_changelog = changelog_out + + if self.cz.changelog_hook: + changelog_out = self.cz.changelog_hook(changelog_out, partial_changelog) + + changelog_file.write(changelog_out) + + def _export_template(self, dist: str) -> None: + filename = changelog.get_changelog_template( + self.cz.template_loader, self.template + ).filename + if filename is None: + raise NotAllowed("Template filename is not set") + + text = Path(filename).read_text() + Path(dist).write_text(text) + + def __call__(self) -> None: + commit_parser = self.cz.commit_parser + changelog_pattern = self.cz.changelog_pattern + start_rev = self.start_rev + + if self.export_template_to: + return self._export_template(self.export_template_to) + + if not changelog_pattern or not commit_parser: + raise NoPatternMapError( + f"'{self.config.settings['name']}' rule does not support changelog" + ) + + if self.incremental and self.rev_range: + raise NotAllowed("--incremental cannot be combined with a rev_range") + + # Don't continue if no `file_name` specified. + if not self.file_name: + raise NotAllowed("filename is required.") + + tags = self.tag_rules.get_version_tags(git.get_tags(), warn=True) + changelog_meta = changelog.Metadata() + if self.incremental: + changelog_meta = self.changelog_format.get_metadata(self.file_name) + if changelog_meta.latest_version: + start_rev = self._find_incremental_rev( + strip_local_version(changelog_meta.latest_version_tag or ""), tags + ) + + end_rev = "" + if self.rev_range: + start_rev, end_rev = changelog.get_oldest_and_newest_rev( + tags, + self.rev_range, + self.tag_rules, + ) + + if self.during_version_bump and self.tag_rules.merge_prereleases: + latest_full_release_info = self.changelog_format.get_latest_full_release( + self.file_name + ) + # Determine if there are prereleases to merge: + # - Only prereleases in changelog (no full release found), OR + # - First version in changelog is before first full release (prereleases exist) + if latest_full_release_info.index is not None and ( + latest_full_release_info.name is None + or ( + changelog_meta.latest_version_position is not None + and changelog_meta.latest_version_position + < latest_full_release_info.index + ) + ): + # Use the existing unreleased_start if available (from get_metadata()). + # Otherwise, use the position of the first version entry (prerelease) + # to preserve the changelog header. + if changelog_meta.unreleased_start is None: + changelog_meta.unreleased_start = ( + changelog_meta.latest_version_position + ) + changelog_meta.latest_version_position = latest_full_release_info.index + changelog_meta.unreleased_end = latest_full_release_info.index - 1 + + start_rev = latest_full_release_info.name or "" + if not start_rev: + # Only pre-releases in changelog + changelog_meta.latest_version_position = None + changelog_meta.unreleased_end = latest_full_release_info.index + 1 + + commits = git.get_commits(start=start_rev, end=end_rev, args="--topo-order") + if not commits and ( + self.current_version is None or not self.current_version.is_prerelease + ): + raise NoCommitsFoundError("No commits found") + + tree = changelog.generate_tree_from_commits( + commits, + tags, + commit_parser, + changelog_pattern, + self.unreleased_version, + change_type_map=self.change_type_map, + changelog_message_builder_hook=self.cz.changelog_message_builder_hook, + changelog_release_hook=self.cz.changelog_release_hook, + rules=self.tag_rules, + during_version_bump=self.during_version_bump, + ) + if self.change_type_order: + tree = changelog.generate_ordered_changelog_tree( + tree, self.change_type_order + ) + + changelog_out = changelog.render_changelog( + tree, + self.cz.template_loader, + self.template, + **{ + "incremental": self.incremental, # extra variable for the template + **self.cz.template_extras, + **self.config.settings["extras"], + **self.extras, + }, + ).lstrip("\n") + + # Dry_run is executed here to avoid checking and reading the files + if self.dry_run: + if self.cz.changelog_hook: + changelog_out = self.cz.changelog_hook(changelog_out, "") + out.write(changelog_out) + raise DryRunExit() + + lines = [] + changelog_path = Path(self.file_name) + if self.incremental and changelog_path.is_file(): + with changelog_path.open( + encoding=self.config.settings["encoding"] + ) as changelog_file: + lines = changelog_file.readlines() + + self._write_changelog(changelog_out, lines, changelog_meta) diff --git a/commitizen/commands/check.py b/commitizen/commands/check.py new file mode 100644 index 0000000000..ab5e671d67 --- /dev/null +++ b/commitizen/commands/check.py @@ -0,0 +1,164 @@ +from __future__ import annotations + +import re +import sys +from pathlib import Path +from typing import TYPE_CHECKING, TypedDict + +from commitizen import factory, git, out +from commitizen.exceptions import ( + InvalidCommandArgumentError, + InvalidCommitMessageError, + NoCommitsFoundError, +) + +if TYPE_CHECKING: + from commitizen.config import BaseConfig + + +class CheckArgs(TypedDict, total=False): + commit_msg_file: str + commit_msg: str + rev_range: str + allow_abort: bool + message_length_limit: int + allowed_prefixes: list[str] + message: str + use_default_range: bool + + +class Check: + """Check if the current commit msg matches the commitizen format.""" + + def __init__(self, config: BaseConfig, arguments: CheckArgs, *args: object) -> None: + """Initial check command. + + Args: + config: The config object required for the command to perform its action + arguments: All the flags provided by the user + cwd: Current work directory + """ + self.commit_msg_file = arguments.get("commit_msg_file") + self.commit_msg = arguments.get("message") + self.rev_range = arguments.get("rev_range") + self.allow_abort = bool( + arguments.get("allow_abort", config.settings["allow_abort"]) + ) + + self.use_default_range = bool(arguments.get("use_default_range")) + self.max_msg_length = arguments.get( + "message_length_limit", config.settings.get("message_length_limit", 0) + ) + + # we need to distinguish between None and [], which is a valid value + allowed_prefixes = arguments.get("allowed_prefixes") + self.allowed_prefixes: list[str] = ( + allowed_prefixes + if allowed_prefixes is not None + else config.settings["allowed_prefixes"] + ) + + num_exclusive_args_provided = sum( + arg is not None + for arg in ( + self.commit_msg_file, + self.commit_msg, + self.rev_range, + ) + ) + + if num_exclusive_args_provided > 1: + raise InvalidCommandArgumentError( + "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command! " + "See 'cz check -h' for more information" + ) + + if num_exclusive_args_provided == 0 and not sys.stdin.isatty(): + self.commit_msg = sys.stdin.read() + + self.config: BaseConfig = config + self.cz = factory.committer_factory(self.config) + + def __call__(self) -> None: + """Validate if commit messages follows the conventional pattern. + + Raises: + InvalidCommitMessageError: if the commit provided does not follow the conventional pattern + NoCommitsFoundError: if no commit is found with the given range + """ + commits = self._get_commits() + if not commits: + raise NoCommitsFoundError(f"No commit found with range: '{self.rev_range}'") + + pattern = re.compile(self.cz.schema_pattern()) + invalid_commits = [ + (commit, check.errors) + for commit in commits + if not ( + check := self.cz.validate_commit_message( + commit_msg=commit.message, + pattern=pattern, + allow_abort=self.allow_abort, + allowed_prefixes=self.allowed_prefixes, + max_msg_length=self.max_msg_length, + commit_hash=commit.rev, + ) + ).is_valid + ] + + if invalid_commits: + raise InvalidCommitMessageError( + self.cz.format_exception_message(invalid_commits) + ) + out.success("Commit validation: successful!") + + def _get_commit_message(self) -> str | None: + if self.commit_msg_file is None: + # Get commit message from command line (--message) + return self.commit_msg + + # Get commit message from file (--commit-msg-file) + return Path(self.commit_msg_file).read_text( + encoding=self.config.settings["encoding"] + ) + + def _get_commits(self) -> list[git.GitCommit]: + if (msg := self._get_commit_message()) is not None: + return [git.GitCommit(rev="", title="", body=self._filter_comments(msg))] + + # Get commit messages from git log (--rev-range) + return git.get_commits( + git.get_default_branch() if self.use_default_range else None, + self.rev_range, + ) + + @staticmethod + def _filter_comments(msg: str) -> str: + """Filter the commit message by removing comments. + + When using `git commit --verbose`, we exclude the diff that is going to + generated, like the following example: + + ```bash + ... + # ------------------------ >8 ------------------------ + # Do not modify or remove the line above. + # Everything below it will be ignored. + diff --git a/... b/... + ... + ``` + + Args: + msg: The commit message to filter. + + Returns: + The filtered commit message without comments. + """ + + lines: list[str] = [] + for line in msg.split("\n"): + if "# ------------------------ >8 ------------------------" in line: + break + if not line.startswith("#"): + lines.append(line) + return "\n".join(lines) diff --git a/commitizen/commands/commit.py b/commitizen/commands/commit.py index 8b438da4d7..6668c0d65b 100644 --- a/commitizen/commands/commit.py +++ b/commitizen/commands/commit.py @@ -1,85 +1,192 @@ +from __future__ import annotations + import contextlib import os +import shutil +import subprocess import tempfile +from pathlib import Path +from typing import TYPE_CHECKING, TypedDict import questionary from commitizen import factory, git, out from commitizen.cz.exceptions import CzException - -NO_ANSWERS = 5 -COMMIT_ERROR = 6 -NO_COMMIT_BACKUP = 7 -NOTHING_TO_COMMIT = 8 -CUSTOM_ERROR = 9 +from commitizen.cz.utils import get_backup_file_path +from commitizen.exceptions import ( + CommitError, + CommitMessageLengthExceededError, + CustomError, + DryRunExit, + NoAnswersError, + NoCommitBackupError, + NotAGitProjectError, + NotAllowed, + NothingToCommitError, +) +from commitizen.git import smart_open + +if TYPE_CHECKING: + from commitizen.config import BaseConfig + + +class CommitArgs(TypedDict, total=False): + all: bool + dry_run: bool + edit: bool + extra_cli_args: str + message_length_limit: int + no_retry: bool + signoff: bool + write_message_to_file: Path | None + retry: bool class Commit: """Show prompt for the user to create a guided commit.""" - def __init__(self, config: dict, arguments: dict): - self.config: dict = config - self.cz = factory.commiter_factory(self.config) + def __init__(self, config: BaseConfig, arguments: CommitArgs) -> None: + if not git.is_git_project(): + raise NotAGitProjectError() + + self.config: BaseConfig = config + self.cz = factory.committer_factory(self.config) self.arguments = arguments - self.temp_file: str = os.path.join(tempfile.gettempdir(), "cz.commit.backup") + self.backup_file_path = get_backup_file_path() - def read_backup_message(self) -> str: + def _read_backup_message(self) -> str | None: # Check the commit backup file exists - if not os.path.isfile(self.temp_file): - out.error("No commit backup found") - raise SystemExit(NO_COMMIT_BACKUP) + if not self.backup_file_path.is_file(): + return None # Read commit message from backup - with open(self.temp_file, "r") as f: - return f.read().strip() + return self.backup_file_path.read_text( + encoding=self.config.settings["encoding"] + ).strip() - def prompt_commit_questions(self) -> str: + def _get_message_by_prompt_commit_questions(self) -> str: # Prompt user for the commit message - cz = self.cz - questions = cz.questions() + questions = self.cz.questions() + for question in (q for q in questions if q["type"] == "list"): + question["use_shortcuts"] = self.config.settings["use_shortcuts"] try: - answers = questionary.prompt(questions, style=cz.style) + answers = questionary.prompt(questions, style=self.cz.style) except ValueError as err: root_err = err.__context__ if isinstance(root_err, CzException): - out.error(root_err.__str__()) - raise SystemExit(CUSTOM_ERROR) + raise CustomError(str(root_err)) raise err if not answers: - raise SystemExit(NO_ANSWERS) - return cz.message(answers) - - def __call__(self): - if git.is_staging_clean(): - out.write("No files added to staging!") - raise SystemExit(NOTHING_TO_COMMIT) - - retry: bool = self.arguments.get("retry") - - if retry: - m = self.read_backup_message() - else: - m = self.prompt_commit_questions() - - out.info(f"\n{m}\n") - c = git.commit(m) - - if c.err: + raise NoAnswersError() + + message = self.cz.message(answers) + self._validate_subject_length(message) + return message + + def _validate_subject_length(self, message: str) -> None: + message_length_limit = self.arguments.get( + "message_length_limit", self.config.settings.get("message_length_limit", 0) + ) + # By the contract, message_length_limit is set to 0 for no limit + if ( + message_length_limit is None or message_length_limit <= 0 + ): # do nothing for no limit + return + + subject = message.partition("\n")[0].strip() + if len(subject) > message_length_limit: + raise CommitMessageLengthExceededError( + f"Length of commit message exceeds limit ({len(subject)}/{message_length_limit}), subject: '{subject}'" + ) + + def manual_edit(self, message: str) -> str: + editor = git.get_core_editor() + if editor is None: + raise RuntimeError("No 'editor' value given and no default available.") + exec_path = shutil.which(editor) + if exec_path is None: + raise RuntimeError(f"Editor '{editor}' not found.") + with tempfile.NamedTemporaryFile(mode="w", delete=False) as file: + file.write(message) + file_path = file.name + argv = [exec_path, file_path] + subprocess.call(argv) + message = Path(file_path).read_text().strip() + os.unlink(file.name) + return message + + def _get_message(self) -> str: + if self.arguments.get("retry"): + commit_message = self._read_backup_message() + if commit_message is None: + raise NoCommitBackupError() + return commit_message + + if ( + self.config.settings.get("retry_after_failure") + and not self.arguments.get("no_retry") + and (backup_message := self._read_backup_message()) + ): + return backup_message + return self._get_message_by_prompt_commit_questions() + + def __call__(self) -> None: + extra_args = self.arguments.get("extra_cli_args", "") + dry_run = bool(self.arguments.get("dry_run")) + write_message_to_file = self.arguments.get("write_message_to_file") + signoff = bool(self.arguments.get("signoff")) + + if signoff: + out.warn( + "Deprecated warning: `cz commit -s` is deprecated and will be removed in v5, please use `cz commit -- -s` instead." + ) + + if self.arguments.get("all"): + git.add("-u") + + if git.is_staging_clean() and not (dry_run or "--allow-empty" in extra_args): + raise NothingToCommitError("No files added to staging!") + + if write_message_to_file is not None and write_message_to_file.is_dir(): + raise NotAllowed(f"{write_message_to_file} is a directory") + + commit_message = self._get_message() + if self.arguments.get("edit"): + commit_message = self.manual_edit(commit_message) + + out.info(f"\n{commit_message}\n") + + if write_message_to_file: + with smart_open( + write_message_to_file, "w", encoding=self.config.settings["encoding"] + ) as file: + file.write(commit_message) + + if dry_run: + raise DryRunExit() + + if self.config.settings["always_signoff"] or signoff: + extra_args = f"{extra_args} -s".strip() + + c = git.commit(commit_message, args=extra_args) + if c.return_code != 0: out.error(c.err) # Create commit backup - with open(self.temp_file, "w") as f: - f.write(m) + with smart_open( + self.backup_file_path, "w", encoding=self.config.settings["encoding"] + ) as f: + f.write(commit_message) - raise SystemExit(COMMIT_ERROR) + raise CommitError() - if "nothing added" in c.out or "no changes added to commit" in c.out: + if any(s in c.out for s in ("nothing added", "no changes added to commit")): out.error(c.out) - elif c.err: - out.error(c.err) - else: - with contextlib.suppress(FileNotFoundError): - os.remove(self.temp_file) - out.write(c.out) - out.success("Commit successful!") + return + + with contextlib.suppress(FileNotFoundError): + self.backup_file_path.unlink() + out.write(c.err) + out.write(c.out) + out.success("Commit successful!") diff --git a/commitizen/commands/example.py b/commitizen/commands/example.py index 66246d4f55..ba9f34adc4 100644 --- a/commitizen/commands/example.py +++ b/commitizen/commands/example.py @@ -1,12 +1,13 @@ from commitizen import factory, out +from commitizen.config import BaseConfig class Example: """Show an example so people understands the rules.""" - def __init__(self, config: dict, *args): - self.config: dict = config - self.cz = factory.commiter_factory(self.config) + def __init__(self, config: BaseConfig, *args: object) -> None: + self.config: BaseConfig = config + self.cz = factory.committer_factory(self.config) - def __call__(self): + def __call__(self) -> None: out.write(self.cz.example()) diff --git a/commitizen/commands/info.py b/commitizen/commands/info.py index f8450e6b0d..5ea8227313 100644 --- a/commitizen/commands/info.py +++ b/commitizen/commands/info.py @@ -1,12 +1,13 @@ from commitizen import factory, out +from commitizen.config import BaseConfig class Info: """Show in depth explanation of your rules.""" - def __init__(self, config: dict, *args): - self.config: dict = config - self.cz = factory.commiter_factory(self.config) + def __init__(self, config: BaseConfig, *args: object) -> None: + self.config: BaseConfig = config + self.cz = factory.committer_factory(self.config) - def __call__(self): + def __call__(self) -> None: out.write(self.cz.info()) diff --git a/commitizen/commands/init.py b/commitizen/commands/init.py new file mode 100644 index 0000000000..d0f4b686ac --- /dev/null +++ b/commitizen/commands/init.py @@ -0,0 +1,344 @@ +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING, Any, NamedTuple + +import questionary +import yaml + +from commitizen import cmd, factory, out, project_info +from commitizen.__version__ import __version__ +from commitizen.config.factory import create_config +from commitizen.cz import registry +from commitizen.defaults import CONFIG_FILES, DEFAULT_SETTINGS +from commitizen.exceptions import ( + InitFailedError, + MissingCzCustomizeConfigError, + NoAnswersError, +) +from commitizen.git import get_latest_tag_name, get_tag_names, smart_open +from commitizen.version_schemes import KNOWN_SCHEMES, Version, get_version_scheme + +if TYPE_CHECKING: + from commitizen.config import ( + BaseConfig, + ) + + +class _VersionProviderOption(NamedTuple): + provider_name: str + description: str + + @property + def title(self) -> str: + return f"{self.provider_name}: {self.description}" + + +_VERSION_PROVIDER_CHOICES = tuple( + questionary.Choice(title=option.title, value=option.provider_name) + for option in ( + _VersionProviderOption( + provider_name="commitizen", + description="Fetch and set version in commitizen config (default)", + ), + _VersionProviderOption( + provider_name="cargo", + description="Get and set version from Cargo.toml:project.version field", + ), + _VersionProviderOption( + provider_name="composer", + description="Get and set version from composer.json:project.version field", + ), + _VersionProviderOption( + provider_name="npm", + description="Get and set version from package.json:project.version field", + ), + _VersionProviderOption( + provider_name="pep621", + description="Get and set version from pyproject.toml:project.version field", + ), + _VersionProviderOption( + provider_name="poetry", + description="Get and set version from pyproject.toml:tool.poetry.version field", + ), + _VersionProviderOption( + provider_name="uv", + description="Get and set version from pyproject.toml and uv.lock", + ), + _VersionProviderOption( + provider_name="scm", + description="Fetch the version from git and does not need to set it back", + ), + ) +) + + +class Init: + _PRE_COMMIT_CONFIG_PATH = ".pre-commit-config.yaml" + + def __init__(self, config: BaseConfig, *args: object) -> None: + self.config: BaseConfig = config + self.cz = factory.committer_factory(self.config) + + def __call__(self) -> None: + if self.config.path: + out.line(f"Config file {self.config.path} already exists") + return + + out.info("Welcome to commitizen!\n") + out.line( + "Answer the following questions to configure your project.\n" + "For further configuration, visit:\n" + "\n" + "https://commitizen-tools.github.io/commitizen/config/" + "\n" + ) + + # Collect information + try: + config_path = self._ask_config_path() # select + cz_name = self._ask_name() # select + version_provider = self._ask_version_provider() # select + tag = self._ask_tag() # confirm & select + version_scheme = self._ask_version_scheme() # select + version = get_version_scheme(self.config.settings, version_scheme)(tag) + tag_format = self._ask_tag_format(tag) # confirm & text + update_changelog_on_bump = self._ask_update_changelog_on_bump() # confirm + major_version_zero = self._ask_major_version_zero(version) # confirm + hook_types: list[str] | None = questionary.checkbox( + "What types of pre-commit hook you want to install? (Leave blank if you don't want to install)", + choices=[ + questionary.Choice("commit-msg", checked=False), + questionary.Choice("pre-push", checked=False), + ], + ).unsafe_ask() + except KeyboardInterrupt: + raise InitFailedError("Stopped by user") + + if hook_types: + config_data = self._get_config_data() + with smart_open( + self._PRE_COMMIT_CONFIG_PATH, + "w", + encoding=self.config.settings["encoding"], + ) as config_file: + yaml.safe_dump(config_data, stream=config_file) + + if not project_info.is_pre_commit_installed(): + raise InitFailedError( + "Failed to install pre-commit hook.\n" + "pre-commit is not installed in current environment." + ) + + cmd_str = "pre-commit install " + " ".join( + f"--hook-type {ty}" for ty in hook_types + ) + c = cmd.run(cmd_str) + if c.return_code != 0: + raise InitFailedError( + "Failed to install pre-commit hook.\n" + f"Error running {cmd_str}." + "Outputs are attached below:\n" + f"stdout: {c.out}\n" + f"stderr: {c.err}" + ) + out.write("commitizen pre-commit hook is now installed in your '.git'\n") + + _write_config_to_file( + path=config_path, + cz_name=cz_name, + version_provider=version_provider, + version_scheme=version_scheme, + version=version, + tag_format=tag_format, + update_changelog_on_bump=update_changelog_on_bump, + major_version_zero=major_version_zero, + ) + + out.write("\nYou can bump the version running:\n") + out.info("\tcz bump\n") + out.success("Configuration complete 🚀") + + def _ask_config_path(self) -> Path: + filename: str = questionary.select( + "Please choose a supported config file: ", + choices=CONFIG_FILES, + default=project_info.get_default_config_filename(), + style=self.cz.style, + ).unsafe_ask() + return Path(filename) + + def _ask_name(self) -> str: + name: str = questionary.select( + f"Please choose a cz (commit rule): (default: {DEFAULT_SETTINGS['name']})", + choices=self._construct_name_choices_from_registry(), + default=DEFAULT_SETTINGS["name"], + style=self.cz.style, + ).unsafe_ask() + return name + + def _construct_name_choices_from_registry(self) -> list[questionary.Choice]: + """ + Construct questionary choices of cz names from registry. + """ + choices = [] + for cz_name, cz_class in registry.items(): + try: + cz_obj = cz_class(self.config) + except MissingCzCustomizeConfigError: + # Fallback if description is not available + choices.append(questionary.Choice(title=cz_name, value=cz_name)) + continue + + # Get the first line of the schema as the description + # TODO(bearomorphism): schema is a workaround. Add a description method to the cz class. + description = cz_obj.schema().partition("\n")[0] + choices.append( + questionary.Choice( + title=cz_name, value=cz_name, description=description + ) + ) + return choices + + def _ask_tag(self) -> str: + latest_tag = get_latest_tag_name() + if not latest_tag: + out.error("No Existing Tag. Set tag to v0.0.1") + return "0.0.1" + + if questionary.confirm( + f"Is {latest_tag} the latest tag?", style=self.cz.style, default=False + ).unsafe_ask(): + return latest_tag + + existing_tags = get_tag_names() + if not existing_tags: + out.error("No Existing Tag. Set tag to v0.0.1") + return "0.0.1" + + answer: str = questionary.select( + "Please choose the latest tag: ", + # The latest tag is most likely with the largest number. + # Thus, listing the existing_tags in reverse order makes more sense. + choices=sorted(existing_tags, reverse=True), + style=self.cz.style, + ).unsafe_ask() + + if not answer: + raise NoAnswersError("Tag is required!") + return answer + + def _ask_tag_format(self, latest_tag: str) -> str: + if latest_tag.startswith("v"): + v_tag_format = r"v$version" + if questionary.confirm( + f'Is "{v_tag_format}" the correct tag format?', style=self.cz.style + ).unsafe_ask(): + return v_tag_format + + default_format = DEFAULT_SETTINGS["tag_format"] + tag_format: str = questionary.text( + f'Please enter the correct version format: (default: "{default_format}")', + style=self.cz.style, + ).unsafe_ask() + + return tag_format or default_format + + def _ask_version_provider(self) -> str: + """Ask for setting: version_provider""" + + version_provider: str = questionary.select( + "Choose the source of the version:", + choices=_VERSION_PROVIDER_CHOICES, + style=self.cz.style, + default=project_info.get_default_version_provider(), + ).unsafe_ask() + return version_provider + + def _ask_version_scheme(self) -> str: + """Ask for setting: version_scheme""" + scheme: str = questionary.select( + "Choose version scheme: ", + choices=KNOWN_SCHEMES, + style=self.cz.style, + default=project_info.get_default_version_scheme(), + ).unsafe_ask() + return scheme + + def _ask_major_version_zero(self, version: Version) -> bool: + """Ask for setting: major_version_zero""" + if version.major > 0: + return False + major_version_zero: bool = questionary.confirm( + "Keep major version zero (0.x) during breaking changes", + default=True, + auto_enter=True, + ).unsafe_ask() + return major_version_zero + + def _ask_update_changelog_on_bump(self) -> bool: + """Ask for setting: update_changelog_on_bump""" + update_changelog_on_bump: bool = questionary.confirm( + "Create changelog automatically on bump", + default=True, + auto_enter=True, + ).unsafe_ask() + return update_changelog_on_bump + + def _get_config_data(self) -> dict[str, Any]: + CZ_HOOK_CONFIG = { + "repo": "https://github.com/commitizen-tools/commitizen", + "rev": f"v{__version__}", + "hooks": [ + {"id": "commitizen"}, + {"id": "commitizen-branch", "stages": ["pre-push"]}, + ], + } + + pre_commit_config_path = Path(self._PRE_COMMIT_CONFIG_PATH) + if not pre_commit_config_path.is_file(): + return {"repos": [CZ_HOOK_CONFIG]} + + with pre_commit_config_path.open( + encoding=self.config.settings["encoding"] + ) as config_file: + config_data: dict[str, Any] = yaml.safe_load(config_file) or {} + + if not isinstance(repos := config_data.get("repos"), list): + # .pre-commit-config.yaml exists but there's no "repos" key + config_data["repos"] = [CZ_HOOK_CONFIG] + return config_data + + # Check if commitizen pre-commit hook is already in the config + if any("commitizen" in hook_config["repo"] for hook_config in repos): + out.write("commitizen already in pre-commit config") + else: + repos.append(CZ_HOOK_CONFIG) + return config_data + + +def _write_config_to_file( + *, + path: Path, + cz_name: str, + version_provider: str, + version_scheme: str, + version: Version, + tag_format: str, + update_changelog_on_bump: bool, + major_version_zero: bool, +) -> None: + out_config = create_config(path=path) + out_config.init_empty_config_content() + + out_config.set_key("name", cz_name) + out_config.set_key("tag_format", tag_format) + out_config.set_key("version_scheme", version_scheme) + if version_provider == "commitizen": + out_config.set_key("version", version.public) + else: + out_config.set_key("version_provider", version_provider) + if update_changelog_on_bump: + out_config.set_key("update_changelog_on_bump", update_changelog_on_bump) + if major_version_zero: + out_config.set_key("major_version_zero", major_version_zero) diff --git a/commitizen/commands/list_cz.py b/commitizen/commands/list_cz.py index c498c9332f..412266f6c3 100644 --- a/commitizen/commands/list_cz.py +++ b/commitizen/commands/list_cz.py @@ -1,12 +1,13 @@ from commitizen import out +from commitizen.config import BaseConfig from commitizen.cz import registry class ListCz: """List currently installed rules.""" - def __init__(self, config: dict, *args): - self.config: dict = config + def __init__(self, config: BaseConfig, *args: object) -> None: + self.config: BaseConfig = config - def __call__(self): + def __call__(self) -> None: out.write("\n".join(registry.keys())) diff --git a/commitizen/commands/schema.py b/commitizen/commands/schema.py index fdb488295b..a7aeb53569 100644 --- a/commitizen/commands/schema.py +++ b/commitizen/commands/schema.py @@ -1,12 +1,13 @@ from commitizen import factory, out +from commitizen.config import BaseConfig class Schema: """Show structure of the rule.""" - def __init__(self, config: dict, *args): - self.config: dict = config - self.cz = factory.commiter_factory(self.config) + def __init__(self, config: BaseConfig, *args: object) -> None: + self.config: BaseConfig = config + self.cz = factory.committer_factory(self.config) - def __call__(self): + def __call__(self) -> None: out.write(self.cz.schema()) diff --git a/commitizen/commands/version.py b/commitizen/commands/version.py index b5158ef641..c8a76fe27f 100644 --- a/commitizen/commands/version.py +++ b/commitizen/commands/version.py @@ -1,12 +1,86 @@ +import platform +import sys +from typing import TypedDict + from commitizen import out from commitizen.__version__ import __version__ +from commitizen.config import BaseConfig +from commitizen.exceptions import NoVersionSpecifiedError, VersionSchemeUnknown +from commitizen.providers import get_provider +from commitizen.tags import TagRules +from commitizen.version_schemes import get_version_scheme + + +class VersionArgs(TypedDict, total=False): + commitizen: bool + report: bool + project: bool + verbose: bool + major: bool + minor: bool + tag: bool class Version: - """Get the version of the installed commitizen.""" + """Get the version of the installed commitizen or the current project. + Precedence: + 1. report + 2. commitizen + 3. verbose, project + """ + + def __init__(self, config: BaseConfig, arguments: VersionArgs) -> None: + self.config: BaseConfig = config + self.arguments = arguments + + def __call__(self) -> None: + if self.arguments.get("report"): + out.write(f"Commitizen Version: {__version__}") + out.write(f"Python Version: {sys.version}") + out.write(f"Operating System: {platform.system()}") + return + + if self.arguments.get("verbose"): + out.write(f"Installed Commitizen Version: {__version__}") + + if not self.arguments.get("commitizen") and ( + self.arguments.get("project") or self.arguments.get("verbose") + ): + try: + version = get_provider(self.config).get_version() + except NoVersionSpecifiedError: + out.error("No project information in this project.") + return + try: + version_scheme = get_version_scheme(self.config.settings)(version) + except VersionSchemeUnknown: + out.error("Unknown version scheme.") + return + + if self.arguments.get("major"): + version = f"{version_scheme.major}" + elif self.arguments.get("minor"): + version = f"{version_scheme.minor}" + elif self.arguments.get("tag"): + tag_rules = TagRules.from_settings(self.config.settings) + version = tag_rules.normalize_tag(version_scheme) + + out.write( + f"Project Version: {version}" + if self.arguments.get("verbose") + else version + ) + return + + if self.arguments.get("major") or self.arguments.get("minor"): + out.error( + "Major or minor version can only be used with --project or --verbose." + ) + return - def __init__(self, config: dict, *args): - self.config: dict = config + if self.arguments.get("tag"): + out.error("Tag can only be used with --project or --verbose.") + return - def __call__(self): + # If no arguments are provided, just show the installed commitizen version out.write(__version__) diff --git a/commitizen/config.py b/commitizen/config.py deleted file mode 100644 index 24507e0ea9..0000000000 --- a/commitizen/config.py +++ /dev/null @@ -1,161 +0,0 @@ -import configparser -import json -import os -import warnings -from pathlib import Path -from typing import Optional - -from tomlkit import exceptions, parse - -from commitizen import defaults - - -class Config: - def __init__(self): - self._config = defaults.settings.copy() - self._path: Optional[str] = None - - @property - def config(self): - return self._config - - @property - def path(self): - return self._path - - def update(self, data: dict): - self._config.update(data) - - def add_path(self, path: str): - self._path = path - - -_conf = Config() - - -def has_pyproject() -> bool: - return os.path.isfile("pyproject.toml") - - -def read_pyproject_conf(data: str) -> dict: - """We expect to have a section in pyproject looking like - - ``` - [tool.commitizen] - name = "cz_conventional_commits" - ``` - """ - doc = parse(data) - try: - return doc["tool"]["commitizen"] - except exceptions.NonExistentKey: - return {} - - -def read_raw_parser_conf(data: str) -> dict: - """We expect to have a section like this - - ``` - [commitizen] - name = cz_jira - files = [ - "commitizen/__version__.py", - "pyproject.toml" - ] # this tab at the end is important - style = [ - ["pointer", "reverse"], - ["question", "underline"] - ] # this tab at the end is important - ``` - """ - config = configparser.ConfigParser(allow_no_value=True) - config.read_string(data) - try: - _data: dict = dict(config["commitizen"]) - if "files" in _data: - files = _data["files"] - _f = json.loads(files) - _data.update({"files": _f}) - if "style" in _data: - style = _data["style"] - _s = json.loads(style) - _data.update({"style": _s}) - - return _data - - except KeyError: - return {} - - -def load_global_conf() -> dict: - home = str(Path.home()) - global_cfg = os.path.join(home, ".cz") - if not os.path.exists(global_cfg): - return {} - - # global conf doesnt make sense with commitizen bump - # so I'm deprecating it and won't test it - message = ( - "Global conf will be deprecated in next major version. " - "Use per project configuration. " - "Remove '~/.cz' file from your conf folder." - ) - warnings.simplefilter("always", DeprecationWarning) - warnings.warn(message, category=DeprecationWarning) - - with open(global_cfg, "r") as f: - data = f.read() - conf = read_raw_parser_conf(data) - return conf - - -def read_cfg() -> dict: - allowed_cfg_files = defaults.config_files - - for filename in allowed_cfg_files: - config_file_exists = os.path.exists(filename) - if not config_file_exists: - continue - with open(filename, "r") as f: - data: str = f.read() - if "toml" in filename: - conf = read_pyproject_conf(data) - else: - conf = read_raw_parser_conf(data) - if not conf: - continue - - _conf.update(conf) - _conf.add_path(filename) - return _conf.config - - if not _conf.path: - conf = load_global_conf() - if conf: - _conf.update(conf) - return _conf.config - - -def set_key(key: str, value: str) -> dict: - """Set or update a key in the conf. - - For now only strings are supported. - We use to update the version number. - """ - if not _conf.path: - return {} - - if "toml" in _conf.path: - with open(_conf.path, "r") as f: - parser = parse(f.read()) - parser["tool"]["commitizen"][key] = value - with open(_conf.path, "w") as f: - f.write(parser.as_string()) - else: - parser = configparser.ConfigParser() - parser.read(_conf.path) - parser["commitizen"][key] = value - with open(_conf.path, "w") as f: - parser.write(f) - - return _conf.config diff --git a/commitizen/config/__init__.py b/commitizen/config/__init__.py new file mode 100644 index 0000000000..08dc7ffd7e --- /dev/null +++ b/commitizen/config/__init__.py @@ -0,0 +1,51 @@ +from __future__ import annotations + +from pathlib import Path + +from commitizen import defaults, git, out +from commitizen.config.factory import create_config +from commitizen.exceptions import ConfigFileIsEmpty, ConfigFileNotFound + +from .base_config import BaseConfig + + +def _resolve_config_candidates() -> list[BaseConfig]: + git_project_root = git.find_git_project_root() + cfg_search_paths = [Path(".")] + + if git_project_root and cfg_search_paths[0].resolve() != git_project_root.resolve(): + cfg_search_paths.append(git_project_root) + + candidates: list[BaseConfig] = [] + for dir in cfg_search_paths: + for filename in defaults.CONFIG_FILES: + out_path = dir / filename + if out_path.is_file(): + conf = _create_config_from_path(out_path) + if conf.contains_commitizen_section(): + candidates.append(conf) + return candidates + + +def _create_config_from_path(path: Path) -> BaseConfig: + return create_config(data=path.read_bytes(), path=path) + + +def read_cfg(filepath: str | None = None) -> BaseConfig: + if filepath is not None: + conf_path = Path(filepath) + if not conf_path.is_file(): + raise ConfigFileNotFound() + conf = _create_config_from_path(conf_path) + if not conf.contains_commitizen_section(): + raise ConfigFileIsEmpty() + return conf + + config_candidates = _resolve_config_candidates() + if len(config_candidates) > 1: + out.warn( + f"Multiple config files detected: {', '.join(str(conf.path) for conf in config_candidates)}. " + f"Using config file: '{config_candidates[0].path}'." + ) + + return config_candidates[0] if config_candidates else BaseConfig() diff --git a/commitizen/config/base_config.py b/commitizen/config/base_config.py new file mode 100644 index 0000000000..f100cf9953 --- /dev/null +++ b/commitizen/config/base_config.py @@ -0,0 +1,60 @@ +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING + +from commitizen.defaults import DEFAULT_SETTINGS, Settings + +if TYPE_CHECKING: + import sys + + # Self is Python 3.11+ but backported in typing-extensions + if sys.version_info < (3, 11): + from typing_extensions import Self + else: + from typing import Self + + +class BaseConfig: + def __init__(self) -> None: + self._settings: Settings = DEFAULT_SETTINGS.copy() + self._path: Path | None = None + + def contains_commitizen_section(self) -> bool: + """Check if the config file contains a commitizen section. + + The implementation is different for each config file type. + """ + raise NotImplementedError() + + @property + def settings(self) -> Settings: + return self._settings + + @property + def path(self) -> Path: + return self._path # type: ignore[return-value] + + @path.setter + def path(self, path: Path) -> None: + self._path = Path(path) + + def set_key(self, key: str, value: object) -> Self: + """Set or update a key in the config file. + + Currently, only strings are supported for the parameter key. + """ + raise NotImplementedError() + + def update(self, data: Settings) -> None: + self._settings.update(data) + + def _parse_setting(self, data: bytes | str) -> None: + raise NotImplementedError() + + def init_empty_config_content(self) -> None: + """Create a config file with the empty config content. + + The implementation is different for each config file type. + """ + raise NotImplementedError() diff --git a/commitizen/config/factory.py b/commitizen/config/factory.py new file mode 100644 index 0000000000..d0a212b73f --- /dev/null +++ b/commitizen/config/factory.py @@ -0,0 +1,26 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +from commitizen.config.json_config import JsonConfig +from commitizen.config.toml_config import TomlConfig +from commitizen.config.yaml_config import YAMLConfig + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + + +def create_config(*, data: bytes | str | None = None, path: Path) -> BaseConfig: + if "toml" in path.suffix: + return TomlConfig(data=data or "", path=path) + if "json" in path.suffix: + return JsonConfig(data=data or "{}", path=path) + if "yaml" in path.suffix: + return YAMLConfig(data=data or "", path=path) + + # Should be unreachable. See the constant CONFIG_FILES. + raise ValueError( + f"Unsupported config file: {path.name} due to unknown file extension" + ) diff --git a/commitizen/config/json_config.py b/commitizen/config/json_config.py new file mode 100644 index 0000000000..688a6b9fec --- /dev/null +++ b/commitizen/config/json_config.py @@ -0,0 +1,70 @@ +from __future__ import annotations + +import json +from typing import TYPE_CHECKING + +from commitizen.exceptions import InvalidConfigurationError +from commitizen.git import smart_open + +from .base_config import BaseConfig + +if TYPE_CHECKING: + import sys + from pathlib import Path + + # Self is Python 3.11+ but backported in typing-extensions + if sys.version_info < (3, 11): + from typing_extensions import Self + else: + from typing import Self + + +class JsonConfig(BaseConfig): + def __init__(self, *, data: bytes | str, path: Path) -> None: + super().__init__() + self.path = path + self._parse_setting(data) + + def contains_commitizen_section(self) -> bool: + with self.path.open("rb") as json_file: + try: + config_doc = json.load(json_file) + except json.JSONDecodeError: + return False + return config_doc.get("commitizen") is not None + + def init_empty_config_content(self) -> None: + with smart_open( + self.path, "a", encoding=self._settings["encoding"] + ) as json_file: + json.dump({"commitizen": {}}, json_file) + + def set_key(self, key: str, value: object) -> Self: + with self.path.open("rb") as f: + config_doc = json.load(f) + + config_doc["commitizen"][key] = value + with smart_open(self.path, "w", encoding=self._settings["encoding"]) as f: + json.dump(config_doc, f, indent=2) + return self + + def _parse_setting(self, data: bytes | str) -> None: + """We expect to have a section in .cz.json looking like + + ``` + { + "commitizen": { + "name": "cz_conventional_commits" + } + } + ``` + """ + try: + doc = json.loads(data) + except json.JSONDecodeError as e: + raise InvalidConfigurationError(f"Failed to parse {self.path}: {e}") + + try: + self.settings.update(doc["commitizen"]) + except KeyError: + pass diff --git a/commitizen/config/toml_config.py b/commitizen/config/toml_config.py new file mode 100644 index 0000000000..28c05aaa52 --- /dev/null +++ b/commitizen/config/toml_config.py @@ -0,0 +1,70 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +from tomlkit import TOMLDocument, exceptions, parse, table + +from commitizen.exceptions import InvalidConfigurationError + +from .base_config import BaseConfig + +if TYPE_CHECKING: + import sys + from pathlib import Path + + # Self is Python 3.11+ but backported in typing-extensions + if sys.version_info < (3, 11): + from typing_extensions import Self + else: + from typing import Self + + +class TomlConfig(BaseConfig): + def __init__(self, *, data: bytes | str, path: Path) -> None: + super().__init__() + self.path = path + self._parse_setting(data) + + def contains_commitizen_section(self) -> bool: + config_doc = parse(self.path.read_bytes()) + return config_doc.get("tool", {}).get("commitizen") is not None + + def init_empty_config_content(self) -> None: + config_doc = TOMLDocument() + if self.path.is_file(): + config_doc = parse(self.path.read_bytes()) + + if config_doc.get("tool") is None: + config_doc["tool"] = table() + config_doc["tool"]["commitizen"] = table() # type: ignore[index] + + with self.path.open("wb") as output_toml_file: + output_toml_file.write( + config_doc.as_string().encode(self._settings["encoding"]) + ) + + def set_key(self, key: str, value: object) -> Self: + config_doc = parse(self.path.read_bytes()) + + config_doc["tool"]["commitizen"][key] = value # type: ignore[index] + self.path.write_bytes(config_doc.as_string().encode(self._settings["encoding"])) + + return self + + def _parse_setting(self, data: bytes | str) -> None: + """We expect to have a section in pyproject looking like + + ``` + [tool.commitizen] + name = "cz_conventional_commits" + ``` + """ + try: + doc = parse(data) + except exceptions.ParseError as e: + raise InvalidConfigurationError(f"Failed to parse {self.path}: {e}") + + try: + self.settings.update(doc["tool"]["commitizen"]) # type: ignore[index,typeddict-item] # TODO: fix this + except exceptions.NonExistentKey: + pass diff --git a/commitizen/config/yaml_config.py b/commitizen/config/yaml_config.py new file mode 100644 index 0000000000..1e9610e17a --- /dev/null +++ b/commitizen/config/yaml_config.py @@ -0,0 +1,68 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import yaml + +from commitizen.exceptions import InvalidConfigurationError +from commitizen.git import smart_open + +from .base_config import BaseConfig + +if TYPE_CHECKING: + import sys + from pathlib import Path + + # Self is Python 3.11+ but backported in typing-extensions + if sys.version_info < (3, 11): + from typing_extensions import Self + else: + from typing import Self + + +class YAMLConfig(BaseConfig): + def __init__(self, *, data: bytes | str, path: Path) -> None: + super().__init__() + self.path = path + self._parse_setting(data) + + def init_empty_config_content(self) -> None: + with smart_open( + self.path, "a", encoding=self._settings["encoding"] + ) as json_file: + yaml.dump({"commitizen": {}}, json_file, explicit_start=True) + + def contains_commitizen_section(self) -> bool: + with self.path.open("rb") as yaml_file: + config_doc = yaml.load(yaml_file, Loader=yaml.FullLoader) + return config_doc is not None and config_doc.get("commitizen") is not None + + def _parse_setting(self, data: bytes | str) -> None: + """We expect to have a section in cz.yaml looking like + + ``` + commitizen: + name: cz_conventional_commits + ``` + """ + try: + doc = yaml.safe_load(data) + except yaml.YAMLError as e: + raise InvalidConfigurationError(f"Failed to parse {self.path}: {e}") + + try: + self.settings.update(doc["commitizen"]) + except (KeyError, TypeError): + pass + + def set_key(self, key: str, value: object) -> Self: + with self.path.open("rb") as yaml_file: + config_doc = yaml.load(yaml_file, Loader=yaml.FullLoader) + + config_doc["commitizen"][key] = value + with smart_open( + self.path, "w", encoding=self._settings["encoding"] + ) as yaml_file: + yaml.dump(config_doc, yaml_file, explicit_start=True) + + return self diff --git a/commitizen/cz/__init__.py b/commitizen/cz/__init__.py index 88e936d0c6..6b7c1c887a 100644 --- a/commitizen/cz/__init__.py +++ b/commitizen/cz/__init__.py @@ -1,14 +1,43 @@ +from __future__ import annotations + import importlib import pkgutil +import warnings +from collections.abc import Iterable +from importlib import metadata +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from collections.abc import Iterable + + from commitizen.cz.base import BaseCommitizen + + +def discover_plugins( + path: Iterable[str] | None = None, +) -> dict[str, type[BaseCommitizen]]: + """Discover commitizen plugins on the path + + Args: + path (Path, optional): If provided, 'path' should be either None or a list of paths to look for + modules in. If path is None, all top-level modules on sys.path.. Defaults to None. + + Returns: + Dict[str, Type[BaseCommitizen]]: Registry with found plugins + """ + for _, name, _ in pkgutil.iter_modules(path): + if name.startswith("cz_"): + mod = importlib.import_module(name) + if hasattr(mod, "discover_this"): + warnings.warn( + UserWarning( + f"Legacy plugin '{name}' has been ignored: please expose it the 'commitizen.plugin' entrypoint" + ) + ) -from commitizen.cz.conventional_commits import ConventionalCommitsCz -from commitizen.cz.jira import JiraSmartCz + return { + ep.name: ep.load() for ep in metadata.entry_points(group="commitizen.plugin") + } -registry = {"cz_conventional_commits": ConventionalCommitsCz, "cz_jira": JiraSmartCz} -plugins = { - name: importlib.import_module(name).discover_this - for finder, name, ispkg in pkgutil.iter_modules() - if name.startswith("cz_") -} -registry.update(plugins) +registry: dict[str, type[BaseCommitizen]] = discover_plugins() diff --git a/commitizen/cz/base.py b/commitizen/cz/base.py index 656100ec64..5e7f2663ca 100644 --- a/commitizen/cz/base.py +++ b/commitizen/cz/base.py @@ -1,13 +1,45 @@ +from __future__ import annotations + from abc import ABCMeta, abstractmethod -from typing import List, Optional, Tuple +from collections.abc import Iterable, Mapping +from typing import TYPE_CHECKING, Any, NamedTuple, Protocol + +from jinja2 import BaseLoader, PackageLoader +from prompt_toolkit.styles import Style + +from commitizen.exceptions import CommitMessageLengthExceededError + +if TYPE_CHECKING: + import re + from collections.abc import Callable, Iterable, Mapping + + from commitizen import git + from commitizen.config.base_config import BaseConfig + from commitizen.question import CzQuestion + + +class MessageBuilderHook(Protocol): + def __call__( + self, message: dict[str, Any], commit: git.GitCommit + ) -> dict[str, Any] | Iterable[dict[str, Any]] | None: ... -from prompt_toolkit.styles import Style, merge_styles + +class ChangelogReleaseHook(Protocol): + def __call__( + self, release: dict[str, Any], tag: git.GitTag | None + ) -> dict[str, Any]: ... + + +class ValidationResult(NamedTuple): + is_valid: bool + errors: list class BaseCommitizen(metaclass=ABCMeta): - bump_pattern: Optional[str] = None - bump_map: Optional[dict] = None - default_style_config: List[Tuple[str, str]] = [ + bump_pattern: str | None = None + bump_map: dict[str, str] | None = None + bump_map_major_version_zero: dict[str, str] | None = None + default_style_config: list[tuple[str, str]] = [ ("qmark", "fg:#ff9d00 bold"), ("question", "bold"), ("answer", "fg:#ff9d00 bold"), @@ -20,33 +52,113 @@ class BaseCommitizen(metaclass=ABCMeta): ("disabled", "fg:#858585 italic"), ] - def __init__(self, config: dict): + # The whole subject will be parsed as a message by default + # This allows supporting changelog for any rule system. + # It can be modified per rule + commit_parser: str | None = r"(?P<message>.*)" + changelog_pattern: str | None = r".*" + change_type_map: dict[str, str] | None = None + change_type_order: list[str] | None = None + + # Executed per message parsed by the commitizen + changelog_message_builder_hook: MessageBuilderHook | None = None + + # Executed only at the end of the changelog generation + changelog_hook: Callable[[str, str | None], str] | None = None + + # Executed for each release in the changelog + changelog_release_hook: ChangelogReleaseHook | None = None + + # Plugins can override templates and provide extra template data + template_loader: BaseLoader = PackageLoader("commitizen", "templates") + template_extras: dict[str, Any] = {} + + def __init__(self, config: BaseConfig) -> None: self.config = config - if not self.config.get("style"): - self.config["style"] = BaseCommitizen.default_style_config + if not self.config.settings.get("style"): + self.config.settings.update({"style": BaseCommitizen.default_style_config}) @abstractmethod - def questions(self) -> list: + def questions(self) -> list[CzQuestion]: """Questions regarding the commit message.""" @abstractmethod - def message(self, answers: dict) -> str: + def message(self, answers: Mapping[str, Any]) -> str: """Format your git message.""" @property - def style(self): - return merge_styles( - [Style(BaseCommitizen.default_style_config), Style(self.config["style"])] + def style(self) -> Style: + return Style( + [ + *BaseCommitizen.default_style_config, + *self.config.settings["style"], + ] ) + @abstractmethod def example(self) -> str: """Example of the commit message.""" - raise NotImplementedError("Not Implemented yet") + @abstractmethod def schema(self) -> str: """Schema definition of the commit message.""" - raise NotImplementedError("Not Implemented yet") + @abstractmethod + def schema_pattern(self) -> str: + """Regex matching the schema used for message validation.""" + + @abstractmethod def info(self) -> str: """Information about the standardized commit message.""" - raise NotImplementedError("Not Implemented yet") + + def validate_commit_message( + self, + *, + commit_msg: str, + pattern: re.Pattern[str], + allow_abort: bool, + allowed_prefixes: list[str], + max_msg_length: int | None, + commit_hash: str, + ) -> ValidationResult: + """Validate commit message against the pattern.""" + if not commit_msg: + return ValidationResult( + allow_abort, [] if allow_abort else ["commit message is empty"] + ) + + if any(map(commit_msg.startswith, allowed_prefixes)): + return ValidationResult(True, []) + + if max_msg_length is not None and max_msg_length > 0: + msg_len = len(commit_msg.partition("\n")[0].strip()) + if msg_len > max_msg_length: + # TODO: capitalize the first letter of the error message for consistency in v5 + raise CommitMessageLengthExceededError( + f"commit validation: failed!\n" + f"commit message length exceeds the limit.\n" + f'commit "{commit_hash}": "{commit_msg}"\n' + f"message length limit: {max_msg_length} (actual: {msg_len})" + ) + + return ValidationResult( + bool(pattern.match(commit_msg)), + [f"pattern: {pattern.pattern}"], + ) + + def format_exception_message( + self, invalid_commits: list[tuple[git.GitCommit, list]] + ) -> str: + """Format commit errors.""" + displayed_msgs_content = "\n".join( + [ + f'commit "{commit.rev}": "{commit.message}\n"' + "\n".join(errors) + for commit, errors in invalid_commits + ] + ) + # TODO: capitalize the first letter of the error message for consistency in v5 + return ( + "commit validation: failed!\n" + "please enter a commit message in the commitizen format.\n" + f"{displayed_msgs_content}" + ) diff --git a/commitizen/cz/conventional_commits/__init__.py b/commitizen/cz/conventional_commits/__init__.py index 4ee406ca1a..52624d2ddb 100644 --- a/commitizen/cz/conventional_commits/__init__.py +++ b/commitizen/cz/conventional_commits/__init__.py @@ -1 +1 @@ -from .conventional_commits import ConventionalCommitsCz # noqa +from .conventional_commits import ConventionalCommitsCz # noqa: F401 diff --git a/commitizen/cz/conventional_commits/conventional_commits.py b/commitizen/cz/conventional_commits/conventional_commits.py index 401e8cdf91..31c329595a 100644 --- a/commitizen/cz/conventional_commits/conventional_commits.py +++ b/commitizen/cz/conventional_commits/conventional_commits.py @@ -1,43 +1,50 @@ -import os +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING, TypedDict from commitizen import defaults from commitizen.cz.base import BaseCommitizen -from commitizen.cz.exceptions import CzException - -__all__ = ["ConventionalCommitsCz"] - +from commitizen.cz.utils import multiple_line_breaker, required_validator -class NoSubjectException(CzException): - ... +if TYPE_CHECKING: + from commitizen.question import CzQuestion +__all__ = ["ConventionalCommitsCz"] -def parse_scope(text): - if not text: - return "" - - scope = text.strip().split() - if len(scope) == 1: - return scope[0] - return "-".join(scope) +def _parse_scope(text: str) -> str: + return "-".join(text.strip().split()) -def parse_subject(text): - if isinstance(text, str): - text = text.strip(".").strip() +def _parse_subject(text: str) -> str: + return required_validator(text.strip(".").strip(), msg="Subject is required.") - if not text: - raise NoSubjectException("Subject is required.") - return text +class ConventionalCommitsAnswers(TypedDict): + prefix: str + scope: str + subject: str + body: str + footer: str + is_breaking_change: bool class ConventionalCommitsCz(BaseCommitizen): - bump_pattern = defaults.bump_pattern - bump_map = defaults.bump_map - - def questions(self) -> list: - questions = [ + bump_pattern = defaults.BUMP_PATTERN + bump_map = defaults.BUMP_MAP + bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO + commit_parser = r"^((?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?|\w+!):\s(?P<message>.*)?" + change_type_map = { + "feat": "Feat", + "fix": "Fix", + "refactor": "Refactor", + "perf": "Perf", + } + changelog_pattern = defaults.BUMP_PATTERN + + def questions(self) -> list[CzQuestion]: + return [ { "type": "list", "name": "prefix", @@ -46,12 +53,18 @@ def questions(self) -> list: { "value": "fix", "name": "fix: A bug fix. Correlates with PATCH in SemVer", + "key": "x", }, { "value": "feat", "name": "feat: A new feature. Correlates with MINOR in SemVer", + "key": "f", + }, + { + "value": "docs", + "name": "docs: Documentation only changes", + "key": "d", }, - {"value": "docs", "name": "docs: Documentation only changes"}, { "value": "style", "name": ( @@ -59,6 +72,7 @@ def questions(self) -> list: "meaning of the code (white-space, formatting," " missing semi-colons, etc)" ), + "key": "s", }, { "value": "refactor", @@ -66,16 +80,17 @@ def questions(self) -> list: "refactor: A code change that neither fixes " "a bug nor adds a feature" ), + "key": "r", }, { "value": "perf", "name": "perf: A code change that improves performance", + "key": "p", }, { "value": "test", - "name": ( - "test: Adding missing or correcting " "existing tests" - ), + "name": ("test: Adding missing or correcting existing tests"), + "key": "t", }, { "value": "build", @@ -83,13 +98,15 @@ def questions(self) -> list: "build: Changes that affect the build system or " "external dependencies (example scopes: pip, docker, npm)" ), + "key": "b", }, { "value": "ci", "name": ( - "ci: Changes to our CI configuration files and " + "ci: Changes to CI configuration files and " "scripts (example scopes: GitLabCI)" ), + "key": "c", }, ], }, @@ -97,46 +114,43 @@ def questions(self) -> list: "type": "input", "name": "scope", "message": ( - "Scope. Could be anything specifying place of the " - "commit change (users, db, poll):\n" + "What is the scope of this change? (class or file name): (press [enter] to skip)\n" ), - "filter": parse_scope, + "filter": _parse_scope, }, { "type": "input", "name": "subject", - "filter": parse_subject, + "filter": _parse_subject, "message": ( - "Subject. Concise description of the changes. " - "Imperative, lower case and no final dot:\n" + "Write a short and imperative summary of the code changes: (lower case and no period)\n" ), }, - { - "type": "confirm", - "message": "Is this a BREAKING CHANGE? Correlates with MAJOR in SemVer", - "name": "is_breaking_change", - "default": False, - }, { "type": "input", "name": "body", "message": ( - "Body. Motivation for the change and contrast this " - "with previous behavior:\n" + "Provide additional contextual information about the code changes: (press [enter] to skip)\n" ), + "filter": multiple_line_breaker, + }, + { + "type": "confirm", + "name": "is_breaking_change", + "message": "Is this a BREAKING CHANGE? Correlates with MAJOR in SemVer", + "default": False, }, { "type": "input", "name": "footer", "message": ( "Footer. Information about Breaking Changes and " - "reference issues that this commit closes:\n" + "reference issues that this commit closes: (press [enter] to skip)\n" ), }, ] - return questions - def message(self, answers: dict) -> str: + def message(self, answers: ConventionalCommitsAnswers) -> str: # type: ignore[override] prefix = answers["prefix"] scope = answers["scope"] subject = answers["subject"] @@ -144,18 +158,17 @@ def message(self, answers: dict) -> str: footer = answers["footer"] is_breaking_change = answers["is_breaking_change"] - if scope: - scope = f"({scope})" + formatted_scope = f"({scope})" if scope else "" + title = f"{prefix}{formatted_scope}" if is_breaking_change: - body = f"BREAKING CHANGE: {body}" - if body: - body = f"\n\n{body}" - if footer: - footer = f"\n\n{footer}" + if self.config.settings.get("breaking_change_exclamation_in_title", False): + title = f"{title}!" + footer = f"BREAKING CHANGE: {footer}" - message = f"{prefix}{scope}: {subject}{body}{footer}" + formatted_body = f"\n\n{body}" if body else "" + formatted_footter = f"\n\n{footer}" if footer else "" - return message + return f"{title}: {subject}{formatted_body}{formatted_footter}" def example(self) -> str: return ( @@ -170,14 +183,36 @@ def schema(self) -> str: return ( "<type>(<scope>): <subject>\n" "<BLANK LINE>\n" - "(BREAKING CHANGE: )<body>\n" + "<body>\n" "<BLANK LINE>\n" - "<footer>" + "(BREAKING CHANGE: )<footer>" + ) + + def schema_pattern(self) -> str: + change_types = ( + "build", + "bump", + "chore", + "ci", + "docs", + "feat", + "fix", + "perf", + "refactor", + "revert", + "style", + "test", + ) + return ( + r"(?s)" # To explicitly make . match new line + r"(" + "|".join(change_types) + r")" # type + r"(\(\S+\))?" # scope + r"!?" + r": " + r"([^\n\r]+)" # subject + r"((\n\n.*)|(\s*))?$" ) def info(self) -> str: - dir_path = os.path.dirname(os.path.realpath(__file__)) - filepath = os.path.join(dir_path, "conventional_commits_info.txt") - with open(filepath, "r") as f: - content = f.read() - return content + filepath = Path(__file__).parent / "conventional_commits_info.txt" + return filepath.read_text(encoding=self.config.settings["encoding"]) diff --git a/commitizen/cz/conventional_commits/conventional_commits_info.txt b/commitizen/cz/conventional_commits/conventional_commits_info.txt index f1b5633e07..a076e4f5ec 100644 --- a/commitizen/cz/conventional_commits/conventional_commits_info.txt +++ b/commitizen/cz/conventional_commits/conventional_commits_info.txt @@ -28,4 +28,4 @@ information and is contained within parenthesis, e.g., feat(parser): add ability [optional body] -[optional footer] \ No newline at end of file +[optional footer] diff --git a/commitizen/cz/customize/__init__.py b/commitizen/cz/customize/__init__.py new file mode 100644 index 0000000000..0aedb9337a --- /dev/null +++ b/commitizen/cz/customize/__init__.py @@ -0,0 +1 @@ +from .customize import CustomizeCommitsCz # noqa: F401 diff --git a/commitizen/cz/customize/customize.py b/commitizen/cz/customize/customize.py new file mode 100644 index 0000000000..8fcc63fac3 --- /dev/null +++ b/commitizen/cz/customize/customize.py @@ -0,0 +1,73 @@ +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from collections.abc import Mapping + + from jinja2 import Template + + from commitizen.config import BaseConfig + from commitizen.question import CzQuestion +else: + try: + from jinja2 import Template + except ImportError: + from string import Template + + +from commitizen import defaults +from commitizen.cz.base import BaseCommitizen +from commitizen.exceptions import MissingCzCustomizeConfigError + +__all__ = ["CustomizeCommitsCz"] + + +class CustomizeCommitsCz(BaseCommitizen): + bump_pattern = defaults.BUMP_PATTERN + bump_map = defaults.BUMP_MAP + bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO + change_type_order = defaults.CHANGE_TYPE_ORDER + + def __init__(self, config: BaseConfig) -> None: + super().__init__(config) + + if "customize" not in self.config.settings: + raise MissingCzCustomizeConfigError() + self.custom_settings = self.config.settings["customize"] + + for attr_name in [ + "bump_pattern", + "bump_map", + "bump_map_major_version_zero", + "change_type_order", + "commit_parser", + "changelog_pattern", + "change_type_map", + ]: + if value := self.custom_settings.get(attr_name): + setattr(self, attr_name, value) + + def questions(self) -> list[CzQuestion]: + return self.custom_settings.get("questions", [{}]) # type: ignore[return-value] + + def message(self, answers: Mapping[str, Any]) -> str: + message_template = Template(self.custom_settings.get("message_template", "")) + if getattr(Template, "substitute", None): + return message_template.substitute(**answers) # type: ignore[attr-defined,no-any-return] # pragma: no cover # TODO: check if we can fix this + return message_template.render(**answers) + + def example(self) -> str: + return self.custom_settings.get("example") or "" + + def schema_pattern(self) -> str: + return self.custom_settings.get("schema_pattern") or "" + + def schema(self) -> str: + return self.custom_settings.get("schema") or "" + + def info(self) -> str: + if info_path := self.custom_settings.get("info_path"): + return Path(info_path).read_text(encoding=self.config.settings["encoding"]) + return self.custom_settings.get("info") or "" diff --git a/commitizen/cz/customize/customize_info.txt b/commitizen/cz/customize/customize_info.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/commitizen/cz/exceptions.py b/commitizen/cz/exceptions.py index 2b070ff57d..d74f39aaaa 100644 --- a/commitizen/cz/exceptions.py +++ b/commitizen/cz/exceptions.py @@ -1,2 +1,4 @@ -class CzException(Exception): - ... +class CzException(Exception): ... + + +class AnswerRequiredError(CzException): ... diff --git a/commitizen/cz/jira/jira.py b/commitizen/cz/jira/jira.py index fd329b9701..07189d15d3 100644 --- a/commitizen/cz/jira/jira.py +++ b/commitizen/cz/jira/jira.py @@ -1,13 +1,21 @@ -import os +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING from commitizen.cz.base import BaseCommitizen +if TYPE_CHECKING: + from collections.abc import Mapping + + from commitizen.question import CzQuestion + __all__ = ["JiraSmartCz"] class JiraSmartCz(BaseCommitizen): - def questions(self): - questions = [ + def questions(self) -> list[CzQuestion]: + return [ { "type": "input", "name": "message", @@ -41,23 +49,15 @@ def questions(self): "filter": lambda x: "#comment " + x if x else "", }, ] - return questions - def message(self, answers): + def message(self, answers: Mapping[str, str]) -> str: return " ".join( - filter( - bool, - [ - answers["message"], - answers["issues"], - answers["workflow"], - answers["time"], - answers["comment"], - ], - ) + x + for k in ("message", "issues", "workflow", "time", "comment") + if (x := answers.get(k)) ) - def example(self): + def example(self) -> str: return ( "JRA-34 #comment corrected indent issue\n" "JRA-35 #time 1w 2d 4h 30m Total work logged\n" @@ -66,12 +66,12 @@ def example(self): "ahead of schedule" ) - def schema(self): - return "<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>" # noqa + def schema(self) -> str: + return "<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>" + + def schema_pattern(self) -> str: + return r".*[A-Z]{2,}\-[0-9]+( #| .* #).+( #.+)*" - def info(self): - dir_path = os.path.dirname(os.path.realpath(__file__)) - filepath = os.path.join(dir_path, "jira_info.txt") - with open(filepath, "r") as f: - content = f.read() - return content + def info(self) -> str: + filepath = Path(__file__).parent / "jira_info.txt" + return filepath.read_text(encoding=self.config.settings["encoding"]) diff --git a/commitizen/cz/utils.py b/commitizen/cz/utils.py new file mode 100644 index 0000000000..ba5eace44a --- /dev/null +++ b/commitizen/cz/utils.py @@ -0,0 +1,31 @@ +import os +import re +import tempfile +from pathlib import Path + +from commitizen import git +from commitizen.cz import exceptions + +_RE_LOCAL_VERSION = re.compile(r"\+.+") + + +def required_validator(answer: str, msg: object = None) -> str: + if not answer: + raise exceptions.AnswerRequiredError(msg) + return answer + + +def multiple_line_breaker(answer: str, sep: str = "|") -> str: + return "\n".join(line.strip() for line in answer.split(sep) if line) + + +def strip_local_version(version: str) -> str: + return _RE_LOCAL_VERSION.sub("", version) + + +def get_backup_file_path() -> Path: + project_root = git.find_git_project_root() + project = project_root.as_posix().replace("/", "%") if project_root else "" + + user = os.environ.get("USER", "") + return Path(tempfile.gettempdir(), f"cz.commit%{user}%{project}.backup") diff --git a/commitizen/defaults.py b/commitizen/defaults.py index d6287fe67c..4865ccc188 100644 --- a/commitizen/defaults.py +++ b/commitizen/defaults.py @@ -1,25 +1,198 @@ -name: str = "cz_conventional_commits" -config_files: list = ["pyproject.toml", ".cz", "setup.cfg", ".cz.cfg"] +from __future__ import annotations -# Available settings -settings: dict = { - "name": name, +import warnings +from collections import OrderedDict +from collections.abc import Iterable, MutableMapping, Sequence +from typing import TYPE_CHECKING, Any, TypedDict + +if TYPE_CHECKING: + import pathlib + + from commitizen.question import CzQuestion + + +class CzSettings(TypedDict, total=False): + bump_pattern: str + bump_map: OrderedDict[str, str] + bump_map_major_version_zero: OrderedDict[str, str] + change_type_order: list[str] + + questions: Iterable[CzQuestion] + example: str | None + schema_pattern: str | None + schema: str | None + info_path: str | pathlib.Path + info: str + message_template: str + commit_parser: str | None + changelog_pattern: str | None + change_type_map: dict[str, str] | None + + +class Settings(TypedDict, total=False): + allow_abort: bool + allowed_prefixes: list[str] + always_signoff: bool + annotated_tag: bool + bump_message: str | None + change_type_map: dict[str, str] + changelog_file: str + changelog_format: str | None + changelog_incremental: bool + changelog_merge_prerelease: bool + changelog_start_rev: str | None + customize: CzSettings + encoding: str + extras: dict[str, Any] + gpg_sign: bool + ignored_tag_formats: Sequence[str] + legacy_tag_formats: Sequence[str] + major_version_zero: bool + message_length_limit: int + name: str + post_bump_hooks: list[str] | None + pre_bump_hooks: list[str] | None + prerelease_offset: int + retry_after_failure: bool + style: list[tuple[str, str]] + tag_format: str + template: str | None + update_changelog_on_bump: bool + use_shortcuts: bool + version_files: list[str] + version_provider: str | None + version_scheme: str | None + version_type: str | None + version: str | None + breaking_change_exclamation_in_title: bool + + +CONFIG_FILES: tuple[str, ...] = ( + ".cz.toml", + "cz.toml", + ".cz.json", + "cz.json", + ".cz.yaml", + "cz.yaml", + "pyproject.toml", +) +ENCODING = "utf-8" + +DEFAULT_SETTINGS: Settings = { + "name": "cz_conventional_commits", "version": None, - "files": [], - "tag_format": None, # example v$version + "version_files": [], + "version_provider": "commitizen", + "version_scheme": None, + "tag_format": "$version", # example v$version + "legacy_tag_formats": [], + "ignored_tag_formats": [], "bump_message": None, # bumped v$current_version to $new_version + "retry_after_failure": False, + "allow_abort": False, + "allowed_prefixes": [ + "Merge", + "Revert", + "Pull request", + "fixup!", + "squash!", + "amend!", + ], + "changelog_file": "CHANGELOG.md", + "changelog_format": None, # default guessed from changelog_file + "changelog_incremental": False, + "changelog_start_rev": None, + "changelog_merge_prerelease": False, + "update_changelog_on_bump": False, + "use_shortcuts": False, + "major_version_zero": False, + "pre_bump_hooks": [], + "post_bump_hooks": [], + "prerelease_offset": 0, + "encoding": ENCODING, + "always_signoff": False, + "template": None, # default provided by plugin + "extras": {}, + "breaking_change_exclamation_in_title": False, + "message_length_limit": 0, # 0 for no limit } MAJOR = "MAJOR" MINOR = "MINOR" PATCH = "PATCH" -bump_pattern = r"^(BREAKING CHANGE|feat|fix|refactor|perf)" -bump_map = { - "BREAKING CHANGE": MAJOR, - "feat": MINOR, - "fix": PATCH, - "refactor": PATCH, - "perf": PATCH, -} -bump_message = "bump: version $current_version → $new_version" +CHANGELOG_FORMAT = "markdown" + +BUMP_PATTERN = r"^((BREAKING[\-\ ]CHANGE|\w+)(\(.+\))?!?):" +BUMP_MAP = OrderedDict( + ( + (r"^.+!$", MAJOR), + (r"^BREAKING[\-\ ]CHANGE", MAJOR), + (r"^feat", MINOR), + (r"^fix", PATCH), + (r"^refactor", PATCH), + (r"^perf", PATCH), + ) +) +BUMP_MAP_MAJOR_VERSION_ZERO = OrderedDict( + ( + (r"^.+!$", MINOR), + (r"^BREAKING[\-\ ]CHANGE", MINOR), + (r"^feat", MINOR), + (r"^fix", PATCH), + (r"^refactor", PATCH), + (r"^perf", PATCH), + ) +) +CHANGE_TYPE_ORDER = ["BREAKING CHANGE", "Feat", "Fix", "Refactor", "Perf"] +BUMP_MESSAGE = "bump: version $current_version → $new_version" + + +def get_tag_regexes( + version_regex: str, +) -> dict[str, str]: + regexes = { + "version": version_regex, + "major": r"(?P<major>\d+)", + "minor": r"(?P<minor>\d+)", + "patch": r"(?P<patch>\d+)", + "prerelease": r"(?P<prerelease>\w+\d+)?", + "devrelease": r"(?P<devrelease>\.dev\d+)?", + } + return { + **{f"${k}": v for k, v in regexes.items()}, + **{f"${{{k}}}": v for k, v in regexes.items()}, + } + + +# Type +Questions = Iterable[MutableMapping[str, Any]] # TODO: remove this in v5 + + +def __getattr__(name: str) -> Any: + # PEP-562: deprecate module-level variable + + # {"deprecated key": (value, "new key")} + deprecated_vars = { + "bump_pattern": (BUMP_PATTERN, "BUMP_PATTERN"), + "bump_map": (BUMP_MAP, "BUMP_MAP"), + "bump_map_major_version_zero": ( + BUMP_MAP_MAJOR_VERSION_ZERO, + "BUMP_MAP_MAJOR_VERSION_ZERO", + ), + "bump_message": (BUMP_MESSAGE, "BUMP_MESSAGE"), + "change_type_order": (CHANGE_TYPE_ORDER, "CHANGE_TYPE_ORDER"), + "encoding": (ENCODING, "ENCODING"), + "name": (DEFAULT_SETTINGS["name"], "DEFAULT_SETTINGS['name']"), + "Questions": (Questions, "Iterable[CzQuestion]"), + } + if name in deprecated_vars: + value, replacement = deprecated_vars[name] + warnings.warn( + f"{name} is deprecated and will be removed in v5. " + f"Use {replacement} instead.", + DeprecationWarning, + stacklevel=2, + ) + return value + raise AttributeError(f"{name} is not an attribute of {__name__}") diff --git a/commitizen/exceptions.py b/commitizen/exceptions.py new file mode 100644 index 0000000000..52193e6ccc --- /dev/null +++ b/commitizen/exceptions.py @@ -0,0 +1,284 @@ +from __future__ import annotations + +from enum import IntEnum +from typing import Any + +from commitizen import out + + +class ExitCode(IntEnum): + EXPECTED_EXIT = 0 + NO_COMMITIZEN_FOUND = 1 + NOT_A_GIT_PROJECT = 2 + NO_COMMITS_FOUND = 3 + NO_VERSION_SPECIFIED = 4 + NO_PATTERN_MAP = 5 + BUMP_COMMIT_FAILED = 6 + BUMP_TAG_FAILED = 7 + NO_ANSWERS = 8 + COMMIT_ERROR = 9 + NO_COMMIT_BACKUP = 10 + NOTHING_TO_COMMIT = 11 + CUSTOM_ERROR = 12 + NO_COMMAND_FOUND = 13 + INVALID_COMMIT_MSG = 14 + MISSING_CZ_CUSTOMIZE_CONFIG = 15 + NO_REVISION = 16 + CURRENT_VERSION_NOT_FOUND = 17 + INVALID_COMMAND_ARGUMENT = 18 + INVALID_CONFIGURATION = 19 + NOT_ALLOWED = 20 + NO_INCREMENT = 21 + CHARACTER_SET_DECODE_ERROR = 22 + GIT_COMMAND_ERROR = 23 + INVALID_MANUAL_VERSION = 24 + INIT_FAILED = 25 + RUN_HOOK_FAILED = 26 + VERSION_PROVIDER_UNKNOWN = 27 + VERSION_SCHEME_UNKNOWN = 28 + CHANGELOG_FORMAT_UNKNOWN = 29 + CONFIG_FILE_NOT_FOUND = 30 + CONFIG_FILE_IS_EMPTY = 31 + COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED = 32 + + @classmethod + def from_str(cls, value: str) -> ExitCode: + if value.isdecimal(): + return cls(int(value)) + return cls[value.strip()] + + +class CommitizenException(Exception): + def __init__(self, *args: str, **kwargs: Any) -> None: + self.output_method = kwargs.get("output_method") or out.error + self.exit_code: ExitCode = self.__class__.exit_code + if args: + self.message = args[0] + elif hasattr(self.__class__, "message"): + self.message = self.__class__.message + else: + self.message = "" + + def __str__(self) -> str: + return self.message + + +class ExpectedExit(CommitizenException): + exit_code = ExitCode.EXPECTED_EXIT + + def __init__(self, *args: str, **kwargs: Any) -> None: + kwargs["output_method"] = kwargs.get("output_method") or out.write + super().__init__(*args, **kwargs) + + +class DryRunExit(ExpectedExit): + """Exit due to passing `--dry-run` option""" + + +class NoneIncrementExit(CommitizenException): + """The commits found are not eligible to be bumped""" + + exit_code = ExitCode.NO_INCREMENT + + +class NoCommitizenFoundException(CommitizenException): + """Using a cz (e.g., `cz_jira`) that cannot be found in your system""" + + exit_code = ExitCode.NO_COMMITIZEN_FOUND + + +class NotAGitProjectError(CommitizenException): + """Not in a git project""" + + exit_code = ExitCode.NOT_A_GIT_PROJECT + message = "fatal: not a git repository (or any of the parent directories): .git" + + +class MissingCzCustomizeConfigError(CommitizenException): + """Configuration is missing for `cz_customize`""" + + exit_code = ExitCode.MISSING_CZ_CUSTOMIZE_CONFIG + message = "fatal: customize is not set in configuration file." + + +class NoCommitsFoundError(CommitizenException): + """No commits found""" + + exit_code = ExitCode.NO_COMMITS_FOUND + + +class NoVersionSpecifiedError(CommitizenException): + """Version is not specified in configuration file""" + + exit_code = ExitCode.NO_VERSION_SPECIFIED + message = ( + "[NO_VERSION_SPECIFIED]\n" + "Check if current version is specified in config file, like:\n" + "version = 0.4.3\n" + ) + + +class NoPatternMapError(CommitizenException): + """bump / changelog pattern or map can not be found in configuration file""" + + exit_code = ExitCode.NO_PATTERN_MAP + + +class BumpCommitFailedError(CommitizenException): + """Commit failed when bumping version""" + + exit_code = ExitCode.BUMP_COMMIT_FAILED + + +class BumpTagFailedError(CommitizenException): + """Tag failed when bumping version""" + + exit_code = ExitCode.BUMP_TAG_FAILED + + +class CurrentVersionNotFoundError(CommitizenException): + """Current version cannot be found in `version_files`""" + + exit_code = ExitCode.CURRENT_VERSION_NOT_FOUND + + +class NoAnswersError(CommitizenException): + """No user response given""" + + exit_code = ExitCode.NO_ANSWERS + + +class CommitError(CommitizenException): + """git commit error""" + + exit_code = ExitCode.COMMIT_ERROR + + +class NoCommitBackupError(CommitizenException): + """Commit backup file is not found""" + + exit_code = ExitCode.NO_COMMIT_BACKUP + message = "No commit backup found" + + +class NothingToCommitError(CommitizenException): + """Nothing in staging to be committed""" + + exit_code = ExitCode.NOTHING_TO_COMMIT + + +class CustomError(CommitizenException): + """`CzException` raised""" + + exit_code = ExitCode.CUSTOM_ERROR + + +class InvalidCommitMessageError(CommitizenException): + """The commit message does not pass `cz check`""" + + exit_code = ExitCode.INVALID_COMMIT_MSG + + +class NoRevisionError(CommitizenException): + """No revision found""" + + exit_code = ExitCode.NO_REVISION + message = "No tag found to do an incremental changelog" + + +class NoCommandFoundError(CommitizenException): + """No command found when running Commitizen cli (e.g., `cz --debug`)""" + + exit_code = ExitCode.NO_COMMAND_FOUND + message = "Command is required" + + +class InvalidCommandArgumentError(CommitizenException): + """The argument provided to the command is invalid (e.g. `cz check -commit-msg-file filename --rev-range master..`)""" + + exit_code = ExitCode.INVALID_COMMAND_ARGUMENT + + +class InvalidConfigurationError(CommitizenException): + """An error was found in the Commitizen Configuration, such as duplicates in `change_type_order`""" + + exit_code = ExitCode.INVALID_CONFIGURATION + + +class NotAllowed(CommitizenException): + """`--incremental` cannot be combined with a `rev_range`""" + + exit_code = ExitCode.NOT_ALLOWED + + +class CharacterSetDecodeError(CommitizenException): + """The character encoding of the command output could not be determined""" + + exit_code = ExitCode.CHARACTER_SET_DECODE_ERROR + + +class GitCommandError(CommitizenException): + """Unexpected failure while calling a git command""" + + exit_code = ExitCode.GIT_COMMAND_ERROR + + +class InvalidManualVersion(CommitizenException): + """Manually provided version is invalid""" + + exit_code = ExitCode.INVALID_MANUAL_VERSION + + +class InitFailedError(CommitizenException): + """Failed to initialize pre-commit""" + + exit_code = ExitCode.INIT_FAILED + + +class RunHookError(CommitizenException): + """An error occurred during a hook execution""" + + exit_code = ExitCode.RUN_HOOK_FAILED + + +class VersionProviderUnknown(CommitizenException): + """Unknown `version_provider`""" + + exit_code = ExitCode.VERSION_PROVIDER_UNKNOWN + + +class VersionSchemeUnknown(CommitizenException): + """Unknown `version_scheme`""" + + exit_code = ExitCode.VERSION_SCHEME_UNKNOWN + + +class ChangelogFormatUnknown(CommitizenException): + """Unknown `changelog_format` or cannot be determined by the file extension""" + + exit_code = ExitCode.CHANGELOG_FORMAT_UNKNOWN + message = "Unknown changelog format identifier" + + +class ConfigFileNotFound(CommitizenException): + """The configuration file is not found""" + + exit_code = ExitCode.CONFIG_FILE_NOT_FOUND + message = "Cannot found the config file, please check your file path again." + + +class ConfigFileIsEmpty(CommitizenException): + """The configuration file is empty""" + + exit_code = ExitCode.CONFIG_FILE_IS_EMPTY + message = "Config file is empty, please check your file path again." + + +class CommitMessageLengthExceededError(CommitizenException): + """The commit message length exceeds the given limit.""" + + exit_code = ExitCode.COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED + message = "Length of commit message exceeds the given limit." + + +# When adding / updating a new exit code, please update the documentation of the exit codes in docs/exit_codes.md diff --git a/commitizen/factory.py b/commitizen/factory.py index b1592feda7..d9e99fb771 100644 --- a/commitizen/factory.py +++ b/commitizen/factory.py @@ -1,20 +1,17 @@ -from commitizen import BaseCommitizen, out +from commitizen import BaseCommitizen +from commitizen.config import BaseConfig from commitizen.cz import registry +from commitizen.exceptions import NoCommitizenFoundException -NO_COMMITIZEN_FOUND = 2 - -def commiter_factory(config: dict) -> BaseCommitizen: +def committer_factory(config: BaseConfig) -> BaseCommitizen: """Return the correct commitizen existing in the registry.""" - name: str = config["name"] + name: str = config.settings["name"] try: - _cz = registry[name](config) + return registry[name](config) except KeyError: msg_error = ( - "The commiter has not been found in the system.\n\n" + "The committer has not been found in the system.\n\n" f"Try running 'pip install {name}'\n" ) - out.error(msg_error) - raise SystemExit(NO_COMMITIZEN_FOUND) - else: - return _cz + raise NoCommitizenFoundException(msg_error) diff --git a/commitizen/git.py b/commitizen/git.py index db307d4510..dc26038986 100644 --- a/commitizen/git.py +++ b/commitizen/git.py @@ -1,33 +1,264 @@ +from __future__ import annotations + import os +from enum import Enum +from functools import lru_cache +from pathlib import Path from tempfile import NamedTemporaryFile -from commitizen import cmd +from commitizen import cmd, out +from commitizen.exceptions import GitCommandError -def tag(tag: str): - c = cmd.run(f"git tag {tag}") - return c +class EOLType(Enum): + """The EOL type from `git config core.eol`.""" + + LF = "lf" + CRLF = "crlf" + NATIVE = "native" + + @classmethod + def for_open(cls) -> str: + c = cmd.run("git config core.eol") + eol = c.out.strip().upper() + return cls._char_for_open()[cls._safe_cast(eol)] + + @classmethod + def _safe_cast(cls, eol: str) -> EOLType: + try: + return cls[eol] + except KeyError: + return cls.NATIVE + + @classmethod + @lru_cache + def _char_for_open(cls) -> dict[EOLType, str]: + """Get the EOL character for `open()`.""" + return { + cls.LF: "\n", + cls.CRLF: "\r\n", + cls.NATIVE: os.linesep, + } + + +class GitObject: + rev: str + name: str + date: str + + def __eq__(self, other: object) -> bool: + return hasattr(other, "rev") and self.rev == other.rev + + def __hash__(self) -> int: + return hash(self.rev) + + +class GitCommit(GitObject): + def __init__( + self, + rev: str, + title: str, + body: str = "", + author: str = "", + author_email: str = "", + parents: list[str] | None = None, + ) -> None: + self.rev = rev.strip() + self.title = title.strip() + self.body = body.strip() + self.author = author.strip() + self.author_email = author_email.strip() + self.parents = parents or [] + + @property + def message(self) -> str: + return f"{self.title}\n\n{self.body}".strip() + + @classmethod + def from_rev_and_commit(cls, rev_and_commit: str) -> GitCommit: + """Create a GitCommit instance from a formatted commit string. + + This method parses a multi-line string containing commit information in the following format: + ``` + <rev> + <parents> + <title> + <author> + <author_email> + <body_line_1> + <body_line_2> + ... + ``` + + Args: + rev_and_commit (str): A string containing commit information with fields separated by newlines. + - rev: The commit hash/revision + - parents: Space-separated list of parent commit hashes + - title: The commit title/message + - author: The commit author's name + - author_email: The commit author's email + - body: Optional multi-line commit body + + Returns: + GitCommit: A new GitCommit instance with the parsed information. + + Example: + >>> commit_str = '''abc123 + ... def456 ghi789 + ... feat: add new feature + ... John Doe + ... john@example.com + ... This is a detailed description + ... of the new feature''' + >>> commit = GitCommit.from_rev_and_commit(commit_str) + >>> commit.rev + 'abc123' + >>> commit.title + 'feat: add new feature' + >>> commit.parents + ['def456', 'ghi789'] + """ + rev, parents, title, author, author_email, *body_list = ( + rev_and_commit.splitlines() + ) + return cls( + rev=rev.strip(), + title=title.strip(), + body="\n".join(body_list).strip(), + author=author, + author_email=author_email, + parents=[p for p in parents.strip().split(" ") if p], + ) + + def __repr__(self) -> str: + return f"{self.title} ({self.rev})" + + +class GitTag(GitObject): + def __init__(self, name: str, rev: str, date: str) -> None: + self.rev = rev.strip() + self.name = name.strip() + self._date = date.strip() + + def __repr__(self) -> str: + return f"GitTag('{self.name}', '{self.rev}', '{self.date}')" + + @property + def date(self) -> str: + return self._date + + @date.setter + def date(self, value: str) -> None: + self._date = value + + @classmethod + def from_line(cls, line: str, inner_delimiter: str) -> GitTag: + name, objectname, date, obj = line.split(inner_delimiter) + if not obj: + obj = objectname + + return cls(name=name, rev=obj, date=date) + + +def tag( + tag: str, annotated: bool = False, signed: bool = False, msg: str | None = None +) -> cmd.Command: + if not annotated and not signed: + return cmd.run(f"git tag {tag}") + + # according to https://git-scm.com/book/en/v2/Git-Basics-Tagging, + # we're not able to create lightweight tag with message. + # by adding message, we make it a annotated tags + option = "-s" if signed else "-a" # The else case is for annotated tags + return cmd.run(f'git tag {option} {tag} -m "{msg or tag}"') + + +def add(*args: str) -> cmd.Command: + return cmd.run(f"git add {' '.join(args)}") -def commit(message: str, args=""): +def commit( + message: str, + args: str = "", + committer_date: str | None = None, +) -> cmd.Command: f = NamedTemporaryFile("wb", delete=False) f.write(message.encode("utf-8")) f.close() - c = cmd.run(f"git commit {args} -F {f.name}") + + command = _create_commit_cmd_string(args, committer_date, f.name) + c = cmd.run(command) os.unlink(f.name) return c -def get_commits(start: str, end: str = "HEAD", from_beginning: bool = False) -> list: +def _create_commit_cmd_string(args: str, committer_date: str | None, name: str) -> str: + command = f'git commit {args} -F "{name}"' + if not committer_date: + return command + if os.name != "nt": + return f"GIT_COMMITTER_DATE={committer_date} {command}" + # Using `cmd /v /c "{command}"` sets environment variables only for that command + return f'cmd /v /c "set GIT_COMMITTER_DATE={committer_date}&& {command}"' - c = cmd.run(f"git log --pretty=format:%s%n%b {start}...{end}") - if from_beginning: - c = cmd.run(f"git log --pretty=format:%s%n%b {end}") +def get_commits( + start: str | None = None, + end: str | None = None, + *, + args: str = "", +) -> list[GitCommit]: + """Get the commits between start and end.""" + if end is None: + end = "HEAD" + git_log_entries = _get_log_as_str_list(start, end, args) + return [ + GitCommit.from_rev_and_commit(rev_and_commit) + for rev_and_commit in git_log_entries + if rev_and_commit + ] - if not c.out: - return [] - return c.out.split("\n") + +def get_filenames_in_commit(git_reference: str = "") -> list[str]: + """Get the list of files that were committed in the requested git reference. + + :param git_reference: a git reference as accepted by `git show`, default: the last commit + + :returns: file names committed in the last commit by default or inside the passed git reference + """ + c = cmd.run(f"git show --name-only --pretty=format: {git_reference}") + if c.return_code == 0: + return c.out.strip().split("\n") + raise GitCommandError(c.err) + + +def get_tags( + dateformat: str = "%Y-%m-%d", reachable_only: bool = False +) -> list[GitTag]: + inner_delimiter = "---inner_delimiter---" + formatter = ( + f'"%(refname:strip=2){inner_delimiter}' + f"%(objectname){inner_delimiter}" + f"%(creatordate:format:{dateformat}){inner_delimiter}" + f'%(object)"' + ) + extra = "--merged" if reachable_only else "" + # Force the default language for parsing + env = {"LC_ALL": "C", "LANG": "C", "LANGUAGE": "C"} + c = cmd.run(f"git tag --format={formatter} --sort=-creatordate {extra}", env=env) + if c.return_code != 0: + if reachable_only and c.err == "fatal: malformed object name HEAD\n": + # this can happen if there are no commits in the repo yet + return [] + raise GitCommandError(c.err) + + if c.err: + out.warn(f"Attempting to proceed after: {c.err}") + + return [ + GitTag.from_line(line=line, inner_delimiter=inner_delimiter) + for line in c.out.split("\n")[:-1] + ] def tag_exist(tag: str) -> bool: @@ -35,8 +266,76 @@ def tag_exist(tag: str) -> bool: return tag in c.out +def is_signed_tag(tag: str) -> bool: + return cmd.run(f"git tag -v {tag}").return_code == 0 + + +def get_latest_tag_name() -> str | None: + c = cmd.run("git describe --abbrev=0 --tags") + if c.err: + return None + return c.out.strip() + + +def get_tag_message(tag: str) -> str | None: + c = cmd.run(f"git tag -l --format='%(contents:subject)' {tag}") + if c.err: + return None + return c.out.strip() + + +def get_tag_names() -> list[str]: + c = cmd.run("git tag --list") + if c.err: + return [] + return [tag for raw in c.out.split("\n") if (tag := raw.strip())] + + +def find_git_project_root() -> Path | None: + c = cmd.run("git rev-parse --show-toplevel") + if c.err: + return None + return Path(c.out.strip()) + + def is_staging_clean() -> bool: - """Check if staing is clean""" - c = cmd.run("git diff --no-ext-diff --name-only") - c_cached = cmd.run("git diff --no-ext-diff --cached --name-only") - return not (bool(c.out) or bool(c_cached.out)) + """Check if staging is clean.""" + c = cmd.run("git diff --no-ext-diff --cached --name-only") + return not bool(c.out) + + +def is_git_project() -> bool: + c = cmd.run("git rev-parse --is-inside-work-tree") + return c.out.strip() == "true" + + +def get_core_editor() -> str | None: + c = cmd.run("git var GIT_EDITOR") + if c.out: + return c.out.strip() + return None + + +def smart_open(*args, **kwargs): # type: ignore[no-untyped-def,unused-ignore] # noqa: ANN201 + """Open a file with the EOL style determined from Git.""" + return open(*args, newline=EOLType.for_open(), **kwargs) + + +def _get_log_as_str_list(start: str | None, end: str, args: str) -> list[str]: + """Get string representation of each log entry""" + delimiter = "----------commit-delimiter----------" + log_format: str = "%H%n%P%n%s%n%an%n%ae%n%b" + command_range = f"{start}..{end}" if start else end + command = f"git -c log.showSignature=False log --pretty={log_format}{delimiter} {args} {command_range}" + + c = cmd.run(command) + if c.return_code != 0: + raise GitCommandError(c.err) + return c.out.split(f"{delimiter}\n") + + +def get_default_branch() -> str: + c = cmd.run("git symbolic-ref refs/remotes/origin/HEAD") + if c.return_code != 0: + raise GitCommandError(c.err) + return c.out.strip() diff --git a/commitizen/hooks.py b/commitizen/hooks.py new file mode 100644 index 0000000000..10560d5eae --- /dev/null +++ b/commitizen/hooks.py @@ -0,0 +1,40 @@ +from __future__ import annotations + +import os +from typing import TYPE_CHECKING + +from commitizen import cmd, out +from commitizen.exceptions import RunHookError + +if TYPE_CHECKING: + from collections.abc import Mapping + + +def run(hooks: str | list[str], _env_prefix: str = "CZ_", **env: object) -> None: + if isinstance(hooks, str): + hooks = [hooks] + + for hook in hooks: + out.info(f"Running hook '{hook}'") + + c = cmd.run(hook, env=_format_env(_env_prefix, env)) + + if c.out: + out.write(c.out) + if c.err: + out.error(c.err) + + if c.return_code != 0: + raise RunHookError(f"Running hook '{hook}' failed") + + +def _format_env(prefix: str, env: Mapping[str, object]) -> dict[str, str]: + """_format_env() prefixes all given environment variables with the given + prefix so it can be passed directly to cmd.run().""" + penv = dict(os.environ) + for name, value in env.items(): + name = prefix + name.upper() + value = str(value) if value is not None else "" + penv[name] = value + + return penv diff --git a/commitizen/out.py b/commitizen/out.py index 268f02e29f..1bbfe4329d 100644 --- a/commitizen/out.py +++ b/commitizen/out.py @@ -1,28 +1,43 @@ +import io import sys +from typing import Any from termcolor import colored +if sys.platform == "win32": + if isinstance(sys.stdout, io.TextIOWrapper) and sys.version_info >= (3, 7): + sys.stdout.reconfigure(encoding="utf-8") -def write(value: str, *args): + +def write(value: str, *args: object) -> None: """Intended to be used when value is multiline.""" print(value, *args) -def line(value: str, *args, **kwargs): +def line(value: str, *args: object, **kwargs: Any) -> None: """Wrapper in case I want to do something different later.""" print(value, *args, **kwargs) -def error(value: str): +def error(value: str) -> None: message = colored(value, "red") line(message, file=sys.stderr) -def success(value: str): +def success(value: str) -> None: message = colored(value, "green") line(message) -def info(value: str): +def info(value: str) -> None: message = colored(value, "blue") line(message) + + +def diagnostic(value: str) -> None: + line(value, file=sys.stderr) + + +def warn(value: str) -> None: + message = colored(value, "magenta") + line(message, file=sys.stderr) diff --git a/commitizen/project_info.py b/commitizen/project_info.py new file mode 100644 index 0000000000..381629304e --- /dev/null +++ b/commitizen/project_info.py @@ -0,0 +1,47 @@ +"""Resolves project information about the current working directory.""" + +import shutil +from pathlib import Path +from typing import Literal + + +def is_pre_commit_installed() -> bool: + return any(shutil.which(tool) for tool in ("pre-commit", "prek")) + + +def get_default_version_provider() -> Literal[ + "commitizen", "cargo", "composer", "npm", "pep621", "poetry", "uv" +]: + pyproject_path = Path("pyproject.toml") + if pyproject_path.is_file(): + if "[tool.poetry]" in pyproject_path.read_text(): + return "poetry" + if Path("uv.lock").is_file(): + return "uv" + return "pep621" + + if Path("setup.py").is_file(): + return "pep621" + + if Path("Cargo.toml").is_file(): + return "cargo" + + if Path("package.json").is_file(): + return "npm" + + if Path("composer.json").is_file(): + return "composer" + + return "commitizen" + + +def get_default_config_filename() -> Literal["pyproject.toml", ".cz.toml"]: + return "pyproject.toml" if Path("pyproject.toml").is_file() else ".cz.toml" + + +def get_default_version_scheme() -> Literal["pep440", "semver"]: + return ( + "pep440" + if Path("pyproject.toml").is_file() or Path("setup.py").is_file() + else "semver" + ) diff --git a/commitizen/providers/__init__.py b/commitizen/providers/__init__.py new file mode 100644 index 0000000000..6bec8f1567 --- /dev/null +++ b/commitizen/providers/__init__.py @@ -0,0 +1,49 @@ +from __future__ import annotations + +from importlib import metadata +from typing import TYPE_CHECKING, cast + +from commitizen.config.base_config import BaseConfig +from commitizen.exceptions import VersionProviderUnknown +from commitizen.providers.cargo_provider import CargoProvider +from commitizen.providers.commitizen_provider import CommitizenProvider +from commitizen.providers.composer_provider import ComposerProvider +from commitizen.providers.npm_provider import NpmProvider +from commitizen.providers.pep621_provider import Pep621Provider +from commitizen.providers.poetry_provider import PoetryProvider +from commitizen.providers.scm_provider import ScmProvider +from commitizen.providers.uv_provider import UvProvider + +if TYPE_CHECKING: + from commitizen.config.base_config import BaseConfig + from commitizen.providers.base_provider import VersionProvider + +__all__ = [ + "CargoProvider", + "CommitizenProvider", + "ComposerProvider", + "NpmProvider", + "Pep621Provider", + "PoetryProvider", + "ScmProvider", + "UvProvider", + "get_provider", +] + +PROVIDER_ENTRYPOINT = "commitizen.provider" +DEFAULT_PROVIDER = "commitizen" + + +def get_provider(config: BaseConfig) -> VersionProvider: + """ + Get the version provider as defined in the configuration + + :raises VersionProviderUnknown: if the provider named by `version_provider` is not found. + """ + provider_name = config.settings["version_provider"] or DEFAULT_PROVIDER + try: + (ep,) = metadata.entry_points(name=provider_name, group=PROVIDER_ENTRYPOINT) + except ValueError: + raise VersionProviderUnknown(f'Version Provider "{provider_name}" unknown.') + provider_cls = ep.load() + return cast("VersionProvider", provider_cls(config)) diff --git a/commitizen/providers/base_provider.py b/commitizen/providers/base_provider.py new file mode 100644 index 0000000000..b77d86394c --- /dev/null +++ b/commitizen/providers/base_provider.py @@ -0,0 +1,100 @@ +from __future__ import annotations + +import json +from abc import ABC, abstractmethod +from pathlib import Path +from typing import TYPE_CHECKING, Any, ClassVar + +import tomlkit + +if TYPE_CHECKING: + from collections.abc import Mapping + + from commitizen.config.base_config import BaseConfig + + +class VersionProvider(ABC): + """ + Abstract base class for version providers. + + Each version provider should inherit and implement this class. + """ + + config: BaseConfig + + def __init__(self, config: BaseConfig) -> None: + self.config = config + + @abstractmethod + def get_version(self) -> str: + """ + Get the current version + """ + + @abstractmethod + def set_version(self, version: str) -> None: + """ + Set the new current version + """ + + +class FileProvider(VersionProvider): + """ + Base class for file-based version providers + """ + + filename: ClassVar[str] + + @property + def file(self) -> Path: + return Path() / self.filename + + def _get_encoding(self) -> str: + return self.config.settings["encoding"] + + +class JsonProvider(FileProvider): + """ + Base class for JSON-based version providers + """ + + indent: ClassVar[int] = 2 + + def get_version(self) -> str: + document = json.loads(self.file.read_text(encoding=self._get_encoding())) + return self.get(document) + + def set_version(self, version: str) -> None: + document = json.loads(self.file.read_text(encoding=self._get_encoding())) + self.set(document, version) + self.file.write_text( + json.dumps(document, indent=self.indent) + "\n", + encoding=self._get_encoding(), + ) + + def get(self, document: Mapping[str, str]) -> str: + return document["version"] + + def set(self, document: dict[str, Any], version: str) -> None: + document["version"] = version + + +class TomlProvider(FileProvider): + """ + Base class for TOML-based version providers + """ + + def get_version(self) -> str: + document = tomlkit.parse(self.file.read_text(encoding=self._get_encoding())) + return self.get(document) + + def set_version(self, version: str) -> None: + document = tomlkit.parse(self.file.read_text(encoding=self._get_encoding())) + self.set(document, version) + self.file.write_text(tomlkit.dumps(document), encoding=self._get_encoding()) + + def get(self, document: tomlkit.TOMLDocument) -> str: + return document["project"]["version"] # type: ignore[index,return-value] + + def set(self, document: tomlkit.TOMLDocument, version: str) -> None: + document["project"]["version"] = version # type: ignore[index] diff --git a/commitizen/providers/cargo_provider.py b/commitizen/providers/cargo_provider.py new file mode 100644 index 0000000000..235d4a110c --- /dev/null +++ b/commitizen/providers/cargo_provider.py @@ -0,0 +1,111 @@ +from __future__ import annotations + +import fnmatch +import glob +from pathlib import Path +from typing import TYPE_CHECKING + +from tomlkit import TOMLDocument, dumps, parse +from tomlkit.exceptions import NonExistentKey + +from commitizen.providers.base_provider import TomlProvider + +if TYPE_CHECKING: + from tomlkit.items import AoT + + +class CargoProvider(TomlProvider): + """ + Cargo version management + + With support for `workspaces` + """ + + filename = "Cargo.toml" + lock_filename = "Cargo.lock" + + @property + def lock_file(self) -> Path: + return Path() / self.lock_filename + + def get(self, document: TOMLDocument) -> str: + out = _try_get_workspace(document)["package"]["version"] + if TYPE_CHECKING: + assert isinstance(out, str) + return out + + def set(self, document: TOMLDocument, version: str) -> None: + _try_get_workspace(document)["package"]["version"] = version + + def set_version(self, version: str) -> None: + super().set_version(version) + if self.lock_file.is_file(): + self.set_lock_version(version) + + def set_lock_version(self, version: str) -> None: + cargo_toml_content = parse(self.file.read_text(encoding=self._get_encoding())) + cargo_lock_content = parse( + self.lock_file.read_text(encoding=self._get_encoding()) + ) + packages = cargo_lock_content["package"] + + if TYPE_CHECKING: + assert isinstance(packages, AoT) + + try: + cargo_package_name = cargo_toml_content["package"]["name"] # type: ignore[index] + if TYPE_CHECKING: + assert isinstance(cargo_package_name, str) + for i, package in enumerate(packages): + if package["name"] == cargo_package_name: + cargo_lock_content["package"][i]["version"] = version # type: ignore[index] + break + except NonExistentKey: + workspace = cargo_toml_content.get("workspace", {}) + if TYPE_CHECKING: + assert isinstance(workspace, dict) + workspace_members = workspace.get("members", []) + excluded_workspace_members = workspace.get("exclude", []) + members_inheriting: list[str] = [] + + for member in workspace_members: + for path in glob.glob(member, recursive=True): + if any( + fnmatch.fnmatch(path, pattern) + for pattern in excluded_workspace_members + ): + continue + + cargo_file = Path(path) / "Cargo.toml" + package_content = parse( + cargo_file.read_text(encoding=self._get_encoding()) + ).get("package", {}) + if TYPE_CHECKING: + assert isinstance(package_content, dict) + try: + version_workspace = package_content["version"]["workspace"] + if version_workspace is True: + package_name = package_content["name"] + if TYPE_CHECKING: + assert isinstance(package_name, str) + members_inheriting.append(package_name) + except NonExistentKey: + pass + + for i, package in enumerate(packages): + if package["name"] in members_inheriting: + cargo_lock_content["package"][i]["version"] = version # type: ignore[index] + + self.lock_file.write_text( + dumps(cargo_lock_content), encoding=self._get_encoding() + ) + + +def _try_get_workspace(document: TOMLDocument) -> dict: + try: + workspace = document["workspace"] + if TYPE_CHECKING: + assert isinstance(workspace, dict) + return workspace + except NonExistentKey: + return document diff --git a/commitizen/providers/commitizen_provider.py b/commitizen/providers/commitizen_provider.py new file mode 100644 index 0000000000..f90d7d9b6e --- /dev/null +++ b/commitizen/providers/commitizen_provider.py @@ -0,0 +1,18 @@ +from __future__ import annotations + +from commitizen.exceptions import NoVersionSpecifiedError +from commitizen.providers.base_provider import VersionProvider + + +class CommitizenProvider(VersionProvider): + """ + Default version provider: Fetch and set version in commitizen config. + """ + + def get_version(self) -> str: + if ret := self.config.settings["version"]: + return ret + raise NoVersionSpecifiedError() + + def set_version(self, version: str) -> None: + self.config.set_key("version", version) diff --git a/commitizen/providers/composer_provider.py b/commitizen/providers/composer_provider.py new file mode 100644 index 0000000000..495357d8f0 --- /dev/null +++ b/commitizen/providers/composer_provider.py @@ -0,0 +1,12 @@ +from __future__ import annotations + +from commitizen.providers.base_provider import JsonProvider + + +class ComposerProvider(JsonProvider): + """ + Composer version management + """ + + filename = "composer.json" + indent = 4 diff --git a/commitizen/providers/npm_provider.py b/commitizen/providers/npm_provider.py new file mode 100644 index 0000000000..6794f6a714 --- /dev/null +++ b/commitizen/providers/npm_provider.py @@ -0,0 +1,95 @@ +from __future__ import annotations + +import json +from pathlib import Path +from typing import TYPE_CHECKING, Any, ClassVar + +from commitizen.providers.base_provider import JsonProvider + +if TYPE_CHECKING: + from collections.abc import Mapping + + +class NpmProvider(JsonProvider): + """ + npm package.json and package-lock.json version management + """ + + indent: ClassVar[int] = 2 + package_filename = "package.json" + lock_filename = "package-lock.json" + shrinkwrap_filename = "npm-shrinkwrap.json" + + @property + def package_file(self) -> Path: + return Path() / self.package_filename + + @property + def lock_file(self) -> Path: + return Path() / self.lock_filename + + @property + def shrinkwrap_file(self) -> Path: + return Path() / self.shrinkwrap_filename + + def get_version(self) -> str: + """ + Get the current version from package.json + """ + package_document = json.loads( + self.package_file.read_text(encoding=self._get_encoding()) + ) + return self.get_package_version(package_document) + + def set_version(self, version: str) -> None: + package_document = self.set_package_version( + json.loads(self.package_file.read_text(encoding=self._get_encoding())), + version, + ) + self.package_file.write_text( + json.dumps(package_document, indent=self.indent) + "\n", + encoding=self._get_encoding(), + ) + if self.lock_file.is_file(): + lock_document = self.set_lock_version( + json.loads(self.lock_file.read_text(encoding=self._get_encoding())), + version, + ) + self.lock_file.write_text( + json.dumps(lock_document, indent=self.indent) + "\n", + encoding=self._get_encoding(), + ) + if self.shrinkwrap_file.is_file(): + shrinkwrap_document = self.set_shrinkwrap_version( + json.loads( + self.shrinkwrap_file.read_text(encoding=self._get_encoding()) + ), + version, + ) + self.shrinkwrap_file.write_text( + json.dumps(shrinkwrap_document, indent=self.indent) + "\n", + encoding=self._get_encoding(), + ) + + def get_package_version(self, document: Mapping[str, str]) -> str: + return document["version"] + + def set_package_version( + self, document: dict[str, Any], version: str + ) -> dict[str, Any]: + document["version"] = version + return document + + def set_lock_version( + self, document: dict[str, Any], version: str + ) -> dict[str, Any]: + document["version"] = version + document["packages"][""]["version"] = version + return document + + def set_shrinkwrap_version( + self, document: dict[str, Any], version: str + ) -> dict[str, Any]: + document["version"] = version + document["packages"][""]["version"] = version + return document diff --git a/commitizen/providers/pep621_provider.py b/commitizen/providers/pep621_provider.py new file mode 100644 index 0000000000..0b8b5c4b87 --- /dev/null +++ b/commitizen/providers/pep621_provider.py @@ -0,0 +1,11 @@ +from __future__ import annotations + +from commitizen.providers.base_provider import TomlProvider + + +class Pep621Provider(TomlProvider): + """ + PEP-621 version management + """ + + filename = "pyproject.toml" diff --git a/commitizen/providers/poetry_provider.py b/commitizen/providers/poetry_provider.py new file mode 100644 index 0000000000..d9a174a0a4 --- /dev/null +++ b/commitizen/providers/poetry_provider.py @@ -0,0 +1,22 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +from commitizen.providers.base_provider import TomlProvider + +if TYPE_CHECKING: + import tomlkit + + +class PoetryProvider(TomlProvider): + """ + Poetry version management + """ + + filename = "pyproject.toml" + + def get(self, pyproject: tomlkit.TOMLDocument) -> str: + return pyproject["tool"]["poetry"]["version"] # type: ignore[index,return-value] + + def set(self, pyproject: tomlkit.TOMLDocument, version: str) -> None: + pyproject["tool"]["poetry"]["version"] = version # type: ignore[index] diff --git a/commitizen/providers/scm_provider.py b/commitizen/providers/scm_provider.py new file mode 100644 index 0000000000..687775da30 --- /dev/null +++ b/commitizen/providers/scm_provider.py @@ -0,0 +1,26 @@ +from __future__ import annotations + +from commitizen.git import get_tags +from commitizen.providers.base_provider import VersionProvider +from commitizen.tags import TagRules + + +class ScmProvider(VersionProvider): + """ + A provider fetching the current/last version from the repository history + + The version is fetched using `git describe` and is never set. + + It is meant for `setuptools-scm` or any package manager `*-scm` provider. + """ + + def get_version(self) -> str: + rules = TagRules.from_settings(self.config.settings) + tags = get_tags(reachable_only=True) + version_tags = rules.get_version_tags(tags) + version = max((rules.extract_version(t) for t in version_tags), default=None) + return str(version) if version is not None else "0.0.0" + + def set_version(self, version: str) -> None: + # Not necessary + pass diff --git a/commitizen/providers/uv_provider.py b/commitizen/providers/uv_provider.py new file mode 100644 index 0000000000..0eb19e51a6 --- /dev/null +++ b/commitizen/providers/uv_provider.py @@ -0,0 +1,46 @@ +from __future__ import annotations + +from pathlib import Path + +import tomlkit +import tomlkit.items +from packaging.utils import canonicalize_name + +from commitizen.providers.base_provider import TomlProvider + + +class UvProvider(TomlProvider): + """ + uv.lock and pyproject.toml version management + """ + + filename = "pyproject.toml" + lock_filename = "uv.lock" + + @property + def lock_file(self) -> Path: + return Path() / self.lock_filename + + def set_version(self, version: str) -> None: + super().set_version(version) + self.set_lock_version(version) + + def set_lock_version(self, version: str) -> None: + pyproject_toml_content = tomlkit.parse( + self.file.read_text(encoding=self._get_encoding()) + ) + project_name = pyproject_toml_content["project"]["name"] # type: ignore[index] + normalized_project_name = canonicalize_name(str(project_name)) + + document = tomlkit.parse( + self.lock_file.read_text(encoding=self._get_encoding()) + ) + + packages: tomlkit.items.AoT = document["package"] # type: ignore[assignment] + for i, package in enumerate(packages): + if package["name"] == normalized_project_name: + document["package"][i]["version"] = version # type: ignore[index] + break + self.lock_file.write_text( + tomlkit.dumps(document), encoding=self._get_encoding() + ) diff --git a/commitizen/py.typed b/commitizen/py.typed new file mode 100644 index 0000000000..e69de29bb2 diff --git a/commitizen/question.py b/commitizen/question.py new file mode 100644 index 0000000000..043b8f3ba3 --- /dev/null +++ b/commitizen/question.py @@ -0,0 +1,33 @@ +from collections.abc import Callable +from typing import Literal, TypedDict + + +class Choice(TypedDict, total=False): + value: str + name: str + key: str + + +class ListQuestion(TypedDict, total=False): + type: Literal["list"] + name: str + message: str + choices: list[Choice] + use_shortcuts: bool + + +class InputQuestion(TypedDict, total=False): + type: Literal["input"] + name: str + message: str + filter: Callable[[str], str] + + +class ConfirmQuestion(TypedDict): + type: Literal["confirm"] + name: str + message: str + default: bool + + +CzQuestion = ListQuestion | InputQuestion | ConfirmQuestion diff --git a/commitizen/tags.py b/commitizen/tags.py new file mode 100644 index 0000000000..11b9899bed --- /dev/null +++ b/commitizen/tags.py @@ -0,0 +1,283 @@ +from __future__ import annotations + +import re +import warnings +from dataclasses import dataclass, field +from functools import cached_property +from itertools import chain +from string import Template +from typing import TYPE_CHECKING, NamedTuple + +from commitizen import out +from commitizen.defaults import DEFAULT_SETTINGS, Settings, get_tag_regexes +from commitizen.git import GitTag +from commitizen.version_schemes import ( + DEFAULT_SCHEME, + InvalidVersion, + Version, + VersionScheme, + get_version_scheme, +) + +if TYPE_CHECKING: + import sys + from collections.abc import Iterable, Sequence + + from commitizen.version_schemes import VersionScheme + + # Self is Python 3.11+ but backported in typing-extensions + if sys.version_info < (3, 11): + from typing_extensions import Self + else: + from typing import Self + + +class VersionTag(NamedTuple): + """Represent a version and its matching tag form.""" + + version: str + tag: str + + +@dataclass +class TagRules: + """ + Encapsulate tag-related rules. + + It allows to filter or match tags according to rules provided in settings: + - `tag_format`: the current format of the tags generated on `bump` + - `legacy_tag_formats`: previous known formats of the tag + - `ignored_tag_formats`: known formats that should be ignored + - `merge_prereleases`: if `True`, prereleases will be merged with their release counterpart + - `version_scheme`: the version scheme to use, which will be used to parse and format versions + + This class is meant to abstract and centralize all the logic related to tags. + To ensure consistency, it is recommended to use this class to handle tags. + + Example: + + ```python + settings = DEFAULT_SETTINGS.clone() + settings.update( + { + "tag_format": "v{version}", + "legacy_tag_formats": ["version{version}", "ver{version}"], + "ignored_tag_formats": ["ignored{version}"], + } + ) + + rules = TagRules.from_settings(settings) + + assert rules.is_version_tag("v1.0.0") + assert rules.is_version_tag("version1.0.0") + assert rules.is_version_tag("ver1.0.0") + assert not rules.is_version_tag("ignored1.0.0", warn=True) # Does not warn + assert not rules.is_version_tag("warn1.0.0", warn=True) # Does warn + + assert rules.search_version("# My v1.0.0 version").version == "1.0.0" + assert rules.extract_version("v1.0.0") == Version("1.0.0") + try: + assert rules.extract_version("not-a-v1.0.0") + except InvalidVersion: + print("Does not match a tag format") + ``` + """ + + scheme: VersionScheme = DEFAULT_SCHEME + tag_format: str = DEFAULT_SETTINGS["tag_format"] + legacy_tag_formats: Sequence[str] = field(default_factory=list) + ignored_tag_formats: Sequence[str] = field(default_factory=list) + merge_prereleases: bool = False + + @property + def tag_formats(self) -> Iterable[str]: + return chain([self.tag_format], self.legacy_tag_formats) + + @cached_property + def version_regexes(self) -> list[re.Pattern]: + """Regexes for all legit tag formats, current and legacy""" + return [re.compile(self._format_regex(f)) for f in self.tag_formats] + + @cached_property + def ignored_regexes(self) -> list[re.Pattern]: + """Regexes for known but ignored tag formats""" + return [ + re.compile(self._format_regex(f, star=True)) + for f in self.ignored_tag_formats + ] + + def _format_regex(self, tag_pattern: str, star: bool = False) -> str: + """ + Format a tag pattern into a regex pattern. + + If star is `True`, the `*` character will be considered as a wildcard. + """ + tag_regexes = get_tag_regexes(self.scheme.parser.pattern) + format_regex = tag_pattern.replace("*", "(?:.*?)") if star else tag_pattern + for pattern, regex in tag_regexes.items(): + format_regex = format_regex.replace(pattern, regex) + return format_regex + + def _version_tag_error(self, tag: str) -> str: + """Format the error message for an invalid version tag""" + return f"Invalid version tag: '{tag}' does not match any configured tag format" + + def is_version_tag(self, tag: str | GitTag, warn: bool = False) -> bool: + """ + True if a given tag is a legit version tag. + + if `warn` is `True`, it will print a warning message if the tag is not a version tag. + """ + tag = tag.name if isinstance(tag, GitTag) else tag + is_legit = any(regex.fullmatch(tag) for regex in self.version_regexes) + if warn and not is_legit and not self.is_ignored_tag(tag): + out.warn(self._version_tag_error(tag)) + return is_legit + + def is_ignored_tag(self, tag: str | GitTag) -> bool: + """True if a given tag can be ignored""" + tag = tag.name if isinstance(tag, GitTag) else tag + return any(regex.match(tag) for regex in self.ignored_regexes) + + def get_version_tags( + self, tags: Iterable[GitTag], warn: bool = False + ) -> list[GitTag]: + """Filter in version tags and warn on unexpected tags""" + return [tag for tag in tags if self.is_version_tag(tag, warn)] + + def extract_version(self, tag: GitTag) -> Version: + """ + Extract a version from the tag as defined in tag formats. + + Raises `InvalidVersion` if the tag does not match any format. + """ + candidates = ( + m for regex in self.version_regexes if (m := regex.fullmatch(tag.name)) + ) + if not (match := next(candidates, None)): + raise InvalidVersion(self._version_tag_error(tag.name)) + + if version := match.groupdict().get("version"): + return self.scheme(version) + + return self.scheme(self._extract_version(match)) + + def include_in_changelog(self, tag: GitTag) -> bool: + """Check if a tag should be included in the changelog""" + try: + version = self.extract_version(tag) + except InvalidVersion: + return False + return not (self.merge_prereleases and version.is_prerelease) + + def search_version(self, text: str, last: bool = False) -> VersionTag | None: + """ + Search the first or last version tag occurrence in text. + + It searches for complete versions only (aka `major`, `minor` and `patch`) + """ + candidates = ( + m for regex in self.version_regexes if len(m := list(regex.finditer(text))) + ) + if not (matches := next(candidates, [])): + return None + + match = matches[-1 if last else 0] + + groups = match.groupdict() + if version := groups.get("version"): + return VersionTag(version, match.group(0)) + + if not all(value in groups for value in ["major", "minor", "patch"]): + return None + + version = self._extract_version(match) + return VersionTag(version, match.group(0)) + + def normalize_tag( + self, version: Version | str, tag_format: str | None = None + ) -> str: + """ + The tag and the software version might be different. + + That's why this function exists. + + Example: + | tag | version (PEP 0440) | + | --- | ------- | + | v0.9.0 | 0.9.0 | + | ver1.0.0 | 1.0.0 | + | ver1.0.0.a0 | 1.0.0a0 | + """ + version = self.scheme(version) if isinstance(version, str) else version + tag_format = tag_format or self.tag_format + + major, minor, patch = (list(version.release) + [0, 0, 0])[:3] + prerelease = version.prerelease or "" + + t = Template(tag_format) + return t.safe_substitute( + version=version, + major=major, + minor=minor, + patch=patch, + prerelease=prerelease, + ) + + def find_tag_for( + self, tags: Iterable[GitTag], version: Version | str + ) -> GitTag | None: + """Find the first matching tag for a given version.""" + version = self.scheme(version) if isinstance(version, str) else version + release = version.release + + # If the requested version is incomplete (e.g., "1.2"), try to find the latest + # matching tag that shares the provided prefix. + if len(release) < 3: + matching_versions: list[tuple[Version, GitTag]] = [] + for tag in tags: + try: + tag_version = self.extract_version(tag) + except InvalidVersion: + continue + if tag_version.release[: len(release)] != release: + continue + matching_versions.append((tag_version, tag)) + + if matching_versions: + _, latest_tag = max(matching_versions, key=lambda vt: vt[0]) + return latest_tag + + possible_tags = set(self.normalize_tag(version, f) for f in self.tag_formats) + candidates = [t for t in tags if t.name in possible_tags] + if len(candidates) > 1: + warnings.warn( + UserWarning( + f"Multiple tags found for version {version}: {', '.join(t.name for t in candidates)}" + ) + ) + return next(iter(candidates), None) + + @classmethod + def from_settings(cls, settings: Settings) -> Self: + """Extract tag rules from settings""" + return cls( + scheme=get_version_scheme(settings), + tag_format=settings["tag_format"], + legacy_tag_formats=settings["legacy_tag_formats"], + ignored_tag_formats=settings["ignored_tag_formats"], + merge_prereleases=settings["changelog_merge_prerelease"], + ) + + def _extract_version(self, match: re.Match[str]) -> str: + groups = match.groupdict() + parts: list[str] = [groups["major"]] + if minor := groups.get("minor"): + parts.append(f".{minor}") + if patch := groups.get("patch"): + parts.append(f".{patch}") + if prerelease := groups.get("prerelease"): + parts.append(f"-{prerelease}") + if devrelease := groups.get("devrelease"): + parts.append(devrelease) + return "".join(parts) diff --git a/commitizen/templates/CHANGELOG.adoc.j2 b/commitizen/templates/CHANGELOG.adoc.j2 new file mode 100644 index 0000000000..fe16c5de3d --- /dev/null +++ b/commitizen/templates/CHANGELOG.adoc.j2 @@ -0,0 +1,19 @@ +{% for entry in tree %} + +== {{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif %} + +{% for change_key, changes in entry.changes.items() %} + +{% if change_key %} +=== {{ change_key }} +{% endif %} + +{% for change in changes %} +{% if change.scope %} +* *{{ change.scope }}*: {{ change.message }} +{% elif change.message %} +* {{ change.message }} +{% endif %} +{% endfor %} +{% endfor %} +{% endfor %} diff --git a/commitizen/templates/CHANGELOG.md.j2 b/commitizen/templates/CHANGELOG.md.j2 new file mode 100644 index 0000000000..de63880d66 --- /dev/null +++ b/commitizen/templates/CHANGELOG.md.j2 @@ -0,0 +1,19 @@ +{% for entry in tree %} + +## {{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif %} + +{% for change_key, changes in entry.changes.items() %} + +{% if change_key %} +### {{ change_key }} +{% endif %} + +{% for change in changes %} +{% if change.scope %} +- **{{ change.scope }}**: {{ change.message }} +{% elif change.message %} +- {{ change.message }} +{% endif %} +{% endfor %} +{% endfor %} +{% endfor %} diff --git a/commitizen/templates/CHANGELOG.rst.j2 b/commitizen/templates/CHANGELOG.rst.j2 new file mode 100644 index 0000000000..4287108b55 --- /dev/null +++ b/commitizen/templates/CHANGELOG.rst.j2 @@ -0,0 +1,23 @@ +{% for entry in tree %} + +{% set entry_title -%} +{{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif -%} +{%- endset %} +{{ entry_title }} +{{ "=" * entry_title|length }} +{% for change_key, changes in entry.changes.items() %} + +{% if change_key -%} +{{ change_key }} +{{ "-" * change_key|length }} +{% endif %} + +{% for change in changes %} +{% if change.scope %} +- **{{ change.scope }}**: {{ change.message }} +{% elif change.message %} +- {{ change.message }} +{% endif %} +{% endfor %} +{% endfor %} +{% endfor %} diff --git a/commitizen/templates/CHANGELOG.textile.j2 b/commitizen/templates/CHANGELOG.textile.j2 new file mode 100644 index 0000000000..db55f4caad --- /dev/null +++ b/commitizen/templates/CHANGELOG.textile.j2 @@ -0,0 +1,19 @@ +{% for entry in tree %} + +h2. {{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif %} + +{% for change_key, changes in entry.changes.items() %} + +{% if change_key %} +h3. {{ change_key }} +{% endif %} + +{% for change in changes %} +{% if change.scope %} +- *{{ change.scope }}*: {{ change.message }} +{% elif change.message %} +- {{ change.message }} +{% endif %} +{% endfor %} +{% endfor %} +{% endfor %} diff --git a/commitizen/version_schemes.py b/commitizen/version_schemes.py new file mode 100644 index 0000000000..1f17e90871 --- /dev/null +++ b/commitizen/version_schemes.py @@ -0,0 +1,428 @@ +from __future__ import annotations + +import re +import warnings +from importlib import metadata +from itertools import zip_longest +from typing import ( + TYPE_CHECKING, + Any, + ClassVar, + Literal, + Protocol, + cast, + runtime_checkable, +) + +from packaging.version import InvalidVersion # noqa: F401 (expose the common exception) +from packaging.version import Version as _BaseVersion + +from commitizen.defaults import MAJOR, MINOR, PATCH, Settings +from commitizen.exceptions import VersionSchemeUnknown + +if TYPE_CHECKING: + import sys + from typing import TypeAlias + + # Self is Python 3.11+ but backported in typing-extensions + if sys.version_info < (3, 11): + from typing_extensions import Self + else: + from typing import Self + + +Increment: TypeAlias = Literal["MAJOR", "MINOR", "PATCH"] +Prerelease: TypeAlias = Literal["alpha", "beta", "rc"] +_DEFAULT_VERSION_PARSER = re.compile( + r"v?(?P<version>([0-9]+)\.([0-9]+)(?:\.([0-9]+))?(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z.]+)?(\w+)?)" +) + + +@runtime_checkable +class VersionProtocol(Protocol): + parser: ClassVar[re.Pattern] + """Regex capturing this version scheme into a `version` group""" + + def __init__(self, version: str) -> None: + """ + Initialize a version object from its string representation. + + :raises InvalidVersion: If the ``version`` does not conform to the scheme in any way. + """ + raise NotImplementedError("must be implemented") + + def __str__(self) -> str: + """A string representation of the version that can be rounded-tripped.""" + raise NotImplementedError("must be implemented") + + @property + def scheme(self) -> VersionScheme: + """The version scheme this version follows.""" + raise NotImplementedError("must be implemented") + + @property + def release(self) -> tuple[int, ...]: + """The components of the "release" segment of the version.""" + raise NotImplementedError("must be implemented") + + @property + def is_prerelease(self) -> bool: + """Whether this version is a pre-release.""" + raise NotImplementedError("must be implemented") + + @property + def prerelease(self) -> str | None: + """The prerelease potion of the version is this is a prerelease.""" + raise NotImplementedError("must be implemented") + + @property + def public(self) -> str: + """The public portion of the version.""" + raise NotImplementedError("must be implemented") + + @property + def local(self) -> str | None: + """The local version segment of the version.""" + raise NotImplementedError("must be implemented") + + @property + def major(self) -> int: + """The first item of :attr:`release` or ``0`` if unavailable.""" + raise NotImplementedError("must be implemented") + + @property + def minor(self) -> int: + """The second item of :attr:`release` or ``0`` if unavailable.""" + raise NotImplementedError("must be implemented") + + @property + def micro(self) -> int: + """The third item of :attr:`release` or ``0`` if unavailable.""" + raise NotImplementedError("must be implemented") + + def __lt__(self, other: Any) -> bool: + raise NotImplementedError("must be implemented") + + def __le__(self, other: Any) -> bool: + raise NotImplementedError("must be implemented") + + def __eq__(self, other: object) -> bool: + raise NotImplementedError("must be implemented") + + def __ge__(self, other: Any) -> bool: + raise NotImplementedError("must be implemented") + + def __gt__(self, other: Any) -> bool: + raise NotImplementedError("must be implemented") + + def __ne__(self, other: object) -> bool: + raise NotImplementedError("must be implemented") + + def bump( + self, + increment: Increment | None, + prerelease: Prerelease | None = None, + prerelease_offset: int = 0, + devrelease: int | None = None, + is_local_version: bool = False, + build_metadata: str | None = None, + exact_increment: bool = False, + ) -> Self: + """ + Based on the given increment, generate the next bumped version according to the version scheme + + Args: + increment: The component to increase + prerelease: The type of prerelease, if Any + is_local_version: Whether to increment the local version instead + exact_increment: Treat the increment and prerelease arguments explicitly. Disables logic + that attempts to deduce the correct increment when a prerelease suffix is present. + """ + + +# With PEP 440 and SemVer semantic, Scheme is the type, Version is an instance +Version: TypeAlias = VersionProtocol +VersionScheme: TypeAlias = type[VersionProtocol] + + +class BaseVersion(_BaseVersion): + """ + A base class implementing the `VersionProtocol` for PEP440-like versions. + """ + + parser: ClassVar[re.Pattern] = _DEFAULT_VERSION_PARSER + """Regex capturing this version scheme into a `version` group""" + + @property + def scheme(self) -> VersionScheme: + return self.__class__ + + @property + def prerelease(self) -> str | None: + # version.pre is needed for mypy check + if self.is_prerelease and self.pre: + return f"{self.pre[0]}{self.pre[1]}" + return None + + def generate_prerelease( + self, prerelease: str | None = None, offset: int = 0 + ) -> str: + """Generate prerelease + + X.YaN # Alpha release + X.YbN # Beta release + X.YrcN # Release Candidate + X.Y # Final + + This function might return something like 'alpha1' + but it will be handled by Version. + """ + if not prerelease: + return "" + + # prevent down-bumping the pre-release phase, e.g. from 'b1' to 'a2' + # https://packaging.python.org/en/latest/specifications/version-specifiers/#pre-releases + # https://semver.org/#spec-item-11 + if self.is_prerelease and self.pre: + prerelease = max(prerelease, self.pre[0]) + if prerelease.startswith(self.pre[0]): + offset = self.pre[1] + 1 + + return f"{prerelease}{offset}" + + def generate_devrelease(self, devrelease: int | None) -> str: + """Generate devrelease + + The devrelease version should be passed directly and is not + inferred based on the previous version. + """ + if devrelease is None: + return "" + + return f"dev{devrelease}" + + def generate_build_metadata(self, build_metadata: str | None) -> str: + """Generate build-metadata + + Build-metadata (local version) is not used in version calculations + but added after + statically. + """ + if build_metadata is None: + return "" + + return f"+{build_metadata}" + + def increment_base(self, increment: Increment | None = None) -> str: + prev_release = list(self.release) + increments = [MAJOR, MINOR, PATCH] + base = dict(zip_longest(increments, prev_release, fillvalue=0)) + + if increment == MAJOR: + base[MAJOR] += 1 + base[MINOR] = 0 + base[PATCH] = 0 + elif increment == MINOR: + base[MINOR] += 1 + base[PATCH] = 0 + elif increment == PATCH: + base[PATCH] += 1 + + return f"{base[MAJOR]}.{base[MINOR]}.{base[PATCH]}" + + def bump( + self, + increment: Increment | None, + prerelease: Prerelease | None = None, + prerelease_offset: int = 0, + devrelease: int | None = None, + is_local_version: bool = False, + build_metadata: str | None = None, + exact_increment: bool = False, + ) -> Self: + """Based on the given increment a proper semver will be generated. + + For now the rules and versioning scheme is based on + python's PEP 0440. + More info: https://www.python.org/dev/peps/pep-0440/ + + Example: + PATCH 1.0.0 -> 1.0.1 + MINOR 1.0.0 -> 1.1.0 + MAJOR 1.0.0 -> 2.0.0 + """ + + if self.local and is_local_version: + local_version = self.scheme(self.local).bump(increment) + return self.scheme(f"{self.public}+{local_version}") # type: ignore[return-value] + + base = self._get_increment_base(increment, exact_increment) + dev_version = self.generate_devrelease(devrelease) + + release = list(self.release) + if len(release) < 3: + release += [0] * (3 - len(release)) + current_base = ".".join(str(part) for part in release) + + pre_version = ( + self if base == current_base else cast("BaseVersion", self.scheme(base)) + ).generate_prerelease(prerelease, offset=prerelease_offset) + + # TODO: post version + return self.scheme( + f"{base}{pre_version}{dev_version}{self.generate_build_metadata(build_metadata)}" + ) # type: ignore[return-value] + + def _get_increment_base( + self, increment: Increment | None, exact_increment: bool + ) -> str: + if ( + not self.is_prerelease + or exact_increment + or (increment == MINOR and self.micro != 0) + or (increment == MAJOR and (self.minor != 0 or self.micro != 0)) + ): + return self.increment_base(increment) + return f"{self.major}.{self.minor}.{self.micro}" + + +class Pep440(BaseVersion): + """ + PEP 440 Version Scheme + + See: https://peps.python.org/pep-0440/ + """ + + +class SemVer(BaseVersion): + """ + Semantic Versioning (SemVer) scheme + + See: https://semver.org/spec/v1.0.0.html + """ + + def __str__(self) -> str: + parts: list[str] = [] + + # Epoch + if self.epoch != 0: + parts.append(f"{self.epoch}!") + + # Release segment + parts.append(".".join(str(x) for x in self.release)) + + # Pre-release + if self.prerelease: + parts.append(f"-{self.prerelease}") + + # Post-release + if self.post is not None: + parts.append(f"-post{self.post}") + + # Development release + if self.dev is not None: + parts.append(f"-dev{self.dev}") + + # Local version segment + if self.local: + parts.append(f"+{self.local}") + + return "".join(parts) + + +class SemVer2(SemVer): + """ + Semantic Versioning 2.0 (SemVer2) schema + + See: https://semver.org/spec/v2.0.0.html + """ + + _STD_PRERELEASES = { + "a": "alpha", + "b": "beta", + } + + @property + def prerelease(self) -> str | None: + if self.is_prerelease and self.pre: + prerelease_type = self._STD_PRERELEASES.get(self.pre[0], self.pre[0]) + return f"{prerelease_type}.{self.pre[1]}" + return None + + def __str__(self) -> str: + parts: list[str] = [] + + # Epoch + if self.epoch != 0: + parts.append(f"{self.epoch}!") + + # Release segment + parts.append(".".join(str(x) for x in self.release)) + + if prerelease := self._get_prerelease(): + parts.append(f"-{prerelease}") + + # Local version segment + if self.local: + parts.append(f"+{self.local}") + + return "".join(parts) + + def _get_prerelease(self) -> str: + # Pre-release identifiers + # See: https://semver.org/spec/v2.0.0.html#spec-item-9 + prerelease_parts: list[str] = [] + if self.prerelease: + prerelease_parts.append(f"{self.prerelease}") + + # Post-release + if self.post is not None: + prerelease_parts.append(f"post.{self.post}") + + # Development release + if self.dev is not None: + prerelease_parts.append(f"dev.{self.dev}") + + return ".".join(prerelease_parts) + + +DEFAULT_SCHEME: VersionScheme = Pep440 + +SCHEMES_ENTRYPOINT = "commitizen.scheme" +"""Schemes entrypoints group""" + +KNOWN_SCHEMES = [ep.name for ep in metadata.entry_points(group=SCHEMES_ENTRYPOINT)] +"""All known registered version schemes""" + + +def get_version_scheme(settings: Settings, name: str | None = None) -> VersionScheme: + """ + Get the version scheme as defined in the configuration + or from an overridden `name`. + + + + :raises VersionSchemeUnknown: if the version scheme is not found. + """ + # TODO: Remove the deprecated `version_type` handling + deprecated_setting: str | None = settings.get("version_type") + if deprecated_setting: + warnings.warn( + DeprecationWarning( + "`version_type` setting is deprecated and will be removed in v5. " + "Please use `version_scheme` instead" + ) + ) + name = name or settings.get("version_scheme") or deprecated_setting + if not name: + return DEFAULT_SCHEME + + try: + (ep,) = metadata.entry_points(name=name, group=SCHEMES_ENTRYPOINT) + except ValueError: + raise VersionSchemeUnknown(f'Version scheme "{name}" unknown.') + scheme = cast("VersionScheme", ep.load()) + + if not isinstance(scheme, VersionProtocol): + warnings.warn(f"Version scheme {name} does not implement the VersionProtocol") + + return scheme diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..b4b97884ab --- /dev/null +++ b/docs/README.md @@ -0,0 +1,320 @@ +[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/commitizen-tools/commitizen/pythonpackage.yml?label=python%20package&logo=github&logoColor=white&style=flat-square)](https://github.com/commitizen-tools/commitizen/actions) +[![Check Links](https://github.com/commitizen-tools/commitizen/actions/workflows/links.yml/badge.svg)](https://github.com/commitizen-tools/commitizen/actions/workflows/links.yml) +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org) +[![PyPI Package latest release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/) +[![PyPI Package download count (per month)](https://img.shields.io/pypi/dm/commitizen?style=flat-square)](https://pypi.org/project/commitizen/) +[![Supported versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/) +[![Conda Version](https://img.shields.io/conda/vn/conda-forge/commitizen?style=flat-square)](https://anaconda.org/conda-forge/commitizen) +[![homebrew](https://img.shields.io/homebrew/v/commitizen?color=teal&style=flat-square)](https://formulae.brew.sh/formula/commitizen) +[![Codecov](https://img.shields.io/codecov/c/github/commitizen-tools/commitizen.svg?style=flat-square)](https://codecov.io/gh/commitizen-tools/commitizen) +[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json&style=flat-square&color=brightgreen)](https://github.com/j178/prek) + +![Using Commitizen cli](images/cli_interactive/commit.gif) + +--- + +[**Commitizen Documentation Site**](https://commitizen-tools.github.io/commitizen/) + +--- + +## About + +Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management. + +### What Commitizen Does + +By enforcing standardized commit conventions (defaulting to [Conventional Commits][conventional_commits]), Commitizen helps teams: + +- Write clear, structured commit messages +- Automatically manage version numbers using semantic versioning +- Generate and maintain changelogs +- Streamline the release process + +### Key Benefits + +With just a simple `cz bump` command, Commitizen handles: + +1. **Version Management**: Automatically bumps version numbers and updates version files based on your commit history +2. **Changelog Generation**: Creates and updates changelogs following the [Keep a changelog][keepchangelog] format +3. **Commit Standardization**: Enforces consistent commit message formats across your team + +This standardization makes your commit history more readable and meaningful, while the automation reduces manual work and potential errors in the release process. + +### Features + +- Interactive CLI for standardized commits with default [Conventional Commits][conventional_commits] support +- Intelligent [version bumping](https://commitizen-tools.github.io/commitizen/commands/bump/) using [Semantic Versioning][semver] +- Automatic [keep a changelog][keepchangelog] generation +- Built-in commit validation with pre-commit hooks +- [Customizable](https://commitizen-tools.github.io/commitizen/customization/config_file/) commit rules and templates +- Multi-format version file support +- Custom rules and plugins via pip + +## Getting Started + +### Requirements + +Before installing Commitizen, ensure you have: + +- [Python](https://www.python.org/downloads/) `3.10+` +- [Git][gitscm] `1.8.5.2+` + +### Installation + +#### Global Installation (Recommended) + +The recommended way to install Commitizen is using [`pipx`](https://pipx.pypa.io/) or [`uv`](https://docs.astral.sh/uv/), which ensures a clean, isolated installation: + +**Using pipx:** +```bash +# Install Commitizen +pipx install commitizen + +# Keep it updated +pipx upgrade commitizen +``` + +**Using uv:** +```bash +# Install commitizen +uv tool install commitizen + +# Keep it updated +uv tool upgrade commitizen +``` + +**(For macOS users) Using Homebrew:** +```bash +brew install commitizen +``` + +#### Project-Specific Installation + +You can add Commitizen to your Python project using any of these package managers: + +**Using pip:** +```bash +pip install -U commitizen +``` + +**Using conda:** +```bash +conda install -c conda-forge commitizen +``` + +**Using Poetry:** +```bash +# For Poetry >= 1.2.0 +poetry add commitizen --group dev + +# For Poetry < 1.2.0 +poetry add commitizen --dev +``` + +**Using uv:** +```bash +uv add --dev commitizen +``` + +**Using pdm:** +```bash +pdm add -d commitizen +``` + +### Basic Commands + +#### Initialize Commitizen + +To get started, run the `cz init` command. This will guide you through the process of creating a configuration file with your preferred settings. + +#### Create Commits + +Create standardized commits using: +```sh +cz commit +# or use the shortcut +cz c +``` + +To sign off your commits: +```sh +cz commit -- --signoff +# or use the shortcut +cz commit -- -s +``` + +For more commit options, run `cz commit --help`. + +#### Version Management + +The most common command you'll use is: +```sh +cz bump +``` + +This command: + +- Bumps your project's version +- Creates a git tag +- Updates the changelog (if `update_changelog_on_bump` is enabled) +- Updates version files + +You can customize: + +- [Version files](https://commitizen-tools.github.io/commitizen/commands/bump/#version_files) +- [Version scheme](https://commitizen-tools.github.io/commitizen/commands/bump/#version_scheme) +- [Version provider](https://commitizen-tools.github.io/commitizen/config/version_provider/) + +For all available options, see the [bump command documentation](https://commitizen-tools.github.io/commitizen/commands/bump/). + +### Advanced Usage + +#### Get Project Version + +```sh +# Get your project's version (instead of Commitizen's version) +cz version -p +# Preview changelog changes +cz changelog --dry-run "$(cz version -p)" +``` + +This command is particularly useful for automation scripts and CI/CD pipelines. + +For example, you can use the output of the command `cz changelog --dry-run "$(cz version -p)"` to notify your team about a new release in Slack. + +#### Prek and Pre-commit Integration + +Commitizen can automatically validate your commit messages using pre-commit hooks. + +1. Add to your `.pre-commit-config.yaml`: +```yaml +--- +repos: + - repo: https://github.com/commitizen-tools/commitizen + rev: master # Replace with latest tag + hooks: + - id: commitizen + - id: commitizen-branch + stages: [pre-push] +``` + +2. Install the hooks: +```sh +prek install --hook-type commit-msg --hook-type pre-push +``` + +| Hook | Recommended Stage | +| ----------------- | ----------------- | +| commitizen | commit-msg | +| commitizen-branch | pre-push | + +> **Note**: Replace `master` with the [latest tag](https://github.com/commitizen-tools/commitizen/tags) to avoid warnings. You can automatically update this with: +> ```sh +> prek autoupdate +> ``` + +For more details about commit validation, see the [check command documentation](https://commitizen-tools.github.io/commitizen/commands/check/). + +## Help & Reference + +### Command Line Interface + +Commitizen provides a comprehensive CLI with various commands. Here's the complete reference: + +![cz --help](images/cli_help/cz___help.svg) + +### Quick Reference + +| Command | Description | Alias | +|---------|-------------|-------| +| `cz init` | Initialize Commitizen configuration | - | +| `cz commit` | Create a new commit | `cz c` | +| `cz bump` | Bump version and update changelog | - | +| `cz changelog` | Generate changelog | `cz ch` | +| `cz check` | Validate commit messages | - | +| `cz version` | Show version information | - | + +### Additional Resources + +- [Conventional Commits Specification][conventional_commits] +- [Exit Codes Reference](https://commitizen-tools.github.io/commitizen/exit_codes/) +- [Configuration Guide](https://commitizen-tools.github.io/commitizen/config/configuration_file/) +- [Command Documentation](https://commitizen-tools.github.io/commitizen/commands/init/) + +### Getting Help + +For each command, you can get detailed help by adding `--help`: + +```sh +cz commit --help +cz bump --help +cz changelog --help +``` + +For more details, visit our [documentation site](https://commitizen-tools.github.io/commitizen/). + +## Setting up bash completion + +Commitizen supports command-line completion through [argcomplete](https://kislyuk.github.io/argcomplete/), which is automatically installed as a dependency. This feature provides intelligent auto-completion for all Commitizen commands and options. + +### Supported Shells + +- **Bash**: Full support +- **Zsh**: Limited support +- **Fish**: Limited support +- **Tcsh**: Limited support + +### Installation Methods + +#### Global Installation (Recommended) + +If you installed Commitizen globally (e.g., using `pipx` or `brew`), you can enable global completion: + +```bash +# Enable global completion for all Python applications +sudo activate-global-python-argcomplete +``` + +#### User-Specific Installation + +For a user-specific installation that persists across sessions: + +```bash +# Add to your shell's startup file (e.g., ~/.bashrc, ~/.zshrc) +register-python-argcomplete cz >> ~/.bashrc +``` + +#### Temporary Installation + +For one-time activation in your current shell session: + +```bash +# Activate completion for current session only +eval "$(register-python-argcomplete cz)" +``` + +### Verification + +After installation, you can verify the completion is working by: + +1. Opening a new terminal session +2. Typing `cz` followed by a space and pressing `TAB` twice +3. You should see a list of available commands + +For more detailed information about argcomplete configuration and troubleshooting, visit the [argcomplete documentation](https://kislyuk.github.io/argcomplete/). + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=commitizen-tools/commitizen)](https://star-history.com/#commitizen-tools/commitizen) + + +## Sponsors + +These are our cool sponsors! + +<!-- sponsors --><!-- sponsors --> + +[conventional_commits]: https://www.conventionalcommits.org +[semver]: https://semver.org/ +[keepchangelog]: https://keepachangelog.com/ +[gitscm]: https://git-scm.com/downloads diff --git a/docs/bump.md b/docs/bump.md deleted file mode 100644 index 6a0a4a542a..0000000000 --- a/docs/bump.md +++ /dev/null @@ -1,173 +0,0 @@ -![Bump version](images/bump.gif) - -## About - -The version is bumped **automatically** based on the commits. - -The commits should follow the rules of the commiter in order to be parsed properly. - -It is possible to specify a **prerelease** (alpha, beta, release candidate) version. - -The version can also be **manually** bumped. - -The version format follows [semantic versioning][semver]. - -This means `MAJOR.MINOR.PATCH` - -| Increment | Description | Conventional commit map | -| --------- | --------------------------- | ----------------------- | -| `MAJOR` | Breaking changes introduced | `BREAKING CHANGE` | -| `MINOR` | New features | `feat` | -| `PATCH` | Fixes | `fix` + everything else | - -Prereleases are supported following python's [PEP 0440][pep440] - -The scheme of this format is - -```bash -[N!]N(.N)*[{a|b|rc}N][.postN][.devN] -``` - -Some examples: - -```bash -0.9.0 -0.9.1 -0.9.2 -0.9.10 -0.9.11 -1.0.0a0 # alpha -1.0.0a1 -1.0.0b0 # beta -1.0.0rc0 # release candidate -1.0.0rc1 -1.0.0 -1.0.1 -1.1.0 -2.0.0 -2.0.1a -``` - -`post` and `dev` releases are not supported yet. - -## Usage - -```bash -$ cz bump --help -usage: cz bump [-h] [--dry-run] [--tag-format TAG_FORMAT] - [--prerelease {alpha,beta,rc}] - [--increment {MAJOR,MINOR,PATCH}] - -optional arguments: - -h, --help show this help message and exit - --dry-run show output to stdout, no commit, no modified files - --tag-format TAG_FORMAT - format used to tag the commmit and read it, use it in - existing projects, wrap around simple quotes. - --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc} - choose type of prerelease - --increment {MAJOR,MINOR,PATCH} - manually specify the desired increment -``` - -## Configuration - -### `tag_format` - -Used to read the format from the git tags, and also to generate the tags. - -Supports 2 types of formats, a simple and a more complex. - -```bash -cz bump --tag_format="v$version" -``` - -```bash -cz bump --tag_format="v$minor.$major.$path$prerelease" -``` - -In your `pyproject.toml` - - [tool.commitizen] - tag_format = "v$minor.$major.$path$prerelease" - -Or in your `.cz` - - [commitizen] - tag_format = v$minor.$major.$path$prerelease - -The variables must be preceded by a `$` sign. - -Suppported variables: - -| Variable | Description | -| ------------- | ------------------------------------------ | -| `$version` | full generated version | -| `$major` | MAJOR increment | -| `$minor` | MINOR increment | -| `$patch` | PATCH increment | -| `$prerelease` | Prerelase (alpha, beta, release candidate) | - ---- - -### `files` - -Used to identify the files which should be updated with the new version. -It is also possible to provide a pattern for each file, separated by colons (`:`). - -Commitizen will update it's configuration file automatically (`pyproject.toml`, `.cz`) when bumping, -regarding if the file is present or not in `files`. - -Some examples - -`pyproject.toml` - - [tool.commitizen] - files = [ - "src/__version__.py", - "setup.py:version" - ] - -`.cz` - - [commitizen] - files = [ - "src/__version__.py", - "setup.py:version" - ] - -In the example above, we can see the reference `"setup.py:version"`. -This means that it will find a file `setup.py` and will only make a change -in a line containing the `version` substring. - ---- - -### `bump_message` - -Template used to specify the commit message generated when bumping - -defaults to: `bump: version $current_version → $new_version` - -| Variable | Description | -| ------------------ | ----------------------------------- | -| `$current_version` | the version existing before bumping | -| `$new_version` | version generated after bumping | - -Some examples - -`pyproject.toml` - - [tool.commitizen] - bump_message = "release $current_version → $new_version [skip-ci]" - -`.cz` - - [commitizen] - bump_message = release $current_version → $new_version [skip-ci] - -## Custom bump - -Read the [customizing section](./customization.md). - -[pep440]: https://www.python.org/dev/peps/pep-0440/ -[semver]: https://semver.org/ diff --git a/docs/commands/bump.md b/docs/commands/bump.md new file mode 100644 index 0000000000..51293bca4b --- /dev/null +++ b/docs/commands/bump.md @@ -0,0 +1,530 @@ +![Bump version](../images/cli_interactive/bump.gif) + +## About + +`cz bump` is a powerful command that **automatically** determines and increases your project's version number based on your commit history. + +It analyzes your commits to determine the appropriate version increment according to semantic versioning principles. + +!!! note + In the following documentation, the term "configuration file" refers to `pyproject.toml`, `.cz.toml` or other configuration files. + + We will use `pyproject.toml` as the configuration file throughout the documentation. + + See [Configuration file](../config/configuration_file.md) for more details. + +## Key Features + +- **Automatic Version Detection**: Analyzes commit history to determine the appropriate version bump +- **Manual Version Control**: Supports manual version specification when needed +- **Pre-release Support**: Handles alpha, beta, and release candidate versions +- **Multiple Version Schemes**: Supports both [PEP 440][pep440] and [semantic versioning][semver] formats + +### Version Increment Rules + +The version follows the `MAJOR.MINOR.PATCH` format, with increments determined by your commit types: + +| Increment | Description | Conventional commit map | +| --------- | --------------------------- | ----------------------- | +| `MAJOR` | Breaking changes introduced | `BREAKING CHANGE`, bang (e.g. `feat!`)| +| `MINOR` | New features | `feat` | +| `PATCH` | Fixes and improvements | `fix`, `perf`, `refactor`| + +### `--version-scheme` + +By default, Commitizen uses [PEP 440][pep440] for version formatting. You can switch to semantic versioning using either: + +1. Command line: +```sh +cz bump --version-scheme semver +``` + +2. Configuration file: +```toml title="pyproject.toml" +[tool.commitizen] +version_scheme = "semver" +``` + +Available options are: + +- `pep440`: [PEP 440][pep440] (**default** and recommended for Python projects) +- `semver`: [Semantic Versioning][semver] (recommended for non-Python projects) + +You can also set this in the configuration file with `version_scheme = "semver"`. + +!!! note + [pep440][pep440] and [semver][semver] are quite similar, although their difference lies in + how the prereleases look. For example, `0.3.1a0` in pep440 is equivalent to `0.3.1-a0` in semver. + + The following table illustrates the difference between the two schemes: + + | Version Type | pep440 | semver | + |--------------|----------------|-----------------| + | Non-prerelease | `0.1.0` | `0.1.0` | + | Prerelease | `0.3.1a0` | `0.3.1-a0` | + | Devrelease | `0.1.1.dev1` | `0.1.1-dev1` | + | Dev and pre | `1.0.0a3.dev1` | `1.0.0-a3-dev1` | + + +!!! note "Incomplete Version Handling" + Commitizen treats a three-part version (major.minor.patch) as complete. + If your configured version is incomplete (for example, `1` or `1.2`), Commitizen pads missing parts with zeros when it needs `major/minor/patch` for tag formatting. + The tag output depends on your `tag_format`: formats using `${version}` keep `1`/`1.2`, while formats using `${major}.${minor}.${patch}` will render `1.0.0`/`1.2.0`. + + When bumping from an incomplete version, Commitizen looks for the latest existing tag that matches the provided release prefix. + For example, if the current version is `1.2` and the latest `1.2.x` tag is `1.2.3`, then a patch bump yields `1.2.4` and a minor bump yields `1.3.0`. + +!!! tip + To control the behaviour of bumping and version parsing, you may implement your own `version_scheme` by inheriting from `commitizen.version_schemes.BaseVersion` or use an existing plugin package. + + +### PEP440 Version Examples + +Commitizen supports the [PEP 440][pep440] version format, which includes several version types. Here are examples of each: + +#### Standard Releases +```text +0.9.0 # Initial development release +0.9.1 # Patch release +0.9.2 # Another patch release +0.9.10 # Tenth patch release +0.9.11 # Eleventh patch release +1.0.0 # First stable release +1.0.1 # Patch release after stable +1.1.0 # Minor feature release +2.0.0 # Major version release +``` + +#### Pre-releases +```text +1.0.0a0 # Alpha release 0 +1.0.0a1 # Alpha release 1 +1.0.0b0 # Beta release 0 +1.0.0rc0 # Release candidate 0 +1.0.0rc1 # Release candidate 1 +``` + +#### Development Releases +```text +1.0.0.dev0 # Development release 0 +1.0.0.dev1 # Development release 1 +``` + +#### Combined Pre-release and Development +```text +1.0.0a1.dev0 # Development release 0 of alpha 1 +1.0.0b2.dev1 # Development release 1 of beta 2 +``` + +> **Note**: `post` releases (e.g., `1.0.0.post1`) are not currently supported. + +## Command line options + +![cz bump --help](../images/cli_help/cz_bump___help.svg) + +### `--version-files-only` + +Bumps the version in the files defined in [`version_files`][version_files] without creating a commit and tag on the git repository. + +```bash +cz bump --version-files-only +``` + +### `--changelog` + +Generate a **changelog** along with the new version and tag when bumping. See [changelog](./changelog.md) for more details. + +```bash +cz bump --changelog +``` + +### `--prerelease` + +The bump is a pre-release bump, meaning that in addition to a possible version bump the new version receives a +pre-release segment compatible with the bump's version scheme, where the segment consists of a _phase_ and a +non-negative number. Supported options for `--prerelease` are the following phase names `alpha`, `beta`, or +`rc` (release candidate). For more details, refer to the +[Python Packaging User Guide](https://packaging.python.org/en/latest/specifications/version-specifiers/#pre-releases). + +Note that as per [semantic versioning spec](https://semver.org/#spec-item-9) + +> Pre-release versions have a lower precedence than the associated normal version. A pre-release version +> indicates that the version is unstable and might not satisfy the intended compatibility requirements +> as denoted by its associated normal version. + +For example, the following versions (using the [PEP 440](https://peps.python.org/pep-0440/) scheme) are ordered +by their precedence and showcase how a release might flow through a development cycle: + +- `1.0.0` is the currently published version +- `1.0.1a0` after committing a `fix:` for pre-release +- `1.1.0a1` after committing an additional `feat:` for pre-release +- `1.1.0b0` after bumping a beta release +- `1.1.0rc0` after bumping the release candidate +- `1.1.0` next feature release + +### `--increment-mode` + +#### `--increment-mode=linear` (default) + +Ensures that bumping pre-releases **maintains linearity**. + +Bumping a pre-release with lower precedence than the current pre-release phase maintains the current phase of higher precedence. +For example, if the current version is `1.0.0b1` then bumping with `--prerelease alpha` will continue to bump the *beta* phase. + +#### `--increment-mode=exact` + +Applies the exact changes that have been specified with `--increment` or determined from the commit log. +For example, `--prerelease beta` will always result in a `b` tag, and `--increment PATCH` will always increase the patch component. + +#### Examples + +The following table illustrates the difference in behavior between the two modes: + +| Increment | Pre-release | Start Version | `--increment-mode=linear` | `--increment-mode=exact` | +|-----------|-------------|---------------|---------------------------|--------------------------| +| `MAJOR` | | `2.0.0b0` | `2.0.0` | `3.0.0` | +| `MINOR` | | `2.0.0b0` | `2.0.0` | `2.1.0` | +| `PATCH` | | `2.0.0b0` | `2.0.0` | `2.0.1` | +| `MAJOR` | `alpha` | `2.0.0b0` | `3.0.0a0` | `3.0.0a0` | +| `MINOR` | `alpha` | `2.0.0b0` | `2.0.0b1` | `2.1.0a0` | +| `PATCH` | `alpha` | `2.0.0b0` | `2.0.0b1` | `2.0.1a0` | + +### `--check-consistency` + +Check whether the versions defined in [version_files][version_files] and the version in Commitizen configuration are consistent before bumping version. + +```bash +cz bump --check-consistency +``` + +For example, if we have the following configuration file `pyproject.toml`: + +```toml title="pyproject.toml" +[tool.commitizen] +version = "1.21.0" +version_files = [ + "src/__version__.py", + "setup.py", +] +``` + +and the following version files `src/__version__.py` and `setup.py`: + +```python title="src/__version__.py" +__version__ = "1.21.0" +``` + +```python title="setup.py" +from setuptools import setup + +setup(..., version="1.0.5", ...) +``` + +When you run `cz bump --check-consistency`, Commitizen will verify that the current version in `pyproject.toml` (`1.21.0`) exists in all files listed in [version_files][version_files]. +In this example, it will detect that `setup.py` contains `1.0.5` instead of `1.21.0`, causing the bump to fail. + +!!! warning "Partial updates on failure" + If the consistency check fails, Commitizen may have already updated some files (like `pyproject.toml` and `src/__version__.py`) before detecting the inconsistency. + In this case, you'll need to restore the files to their previous state. + + To resolve this issue: + + 1. Restore the modified files to their previous state: + ```bash + git checkout . + ``` + + 2. Manually update the version in `setup.py` to match the version in `pyproject.toml`: + ```diff title="setup.py" + from setuptools import setup + + - setup(..., version="1.0.5", ...) + + setup(..., version="1.21.0", ...) + ``` + + 3. Run the bump command again: + ```bash + cz bump --check-consistency + ``` + +### `--local-version` + +Bump the local portion of the version. + +For example, if we have the following configuration file `pyproject.toml`: + +```toml title="pyproject.toml" +[tool.commitizen] +version = "5.3.5+0.1.0" +``` + +When you run `cz bump --local-version`, it will bump only the local version `0.1.0` and keep the public version `5.3.5` intact, bumping to the version `5.3.5+0.2.0`. + +### `--annotated-tag` + +Create annotated tags. + +It is also available via configuration files. + +For example, in `pyproject.toml`: + +```toml title="pyproject.toml" +[tool.commitizen] +annotated_tag = true +``` + +!!! note + By default, Commitizen uses lightweight tags. + +### `--annotated-tag-message` + +Create annotated tags with the given message. + +It is also available via configuration files. + +For example, in `pyproject.toml`: + +```toml title="pyproject.toml" +[tool.commitizen] +annotated_tag_message = "Annotated tag message" +``` + +### `--changelog-to-stdout` + +Send the incremental changelog generated by `cz bump` to `stdout`. +Any other messages generated by `cz bump` will be sent to `stderr`. + +When this flag is used, `--changelog` is implied. +However, it is recommended to set `--changelog` (or the setting `update_changelog_on_bump`) explicitly when the option `--changelog-to-stdout` is used. + +!!! note "Useful scenarios" + Pipe the newly created changelog to another tool. + + The output can be redirected to an auditing system, or used to create a GitHub Release, etc. + + ```bash + cz bump --changelog --changelog-to-stdout > body.md + ``` + +### `--git-output-to-stderr` + +Redirects git commands output to `stderr`. + +Useful when used with `--changelog-to-stdout` and piping the output to a file. + +For example, `git commit` output may pollute `stdout`, so it is recommended to use this flag when piping the output to a file. + +### `--retry` + +If you use tools like [pre-commit](https://pre-commit.com/), you can add this flag. +It will retry the commit if it fails the first time. + +Useful to combine with code formatters, like [Prettier](https://prettier.io/). + +### `--major-version-zero` + +Breaking changes do not bump the major version number. + +Say you have a project with the version `0.1.x` and you commit a breaking change like this: + +```text +fix(magic)!: fully deprecate whatever +``` + +and you run + +```bash +cz bump --major-version-zero +``` + +Then the version of your project will be bumped to `0.2.0` instead of `1.0.0`. + +!!! note + A project in its initial development should have a major version zero, + and even breaking changes should not bump that major version from zero. This command ensures that behavior. + + We recommend setting `major_version_zero = true` in your configuration file while a project + is in its initial development. Remove that configuration using a breaking-change commit to bump + your project's major version to `v1.0.0` once your project has reached maturity. + +!!! warning + This option is only compatible with projects that have major version number zero, `0.x.x` for example. + + It fails when used with projects that have a version number greater than zero like `1.x.x`. + + If used together with a manual version, the command also fails. + + ```bash + # This fails + cz bump 0.1.0 --major-version-zero + ``` + +### `--gpg-sign` + +Creates gpg signed tags. + +```bash +cz bump --gpg-sign +``` + +!!! note + By default, Commitizen uses lightweight tags. + +### `--template` + +Provides your own changelog jinja template. +See [the template customization section](../customization/changelog_template.md) + +### `--extra` + +Provides your own changelog extra variables by using the `extras` settings or the `--extra/-e` parameter. + +```bash +cz bump --changelog --extra key=value -e short="quoted value" +``` + +See [the template customization section](../customization/changelog_template.md). + +### `--build-metadata` + +Specifies additional metadata in the version string. + +```bash +# creates a version like `1.1.2+yourmetadata`. +cz bump --build-metadata yourmetadata +``` + +!!! note "Example usage" + - Git hash in version + - Labeling the version with additional metadata. + +!!! note + Commitizen ignores everything after `+` when it bumps the version. + + It is therefore safe to write different build-metadata between versions. + + +!!! warning + Normally, you should not use this functionality, but if you decide to do so, keep in mind that: + + - Version `1.2.3+a`, and `1.2.3+b` are the same version! Tools should not use the string after `+` for version calculation. This is probably not a guarantee (example in helm) even tho it is in the spec. + - It might be problematic having the metadata in place when doing upgrades depending on what tool you use. + +!!! warning + This parameter is not compatible with `--local-version` as it uses the same part of the version string. + +### `--get-next` + +Similar to `--dry-run` but only outputs the next version. + +```bash +# outputs 1.0.1 if the current version is 1.0.0 and the increment is PATCH +cz bump --get-next +``` + +Useful for determining the next version based on CI for non-production environments/builds. + +!!! note "Compare with `--dry-run`" + `--dry-run` provides a more detailed output including the changes as they would appear in the changelog file, while `--get-next` only outputs the next version. + + The following is the output of `cz bump --dry-run`: + + ```text + bump: version 3.28.0 → 3.29.0 + tag to create: v3.29.0 + increment detected: MINOR + ``` + + The following is the output of `cz bump --get-next`: + + ```text + 3.29.0 + ``` + +!!! warning + The `--get-next` flag will raise a `NoneIncrementExit` if the found commits are not eligible for a version bump. + + For information on how to suppress this exit, see [Ignoring Exit Codes](../exit_codes.md#ignoring-exit-codes). + +### `--allow-no-commit` + +Allow the project version to be bumped even when there's no eligible version. + +Example usage: + +```sh +# Force to bump a minor version +cz bump --increment MINOR --allow-no-commit + +# bump version to 2.0.0 even when there's no breaking changes or even no commits +cz bump --allow-no-commit 2.0.0 +``` + +!!! note "Default increment" + The increment is overridden to `PATCH` if there is no increment detected or specified. + + In other words, `cz bump --allow-no-commit` allows you to bump the version to the next patch version even when there is no eligible commit. + + ```sh + # will bump to `1.0.1` if the current version is `1.0.0`. + cz bump --allow-no-commit + + # bump version to 2.0.0 even when there's no breaking changes or even no commits + cz bump --allow-no-commit 2.0.0 + ``` + +### `--tag-format` + +`tag_format` and [version_scheme][version_scheme] are combined to make Git tag names from versions. + +These are used in: + +- `cz bump`: Find previous release tag (exact match) and generate new tag. +- Find previous release tags in `cz changelog`. + - If `--incremental`: Using the latest version found in the changelog, scan existing Git tags with 89\% similarity match. + - `--rev-range` is converted to Git tag names with `tag_format` before searching Git history. +- If the `scm` `version_provider` is used, it uses different regexes to find the previous version tags: + - If `tag_format` is set to `$version` (default): `VersionProtocol.parser` (allows `v` prefix) + - If `tag_format` is set: Custom regex similar to SemVer (not as lenient as PEP440 e.g. on dev-releases) + +Commitizen supports two types of formats, a simple and a more complex. + +```bash +cz bump --tag-format="v$version" +``` + +```bash +cz bump --tag-format="v$minor.$major.$patch$prerelease.$devrelease" +``` + +In your configuration file: + +```toml +[tool.commitizen] +tag_format = "v$major.$minor.$patch$prerelease" +``` + +The variables must be preceded by a `$` sign and optionally can be wrapped in `{}`. The default is `$version`. + +Supported variables: + +| Variable | Description | +|--------------------------------|---------------------------------------------| +| `$version`, `${version}` | fully generated version | +| `$major`, `${major}` | MAJOR increment | +| `$minor`, `${minor}` | MINOR increment | +| `$patch`, `${patch}` | PATCH increment | +| `$prerelease`, `${prerelease}` | Prerelease (alpha, beta, release candidate) | +| `$devrelease`, `${devrelease}` | Development release | + +### `--yes` + +Automatically answers “yes” to all interactive prompts during the bump process, allowing the command to run without manual confirmation. + +```bash +cz bump --yes +``` + +[pep440]: https://www.python.org/dev/peps/pep-0440/ +[semver]: https://semver.org/ +[version_files]: ../config/bump.md#version_files diff --git a/docs/commands/changelog.md b/docs/commands/changelog.md new file mode 100644 index 0000000000..da40eb6fbe --- /dev/null +++ b/docs/commands/changelog.md @@ -0,0 +1,184 @@ +## About + +Generates a changelog following the committing rules established. + +!!! tip + To create the changelog automatically on bump, add the setting [update_changelog_on_bump](../config/bump.md#update_changelog_on_bump) + + ```toml + [tool.commitizen] + update_changelog_on_bump = true + ``` + +## Usage + +![cz changelog --help](../images/cli_help/cz_changelog___help.svg) + +## Examples + +```bash +# Generate full changelog +cz changelog + +# Or use the alias +cz ch + +# Get the changelog for the given version +cz changelog 0.3.0 --dry-run + +# Get the changelog for the given version range +cz changelog 0.3.0..0.4.0 --dry-run +``` + +## Constraints + +Changelog generation is constrained only to **markdown** files. + +## Description + +These are the variables used by the changelog generator. + +```md +# <version> (<date>) + +## <change_type> + +- **<scope>**: <message> +``` + +Creates a full block like above per version found in the tags, and a list of the commits found. +The `change_type` and `scope` are optional and don't need to be provided, +but if your regex parses them, they will be rendered. + +The format followed by the changelog is from [keep a changelog][keepachangelog] +and the following variables are expected: + +| Variable | Description | Source | +| ------------- | ---------------------------------------------------------------------------------------------- | -------------- | +| `version` | Version number which should follow [semver][semver] | `tags` | +| `date` | Date when the tag was created | `tags` | +| `change_type` | The group where the commit belongs to, this is optional. Example: fix | `commit regex` | +| `message` | Information extracted from the commit message | `commit regex` | +| `scope` | Contextual information. Should be parsed using the regex from the message, it will be **bold** | `commit regex` | +| `breaking` | Whether it is a breaking change or not | `commit regex` | + +!!! note + `message` is the only variable required to be parsed by the regex. + +## Command line options + +### `--extras` + +Provide your own changelog extra variables by using the `extras` settings or the `--extra/-e` parameter. + +```bash +cz changelog --extra key=value -e short="quoted value" +``` + +### `--file-name` + +This value can be updated in the configuration file with the key `changelog_file` under `tool.commitizen`. + +Specify the name of the output file. Note that changelog generation only works with Markdown files. + +```bash +cz changelog --file-name="CHANGES.md" +``` + +### `--incremental` + +This flag can be set in the configuration file with the key `changelog_incremental` under `tool.commitizen` + +Benefits: + +- Build from the latest version found in changelog. This is useful if you have an existing changelog and want to use commitizen to extend it. +- Update unreleased area +- Allows users to manually edit the changelog without it being completely rewritten. + +```bash +cz changelog --incremental +``` + +```toml +[tool.commitizen] +# ... +changelog_incremental = true +``` + +### `--start-rev` + +This value can be set in the configuration file with the key `changelog_start_rev` under `tool.commitizen` + +Start from a given git rev to generate the changelog. Commits before that rev will not be considered. This is especially useful for long-running projects adopting conventional commits, where old commit messages might fail to be parsed for changelog generation. + +```bash +cz changelog --start-rev="v0.2.0" +``` + +```toml +[tool.commitizen] +# ... +changelog_start_rev = "v0.2.0" +``` + +### `--merge-prerelease` + +This flag can be set in the configuration file with the key `changelog_merge_prerelease` under `tool.commitizen` + +Collects changes from prereleases into the next non-prerelease version. If you have a prerelease version followed by a normal release, the changelog will show the prerelease changes as part of the normal release. If not set, prereleases will be included as separate entries in the changelog. + +```bash +cz changelog --merge-prerelease +``` + +```toml +[tool.commitizen] +# ... +changelog_merge_prerelease = true +``` + +### `--template` + +Provide your own changelog Jinja template by using the `template` settings or the `--template` parameter. + +```bash +cz changelog --template="path/to/template.j2" +``` + +### `--unreleased-version` + +There is usually a chicken-and-egg situation when automatically bumping the version and creating the changelog: + +- If you bump the version first, you have no changelog yet, and it won't be included in the release of the created version. +- If you create the changelog before bumping the version, you usually don't have the latest tag, and the _Unreleased_ title appears. + +By using `--unreleased-version`, you can prevent this situation. + +Before bumping you can run: + +```bash +cz changelog --unreleased-version="v1.0.0" +``` + +Remember to use the tag format instead of the raw version number. + +For example, if your tag format includes a `v` prefix (e.g., `v1.0.0`), use that format. If your tag is the same as the raw version (e.g., `1.0.0`), use the raw version. + +Alternatively, you can directly bump the version and create the changelog by running: + +```bash +cz bump --changelog +``` + +## Hooks + +Supported hook methods: + +- Per parsed message: Useful to add links to commits or issues +- End of changelog generation: Useful to send Slack or chat messages, or notify another department + +Read more about hooks in the [customization page][customization] + +[keepachangelog]: https://keepachangelog.com/ +[semver]: https://semver.org/ +[customization]: ../customization/config_file.md diff --git a/docs/commands/check.md b/docs/commands/check.md new file mode 100644 index 0000000000..ef7f8f5f90 --- /dev/null +++ b/docs/commands/check.md @@ -0,0 +1,164 @@ +This feature checks whether a string or a range of git commits follows the given committing rules. Comments in git messages will be ignored. + +To set up an automatic check before every git commit, please refer to [Automatically check message before commit](../tutorials/auto_check.md). + +## Usage + +![cz check --help](../images/cli_help/cz_check___help.svg) + +More specifically, there are three mutually exclusive ways to use `cz check`: + +- Validate a range of git commit messages with `--rev-range` +- Validate a given string with `--message` or by piping the message to it +- Validate a commit message from a file with `--commit-msg-file` + +### Use `cz check` to validate a commit message before committing + +#### Option 1: use `--message` to check a given string: + +```bash +cz check --message <message_to_be_checked> +``` + +#### Option 2: pipe the message to `cz check`: +```bash +echo <message_to_be_checked> | cz check +``` + +#### Option 3: use `--commit-msg-file` to read the commit message from a file +```bash +cz check --commit-msg-file /path/to/file.txt +``` + +## Command Line Options + +### `--rev-range` + +Test if a given range of commits in the git log passes `cz check`. + +```bash +cz check --rev-range REV_RANGE +``` + +For more information on `REV_RANGE`, check the [git documentation](https://git-scm.com/book/en/v2/Git-Tools-Revision-Selection#_commit_ranges). + +#### Use cases + +1. Validate the latest 3 commit messages: + ```bash + cz check --rev-range HEAD~3..HEAD + # or + cz check --rev-range HEAD~3.. + # or + cz check --rev-range HEAD~~~.. + ``` + +1. Validate all git commit messages on some branch up to HEAD: + ```bash + cz check --rev-range <branch_name>..HEAD + ``` + + For example, to check all git commit messages on `main` branch up to HEAD: + ```bash + cz check --rev-range main..HEAD + ``` + + or if your project still uses `master` branch: + ```bash + cz check --rev-range master..HEAD + ``` + + !!! note "Default branch" + Usually the default branch is `main` or `master`. + You can check the default branch by running `cz check --use-default-range`. + +1. Validate all git commit messages starting from when you first implemented commit message linting: + + **(Why this is useful?)** Let's say you decided to enforce commit message today. However, it is impractical to `git rebase` all your previous commits. `--rev-range` helps you skip commits before you first implemented commit message linting by using a specific commit hash. + + ```bash + cz check --rev-range <first_commit_sha>..HEAD + ``` + +### `--use-default-range` + +Equivalent to `--rev-range <default_branch>..HEAD`. + +```bash +cz check --use-default-range +# or +cz check -d +``` + +### `--message` + +Test if a given string passes `cz check`. + +```bash +cz check --message <message_to_be_checked> +``` + +### `--commit-msg-file` + +Test if a given file contains a commit message that passes `cz check`. + +```bash +cz check --commit-msg-file <path_to_file_containing_message_to_be_checked> +``` + +This can be useful when cooperating with git hooks. Please check [Automatically check message before commit](../tutorials/auto_check.md) for more detailed examples. + +### `--allow-abort` + +Example: + +```bash +cz check --message <message_to_be_checked> --allow-abort +``` + +Empty commit messages typically instruct Git to abort a commit, so you can pass `--allow-abort` to +permit them. Since `git commit` accepts the `--allow-empty-message` flag (primarily for wrapper scripts), you may wish to disallow such commits in CI. `--allow-abort` may be used in conjunction with any of the other options. + +### `--allowed-prefixes` + +Skip validation for commit messages that start with the specified prefixes. + +If not set, commit messages starting with the following prefixes are ignored by `cz check`: + +- `Merge` +- `Revert` +- `Pull request` +- `fixup!` +- `squash!` +- `amend!` + +```bash +cz check --message <message_to_be_checked> --allowed-prefixes 'Merge' 'Revert' 'Custom Prefix' +``` + +For example, + +```bash +# The following message passes the check because it starts with 'Merge' +cz check --message "Merge branch 'main' into feature/new-feature" --allowed-prefixes 'Merge' + +# The following fails +cz check --message "Merge branch 'main' into feature/new-feature" --allowed-prefixes 'aaa' +``` + +### `--message-length-limit` + +Restrict the length of **the first line** of the commit message. + +```bash +# The following passes +cz check --message "docs(check): fix grammar issues" -l 80 + +# The following fails +cz check --message "docs:very long long long long message with many words" -l 3 +``` + +By default, the limit is set to `0`, which means no limit on the length. + +!!! note + Specifically, for `ConventionalCommitsCz` the length only counts from the type of change to the subject, while the body and the footer are not counted. diff --git a/docs/commands/commit.md b/docs/commands/commit.md new file mode 100644 index 0000000000..5e93a2274f --- /dev/null +++ b/docs/commands/commit.md @@ -0,0 +1,65 @@ +## Usage + +![cz commit --help](../images/cli_help/cz_commit___help.svg) + +## Overview + +![Using Commitizen cli](../images/cli_interactive/commit.gif) + +The `commit` command provides an interactive way to create structured commits. Use either: + +- `cz commit` +- `cz c` (shortcut) + +By default, Commitizen uses conventional commits, but you can customize the commit rules to match your project's needs. See the [customization guide](../customization/config_file.md) for details. + +## Basic Usage + +### Interactive Commit Creation + +Simply run `cz commit` in your terminal to start the interactive commit creation process. The command will guide you through creating a properly formatted commit message according to your configured rules. + +### Writing Messages to File + +You can save the generated commit message to a file using: +```sh +cz commit --write-message-to-file COMMIT_MSG_FILE +``` + +This can be combined with `--dry-run` to only write the message without creating a commit. This is particularly useful for [automatically preparing commit messages](../tutorials/auto_prepare_commit_message.md). + +## Advanced Features + +### Git Command Options + +You can pass any git commit options using the `--` syntax: +```sh +cz commit <commitizen-args> -- <git-cli-args> + +# Examples: +cz c --dry-run -- -a -S # Stage all changes and sign the commit +cz c -a -- -n # Stage all changes and skip the pre-commit and commit-msg hooks +``` + +!!! warning + The `--signoff` option (or `-s`) is now recommended being used with the new syntax: `cz commit -- -s`. The old syntax `cz commit --signoff` is deprecated and will be removed in v5. + +### Retry + +- Use `cz commit --retry` to reuse the last commit message after a failed commit attempt +- Set `retry_after_failure: true` in your configuration to automatically retry +- Use `cz commit --no-retry` to force a new commit message prompt + +### Message Length Control + +Control the length of your commit messages using the `-l` or `--message-length-limit` option: +```sh +cz commit -l 72 # Limits message length to 72 characters +``` + +!!! note + The length limit only applies to the first line of the commit message. For conventional commits, this means the limit applies from the type of change through the subject. The body and footer are not counted. + +## Technical Notes + +For platform compatibility, the `commit` command disables ANSI escaping in its output. This means pre-commit hooks coloring will be deactivated as discussed in [commitizen-tools/commitizen#417](https://github.com/commitizen-tools/commitizen/issues/417). diff --git a/docs/commands/example.md b/docs/commands/example.md new file mode 100644 index 0000000000..8243453916 --- /dev/null +++ b/docs/commands/example.md @@ -0,0 +1,5 @@ +Show commit example + +## Usage + +![cz example --help](../images/cli_help/cz_example___help.svg) diff --git a/docs/commands/info.md b/docs/commands/info.md new file mode 100644 index 0000000000..5f816ba88d --- /dev/null +++ b/docs/commands/info.md @@ -0,0 +1,5 @@ +Show information about the cz + +## Usage + +![cz info --help](../images/cli_help/cz_info___help.svg) diff --git a/docs/commands/init.md b/docs/commands/init.md new file mode 100644 index 0000000000..122e1bef5f --- /dev/null +++ b/docs/commands/init.md @@ -0,0 +1,68 @@ +The `cz init` command helps you set up Commitizen in your project by creating a configuration file with your preferred settings. + +## Usage + +![cz init --help](../images/cli_help/cz_init___help.svg) + +## Command + +```sh +cz init +``` + +## Interactive Configuration + +When you run `cz init`, Commitizen will guide you through an interactive setup process: + +![init](../images/cli_interactive/init.gif) + +## Configuration File + +The initialization process will create a configuration file in your project root. + +See [Configuration File][configuration_file] for more details. + +## Configuration Options + +During the initialization process, you'll be prompted to configure the following settings: + +1. **Convention Rules**: Select the commit message convention to follow (e.g., conventional commits) +2. **Version Provider**: Choose how to manage versioning in your project. Commitizen supports multiple version management systems: + - `commitizen`: Uses Commitizen's built-in version management system + - `npm`: Manages version in `package.json` for Node.js projects + - `cargo`: Manages version in `Cargo.toml` for Rust projects + - `composer`: Manages version in `composer.json` for PHP projects + - `pep621`: Uses `pyproject.toml` with PEP 621 standard + - `poetry`: Uses `pyproject.toml` with Poetry configuration + - `uv`: Uses `pyproject.toml` and `uv.lock` for Python projects + - `scm`: Reads version directly from git tags without modifying files +3. **Project Version**: The current version of your project will be detected automatically +4. **Tag Format**: The format used for version tags in your repository +5. **Version Type**: Choose between: + - `semver` or `semver2`: Semantic Versioning (MAJOR.MINOR.PATCH) + - `pep440`: Python Package Versioning +6. **Changelog Generation**: Configure whether to automatically generate changelog during version bumps +7. **Alpha Versioning**: Option to keep major version at 0 for alpha/beta software +8. **Pre-commit Hooks**: Set up Git pre-commit hooks for automated commit message validation + +See [Configuration Options][configuration_options] for more details. + +## Example + +```sh +# Start the initialization process +cz init + +# Follow the interactive prompts to configure your project +``` + +## Next Steps + +After initialization, you can: + +1. Start using [`cz commit`](./commit.md) to create conventional commits +2. Use [`cz bump`](./bump.md) to manage versioning +3. Configure additional settings in your project's [configuration_file][configuration_file] + +[configuration_file]: ../config/configuration_file.md +[configuration_options]: ../config/option.md diff --git a/docs/commands/ls.md b/docs/commands/ls.md new file mode 100644 index 0000000000..f255ca5444 --- /dev/null +++ b/docs/commands/ls.md @@ -0,0 +1,3 @@ +## Usage + +![cz ls --help](../images/cli_help/cz_ls___help.svg) diff --git a/docs/commands/schema.md b/docs/commands/schema.md new file mode 100644 index 0000000000..bd6fa85195 --- /dev/null +++ b/docs/commands/schema.md @@ -0,0 +1,5 @@ +Show commit schema + +## Usage + +![cz schema --help](../images/cli_help/cz_schema___help.svg) diff --git a/docs/commands/version.md b/docs/commands/version.md new file mode 100644 index 0000000000..4d2e6a0323 --- /dev/null +++ b/docs/commands/version.md @@ -0,0 +1,5 @@ +Get the version of the installed Commitizen or the current project (default: installed commitizen) + +## Usage + +![cz version --help](../images/cli_help/cz_version___help.svg) diff --git a/docs/config.md b/docs/config.md deleted file mode 100644 index dcbb218e86..0000000000 --- a/docs/config.md +++ /dev/null @@ -1,67 +0,0 @@ -# Configuration - -Commitizen has support for `toml` and `ini` files. - -## pyproject.toml - -Add an entry to `pyproject.toml`. Recommended for **python** projects. - - [tool.commitizen] - name = "cz_conventional_commits" - version = "0.1.0" - files = [ - "src/__version__.py", - "pyproject.toml:version" - ] - style = [ - ["qmark", "fg:#ff9d00 bold"], - ["question", "bold"], - ["answer", "fg:#ff9d00 bold"], - ["pointer", "fg:#ff9d00 bold"], - ["highlighted", "fg:#ff9d00 bold"], - ["selected", "fg:#cc5454"], - ["separator", "fg:#cc5454"], - ["instruction", ""], - ["text", ""], - ["disabled", "fg:#858585 italic"] - ] - -## INI files - -Supported files: `.cz`, `.cz.cfg`, `setup.py`, and `$HOME/.cz` - -The format is slightly different to the `toml`, so pay attention. -Recommended for **other languages** projects (js, go, etc). - - [commitizen] - name = cz_conventional_commits - version = 0.1.0 - files = [ - "src/__version__.py", - "pyproject.toml:version" - ] - style = [ - ["qmark", "fg:#ff9d00 bold"], - ["question", "bold"], - ["answer", "fg:#ff9d00 bold"], - ["pointer", "fg:#ff9d00 bold"], - ["highlighted", "fg:#ff9d00 bold"], - ["selected", "fg:#cc5454"], - ["separator", "fg:#cc5454"], - ["instruction", ""], - ["text", ""], - ["disabled", "fg:#858585 italic"] - ] - -The extra tab before the square brakets (`]`) at the end is required. - -## Settings - -| Variable | Type | Default | Description | -| -------- | ---- | ------- | ----------- | -| `name` | `str` | `"cz_conventional_commits"` | Name of the commiting rules to use | -| `version` | `str` | `None` | Current version. Example: "0.1.2" | -| `files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more](https://woile.github.io/commitizen/bump#files) | -| `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more](https://woile.github.io/commitizen/bump#tag_format) | -| `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more](https://woile.github.io/commitizen/bump#bump_message) | -| `style` | `list` | see above | Style for the prompts (It will merge this value with default style.) [See More (Styling your prompts with your favorite colors)](https://github.com/tmbo/questionary#additional-features) | diff --git a/docs/config/bump.md b/docs/config/bump.md new file mode 100644 index 0000000000..10ca5bcf8d --- /dev/null +++ b/docs/config/bump.md @@ -0,0 +1,217 @@ +# Bump Options + +<!-- When adding a new option, please keep the alphabetical order. --> + +## `annotated_tag` + +When set to `true`, `cz bump` is equivalent to `cz bump --annotated-tag`. + +```toml title="pyproject.toml" +[tool.commitizen] +annotated_tag = true +``` + +## `bump_message` + +Template used to specify the commit message generated when bumping. + +Defaults to: `bump: version $current_version → $new_version` + +| Variable | Description | +| ------------------ | ----------------------------------- | +| `$current_version` | the version existing before bumping | +| `$new_version` | version generated after bumping | + +```toml title="pyproject.toml" +[tool.commitizen] +bump_message = "release $current_version → $new_version [skip-ci]" +``` + +## `gpg_sign` + +When set to `true`, `cz bump` is equivalent to `cz bump --gpg-sign`. See [`--gpg-sign`](../commands/bump.md#-gpg-sign). + +```toml title="pyproject.toml" +[tool.commitizen] +gpg_sign = true +``` + +## `ignored_tag_formats` + +- Type: `list` +- Default: `[]` + +Tags matching those formats will be totally ignored and won't raise a warning. +Each entry uses the syntax as [`tag_format`](#tag_format) with the addition of `*` that will match everything (non-greedy). + +## `major_version_zero` + +When set to `true`, `cz bump` is equivalent to `cz bump --major-version-zero`. See [`--major-version-zero`](../commands/bump.md#-major-version-zero). + +```toml title="pyproject.toml" +[tool.commitizen] +major_version_zero = true +``` + +## `legacy_tag_formats` + +- Type: `list` +- Default: `[]` + +Legacy git tag formats, useful for old projects that changed tag format. +Tags matching those formats will be recognized as version tags and be included in the changelog. +Each entry uses the syntax as `tag_format`. + +## `pre_bump_hooks` + +A list of optional commands that will run right *after* updating [`version_files`](#version_files) and *before* actual committing and tagging the release. + +Useful when you need to generate documentation based on the new version. During +execution of the script, some environment variables are available: + +| Variable | Description | +| ---------------------------- | ---------------------------------------------------------- | +| `CZ_PRE_IS_INITIAL` | `True` when this is the initial release, `False` otherwise | +| `CZ_PRE_CURRENT_VERSION` | Current version, before the bump | +| `CZ_PRE_CURRENT_TAG_VERSION` | Current version tag, before the bump | +| `CZ_PRE_NEW_VERSION` | New version, after the bump | +| `CZ_PRE_NEW_TAG_VERSION` | New version tag, after the bump | +| `CZ_PRE_MESSAGE` | Commit message of the bump | +| `CZ_PRE_INCREMENT` | Whether this is a `MAJOR`, `MINOR` or `PATCH` release | +| `CZ_PRE_CHANGELOG_FILE_NAME` | Path to the changelog file, if available | + +```toml title="pyproject.toml" +[tool.commitizen] +pre_bump_hooks = [ + "scripts/generate_documentation.sh" +] +``` + +## `post_bump_hooks` + +A list of optional commands that will run right *after* committing and tagging the release. + +Useful when you need to send notifications about a release, or further automate deploying the +release. During execution of the script, some environment variables are available: + +| Variable | Description | +| ------------------------------ | ----------------------------------------------------------- | +| `CZ_POST_WAS_INITIAL` | `True` when this was the initial release, `False` otherwise | +| `CZ_POST_PREVIOUS_VERSION` | Previous version, before the bump | +| `CZ_POST_PREVIOUS_TAG_VERSION` | Previous version tag, before the bump | +| `CZ_POST_CURRENT_VERSION` | Current version, after the bump | +| `CZ_POST_CURRENT_TAG_VERSION` | Current version tag, after the bump | +| `CZ_POST_MESSAGE` | Commit message of the bump | +| `CZ_POST_INCREMENT` | Whether this was a `MAJOR`, `MINOR` or `PATCH` release | +| `CZ_POST_CHANGELOG_FILE_NAME` | Path to the changelog file, if available | + +```toml title="pyproject.toml" +[tool.commitizen] +post_bump_hooks = [ + "scripts/slack_notification.sh" +] +``` + +## `prerelease_offset` + +Offset with which to start counting prereleases. + +If not specified, defaults to `0`. + +```toml title="pyproject.toml" +[tool.commitizen] +prerelease_offset = 1 +``` + +!!! note + Under some circumstances, a prerelease cannot start with `0`-for example, in embedded projects where individual characters are encoded as bytes. You can specify an offset from which to start counting. + +## `tag_format` + +See [`--tag-format`](../commands/bump.md#-tag-format). + +## `update_changelog_on_bump` + +When set to `true`, `cz bump` is equivalent to `cz bump --changelog`. + +```toml title="pyproject.toml" +[tool.commitizen] +update_changelog_on_bump = true +``` + +## `version_files` + +Identify the files or glob patterns which should be updated with the new version. + +Commitizen will update its configuration file automatically when bumping, +regardless of whether the file is present or not in `version_files`. + +You may specify the `version_files` in your configuration file. + +```toml title="pyproject.toml" +[tool.commitizen] +version_files = [ + "src/__version__.py", +] +``` + +It is also possible to provide a pattern for each file, separated by a colon (e.g. `file:pattern`). See the below example for more details. + +```toml title="pyproject.toml" +[tool.commitizen] +version_files = [ + "packages/*/pyproject.toml:version", + "setup.json:version", +] +``` + +!!! note "Example scenario" + We have a project with the following configuration file `pyproject.toml`: + + ```toml title="pyproject.toml" + [tool.commitizen] + version_files = [ + "src/__version__.py", + "packages/*/pyproject.toml:version", + "setup.json:version", + ] + ``` + + For the reference `"setup.json:version"`, it means that it will look for a file `setup.json` and will only change the lines that contain the substring `"version"`. + + For example, if the content of `setup.json` is: + + <!-- DEPENDENCY: repeated_version_number.json --> + + ```json title="setup.json" + { + "name": "magictool", + "version": "1.2.3", + "dependencies": { + "lodash": "1.2.3" + } + } + ``` + + After running `cz bump 2.0.0`, its content will be updated to: + + ```diff title="setup.json" + { + "name": "magictool", + - "version": "1.2.3", + + "version": "2.0.0", + "dependencies": { + "lodash": "1.2.3" + } + } + ``` + +!!! note + Files can be specified using relative (to the execution) paths, absolute paths, or glob patterns. + +!!! note "Historical note" + This option was renamed from `files` to `version_files`. + +## `version_scheme` + +See [`--version-scheme`](../commands/bump.md#-version-scheme). diff --git a/docs/config/changelog.md b/docs/config/changelog.md new file mode 100644 index 0000000000..86d4363105 --- /dev/null +++ b/docs/config/changelog.md @@ -0,0 +1,8 @@ +# Changelog Options + +<!-- When adding a new option, please keep the alphabetical order. --> +<!-- If there is a new configuration option that doesn't have a corresponding command line option, please add it here. --> + +As for now, each of the options that is used by `cz changelog` command can correlate to a command line option. + +See [changelog command line options](../commands/changelog.md#command-line-options) for more details. diff --git a/docs/config/check.md b/docs/config/check.md new file mode 100644 index 0000000000..2c8dda27b4 --- /dev/null +++ b/docs/config/check.md @@ -0,0 +1,27 @@ +# Check Options + +<!-- When adding a new option, please keep the alphabetical order. --> + +## `allow_abort` + +- Type: `bool` +- Default: `False` + +Disallow empty commit messages. Useful in CI. + +## `allowed_prefixes` + +- Type: `list` +- Default: `["Merge", "Revert", "Pull request", "fixup!", "squash!"]` + +List of prefixes that commitizen ignores when verifying messages. + +## `message_length_limit` + +- Type: `int` +- Default: `0` (no limit) + +Maximum length of the commit message. Setting it to `0` disables the length limit. + +!!! note + This option can be overridden by the `-l/--message-length-limit` command line argument. diff --git a/docs/config/commit.md b/docs/config/commit.md new file mode 100644 index 0000000000..72fdff947c --- /dev/null +++ b/docs/config/commit.md @@ -0,0 +1,26 @@ +# Commit Options + +<!-- When adding a new option, please keep the alphabetical order. --> + +## `breaking_change_exclamation_in_title` + +- Type: `bool` +- Default: `False` + +When true, breaking changes will be also indicated by an exclamation mark in the commit title (e.g., `feat!: breaking change`). + +When false, breaking changes will be only indicated by `BREAKING CHANGE:` in the footer. See [writing commits](../tutorials/writing_commits.md) for more details. + +## `encoding` + +- Type: `str` +- Default: `"utf-8"` + +Sets the character encoding to be used when parsing commit messages. + +## `retry_after_failure` + +- Type: `bool` +- Default: `False` + +Retries failed commit when running `cz commit`. diff --git a/docs/config/configuration_file.md b/docs/config/configuration_file.md new file mode 100644 index 0000000000..172cbce1a3 --- /dev/null +++ b/docs/config/configuration_file.md @@ -0,0 +1,247 @@ +# Configuration File + +Commitizen uses configuration files to customize its behavior for your project. These files define settings such as which commit rules to use, version management preferences, changelog generation options, and more. + +## Creating a Configuration File + +It is recommended to create a configuration file via our [`cz init`](../commands/init.md) command. This command will guide you through setting up your configuration file with the appropriate settings for your project. + +## File Location and Search Order + +Configuration files are typically located in the root of your project directory. Commitizen searches for configuration files in the following order: + +<!-- DEPENDENCY: commitizen/defaults.py CONFIG_FILES --> + +1. `.cz.toml` +2. `cz.toml` +3. `.cz.json` +4. `cz.json` +5. `.cz.yaml` +6. `cz.yaml` +7. `pyproject.toml` (in the `[tool.commitizen]` section) + +The first valid configuration file found will be used. If no configuration file is found, Commitizen will use its default settings. + +!!! note + Commitizen supports explicitly specifying a configuration file using the `--config` option, which is useful when the configuration file is not located in the project root directory. + When `--config` is provided, Commitizen will only load configuration from the specified file and will not search for configuration files using the default search order described above. If the specified configuration file does not exist, Commitizen raises the `ConfigFileNotFound` error. If the specified configuration file exists but is empty, Commitizen raises the `ConfigFileIsEmpty` error. + + ```bash + cz --config <PATH> <command> + ``` + +!!! tip + For Python projects, you can add your Commitizen configuration to `pyproject.toml` to keep all project configuration in one place. + +!!! warning "Multiple Configuration Files" + If Commitizen detects more than one configuration file in your project directory (excluding `pyproject.toml`), it will display a warning message and identify which file is being used. To avoid confusion, ensure you have only one Commitizen configuration file in your project. + +## Supported Formats + +Commitizen supports three configuration file formats: + +- **TOML** (`.toml`) - Recommended for Python projects +- **JSON** (`.json`) +- **YAML** (`.yaml`) + +All formats support the same configuration options. Choose the format that best fits your project's ecosystem. + +## Configuration Structure + +=== "TOML Format" + + For TOML files, Commitizen settings are placed under the `[tool.commitizen]` section. If you're using a standalone `.cz.toml` or `cz.toml` file, you can use `[tool.commitizen]` or just `[commitizen]`. + + **Example: `pyproject.toml`, `.cz.toml` or `cz.toml`** + + ```toml title="pyproject.toml" + [tool.commitizen] + name = "cz_conventional_commits" + version = "0.1.0" + version_provider = "commitizen" + version_scheme = "pep440" + version_files = [ + "src/__version__.py", + "pyproject.toml:version" + ] + tag_format = "$version" + update_changelog_on_bump = true + changelog_file = "CHANGELOG.md" + changelog_incremental = false + bump_message = "bump: version $current_version → $new_version" + gpg_sign = false + annotated_tag = false + major_version_zero = false + prerelease_offset = 0 + retry_after_failure = false + allow_abort = false + message_length_limit = 0 + allowed_prefixes = [ + "Merge", + "Revert", + "Pull request", + "fixup!", + "squash!", + "amend!" + ] + breaking_change_exclamation_in_title = false + use_shortcuts = false + pre_bump_hooks = [] + post_bump_hooks = [] + encoding = "utf-8" + + # Optional: Custom styling for prompts + style = [ + ["qmark", "fg:#ff9d00 bold"], + ["question", "bold"], + ["answer", "fg:#ff9d00 bold"], + ["pointer", "fg:#ff9d00 bold"], + ["highlighted", "fg:#ff9d00 bold"], + ["selected", "fg:#cc5454"], + ["separator", "fg:#cc5454"], + ["instruction", ""], + ["text", ""], + ["disabled", "fg:#858585 italic"] + ] + ``` + +=== "JSON Format" + + For JSON files, Commitizen settings are placed under the `commitizen` key. + + **Example: `.cz.json` or `cz.json`** + + ```json title=".cz.json" + { + "commitizen": { + "name": "cz_conventional_commits", + "version": "0.1.0", + "version_provider": "commitizen", + "version_scheme": "pep440", + "version_files": [ + "src/__version__.py", + "pyproject.toml:version" + ], + "tag_format": "$version", + "update_changelog_on_bump": true, + "changelog_file": "CHANGELOG.md", + "changelog_incremental": false, + "bump_message": "bump: version $current_version → $new_version", + "gpg_sign": false, + "annotated_tag": false, + "major_version_zero": false, + "prerelease_offset": 0, + "retry_after_failure": false, + "allow_abort": false, + "message_length_limit": 0, + "allowed_prefixes": [ + "Merge", + "Revert", + "Pull request", + "fixup!", + "squash!", + "amend!" + ], + "breaking_change_exclamation_in_title": false, + "use_shortcuts": false, + "pre_bump_hooks": [], + "post_bump_hooks": [], + "encoding": "utf-8", + "style": [ + ["qmark", "fg:#ff9d00 bold"], + ["question", "bold"], + ["answer", "fg:#ff9d00 bold"], + ["pointer", "fg:#ff9d00 bold"], + ["highlighted", "fg:#ff9d00 bold"], + ["selected", "fg:#cc5454"], + ["separator", "fg:#cc5454"], + ["instruction", ""], + ["text", ""], + ["disabled", "fg:#858585 italic"] + ] + } + } + ``` + +=== "YAML Format" + + For YAML files, Commitizen settings are placed under the `commitizen` key. + + **Example: `.cz.yaml` or `cz.yaml`** + + ```yaml title=".cz.yaml" + commitizen: + name: cz_conventional_commits + version: "0.1.0" + version_provider: commitizen + version_scheme: pep440 + version_files: + - src/__version__.py + - pyproject.toml:version + tag_format: "$version" + update_changelog_on_bump: true + changelog_file: CHANGELOG.md + changelog_incremental: false + bump_message: "bump: version $current_version → $new_version" + gpg_sign: false + annotated_tag: false + major_version_zero: false + prerelease_offset: 0 + retry_after_failure: false + allow_abort: false + message_length_limit: 0 + allowed_prefixes: + - Merge + - Revert + - Pull request + - fixup! + - squash! + - amend! + breaking_change_exclamation_in_title: false + use_shortcuts: false + pre_bump_hooks: [] + post_bump_hooks: [] + encoding: utf-8 + style: + - - qmark + - fg:#ff9d00 bold + - - question + - bold + - - answer + - fg:#ff9d00 bold + - - pointer + - fg:#ff9d00 bold + - - highlighted + - fg:#ff9d00 bold + - - selected + - fg:#cc5454 + - - separator + - fg:#cc5454 + - - instruction + - "" + - - text + - "" + - - disabled + - fg:#858585 italic + ``` + +## Configuration Options + +For a complete list of all available configuration options and their descriptions, see the [Configuration Settings](../config/option.md) documentation. + +Key configuration categories include: + +- **Commit Rules**: `name` - Select which commit convention to use +- **Version Management**: `version`, `version_provider`, `version_scheme`, `version_files` +- **Tagging**: `tag_format`, `legacy_tag_formats`, `ignored_tag_formats`, `gpg_sign`, `annotated_tag` +- **Changelog**: `changelog_file`, `changelog_format`, `changelog_incremental`, `update_changelog_on_bump` +- **Bumping**: `bump_message`, `major_version_zero`, `prerelease_offset`, `pre_bump_hooks`, `post_bump_hooks` +- **Commit Validation**: `allowed_prefixes`, `message_length_limit`, `allow_abort`, `retry_after_failure` +- **Customization**: `customize`, `style`, `use_shortcuts`, `template`, `extras` + +## Customization + +For advanced customization, including creating custom commit rules, see the [Customization](../customization/config_file.md) documentation. + +!!! note + The `customize` option is supported in TOML, JSON, and YAML configuration files. For Python projects, adding it to `pyproject.toml` keeps all project configuration in one place. diff --git a/docs/config/option.md b/docs/config/option.md new file mode 100644 index 0000000000..4109f3ff7b --- /dev/null +++ b/docs/config/option.md @@ -0,0 +1,52 @@ +# Misc Options + +## `name` + +- Type: `str` +- Default: `"cz_conventional_commits"` + +Name of the committing rules to use. + +## `version` + +- Type: `str` +- Default: `None` + +Current version. Example: `"0.1.2"`. Required if you use `version_provider = "commitizen"`. + +## `style` + +- Type: `list` +- Default: `[]` + +Style for the prompts (It will merge this value with default style.) See [Styling your prompts with your favorite colors](https://github.com/tmbo/questionary#additional-features) for more details. + +## `customize` + +- Type: `dict` +- Default: `None` + +**Supported in TOML, JSON, and YAML configuration files.** + +Custom rules for committing and bumping. See [customization](../customization/config_file.md) for more details. + +## `use_shortcuts` + +- Type: `bool` +- Default: `False` + +Show keyboard shortcuts when selecting from a list. When enabled, each choice shows a shortcut key; press that key or use the arrow keys to select. + +Example: + +```toml title="pyproject.toml" +[tool.commitizen] +name = "cz_conventional_commits" +use_shortcuts = true +``` + +Run `cz commit` to see shortcut keys on each choice. + +![Menu with shortcut keys](../images/cli_interactive/shortcut_default.gif) + +To customize which key is used for each choice (via the `key` field when using `cz_customize`), see [shortcut keys customization](../customization/config_file.md#shortcut-keys). diff --git a/docs/config/version_provider.md b/docs/config/version_provider.md new file mode 100644 index 0000000000..ccbbe6cfd3 --- /dev/null +++ b/docs/config/version_provider.md @@ -0,0 +1,335 @@ +# Version Providers + +Version providers are the mechanism by which Commitizen reads and writes version information in your project. + +They abstract away the details of where and how version numbers are stored, allowing Commitizen to work seamlessly with different project types and package management systems. + +## Overview + +By default, Commitizen uses the `commitizen` provider, which stores the version in your Commitizen configuration file. +However, you can configure Commitizen to use any available provider that matches your project's setup. +This is particularly useful when you want Commitizen to manage versions in the same location as your package manager (e.g., `package.json` for Node.js projects, `pyproject.toml` for Python projects). + +## Built-in Providers + +Commitizen includes several built-in version providers for common package management formats: + +### `commitizen` (Default) + +The default version provider stores and retrieves the version from your Commitizen configuration file (e.g., `pyproject.toml`, `.cz.toml`, etc.). + +**Use when:** + +- You want to keep version management separate from your package manager +- Your project doesn't use a standard package manager +- You need maximum flexibility in version management + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "commitizen" +version = "0.1.0" # Required when using this provider +``` + +### `scm` + +Fetches the version from Git tags using `git describe`. This provider **only reads** version information and never writes it back to files. It's designed to work with tools like `setuptools-scm` or other package manager `*-scm` plugins that derive version numbers from Git history. + +**Use when:** + +- You're using `setuptools-scm` or similar tools +- You want version numbers derived from Git tags +- You don't want Commitizen to modify any files for version management + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "scm" +# No version field needed - it's read from Git tags +``` + +!!! note + The `scm` provider is read-only. When you run `cz bump`, it will create a Git tag but won't update any files. This is intentional and works well with tools that derive versions from Git tags. + +### `pep621` + +Manages version in `pyproject.toml` under the `project.version` field, following [PEP 621](https://peps.python.org/pep-0621/) standards. + +**Use when:** + +- You're using a modern Python project with PEP 621-compliant `pyproject.toml` +- You want version management integrated with your Python project metadata + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "pep621" +``` + +**Example `pyproject.toml`:** +```toml +[project] +name = "my-package" +version = "0.1.0" # Managed by Commitizen +``` + +### `poetry` + +Manages version in `pyproject.toml` under the `tool.poetry.version` field, which is used by the [Poetry](https://python-poetry.org/) package manager. This approach is recommended only for users running Poetry versions earlier than 2.0 or relying on Poetry-specific features. For most users on Poetry 2.0 or later, it is recommended to use `pep621` instead. [Read More](https://python-poetry.org/docs/main/managing-dependencies/) + +**Use when:** + +- You're using Poetry < 2.0 as your Python package manager +- You're using Poetry >= 2.0 as your Python package manager, but don't need poetry-specific features +- You want Commitizen to manage the version that Poetry uses + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "poetry" +``` + +**Example `pyproject.toml`:** +```toml +[tool.poetry] +name = "my-package" +version = "0.1.0" # Managed by Commitizen +``` + +### `uv` + +Manages version in both `pyproject.toml` (`project.version`) and `uv.lock` (`package.version` for the matching package name). This ensures consistency between your project metadata and lock file. + + +!!! note + Even though uv follows PEP 621 format, `pep621` does not manage the version in `uv.lock`. `uv` is still suggested for uv users. + +**Use when:** + +- You're using `uv` as your Python package manager +- You want version synchronization between `pyproject.toml` and `uv.lock` + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "uv" +``` + +### `cargo` + +Manages version in both `Cargo.toml` (`package.version`) and `Cargo.lock` (`package.version` for the matching package name). This ensures consistency between your Rust project's manifest and lock file. + +**Use when:** + +- You're working with a Rust project using Cargo +- You want Commitizen to manage Rust package versions + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "cargo" +``` + +**Example `Cargo.toml`:** +```toml +[package] +name = "my-crate" +version = "0.1.0" # Managed by Commitizen +``` + +### `npm` + +Manages version in `package.json` and optionally synchronizes with `package-lock.json` and `npm-shrinkwrap.json` if they exist. + +**Use when:** + +- You're working with a Node.js/JavaScript project +- You want Commitizen to manage npm package versions + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "npm" +``` + +**Example `package.json`:** +```json +{ + "name": "my-package", + "version": "0.1.0" +} +``` + +### `composer` + +Manages version in `composer.json` under the `version` field, used by PHP's Composer package manager. + +**Use when:** + +- You're working with a PHP project using Composer +- You want Commitizen to manage Composer package versions + +**Configuration:** +```toml +[tool.commitizen] +version_provider = "composer" +``` + +**Example `composer.json`:** +```json +{ + "name": "vendor/package", + "version": "0.1.0" +} +``` + +## Provider Comparison Table + +| Provider | File(s) Modified | Read-Only | Best For | +| ------------ | ----------------------------------- | --------- | --------------------------------- | +| `commitizen` | Commitizen config file | No | General use, flexible projects | +| `scm` | None (reads from Git tags) | Yes | `setuptools-scm` users | +| `pep621` | `pyproject.toml` (`project.version`) | No | Modern Python (PEP 621) | +| `poetry` | `pyproject.toml` (`tool.poetry.version`) | No | Poetry projects | +| `uv` | `pyproject.toml` + `uv.lock` | No | uv package manager | +| `cargo` | `Cargo.toml` + `Cargo.lock` | No | Rust/Cargo projects | +| `npm` | `package.json` (+ lock files) | No | Node.js/npm projects | +| `composer` | `composer.json` | No | PHP/Composer projects | + +## Creating Custom Version Providers + +If none of the built-in providers meet your needs, you can create a custom version provider by extending the `VersionProvider` base class and registering it as a plugin. + +### Step 1: Create Your Provider Class + +Create a Python file (e.g., `my_provider.py`) that extends `VersionProvider`: + +```python title="my_provider.py" +from pathlib import Path +from commitizen.providers import VersionProvider + + +class MyProvider(VersionProvider): + """ + Custom version provider that reads/writes from a VERSION file. + """ + + def get_version(self) -> str: + """Read version from VERSION file.""" + version_file = Path("VERSION") + if not version_file.is_file(): + return "0.0.0" + return version_file.read_text().strip() + + def set_version(self, version: str) -> None: + """Write version to VERSION file.""" + version_file = Path("VERSION") + version_file.write_text(f"{version}\n") +``` + +### Step 2: Register as an Entry Point + +Register your provider using the `commitizen.provider` entry point. You can do this in your `setup.py`, `setup.cfg`, or `pyproject.toml`: + +**Using `pyproject.toml` (recommended):** + +```toml title="pyproject.toml" +[project] +name = "my-commitizen-provider" +version = "0.1.0" +dependencies = ["commitizen"] + +[project.entry-points."commitizen.provider"] +my-provider = "my_provider:MyProvider" +``` + +**Using `setup.py` (for legacy setup):** + +```python title="setup.py" +from setuptools import setup + +setup( + name="my-commitizen-provider", + version="0.1.0", + py_modules=["my_provider"], + install_requires=["commitizen"], + entry_points={ + "commitizen.provider": [ + "my-provider = my_provider:MyProvider", + ] + }, +) +``` + +### Step 3: Install and Use + +1. Install your provider package: + + - Once your custom Commitizen provider is packaged and published (for example, to PyPI), install it like any standard Python package: + + ```bash + pip install my-commitizen-provider + ``` + + - If you want to use the provider directly from the current project source (during development), install it in editable mode ([See pip documentation](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-e)): + + ```bash + pip install -e . + ``` + +2. Configure Commitizen to use your provider: + ```toml + [tool.commitizen] + version_provider = "my-provider" + ``` + +### Provider Implementation Guidelines + +When creating a custom provider, keep these guidelines in mind: + +- **`get_version()`** should return a string representing the current version. If no version is found, you can return `"0.0.0"` or raise an appropriate exception. +- **`set_version(version: str)`** should write the version to your chosen storage location. The version string will be properly formatted according to your `version_scheme` setting. +- The provider has access to `self.config`, which is a `BaseConfig` instance containing all Commitizen settings. +- For file-based providers, consider using the `FileProvider` or `JsonProvider`/`TomlProvider` base classes from `commitizen.providers.base_provider` to simplify implementation. + +### Example: JSON-based Provider + +Here's a more complete example using the `JsonProvider` base class: + +```python title="json_version_provider.py" +from commitizen.providers.base_provider import JsonProvider + + +class JsonVersionProvider(JsonProvider): + """ + Version provider that uses a custom version.json file. + """ + + filename = "version.json" + + def get(self, document): + """Extract version from JSON document.""" + return document["version"] + + def set(self, document, version): + """Set version in JSON document.""" + document["version"] = version +``` + +This example leverages the `JsonProvider` base class, which handles file reading, writing, and JSON parsing automatically. + +## Choosing the Right Provider + +Select a version provider based on your project's characteristics: + +- **Python projects** + - **with `uv`**: Use `uv` + - **with `pyproject.toml` that follows PEP 621**: Use `pep621` + - **with Poetry**: Use `poetry` + - **setuptools-scm**: Use `scm` +- **Rust projects**: Use `cargo` +- **Node.js projects**: Use `npm` +- **PHP projects**: Use `composer` +- **Other cases or custom needs**: Use `commitizen` (default) or create a custom provider + +Remember that you can always use `version_files` in combination with any provider to update additional files during version bumps, regardless of which provider you choose for reading/writing the primary version. diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md new file mode 100644 index 0000000000..446410533c --- /dev/null +++ b/docs/contributing/contributing.md @@ -0,0 +1,157 @@ +# Contributing to Commitizen + +First, thank you for taking the time to contribute! 🎉 Your contributions help make Commitizen better for everyone. + +When contributing to Commitizen, we encourage you to: + +1. First, check out the [issues](https://github.com/commitizen-tools/commitizen/issues) and [Features we won't add](../features_wont_add.md) to see if there's already a discussion about the change you wish to make. +2. If there's no discussion, [create an issue](https://github.com/commitizen-tools/commitizen/issues/new) to discuss your proposed changes. +3. Follow our [development workflow](#development-workflow) and guidelines below. + +If you're a first-time contributor, please check out issues labeled [good first issue](https://github.com/commitizen-tools/commitizen/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - these are specifically chosen to be beginner-friendly. + +## Prerequisites & Setup + +### Required Tools + +1. **Python Environment** + - Python `>=3.10` + - [uv](https://docs.astral.sh/uv/getting-started/installation/) `>=0.9.0` +2. **Version Control & Security** + - Git + - Commitizen + - [GPG](https://gnupg.org) for commit signing + - [Installation page](https://gnupg.org/documentation/manuals/gnupg/Installation.html#Installation) + - For Mac users: `brew install gnupg` + - For Windows users: Download from [Gpg4win](https://www.gpg4win.org/) + - For Linux users: Use your distribution's package manager (e.g., `apt install gnupg` for Ubuntu) + +### Getting Started + +1. Fork [Commitizen](https://github.com/commitizen-tools/commitizen) +2. Clone your fork: + ```bash + git clone https://github.com/YOUR_USERNAME/commitizen.git + cd commitizen + ``` +3. Add the upstream repository: + ```bash + git remote add upstream https://github.com/commitizen-tools/commitizen.git + ``` +4. Set up the development environment: + ```bash + uv sync --dev --frozen + ``` +5. Set up pre-commit hooks: + ```bash + uv run poe setup-pre-commit + ``` + +## Development Workflow + +1. **Create a New Branch** + ```bash + git switch -c feature/your-feature-name + # or + git switch -c fix/your-bug-fix + ``` +2. **Make Your Changes** + - Write your code + - Add tests for new functionalities or fixes + - Update documentation if needed + - Follow the existing code style +3. **Testing** + - Run the full test suite: `uv run poe all` + - Ensure test coverage doesn't drop (we use [CodeCov](https://app.codecov.io/gh/commitizen-tools/commitizen)) + - For documentation changes, run `uv run poe doc` to check for warnings/errors + - If you need to change some file regression snapshots, run: `uv run poe test:regen` +4. **Committing Changes** + - Use Commitizen to make commits (we follow [conventional commits](https://www.conventionalcommits.org/)) + - Example: `cz commit` +5. **Documentation** + - Update `docs/README.md` if needed + - For CLI help screenshots: `uv run poe doc:screenshots` + - Prefer [Google style documentation](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings), which works well with editors like VSCode and PyCharm + - **DO NOT** update `CHANGELOG.md` (automatically generated) + - **DO NOT** update version numbers (automatically handled) +6. **Pull Request** + - Push your changes: `git push origin your-branch-name` + - Create a pull request on GitHub + - Ensure CI checks pass + - Wait for review and address any feedback + +## Use of GitHub Labels + +* good-first-issue *(issue only)* +* help-wanted +* issue-status: needs-triage *(issue only)* **(default label for issues)** +* issue-status: wont-fix +* issue-status: wont-implement +* issue-status: duplicate +* issue-status: invalid +* issue-status: wait-for-response +* issue-status: wait-for-implementation +* issue-status: pr-created +* pr-status: wait-for-review **(default label for PRs)** +* pr-status: reviewing +* pr-status: wait-for-modification +* pr-status: wait-for-response +* pr-status: ready-to-merge +* needs: test-case *(PR only)* +* needs: documentation *(PR only)* +* type: feature +* type: bug +* type: documentation +* type: refactor +* type: question *(issue only)* +* os: Windows +* os: Linux +* os: macOS + + +## Issue life cycle + +```mermaid +graph TD + input[/issue created/] --> + needs-triage + needs-triage --triage--> close(wont-implement, wont-fix, duplicate, invalid) + + needs-triage --triage--> wait-for-implementation + needs-triage --triage--> wait-for-response + + wait-for-response --response--> needs-triage + + wait-for-implementation --PR-created--> pr-created --PR-merged--> output[/close/] + + close --> output[/close/] +``` + +## Pull request life cycle + +```mermaid +flowchart TD + input[/pull request created/] --> + wait-for-review + --start reviewing --> + reviewing + --finish review --> + reviewed{approved} + + reviewed --Y--> + wait-for-merge --> + output[/merge/] + + reviewed --n--> + require-more-information{require more information} + + require-more-information --y--> + wait-for-response + --response--> + require-more-information + + require-more-information --n--> + wait-for-modification + --modification-received--> + review +``` diff --git a/docs/contributing/contributing_tldr.md b/docs/contributing/contributing_tldr.md new file mode 100644 index 0000000000..af350d2bb7 --- /dev/null +++ b/docs/contributing/contributing_tldr.md @@ -0,0 +1,39 @@ +# Contributing TL;DR + +Feel free to send a PR to update this file if you find anything useful. 🙇 + +## Environment + +- Python `>=3.10` +- [uv](https://docs.astral.sh/uv/getting-started/installation/) `>=0.9.0` + +## Useful commands + +Please check the [pyproject.toml](https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml) for a comprehensive list of commands. + +### Code Changes + +```bash +# Ensure you have the correct dependencies +uv sync --dev --frozen + +# Make ruff happy +uv run poe format + +# Check if ruff and mypy are happy +uv run poe lint + +# Check if mypy is happy in python 3.10 +mypy --python-version 3.10 + +# Run tests in parallel. +pytest -n auto # This may take a while. +pytest -n auto <test_suite> +``` + +### Documentation Changes + +```bash +# Build the documentation locally and check for broken links +uv run poe doc +``` diff --git a/docs/contributing/pull_request.md b/docs/contributing/pull_request.md new file mode 100644 index 0000000000..4682496b4c --- /dev/null +++ b/docs/contributing/pull_request.md @@ -0,0 +1,71 @@ +# Pull Request Guidelines + +This document outlines important guidelines to follow when creating a pull request. + +## Before Creating a Pull Request + +1. **Check Existing Issues**: Ensure there's a related issue or discussion for your changes. If not, create one first to discuss the proposed changes. +2. **Follow the Development Workflow**: Make sure you've followed all steps in the [contributing guidelines](contributing.md). + +## Making Changes + +When adding new code, match the existing coding style in the file you're modifying. Consistency within a file and throughout the project is crucial for maintainability. + +## Following PR Description Template Instructions + +The PR description template includes a checklist and specific requirements. Please: + +1. **Complete the Checklist**: Check off all applicable items before requesting review. +2. **Provide Clear Descriptions**: Clearly describe what the change does, expected behavior, and steps to test. +3. **Respond to Feedback**: Carefully read maintainer feedback and address all points raised. Ask for clarification if something is unclear. + +## AI-Assisted Contributions + +We welcome contributions that use AI tools for assistance, but we have strict quality standards to maintain code quality and avoid "AI spaghetti code." + +!!! note + Most of our new documentation changes are, of course, generated by AI, but we still need to review it and make sure it's correct. + +![when bro's code is filled with "🔥 🚀 💥 ❌ ✅"](https://images3.memedroid.com/images/UPLOADED78/69501f1c23cab.webp) + +### Guidelines for AI-Assisted PRs + +1. **Review and Refine**: Thoroughly review and understand all AI-generated code. Refactor to match our project's style and remove unnecessary complexity. +2. **Test Thoroughly**: Don't assume AI-generated code works—test it extensively with comprehensive test cases and manual testing when possible. +3. **Understand the Code**: You should be able to explain every line. If you don't understand something, learn about it or rewrite it. Maintainers may ask you to explain your code. +4. **Avoid Common Pitfalls**: + - Over-engineering (simplify when possible) + - Inconsistent style (ensure consistency with our standards) + - Unnecessary dependencies + - Copy-paste without adaptation + - Verbose or obvious comments +5. **Code Quality Still Matters**: AI assistance doesn't excuse poor code quality. All code must pass linting, type checking, and follow best practices. +6. **Be Transparent**: **Mention AI assistance in the PR description**. Code quality standards remain the same regardless of how the code was written. + +!!! warning "Consequences of Poor AI-Assisted Contributions" + Maintainers who identify low-quality AI-generated code or copy-pasted responses will have no choice but to close the related PRs. This adds unnecessary burden on maintainers and doesn't help the project. Additionally, the contributor's reputation is impacted as maintainers may lose confidence and might restrict the user from making further contributions. + +### What We Consider "AI Spaghetti" + +Red flags that may result in PR rejection or requests for significant refactoring: + +- Overly complex solutions when simpler ones exist +- Unnecessary abstractions or design patterns +- Code that's difficult to understand or maintain +- Missing or inadequate tests +- Copy-pasted code blocks that don't fit the project structure +- Excessive comments explaining obvious things + +**Remember**: If you use AI tools, you're still responsible for the quality of the final code. Use AI as a starting point, not a final solution. + +## Commenting on the PR + +When commenting on the PR: + +- Address the feedback points raised by maintainers +- Ask questions if something is unclear +- **Do not** just copy-paste AI-generated responses + - Maintainers want to see your thought process and understanding of the codebase + - Maintainers and other contributors can tell if you're just copying and pasting AI-generated responses + +Thank you for helping make Commitizen better! 🎉 diff --git a/docs/customization.md b/docs/customization.md deleted file mode 100644 index f863d9fae3..0000000000 --- a/docs/customization.md +++ /dev/null @@ -1,135 +0,0 @@ -Customizing commitizen is not hard at all. - -The basic steps are: - -1. Inheriting from `BaseCommitizen` -2. Give a name to your rules. -3. expose the class at the end of your file assigning it to `discover_this` -4. Create a python package starting with `cz_` using `setup.py`, `poetry`, etc - -Check an [example](convcomms) on how to configure `BaseCommitizen`. - -## Custom commit rules - -Create a file starting with `cz_` for example `cz_jira.py`. This prefix -is used to detect the plugin. Same method [flask uses] - -Inherit from `BaseCommitizen` and you must define `questions` and -`message`. The others are optionals. - -```python -from commitizen.cz.base import BaseCommitizen - -class JiraCz(BaseCommitizen): - - def questions(self) -> list: - """Questions regarding the commit message.""" - questions = [ - { - 'type': 'input', - 'name': 'title', - 'message': 'Commit title' - }, - { - 'type': 'input', - 'name': 'issue', - 'message': 'Jira Issue number:' - }, - ] - return questions - - def message(self, answers: dict) -> str: - """Generate the message with the given answers.""" - return '{0} (#{1})'.format(answers['title'], answers['issue']) - - def example(self) -> str: - """Provide an example to help understand the style (OPTIONAL) - - Used by `cz example`. - """ - return 'Problem with user (#321)' - - def schema(self) -> str: - """Show the schema used (OPTIONAL) - - Used by `cz schema`. - """ - return '<title> (<issue>)' - - def info(self) -> str: - """Explanation of the commit rules. (OPTIONAL) - - Used by `cz info`. - """ - return 'We use this because is useful' - - -discover_this = JiraCz # used by the plugin system -``` - -The next file required is `setup.py` modified from flask version - -```python -from setuptools import setup - -setup( - name='JiraCommitizen', - version='0.1.0', - py_modules=['cz_jira'], - license='MIT', - long_description='this is a long description', - install_requires=['commitizen'] -) -``` - -So at the end we would have - - . - ├── cz_jira.py - └── setup.py - -And that's it, you can install it without uploading to pypi by simply -doing `pip install .` - -If you feel like it should be part of this repo, create a PR. - -[flask uses]: http://flask.pocoo.org/docs/0.12/extensiondev/ - -## Custom bump rules - -You need to define 2 parameters inside `BaseCommitizen`. - -| Parameter | Type | Default | Description | -| --------- | ---- | ------- | ----------- | -| `bump_pattern` | `str` | `None` | Regex to extract information from commit (subject and body) | -| `bump_map` | `dict` | `None` | Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) | - -Let's see an exampple - -```python -from commitizen.cz.base import BaseCommitizen - - -class StrangeCommitizen(BaseCommitizen): - bump_pattern = r"^(break|new|fix|hotfix)" - bump_map = {"break": "MAJOR", "new": "MINOR", "fix": "PATCH", "hotfix": "PATCH"} -``` - -That's it, your commitizen now supports custom rules and you can run - -```bash -cz -n cz_strange bump -``` - -[convcomms]: https://github.com/Woile/commitizen/blob/master/commitizen/cz/conventional_commits/conventional_commits.py - -## Raise Customize Exception - -If you wannt `commitizen` to catch your exception and print the message, you'll have to inherit `CzException`. - -```python -from commitizen.cz.exception import CzException - -class NoSubjectProvidedException(CzException): - ... -``` diff --git a/docs/customization/changelog_template.md b/docs/customization/changelog_template.md new file mode 100644 index 0000000000..60f40ebea7 --- /dev/null +++ b/docs/customization/changelog_template.md @@ -0,0 +1,85 @@ + +# Customizing the changelog template + +Commitizen gives you the possibility to provide your own changelog template, by: + +- providing one with your customization class +- providing one from the current working directory and setting it: + - Through the configuration file + - as `--template` parameter to both `bump` and `changelog` commands +- either by providing a template with the same name as the default template + +By default, the template used is the `CHANGELOG.md.j2` file from the Commitizen repository. + +## Providing a template with your customization class + +There are 3 parameters available to change the template rendering from your custom `BaseCommitizen`. + +| Parameter | Type | Default | Description | +| ----------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- | +| `template` | `str` | `None` | Provide your own template name (default to `CHANGELOG.md.j2`) | +| `template_loader` | `str` | `None` | Override the default template loader (so you can provide template from your customization class) | +| `template_extras` | `dict` | `None` | Provide some extra template parameters | + +Let's see an example. + +```python +from commitizen.cz.base import BaseCommitizen +from jinja2 import PackageLoader + + +class MyPlugin(BaseCommitizen): + template = "CHANGELOG.md.jinja" + template_loader = PackageLoader("my_plugin", "templates") + template_extras = {"key": "value"} +``` + +This snippet will: + +- use `CHANGELOG.md.jinja` as template name +- search for it in the `templates` directory for `my_plugin` package +- add the `key=value` variable in the template + +## Providing a template from the current working directory + +Users can provide their own template from their current working directory (your project root) by: + +- providing a template with the same name (`CHANGELOG.md.j2` unless overridden by your custom class) +- setting your template path as `template` configuration +- giving your template path as `--template` parameter to `bump` and `changelog` commands + +!!! note + The path is relative to the current working directory, aka your project root most of the time. + +## Template variables + +The default template use a single `tree` variable which is a list of entries (a release) with the following format: + +| Name | Type | Description | +| ---- | ---- | ----------- | +| version | `str` | The release version | +| date | `datetime` | The release date | +| changes | `list[tuple[str, list[Change]]]` | The release sorted changes list in the form `(type, changes)` | + +Each `Change` has the following fields: + +| Name | Type | Description | +| ---- | ---- | ----------- | +| scope | `str | None` | An optional scope | +| message | `str` | The commit message body | +| sha1 | `str` | The commit `sha1` | +| parents | `list[str]` | The parent commit(s) `sha1`(s) | +| author | `str` | The commit author name | +| author_email | `str` | The commit author email | + +!!! note + The field values depend on the customization class and/or the settings you provide + +The `parents` field can be used to identify merge commits and generate a changelog based on those. Another use case +is listing commits that belong to the same pull request. + +When using another template (either provided by a plugin or by yourself), you can also pass extra template variables +by: + +- defining them in your configuration with the `extras` settings +- providing them on the command line with the `--extra/-e` parameter to `bump` and `changelog` commands diff --git a/docs/customization/config_file.md b/docs/customization/config_file.md new file mode 100644 index 0000000000..50185a7583 --- /dev/null +++ b/docs/customization/config_file.md @@ -0,0 +1,234 @@ +# Customize in configuration file + +The basic steps are: + +1. Define your custom committing or bumping rules in the configuration file. +2. Declare `name = "cz_customize"` in your configuration file, or add `-n cz_customize` when running Commitizen. +!!! warning + `cz_customize` is likely to be removed or renamed in the next major release. + This change is still under discussion; you can continue using `cz_customize` for now and follow [#1385](https://github.com/commitizen-tools/commitizen/issues/1385) for the rationale, options, and current status. + +The following shows the **same configuration** in TOML, JSON, and YAML; use the format your project uses. + +Example: + +=== "TOML" + + ```toml title="pyproject.toml" + [tool.commitizen] + name = "cz_customize" + + [tool.commitizen.customize] + message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example = "feature: this feature enable customize through config file" + schema = "<type>: <body>" + schema_pattern = "(feature|bug fix):(\\s.*)" + bump_pattern = "^(break|new|fix|hotfix)" + bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"} + change_type_order = ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"] + info_path = "cz_customize_info.txt" + info = """ + This is customized info + """ + commit_parser = "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?" + changelog_pattern = "^(feature|bug fix)?(!)?" + change_type_map = {"feature" = "Feat", "bug fix" = "Fix"} + + [[tool.commitizen.customize.questions]] + type = "list" + name = "change_type" + choices = [{value = "feature", name = "feature: A new feature."}, {value = "bug fix", name = "bug fix: A bug fix."}] + # choices = ["feature", "fix"] # short version + message = "Select the type of change you are committing" + + [[tool.commitizen.customize.questions]] + type = "input" + name = "message" + message = "Body." + + [[tool.commitizen.customize.questions]] + type = "confirm" + name = "show_message" + message = "Do you want to add body message in commit?" + ``` + +=== "JSON" + + ```json title=".cz.json" + { + "commitizen": { + "name": "cz_customize", + "customize": { + "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}", + "example": "feature: this feature enable customize through config file", + "schema": "<type>: <body>", + "schema_pattern": "(feature|bug fix):(\\s.*)", + "bump_pattern": "^(break|new|fix|hotfix)", + "bump_map": { + "break": "MAJOR", + "new": "MINOR", + "fix": "PATCH", + "hotfix": "PATCH" + }, + "change_type_order": ["BREAKING CHANGE", "feat", "fix", "refactor", "perf"], + "info_path": "cz_customize_info.txt", + "info": "This is customized info", + "commit_parser": "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?", + "changelog_pattern": "^(feature|bug fix)?(!)?", + "change_type_map": {"feature": "Feat", "bug fix": "Fix"}, + "questions": [ + { + "type": "list", + "name": "change_type", + "choices": [ + { + "value": "feature", + "name": "feature: A new feature." + }, + { + "value": "bug fix", + "name": "bug fix: A bug fix." + } + ], + "message": "Select the type of change you are committing" + }, + { + "type": "input", + "name": "message", + "message": "Body." + }, + { + "type": "confirm", + "name": "show_message", + "message": "Do you want to add body message in commit?" + } + ] + } + } + } + ``` + +=== "YAML" + + ```yaml title=".cz.yaml" + commitizen: + name: cz_customize + customize: + message_template: '{{change_type}}:{% if show_message %} {{message}}{% endif %}' + example: 'feature: this feature enable customize through config file' + schema: '<type>: <body>' + schema_pattern: '(feature|bug fix):(\\s.*)' + bump_pattern: '^(break|new|fix|hotfix)' + commit_parser: '^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?' + changelog_pattern: '^(feature|bug fix)?(!)?' + change_type_map: + feature: Feat + bug fix: Fix + bump_map: + break: MAJOR + new: MINOR + fix: PATCH + hotfix: PATCH + change_type_order: ['BREAKING CHANGE', 'feat', 'fix', 'refactor', 'perf'] + info_path: cz_customize_info.txt + info: This is customized info + questions: + - type: list + name: change_type + choices: + - value: feature + name: 'feature: A new feature.' + - value: bug fix + name: 'bug fix: A bug fix.' + message: Select the type of change you are committing + - type: input + name: message + message: 'Body.' + - type: confirm + name: show_message + message: 'Do you want to add body message in commit?' + ``` + +## Configuration File Options + +| Parameter | Type | Default | Description | +| ------------------- | ------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `questions` | `Questions` | `None` | Questions regarding the commit message. Detailed below. The type `Questions` is an alias to `Iterable[MutableMapping[str, Any]]` which is defined in `commitizen.defaults`. It expects a list of dictionaries. | +| `message_template` | `str` | `None` | The template for generating message from the given answers. `message_template` should either follow [Jinja2][jinja2] formatting specification, and all the variables in this template should be defined in `name` in `questions` | +| `example` | `str` | `""` | (OPTIONAL) Provide an example to help understand the style. Used by `cz example`. | +| `schema` | `str` | `""` | (OPTIONAL) Show the schema used. Used by `cz schema`. | +| `schema_pattern` | `str` | `""` | (OPTIONAL) The regular expression used to do commit message validation. Used by `cz check`. | +| `info_path` | `str` | `""` | (OPTIONAL) The path to the file that contains explanation of the commit rules. Used by `cz info`. If not provided `cz info`, will load `info` instead. | +| `info` | `str` | `""` | (OPTIONAL) Explanation of the commit rules. Used by `cz info`. | +| `bump_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) | +| `bump_pattern` | `str` | `None` | (OPTIONAL) Regex to extract information from commit (subject and body) | +| `change_type_order` | `str` | `None` | (OPTIONAL) List of strings used to order the Changelog. All other types will be sorted alphabetically. Default is `["BREAKING CHANGE", "Feat", "Fix", "Refactor", "Perf"]` | +| `commit_parser` | `str` | `None` | (OPTIONAL) Regex to extract information used in creating changelog. [See more][changelog-spec] | +| `changelog_pattern` | `str` | `None` | (OPTIONAL) Regex to understand which commits to include in the changelog | +| `change_type_map` | `dict` | `None` | (OPTIONAL) Dictionary mapping the type of the commit to a changelog entry | + +[jinja2]: https://jinja.palletsprojects.com/en/2.10.x/ +[changelog-spec]: https://commitizen-tools.github.io/commitizen/commands/changelog/ + +### Detailed `questions` content + +| Parameter | Type | Default | Description | +| ----------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `type` | `str` | `None` | The type of questions. Valid types: `list`, `select`, `input`, etc. The `select` type provides an interactive searchable list interface. [See More][different-question-types] | +| `name` | `str` | `None` | The key for the value answered by user. It's used in `message_template` | +| `message` | `str` | `None` | Detail description for the question. | +| `choices` | `list` | `None` | (OPTIONAL) The choices when `type = list` or `type = select`. Either use a list of values or a list of dictionaries with `name` and `value` keys. Keyboard shortcuts can be defined via `key`. See examples above. | +| `default` | `Any` | `None` | (OPTIONAL) The default value for this question. | +| `filter` | `str` | `None` | (OPTIONAL) Validator for user's answer. **(Work in Progress)** | +| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. | +| `use_search_filter` | `bool` | `False` | (OPTIONAL) Enable search/filter functionality for list/select type questions. This allows users to type and filter through the choices. | +| `use_jk_keys` | `bool` | `True` | (OPTIONAL) Enable/disable j/k keys for navigation in list/select type questions. Set to false if you prefer arrow keys only. | + +[different-question-types]: https://github.com/tmbo/questionary#different-question-types + +### Shortcut keys + +For a basic overview of `use_shortcuts` and how the default menu looks, see the [`use_shortcuts` option](../config/option.md#use_shortcuts). + +#### `use_shortcuts` with `cz_customize` + +When using `cz_customize`, enabling `use_shortcuts` lets you set an optional `key` for each list/select choice so that choice shows your chosen shortcut. Rules below. + +Example: + +```toml title="pyproject.toml" +[tool.commitizen] +name = "cz_customize" +use_shortcuts = true + +[tool.commitizen.customize] +message_template = "{{prefix}}: {{message}}" +schema = "<type>: <body>" +schema_pattern = "(feat|fix|docs|test):(\\s.*)" + +[[tool.commitizen.customize.questions]] +type = "list" +name = "prefix" +message = "Select the type of change you are committing" +choices = [ + { value = "feat", name = "feat: A new feature.", key = "f" }, + { value = "fix", name = "fix: A bug fix.", key = "x" }, + { value = "docs", name = "docs: Documentation only changes", key = "d" }, + { value = "test", name = "test: Adding or correcting tests", key = "t" } +] + +[[tool.commitizen.customize.questions]] +type = "input" +name = "message" +message = "Commit body: " +``` + +![Menu with custom shortcut keys settings](../images/cli_interactive/shortcut_custom.gif) + +**Rules for `key`** + +| Rule | Description | +|------|-------------| +| Allowed | Lowercase `a`–`z` or digits `0`–`9` only | +| Uniqueness | Each `key` must be unique among all choices | +| Optional | Omit `key` to use default numeric order (1, 2, 3, …) | diff --git a/docs/customization/python_class.md b/docs/customization/python_class.md new file mode 100644 index 0000000000..c698b03dee --- /dev/null +++ b/docs/customization/python_class.md @@ -0,0 +1,310 @@ +# Customizing through a python class + +The basic steps are: + +1. Inheriting from `BaseCommitizen`. +2. Give a name to your rules. +3. Create a Python package using proper [build backend](https://packaging.python.org/en/latest/glossary/#term-Build-Backend) +4. Expose the class as a `commitizen.plugin` entrypoint. + +Check an [example][convcomms] on how to configure `BaseCommitizen`. + +You can also automate the steps above through [cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.0/). + +```sh +cookiecutter gh:commitizen-tools/commitizen_cz_template +``` + +See [commitizen_cz_template](https://github.com/commitizen-tools/commitizen_cz_template) for details. + +See [Third-party plugins](../third-party-plugins/about.md) for more details on how to create a third-party Commitizen plugin. + +## Custom commit rules + +Create a Python module, for example `cz_jira.py`. + +Inherit from `BaseCommitizen`, and you must define `questions` and `message`. The others are optional. + +```python title="cz_jira.py" +from commitizen.cz.base import BaseCommitizen +from commitizen.defaults import Questions + + +class JiraCz(BaseCommitizen): + # Questions = Iterable[MutableMapping[str, Any]] + # It expects a list with dictionaries. + def questions(self) -> Questions: + """Questions regarding the commit message.""" + questions = [ + {"type": "input", "name": "title", "message": "Commit title"}, + {"type": "input", "name": "issue", "message": "Jira Issue number:"}, + ] + return questions + + def message(self, answers: dict) -> str: + """Generate the message with the given answers.""" + return f"answers['title'] (#answers['issue'])" + + def example(self) -> str: + """Provide an example to help understand the style (OPTIONAL) + + Used by `cz example`. + """ + return "Problem with user (#321)" + + def schema(self) -> str: + """Show the schema used (OPTIONAL) + + Used by `cz schema`. + """ + return "<title> (<issue>)" + + def info(self) -> str: + """Explanation of the commit rules. (OPTIONAL) + + Used by `cz info`. + """ + return "We use this because is useful" +``` + +The next file required is `setup.py` modified from flask version. + +```python title="setup.py" +from setuptools import setup + +setup( + name="JiraCommitizen", + version="0.1.0", + py_modules=["cz_jira"], + license="MIT", + long_description="this is a long description", + install_requires=["commitizen"], + entry_points={"commitizen.plugin": ["cz_jira = cz_jira:JiraCz"]}, +) +``` + +So in the end, we would have + + . + ├── cz_jira.py + └── setup.py + +And that's it. You can install it without uploading to PyPI by simply +doing `pip install .` + +## Custom bump rules + +You need to define 2 parameters inside your custom `BaseCommitizen`. + +| Parameter | Type | Default | Description | +| -------------- | ------ | ------- | ----------------------------------------------------------------------------------------------------- | +| `bump_pattern` | `str` | `None` | Regex to extract information from commit (subject and body) | +| `bump_map` | `dict` | `None` | Dictionary mapping the extracted information to a `SemVer` increment type (`MAJOR`, `MINOR`, `PATCH`) | + +Let's see an example. + +```python title="cz_strange.py" +from commitizen.cz.base import BaseCommitizen + + +class StrangeCommitizen(BaseCommitizen): + bump_pattern = r"^(break|new|fix|hotfix)" + bump_map = {"break": "MAJOR", "new": "MINOR", "fix": "PATCH", "hotfix": "PATCH"} +``` + +That's it, your Commitizen now supports custom rules, and you can run. + +```bash +cz -n cz_strange bump +``` + +[convcomms]: https://github.com/commitizen-tools/commitizen/blob/master/commitizen/cz/conventional_commits/conventional_commits.py + +### Custom commit validation and error message + +The commit message validation can be customized by overriding the `validate_commit_message` and `format_error_message` +methods from `BaseCommitizen`. This allows for a more detailed feedback to the user where the error originates from. + +```python +import re +from commitizen.cz.base import BaseCommitizen, ValidationResult +from commitizen import git + + +class CustomValidationCz(BaseCommitizen): + def validate_commit_message( + self, + *, + commit_msg: str, + pattern: str | None, + allow_abort: bool, + allowed_prefixes: list[str], + max_msg_length: int, + ) -> ValidationResult: + """Validate commit message against the pattern.""" + if not commit_msg: + return allow_abort, [] if allow_abort else [f"commit message is empty"] + if pattern is None: + return True, [] + if any(map(commit_msg.startswith, allowed_prefixes)): + return True, [] + if max_msg_length: + msg_len = len(commit_msg.partition("\n")[0].strip()) + if msg_len > max_msg_length: + return False, [ + f"commit message is too long. Max length is {max_msg_length}" + ] + pattern_match = re.match(pattern, commit_msg) + if pattern_match: + return True, [] + else: + # Perform additional validation of the commit message format + # and add custom error messages as needed + return False, ["commit message does not match the pattern"] + + def format_exception_message( + self, ill_formatted_commits: list[tuple[git.GitCommit, list]] + ) -> str: + """Format commit errors.""" + displayed_msgs_content = "\n".join( + ( + f'commit "{commit.rev}": "{commit.message}"' + f"errors:\n" + "\n".join((f"- {error}" for error in errors)) + ) + for commit, errors in ill_formatted_commits + ) + return ( + "commit validation: failed!\n" + "please enter a commit message in the commitizen format.\n" + f"{displayed_msgs_content}\n" + f"pattern: {self.schema_pattern()}" + ) +``` + +## Custom changelog generator + +The changelog generator should just work in a very basic manner without touching anything. +You can customize it of course, and the following variables are the ones you need to add to your custom `BaseCommitizen`. + +| Parameter | Type | Required | Description | +| -------------------------------- | ------------------------------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `commit_parser` | `str` | NO | Regex which should provide the variables explained in the [changelog description][changelog-des] | +| `changelog_pattern` | `str` | NO | Regex to validate the commits, this is useful to skip commits that don't meet your ruling standards like a Merge. Usually the same as bump_pattern | +| `change_type_map` | `dict` | NO | Convert the title of the change type that will appear in the changelog, if a value is not found, the original will be provided | +| `changelog_message_builder_hook` | `method: (dict, git.GitCommit) -> dict | list | None` | NO | Customize with extra information your message output, like adding links, this function is executed per parsed commit. Each GitCommit contains the following attrs: `rev`, `title`, `body`, `author`, `author_email`. Returning a falsy value ignore the commit. | +| `changelog_hook` | `method: (full_changelog: str, partial_changelog: Optional[str]) -> str` | NO | Receives the whole and partial (if used incremental) changelog. Useful to send slack messages or notify a compliance department. Must return the full_changelog | +| `changelog_release_hook` | `method: (release: dict, tag: git.GitTag) -> dict` | NO | Receives each generated changelog release and its associated tag. Useful to enrich releases before they are rendered. Must return the update release + +```python title="cz_strange.py" +from commitizen.cz.base import BaseCommitizen +import chat +import compliance + + +class StrangeCommitizen(BaseCommitizen): + changelog_pattern = r"^(break|new|fix|hotfix)" + commit_parser = r"^(?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?:\s(?P<message>.*)?" + change_type_map = { + "feat": "Features", + "fix": "Bug Fixes", + "refactor": "Code Refactor", + "perf": "Performance improvements", + } + + def changelog_message_builder_hook( + self, parsed_message: dict, commit: git.GitCommit + ) -> dict | list | None: + rev = commit.rev + m = parsed_message["message"] + parsed_message[ + "message" + ] = f"{m} {rev} [{commit.author}]({commit.author_email})" + return parsed_message + + def changelog_release_hook(self, release: dict, tag: git.GitTag) -> dict: + release["author"] = tag.author + return release + + def changelog_hook( + self, full_changelog: str, partial_changelog: Optional[str] + ) -> str: + """Executed at the end of the changelog generation + + full_changelog: it's the output about to being written into the file + partial_changelog: it's the new stuff, this is useful to send slack messages or + similar + + Return: + the new updated full_changelog + """ + if partial_changelog: + chat.room("#committers").notify(partial_changelog) + if full_changelog: + compliance.send(full_changelog) + full_changelog.replace(" fix ", " **fix** ") + return full_changelog +``` + +## Raise Customize Exception + +If you want `commitizen` to catch your exception and print the message, you'll have to inherit `CzException`. + +```python +from commitizen.cz.exception import CzException + + +class NoSubjectProvidedException(CzException): + ... +``` + +## Migrating from legacy plugin format + +Commitizen migrated to a new plugin format relying on `importlib.metadata.EntryPoint`. +Migration should be straight-forward for legacy plugins: + +- Remove the `discover_this` line from your plugin module +- Expose the plugin class under as a `commitizen.plugin` entrypoint. + +The name of the plugin is now determined by the name of the entrypoint. + +### Example + +If you were having a `CzPlugin` class in a `cz_plugin.py` module like this: + +```python +from commitizen.cz.base import BaseCommitizen + + +class PluginCz(BaseCommitizen): + ... + + +discover_this = PluginCz +``` + +Then remove the `discover_this` line: + +```python +from commitizen.cz.base import BaseCommitizen + + +class PluginCz(BaseCommitizen): + ... +``` + +and expose the class as entrypoint in your `setuptools`: + +```python +from setuptools import setup + +setup( + name="MyPlugin", + version="0.1.0", + py_modules=["cz_plugin"], + entry_points={"commitizen.plugin": ["plugin = cz_plugin:PluginCz"]}, + ..., +) +``` + +Then your plugin will be available under the name `plugin`. diff --git a/docs/exit_codes.md b/docs/exit_codes.md new file mode 100644 index 0000000000..1a214e2832 --- /dev/null +++ b/docs/exit_codes.md @@ -0,0 +1,142 @@ +# Exit Codes + +Commitizen handles expected exceptions through `CommitizenException` and returns different exit codes for different situations. This reference is useful when you need to ignore specific errors in your CI/CD pipeline or automation scripts. + +All exit codes are defined in [commitizen/exceptions.py](https://github.com/commitizen-tools/commitizen/blob/master/commitizen/exceptions.py). + +## Exit Code Reference + +| Exception | Exit Code | Description | +| --------------------------- | --------- | ----------------------------------------------------------------------------------------------------------- | +| `ExpectedExit` | 0 | Expected exit | +| `DryRunExit` | 0 | Exit due to passing `--dry-run` option | +| `NoCommitizenFoundException` | 1 | Using a cz (e.g., `cz_jira`) that cannot be found in your system | +| `NotAGitProjectError` | 2 | Not in a git project | +| `NoCommitsFoundError` | 3 | No commits found | +| `NoVersionSpecifiedError` | 4 | Version is not specified in configuration file | +| `NoPatternMapError` | 5 | bump / changelog pattern or map can not be found in configuration file | +| `BumpCommitFailedError` | 6 | Commit failed when bumping version | +| `BumpTagFailedError` | 7 | Tag failed when bumping version | +| `NoAnswersError` | 8 | No user response given | +| `CommitError` | 9 | git commit error | +| `NoCommitBackupError` | 10 | Commit backup file is not found | +| `NothingToCommitError` | 11 | Nothing in staging to be committed | +| `CustomError` | 12 | `CzException` raised | +| `NoCommandFoundError` | 13 | No command found when running Commitizen cli (e.g., `cz --debug`) | +| `InvalidCommitMessageError` | 14 | The commit message does not pass `cz check` | +| `MissingConfigError` | 15 | Configuration is missing for `cz_customize` | +| `NoRevisionError` | 16 | No revision found | +| `CurrentVersionNotFoundError`| 17 | Current version cannot be found in `version_files` | +| `InvalidCommandArgumentError`| 18 | The argument provided to the command is invalid (e.g. `cz check -commit-msg-file filename --rev-range master..`) | +| `InvalidConfigurationError` | 19 | An error was found in the Commitizen Configuration, such as duplicates in `change_type_order` | +| `NotAllowed` | 20 | Invalid combination of command line / configuration file options | +| `NoneIncrementExit` | 21 | The commits found are not eligible to be bumped | +| `CharacterSetDecodeError` | 22 | The character encoding of the command output could not be determined | +| `GitCommandError` | 23 | Unexpected failure while calling a git command | +| `InvalidManualVersion` | 24 | Manually provided version is invalid | +| `InitFailedError` | 25 | Failed to initialize pre-commit | +| `RunHookError` | 26 | An error occurred during a hook execution | +| `VersionProviderUnknown` | 27 | Unknown `version_provider` | +| `VersionSchemeUnknown` | 28 | Unknown `version_scheme` | +| `ChangelogFormatUnknown` | 29 | Unknown `changelog_format` or cannot be determined by the file extension | +| `ConfigFileNotFound` | 30 | The configuration file is not found | +| `ConfigFileIsEmpty` | 31 | The configuration file is empty | +| `CommitMessageLengthLimitExceededError`| 32 | The commit message length exceeds the given limit. | + +## Ignoring Exit Codes + +In some scenarios, you may want Commitizen to continue execution even when certain errors occur. This is particularly useful in CI/CD pipelines where you want to handle specific errors gracefully. + +### Using `--no-raise` Flag + +The `--no-raise` (or `-nr`) flag allows you to specify exit codes that should not cause Commitizen to exit with an error. You can use either: + +- **Exit code numbers**: `21`, `3`, `4` +- **Exit code names**: `NO_INCREMENT`, `NO_COMMITS_FOUND`, `NO_VERSION_SPECIFIED` +- **Mixed format**: `21,NO_COMMITS_FOUND,4` + +Multiple exit codes can be specified as a comma-separated list. + +### Common Use Cases + +#### Ignoring No Increment Errors + +The most common use case is to ignore `NoneIncrementExit` (exit code 21) when running `cz bump`. This allows the command to succeed even when no commits are eligible for a version bump: + +```sh +cz -nr 21 bump +``` + +Or using the exit code name: + +```sh +cz -nr NO_INCREMENT bump +``` + +This is useful in CI pipelines where you want to run `cz bump` regularly, but don't want the pipeline to fail when there are no version-worthy commits. + +#### Ignoring Multiple Exit Codes + +You can ignore multiple exit codes at once: + +```sh +cz --no-raise 21,3,4 bump +``` + +This example ignores: + +- `21` (`NoneIncrementExit`) - No eligible commits for bump +- `3` (`NoCommitsFoundError`) - No commits found +- `4` (`NoVersionSpecifiedError`) - Version not specified + +### Finding the Exit Code + +If you encounter an error and want to ignore it, you can find the exit code in two ways: + +#### Method 1: Check the Exit Code After Running + +After running a Commitizen command that fails, check the exit code: + +```sh +cz bump +echo $? # Prints the exit code (e.g., 21) +``` + +Then use that exit code with `--no-raise`: + +```sh +cz -nr 21 bump +``` + +#### Method 2: Look Up the Exception + +1. Check the error message to identify the exception type +2. Find the corresponding exit code in the table above +3. Use that exit code with `--no-raise` + +For example, if you see `NoneIncrementExit` in the error, look it up in the table to find it's exit code 21, then use: + +```sh +cz -nr 21 bump +``` + +### Best Practices + +- **Document your usage**: If you use `--no-raise` in scripts or CI/CD, document why specific exit codes are ignored +- **Be specific**: Only ignore exit codes you understand and have a reason to ignore +- **Test thoroughly**: Ensure that ignoring certain exit codes doesn't mask real problems in your workflow +- **Use exit code names**: When possible, use exit code names (e.g., `NO_INCREMENT`) instead of numbers for better readability + +### Example: CI/CD Pipeline + +Here's an example of using `--no-raise` in a CI/CD pipeline: + +```yaml +# .github/workflows/release.yml +- name: Bump version + run: | + cz -nr NO_INCREMENT bump || true + # Continue even if no version bump is needed +``` + +This ensures the pipeline continues even when there are no commits eligible for a version bump. diff --git a/docs/external_links.md b/docs/external_links.md new file mode 100644 index 0000000000..dc9bc1b0a2 --- /dev/null +++ b/docs/external_links.md @@ -0,0 +1,19 @@ +> If you have written over Commitizen, make a PR and add the link here 💪 + +## Talks + +| Name | Speaker | Occasion | Language | Extra | +| ------------------------------------------------------------------------- | --------------- | ---------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| [Atomic Commits: An Easy & Proven Way to Manage & Automate Release Process](https://www.youtube.com/watch?v=IxzN9ClXhs8) | Wei Lee | COSCUP 2023 | Taiwanese Mandarin | [slides](https://speakerdeck.com/leew/atomic-commits-an-easy-and-proven-way-to-manage-and-automate-release-process) | +| commitizen-tools: What can we gain from crafting a git message convention | Wei Lee | Taipei.py 2020 June Meetup, Remote Python Pizza 2020 | English | [slides](https://speakerdeck.com/leew/commitizen-tools-what-can-we-gain-from-crafting-a-git-message-convention-at-taipey-dot-py) | +| Automating release cycles | Santiago Fraire | PyAmsterdam June 24, 2020, Online | English | [slides](https://woile.github.io/commitizen-presentation/) | +| [Automatizando Releases con Commitizen y Github Actions][automatizando] | Santiago Fraire | PyConAr 2020, Remote | Español | [slides](https://woile.github.io/automating-releases-github-actions-presentation/#/) | + +## Articles + +- [Python Table Manners - Commitizen: 規格化 commit message](https://blog.wei-lee.me/posts/tech/2020/03/python-table-manners-commitizen/) (Written in Traditional Mandarin) +- [Automating semantic release with commitizen](https://woile.dev/blog/automating-deployment-with-commitizen.html) (English) +- [How to Write Better Git Commit Messages – A Step-By-Step Guide](https://www.freecodecamp.org/news/how-to-write-better-git-commit-messages/?utm_source=tldrnewsletter) (English) +- [Continuous delivery made easy (in Python)](https://blog.devgenius.io/continuous-delivery-made-easy-in-python-c085e9c82e69) + +[automatizando]: https://youtu.be/t3aE2M8UPBo diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000000..568ec2fbe8 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,91 @@ +# FAQ + +This page contains frequently asked how to questions. + +## Support for [`PEP621`](https://peps.python.org/pep-0621/) + +`PEP621` establishes a `[project]` definition inside `pyproject.toml` + +```toml +[project] +name = "spam" +version = "2.5.1" +``` + +Commitizen provides a [`PEP621` version provider](config/version_provider.md) to get and set version from this field. + +You just need to set the proper `version_provider` setting: + +```toml +[project] +name = "spam" +version = "2.5.1" + +[tool.commitizen] +version_provider = "pep621" +``` + +## How to revert a bump? + +If for any reason, the created tag and changelog were to be undone, this is the snippet: + +```sh +git tag --delete <created_tag> +git reset HEAD~ +git reset --hard HEAD +``` + +This will remove the last tag created, plus the commit containing the update to `.cz.toml` and the changelog generated for the version. + +In case the commit was pushed to the server, you can remove it by running: + +```sh +git push --delete origin <created_tag> +``` + +## How to handle revert commits? + +```sh +git revert --no-commit <SHA> +git commit -m "revert: foo bar" +``` + +## I got `Exception [WinError 995] The I/O operation ...` error + +This error was caused by a Python bug on Windows. It's been fixed by [cpython #22017](https://github.com/python/cpython/pull/22017), and according to Python's changelog, [3.8.6rc1](https://docs.python.org/3.8/whatsnew/changelog.html#python-3-8-6-release-candidate-1) and [3.9.0rc2](https://docs.python.org/3.9/whatsnew/changelog.html#python-3-9-0-release-candidate-2) should be the accurate versions first contain this fix. In conclusion, upgrade your Python version might solve this issue. + +More discussion can be found in issue [#318](https://github.com/commitizen-tools/commitizen/issues/318). + +## How to change the tag format ? + +You can use the [`legacy_tag_formats`](config/bump.md#legacy_tag_formats) to list old tag formats. +New bumped tags will be in the new format but old ones will still work for: + +- changelog generation (full, incremental and version range) +- bump new version computation (automatically guessed or increment given) + + +So given if you change from `myproject-$version` to `${version}` and then `v${version}`, +your Commitizen configuration will look like this: + +```toml +tag_format = "v${version}" +legacy_tag_formats = [ + "${version}", + "myproject-$version", +] +``` + +## How to avoid warnings for expected non-version tags? + +You can explicitly ignore them with [`ignored_tag_formats`](config/bump.md#ignored_tag_formats). + +```toml +tag_format = "v${version}" +ignored_tag_formats = [ + "stable", + "component-*", + "env/*", + "v${major}.${minor}", +] +``` diff --git a/docs/features_wont_add.md b/docs/features_wont_add.md new file mode 100644 index 0000000000..01b5da1ff7 --- /dev/null +++ b/docs/features_wont_add.md @@ -0,0 +1,71 @@ +# Feature request graveyard + +This page contains features and designs that have been proposed or considered but won't be implemented in Commitizen. + +For a comprehensive list, please refer to our [issue tracker](https://github.com/commitizen-tools/commitizen/issues?q=is:issue%20state:closed%20label:%22issue-status:%20wont-fix%22%20OR%20label:%22issue-status:%20wont-implement%22). + +## Enable multiple locations of config file `.cz.*` [#955](https://github.com/commitizen-tools/commitizen/issues/955) + +<!-- TODO: Add more details about why we won't add this feature --> + +## Create a flag to build the changelog from commits in multiple git repositories [#790](https://github.com/commitizen-tools/commitizen/issues/790) + +<!-- TODO: Add more details about why we won't add this feature --> + +## Global Configuration [#597](https://github.com/commitizen-tools/commitizen/issues/597) + +<!-- TODO: Add more details about why we won't add this feature --> + +## Why are `revert` and `chore` valid types in the check pattern of `cz_conventional_commits` but not types we can select? + +`revert` and `chore` are added to the `pattern` in `cz check` in order to prevent backward errors, but officially they are not part of conventional commits, we are using the latest [types from Angular](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) (they used to but were removed). +However, you can create a customized `cz` with those extra types. (See [Customization](customization/config_file.md)). + +See more discussion in + +- [issue #142](https://github.com/commitizen-tools/commitizen/issues/142) +- [issue #36](https://github.com/commitizen-tools/commitizen/issues/36) + + +## Why does Commitizen not support CalVer? + +`commitizen` could support CalVer alongside SemVer, but in practice implementing CalVer +creates numerous edge cases that are difficult to maintain ([#385]) and more generally, +mixing the two version schemes may not be a good idea. If CalVer or other custom +versioning scheme is needed, `commitizen` could still be used to standardize commits +and create changelogs, but a separate package should be used for version increments. + +Mixing CalVer and SemVer is generally not recommended because each versioning scheme +serves a different purpose. Diverging from either specification can be confusing to +users and cause errors with third-party tools that don't expect the non-standard format. + +In the future, `commitizen` may support some implementation of CalVer, but at the time +of writing, there are no plans to implement the feature ([#173]). + +If you would like to learn more about both schemes, there are plenty of good resources: + +- [Announcing CalVer](https://sedimental.org/calver.html) +- [API Versioning from Stripe](https://stripe.com/blog/api-versioning) +- [Discussion about pip's use of CalVer](https://github.com/pypa/pip/issues/5645#issuecomment-407192448) +- [Git Version Numbering](https://code.erpenbeck.io/git/2021/12/16/git-version-numbering/) +- [SemVer vs. CalVer and Why I Use Both](https://mikestaszel.com/post/semver-vs-calver-and-why-i-use-both/) (but not at the same time) +- [Semver Will Not Save You](https://hynek.me/articles/semver-will-not-save-you/) +- [Why I Don't Like SemVer](https://snarky.ca/why-i-dont-like-semver/) + +[#173]: https://github.com/commitizen-tools/commitizen/issues/173 +[#385]: https://github.com/commitizen-tools/commitizen/pull/385 + + +## Why don't we use [Pydantic](https://docs.pydantic.dev/)? + +While Pydantic is a powerful and popular library for data validation, we intentionally avoid using it in this project to keep our dependency tree minimal and maintainable. + +Including Pydantic would increase the chances of version conflicts for users - especially with major changes introduced in Pydantic v3. Because we pin dependencies tightly, adding Pydantic could unintentionally restrict what other tools or libraries users can install alongside `commitizen`. + +Moreover we don't rely on the full feature set of Pydantic. Simpler alternatives like Python's built-in `TypedDict` offer sufficient type safety for our use cases, without the runtime overhead or dependency burden. + +In short, avoiding Pydantic helps us: + +- Keep dependencies lightweight +- Reduce compatibility issues for users +- Maintain clarity about what contributors should and shouldn't use diff --git a/docs/history.md b/docs/history.md new file mode 100644 index 0000000000..47a726e100 --- /dev/null +++ b/docs/history.md @@ -0,0 +1,23 @@ +## Is this project affiliated with the [cz-cli][cz-cli] project? + +**It is not affiliated.** + +Both are used for similar purposes, parsing commits, generating changelog and version we presume. +Our Commitizen project is written in python to make integration easier for python projects, whereas [cz-cli][cz-cli] is written in JavaScript and serves the JS packages. + +<!-- TODO: Add more details about the differences between Commitizen and cz-cli --> + +They differ a bit in design, not sure if cz-cli does any of this, but these are some things you can do with our Commitizen: + +- create custom rules, version bumps and changelog generation. By default, we use the popular conventional commits (I think cz-cli allows this). +- single package, install one thing and it will work. cz-cli is a monorepo, but you have to install different dependencies as far as I know. +- pre-commit integration +- works on any language project, as long as you create the `.cz.toml` or `cz.toml` file. + +Where do they cross paths? + +If you are using conventional commits in your git history, then you could swap one with the other in theory. + +Regarding the name, [cz-cli][cz-cli] came first, they used the word Commitizen first. When this project was created originally, the creator read "be a good commitizen", and thought it was just a cool word that made sense, and this would be a package that helps you be a good "commit citizen". + +[cz-cli]: https://github.com/commitizen/cz-cli diff --git a/docs/images/bump.gif b/docs/images/bump.gif deleted file mode 100644 index f9c9e0c8a3..0000000000 Binary files a/docs/images/bump.gif and /dev/null differ diff --git a/docs/images/bump.tape b/docs/images/bump.tape new file mode 100644 index 0000000000..08003602e2 --- /dev/null +++ b/docs/images/bump.tape @@ -0,0 +1,134 @@ +Output cli_interactive/bump.gif + +Require cz + +# Use bash for cross-platform compatibility (macOS, Linux, Windows) +Set Shell bash + +Set FontSize 16 +Set Width 878 +Set Height 568 +Set Padding 20 +Set TypingSpeed 50ms + +Set Theme { + "name": "Commitizen", + "black": "#232628", + "red": "#fc4384", + "green": "#b3e33b", + "yellow": "#ffa727", + "blue": "#75dff2", + "magenta": "#ae89fe", + "cyan": "#708387", + "white": "#d5d5d0", + "brightBlack": "#626566", + "brightRed": "#ff7fac", + "brightGreen": "#c8ed71", + "brightYellow": "#ebdf86", + "brightBlue": "#75dff2", + "brightMagenta": "#ae89fe", + "brightCyan": "#b1c6ca", + "brightWhite": "#f9f9f4", + "background": "#1e1e2e", + "foreground": "#afafaf", + "cursor": "#c7c7c7" +} + +# Hide initial shell prompt +Hide + +# Wait for terminal to be ready +Sleep 1s + +# Set a clean, simple prompt (while hidden) +Type "PS1='$ '" +Enter +Sleep 300ms + +# Create a clean temporary directory for recording +Type "rm -rf /tmp/commitizen-example && mkdir -p /tmp/commitizen-example && cd /tmp/commitizen-example" +Enter +Sleep 500ms + +# Initialize git repository +Type "git init" +Enter +Type "git config user.email 'you@example.com'" +Enter +Type "git config user.name 'Your Name'" +Enter +Sleep 500ms + +# Initialize commitizen config with version 0.0.1 and changelog enabled +Type `cat > pyproject.toml << 'EOF'` +Enter +Sleep 100ms +Type `[tool.commitizen]` +Enter +Sleep 100ms +Type `version = "0.0.1"` +Enter +Sleep 100ms +Type `update_changelog_on_bump = true` +Enter +Sleep 100ms +Type "EOF" +Enter +Sleep 300ms + +# Create initial commit (no tag, so cz bump will ask "Is this the first tag created?") +Type "git add pyproject.toml" +Enter +Sleep 300ms + +Type "git commit -m 'chore: initial commit'" +Enter +Sleep 500ms + +# Create a feat commit that will trigger a MINOR bump (0.0.1 -> 0.1.0) +Type "echo 'new feature' > feature.py" +Enter +Sleep 300ms + +Type "git add feature.py" +Enter +Sleep 300ms + +Type "git commit -m 'feat: add awesome new feature'" +Enter +Sleep 500ms + +# Clear the screen to start fresh +Type "clear" +Enter +Sleep 500ms + +# Show commands from here +Show + +# Step 1: Show current version +Type "cz version --project" +Sleep 500ms +Enter +Sleep 1s + +# Step 2: Run cz bump (no existing tag, will prompt for first tag) +Type "cz bump" +Sleep 500ms +Enter + +# Wait for the "Is this the first tag created?" prompt +Sleep 2s + +# Answer Yes to "Is this the first tag created?" (default is Yes, just press Enter) +Enter +Sleep 3s + +# Step 3: Show new version after bump +Type "cz version --project" +Sleep 500ms +Enter +Sleep 1s + +# Wait for final output +Sleep 3s diff --git a/docs/images/cli_help/cz___help.svg b/docs/images/cli_help/cz___help.svg new file mode 100644 index 0000000000..5c8f8fef39 --- /dev/null +++ b/docs/images/cli_help/cz___help.svg @@ -0,0 +1,206 @@ +<svg class="rich-terminal" viewBox="0 0 994 952.8" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-1104329960-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-1104329960-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-1104329960-r1 { fill: #c5c8c6 } +.terminal-1104329960-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-1104329960-r3 { fill: #d0b344 } +.terminal-1104329960-r4 { fill: #1984e9;text-decoration: underline; } +.terminal-1104329960-r5 { fill: #68a0b3;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-1104329960-clip-terminal"> + <rect x="0" y="0" width="975.0" height="901.8" /> + </clipPath> + <clipPath id="terminal-1104329960-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-7"> + <rect x="0" y="172.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-8"> + <rect x="0" y="196.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-9"> + <rect x="0" y="221.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-10"> + <rect x="0" y="245.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-11"> + <rect x="0" y="269.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-12"> + <rect x="0" y="294.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-13"> + <rect x="0" y="318.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-14"> + <rect x="0" y="343.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-15"> + <rect x="0" y="367.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-16"> + <rect x="0" y="391.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-17"> + <rect x="0" y="416.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-18"> + <rect x="0" y="440.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-19"> + <rect x="0" y="465.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-20"> + <rect x="0" y="489.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-21"> + <rect x="0" y="513.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-22"> + <rect x="0" y="538.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-23"> + <rect x="0" y="562.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-24"> + <rect x="0" y="587.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-25"> + <rect x="0" y="611.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-26"> + <rect x="0" y="635.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-27"> + <rect x="0" y="660.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-28"> + <rect x="0" y="684.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-29"> + <rect x="0" y="709.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-30"> + <rect x="0" y="733.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-31"> + <rect x="0" y="757.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-32"> + <rect x="0" y="782.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-33"> + <rect x="0" y="806.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-34"> + <rect x="0" y="831.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1104329960-line-35"> + <rect x="0" y="855.5" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="950.8" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-1104329960-clip-terminal)"> + + <g class="terminal-1104329960-matrix"> + <text class="terminal-1104329960-r1" x="0" y="20" textLength="134.2" clip-path="url(#terminal-1104329960-line-0)">$ cz --help</text><text class="terminal-1104329960-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-1104329960-line-0)"> +</text><text class="terminal-1104329960-r1" x="0" y="44.4" textLength="122" clip-path="url(#terminal-1104329960-line-1)">usage: cz </text><text class="terminal-1104329960-r2" x="122" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">[</text><text class="terminal-1104329960-r1" x="134.2" y="44.4" textLength="24.4" clip-path="url(#terminal-1104329960-line-1)">-h</text><text class="terminal-1104329960-r2" x="158.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">]</text><text class="terminal-1104329960-r2" x="183" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">[</text><text class="terminal-1104329960-r1" x="195.2" y="44.4" textLength="183" clip-path="url(#terminal-1104329960-line-1)">--config CONFIG</text><text class="terminal-1104329960-r2" x="378.2" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">]</text><text class="terminal-1104329960-r2" x="402.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">[</text><text class="terminal-1104329960-r1" x="414.8" y="44.4" textLength="85.4" clip-path="url(#terminal-1104329960-line-1)">--debug</text><text class="terminal-1104329960-r2" x="500.2" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">]</text><text class="terminal-1104329960-r2" x="524.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">[</text><text class="terminal-1104329960-r1" x="536.8" y="44.4" textLength="85.4" clip-path="url(#terminal-1104329960-line-1)">-n NAME</text><text class="terminal-1104329960-r2" x="622.2" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">]</text><text class="terminal-1104329960-r2" x="646.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">[</text><text class="terminal-1104329960-r1" x="658.8" y="44.4" textLength="146.4" clip-path="url(#terminal-1104329960-line-1)">-nr NO_RAISE</text><text class="terminal-1104329960-r2" x="805.2" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)">]</text><text class="terminal-1104329960-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-1)"> +</text><text class="terminal-1104329960-r2" x="122" y="68.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-2)">{</text><text class="terminal-1104329960-r1" x="134.2" y="68.8" textLength="829.6" clip-path="url(#terminal-1104329960-line-2)">init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version</text><text class="terminal-1104329960-r2" x="963.8" y="68.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-2)">}</text><text class="terminal-1104329960-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-2)"> +</text><text class="terminal-1104329960-r3" x="122" y="93.2" textLength="36.6" clip-path="url(#terminal-1104329960-line-3)">...</text><text class="terminal-1104329960-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-3)"> +</text><text class="terminal-1104329960-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-4)"> +</text><text class="terminal-1104329960-r1" x="0" y="142" textLength="915" clip-path="url(#terminal-1104329960-line-5)">Commitizen is a powerful release management tool that helps teams maintain </text><text class="terminal-1104329960-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-1104329960-line-5)"> +</text><text class="terminal-1104329960-r1" x="0" y="166.4" textLength="951.6" clip-path="url(#terminal-1104329960-line-6)">consistent and meaningful commit messages while automating version management.</text><text class="terminal-1104329960-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-6)"> +</text><text class="terminal-1104329960-r1" x="0" y="190.8" textLength="427" clip-path="url(#terminal-1104329960-line-7)">For more information, please visit </text><text class="terminal-1104329960-r4" x="427" y="190.8" textLength="549" clip-path="url(#terminal-1104329960-line-7)">https://commitizen-tools.github.io/commitizen</text><text class="terminal-1104329960-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-7)"> +</text><text class="terminal-1104329960-r1" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-8)"> +</text><text class="terminal-1104329960-r1" x="0" y="239.6" textLength="97.6" clip-path="url(#terminal-1104329960-line-9)">options:</text><text class="terminal-1104329960-r1" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-9)"> +</text><text class="terminal-1104329960-r1" x="0" y="264" textLength="671" clip-path="url(#terminal-1104329960-line-10)">  -h, --help            show this help message and exit</text><text class="terminal-1104329960-r1" x="976" y="264" textLength="12.2" clip-path="url(#terminal-1104329960-line-10)"> +</text><text class="terminal-1104329960-r1" x="0" y="288.4" textLength="719.8" clip-path="url(#terminal-1104329960-line-11)">  --config CONFIG       The path to the configuration file.</text><text class="terminal-1104329960-r1" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-11)"> +</text><text class="terminal-1104329960-r1" x="0" y="312.8" textLength="475.8" clip-path="url(#terminal-1104329960-line-12)">  --debug               Use debug mode.</text><text class="terminal-1104329960-r1" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-12)"> +</text><text class="terminal-1104329960-r1" x="0" y="337.2" textLength="597.8" clip-path="url(#terminal-1104329960-line-13)">  -n NAME, --name NAME  Use the given commitizen </text><text class="terminal-1104329960-r2" x="597.8" y="337.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-13)">(</text><text class="terminal-1104329960-r1" x="610" y="337.2" textLength="97.6" clip-path="url(#terminal-1104329960-line-13)">default:</text><text class="terminal-1104329960-r1" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-13)"> +</text><text class="terminal-1104329960-r1" x="0" y="361.6" textLength="573.4" clip-path="url(#terminal-1104329960-line-14)">                        cz_conventional_commits</text><text class="terminal-1104329960-r2" x="573.4" y="361.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-14)">)</text><text class="terminal-1104329960-r1" x="585.6" y="361.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-14)">.</text><text class="terminal-1104329960-r1" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-14)"> +</text><text class="terminal-1104329960-r1" x="0" y="386" textLength="427" clip-path="url(#terminal-1104329960-line-15)">  -nr NO_RAISE, --no-raise NO_RAISE</text><text class="terminal-1104329960-r1" x="976" y="386" textLength="12.2" clip-path="url(#terminal-1104329960-line-15)"> +</text><text class="terminal-1104329960-r1" x="0" y="410.4" textLength="915" clip-path="url(#terminal-1104329960-line-16)">                        Comma-separated error codes that won't raise error,</text><text class="terminal-1104329960-r1" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-16)"> +</text><text class="terminal-1104329960-r1" x="0" y="434.8" textLength="451.4" clip-path="url(#terminal-1104329960-line-17)">                        e.g., cz -nr </text><text class="terminal-1104329960-r5" x="451.4" y="434.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-17)">1</text><text class="terminal-1104329960-r1" x="463.6" y="434.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-17)">,</text><text class="terminal-1104329960-r5" x="475.8" y="434.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-17)">2</text><text class="terminal-1104329960-r1" x="488" y="434.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-17)">,</text><text class="terminal-1104329960-r5" x="500.2" y="434.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-17)">3</text><text class="terminal-1104329960-r1" x="512.4" y="434.8" textLength="231.8" clip-path="url(#terminal-1104329960-line-17)"> bump. See codes at</text><text class="terminal-1104329960-r1" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-17)"> +</text><text class="terminal-1104329960-r4" x="292.8" y="459.2" textLength="231.8" clip-path="url(#terminal-1104329960-line-18)">https://commitizen-</text><text class="terminal-1104329960-r1" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-18)"> +</text><text class="terminal-1104329960-r1" x="0" y="483.6" textLength="756.4" clip-path="url(#terminal-1104329960-line-19)">                        tools.github.io/commitizen/exit_codes/</text><text class="terminal-1104329960-r1" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-19)"> +</text><text class="terminal-1104329960-r1" x="976" y="508" textLength="12.2" clip-path="url(#terminal-1104329960-line-20)"> +</text><text class="terminal-1104329960-r1" x="0" y="532.4" textLength="109.8" clip-path="url(#terminal-1104329960-line-21)">commands:</text><text class="terminal-1104329960-r1" x="976" y="532.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-21)"> +</text><text class="terminal-1104329960-r2" x="24.4" y="556.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-22)">{</text><text class="terminal-1104329960-r1" x="36.6" y="556.8" textLength="829.6" clip-path="url(#terminal-1104329960-line-22)">init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version</text><text class="terminal-1104329960-r2" x="866.2" y="556.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-22)">}</text><text class="terminal-1104329960-r1" x="976" y="556.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-22)"> +</text><text class="terminal-1104329960-r1" x="0" y="581.2" textLength="732" clip-path="url(#terminal-1104329960-line-23)">    init                Initialize commitizen configuration.</text><text class="terminal-1104329960-r1" x="976" y="581.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-23)"> +</text><text class="terminal-1104329960-r1" x="0" y="605.6" textLength="134.2" clip-path="url(#terminal-1104329960-line-24)">    commit </text><text class="terminal-1104329960-r2" x="134.2" y="605.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-24)">(</text><text class="terminal-1104329960-r1" x="146.4" y="605.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-24)">c</text><text class="terminal-1104329960-r2" x="158.6" y="605.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-24)">)</text><text class="terminal-1104329960-r1" x="170.8" y="605.6" textLength="341.6" clip-path="url(#terminal-1104329960-line-24)">          Create new commit.</text><text class="terminal-1104329960-r1" x="976" y="605.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-24)"> +</text><text class="terminal-1104329960-r1" x="0" y="630" textLength="622.2" clip-path="url(#terminal-1104329960-line-25)">    ls                  Show available Commitizens.</text><text class="terminal-1104329960-r1" x="976" y="630" textLength="12.2" clip-path="url(#terminal-1104329960-line-25)"> +</text><text class="terminal-1104329960-r1" x="0" y="654.4" textLength="536.8" clip-path="url(#terminal-1104329960-line-26)">    example             Show commit example.</text><text class="terminal-1104329960-r1" x="976" y="654.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-26)"> +</text><text class="terminal-1104329960-r1" x="0" y="678.8" textLength="658.8" clip-path="url(#terminal-1104329960-line-27)">    info                Show information about the cz.</text><text class="terminal-1104329960-r1" x="976" y="678.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-27)"> +</text><text class="terminal-1104329960-r1" x="0" y="703.2" textLength="524.6" clip-path="url(#terminal-1104329960-line-28)">    schema              Show commit schema.</text><text class="terminal-1104329960-r1" x="976" y="703.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-28)"> +</text><text class="terminal-1104329960-r1" x="0" y="727.6" textLength="817.4" clip-path="url(#terminal-1104329960-line-29)">    bump                Bump semantic version based on the git log.</text><text class="terminal-1104329960-r1" x="976" y="727.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-29)"> +</text><text class="terminal-1104329960-r1" x="0" y="752" textLength="170.8" clip-path="url(#terminal-1104329960-line-30)">    changelog </text><text class="terminal-1104329960-r2" x="170.8" y="752" textLength="12.2" clip-path="url(#terminal-1104329960-line-30)">(</text><text class="terminal-1104329960-r1" x="183" y="752" textLength="24.4" clip-path="url(#terminal-1104329960-line-30)">ch</text><text class="terminal-1104329960-r2" x="207.4" y="752" textLength="12.2" clip-path="url(#terminal-1104329960-line-30)">)</text><text class="terminal-1104329960-r1" x="219.6" y="752" textLength="305" clip-path="url(#terminal-1104329960-line-30)">      Generate changelog </text><text class="terminal-1104329960-r2" x="524.6" y="752" textLength="12.2" clip-path="url(#terminal-1104329960-line-30)">(</text><text class="terminal-1104329960-r1" x="536.8" y="752" textLength="329.4" clip-path="url(#terminal-1104329960-line-30)">note that it will overwrite</text><text class="terminal-1104329960-r1" x="976" y="752" textLength="12.2" clip-path="url(#terminal-1104329960-line-30)"> +</text><text class="terminal-1104329960-r1" x="0" y="776.4" textLength="463.6" clip-path="url(#terminal-1104329960-line-31)">                        existing files</text><text class="terminal-1104329960-r2" x="463.6" y="776.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-31)">)</text><text class="terminal-1104329960-r1" x="475.8" y="776.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-31)">.</text><text class="terminal-1104329960-r1" x="976" y="776.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-31)"> +</text><text class="terminal-1104329960-r1" x="0" y="800.8" textLength="939.4" clip-path="url(#terminal-1104329960-line-32)">    check               Validate that a commit message matches the commitizen</text><text class="terminal-1104329960-r1" x="976" y="800.8" textLength="12.2" clip-path="url(#terminal-1104329960-line-32)"> +</text><text class="terminal-1104329960-r1" x="0" y="825.2" textLength="378.2" clip-path="url(#terminal-1104329960-line-33)">                        schema.</text><text class="terminal-1104329960-r1" x="976" y="825.2" textLength="12.2" clip-path="url(#terminal-1104329960-line-33)"> +</text><text class="terminal-1104329960-r1" x="0" y="849.6" textLength="902.8" clip-path="url(#terminal-1104329960-line-34)">    version             Get the version of the installed commitizen or the</text><text class="terminal-1104329960-r1" x="976" y="849.6" textLength="12.2" clip-path="url(#terminal-1104329960-line-34)"> +</text><text class="terminal-1104329960-r1" x="0" y="874" textLength="488" clip-path="url(#terminal-1104329960-line-35)">                        current project </text><text class="terminal-1104329960-r2" x="488" y="874" textLength="12.2" clip-path="url(#terminal-1104329960-line-35)">(</text><text class="terminal-1104329960-r1" x="500.2" y="874" textLength="353.8" clip-path="url(#terminal-1104329960-line-35)">default: installed commitizen</text><text class="terminal-1104329960-r2" x="854" y="874" textLength="12.2" clip-path="url(#terminal-1104329960-line-35)">)</text><text class="terminal-1104329960-r1" x="866.2" y="874" textLength="12.2" clip-path="url(#terminal-1104329960-line-35)">.</text><text class="terminal-1104329960-r1" x="976" y="874" textLength="12.2" clip-path="url(#terminal-1104329960-line-35)"> +</text><text class="terminal-1104329960-r1" x="976" y="898.4" textLength="12.2" clip-path="url(#terminal-1104329960-line-36)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_bump___help.svg b/docs/images/cli_help/cz_bump___help.svg new file mode 100644 index 0000000000..42f618ea9c --- /dev/null +++ b/docs/images/cli_help/cz_bump___help.svg @@ -0,0 +1,414 @@ +<svg class="rich-terminal" viewBox="0 0 994 2221.6" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-4007273841-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-4007273841-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-4007273841-r1 { fill: #c5c8c6 } +.terminal-4007273841-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-4007273841-r3 { fill: #68a0b3;font-weight: bold } +.terminal-4007273841-r4 { fill: #98729f;font-weight: bold } +.terminal-4007273841-r5 { fill: #98a84b } + </style> + + <defs> + <clipPath id="terminal-4007273841-clip-terminal"> + <rect x="0" y="0" width="975.0" height="2170.6" /> + </clipPath> + <clipPath id="terminal-4007273841-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-7"> + <rect x="0" y="172.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-8"> + <rect x="0" y="196.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-9"> + <rect x="0" y="221.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-10"> + <rect x="0" y="245.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-11"> + <rect x="0" y="269.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-12"> + <rect x="0" y="294.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-13"> + <rect x="0" y="318.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-14"> + <rect x="0" y="343.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-15"> + <rect x="0" y="367.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-16"> + <rect x="0" y="391.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-17"> + <rect x="0" y="416.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-18"> + <rect x="0" y="440.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-19"> + <rect x="0" y="465.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-20"> + <rect x="0" y="489.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-21"> + <rect x="0" y="513.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-22"> + <rect x="0" y="538.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-23"> + <rect x="0" y="562.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-24"> + <rect x="0" y="587.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-25"> + <rect x="0" y="611.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-26"> + <rect x="0" y="635.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-27"> + <rect x="0" y="660.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-28"> + <rect x="0" y="684.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-29"> + <rect x="0" y="709.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-30"> + <rect x="0" y="733.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-31"> + <rect x="0" y="757.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-32"> + <rect x="0" y="782.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-33"> + <rect x="0" y="806.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-34"> + <rect x="0" y="831.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-35"> + <rect x="0" y="855.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-36"> + <rect x="0" y="879.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-37"> + <rect x="0" y="904.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-38"> + <rect x="0" y="928.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-39"> + <rect x="0" y="953.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-40"> + <rect x="0" y="977.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-41"> + <rect x="0" y="1001.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-42"> + <rect x="0" y="1026.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-43"> + <rect x="0" y="1050.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-44"> + <rect x="0" y="1075.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-45"> + <rect x="0" y="1099.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-46"> + <rect x="0" y="1123.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-47"> + <rect x="0" y="1148.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-48"> + <rect x="0" y="1172.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-49"> + <rect x="0" y="1197.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-50"> + <rect x="0" y="1221.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-51"> + <rect x="0" y="1245.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-52"> + <rect x="0" y="1270.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-53"> + <rect x="0" y="1294.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-54"> + <rect x="0" y="1319.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-55"> + <rect x="0" y="1343.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-56"> + <rect x="0" y="1367.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-57"> + <rect x="0" y="1392.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-58"> + <rect x="0" y="1416.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-59"> + <rect x="0" y="1441.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-60"> + <rect x="0" y="1465.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-61"> + <rect x="0" y="1489.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-62"> + <rect x="0" y="1514.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-63"> + <rect x="0" y="1538.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-64"> + <rect x="0" y="1563.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-65"> + <rect x="0" y="1587.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-66"> + <rect x="0" y="1611.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-67"> + <rect x="0" y="1636.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-68"> + <rect x="0" y="1660.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-69"> + <rect x="0" y="1685.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-70"> + <rect x="0" y="1709.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-71"> + <rect x="0" y="1733.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-72"> + <rect x="0" y="1758.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-73"> + <rect x="0" y="1782.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-74"> + <rect x="0" y="1807.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-75"> + <rect x="0" y="1831.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-76"> + <rect x="0" y="1855.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-77"> + <rect x="0" y="1880.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-78"> + <rect x="0" y="1904.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-79"> + <rect x="0" y="1929.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-80"> + <rect x="0" y="1953.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-81"> + <rect x="0" y="1977.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-82"> + <rect x="0" y="2002.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-83"> + <rect x="0" y="2026.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-84"> + <rect x="0" y="2051.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-85"> + <rect x="0" y="2075.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-86"> + <rect x="0" y="2099.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-4007273841-line-87"> + <rect x="0" y="2124.3" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="2219.6" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-4007273841-clip-terminal)"> + + <g class="terminal-4007273841-matrix"> + <text class="terminal-4007273841-r1" x="0" y="20" textLength="195.2" clip-path="url(#terminal-4007273841-line-0)">$ cz bump --help</text><text class="terminal-4007273841-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-4007273841-line-0)"> +</text><text class="terminal-4007273841-r1" x="0" y="44.4" textLength="183" clip-path="url(#terminal-4007273841-line-1)">usage: cz bump </text><text class="terminal-4007273841-r2" x="183" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">[</text><text class="terminal-4007273841-r1" x="195.2" y="44.4" textLength="24.4" clip-path="url(#terminal-4007273841-line-1)">-h</text><text class="terminal-4007273841-r2" x="219.6" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">]</text><text class="terminal-4007273841-r2" x="244" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">[</text><text class="terminal-4007273841-r1" x="256.2" y="44.4" textLength="109.8" clip-path="url(#terminal-4007273841-line-1)">--dry-run</text><text class="terminal-4007273841-r2" x="366" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">]</text><text class="terminal-4007273841-r2" x="390.4" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">[</text><text class="terminal-4007273841-r1" x="402.6" y="44.4" textLength="146.4" clip-path="url(#terminal-4007273841-line-1)">--files-only</text><text class="terminal-4007273841-r2" x="549" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">]</text><text class="terminal-4007273841-r2" x="573.4" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">[</text><text class="terminal-4007273841-r1" x="585.6" y="44.4" textLength="244" clip-path="url(#terminal-4007273841-line-1)">--version-files-only</text><text class="terminal-4007273841-r2" x="829.6" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)">]</text><text class="terminal-4007273841-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-1)"> +</text><text class="terminal-4007273841-r2" x="183" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">[</text><text class="terminal-4007273841-r1" x="195.2" y="68.8" textLength="183" clip-path="url(#terminal-4007273841-line-2)">--local-version</text><text class="terminal-4007273841-r2" x="378.2" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">]</text><text class="terminal-4007273841-r2" x="402.6" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">[</text><text class="terminal-4007273841-r1" x="414.8" y="68.8" textLength="134.2" clip-path="url(#terminal-4007273841-line-2)">--changelog</text><text class="terminal-4007273841-r2" x="549" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">]</text><text class="terminal-4007273841-r2" x="573.4" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">[</text><text class="terminal-4007273841-r1" x="585.6" y="68.8" textLength="134.2" clip-path="url(#terminal-4007273841-line-2)">--no-verify</text><text class="terminal-4007273841-r2" x="719.8" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">]</text><text class="terminal-4007273841-r2" x="744.2" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">[</text><text class="terminal-4007273841-r1" x="756.4" y="68.8" textLength="61" clip-path="url(#terminal-4007273841-line-2)">--yes</text><text class="terminal-4007273841-r2" x="817.4" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)">]</text><text class="terminal-4007273841-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-2)"> +</text><text class="terminal-4007273841-r2" x="183" y="93.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-3)">[</text><text class="terminal-4007273841-r1" x="195.2" y="93.2" textLength="280.6" clip-path="url(#terminal-4007273841-line-3)">--tag-format TAG_FORMAT</text><text class="terminal-4007273841-r2" x="475.8" y="93.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-3)">]</text><text class="terminal-4007273841-r2" x="500.2" y="93.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-3)">[</text><text class="terminal-4007273841-r1" x="512.4" y="93.2" textLength="329.4" clip-path="url(#terminal-4007273841-line-3)">--bump-message BUMP_MESSAGE</text><text class="terminal-4007273841-r2" x="841.8" y="93.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-3)">]</text><text class="terminal-4007273841-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-3)"> +</text><text class="terminal-4007273841-r2" x="183" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)">[</text><text class="terminal-4007273841-r1" x="195.2" y="117.6" textLength="158.6" clip-path="url(#terminal-4007273841-line-4)">--prerelease </text><text class="terminal-4007273841-r2" x="353.8" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)">{</text><text class="terminal-4007273841-r1" x="366" y="117.6" textLength="158.6" clip-path="url(#terminal-4007273841-line-4)">alpha,beta,rc</text><text class="terminal-4007273841-r2" x="524.6" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)">}</text><text class="terminal-4007273841-r2" x="536.8" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)">]</text><text class="terminal-4007273841-r2" x="561.2" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)">[</text><text class="terminal-4007273841-r1" x="573.4" y="117.6" textLength="280.6" clip-path="url(#terminal-4007273841-line-4)">--devrelease DEVRELEASE</text><text class="terminal-4007273841-r2" x="854" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)">]</text><text class="terminal-4007273841-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-4)"> +</text><text class="terminal-4007273841-r2" x="183" y="142" textLength="12.2" clip-path="url(#terminal-4007273841-line-5)">[</text><text class="terminal-4007273841-r1" x="195.2" y="142" textLength="146.4" clip-path="url(#terminal-4007273841-line-5)">--increment </text><text class="terminal-4007273841-r2" x="341.6" y="142" textLength="12.2" clip-path="url(#terminal-4007273841-line-5)">{</text><text class="terminal-4007273841-r1" x="353.8" y="142" textLength="207.4" clip-path="url(#terminal-4007273841-line-5)">MAJOR,MINOR,PATCH</text><text class="terminal-4007273841-r2" x="561.2" y="142" textLength="12.2" clip-path="url(#terminal-4007273841-line-5)">}</text><text class="terminal-4007273841-r2" x="573.4" y="142" textLength="12.2" clip-path="url(#terminal-4007273841-line-5)">]</text><text class="terminal-4007273841-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-4007273841-line-5)"> +</text><text class="terminal-4007273841-r2" x="183" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)">[</text><text class="terminal-4007273841-r1" x="195.2" y="166.4" textLength="207.4" clip-path="url(#terminal-4007273841-line-6)">--increment-mode </text><text class="terminal-4007273841-r2" x="402.6" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)">{</text><text class="terminal-4007273841-r1" x="414.8" y="166.4" textLength="146.4" clip-path="url(#terminal-4007273841-line-6)">linear,exact</text><text class="terminal-4007273841-r2" x="561.2" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)">}</text><text class="terminal-4007273841-r2" x="573.4" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)">]</text><text class="terminal-4007273841-r2" x="597.8" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)">[</text><text class="terminal-4007273841-r1" x="610" y="166.4" textLength="231.8" clip-path="url(#terminal-4007273841-line-6)">--check-consistency</text><text class="terminal-4007273841-r2" x="841.8" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)">]</text><text class="terminal-4007273841-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-6)"> +</text><text class="terminal-4007273841-r2" x="183" y="190.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-7)">[</text><text class="terminal-4007273841-r1" x="195.2" y="190.8" textLength="183" clip-path="url(#terminal-4007273841-line-7)">--annotated-tag</text><text class="terminal-4007273841-r2" x="378.2" y="190.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-7)">]</text><text class="terminal-4007273841-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-7)"> +</text><text class="terminal-4007273841-r2" x="183" y="215.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-8)">[</text><text class="terminal-4007273841-r1" x="195.2" y="215.2" textLength="549" clip-path="url(#terminal-4007273841-line-8)">--annotated-tag-message ANNOTATED_TAG_MESSAGE</text><text class="terminal-4007273841-r2" x="744.2" y="215.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-8)">]</text><text class="terminal-4007273841-r2" x="768.6" y="215.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-8)">[</text><text class="terminal-4007273841-r1" x="780.8" y="215.2" textLength="122" clip-path="url(#terminal-4007273841-line-8)">--gpg-sign</text><text class="terminal-4007273841-r2" x="902.8" y="215.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-8)">]</text><text class="terminal-4007273841-r1" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-8)"> +</text><text class="terminal-4007273841-r2" x="183" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)">[</text><text class="terminal-4007273841-r1" x="195.2" y="239.6" textLength="256.2" clip-path="url(#terminal-4007273841-line-9)">--changelog-to-stdout</text><text class="terminal-4007273841-r2" x="451.4" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)">]</text><text class="terminal-4007273841-r2" x="475.8" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)">[</text><text class="terminal-4007273841-r1" x="488" y="239.6" textLength="268.4" clip-path="url(#terminal-4007273841-line-9)">--git-output-to-stderr</text><text class="terminal-4007273841-r2" x="756.4" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)">]</text><text class="terminal-4007273841-r2" x="780.8" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)">[</text><text class="terminal-4007273841-r1" x="793" y="239.6" textLength="85.4" clip-path="url(#terminal-4007273841-line-9)">--retry</text><text class="terminal-4007273841-r2" x="878.4" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)">]</text><text class="terminal-4007273841-r1" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-9)"> +</text><text class="terminal-4007273841-r2" x="183" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)">[</text><text class="terminal-4007273841-r1" x="195.2" y="264" textLength="244" clip-path="url(#terminal-4007273841-line-10)">--major-version-zero</text><text class="terminal-4007273841-r2" x="439.2" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)">]</text><text class="terminal-4007273841-r2" x="463.6" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)">[</text><text class="terminal-4007273841-r1" x="475.8" y="264" textLength="231.8" clip-path="url(#terminal-4007273841-line-10)">--template TEMPLATE</text><text class="terminal-4007273841-r2" x="707.6" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)">]</text><text class="terminal-4007273841-r2" x="732" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)">[</text><text class="terminal-4007273841-r1" x="744.2" y="264" textLength="158.6" clip-path="url(#terminal-4007273841-line-10)">--extra EXTRA</text><text class="terminal-4007273841-r2" x="902.8" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)">]</text><text class="terminal-4007273841-r1" x="976" y="264" textLength="12.2" clip-path="url(#terminal-4007273841-line-10)"> +</text><text class="terminal-4007273841-r2" x="183" y="288.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-11)">[</text><text class="terminal-4007273841-r1" x="195.2" y="288.4" textLength="256.2" clip-path="url(#terminal-4007273841-line-11)">--file-name FILE_NAME</text><text class="terminal-4007273841-r2" x="451.4" y="288.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-11)">]</text><text class="terminal-4007273841-r2" x="475.8" y="288.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-11)">[</text><text class="terminal-4007273841-r1" x="488" y="288.4" textLength="451.4" clip-path="url(#terminal-4007273841-line-11)">--prerelease-offset PRERELEASE_OFFSET</text><text class="terminal-4007273841-r2" x="939.4" y="288.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-11)">]</text><text class="terminal-4007273841-r1" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-11)"> +</text><text class="terminal-4007273841-r2" x="183" y="312.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-12)">[</text><text class="terminal-4007273841-r1" x="195.2" y="312.8" textLength="207.4" clip-path="url(#terminal-4007273841-line-12)">--version-scheme </text><text class="terminal-4007273841-r2" x="402.6" y="312.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-12)">{</text><text class="terminal-4007273841-r1" x="414.8" y="312.8" textLength="256.2" clip-path="url(#terminal-4007273841-line-12)">pep440,semver,semver2</text><text class="terminal-4007273841-r2" x="671" y="312.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-12)">}</text><text class="terminal-4007273841-r2" x="683.2" y="312.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-12)">]</text><text class="terminal-4007273841-r1" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-12)"> +</text><text class="terminal-4007273841-r2" x="183" y="337.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-13)">[</text><text class="terminal-4007273841-r1" x="195.2" y="337.2" textLength="183" clip-path="url(#terminal-4007273841-line-13)">--version-type </text><text class="terminal-4007273841-r2" x="378.2" y="337.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-13)">{</text><text class="terminal-4007273841-r1" x="390.4" y="337.2" textLength="256.2" clip-path="url(#terminal-4007273841-line-13)">pep440,semver,semver2</text><text class="terminal-4007273841-r2" x="646.6" y="337.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-13)">}</text><text class="terminal-4007273841-r2" x="658.8" y="337.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-13)">]</text><text class="terminal-4007273841-r1" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-13)"> +</text><text class="terminal-4007273841-r2" x="183" y="361.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-14)">[</text><text class="terminal-4007273841-r1" x="195.2" y="361.6" textLength="378.2" clip-path="url(#terminal-4007273841-line-14)">--build-metadata BUILD_METADATA</text><text class="terminal-4007273841-r2" x="573.4" y="361.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-14)">]</text><text class="terminal-4007273841-r2" x="597.8" y="361.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-14)">[</text><text class="terminal-4007273841-r1" x="610" y="361.6" textLength="122" clip-path="url(#terminal-4007273841-line-14)">--get-next</text><text class="terminal-4007273841-r2" x="732" y="361.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-14)">]</text><text class="terminal-4007273841-r1" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-14)"> +</text><text class="terminal-4007273841-r2" x="183" y="386" textLength="12.2" clip-path="url(#terminal-4007273841-line-15)">[</text><text class="terminal-4007273841-r1" x="195.2" y="386" textLength="207.4" clip-path="url(#terminal-4007273841-line-15)">--allow-no-commit</text><text class="terminal-4007273841-r2" x="402.6" y="386" textLength="12.2" clip-path="url(#terminal-4007273841-line-15)">]</text><text class="terminal-4007273841-r1" x="976" y="386" textLength="12.2" clip-path="url(#terminal-4007273841-line-15)"> +</text><text class="terminal-4007273841-r2" x="183" y="410.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-16)">[</text><text class="terminal-4007273841-r1" x="195.2" y="410.4" textLength="170.8" clip-path="url(#terminal-4007273841-line-16)">MANUAL_VERSION</text><text class="terminal-4007273841-r2" x="366" y="410.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-16)">]</text><text class="terminal-4007273841-r1" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-16)"> +</text><text class="terminal-4007273841-r1" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-17)"> +</text><text class="terminal-4007273841-r1" x="0" y="459.2" textLength="512.4" clip-path="url(#terminal-4007273841-line-18)">Bump semantic version based on the git log</text><text class="terminal-4007273841-r1" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-18)"> +</text><text class="terminal-4007273841-r1" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-19)"> +</text><text class="terminal-4007273841-r1" x="0" y="508" textLength="256.2" clip-path="url(#terminal-4007273841-line-20)">positional arguments:</text><text class="terminal-4007273841-r1" x="976" y="508" textLength="12.2" clip-path="url(#terminal-4007273841-line-20)"> +</text><text class="terminal-4007273841-r1" x="0" y="532.4" textLength="610" clip-path="url(#terminal-4007273841-line-21)">  MANUAL_VERSION        Bump to the given version </text><text class="terminal-4007273841-r2" x="610" y="532.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-21)">(</text><text class="terminal-4007273841-r1" x="622.2" y="532.4" textLength="73.2" clip-path="url(#terminal-4007273841-line-21)">e.g., </text><text class="terminal-4007273841-r3" x="695.4" y="532.4" textLength="36.6" clip-path="url(#terminal-4007273841-line-21)">1.5</text><text class="terminal-4007273841-r1" x="732" y="532.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-21)">.</text><text class="terminal-4007273841-r3" x="744.2" y="532.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-21)">3</text><text class="terminal-4007273841-r2" x="756.4" y="532.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-21)">)</text><text class="terminal-4007273841-r1" x="768.6" y="532.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-21)">.</text><text class="terminal-4007273841-r1" x="976" y="532.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-21)"> +</text><text class="terminal-4007273841-r1" x="976" y="556.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-22)"> +</text><text class="terminal-4007273841-r1" x="0" y="581.2" textLength="97.6" clip-path="url(#terminal-4007273841-line-23)">options:</text><text class="terminal-4007273841-r1" x="976" y="581.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-23)"> +</text><text class="terminal-4007273841-r1" x="0" y="605.6" textLength="671" clip-path="url(#terminal-4007273841-line-24)">  -h, --help            show this help message and exit</text><text class="terminal-4007273841-r1" x="976" y="605.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-24)"> +</text><text class="terminal-4007273841-r1" x="0" y="630" textLength="902.8" clip-path="url(#terminal-4007273841-line-25)">  --dry-run             Perform a dry run, without committing or modifying</text><text class="terminal-4007273841-r1" x="976" y="630" textLength="12.2" clip-path="url(#terminal-4007273841-line-25)"> +</text><text class="terminal-4007273841-r1" x="0" y="654.4" textLength="366" clip-path="url(#terminal-4007273841-line-26)">                        files.</text><text class="terminal-4007273841-r1" x="976" y="654.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-26)"> +</text><text class="terminal-4007273841-r1" x="0" y="678.8" textLength="927.2" clip-path="url(#terminal-4007273841-line-27)">  --files-only          Bump version in the `version_files` specified in the</text><text class="terminal-4007273841-r1" x="976" y="678.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-27)"> +</text><text class="terminal-4007273841-r1" x="0" y="703.2" textLength="524.6" clip-path="url(#terminal-4007273841-line-28)">                        configuration file </text><text class="terminal-4007273841-r4" x="524.6" y="703.2" textLength="48.8" clip-path="url(#terminal-4007273841-line-28)">only</text><text class="terminal-4007273841-r2" x="573.4" y="703.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-28)">(</text><text class="terminal-4007273841-r1" x="585.6" y="703.2" textLength="317.2" clip-path="url(#terminal-4007273841-line-28)">deprecated; use --version-</text><text class="terminal-4007273841-r1" x="976" y="703.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-28)"> +</text><text class="terminal-4007273841-r1" x="0" y="727.6" textLength="512.4" clip-path="url(#terminal-4007273841-line-29)">                        files-only instead</text><text class="terminal-4007273841-r2" x="512.4" y="727.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-29)">)</text><text class="terminal-4007273841-r1" x="524.6" y="727.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-29)">.</text><text class="terminal-4007273841-r1" x="976" y="727.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-29)"> +</text><text class="terminal-4007273841-r1" x="0" y="752" textLength="793" clip-path="url(#terminal-4007273841-line-30)">  --version-files-only  Bump version in the files from the config</text><text class="terminal-4007273841-r1" x="976" y="752" textLength="12.2" clip-path="url(#terminal-4007273841-line-30)"> +</text><text class="terminal-4007273841-r1" x="0" y="776.4" textLength="829.6" clip-path="url(#terminal-4007273841-line-31)">  --local-version       Bump version only the local version portion </text><text class="terminal-4007273841-r2" x="829.6" y="776.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-31)">(</text><text class="terminal-4007273841-r1" x="841.8" y="776.4" textLength="97.6" clip-path="url(#terminal-4007273841-line-31)">ignoring</text><text class="terminal-4007273841-r1" x="976" y="776.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-31)"> +</text><text class="terminal-4007273841-r1" x="0" y="800.8" textLength="512.4" clip-path="url(#terminal-4007273841-line-32)">                        the public version</text><text class="terminal-4007273841-r2" x="512.4" y="800.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-32)">)</text><text class="terminal-4007273841-r1" x="524.6" y="800.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-32)">.</text><text class="terminal-4007273841-r1" x="976" y="800.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-32)"> +</text><text class="terminal-4007273841-r1" x="0" y="825.2" textLength="854" clip-path="url(#terminal-4007273841-line-33)">  --changelog, -ch      Generate the changelog for the latest version.</text><text class="terminal-4007273841-r1" x="976" y="825.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-33)"> +</text><text class="terminal-4007273841-r1" x="0" y="849.6" textLength="817.4" clip-path="url(#terminal-4007273841-line-34)">  --no-verify           Bypass the pre-commit and commit-msg hooks.</text><text class="terminal-4007273841-r1" x="976" y="849.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-34)"> +</text><text class="terminal-4007273841-r1" x="0" y="874" textLength="780.8" clip-path="url(#terminal-4007273841-line-35)">  --yes                 Accept automatically answered questions.</text><text class="terminal-4007273841-r1" x="976" y="874" textLength="12.2" clip-path="url(#terminal-4007273841-line-35)"> +</text><text class="terminal-4007273841-r1" x="0" y="898.4" textLength="305" clip-path="url(#terminal-4007273841-line-36)">  --tag-format TAG_FORMAT</text><text class="terminal-4007273841-r1" x="976" y="898.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-36)"> +</text><text class="terminal-4007273841-r1" x="0" y="922.8" textLength="939.4" clip-path="url(#terminal-4007273841-line-37)">                        The format used to tag the commit and read it. Use it</text><text class="terminal-4007273841-r1" x="976" y="922.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-37)"> +</text><text class="terminal-4007273841-r1" x="0" y="947.2" textLength="927.2" clip-path="url(#terminal-4007273841-line-38)">                        in existing projects, and wrap around simple quotes.</text><text class="terminal-4007273841-r1" x="976" y="947.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-38)"> +</text><text class="terminal-4007273841-r1" x="0" y="971.6" textLength="353.8" clip-path="url(#terminal-4007273841-line-39)">  --bump-message BUMP_MESSAGE</text><text class="terminal-4007273841-r1" x="976" y="971.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-39)"> +</text><text class="terminal-4007273841-r1" x="0" y="996" textLength="902.8" clip-path="url(#terminal-4007273841-line-40)">                        Template used to create the release commit, useful</text><text class="terminal-4007273841-r1" x="976" y="996" textLength="12.2" clip-path="url(#terminal-4007273841-line-40)"> +</text><text class="terminal-4007273841-r1" x="0" y="1020.4" textLength="549" clip-path="url(#terminal-4007273841-line-41)">                        when working with CI.</text><text class="terminal-4007273841-r1" x="976" y="1020.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-41)"> +</text><text class="terminal-4007273841-r1" x="0" y="1044.8" textLength="183" clip-path="url(#terminal-4007273841-line-42)">  --prerelease </text><text class="terminal-4007273841-r2" x="183" y="1044.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-42)">{</text><text class="terminal-4007273841-r1" x="195.2" y="1044.8" textLength="158.6" clip-path="url(#terminal-4007273841-line-42)">alpha,beta,rc</text><text class="terminal-4007273841-r2" x="353.8" y="1044.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-42)">}</text><text class="terminal-4007273841-r1" x="366" y="1044.8" textLength="73.2" clip-path="url(#terminal-4007273841-line-42)">, -pr </text><text class="terminal-4007273841-r2" x="439.2" y="1044.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-42)">{</text><text class="terminal-4007273841-r1" x="451.4" y="1044.8" textLength="158.6" clip-path="url(#terminal-4007273841-line-42)">alpha,beta,rc</text><text class="terminal-4007273841-r2" x="610" y="1044.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-42)">}</text><text class="terminal-4007273841-r1" x="976" y="1044.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-42)"> +</text><text class="terminal-4007273841-r1" x="0" y="1069.2" textLength="524.6" clip-path="url(#terminal-4007273841-line-43)">                        Type of prerelease.</text><text class="terminal-4007273841-r1" x="976" y="1069.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-43)"> +</text><text class="terminal-4007273841-r1" x="0" y="1093.6" textLength="488" clip-path="url(#terminal-4007273841-line-44)">  --devrelease DEVRELEASE, -d DEVRELEASE</text><text class="terminal-4007273841-r1" x="976" y="1093.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-44)"> +</text><text class="terminal-4007273841-r1" x="0" y="1118" textLength="841.8" clip-path="url(#terminal-4007273841-line-45)">                        Specify non-negative integer for dev release.</text><text class="terminal-4007273841-r1" x="976" y="1118" textLength="12.2" clip-path="url(#terminal-4007273841-line-45)"> +</text><text class="terminal-4007273841-r1" x="0" y="1142.4" textLength="170.8" clip-path="url(#terminal-4007273841-line-46)">  --increment </text><text class="terminal-4007273841-r2" x="170.8" y="1142.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-46)">{</text><text class="terminal-4007273841-r1" x="183" y="1142.4" textLength="207.4" clip-path="url(#terminal-4007273841-line-46)">MAJOR,MINOR,PATCH</text><text class="terminal-4007273841-r2" x="390.4" y="1142.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-46)">}</text><text class="terminal-4007273841-r1" x="976" y="1142.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-46)"> +</text><text class="terminal-4007273841-r1" x="0" y="1166.8" textLength="658.8" clip-path="url(#terminal-4007273841-line-47)">                        Specify the desired increment.</text><text class="terminal-4007273841-r1" x="976" y="1166.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-47)"> +</text><text class="terminal-4007273841-r1" x="0" y="1191.2" textLength="231.8" clip-path="url(#terminal-4007273841-line-48)">  --increment-mode </text><text class="terminal-4007273841-r2" x="231.8" y="1191.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-48)">{</text><text class="terminal-4007273841-r1" x="244" y="1191.2" textLength="146.4" clip-path="url(#terminal-4007273841-line-48)">linear,exact</text><text class="terminal-4007273841-r2" x="390.4" y="1191.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-48)">}</text><text class="terminal-4007273841-r1" x="976" y="1191.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-48)"> +</text><text class="terminal-4007273841-r1" x="0" y="1215.6" textLength="902.8" clip-path="url(#terminal-4007273841-line-49)">                        Set the method by which the new version is chosen.</text><text class="terminal-4007273841-r1" x="976" y="1215.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-49)"> +</text><text class="terminal-4007273841-r5" x="292.8" y="1240" textLength="97.6" clip-path="url(#terminal-4007273841-line-50)">'linear'</text><text class="terminal-4007273841-r2" x="402.6" y="1240" textLength="12.2" clip-path="url(#terminal-4007273841-line-50)">(</text><text class="terminal-4007273841-r1" x="414.8" y="1240" textLength="85.4" clip-path="url(#terminal-4007273841-line-50)">default</text><text class="terminal-4007273841-r2" x="500.2" y="1240" textLength="12.2" clip-path="url(#terminal-4007273841-line-50)">)</text><text class="terminal-4007273841-r1" x="512.4" y="1240" textLength="427" clip-path="url(#terminal-4007273841-line-50)"> resolves the next version based on</text><text class="terminal-4007273841-r1" x="976" y="1240" textLength="12.2" clip-path="url(#terminal-4007273841-line-50)"> +</text><text class="terminal-4007273841-r1" x="0" y="1264.4" textLength="951.6" clip-path="url(#terminal-4007273841-line-51)">                        typical linear version progression, where bumping of a</text><text class="terminal-4007273841-r1" x="976" y="1264.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-51)"> +</text><text class="terminal-4007273841-r1" x="0" y="1288.8" textLength="902.8" clip-path="url(#terminal-4007273841-line-52)">                        pre-release with lower precedence than the current</text><text class="terminal-4007273841-r1" x="976" y="1288.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-52)"> +</text><text class="terminal-4007273841-r1" x="0" y="1313.2" textLength="878.4" clip-path="url(#terminal-4007273841-line-53)">                        pre-release phase maintains the current phase of</text><text class="terminal-4007273841-r1" x="976" y="1313.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-53)"> +</text><text class="terminal-4007273841-r1" x="0" y="1337.6" textLength="524.6" clip-path="url(#terminal-4007273841-line-54)">                        higher precedence. </text><text class="terminal-4007273841-r5" x="524.6" y="1337.6" textLength="85.4" clip-path="url(#terminal-4007273841-line-54)">'exact'</text><text class="terminal-4007273841-r1" x="610" y="1337.6" textLength="305" clip-path="url(#terminal-4007273841-line-54)"> applies the changes that</text><text class="terminal-4007273841-r1" x="976" y="1337.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-54)"> +</text><text class="terminal-4007273841-r1" x="0" y="1362" textLength="536.8" clip-path="url(#terminal-4007273841-line-55)">                        have been specified </text><text class="terminal-4007273841-r2" x="536.8" y="1362" textLength="12.2" clip-path="url(#terminal-4007273841-line-55)">(</text><text class="terminal-4007273841-r1" x="549" y="1362" textLength="353.8" clip-path="url(#terminal-4007273841-line-55)">or determined from the commit</text><text class="terminal-4007273841-r1" x="976" y="1362" textLength="12.2" clip-path="url(#terminal-4007273841-line-55)"> +</text><text class="terminal-4007273841-r1" x="0" y="1386.4" textLength="329.4" clip-path="url(#terminal-4007273841-line-56)">                        log</text><text class="terminal-4007273841-r2" x="329.4" y="1386.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-56)">)</text><text class="terminal-4007273841-r1" x="341.6" y="1386.4" textLength="573.4" clip-path="url(#terminal-4007273841-line-56)"> without interpretation, ensuring the increment</text><text class="terminal-4007273841-r1" x="976" y="1386.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-56)"> +</text><text class="terminal-4007273841-r1" x="0" y="1410.8" textLength="719.8" clip-path="url(#terminal-4007273841-line-57)">                        and pre-release are always honored.</text><text class="terminal-4007273841-r1" x="976" y="1410.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-57)"> +</text><text class="terminal-4007273841-r1" x="0" y="1435.2" textLength="317.2" clip-path="url(#terminal-4007273841-line-58)">  --check-consistency, -cc</text><text class="terminal-4007273841-r1" x="976" y="1435.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-58)"> +</text><text class="terminal-4007273841-r1" x="0" y="1459.6" textLength="951.6" clip-path="url(#terminal-4007273841-line-59)">                        Check consistency among versions defined in Commitizen</text><text class="terminal-4007273841-r1" x="976" y="1459.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-59)"> +</text><text class="terminal-4007273841-r1" x="0" y="1484" textLength="768.6" clip-path="url(#terminal-4007273841-line-60)">                        configuration file and `version_files`.</text><text class="terminal-4007273841-r1" x="976" y="1484" textLength="12.2" clip-path="url(#terminal-4007273841-line-60)"> +</text><text class="terminal-4007273841-r1" x="0" y="1508.4" textLength="878.4" clip-path="url(#terminal-4007273841-line-61)">  --annotated-tag, -at  Create annotated tag instead of lightweight one.</text><text class="terminal-4007273841-r1" x="976" y="1508.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-61)"> +</text><text class="terminal-4007273841-r1" x="0" y="1532.8" textLength="915" clip-path="url(#terminal-4007273841-line-62)">  --annotated-tag-message ANNOTATED_TAG_MESSAGE, -atm ANNOTATED_TAG_MESSAGE</text><text class="terminal-4007273841-r1" x="976" y="1532.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-62)"> +</text><text class="terminal-4007273841-r1" x="0" y="1557.2" textLength="646.6" clip-path="url(#terminal-4007273841-line-63)">                        Create annotated tag message.</text><text class="terminal-4007273841-r1" x="976" y="1557.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-63)"> +</text><text class="terminal-4007273841-r1" x="0" y="1581.6" textLength="732" clip-path="url(#terminal-4007273841-line-64)">  --gpg-sign, -s        Sign tag instead of lightweight one.</text><text class="terminal-4007273841-r1" x="976" y="1581.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-64)"> +</text><text class="terminal-4007273841-r1" x="0" y="1606" textLength="280.6" clip-path="url(#terminal-4007273841-line-65)">  --changelog-to-stdout</text><text class="terminal-4007273841-r1" x="976" y="1606" textLength="12.2" clip-path="url(#terminal-4007273841-line-65)"> +</text><text class="terminal-4007273841-r1" x="0" y="1630.4" textLength="622.2" clip-path="url(#terminal-4007273841-line-66)">                        Output changelog to stdout.</text><text class="terminal-4007273841-r1" x="976" y="1630.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-66)"> +</text><text class="terminal-4007273841-r1" x="0" y="1654.8" textLength="292.8" clip-path="url(#terminal-4007273841-line-67)">  --git-output-to-stderr</text><text class="terminal-4007273841-r1" x="976" y="1654.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-67)"> +</text><text class="terminal-4007273841-r1" x="0" y="1679.2" textLength="658.8" clip-path="url(#terminal-4007273841-line-68)">                        Redirect git output to stderr.</text><text class="terminal-4007273841-r1" x="976" y="1679.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-68)"> +</text><text class="terminal-4007273841-r1" x="0" y="1703.6" textLength="829.6" clip-path="url(#terminal-4007273841-line-69)">  --retry               Retry commit if it fails for the first time.</text><text class="terminal-4007273841-r1" x="976" y="1703.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-69)"> +</text><text class="terminal-4007273841-r1" x="0" y="1728" textLength="951.6" clip-path="url(#terminal-4007273841-line-70)">  --major-version-zero  Keep major version at zero, even for breaking changes.</text><text class="terminal-4007273841-r1" x="976" y="1728" textLength="12.2" clip-path="url(#terminal-4007273841-line-70)"> +</text><text class="terminal-4007273841-r1" x="0" y="1752.4" textLength="414.8" clip-path="url(#terminal-4007273841-line-71)">  --template TEMPLATE, -t TEMPLATE</text><text class="terminal-4007273841-r1" x="976" y="1752.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-71)"> +</text><text class="terminal-4007273841-r1" x="0" y="1776.8" textLength="646.6" clip-path="url(#terminal-4007273841-line-72)">                        Changelog template file name </text><text class="terminal-4007273841-r2" x="646.6" y="1776.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-72)">(</text><text class="terminal-4007273841-r1" x="658.8" y="1776.8" textLength="280.6" clip-path="url(#terminal-4007273841-line-72)">relative to the current</text><text class="terminal-4007273841-r1" x="976" y="1776.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-72)"> +</text><text class="terminal-4007273841-r1" x="0" y="1801.2" textLength="500.2" clip-path="url(#terminal-4007273841-line-73)">                        working directory</text><text class="terminal-4007273841-r2" x="500.2" y="1801.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-73)">)</text><text class="terminal-4007273841-r1" x="512.4" y="1801.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-73)">.</text><text class="terminal-4007273841-r1" x="976" y="1801.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-73)"> +</text><text class="terminal-4007273841-r1" x="0" y="1825.6" textLength="305" clip-path="url(#terminal-4007273841-line-74)">  --extra EXTRA, -e EXTRA</text><text class="terminal-4007273841-r1" x="976" y="1825.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-74)"> +</text><text class="terminal-4007273841-r1" x="0" y="1850" textLength="610" clip-path="url(#terminal-4007273841-line-75)">                        Changelog extra variables </text><text class="terminal-4007273841-r2" x="610" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)">(</text><text class="terminal-4007273841-r1" x="622.2" y="1850" textLength="146.4" clip-path="url(#terminal-4007273841-line-75)">in the form </text><text class="terminal-4007273841-r5" x="768.6" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)">'</text><text class="terminal-4007273841-r5" x="780.8" y="1850" textLength="36.6" clip-path="url(#terminal-4007273841-line-75)">key</text><text class="terminal-4007273841-r5" x="817.4" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)">=</text><text class="terminal-4007273841-r5" x="829.6" y="1850" textLength="61" clip-path="url(#terminal-4007273841-line-75)">value</text><text class="terminal-4007273841-r5" x="890.6" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)">'</text><text class="terminal-4007273841-r2" x="902.8" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)">)</text><text class="terminal-4007273841-r1" x="915" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)">.</text><text class="terminal-4007273841-r1" x="976" y="1850" textLength="12.2" clip-path="url(#terminal-4007273841-line-75)"> +</text><text class="terminal-4007273841-r1" x="0" y="1874.4" textLength="280.6" clip-path="url(#terminal-4007273841-line-76)">  --file-name FILE_NAME</text><text class="terminal-4007273841-r1" x="976" y="1874.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-76)"> +</text><text class="terminal-4007273841-r1" x="0" y="1898.8" textLength="573.4" clip-path="url(#terminal-4007273841-line-77)">                        File name of changelog </text><text class="terminal-4007273841-r2" x="573.4" y="1898.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-77)">(</text><text class="terminal-4007273841-r1" x="585.6" y="1898.8" textLength="109.8" clip-path="url(#terminal-4007273841-line-77)">default: </text><text class="terminal-4007273841-r5" x="695.4" y="1898.8" textLength="170.8" clip-path="url(#terminal-4007273841-line-77)">'CHANGELOG.md'</text><text class="terminal-4007273841-r2" x="866.2" y="1898.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-77)">)</text><text class="terminal-4007273841-r1" x="878.4" y="1898.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-77)">.</text><text class="terminal-4007273841-r1" x="976" y="1898.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-77)"> +</text><text class="terminal-4007273841-r1" x="0" y="1923.2" textLength="475.8" clip-path="url(#terminal-4007273841-line-78)">  --prerelease-offset PRERELEASE_OFFSET</text><text class="terminal-4007273841-r1" x="976" y="1923.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-78)"> +</text><text class="terminal-4007273841-r1" x="0" y="1947.6" textLength="732" clip-path="url(#terminal-4007273841-line-79)">                        Start pre-releases with this offset.</text><text class="terminal-4007273841-r1" x="976" y="1947.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-79)"> +</text><text class="terminal-4007273841-r1" x="0" y="1972" textLength="231.8" clip-path="url(#terminal-4007273841-line-80)">  --version-scheme </text><text class="terminal-4007273841-r2" x="231.8" y="1972" textLength="12.2" clip-path="url(#terminal-4007273841-line-80)">{</text><text class="terminal-4007273841-r1" x="244" y="1972" textLength="256.2" clip-path="url(#terminal-4007273841-line-80)">pep440,semver,semver2</text><text class="terminal-4007273841-r2" x="500.2" y="1972" textLength="12.2" clip-path="url(#terminal-4007273841-line-80)">}</text><text class="terminal-4007273841-r1" x="976" y="1972" textLength="12.2" clip-path="url(#terminal-4007273841-line-80)"> +</text><text class="terminal-4007273841-r1" x="0" y="1996.4" textLength="561.2" clip-path="url(#terminal-4007273841-line-81)">                        Choose version scheme.</text><text class="terminal-4007273841-r1" x="976" y="1996.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-81)"> +</text><text class="terminal-4007273841-r1" x="0" y="2020.8" textLength="207.4" clip-path="url(#terminal-4007273841-line-82)">  --version-type </text><text class="terminal-4007273841-r2" x="207.4" y="2020.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-82)">{</text><text class="terminal-4007273841-r1" x="219.6" y="2020.8" textLength="256.2" clip-path="url(#terminal-4007273841-line-82)">pep440,semver,semver2</text><text class="terminal-4007273841-r2" x="475.8" y="2020.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-82)">}</text><text class="terminal-4007273841-r1" x="976" y="2020.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-82)"> +</text><text class="terminal-4007273841-r1" x="0" y="2045.2" textLength="817.4" clip-path="url(#terminal-4007273841-line-83)">                        Deprecated, use `--version-scheme` instead.</text><text class="terminal-4007273841-r1" x="976" y="2045.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-83)"> +</text><text class="terminal-4007273841-r1" x="0" y="2069.6" textLength="402.6" clip-path="url(#terminal-4007273841-line-84)">  --build-metadata BUILD_METADATA</text><text class="terminal-4007273841-r1" x="976" y="2069.6" textLength="12.2" clip-path="url(#terminal-4007273841-line-84)"> +</text><text class="terminal-4007273841-r1" x="0" y="2094" textLength="927.2" clip-path="url(#terminal-4007273841-line-85)">                        Add additional build-metadata to the version-number.</text><text class="terminal-4007273841-r1" x="976" y="2094" textLength="12.2" clip-path="url(#terminal-4007273841-line-85)"> +</text><text class="terminal-4007273841-r1" x="0" y="2118.4" textLength="866.2" clip-path="url(#terminal-4007273841-line-86)">  --get-next            Determine the next version and write to stdout.</text><text class="terminal-4007273841-r1" x="976" y="2118.4" textLength="12.2" clip-path="url(#terminal-4007273841-line-86)"> +</text><text class="terminal-4007273841-r1" x="0" y="2142.8" textLength="756.4" clip-path="url(#terminal-4007273841-line-87)">  --allow-no-commit     Bump version without eligible commits.</text><text class="terminal-4007273841-r1" x="976" y="2142.8" textLength="12.2" clip-path="url(#terminal-4007273841-line-87)"> +</text><text class="terminal-4007273841-r1" x="976" y="2167.2" textLength="12.2" clip-path="url(#terminal-4007273841-line-88)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_changelog___help.svg b/docs/images/cli_help/cz_changelog___help.svg new file mode 100644 index 0000000000..00031d48f6 --- /dev/null +++ b/docs/images/cli_help/cz_changelog___help.svg @@ -0,0 +1,233 @@ +<svg class="rich-terminal" viewBox="0 0 994 1123.6" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-771491591-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-771491591-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-771491591-r1 { fill: #c5c8c6 } +.terminal-771491591-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-771491591-r3 { fill: #68a0b3;font-weight: bold } +.terminal-771491591-r4 { fill: #98a84b } + </style> + + <defs> + <clipPath id="terminal-771491591-clip-terminal"> + <rect x="0" y="0" width="975.0" height="1072.6" /> + </clipPath> + <clipPath id="terminal-771491591-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-7"> + <rect x="0" y="172.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-8"> + <rect x="0" y="196.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-9"> + <rect x="0" y="221.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-10"> + <rect x="0" y="245.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-11"> + <rect x="0" y="269.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-12"> + <rect x="0" y="294.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-13"> + <rect x="0" y="318.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-14"> + <rect x="0" y="343.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-15"> + <rect x="0" y="367.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-16"> + <rect x="0" y="391.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-17"> + <rect x="0" y="416.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-18"> + <rect x="0" y="440.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-19"> + <rect x="0" y="465.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-20"> + <rect x="0" y="489.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-21"> + <rect x="0" y="513.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-22"> + <rect x="0" y="538.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-23"> + <rect x="0" y="562.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-24"> + <rect x="0" y="587.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-25"> + <rect x="0" y="611.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-26"> + <rect x="0" y="635.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-27"> + <rect x="0" y="660.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-28"> + <rect x="0" y="684.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-29"> + <rect x="0" y="709.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-30"> + <rect x="0" y="733.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-31"> + <rect x="0" y="757.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-32"> + <rect x="0" y="782.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-33"> + <rect x="0" y="806.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-34"> + <rect x="0" y="831.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-35"> + <rect x="0" y="855.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-36"> + <rect x="0" y="879.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-37"> + <rect x="0" y="904.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-38"> + <rect x="0" y="928.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-39"> + <rect x="0" y="953.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-40"> + <rect x="0" y="977.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-41"> + <rect x="0" y="1001.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-771491591-line-42"> + <rect x="0" y="1026.3" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="1121.6" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-771491591-clip-terminal)"> + + <g class="terminal-771491591-matrix"> + <text class="terminal-771491591-r1" x="0" y="20" textLength="256.2" clip-path="url(#terminal-771491591-line-0)">$ cz changelog --help</text><text class="terminal-771491591-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-771491591-line-0)"> +</text><text class="terminal-771491591-r1" x="0" y="44.4" textLength="244" clip-path="url(#terminal-771491591-line-1)">usage: cz changelog </text><text class="terminal-771491591-r2" x="244" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)">[</text><text class="terminal-771491591-r1" x="256.2" y="44.4" textLength="24.4" clip-path="url(#terminal-771491591-line-1)">-h</text><text class="terminal-771491591-r2" x="280.6" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)">]</text><text class="terminal-771491591-r2" x="305" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)">[</text><text class="terminal-771491591-r1" x="317.2" y="44.4" textLength="109.8" clip-path="url(#terminal-771491591-line-1)">--dry-run</text><text class="terminal-771491591-r2" x="427" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)">]</text><text class="terminal-771491591-r2" x="451.4" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)">[</text><text class="terminal-771491591-r1" x="463.6" y="44.4" textLength="256.2" clip-path="url(#terminal-771491591-line-1)">--file-name FILE_NAME</text><text class="terminal-771491591-r2" x="719.8" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)">]</text><text class="terminal-771491591-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-771491591-line-1)"> +</text><text class="terminal-771491591-r2" x="244" y="68.8" textLength="12.2" clip-path="url(#terminal-771491591-line-2)">[</text><text class="terminal-771491591-r1" x="256.2" y="68.8" textLength="475.8" clip-path="url(#terminal-771491591-line-2)">--unreleased-version UNRELEASED_VERSION</text><text class="terminal-771491591-r2" x="732" y="68.8" textLength="12.2" clip-path="url(#terminal-771491591-line-2)">]</text><text class="terminal-771491591-r2" x="756.4" y="68.8" textLength="12.2" clip-path="url(#terminal-771491591-line-2)">[</text><text class="terminal-771491591-r1" x="768.6" y="68.8" textLength="158.6" clip-path="url(#terminal-771491591-line-2)">--incremental</text><text class="terminal-771491591-r2" x="927.2" y="68.8" textLength="12.2" clip-path="url(#terminal-771491591-line-2)">]</text><text class="terminal-771491591-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-771491591-line-2)"> +</text><text class="terminal-771491591-r2" x="244" y="93.2" textLength="12.2" clip-path="url(#terminal-771491591-line-3)">[</text><text class="terminal-771491591-r1" x="256.2" y="93.2" textLength="256.2" clip-path="url(#terminal-771491591-line-3)">--start-rev START_REV</text><text class="terminal-771491591-r2" x="512.4" y="93.2" textLength="12.2" clip-path="url(#terminal-771491591-line-3)">]</text><text class="terminal-771491591-r2" x="536.8" y="93.2" textLength="12.2" clip-path="url(#terminal-771491591-line-3)">[</text><text class="terminal-771491591-r1" x="549" y="93.2" textLength="219.6" clip-path="url(#terminal-771491591-line-3)">--merge-prerelease</text><text class="terminal-771491591-r2" x="768.6" y="93.2" textLength="12.2" clip-path="url(#terminal-771491591-line-3)">]</text><text class="terminal-771491591-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-771491591-line-3)"> +</text><text class="terminal-771491591-r2" x="244" y="117.6" textLength="12.2" clip-path="url(#terminal-771491591-line-4)">[</text><text class="terminal-771491591-r1" x="256.2" y="117.6" textLength="207.4" clip-path="url(#terminal-771491591-line-4)">--version-scheme </text><text class="terminal-771491591-r2" x="463.6" y="117.6" textLength="12.2" clip-path="url(#terminal-771491591-line-4)">{</text><text class="terminal-771491591-r1" x="475.8" y="117.6" textLength="256.2" clip-path="url(#terminal-771491591-line-4)">pep440,semver,semver2</text><text class="terminal-771491591-r2" x="732" y="117.6" textLength="12.2" clip-path="url(#terminal-771491591-line-4)">}</text><text class="terminal-771491591-r2" x="744.2" y="117.6" textLength="12.2" clip-path="url(#terminal-771491591-line-4)">]</text><text class="terminal-771491591-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-771491591-line-4)"> +</text><text class="terminal-771491591-r2" x="244" y="142" textLength="12.2" clip-path="url(#terminal-771491591-line-5)">[</text><text class="terminal-771491591-r1" x="256.2" y="142" textLength="402.6" clip-path="url(#terminal-771491591-line-5)">--export-template EXPORT_TEMPLATE</text><text class="terminal-771491591-r2" x="658.8" y="142" textLength="12.2" clip-path="url(#terminal-771491591-line-5)">]</text><text class="terminal-771491591-r2" x="683.2" y="142" textLength="12.2" clip-path="url(#terminal-771491591-line-5)">[</text><text class="terminal-771491591-r1" x="695.4" y="142" textLength="231.8" clip-path="url(#terminal-771491591-line-5)">--template TEMPLATE</text><text class="terminal-771491591-r2" x="927.2" y="142" textLength="12.2" clip-path="url(#terminal-771491591-line-5)">]</text><text class="terminal-771491591-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-771491591-line-5)"> +</text><text class="terminal-771491591-r2" x="244" y="166.4" textLength="12.2" clip-path="url(#terminal-771491591-line-6)">[</text><text class="terminal-771491591-r1" x="256.2" y="166.4" textLength="158.6" clip-path="url(#terminal-771491591-line-6)">--extra EXTRA</text><text class="terminal-771491591-r2" x="414.8" y="166.4" textLength="12.2" clip-path="url(#terminal-771491591-line-6)">]</text><text class="terminal-771491591-r2" x="439.2" y="166.4" textLength="12.2" clip-path="url(#terminal-771491591-line-6)">[</text><text class="terminal-771491591-r1" x="451.4" y="166.4" textLength="280.6" clip-path="url(#terminal-771491591-line-6)">--tag-format TAG_FORMAT</text><text class="terminal-771491591-r2" x="732" y="166.4" textLength="12.2" clip-path="url(#terminal-771491591-line-6)">]</text><text class="terminal-771491591-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-771491591-line-6)"> +</text><text class="terminal-771491591-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-771491591-line-7)"> +</text><text class="terminal-771491591-r1" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-771491591-line-8)"> +</text><text class="terminal-771491591-r1" x="0" y="239.6" textLength="231.8" clip-path="url(#terminal-771491591-line-9)">Generate changelog </text><text class="terminal-771491591-r2" x="231.8" y="239.6" textLength="12.2" clip-path="url(#terminal-771491591-line-9)">(</text><text class="terminal-771491591-r1" x="244" y="239.6" textLength="512.4" clip-path="url(#terminal-771491591-line-9)">note that it will overwrite existing files</text><text class="terminal-771491591-r2" x="756.4" y="239.6" textLength="12.2" clip-path="url(#terminal-771491591-line-9)">)</text><text class="terminal-771491591-r1" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-771491591-line-9)"> +</text><text class="terminal-771491591-r1" x="976" y="264" textLength="12.2" clip-path="url(#terminal-771491591-line-10)"> +</text><text class="terminal-771491591-r1" x="0" y="288.4" textLength="256.2" clip-path="url(#terminal-771491591-line-11)">positional arguments:</text><text class="terminal-771491591-r1" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-771491591-line-11)"> +</text><text class="terminal-771491591-r1" x="0" y="312.8" textLength="793" clip-path="url(#terminal-771491591-line-12)">  rev_range             Generate changelog for the given version </text><text class="terminal-771491591-r2" x="793" y="312.8" textLength="12.2" clip-path="url(#terminal-771491591-line-12)">(</text><text class="terminal-771491591-r1" x="805.2" y="312.8" textLength="73.2" clip-path="url(#terminal-771491591-line-12)">e.g., </text><text class="terminal-771491591-r3" x="878.4" y="312.8" textLength="36.6" clip-path="url(#terminal-771491591-line-12)">1.5</text><text class="terminal-771491591-r1" x="915" y="312.8" textLength="12.2" clip-path="url(#terminal-771491591-line-12)">.</text><text class="terminal-771491591-r3" x="927.2" y="312.8" textLength="12.2" clip-path="url(#terminal-771491591-line-12)">3</text><text class="terminal-771491591-r2" x="939.4" y="312.8" textLength="12.2" clip-path="url(#terminal-771491591-line-12)">)</text><text class="terminal-771491591-r1" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-771491591-line-12)"> +</text><text class="terminal-771491591-r1" x="0" y="337.2" textLength="500.2" clip-path="url(#terminal-771491591-line-13)">                        or version range </text><text class="terminal-771491591-r2" x="500.2" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">(</text><text class="terminal-771491591-r1" x="512.4" y="337.2" textLength="73.2" clip-path="url(#terminal-771491591-line-13)">e.g., </text><text class="terminal-771491591-r3" x="585.6" y="337.2" textLength="36.6" clip-path="url(#terminal-771491591-line-13)">1.5</text><text class="terminal-771491591-r1" x="622.2" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">.</text><text class="terminal-771491591-r3" x="634.4" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">3</text><text class="terminal-771491591-r1" x="646.6" y="337.2" textLength="24.4" clip-path="url(#terminal-771491591-line-13)">..</text><text class="terminal-771491591-r3" x="671" y="337.2" textLength="36.6" clip-path="url(#terminal-771491591-line-13)">1.7</text><text class="terminal-771491591-r1" x="707.6" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">.</text><text class="terminal-771491591-r3" x="719.8" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">9</text><text class="terminal-771491591-r2" x="732" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">)</text><text class="terminal-771491591-r1" x="744.2" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)">.</text><text class="terminal-771491591-r1" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-771491591-line-13)"> +</text><text class="terminal-771491591-r1" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-771491591-line-14)"> +</text><text class="terminal-771491591-r1" x="0" y="386" textLength="97.6" clip-path="url(#terminal-771491591-line-15)">options:</text><text class="terminal-771491591-r1" x="976" y="386" textLength="12.2" clip-path="url(#terminal-771491591-line-15)"> +</text><text class="terminal-771491591-r1" x="0" y="410.4" textLength="671" clip-path="url(#terminal-771491591-line-16)">  -h, --help            show this help message and exit</text><text class="terminal-771491591-r1" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-771491591-line-16)"> +</text><text class="terminal-771491591-r1" x="0" y="434.8" textLength="597.8" clip-path="url(#terminal-771491591-line-17)">  --dry-run             Show changelog to stdout.</text><text class="terminal-771491591-r1" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-771491591-line-17)"> +</text><text class="terminal-771491591-r1" x="0" y="459.2" textLength="280.6" clip-path="url(#terminal-771491591-line-18)">  --file-name FILE_NAME</text><text class="terminal-771491591-r1" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-771491591-line-18)"> +</text><text class="terminal-771491591-r1" x="0" y="483.6" textLength="573.4" clip-path="url(#terminal-771491591-line-19)">                        File name of changelog </text><text class="terminal-771491591-r2" x="573.4" y="483.6" textLength="12.2" clip-path="url(#terminal-771491591-line-19)">(</text><text class="terminal-771491591-r1" x="585.6" y="483.6" textLength="109.8" clip-path="url(#terminal-771491591-line-19)">default: </text><text class="terminal-771491591-r4" x="695.4" y="483.6" textLength="170.8" clip-path="url(#terminal-771491591-line-19)">'CHANGELOG.md'</text><text class="terminal-771491591-r2" x="866.2" y="483.6" textLength="12.2" clip-path="url(#terminal-771491591-line-19)">)</text><text class="terminal-771491591-r1" x="878.4" y="483.6" textLength="12.2" clip-path="url(#terminal-771491591-line-19)">.</text><text class="terminal-771491591-r1" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-771491591-line-19)"> +</text><text class="terminal-771491591-r1" x="0" y="508" textLength="500.2" clip-path="url(#terminal-771491591-line-20)">  --unreleased-version UNRELEASED_VERSION</text><text class="terminal-771491591-r1" x="976" y="508" textLength="12.2" clip-path="url(#terminal-771491591-line-20)"> +</text><text class="terminal-771491591-r1" x="0" y="532.4" textLength="707.6" clip-path="url(#terminal-771491591-line-21)">                        Set the value for the new version </text><text class="terminal-771491591-r2" x="707.6" y="532.4" textLength="12.2" clip-path="url(#terminal-771491591-line-21)">(</text><text class="terminal-771491591-r1" x="719.8" y="532.4" textLength="207.4" clip-path="url(#terminal-771491591-line-21)">use the tag value</text><text class="terminal-771491591-r2" x="927.2" y="532.4" textLength="12.2" clip-path="url(#terminal-771491591-line-21)">)</text><text class="terminal-771491591-r1" x="939.4" y="532.4" textLength="12.2" clip-path="url(#terminal-771491591-line-21)">,</text><text class="terminal-771491591-r1" x="976" y="532.4" textLength="12.2" clip-path="url(#terminal-771491591-line-21)"> +</text><text class="terminal-771491591-r1" x="0" y="556.8" textLength="744.2" clip-path="url(#terminal-771491591-line-22)">                        instead of using unreleased versions.</text><text class="terminal-771491591-r1" x="976" y="556.8" textLength="12.2" clip-path="url(#terminal-771491591-line-22)"> +</text><text class="terminal-771491591-r1" x="0" y="581.2" textLength="890.6" clip-path="url(#terminal-771491591-line-23)">  --incremental         Generate changelog from the last created version,</text><text class="terminal-771491591-r1" x="976" y="581.2" textLength="12.2" clip-path="url(#terminal-771491591-line-23)"> +</text><text class="terminal-771491591-r1" x="0" y="605.6" textLength="915" clip-path="url(#terminal-771491591-line-24)">                        useful if the changelog has been manually modified.</text><text class="terminal-771491591-r1" x="976" y="605.6" textLength="12.2" clip-path="url(#terminal-771491591-line-24)"> +</text><text class="terminal-771491591-r1" x="0" y="630" textLength="280.6" clip-path="url(#terminal-771491591-line-25)">  --start-rev START_REV</text><text class="terminal-771491591-r1" x="976" y="630" textLength="12.2" clip-path="url(#terminal-771491591-line-25)"> +</text><text class="terminal-771491591-r1" x="0" y="654.4" textLength="866.2" clip-path="url(#terminal-771491591-line-26)">                        Start rev of the changelog. If not set, it will</text><text class="terminal-771491591-r1" x="976" y="654.4" textLength="12.2" clip-path="url(#terminal-771491591-line-26)"> +</text><text class="terminal-771491591-r1" x="0" y="678.8" textLength="756.4" clip-path="url(#terminal-771491591-line-27)">                        generate changelog from the beginning.</text><text class="terminal-771491591-r1" x="976" y="678.8" textLength="12.2" clip-path="url(#terminal-771491591-line-27)"> +</text><text class="terminal-771491591-r1" x="0" y="703.2" textLength="902.8" clip-path="url(#terminal-771491591-line-28)">  --merge-prerelease    Collect all changes from prereleases into the next</text><text class="terminal-771491591-r1" x="976" y="703.2" textLength="12.2" clip-path="url(#terminal-771491591-line-28)"> +</text><text class="terminal-771491591-r1" x="0" y="727.6" textLength="817.4" clip-path="url(#terminal-771491591-line-29)">                        non-prerelease. If not set, it will include</text><text class="terminal-771491591-r1" x="976" y="727.6" textLength="12.2" clip-path="url(#terminal-771491591-line-29)"> +</text><text class="terminal-771491591-r1" x="0" y="752" textLength="646.6" clip-path="url(#terminal-771491591-line-30)">                        prereleases in the changelog.</text><text class="terminal-771491591-r1" x="976" y="752" textLength="12.2" clip-path="url(#terminal-771491591-line-30)"> +</text><text class="terminal-771491591-r1" x="0" y="776.4" textLength="231.8" clip-path="url(#terminal-771491591-line-31)">  --version-scheme </text><text class="terminal-771491591-r2" x="231.8" y="776.4" textLength="12.2" clip-path="url(#terminal-771491591-line-31)">{</text><text class="terminal-771491591-r1" x="244" y="776.4" textLength="256.2" clip-path="url(#terminal-771491591-line-31)">pep440,semver,semver2</text><text class="terminal-771491591-r2" x="500.2" y="776.4" textLength="12.2" clip-path="url(#terminal-771491591-line-31)">}</text><text class="terminal-771491591-r1" x="976" y="776.4" textLength="12.2" clip-path="url(#terminal-771491591-line-31)"> +</text><text class="terminal-771491591-r1" x="0" y="800.8" textLength="561.2" clip-path="url(#terminal-771491591-line-32)">                        Choose version scheme.</text><text class="terminal-771491591-r1" x="976" y="800.8" textLength="12.2" clip-path="url(#terminal-771491591-line-32)"> +</text><text class="terminal-771491591-r1" x="0" y="825.2" textLength="427" clip-path="url(#terminal-771491591-line-33)">  --export-template EXPORT_TEMPLATE</text><text class="terminal-771491591-r1" x="976" y="825.2" textLength="12.2" clip-path="url(#terminal-771491591-line-33)"> +</text><text class="terminal-771491591-r1" x="0" y="849.6" textLength="927.2" clip-path="url(#terminal-771491591-line-34)">                        Export the changelog template into this file instead</text><text class="terminal-771491591-r1" x="976" y="849.6" textLength="12.2" clip-path="url(#terminal-771491591-line-34)"> +</text><text class="terminal-771491591-r1" x="0" y="874" textLength="488" clip-path="url(#terminal-771491591-line-35)">                        of rendering it.</text><text class="terminal-771491591-r1" x="976" y="874" textLength="12.2" clip-path="url(#terminal-771491591-line-35)"> +</text><text class="terminal-771491591-r1" x="0" y="898.4" textLength="414.8" clip-path="url(#terminal-771491591-line-36)">  --template TEMPLATE, -t TEMPLATE</text><text class="terminal-771491591-r1" x="976" y="898.4" textLength="12.2" clip-path="url(#terminal-771491591-line-36)"> +</text><text class="terminal-771491591-r1" x="0" y="922.8" textLength="646.6" clip-path="url(#terminal-771491591-line-37)">                        Changelog template file name </text><text class="terminal-771491591-r2" x="646.6" y="922.8" textLength="12.2" clip-path="url(#terminal-771491591-line-37)">(</text><text class="terminal-771491591-r1" x="658.8" y="922.8" textLength="280.6" clip-path="url(#terminal-771491591-line-37)">relative to the current</text><text class="terminal-771491591-r1" x="976" y="922.8" textLength="12.2" clip-path="url(#terminal-771491591-line-37)"> +</text><text class="terminal-771491591-r1" x="0" y="947.2" textLength="500.2" clip-path="url(#terminal-771491591-line-38)">                        working directory</text><text class="terminal-771491591-r2" x="500.2" y="947.2" textLength="12.2" clip-path="url(#terminal-771491591-line-38)">)</text><text class="terminal-771491591-r1" x="512.4" y="947.2" textLength="12.2" clip-path="url(#terminal-771491591-line-38)">.</text><text class="terminal-771491591-r1" x="976" y="947.2" textLength="12.2" clip-path="url(#terminal-771491591-line-38)"> +</text><text class="terminal-771491591-r1" x="0" y="971.6" textLength="305" clip-path="url(#terminal-771491591-line-39)">  --extra EXTRA, -e EXTRA</text><text class="terminal-771491591-r1" x="976" y="971.6" textLength="12.2" clip-path="url(#terminal-771491591-line-39)"> +</text><text class="terminal-771491591-r1" x="0" y="996" textLength="610" clip-path="url(#terminal-771491591-line-40)">                        Changelog extra variables </text><text class="terminal-771491591-r2" x="610" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)">(</text><text class="terminal-771491591-r1" x="622.2" y="996" textLength="146.4" clip-path="url(#terminal-771491591-line-40)">in the form </text><text class="terminal-771491591-r4" x="768.6" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)">'</text><text class="terminal-771491591-r4" x="780.8" y="996" textLength="36.6" clip-path="url(#terminal-771491591-line-40)">key</text><text class="terminal-771491591-r4" x="817.4" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)">=</text><text class="terminal-771491591-r4" x="829.6" y="996" textLength="61" clip-path="url(#terminal-771491591-line-40)">value</text><text class="terminal-771491591-r4" x="890.6" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)">'</text><text class="terminal-771491591-r2" x="902.8" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)">)</text><text class="terminal-771491591-r1" x="915" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)">.</text><text class="terminal-771491591-r1" x="976" y="996" textLength="12.2" clip-path="url(#terminal-771491591-line-40)"> +</text><text class="terminal-771491591-r1" x="0" y="1020.4" textLength="305" clip-path="url(#terminal-771491591-line-41)">  --tag-format TAG_FORMAT</text><text class="terminal-771491591-r1" x="976" y="1020.4" textLength="12.2" clip-path="url(#terminal-771491591-line-41)"> +</text><text class="terminal-771491591-r1" x="0" y="1044.8" textLength="890.6" clip-path="url(#terminal-771491591-line-42)">                        The format of the tag, wrap around simple quotes.</text><text class="terminal-771491591-r1" x="976" y="1044.8" textLength="12.2" clip-path="url(#terminal-771491591-line-42)"> +</text><text class="terminal-771491591-r1" x="976" y="1069.2" textLength="12.2" clip-path="url(#terminal-771491591-line-43)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_check___help.svg b/docs/images/cli_help/cz_check___help.svg new file mode 100644 index 0000000000..57dd5ee1a4 --- /dev/null +++ b/docs/images/cli_help/cz_check___help.svg @@ -0,0 +1,185 @@ +<svg class="rich-terminal" viewBox="0 0 994 830.8" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-3704235523-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-3704235523-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-3704235523-r1 { fill: #c5c8c6 } +.terminal-3704235523-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-3704235523-r3 { fill: #d0b344 } +.terminal-3704235523-r4 { fill: #68a0b3;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-3704235523-clip-terminal"> + <rect x="0" y="0" width="975.0" height="779.8" /> + </clipPath> + <clipPath id="terminal-3704235523-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-7"> + <rect x="0" y="172.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-8"> + <rect x="0" y="196.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-9"> + <rect x="0" y="221.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-10"> + <rect x="0" y="245.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-11"> + <rect x="0" y="269.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-12"> + <rect x="0" y="294.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-13"> + <rect x="0" y="318.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-14"> + <rect x="0" y="343.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-15"> + <rect x="0" y="367.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-16"> + <rect x="0" y="391.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-17"> + <rect x="0" y="416.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-18"> + <rect x="0" y="440.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-19"> + <rect x="0" y="465.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-20"> + <rect x="0" y="489.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-21"> + <rect x="0" y="513.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-22"> + <rect x="0" y="538.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-23"> + <rect x="0" y="562.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-24"> + <rect x="0" y="587.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-25"> + <rect x="0" y="611.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-26"> + <rect x="0" y="635.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-27"> + <rect x="0" y="660.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-28"> + <rect x="0" y="684.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-29"> + <rect x="0" y="709.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3704235523-line-30"> + <rect x="0" y="733.5" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="828.8" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-3704235523-clip-terminal)"> + + <g class="terminal-3704235523-matrix"> + <text class="terminal-3704235523-r1" x="0" y="20" textLength="207.4" clip-path="url(#terminal-3704235523-line-0)">$ cz check --help</text><text class="terminal-3704235523-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-3704235523-line-0)"> +</text><text class="terminal-3704235523-r1" x="0" y="44.4" textLength="195.2" clip-path="url(#terminal-3704235523-line-1)">usage: cz check </text><text class="terminal-3704235523-r2" x="195.2" y="44.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-1)">[</text><text class="terminal-3704235523-r1" x="207.4" y="44.4" textLength="24.4" clip-path="url(#terminal-3704235523-line-1)">-h</text><text class="terminal-3704235523-r2" x="231.8" y="44.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-1)">]</text><text class="terminal-3704235523-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-1)"> +</text><text class="terminal-3704235523-r2" x="195.2" y="68.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-2)">[</text><text class="terminal-3704235523-r1" x="207.4" y="68.8" textLength="768.6" clip-path="url(#terminal-3704235523-line-2)">--commit-msg-file COMMIT_MSG_FILE | --rev-range REV_RANGE | -d </text><text class="terminal-3704235523-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-2)"> +</text><text class="terminal-3704235523-r1" x="0" y="93.2" textLength="146.4" clip-path="url(#terminal-3704235523-line-3)">| -m MESSAGE</text><text class="terminal-3704235523-r2" x="146.4" y="93.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-3)">]</text><text class="terminal-3704235523-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-3)"> +</text><text class="terminal-3704235523-r2" x="195.2" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)">[</text><text class="terminal-3704235523-r1" x="207.4" y="117.6" textLength="158.6" clip-path="url(#terminal-3704235523-line-4)">--allow-abort</text><text class="terminal-3704235523-r2" x="366" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)">]</text><text class="terminal-3704235523-r2" x="390.4" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)">[</text><text class="terminal-3704235523-r1" x="402.6" y="117.6" textLength="231.8" clip-path="url(#terminal-3704235523-line-4)">--allowed-prefixes </text><text class="terminal-3704235523-r2" x="634.4" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)">[</text><text class="terminal-3704235523-r1" x="646.6" y="117.6" textLength="207.4" clip-path="url(#terminal-3704235523-line-4)">ALLOWED_PREFIXES </text><text class="terminal-3704235523-r3" x="854" y="117.6" textLength="36.6" clip-path="url(#terminal-3704235523-line-4)">...</text><text class="terminal-3704235523-r2" x="890.6" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)">]</text><text class="terminal-3704235523-r2" x="902.8" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)">]</text><text class="terminal-3704235523-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-4)"> +</text><text class="terminal-3704235523-r2" x="195.2" y="142" textLength="12.2" clip-path="url(#terminal-3704235523-line-5)">[</text><text class="terminal-3704235523-r1" x="207.4" y="142" textLength="280.6" clip-path="url(#terminal-3704235523-line-5)">-l MESSAGE_LENGTH_LIMIT</text><text class="terminal-3704235523-r2" x="488" y="142" textLength="12.2" clip-path="url(#terminal-3704235523-line-5)">]</text><text class="terminal-3704235523-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-3704235523-line-5)"> +</text><text class="terminal-3704235523-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-6)"> +</text><text class="terminal-3704235523-r1" x="0" y="190.8" textLength="732" clip-path="url(#terminal-3704235523-line-7)">Validate that a commit message matches the commitizen schema</text><text class="terminal-3704235523-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-7)"> +</text><text class="terminal-3704235523-r1" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-8)"> +</text><text class="terminal-3704235523-r1" x="0" y="239.6" textLength="97.6" clip-path="url(#terminal-3704235523-line-9)">options:</text><text class="terminal-3704235523-r1" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-9)"> +</text><text class="terminal-3704235523-r1" x="0" y="264" textLength="671" clip-path="url(#terminal-3704235523-line-10)">  -h, --help            show this help message and exit</text><text class="terminal-3704235523-r1" x="976" y="264" textLength="12.2" clip-path="url(#terminal-3704235523-line-10)"> +</text><text class="terminal-3704235523-r1" x="0" y="288.4" textLength="427" clip-path="url(#terminal-3704235523-line-11)">  --commit-msg-file COMMIT_MSG_FILE</text><text class="terminal-3704235523-r1" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-11)"> +</text><text class="terminal-3704235523-r1" x="0" y="312.8" textLength="927.2" clip-path="url(#terminal-3704235523-line-12)">                        Ask for the name of the temporary file that contains</text><text class="terminal-3704235523-r1" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-12)"> +</text><text class="terminal-3704235523-r1" x="0" y="337.2" textLength="878.4" clip-path="url(#terminal-3704235523-line-13)">                        the commit message. Use it in a git hook script:</text><text class="terminal-3704235523-r1" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-13)"> +</text><text class="terminal-3704235523-r3" x="292.8" y="361.6" textLength="97.6" clip-path="url(#terminal-3704235523-line-14)">MSG_FILE</text><text class="terminal-3704235523-r1" x="390.4" y="361.6" textLength="24.4" clip-path="url(#terminal-3704235523-line-14)">=$</text><text class="terminal-3704235523-r4" x="414.8" y="361.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-14)">1</text><text class="terminal-3704235523-r1" x="427" y="361.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-14)">.</text><text class="terminal-3704235523-r1" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-14)"> +</text><text class="terminal-3704235523-r1" x="0" y="386" textLength="280.6" clip-path="url(#terminal-3704235523-line-15)">  --rev-range REV_RANGE</text><text class="terminal-3704235523-r1" x="976" y="386" textLength="12.2" clip-path="url(#terminal-3704235523-line-15)"> +</text><text class="terminal-3704235523-r1" x="0" y="410.4" textLength="915" clip-path="url(#terminal-3704235523-line-16)">                        Validate the commits in the given range of git rev,</text><text class="terminal-3704235523-r1" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-16)"> +</text><text class="terminal-3704235523-r1" x="0" y="434.8" textLength="524.6" clip-path="url(#terminal-3704235523-line-17)">                        e.g., master..HEAD.</text><text class="terminal-3704235523-r1" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-17)"> +</text><text class="terminal-3704235523-r1" x="0" y="459.2" textLength="305" clip-path="url(#terminal-3704235523-line-18)">  -d, --use-default-range</text><text class="terminal-3704235523-r1" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-18)"> +</text><text class="terminal-3704235523-r1" x="0" y="483.6" textLength="939.4" clip-path="url(#terminal-3704235523-line-19)">                        Validate the commits from the default branch to HEAD,</text><text class="terminal-3704235523-r1" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-19)"> +</text><text class="terminal-3704235523-r1" x="0" y="508" textLength="768.6" clip-path="url(#terminal-3704235523-line-20)">                        e.g., refs/remotes/origin/master..HEAD.</text><text class="terminal-3704235523-r1" x="976" y="508" textLength="12.2" clip-path="url(#terminal-3704235523-line-20)"> +</text><text class="terminal-3704235523-r1" x="0" y="532.4" textLength="378.2" clip-path="url(#terminal-3704235523-line-21)">  -m MESSAGE, --message MESSAGE</text><text class="terminal-3704235523-r1" x="976" y="532.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-21)"> +</text><text class="terminal-3704235523-r1" x="0" y="556.8" textLength="707.6" clip-path="url(#terminal-3704235523-line-22)">                        Validate the given commit message.</text><text class="terminal-3704235523-r1" x="976" y="556.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-22)"> +</text><text class="terminal-3704235523-r1" x="0" y="581.2" textLength="927.2" clip-path="url(#terminal-3704235523-line-23)">  --allow-abort         Allow empty commit messages, which typically abort a</text><text class="terminal-3704235523-r1" x="976" y="581.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-23)"> +</text><text class="terminal-3704235523-r1" x="0" y="605.6" textLength="378.2" clip-path="url(#terminal-3704235523-line-24)">                        commit.</text><text class="terminal-3704235523-r1" x="976" y="605.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-24)"> +</text><text class="terminal-3704235523-r1" x="0" y="630" textLength="256.2" clip-path="url(#terminal-3704235523-line-25)">  --allowed-prefixes </text><text class="terminal-3704235523-r2" x="256.2" y="630" textLength="12.2" clip-path="url(#terminal-3704235523-line-25)">[</text><text class="terminal-3704235523-r1" x="268.4" y="630" textLength="207.4" clip-path="url(#terminal-3704235523-line-25)">ALLOWED_PREFIXES </text><text class="terminal-3704235523-r3" x="475.8" y="630" textLength="36.6" clip-path="url(#terminal-3704235523-line-25)">...</text><text class="terminal-3704235523-r2" x="512.4" y="630" textLength="12.2" clip-path="url(#terminal-3704235523-line-25)">]</text><text class="terminal-3704235523-r1" x="976" y="630" textLength="12.2" clip-path="url(#terminal-3704235523-line-25)"> +</text><text class="terminal-3704235523-r1" x="0" y="654.4" textLength="915" clip-path="url(#terminal-3704235523-line-26)">                        Skip validation for commit messages that start with</text><text class="terminal-3704235523-r1" x="976" y="654.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-26)"> +</text><text class="terminal-3704235523-r1" x="0" y="678.8" textLength="573.4" clip-path="url(#terminal-3704235523-line-27)">                        the specified prefixes.</text><text class="terminal-3704235523-r1" x="976" y="678.8" textLength="12.2" clip-path="url(#terminal-3704235523-line-27)"> +</text><text class="terminal-3704235523-r1" x="0" y="703.2" textLength="854" clip-path="url(#terminal-3704235523-line-28)">  -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT</text><text class="terminal-3704235523-r1" x="976" y="703.2" textLength="12.2" clip-path="url(#terminal-3704235523-line-28)"> +</text><text class="terminal-3704235523-r1" x="0" y="727.6" textLength="878.4" clip-path="url(#terminal-3704235523-line-29)">                        Restrict the length of the **first line** of the</text><text class="terminal-3704235523-r1" x="976" y="727.6" textLength="12.2" clip-path="url(#terminal-3704235523-line-29)"> +</text><text class="terminal-3704235523-r1" x="0" y="752" textLength="488" clip-path="url(#terminal-3704235523-line-30)">                        commit message; </text><text class="terminal-3704235523-r4" x="488" y="752" textLength="12.2" clip-path="url(#terminal-3704235523-line-30)">0</text><text class="terminal-3704235523-r1" x="500.2" y="752" textLength="170.8" clip-path="url(#terminal-3704235523-line-30)"> for no limit.</text><text class="terminal-3704235523-r1" x="976" y="752" textLength="12.2" clip-path="url(#terminal-3704235523-line-30)"> +</text><text class="terminal-3704235523-r1" x="976" y="776.4" textLength="12.2" clip-path="url(#terminal-3704235523-line-31)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_commit___help.svg b/docs/images/cli_help/cz_commit___help.svg new file mode 100644 index 0000000000..633cea8fd0 --- /dev/null +++ b/docs/images/cli_help/cz_commit___help.svg @@ -0,0 +1,164 @@ +<svg class="rich-terminal" viewBox="0 0 994 708.8" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-2417358551-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-2417358551-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-2417358551-r1 { fill: #c5c8c6 } +.terminal-2417358551-r2 { fill: #c5c8c6;font-weight: bold } +.terminal-2417358551-r3 { fill: #68a0b3;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-2417358551-clip-terminal"> + <rect x="0" y="0" width="975.0" height="657.8" /> + </clipPath> + <clipPath id="terminal-2417358551-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-7"> + <rect x="0" y="172.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-8"> + <rect x="0" y="196.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-9"> + <rect x="0" y="221.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-10"> + <rect x="0" y="245.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-11"> + <rect x="0" y="269.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-12"> + <rect x="0" y="294.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-13"> + <rect x="0" y="318.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-14"> + <rect x="0" y="343.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-15"> + <rect x="0" y="367.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-16"> + <rect x="0" y="391.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-17"> + <rect x="0" y="416.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-18"> + <rect x="0" y="440.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-19"> + <rect x="0" y="465.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-20"> + <rect x="0" y="489.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-21"> + <rect x="0" y="513.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-22"> + <rect x="0" y="538.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-23"> + <rect x="0" y="562.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-24"> + <rect x="0" y="587.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2417358551-line-25"> + <rect x="0" y="611.5" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="706.8" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-2417358551-clip-terminal)"> + + <g class="terminal-2417358551-matrix"> + <text class="terminal-2417358551-r1" x="0" y="20" textLength="219.6" clip-path="url(#terminal-2417358551-line-0)">$ cz commit --help</text><text class="terminal-2417358551-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-2417358551-line-0)"> +</text><text class="terminal-2417358551-r1" x="0" y="44.4" textLength="207.4" clip-path="url(#terminal-2417358551-line-1)">usage: cz commit </text><text class="terminal-2417358551-r2" x="207.4" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">[</text><text class="terminal-2417358551-r1" x="219.6" y="44.4" textLength="24.4" clip-path="url(#terminal-2417358551-line-1)">-h</text><text class="terminal-2417358551-r2" x="244" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">]</text><text class="terminal-2417358551-r2" x="268.4" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">[</text><text class="terminal-2417358551-r1" x="280.6" y="44.4" textLength="85.4" clip-path="url(#terminal-2417358551-line-1)">--retry</text><text class="terminal-2417358551-r2" x="366" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">]</text><text class="terminal-2417358551-r2" x="390.4" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">[</text><text class="terminal-2417358551-r1" x="402.6" y="44.4" textLength="122" clip-path="url(#terminal-2417358551-line-1)">--no-retry</text><text class="terminal-2417358551-r2" x="524.6" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">]</text><text class="terminal-2417358551-r2" x="549" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">[</text><text class="terminal-2417358551-r1" x="561.2" y="44.4" textLength="109.8" clip-path="url(#terminal-2417358551-line-1)">--dry-run</text><text class="terminal-2417358551-r2" x="671" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)">]</text><text class="terminal-2417358551-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-1)"> +</text><text class="terminal-2417358551-r2" x="207.4" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">[</text><text class="terminal-2417358551-r1" x="219.6" y="68.8" textLength="402.6" clip-path="url(#terminal-2417358551-line-2)">--write-message-to-file FILE_PATH</text><text class="terminal-2417358551-r2" x="622.2" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">]</text><text class="terminal-2417358551-r2" x="646.6" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">[</text><text class="terminal-2417358551-r1" x="658.8" y="68.8" textLength="24.4" clip-path="url(#terminal-2417358551-line-2)">-s</text><text class="terminal-2417358551-r2" x="683.2" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">]</text><text class="terminal-2417358551-r2" x="707.6" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">[</text><text class="terminal-2417358551-r1" x="719.8" y="68.8" textLength="24.4" clip-path="url(#terminal-2417358551-line-2)">-a</text><text class="terminal-2417358551-r2" x="744.2" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">]</text><text class="terminal-2417358551-r2" x="768.6" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">[</text><text class="terminal-2417358551-r1" x="780.8" y="68.8" textLength="24.4" clip-path="url(#terminal-2417358551-line-2)">-e</text><text class="terminal-2417358551-r2" x="805.2" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)">]</text><text class="terminal-2417358551-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-2)"> +</text><text class="terminal-2417358551-r2" x="207.4" y="93.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-3)">[</text><text class="terminal-2417358551-r1" x="219.6" y="93.2" textLength="280.6" clip-path="url(#terminal-2417358551-line-3)">-l MESSAGE_LENGTH_LIMIT</text><text class="terminal-2417358551-r2" x="500.2" y="93.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-3)">]</text><text class="terminal-2417358551-r2" x="524.6" y="93.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-3)">[</text><text class="terminal-2417358551-r1" x="536.8" y="93.2" textLength="24.4" clip-path="url(#terminal-2417358551-line-3)">--</text><text class="terminal-2417358551-r2" x="561.2" y="93.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-3)">]</text><text class="terminal-2417358551-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-3)"> +</text><text class="terminal-2417358551-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-2417358551-line-4)"> +</text><text class="terminal-2417358551-r1" x="0" y="142" textLength="207.4" clip-path="url(#terminal-2417358551-line-5)">Create new commit</text><text class="terminal-2417358551-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-2417358551-line-5)"> +</text><text class="terminal-2417358551-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-6)"> +</text><text class="terminal-2417358551-r1" x="0" y="190.8" textLength="97.6" clip-path="url(#terminal-2417358551-line-7)">options:</text><text class="terminal-2417358551-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-7)"> +</text><text class="terminal-2417358551-r1" x="0" y="215.2" textLength="671" clip-path="url(#terminal-2417358551-line-8)">  -h, --help            show this help message and exit</text><text class="terminal-2417358551-r1" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-8)"> +</text><text class="terminal-2417358551-r1" x="0" y="239.6" textLength="561.2" clip-path="url(#terminal-2417358551-line-9)">  --retry               Retry the last commit.</text><text class="terminal-2417358551-r1" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-2417358551-line-9)"> +</text><text class="terminal-2417358551-r1" x="0" y="264" textLength="939.4" clip-path="url(#terminal-2417358551-line-10)">  --no-retry            Skip retry if --retry or `retry_after_failure` is set</text><text class="terminal-2417358551-r1" x="976" y="264" textLength="12.2" clip-path="url(#terminal-2417358551-line-10)"> +</text><text class="terminal-2417358551-r1" x="0" y="288.4" textLength="390.4" clip-path="url(#terminal-2417358551-line-11)">                        to true.</text><text class="terminal-2417358551-r1" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-11)"> +</text><text class="terminal-2417358551-r1" x="0" y="312.8" textLength="902.8" clip-path="url(#terminal-2417358551-line-12)">  --dry-run             Perform a dry run, without committing or modifying</text><text class="terminal-2417358551-r1" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-12)"> +</text><text class="terminal-2417358551-r1" x="0" y="337.2" textLength="366" clip-path="url(#terminal-2417358551-line-13)">                        files.</text><text class="terminal-2417358551-r1" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-13)"> +</text><text class="terminal-2417358551-r1" x="0" y="361.6" textLength="427" clip-path="url(#terminal-2417358551-line-14)">  --write-message-to-file FILE_PATH</text><text class="terminal-2417358551-r1" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-2417358551-line-14)"> +</text><text class="terminal-2417358551-r1" x="0" y="386" textLength="841.8" clip-path="url(#terminal-2417358551-line-15)">                        Write message to FILE_PATH before committing </text><text class="terminal-2417358551-r2" x="841.8" y="386" textLength="12.2" clip-path="url(#terminal-2417358551-line-15)">(</text><text class="terminal-2417358551-r1" x="854" y="386" textLength="73.2" clip-path="url(#terminal-2417358551-line-15)">can be</text><text class="terminal-2417358551-r1" x="976" y="386" textLength="12.2" clip-path="url(#terminal-2417358551-line-15)"> +</text><text class="terminal-2417358551-r1" x="0" y="410.4" textLength="524.6" clip-path="url(#terminal-2417358551-line-16)">                        used with --dry-run</text><text class="terminal-2417358551-r2" x="524.6" y="410.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-16)">)</text><text class="terminal-2417358551-r1" x="536.8" y="410.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-16)">.</text><text class="terminal-2417358551-r1" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-16)"> +</text><text class="terminal-2417358551-r1" x="0" y="434.8" textLength="805.2" clip-path="url(#terminal-2417358551-line-17)">  -s, --signoff         Deprecated, use `cz commit -- -s` instead.</text><text class="terminal-2417358551-r1" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-17)"> +</text><text class="terminal-2417358551-r1" x="0" y="459.2" textLength="939.4" clip-path="url(#terminal-2417358551-line-18)">  -a, --all             Automatically stage files that have been modified and</text><text class="terminal-2417358551-r1" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-18)"> +</text><text class="terminal-2417358551-r1" x="0" y="483.6" textLength="951.6" clip-path="url(#terminal-2417358551-line-19)">                        deleted, but new files you have not told Git about are</text><text class="terminal-2417358551-r1" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-2417358551-line-19)"> +</text><text class="terminal-2417358551-r1" x="0" y="508" textLength="451.4" clip-path="url(#terminal-2417358551-line-20)">                        not affected.</text><text class="terminal-2417358551-r1" x="976" y="508" textLength="12.2" clip-path="url(#terminal-2417358551-line-20)"> +</text><text class="terminal-2417358551-r1" x="0" y="532.4" textLength="805.2" clip-path="url(#terminal-2417358551-line-21)">  -e, --edit            Edit the commit message before committing.</text><text class="terminal-2417358551-r1" x="976" y="532.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-21)"> +</text><text class="terminal-2417358551-r1" x="0" y="556.8" textLength="854" clip-path="url(#terminal-2417358551-line-22)">  -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT</text><text class="terminal-2417358551-r1" x="976" y="556.8" textLength="12.2" clip-path="url(#terminal-2417358551-line-22)"> +</text><text class="terminal-2417358551-r1" x="0" y="581.2" textLength="829.6" clip-path="url(#terminal-2417358551-line-23)">                        Set the length limit of the commit message; </text><text class="terminal-2417358551-r3" x="829.6" y="581.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-23)">0</text><text class="terminal-2417358551-r1" x="841.8" y="581.2" textLength="85.4" clip-path="url(#terminal-2417358551-line-23)"> for no</text><text class="terminal-2417358551-r1" x="976" y="581.2" textLength="12.2" clip-path="url(#terminal-2417358551-line-23)"> +</text><text class="terminal-2417358551-r1" x="0" y="605.6" textLength="366" clip-path="url(#terminal-2417358551-line-24)">                        limit.</text><text class="terminal-2417358551-r1" x="976" y="605.6" textLength="12.2" clip-path="url(#terminal-2417358551-line-24)"> +</text><text class="terminal-2417358551-r1" x="0" y="630" textLength="671" clip-path="url(#terminal-2417358551-line-25)">  --                    Positional arguments separator </text><text class="terminal-2417358551-r2" x="671" y="630" textLength="12.2" clip-path="url(#terminal-2417358551-line-25)">(</text><text class="terminal-2417358551-r1" x="683.2" y="630" textLength="134.2" clip-path="url(#terminal-2417358551-line-25)">recommended</text><text class="terminal-2417358551-r2" x="817.4" y="630" textLength="12.2" clip-path="url(#terminal-2417358551-line-25)">)</text><text class="terminal-2417358551-r1" x="829.6" y="630" textLength="12.2" clip-path="url(#terminal-2417358551-line-25)">.</text><text class="terminal-2417358551-r1" x="976" y="630" textLength="12.2" clip-path="url(#terminal-2417358551-line-25)"> +</text><text class="terminal-2417358551-r1" x="976" y="654.4" textLength="12.2" clip-path="url(#terminal-2417358551-line-26)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_example___help.svg b/docs/images/cli_help/cz_example___help.svg new file mode 100644 index 0000000000..5ac29a22e3 --- /dev/null +++ b/docs/images/cli_help/cz_example___help.svg @@ -0,0 +1,87 @@ +<svg class="rich-terminal" viewBox="0 0 994 245.2" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-703430360-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-703430360-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-703430360-r1 { fill: #c5c8c6 } +.terminal-703430360-r2 { fill: #c5c8c6;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-703430360-clip-terminal"> + <rect x="0" y="0" width="975.0" height="194.2" /> + </clipPath> + <clipPath id="terminal-703430360-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-703430360-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-703430360-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-703430360-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-703430360-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-703430360-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-703430360-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="243.2" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-703430360-clip-terminal)"> + + <g class="terminal-703430360-matrix"> + <text class="terminal-703430360-r1" x="0" y="20" textLength="231.8" clip-path="url(#terminal-703430360-line-0)">$ cz example --help</text><text class="terminal-703430360-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-703430360-line-0)"> +</text><text class="terminal-703430360-r1" x="0" y="44.4" textLength="219.6" clip-path="url(#terminal-703430360-line-1)">usage: cz example </text><text class="terminal-703430360-r2" x="219.6" y="44.4" textLength="12.2" clip-path="url(#terminal-703430360-line-1)">[</text><text class="terminal-703430360-r1" x="231.8" y="44.4" textLength="24.4" clip-path="url(#terminal-703430360-line-1)">-h</text><text class="terminal-703430360-r2" x="256.2" y="44.4" textLength="12.2" clip-path="url(#terminal-703430360-line-1)">]</text><text class="terminal-703430360-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-703430360-line-1)"> +</text><text class="terminal-703430360-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-703430360-line-2)"> +</text><text class="terminal-703430360-r1" x="0" y="93.2" textLength="231.8" clip-path="url(#terminal-703430360-line-3)">Show commit example</text><text class="terminal-703430360-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-703430360-line-3)"> +</text><text class="terminal-703430360-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-703430360-line-4)"> +</text><text class="terminal-703430360-r1" x="0" y="142" textLength="97.6" clip-path="url(#terminal-703430360-line-5)">options:</text><text class="terminal-703430360-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-703430360-line-5)"> +</text><text class="terminal-703430360-r1" x="0" y="166.4" textLength="549" clip-path="url(#terminal-703430360-line-6)">  -h, --help  show this help message and exit</text><text class="terminal-703430360-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-703430360-line-6)"> +</text><text class="terminal-703430360-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-703430360-line-7)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_info___help.svg b/docs/images/cli_help/cz_info___help.svg new file mode 100644 index 0000000000..63ce1ee394 --- /dev/null +++ b/docs/images/cli_help/cz_info___help.svg @@ -0,0 +1,87 @@ +<svg class="rich-terminal" viewBox="0 0 994 245.2" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-3108929538-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-3108929538-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-3108929538-r1 { fill: #c5c8c6 } +.terminal-3108929538-r2 { fill: #c5c8c6;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-3108929538-clip-terminal"> + <rect x="0" y="0" width="975.0" height="194.2" /> + </clipPath> + <clipPath id="terminal-3108929538-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3108929538-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3108929538-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3108929538-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3108929538-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3108929538-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3108929538-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="243.2" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-3108929538-clip-terminal)"> + + <g class="terminal-3108929538-matrix"> + <text class="terminal-3108929538-r1" x="0" y="20" textLength="195.2" clip-path="url(#terminal-3108929538-line-0)">$ cz info --help</text><text class="terminal-3108929538-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-3108929538-line-0)"> +</text><text class="terminal-3108929538-r1" x="0" y="44.4" textLength="183" clip-path="url(#terminal-3108929538-line-1)">usage: cz info </text><text class="terminal-3108929538-r2" x="183" y="44.4" textLength="12.2" clip-path="url(#terminal-3108929538-line-1)">[</text><text class="terminal-3108929538-r1" x="195.2" y="44.4" textLength="24.4" clip-path="url(#terminal-3108929538-line-1)">-h</text><text class="terminal-3108929538-r2" x="219.6" y="44.4" textLength="12.2" clip-path="url(#terminal-3108929538-line-1)">]</text><text class="terminal-3108929538-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-3108929538-line-1)"> +</text><text class="terminal-3108929538-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-3108929538-line-2)"> +</text><text class="terminal-3108929538-r1" x="0" y="93.2" textLength="353.8" clip-path="url(#terminal-3108929538-line-3)">Show information about the cz</text><text class="terminal-3108929538-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-3108929538-line-3)"> +</text><text class="terminal-3108929538-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-3108929538-line-4)"> +</text><text class="terminal-3108929538-r1" x="0" y="142" textLength="97.6" clip-path="url(#terminal-3108929538-line-5)">options:</text><text class="terminal-3108929538-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-3108929538-line-5)"> +</text><text class="terminal-3108929538-r1" x="0" y="166.4" textLength="549" clip-path="url(#terminal-3108929538-line-6)">  -h, --help  show this help message and exit</text><text class="terminal-3108929538-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-3108929538-line-6)"> +</text><text class="terminal-3108929538-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-3108929538-line-7)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_init___help.svg b/docs/images/cli_help/cz_init___help.svg new file mode 100644 index 0000000000..daf7d90cd7 --- /dev/null +++ b/docs/images/cli_help/cz_init___help.svg @@ -0,0 +1,87 @@ +<svg class="rich-terminal" viewBox="0 0 994 245.2" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-2562163483-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-2562163483-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-2562163483-r1 { fill: #c5c8c6 } +.terminal-2562163483-r2 { fill: #c5c8c6;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-2562163483-clip-terminal"> + <rect x="0" y="0" width="975.0" height="194.2" /> + </clipPath> + <clipPath id="terminal-2562163483-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2562163483-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2562163483-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2562163483-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2562163483-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2562163483-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-2562163483-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="243.2" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-2562163483-clip-terminal)"> + + <g class="terminal-2562163483-matrix"> + <text class="terminal-2562163483-r1" x="0" y="20" textLength="195.2" clip-path="url(#terminal-2562163483-line-0)">$ cz init --help</text><text class="terminal-2562163483-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-2562163483-line-0)"> +</text><text class="terminal-2562163483-r1" x="0" y="44.4" textLength="183" clip-path="url(#terminal-2562163483-line-1)">usage: cz init </text><text class="terminal-2562163483-r2" x="183" y="44.4" textLength="12.2" clip-path="url(#terminal-2562163483-line-1)">[</text><text class="terminal-2562163483-r1" x="195.2" y="44.4" textLength="24.4" clip-path="url(#terminal-2562163483-line-1)">-h</text><text class="terminal-2562163483-r2" x="219.6" y="44.4" textLength="12.2" clip-path="url(#terminal-2562163483-line-1)">]</text><text class="terminal-2562163483-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-2562163483-line-1)"> +</text><text class="terminal-2562163483-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-2562163483-line-2)"> +</text><text class="terminal-2562163483-r1" x="0" y="93.2" textLength="427" clip-path="url(#terminal-2562163483-line-3)">Initialize commitizen configuration</text><text class="terminal-2562163483-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-2562163483-line-3)"> +</text><text class="terminal-2562163483-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-2562163483-line-4)"> +</text><text class="terminal-2562163483-r1" x="0" y="142" textLength="97.6" clip-path="url(#terminal-2562163483-line-5)">options:</text><text class="terminal-2562163483-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-2562163483-line-5)"> +</text><text class="terminal-2562163483-r1" x="0" y="166.4" textLength="549" clip-path="url(#terminal-2562163483-line-6)">  -h, --help  show this help message and exit</text><text class="terminal-2562163483-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-2562163483-line-6)"> +</text><text class="terminal-2562163483-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-2562163483-line-7)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_ls___help.svg b/docs/images/cli_help/cz_ls___help.svg new file mode 100644 index 0000000000..27bd6b760a --- /dev/null +++ b/docs/images/cli_help/cz_ls___help.svg @@ -0,0 +1,87 @@ +<svg class="rich-terminal" viewBox="0 0 994 245.2" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-3771170172-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-3771170172-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-3771170172-r1 { fill: #c5c8c6 } +.terminal-3771170172-r2 { fill: #c5c8c6;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-3771170172-clip-terminal"> + <rect x="0" y="0" width="975.0" height="194.2" /> + </clipPath> + <clipPath id="terminal-3771170172-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3771170172-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3771170172-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3771170172-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3771170172-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3771170172-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-3771170172-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="243.2" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-3771170172-clip-terminal)"> + + <g class="terminal-3771170172-matrix"> + <text class="terminal-3771170172-r1" x="0" y="20" textLength="170.8" clip-path="url(#terminal-3771170172-line-0)">$ cz ls --help</text><text class="terminal-3771170172-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-3771170172-line-0)"> +</text><text class="terminal-3771170172-r1" x="0" y="44.4" textLength="158.6" clip-path="url(#terminal-3771170172-line-1)">usage: cz ls </text><text class="terminal-3771170172-r2" x="158.6" y="44.4" textLength="12.2" clip-path="url(#terminal-3771170172-line-1)">[</text><text class="terminal-3771170172-r1" x="170.8" y="44.4" textLength="24.4" clip-path="url(#terminal-3771170172-line-1)">-h</text><text class="terminal-3771170172-r2" x="195.2" y="44.4" textLength="12.2" clip-path="url(#terminal-3771170172-line-1)">]</text><text class="terminal-3771170172-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-3771170172-line-1)"> +</text><text class="terminal-3771170172-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-3771170172-line-2)"> +</text><text class="terminal-3771170172-r1" x="0" y="93.2" textLength="317.2" clip-path="url(#terminal-3771170172-line-3)">Show available Commitizens</text><text class="terminal-3771170172-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-3771170172-line-3)"> +</text><text class="terminal-3771170172-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-3771170172-line-4)"> +</text><text class="terminal-3771170172-r1" x="0" y="142" textLength="97.6" clip-path="url(#terminal-3771170172-line-5)">options:</text><text class="terminal-3771170172-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-3771170172-line-5)"> +</text><text class="terminal-3771170172-r1" x="0" y="166.4" textLength="549" clip-path="url(#terminal-3771170172-line-6)">  -h, --help  show this help message and exit</text><text class="terminal-3771170172-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-3771170172-line-6)"> +</text><text class="terminal-3771170172-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-3771170172-line-7)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_schema___help.svg b/docs/images/cli_help/cz_schema___help.svg new file mode 100644 index 0000000000..3a0098b2db --- /dev/null +++ b/docs/images/cli_help/cz_schema___help.svg @@ -0,0 +1,87 @@ +<svg class="rich-terminal" viewBox="0 0 994 245.2" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-721452391-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-721452391-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-721452391-r1 { fill: #c5c8c6 } +.terminal-721452391-r2 { fill: #c5c8c6;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-721452391-clip-terminal"> + <rect x="0" y="0" width="975.0" height="194.2" /> + </clipPath> + <clipPath id="terminal-721452391-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-721452391-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-721452391-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-721452391-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-721452391-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-721452391-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-721452391-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="243.2" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-721452391-clip-terminal)"> + + <g class="terminal-721452391-matrix"> + <text class="terminal-721452391-r1" x="0" y="20" textLength="219.6" clip-path="url(#terminal-721452391-line-0)">$ cz schema --help</text><text class="terminal-721452391-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-721452391-line-0)"> +</text><text class="terminal-721452391-r1" x="0" y="44.4" textLength="207.4" clip-path="url(#terminal-721452391-line-1)">usage: cz schema </text><text class="terminal-721452391-r2" x="207.4" y="44.4" textLength="12.2" clip-path="url(#terminal-721452391-line-1)">[</text><text class="terminal-721452391-r1" x="219.6" y="44.4" textLength="24.4" clip-path="url(#terminal-721452391-line-1)">-h</text><text class="terminal-721452391-r2" x="244" y="44.4" textLength="12.2" clip-path="url(#terminal-721452391-line-1)">]</text><text class="terminal-721452391-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-721452391-line-1)"> +</text><text class="terminal-721452391-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-721452391-line-2)"> +</text><text class="terminal-721452391-r1" x="0" y="93.2" textLength="219.6" clip-path="url(#terminal-721452391-line-3)">Show commit schema</text><text class="terminal-721452391-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-721452391-line-3)"> +</text><text class="terminal-721452391-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-721452391-line-4)"> +</text><text class="terminal-721452391-r1" x="0" y="142" textLength="97.6" clip-path="url(#terminal-721452391-line-5)">options:</text><text class="terminal-721452391-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-721452391-line-5)"> +</text><text class="terminal-721452391-r1" x="0" y="166.4" textLength="549" clip-path="url(#terminal-721452391-line-6)">  -h, --help  show this help message and exit</text><text class="terminal-721452391-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-721452391-line-6)"> +</text><text class="terminal-721452391-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-721452391-line-7)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_help/cz_version___help.svg b/docs/images/cli_help/cz_version___help.svg new file mode 100644 index 0000000000..20331e0972 --- /dev/null +++ b/docs/images/cli_help/cz_version___help.svg @@ -0,0 +1,135 @@ +<svg class="rich-terminal" viewBox="0 0 994 538.0" xmlns="http://www.w3.org/2000/svg"> + <!-- Generated with Rich https://www.textualize.io --> + <style> + + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Regular"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Regular.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Regular.woff") format("woff"); + font-style: normal; + font-weight: 400; + } + @font-face { + font-family: "Fira Code"; + src: local("FiraCode-Bold"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff2/FiraCode-Bold.woff2") format("woff2"), + url("https://cdnjs.cloudflare.com/ajax/libs/firacode/6.2.0/woff/FiraCode-Bold.woff") format("woff"); + font-style: bold; + font-weight: 700; + } + + .terminal-1926777403-matrix { + font-family: Fira Code, monospace; + font-size: 20px; + line-height: 24.4px; + font-variant-east-asian: full-width; + } + + .terminal-1926777403-title { + font-size: 18px; + font-weight: bold; + font-family: arial; + } + + .terminal-1926777403-r1 { fill: #c5c8c6 } +.terminal-1926777403-r2 { fill: #c5c8c6;font-weight: bold } + </style> + + <defs> + <clipPath id="terminal-1926777403-clip-terminal"> + <rect x="0" y="0" width="975.0" height="487.0" /> + </clipPath> + <clipPath id="terminal-1926777403-line-0"> + <rect x="0" y="1.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-1"> + <rect x="0" y="25.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-2"> + <rect x="0" y="50.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-3"> + <rect x="0" y="74.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-4"> + <rect x="0" y="99.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-5"> + <rect x="0" y="123.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-6"> + <rect x="0" y="147.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-7"> + <rect x="0" y="172.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-8"> + <rect x="0" y="196.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-9"> + <rect x="0" y="221.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-10"> + <rect x="0" y="245.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-11"> + <rect x="0" y="269.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-12"> + <rect x="0" y="294.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-13"> + <rect x="0" y="318.7" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-14"> + <rect x="0" y="343.1" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-15"> + <rect x="0" y="367.5" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-16"> + <rect x="0" y="391.9" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-17"> + <rect x="0" y="416.3" width="976" height="24.65"/> + </clipPath> +<clipPath id="terminal-1926777403-line-18"> + <rect x="0" y="440.7" width="976" height="24.65"/> + </clipPath> + </defs> + + <rect fill="#292929" stroke="rgba(255,255,255,0.35)" stroke-width="1" x="1" y="1" width="992" height="536" rx="8"/> + <g transform="translate(26,22)"> + <circle cx="0" cy="0" r="7" fill="#ff5f57"/> + <circle cx="22" cy="0" r="7" fill="#febc2e"/> + <circle cx="44" cy="0" r="7" fill="#28c840"/> + </g> + + <g transform="translate(9, 41)" clip-path="url(#terminal-1926777403-clip-terminal)"> + + <g class="terminal-1926777403-matrix"> + <text class="terminal-1926777403-r1" x="0" y="20" textLength="231.8" clip-path="url(#terminal-1926777403-line-0)">$ cz version --help</text><text class="terminal-1926777403-r1" x="976" y="20" textLength="12.2" clip-path="url(#terminal-1926777403-line-0)"> +</text><text class="terminal-1926777403-r1" x="0" y="44.4" textLength="219.6" clip-path="url(#terminal-1926777403-line-1)">usage: cz version </text><text class="terminal-1926777403-r2" x="219.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)">[</text><text class="terminal-1926777403-r1" x="231.8" y="44.4" textLength="24.4" clip-path="url(#terminal-1926777403-line-1)">-h</text><text class="terminal-1926777403-r2" x="256.2" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)">]</text><text class="terminal-1926777403-r2" x="280.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)">[</text><text class="terminal-1926777403-r1" x="292.8" y="44.4" textLength="207.4" clip-path="url(#terminal-1926777403-line-1)">-r | -p | -c | -v</text><text class="terminal-1926777403-r2" x="500.2" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)">]</text><text class="terminal-1926777403-r2" x="524.6" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)">[</text><text class="terminal-1926777403-r1" x="536.8" y="44.4" textLength="305" clip-path="url(#terminal-1926777403-line-1)">--major | --minor | --tag</text><text class="terminal-1926777403-r2" x="841.8" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)">]</text><text class="terminal-1926777403-r1" x="976" y="44.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-1)"> +</text><text class="terminal-1926777403-r1" x="976" y="68.8" textLength="12.2" clip-path="url(#terminal-1926777403-line-2)"> +</text><text class="terminal-1926777403-r1" x="0" y="93.2" textLength="817.4" clip-path="url(#terminal-1926777403-line-3)">Get the version of the installed commitizen or the current project </text><text class="terminal-1926777403-r2" x="817.4" y="93.2" textLength="12.2" clip-path="url(#terminal-1926777403-line-3)">(</text><text class="terminal-1926777403-r1" x="829.6" y="93.2" textLength="97.6" clip-path="url(#terminal-1926777403-line-3)">default:</text><text class="terminal-1926777403-r1" x="976" y="93.2" textLength="12.2" clip-path="url(#terminal-1926777403-line-3)"> +</text><text class="terminal-1926777403-r1" x="0" y="117.6" textLength="244" clip-path="url(#terminal-1926777403-line-4)">installed commitizen</text><text class="terminal-1926777403-r2" x="244" y="117.6" textLength="12.2" clip-path="url(#terminal-1926777403-line-4)">)</text><text class="terminal-1926777403-r1" x="976" y="117.6" textLength="12.2" clip-path="url(#terminal-1926777403-line-4)"> +</text><text class="terminal-1926777403-r1" x="976" y="142" textLength="12.2" clip-path="url(#terminal-1926777403-line-5)"> +</text><text class="terminal-1926777403-r1" x="0" y="166.4" textLength="97.6" clip-path="url(#terminal-1926777403-line-6)">options:</text><text class="terminal-1926777403-r1" x="976" y="166.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-6)"> +</text><text class="terminal-1926777403-r1" x="0" y="190.8" textLength="622.2" clip-path="url(#terminal-1926777403-line-7)">  -h, --help        show this help message and exit</text><text class="terminal-1926777403-r1" x="976" y="190.8" textLength="12.2" clip-path="url(#terminal-1926777403-line-7)"> +</text><text class="terminal-1926777403-r1" x="0" y="215.2" textLength="841.8" clip-path="url(#terminal-1926777403-line-8)">  -r, --report      Output the system information for reporting bugs.</text><text class="terminal-1926777403-r1" x="976" y="215.2" textLength="12.2" clip-path="url(#terminal-1926777403-line-8)"> +</text><text class="terminal-1926777403-r1" x="0" y="239.6" textLength="756.4" clip-path="url(#terminal-1926777403-line-9)">  -p, --project     Output the version of the current project.</text><text class="terminal-1926777403-r1" x="976" y="239.6" textLength="12.2" clip-path="url(#terminal-1926777403-line-9)"> +</text><text class="terminal-1926777403-r1" x="0" y="264" textLength="817.4" clip-path="url(#terminal-1926777403-line-10)">  -c, --commitizen  Output the version of the installed commitizen.</text><text class="terminal-1926777403-r1" x="976" y="264" textLength="12.2" clip-path="url(#terminal-1926777403-line-10)"> +</text><text class="terminal-1926777403-r1" x="0" y="288.4" textLength="915" clip-path="url(#terminal-1926777403-line-11)">  -v, --verbose     Output the version of both the installed commitizen and</text><text class="terminal-1926777403-r1" x="976" y="288.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-11)"> +</text><text class="terminal-1926777403-r1" x="0" y="312.8" textLength="488" clip-path="url(#terminal-1926777403-line-12)">                    the current project.</text><text class="terminal-1926777403-r1" x="976" y="312.8" textLength="12.2" clip-path="url(#terminal-1926777403-line-12)"> +</text><text class="terminal-1926777403-r1" x="0" y="337.2" textLength="951.6" clip-path="url(#terminal-1926777403-line-13)">  --major           Output just the major version. Must be used with --project</text><text class="terminal-1926777403-r1" x="976" y="337.2" textLength="12.2" clip-path="url(#terminal-1926777403-line-13)"> +</text><text class="terminal-1926777403-r1" x="0" y="361.6" textLength="402.6" clip-path="url(#terminal-1926777403-line-14)">                    or --verbose.</text><text class="terminal-1926777403-r1" x="976" y="361.6" textLength="12.2" clip-path="url(#terminal-1926777403-line-14)"> +</text><text class="terminal-1926777403-r1" x="0" y="386" textLength="951.6" clip-path="url(#terminal-1926777403-line-15)">  --minor           Output just the minor version. Must be used with --project</text><text class="terminal-1926777403-r1" x="976" y="386" textLength="12.2" clip-path="url(#terminal-1926777403-line-15)"> +</text><text class="terminal-1926777403-r1" x="0" y="410.4" textLength="402.6" clip-path="url(#terminal-1926777403-line-16)">                    or --verbose.</text><text class="terminal-1926777403-r1" x="976" y="410.4" textLength="12.2" clip-path="url(#terminal-1926777403-line-16)"> +</text><text class="terminal-1926777403-r1" x="0" y="434.8" textLength="890.6" clip-path="url(#terminal-1926777403-line-17)">  --tag             get the version with tag prefix. Need to be used with</text><text class="terminal-1926777403-r1" x="976" y="434.8" textLength="12.2" clip-path="url(#terminal-1926777403-line-17)"> +</text><text class="terminal-1926777403-r1" x="0" y="459.2" textLength="524.6" clip-path="url(#terminal-1926777403-line-18)">                    --project or --verbose.</text><text class="terminal-1926777403-r1" x="976" y="459.2" textLength="12.2" clip-path="url(#terminal-1926777403-line-18)"> +</text><text class="terminal-1926777403-r1" x="976" y="483.6" textLength="12.2" clip-path="url(#terminal-1926777403-line-19)"> +</text> + </g> + </g> +</svg> diff --git a/docs/images/cli_interactive/bump.gif b/docs/images/cli_interactive/bump.gif new file mode 100644 index 0000000000..aa3704be09 Binary files /dev/null and b/docs/images/cli_interactive/bump.gif differ diff --git a/docs/images/cli_interactive/commit.gif b/docs/images/cli_interactive/commit.gif new file mode 100644 index 0000000000..3726f93c73 Binary files /dev/null and b/docs/images/cli_interactive/commit.gif differ diff --git a/docs/images/cli_interactive/init.gif b/docs/images/cli_interactive/init.gif new file mode 100644 index 0000000000..eccd972a88 Binary files /dev/null and b/docs/images/cli_interactive/init.gif differ diff --git a/docs/images/cli_interactive/shortcut_custom.gif b/docs/images/cli_interactive/shortcut_custom.gif new file mode 100644 index 0000000000..ee65dea37a Binary files /dev/null and b/docs/images/cli_interactive/shortcut_custom.gif differ diff --git a/docs/images/cli_interactive/shortcut_default.gif b/docs/images/cli_interactive/shortcut_default.gif new file mode 100644 index 0000000000..45369686e9 Binary files /dev/null and b/docs/images/cli_interactive/shortcut_default.gif differ diff --git a/docs/images/commit.tape b/docs/images/commit.tape new file mode 100644 index 0000000000..f05a354e7b --- /dev/null +++ b/docs/images/commit.tape @@ -0,0 +1,120 @@ +Output cli_interactive/commit.gif + +Require cz + +# Use bash for cross-platform compatibility (macOS, Linux, Windows) +Set Shell bash + +Set FontSize 16 +Set Width 878 +Set Height 568 +Set Padding 20 +Set TypingSpeed 50ms + +Set Theme { + "name": "Commitizen", + "black": "#232628", + "red": "#fc4384", + "green": "#b3e33b", + "yellow": "#ffa727", + "blue": "#75dff2", + "magenta": "#ae89fe", + "cyan": "#708387", + "white": "#d5d5d0", + "brightBlack": "#626566", + "brightRed": "#ff7fac", + "brightGreen": "#c8ed71", + "brightYellow": "#ebdf86", + "brightBlue": "#75dff2", + "brightMagenta": "#ae89fe", + "brightCyan": "#b1c6ca", + "brightWhite": "#f9f9f4", + "background": "#1e1e2e", + "foreground": "#afafaf", + "cursor": "#c7c7c7" +} + +# Hide initial shell prompt +Hide + +# Wait for terminal to be ready +Sleep 1s + +# Set a clean, simple prompt (while hidden) +Type "PS1='$ '" +Enter +Sleep 300ms + +# Create a clean temporary directory for recording +Type "rm -rf /tmp/commitizen-demo && mkdir -p /tmp/commitizen-demo && cd /tmp/commitizen-demo" +Enter +Sleep 500ms + +# Initialize git repository +Type "git init" +Enter +Type "git config user.email 'you@example.com'" +Enter +Type "git config user.name 'Your Name'" +Enter +Sleep 500ms + +Type "git checkout -b awesome-feature" +Enter +Sleep 500ms + +# Create a dummy file to commit +Type "echo 'test content' > example.py" +Enter +Sleep 300ms + +Type "git add example.py" +Enter +Sleep 300ms + +# Clear the screen to start fresh +Type "clear" +Enter +Sleep 500ms + +# Show commands from here +Show + +# Now run cz commit +Type "cz commit" +Sleep 500ms +Enter + +# Wait for first prompt to appear +Sleep 1s + +# Question 1: Select the type of change (move down to "feat") +Down +Sleep 500ms +Enter +Sleep 1s + +# Question 2: Scope (optional, skip) +Enter +Sleep 1s + +# Question 3: Subject +Type "awesome new feature" +Sleep 500ms +Enter +Sleep 1s + +# Question 4: Is this a BREAKING CHANGE? (No) +Enter +Sleep 1s + +# Question 5: Body (optional, skip) +Enter +Sleep 1s + +# Question 6: Footer (optional, skip) +Enter +Sleep 1s + +# Wait for commit success message +Sleep 2s diff --git a/docs/images/commit.yml b/docs/images/commit.yml index a239bc3aab..fd10ed777f 100644 --- a/docs/images/commit.yml +++ b/docs/images/commit.yml @@ -136,9 +136,9 @@ records: - delay: 209 content: "\e[?1l\e[6n" - delay: 7 - content: "\e[?2004h\e[?25l\e[0m\e[?7l\e[0m\e[J\e[0;38;5;67m?\e[0;1m Select the type of change you are committing \e[0m (Use arrow keys) \r\e[100C \e[0m\r\r\n\e[0m » fix: A bug fix. Correlates with PATCH in SemVer\e[0m\r\r\n\e[0m feat: A new feature. Correlates with MINOR in SemVer\e[0m\r\r\n\e[0m docs: Documentation only changes\e[0m\r\r\n\e[0m style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-\r\e[100Cc\e[0m\r\r\n\e[0m refactor: A code change that neither fixes a bug nor adds a feature\e[0m\r\r\n\e[0m perf: A code change that improves performance\e[0m\r\r\n\e[0m test: Adding missing or correcting existing tests\e[0m\r\r\n\e[0m build: Changes that affect the build system or external dependencies (example scopes: pip, docker\r\e[100C,\e[0m\r\r\n\e[0m ci: Changes to our CI configuration files and scripts (example scopes: GitLabCI) \r\e[100C \r\e[9A\e[64C\e[?7h\e[0m\e[?12l\e[?25h" + content: "\e[?2004h\e[?25l\e[0m\e[?7l\e[0m\e[J\e[0;38;5;67m?\e[0;1m Select the type of change you are committing \e[0m (Use arrow keys) \r\e[100C \e[0m\r\r\n\e[0m » fix: A bug fix. Correlates with PATCH in SemVer\e[0m\r\r\n\e[0m feat: A new feature. Correlates with MINOR in SemVer\e[0m\r\r\n\e[0m docs: Documentation only changes\e[0m\r\r\n\e[0m style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-\r\e[100Cc\e[0m\r\r\n\e[0m refactor: A code change that neither fixes a bug nor adds a feature\e[0m\r\r\n\e[0m perf: A code change that improves performance\e[0m\r\r\n\e[0m test: Adding missing or correcting existing tests\e[0m\r\r\n\e[0m build: Changes that affect the build system or external dependencies (example scopes: pip, docker\r\e[100C,\e[0m\r\r\n\e[0m ci: Changes to CI configuration files and scripts (example scopes: GitLabCI) \r\e[100C \r\e[9A\e[64C\e[?7h\e[0m\e[?12l\e[?25h" - delay: 17 - content: "\e[?25l\e[?7l\e[0m\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\e[0m ci: Changes to our CI configuration files and scripts (example scopes: GitLabCI)\e[0m\e[K\e[0m\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\e[0m \r\e[100C \r\e[19A\e[64C\e[?7h\e[0m\e[?12l\e[?25h" + content: "\e[?25l\e[?7l\e[0m\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\e[0m ci: Changes to CI configuration files and scripts (example scopes: GitLabCI)\e[0m\e[K\e[0m\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\r\r\n\e[0m \r\e[100C \r\e[19A\e[64C\e[?7h\e[0m\e[?12l\e[?25h" - delay: 647 content: "\e[?25l\e[?7l\e[0m\r\r\n\e[0m \e[0m\r\r\n\e[0m » \e[2A\e[61C\e[?7h\e[0m\e[?12l\e[?25h" - delay: 574 diff --git a/docs/images/cz_logo.png b/docs/images/cz_logo.png new file mode 100644 index 0000000000..2f5f0244ec Binary files /dev/null and b/docs/images/cz_logo.png differ diff --git a/docs/images/demo.gif b/docs/images/demo.gif deleted file mode 100644 index 0f2b9f2487..0000000000 Binary files a/docs/images/demo.gif and /dev/null differ diff --git a/docs/images/gitlab_ci/gitlab_deploy_key.png b/docs/images/gitlab_ci/gitlab_deploy_key.png new file mode 100644 index 0000000000..dd70443c32 Binary files /dev/null and b/docs/images/gitlab_ci/gitlab_deploy_key.png differ diff --git a/docs/images/gitlab_ci/gitlab_final_ci_result.png b/docs/images/gitlab_ci/gitlab_final_ci_result.png new file mode 100644 index 0000000000..27749db793 Binary files /dev/null and b/docs/images/gitlab_ci/gitlab_final_ci_result.png differ diff --git a/docs/images/gitlab_ci/gitlab_variables.png b/docs/images/gitlab_ci/gitlab_variables.png new file mode 100644 index 0000000000..d00ebfcf79 Binary files /dev/null and b/docs/images/gitlab_ci/gitlab_variables.png differ diff --git a/docs/images/init.tape b/docs/images/init.tape new file mode 100644 index 0000000000..cd115c6abb --- /dev/null +++ b/docs/images/init.tape @@ -0,0 +1,111 @@ +Output cli_interactive/init.gif + +Require cz + +# Use bash for cross-platform compatibility (macOS, Linux, Windows) +Set Shell bash + +Set FontSize 16 +Set Width 878 +Set Height 568 +Set Padding 20 +Set TypingSpeed 50ms + +Set Theme { + "name": "Commitizen", + "black": "#232628", + "red": "#fc4384", + "green": "#b3e33b", + "yellow": "#ffa727", + "blue": "#75dff2", + "magenta": "#ae89fe", + "cyan": "#708387", + "white": "#d5d5d0", + "brightBlack": "#626566", + "brightRed": "#ff7fac", + "brightGreen": "#c8ed71", + "brightYellow": "#ebdf86", + "brightBlue": "#75dff2", + "brightMagenta": "#ae89fe", + "brightCyan": "#b1c6ca", + "brightWhite": "#f9f9f4", + "background": "#1e1e2e", + "foreground": "#afafaf", + "cursor": "#c7c7c7" +} + +# Hide initial shell prompt +Hide + +# Wait for terminal to be ready +Sleep 1s + +# Set a clean, simple prompt +Type "PS1='$ '" +Enter +Sleep 300ms + + +# Create a clean temporary directory for recording +Type "rm -rf /tmp/commitizen-example && mkdir -p /tmp/commitizen-example && cd /tmp/commitizen-example" +Enter +Sleep 500ms + +# Clear the screen to start fresh +Type "clear" +Enter +Sleep 500ms + +# Show commands from here +Show + +# Now run cz init in the clean environment +Type "cz init" +Sleep 500ms +Enter + +# Wait for welcome message and first prompt +Sleep 500ms +Sleep 1s +# Question 1: Please choose a supported config file +# Default is .cz.toml, just press Enter +Enter +Sleep 1s + +# Question 2: Please choose a cz (commit rule) +# Default is cz_conventional_commits, just press Enter +Enter +Sleep 1s + +# Question 3: Choose the source of the version +# Default is "commitizen: Fetch and set version in commitizen config, just press Enter" +Enter +Sleep 1s + +# Question 4: Choose version scheme +# Default is semver, just press Enter +Enter +Sleep 1s + +# Question 5: Please enter the correct version format +# Default is "$version", just press Enter +Enter +Sleep 1s + +# Question 6: Create changelog automatically on bump +# Default is Yes, just press Enter +Enter +Sleep 1s + +# Question 7: Keep major version zero (0.x) during breaking changes +# Default is Yes, just press Enter +Enter +Sleep 1s + +# Question 8: What types of pre-commit hook you want to install? +# Default is [commit-msg], just press Enter to accept +Enter +Sleep 1s + +# Wait for completion message +Sleep 3s diff --git a/docs/images/shortcut_custom.tape b/docs/images/shortcut_custom.tape new file mode 100644 index 0000000000..39f1c5838f --- /dev/null +++ b/docs/images/shortcut_custom.tape @@ -0,0 +1,159 @@ +Output cli_interactive/shortcut_custom.gif + +Require cz + +# Use bash for cross-platform compatibility (macOS, Linux, Windows) +Set Shell bash + +Set FontSize 16 +Set Width 878 +Set Height 568 +Set Padding 20 +Set TypingSpeed 50ms + +Set Theme { + "name": "Commitizen", + "black": "#232628", + "red": "#fc4384", + "green": "#b3e33b", + "yellow": "#ffa727", + "blue": "#75dff2", + "magenta": "#ae89fe", + "cyan": "#708387", + "white": "#d5d5d0", + "brightBlack": "#626566", + "brightRed": "#ff7fac", + "brightGreen": "#c8ed71", + "brightYellow": "#ebdf86", + "brightBlue": "#75dff2", + "brightMagenta": "#ae89fe", + "brightCyan": "#b1c6ca", + "brightWhite": "#f9f9f4", + "background": "#1e1e2e", + "foreground": "#afafaf", + "cursor": "#c7c7c7" +} + +# Hide initial shell prompt +Hide + +# Wait for terminal to be ready +Sleep 1s + +# Set a clean, simple prompt (while hidden) +Type "PS1='$ '" +Enter +Sleep 300ms + +# Create a clean temporary directory for recording +Type "rm -rf /tmp/commitizen-example && mkdir -p /tmp/commitizen-example && cd /tmp/commitizen-example" +Enter +Sleep 500ms + +# Initialize git repository +Type "git init" +Enter +Type "git config user.email 'you@example.com'" +Enter +Type "git config user.name 'Your Name'" +Enter +Sleep 500ms + +Type "git checkout -b awesome-docs" +Enter +Sleep 500ms + +Type `cat > pyproject.toml << 'EOF'` +Enter +Type `[tool.commitizen]` +Enter +Type `name = "cz_customize"` +Enter +Type `use_shortcuts = true` +Enter +Type `` +Enter +Type `[tool.commitizen.customize]` +Enter +Type `message_template = "{{prefix}}: {{message}}"` +Enter +Type `schema = "<type>: <body>"` +Enter +Type `schema_pattern = "(feat|fix|docs|test):(\\s.*)"` +Enter +Type `` +Enter +Type `[[tool.commitizen.customize.questions]]` +Enter +Type `type = "list"` +Enter +Type `name = "prefix"` +Enter +Type `message = "Select the type of change you are committing"` +Enter +Type `choices = [` +Enter +Type ` { value = "feat", name = "feat: A new feature.", key = "f" },` +Enter +Type ` { value = "fix", name = "fix: A bug fix.", key = "x" },` +Enter +Type ` { value = "docs", name = "docs: Documentation only changes", key = "d" },` +Enter +Type ` { value = "test", name = "test: Adding or correcting tests", key = "t" },` +Enter +Type `]` +Enter +Type `` +Enter +Type `[[tool.commitizen.customize.questions]]` +Enter +Type `type = "input"` +Enter +Type `name = "message"` +Enter +Type `message = "Commit body: "` +Enter +Type "EOF" +Enter +Sleep 300ms + +# Create a dummy file to commit +Type "echo 'test content' > README.md" +Enter +Sleep 300ms + +Type "git add README.md" +Enter +Sleep 300ms + +# Clear the screen to start fresh +Type "clear" +Enter +Sleep 500ms + +# Show commands from here +Show + +# Now run cz commit +Type "cz commit" +Sleep 500ms +Enter + +# Wait for first prompt to appear +Sleep 2s + +# Question 1: Select the type of change (press d to "docs") +Sleep 1s +Type "d" +Sleep 2s +Enter +Sleep 1s + +# Question 2: Commit body +Type "demo with custom keys" +Sleep 500ms +Enter +Sleep 500ms + +# Wait for commit success message +Sleep 1s diff --git a/docs/images/shortcut_default.tape b/docs/images/shortcut_default.tape new file mode 100644 index 0000000000..204a18a473 --- /dev/null +++ b/docs/images/shortcut_default.tape @@ -0,0 +1,138 @@ +Output cli_interactive/shortcut_default.gif + +Require cz + +# Use bash for cross-platform compatibility (macOS, Linux, Windows) +Set Shell bash + +Set FontSize 16 +Set Width 878 +Set Height 568 +Set Padding 20 +Set TypingSpeed 50ms + +Set Theme { + "name": "Commitizen", + "black": "#232628", + "red": "#fc4384", + "green": "#b3e33b", + "yellow": "#ffa727", + "blue": "#75dff2", + "magenta": "#ae89fe", + "cyan": "#708387", + "white": "#d5d5d0", + "brightBlack": "#626566", + "brightRed": "#ff7fac", + "brightGreen": "#c8ed71", + "brightYellow": "#ebdf86", + "brightBlue": "#75dff2", + "brightMagenta": "#ae89fe", + "brightCyan": "#b1c6ca", + "brightWhite": "#f9f9f4", + "background": "#1e1e2e", + "foreground": "#afafaf", + "cursor": "#c7c7c7" +} + +# Hide initial shell prompt +Hide + +# Wait for terminal to be ready +Sleep 1s + +# Set a clean, simple prompt (while hidden) +Type "PS1='$ '" +Enter +Sleep 300ms + +# Create a clean temporary directory for recording +Type "rm -rf /tmp/commitizen-example && mkdir -p /tmp/commitizen-example && cd /tmp/commitizen-example" +Enter +Sleep 500ms + +# Initialize git repository +Type "git init" +Enter +Type "git config user.email 'you@example.com'" +Enter +Type "git config user.name 'Your Name'" +Enter +Sleep 500ms + +Type "git checkout -b awesome-docs" +Enter +Sleep 500ms + +# Initialize commitizen config with shortcuts enabled +Type `cat > pyproject.toml << 'EOF'` +Enter +Sleep 100ms +Type `[tool.commitizen]` +Enter +Sleep 100ms +Type `name = "cz_conventional_commits"` +Enter +Sleep 100ms +Type `use_shortcuts = true` +Enter +Sleep 100ms +Type "EOF" +Enter +Sleep 300ms + +# Create a dummy file to commit +Type "echo 'test content' > README.md" +Enter +Sleep 300ms + +Type "git add README.md" +Enter +Sleep 300ms + +# Clear the screen to start fresh +Type "clear" +Enter +Sleep 500ms + +# Show commands from here +Show + +# Now run cz commit +Type "cz commit" +Sleep 500ms +Enter + +# Wait for first prompt to appear +Sleep 2s + +# Question 1: Select the type of change (press d to "docs") +Sleep 1s +Type "d" +Sleep 2s +Enter +Sleep 1s + +# Question 2: Scope (optional, skip) +Enter +Sleep 1s + +# Question 3: Subject +Type "demo with custom keys" +Sleep 500ms +Enter +Sleep 500ms + +# Question 4: Is this a BREAKING CHANGE? (No) +Enter +Sleep 500ms + +# Question 5: Body (optional, skip) +Enter +Sleep 500ms + +# Question 6: Footer (optional, skip) +Enter +Sleep 500ms + +# Wait for commit success message +Sleep 1s diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index fbd06922b1..0000000000 --- a/docs/index.md +++ /dev/null @@ -1,112 +0,0 @@ - -[![Travis](https://img.shields.io/travis/Woile/commitizen.svg?style=flat-square)](https://travis-ci.org/Woile/commitizen) -[![Conventional -Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org) -[![PyPI Package latest -release](https://img.shields.io/pypi/v/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/) -[![Supported -versions](https://img.shields.io/pypi/pyversions/commitizen.svg?style=flat-square)](https://pypi.org/project/commitizen/) -[![Codecov](https://img.shields.io/codecov/c/github/Woile/commitizen.svg?style=flat-square)](https://codecov.io/gh/Woile/commitizen) - - -![Using commitizen cli](images/demo.gif) - -## About - -Commitizen is a tool designed for teams. - -Its main purpose is to define a standard way of commiting rules -and communicating it (using the cli provided by commitizen). - -The reasoning behind it is that is easier to read, and enforces writing -descriptive commits. - -Besides that, having a convetion on your commits, makes it possible to -parse them and use them for something else, like generating automatically -the version or a changelog. - -### Commitizen features - -* Command line utility to create commits with your rules. Defaults: [Conventional commits][conventional_commits] -* Display information about your commit rules (commands: schema, example, info) -* Bump version automatically using [semantic verisoning][semver] based on the commits. [Read More](./bump.md) -* Generate a changelog using [Keep a changelog][keepchangelog] (Planned feature) - -## Requirements - -Python 3.6+ - -[Git][gitscm] `1.8.5.2`+ - -## Installation - -Global installation - -```bash -sudo pip3 install -U Commitizen -``` - -### Python project - -You can add it to your local project using one of these: -```bash -pip install -U commitizen -``` - -```bash -poetry add commitizen --dev -``` - -## Usage - -### Commiting - - -Run in your terminal - - cz commit - -or the shortcut - - cz c - -### Help - -```bash -$ cz --help -usage: cz [-h] [--debug] [-n NAME] [--version] - {ls,commit,c,example,info,schema,bump} ... - -Commitizen is a cli tool to generate conventional commits. -For more information about the topic go to https://conventionalcommits.org/ - -optional arguments: --h, --help show this help message and exit ---debug use debug mode --n NAME, --name NAME use the given commitizen ---version get the version of the installed commitizen - -commands: -{ls,commit,c,example,info,schema,bump} - ls show available commitizens - commit (c) create new commit - example show commit example - info show information about the cz - schema show commit schema - bump bump semantic version based on the git log -``` - -## Contributing - -Feel free to create a PR. - -1. Clone the repo. -2. Add your modifications -3. Create a virtualenv -4. Run `./scripts/test` - -[conventional_commits]: https://www.conventionalcommits.org -[semver]: https://semver.org/ -[keepchangelog]: https://keepachangelog.com/ -[gitscm]: https://git-scm.com/downloads -[Travis]: https://img.shields.io/travis/Woile/commitizen.svg?style=flat-square diff --git a/docs/third-party-plugins/about.md b/docs/third-party-plugins/about.md new file mode 100644 index 0000000000..9711386fc8 --- /dev/null +++ b/docs/third-party-plugins/about.md @@ -0,0 +1,73 @@ +# What are third-party plugins? + +Third-party plugins are a way to extend Commitizen with additional customized features. + +These plugins are available as PyPI packages (installable with `pip`). + +!!! note + New plugins are welcome! Once you published your plugins, please send us a PR to update this page. + +!!! note "Historical notes" + This section was originally called "Third-Party Commitizen Templates", but has been renamed to "Third-Party Commitizen Plugins" to better reflect the content. + +## Plugin features + +<!-- TODO: provide more details about the features --> +<!-- We can move the details from customization pages to here --> + +### Commit message convention + +Includes the rules to validate and generate commit messages. + +### Version scheme + +Includes the rules to generate version numbers. + +### Version provider + +Read and write version from data sources. + +### Changelog format + +Generate changelog in customized formats. + +<!-- TODO: complete the following section --> +<!-- ## How do I create a new plugin? --> + +## How to help us update the list of plugins? + +Please document what features the plugin provides: + +- a convention +- a scheme +- a provider +- a `changelog_format` + +Of course, a plugin can provide multiple features. +You may have noticed that `commitizen` itself can be viewed as a plugin that provides all the above features. + +Please see [cz-path](./cz-path.md) for a detailed example. + +## New plugin documentation template + + # [Package name](https://github.com/author/package-name) + + <!-- Description of the plugin. --> + + <!-- What features does the plugin provide? --> + + ## Installation + + ```sh + pip install package-name + ``` + + ## Usage + + ```sh + cz --name package-name commit + ``` + + ## Example + + <!-- Example usage of the plugin. --> diff --git a/docs/third-party-plugins/commitizen-deno-provider.md b/docs/third-party-plugins/commitizen-deno-provider.md new file mode 100644 index 0000000000..77f7d2e177 --- /dev/null +++ b/docs/third-party-plugins/commitizen-deno-provider.md @@ -0,0 +1,28 @@ +# [commitizen-deno-provider](https://pypi.org/project/commitizen-deno-provider/) + +A provider for **Deno** projects. The provider updates the version in `deno.json` and `jsr.json` files. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install commitizen-deno-provider +``` + +## Usage + +Add `deno-provider` to your configuration file. + +Example for `.cz.yaml`: + +```yaml +--- +commitizen: + major_version_zero: true + name: cz_conventional_commits + tag_format: $version + update_changelog_on_bump: true + version_provider: deno-provider + version_scheme: semver +``` diff --git a/docs/third-party-plugins/commitizen-emoji.md b/docs/third-party-plugins/commitizen-emoji.md new file mode 100644 index 0000000000..e8e2654516 --- /dev/null +++ b/docs/third-party-plugins/commitizen-emoji.md @@ -0,0 +1,17 @@ +# [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) (Unmaintained) + +Just like *conventional commit* format, but with emojis and optionally time spent and related tasks. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install commitizen-emoji +``` + +## Usage + +```sh +cz --name cz_commitizen_emoji commit +``` diff --git a/docs/third-party-plugins/conventional-jira.md b/docs/third-party-plugins/conventional-jira.md new file mode 100644 index 0000000000..99505a2743 --- /dev/null +++ b/docs/third-party-plugins/conventional-jira.md @@ -0,0 +1,13 @@ +# [Conventional JIRA](https://pypi.org/project/conventional-JIRA/) + +Just like _conventional commit_ format, but the scope has been restricted to a +JIRA issue format, i.e. `project-issueNumber`. This standardises scopes in a +meaningful way. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install conventional-JIRA +``` diff --git a/docs/third-party-plugins/cz-ai.md b/docs/third-party-plugins/cz-ai.md new file mode 100644 index 0000000000..e9ced907bf --- /dev/null +++ b/docs/third-party-plugins/cz-ai.md @@ -0,0 +1,17 @@ +# [cz-ai](https://github.com/watadarkstar/cz_ai) + +A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install cz-ai +``` + +## Usage + +```sh +cz --name cz_ai commit +``` diff --git a/docs/third-party-plugins/cz-conventional-gitmoji.md b/docs/third-party-plugins/cz-conventional-gitmoji.md new file mode 100644 index 0000000000..f4157105e7 --- /dev/null +++ b/docs/third-party-plugins/cz-conventional-gitmoji.md @@ -0,0 +1,19 @@ +# [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji) + +*conventional commit*s, but with [gitmojis](https://gitmoji.dev). + +Includes a pre-commit hook that automatically adds the correct gitmoji to the commit message based on the conventional type. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install cz-conventional-gitmoji +``` + +## Usage + +```sh +cz --name cz_gitmoji commit +``` diff --git a/docs/third-party-plugins/cz-emoji.md b/docs/third-party-plugins/cz-emoji.md new file mode 100644 index 0000000000..c638f4bfa1 --- /dev/null +++ b/docs/third-party-plugins/cz-emoji.md @@ -0,0 +1,17 @@ +# [cz-emoji](https://github.com/adam-grant-hendry/cz-emoji) + +_conventional commit_ format, but with emojis. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install cz-emoji +``` + +## Usage + +```sh +cz --name cz_emoji commit +``` diff --git a/docs/third-party-plugins/cz-legacy.md b/docs/third-party-plugins/cz-legacy.md new file mode 100644 index 0000000000..4f0a2e1221 --- /dev/null +++ b/docs/third-party-plugins/cz-legacy.md @@ -0,0 +1,19 @@ +# [Conventional Legacy (cz_legacy)][cz_legacy] + +An extension of the *conventional commit* format to include user-specified +legacy change types in the `CHANGELOG` while preventing the legacy change types +from being used in new commit messages. + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install cz_legacy +``` + +## Usage + +See the [Conventional Legacy README][cz_legacy] for instructions on configuration. + +[cz_legacy]: https://pypi.org/project/cz_legacy diff --git a/docs/third-party-plugins/cz-path.md b/docs/third-party-plugins/cz-path.md new file mode 100644 index 0000000000..7a2ba59176 --- /dev/null +++ b/docs/third-party-plugins/cz-path.md @@ -0,0 +1,54 @@ +# [cz-path](https://pypi.org/project/cz-path/) + +Provides prefix choices for commit messages based on staged files (Git only). +For example, if the staged files are `component/z/a.ts` and `component/z/b.ts`, +the path prefix option will be `component/z` and commit message might look like: +`component/z/: description of changes`. If only one file is staged, the extension +is removed in the prefix. + +This plugins provides a commitizen convention for commit messages. + +## Installation + +```sh +pip install cz-path +``` + +## Usage + +Add `cz-path` to your configuration file. + +Example for `.cz.json`: + +```json +{ + "commitizen": { + "name": "cz_path", + "remove_path_prefixes": ["src", "module_name"] + } +} +``` + +The default value for `remove_path_prefixes` is `["src"]`. Adding `/` to the +prefixes is not required. + +## Example session + +```plain + $ git add .vscode/ + $ cz -n cz_path c +? Prefix: (Use arrow keys) + » .vscode + .vscode/ + project + (empty) +? Prefix: .vscode +? Commit title: adjust settings + +.vscode: adjust settings + +[main 0000000] .vscode: adjust settings + 2 files changed, 1 insertion(+), 11 deletions(-) + +Commit successful! +``` diff --git a/docs/third-party-plugins/github-jira-conventional.md b/docs/third-party-plugins/github-jira-conventional.md new file mode 100644 index 0000000000..6032b8e7ff --- /dev/null +++ b/docs/third-party-plugins/github-jira-conventional.md @@ -0,0 +1,17 @@ +# [GitHub JIRA Conventional](https://pypi.org/project/cz-github-jira-conventional/) + +This plugin extends the Commitizen tools by: + +- requiring a JIRA issue ID in the commit message +- creating links to GitHub commits in `CHANGELOG.md` +- creating links to JIRA issues in `CHANGELOG.md` + +<!-- TODO: What features does the plugin provide? --> + +## Installation + +```sh +pip install cz-github-jira-conventional +``` + +For installation instructions (configuration and pre-commit), please visit the [GitHub repository](https://github.com/apheris/cz-github-jira-conventional). diff --git a/docs/tutorials/auto_check.md b/docs/tutorials/auto_check.md new file mode 100644 index 0000000000..dc2b6a90c2 --- /dev/null +++ b/docs/tutorials/auto_check.md @@ -0,0 +1,162 @@ +# Automatically check message before commit + +## About + +To automatically check a commit message before committing, use a [Git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks). This ensures all commit messages match your project's commitizen format before they are accepted into the repository. + +When a commit message fails validation, Git rejects the commit and displays an error explaining what went wrong. Update the message to the required format before trying again. + +## How to + +There are two common methods for installing the hooks: + +### Method 1: Using pre-commit hook frameworks (Recommended) + +Using pre-commit hook frameworks is the recommended approach because hook installation, updates, and execution are handled automatically. +Two common frameworks are: + +1. [prek](https://prek.j178.dev) (faster) +2. [pre-commit](https://pre-commit.com/) + + +In the steps below, we'll use `prek`. + + +!!! tip "Using pre-commit framework" + If you use pre-commit instead of prek, you can run the same commands. Simply replace prek with pre-commit in the steps below. + + + +#### Step 1: Install prek + +```sh +python -m pip install prek +``` + +#### Step 2: Create `.pre-commit-config.yaml` + +Create a `.pre-commit-config.yaml` file in your project root directory with the following content: + +```yaml +--- +repos: + - repo: https://github.com/commitizen-tools/commitizen + rev: v4.10.0 # Use the latest version or a specific version + hooks: + - id: commitizen + stages: [commit-msg] +``` + +!!! tip "Using the latest version" + Replace `v4.10.0` with the latest commitizen version. You can find the latest version on [GitHub releases](https://github.com/commitizen-tools/commitizen/releases) or use a specific commit SHA for pinning to an exact version. + +#### Step 3: Install the hook + +Install the configuration into Git's hook system: + +```bash +prek install --hook-type commit-msg +``` + +The hook is now active! Every time you create a commit, commitizen will automatically validate your commit message. + +### Method 2: Manual Git hook installation + +If you prefer not to use a pre-commit framework, you can manually create a Git hook. This gives you full control over the hook script but requires manual maintenance. + +#### Step 1: Create the commit-msg hook + +Navigate to your project's `.git/hooks` directory and create the `commit-msg` hook file: + +```bash +cd .git/hooks +touch commit-msg +chmod +x commit-msg +``` + +#### Step 2: Add the commitizen check command + +Open the `commit-msg` file in your editor and add the following content: + +```bash +#!/bin/bash +cz check --allow-abort --commit-msg-file $1 +``` + +Where: + +- `$1` is the temporary file path that Git provides, containing the current commit message +- `--allow-abort` allows empty commit messages (which typically instruct Git to abort a commit) +- `--commit-msg-file` tells commitizen to read the commit message from the specified file + +The hook is now active! Each time you create a commit, this hook will automatically validate your commit message. + +## Testing the hook + +After installing the hook, you can test it by attempting to commit with an invalid message: + +```bash +# This should fail with an invalid message +git commit -m "invalid commit message" + +# This should succeed with a valid message +git commit -m "feat: add new feature" +``` + +If the hook is working correctly, invalid commit messages are rejected with an error explaining what's wrong. + +## What happens when validation fails? + +When a commit message fails validation: + +1. Git will abort the commit +2. An error message will be displayed showing: + - Which commit failed (if checking multiple commits) + - The invalid commit message + - The expected pattern/format +3. Your changes remain staged, so you can simply amend the commit message and try again + +Example error output: + +<!-- DEPENDENCY: InvalidCommitMessageError --> + +``` +commit validation: failed! +please enter a commit message in the commitizen format. +commit "abc123": "invalid message" +pattern: ^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert)(\(.+\))?: .{1,} +``` + +## Troubleshooting + +### Hook not running + +- **Verify the hook file exists**: Check that `.git/hooks/commit-msg` exists and is executable +- **Check file permissions**: Ensure the hook has execute permissions (`chmod +x .git/hooks/commit-msg`) +- **Verify commitizen is installed**: Run `cz --version` to confirm commitizen is available in your PATH +- **Check Git version**: Ensure you're using a recent version of Git that supports hooks + +### Prek hook not working + +- **Verify installation**: Run `prek --version` to confirm pre-commit is installed +- **Reinstall the hook**: Try running `prek install --hook-type commit-msg` again +- **Check configuration**: Verify your `.pre-commit-config.yaml` file is valid YAML and in the project root +- **Update hooks**: Run `prek autoupdate` to update to the latest versions + +### Bypassing the hook (when needed) + +If you need to bypass the hook temporarily (e.g., for merge commits or special cases), you can use: + +```bash +git commit --no-verify -m "your message" +``` + +!!! warning "Use with caution" + Only bypass hooks when absolutely necessary, as it defeats the purpose of automated validation. + +## Additional resources + +- Learn more about [Git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) +- See the [check command documentation](../commands/check.md) for more validation options +- Check out [prek documentation](https://prek.j178.dev/) for advanced hook management +- Check out [pre-commit documentation](https://pre-commit.com/) for advanced hook management diff --git a/docs/tutorials/auto_prepare_commit_message.md b/docs/tutorials/auto_prepare_commit_message.md new file mode 100644 index 0000000000..84ac62b689 --- /dev/null +++ b/docs/tutorials/auto_prepare_commit_message.md @@ -0,0 +1,46 @@ +# Automatically prepare message before commit + +## About + +It can be desirable to use Commitizen for all types of commits (i.e. regular, merge, +squash) so that the complete git history adheres to the commit message convention +without ever having to call `cz commit`. + +To automatically prepare a commit message prior to committing, you can +use a [prepare-commit-msg Git hook][prepare-commit-msg-docs]: + +> This hook is invoked by git-commit right after preparing the +> default log message, and before the editor is started. + +To automatically perform arbitrary cleanup steps after a successful commit you can use a +[post-commit Git hook][post-commit-docs]: + +> This hook is invoked by git-commit. It takes no parameters, and is invoked after a +> commit is made. + +A combination of these two hooks allows for enforcing the usage of Commitizen so that +whenever a commit is about to be created, Commitizen is used for creating the commit +message. Running `git commit` or `git commit -m "..."` for example, would trigger +Commitizen and use the generated commit message for the commit. + +## Installation + +Copy the hooks from [here](https://github.com/commitizen-tools/commitizen/tree/master/hooks) into the `.git/hooks` folder and make them + executable by running the following commands from the root of your Git repository: + +```bash +wget -O .git/hooks/prepare-commit-msg https://raw.githubusercontent.com/commitizen-tools/commitizen/master/hooks/prepare-commit-msg.py +chmod +x .git/hooks/prepare-commit-msg +wget -O .git/hooks/post-commit https://raw.githubusercontent.com/commitizen-tools/commitizen/master/hooks/post-commit.py +chmod +x .git/hooks/post-commit +``` + +## Features + +- Commits can be created using both `cz commit` and the regular `git commit` +- The hooks automatically create a backup of the commit message that can be reused if + the commit failed +- The commit message backup can also be used via `cz commit --retry` + +[post-commit-docs]: https://git-scm.com/docs/githooks#_post_commit +[prepare-commit-msg-docs]: https://git-scm.com/docs/githooks#_prepare_commit_msg diff --git a/docs/tutorials/dev_releases.md b/docs/tutorials/dev_releases.md new file mode 100644 index 0000000000..e2b29fb191 --- /dev/null +++ b/docs/tutorials/dev_releases.md @@ -0,0 +1,73 @@ +# Dev Releases + +## About + +To make use of a `.dev` suffix, as per +[PEP440](https://peps.python.org/pep-0440/#developmental-releases). + +If multiple active branches attempt to create a tag relative to the main branch, there is a possibility that they will attempt to create the _same_ tag, resulting in a collision. + +Developmental releases aim to avoid this by including a `.dev` segment which +includes a non-negative integer unique to that workflow: + +```txt +X.Y.devN +``` + +!!! note + As noted in + [PEP440](https://peps.python.org/pep-0440/#developmental-releases), + while developmental releases help avoid the situation described above, they can be _"difficult to parse for human readers"_ depending on the value passed as the developmental release. + +## How to + +### Example 1: CircleCI + +For example, CircleCI [provides](https://circleci.com/docs/variables/) +`CIRCLE_BUILD_NUM`, a unique number for each job which will increment with each +run: + +```sh +--devrelease ${CIRCLE_BUILD_NUM} +``` + +This will result in a unique developmental release of, for example: + +```sh +1.3.2.dev2478 +``` + +### Example 2: GitHub + +GitHub also +[provides](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables) +`GITHUB_RUN_ID`, a _"unique number for each workflow run"_ which will also +provide a unique number for each workflow: + +```sh +--devrelease ${GITHUB_RUN_ID} +``` + +This will result in a unique developmental release of, for example: + +```sh +1.3.2.dev6048584598 +``` + +### Example 3: Unix time + +Equally, as the developmental release needs only a non-negative integer, it is +possible to use the Unix time (i.e. the number of seconds since 1st January +1970 UTC). + +This approach could potentially create a collision if two builds occur at precisely the same second, but it may be sufficient for many use cases: + +```sh +--devrelease $(date +%s) +``` + +This will result in a unique developmental release of, for example: + +```sh +1.3.2.dev1696238452 +``` diff --git a/docs/tutorials/github_actions.md b/docs/tutorials/github_actions.md new file mode 100644 index 0000000000..c3b06336a9 --- /dev/null +++ b/docs/tutorials/github_actions.md @@ -0,0 +1,191 @@ +## Create a new release with GitHub Actions + +This guide shows you how to automatically bump versions, create changelogs, and publish releases using Commitizen in GitHub Actions. + +### Prerequisites + +Before setting up the workflow, you'll need: + +1. A personal access token with repository write permissions +2. Commitizen configured in your project (see [configuration documentation](../config/configuration_file.md)) + +### Automatic version bumping + +To automatically execute `cz bump` in your CI and push the new commit and tag back to your repository, follow these steps: + +#### Step 1: Create a personal access token + +1. Go to [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens) +2. Click "Generate new token (classic)" +3. Give it a descriptive name (e.g., "Commitizen CI") +4. Select the `repo` scope to grant full repository access +5. Click "Generate token" and **copy the token immediately** (you won't be able to see it again) + +!!! warning "Important: Use Personal Access Token, not GITHUB_TOKEN" + If you use `GITHUB_TOKEN` instead of `PERSONAL_ACCESS_TOKEN`, the workflow won't trigger another workflow run. This is a GitHub security feature to prevent infinite loops. The `GITHUB_TOKEN` is treated like using `[skip ci]` in other CI systems. + +#### Step 2: Add the token as a repository secret + +1. Go to your repository on GitHub +2. Navigate to `Settings > Secrets and variables > Actions` +3. Click "New repository secret" +4. Name it `PERSONAL_ACCESS_TOKEN` +5. Paste the token you copied in Step 1 +6. Click "Add secret" + +#### Step 3: Create the workflow file + +Create a new file `.github/workflows/bumpversion.yml` in your repository with the following content: + +```yaml title=".github/workflows/bumpversion.yml" +name: Bump version + +on: + push: + branches: + - master # or 'main' if that's your default branch + +jobs: + bump-version: + if: "!startsWith(github.event.head_commit.message, 'bump:')" + runs-on: ubuntu-latest + name: "Bump version and create changelog with commitizen" + steps: + - name: Check out + uses: actions/checkout@v6 + with: + token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" + fetch-depth: 0 + - name: Create bump and changelog + uses: commitizen-tools/commitizen-action@master + with: + github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} +``` + +#### How it works + +- **Trigger**: The workflow runs on every push to the `master` branch (or `main` if you change it) +- **Conditional check**: The `if` condition prevents infinite loops by skipping the job if the commit message starts with `bump:` +- **Checkout**: Uses your personal access token to check out the repository with full history (`fetch-depth: 0`) +- **Bump**: The `commitizen-action` automatically: + - Determines the version increment based on your commit messages + - Updates version files (as configured in your `pyproject.toml` or other config) + - Creates a new git tag + - Generates/updates the changelog + - Pushes the commit and tag back to the repository + +Once you push this workflow file to your repository, it will automatically run on the next push to your default branch. + +Check out [commitizen-action](https://github.com/commitizen-tools/commitizen-action) for more details. + +### Creating a GitHub release + +To automatically create a GitHub release when a new version is bumped, you can extend the workflow above. + +The `commitizen-action` creates an environment variable called `REVISION` containing the newly created version. You can use this to create a release with the changelog content. + +```yaml title=".github/workflows/bumpversion.yml" +name: Bump version + +on: + push: + branches: + - master # or 'main' if that's your default branch + +jobs: + bump-version: + if: "!startsWith(github.event.head_commit.message, 'bump:')" + runs-on: ubuntu-latest + name: "Bump version and create changelog with commitizen" + steps: + - name: Check out + uses: actions/checkout@v6 + with: + token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}" + fetch-depth: 0 + - name: Create bump and changelog + uses: commitizen-tools/commitizen-action@master + with: + github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }} + changelog_increment_filename: body.md + - name: Release + uses: ncipollo/release-action@v1 + with: + tag: v${{ env.REVISION }} + bodyFile: "body.md" + skipIfReleaseExists: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +``` + +You can find the complete workflow in our repository at [bumpversion.yml](https://github.com/commitizen-tools/commitizen/blob/master/.github/workflows/bumpversion.yml). + +### Publishing a Python package + +After a new version tag is created by the bump workflow, you can automatically publish your package to PyPI. + +#### Step 1: Create a PyPI API token + +1. Go to [PyPI Account Settings](https://pypi.org/manage/account/) +2. Scroll to the "API tokens" section +3. Click "Add API token" +4. Give it a name (e.g., "GitHub Actions") +5. Set the scope (project-specific or account-wide) +6. Click "Add token" and **copy the token immediately** + +!!! tip "Using trusted publishing (recommended)" + Instead of API tokens, consider using [PyPI trusted publishing](https://docs.pypi.org/trusted-publishers/) with OpenID Connect (OIDC). This is more secure as it doesn't require storing secrets. The `pypa/gh-action-pypi-publish` action supports trusted publishing when you configure it in your PyPI project settings. + +#### Step 2: Add the token as a repository secret + +1. Go to your repository on GitHub +2. Navigate to `Settings > Secrets and variables > Actions` +3. Click "New repository secret" +4. Name it `PYPI_PASSWORD` +5. Paste the PyPI token +6. Click "Add secret" + +#### Step 3: Create the publish workflow + +Create a new file `.github/workflows/pythonpublish.yml` that triggers on tag pushes: + +```yaml title=".github/workflows/pythonpublish.yml" +name: Upload Python Package + +on: + push: + tags: + - "*" # Will trigger for every tag, alternative: 'v*' + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + with: + fetch-depth: 0 + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.x" + - name: Install Poetry + uses: snok/install-poetry@v1 + with: + version: latest + virtualenvs-in-project: true + virtualenvs-create: true + - name: Install dependencies + run: | + poetry --version + poetry install + - name: Build and publish + env: + POETRY_HTTP_BASIC_PYPI_USERNAME: __token__ + POETRY_HTTP_BASIC_PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }} + run: poetry publish --build +``` + +This workflow uses Poetry to build and publish the package. You can find the complete workflow in our repository at [pythonpublish.yml](https://github.com/commitizen-tools/commitizen/blob/master/.github/workflows/pythonpublish.yml). + +!!! note "Alternative publishing methods" + You can also use [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) or other build tools like `setuptools`, `flit`, or `hatchling` to publish your package. diff --git a/docs/tutorials/gitlab_ci.md b/docs/tutorials/gitlab_ci.md new file mode 100644 index 0000000000..0af05c4e7b --- /dev/null +++ b/docs/tutorials/gitlab_ci.md @@ -0,0 +1,113 @@ +## Create a new release using GitLab CI + +For this example, we have a `python/django` application and `Docker` as a containerization tool. + +_Goal_: Bump a new version every time that a change occurs on the `master` branch. The bump should be executed automatically by the `CI` process. + +### Development Workflow + +1. A developer creates a new commit on any branch (except `master`) +2. A developer creates a merge request (MR) against `master` branch +3. When the `MR` is merged into master, the 2 stages of the CI are executed +4. For simplification, we store the software version in a file called `VERSION`. You can use any file that you want as `commitizen` supports it. +5. The commit message executed automatically by the `CI` must include `[skip-ci]` in the message; otherwise, the process will generate a loop. You can define the message structure in [commitizen](../commands/bump.md) as well. + +### GitLab Configuration + +To be able to change files and push new changes with `GitLab CI` runners, we need to have a `ssh` key and configure a git user. + +First, let's create a `ssh key`. The only requirement is to create it without a passphrase: + +```bash +ssh-keygen -f deploy_key -N "" +``` + +The previous command will create a private and public key under the files `deploy_key` and `deploy_key.pub`. We will use them later. + +For the git user, we need an email and username. You can choose whatever you want; in this example, we choose `ci-runner@myproject.com` and `admin`, respectively. + +Now, we need to create three environment variables that will be visible for the runners. They should be created in the `variables` section under `settings/ci_cd`: + +![gitlab variables](../images/gitlab_ci/gitlab_variables.png) + +Create `SSH_PRIVATE_KEY`, `CI_EMAIL`, `CI_USERNAME` variables, and fill them with the `private_key`, `email` and `username` that we have created previously. + +The latest step is to create a `deploy key.` To do this, we should create it under the section `settings/repository` and fill it with the `public key` generated before. Check `Write access allowed`; otherwise, the runner won't be able to write the changes to the repository. + +![gitlab deploy key](../images/gitlab_ci/gitlab_deploy_key.png) + +If you have more projects under the same organization, you can reuse the deploy key created before, but you will have to repeat the step where we have created the environment variables (ssh key, email, and username). + +Tip: If the CI raise some errors, try to unprotect the private key. + +### Defining GitLab CI Pipeline + +1. Create a `.gitlab-ci.yaml` file that contains `stages` and `jobs` configurations. You can find more info [here](https://docs.gitlab.com/ee/ci/quick_start/). + +2. Define `stages` and `jobs`. For this example, we define two `stages` with one `job` each one. + - Test the application. + - Auto bump the version. This means changing the file/s that reflects the version, creating a new commit and git tag. + +### Stages and Jobs + +```yaml +image: docker:latest + +services: + - docker:dind + +variables: + API_IMAGE_NAME: $CI_REGISTRY_IMAGE:$CI_COMMIT_REF_NAME + +before_script: + - apk add --no-cache py-pip + - pip install docker-compose + +stages: + - test + - auto-bump + +test: + stage: test + script: + - docker-compose run -e DJANGO_ENVIRONMENT=dev your_project python manage.py test # run tests + +auto-bump: + stage: auto-bump + image: python:3.10 + before_script: + - "which ssh-agent || ( apt-get update -qy && apt-get install openssh-client -qqy )" + - eval `ssh-agent -s` + - echo "${SSH_PRIVATE_KEY}" | tr -d '\r' | ssh-add - > /dev/null # add ssh key + - pip3 install -U commitizen # install commitizen + - mkdir -p ~/.ssh + - chmod 700 ~/.ssh + - echo "$SSH_PUBLIC_KEY" >> ~/.ssh/id_rsa.pub + - '[[ -f /.dockerenv ]] && echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config' + dependencies: + - test + script: + - git remote set-url origin git@gitlab.com:discover/rentee-core.git # git configuration + - git config --global user.email "${CI_EMAIL}" && git config --global user.name "${CI_USERNAME}" + - 'exists=`git show-ref refs/heads/master` && if [ -n "$exists" ]; then git branch -D master; fi' + - git checkout -b master + - cz bump --yes # execute auto bump and push to master + - git push origin master:$CI_COMMIT_REF_NAME + - TAG=$(head -n 1 VERSION) # get the new software version and save into artifacts + - echo "#!/bin/sh" >> variables + - echo "export TAG='$TAG'" >> variables + - git push origin $TAG + only: + refs: + - master + artifacts: + paths: + - variables +``` + +So, every time that a developer pushes to any branch, the `test` job is executed. If the branch is `master` and the test jobs succeed, the `auto-bump` takes place. +To be able to push using the GitLab runner, we have to set the SSH key, configure git, and finally execute the auto bump. + +After merging the new changes into master, we have the final result: + +![gitlab final ci result](../images/gitlab_ci/gitlab_final_ci_result.png) diff --git a/docs/tutorials/jenkins_pipeline.md b/docs/tutorials/jenkins_pipeline.md new file mode 100644 index 0000000000..2b9ad173d3 --- /dev/null +++ b/docs/tutorials/jenkins_pipeline.md @@ -0,0 +1,53 @@ +# Create a new release with Jenkins Pipelines + +For this we are using the modern approach of [declarative pipelines](https://www.jenkins.io/doc/book/pipeline/). + +You must also ensure your jenkins instance supports docker. +Most modern jenkins systems do have support for it, [they have embraced it](https://www.jenkins.io/doc/book/pipeline/docker/). + +```groovy +pipeline { + agent { + any + } + environment { + CI = 'true' + } + stages { + stage('Bump version') { + when { + beforeAgent true + expression { env.BRANCH_IS_PRIMARY } + not { + changelog '^bump:.+' + } + } + steps { + script { + useCz { + sh "cz bump --changelog" + } + // Here push back to your repository the new commit and tag + } + } + } + } +} + +def useCz(String authorName = 'Jenkins CI Server', String authorEmail = 'your-jenkins@email.com', String image = 'registry.hub.docker.com/commitizen/commitizen:latest', Closure body) { + docker + .image(image) + .inside("-u 0 -v $WORKSPACE:/workspace -w /workspace -e GIT_AUTHOR_NAME='${authorName}' -e GIT_AUTHOR_EMAIL='${authorEmail}' -entrypoint='/bin/sh'") { + sh 'git config --global --add safe.directory "*"' + sh "git config --global user.email '${authorName}'" + sh "git config --global user.name '${authorEmail}'" + body() + } +} +``` + +!!! warning + Using jenkins pipeline with any git plugin may require many configurations, + you'll have to tinker with it until your pipelines properly detects git events. Check your + webhook in your git repository and check the "behaviors" and "build strategies" in + your pipeline settings. diff --git a/docs/tutorials/monorepo_guidance.md b/docs/tutorials/monorepo_guidance.md new file mode 100644 index 0000000000..f863a9e531 --- /dev/null +++ b/docs/tutorials/monorepo_guidance.md @@ -0,0 +1,87 @@ +# Configuring Commitizen in a monorepo + +This tutorial assumes that your monorepo is structured with multiple components that can be released independently of each other. +It also assumes that you are using conventional commits with scopes. + +Here is a step-by-step example using two libraries, `library-b` and `library-z`: + +1. **Organize your monorepo** + + For example, you might have one of these layouts: + + ```shell-session + . + ├── library-b + │   └── .cz.toml + └── library-z + └── .cz.toml + ``` + + ```shell-session + src + ├── library-b + │   └── .cz.toml + └── library-z + └── .cz.toml + ``` + +2. **Add a Commitizen configuration for each component** + + ```toml + # library-b/.cz.toml + [tool.commitizen] + name = "cz_customize" + version = "0.0.0" + tag_format = "${version}-library-b" # the component name can be a prefix or suffix with or without a separator + ignored_tag_formats = ["${version}-library-*"] # Avoid noise from other tags + update_changelog_on_bump = true + ``` + + ```toml + # library-z/.cz.toml + [tool.commitizen] + name = "cz_customize" + version = "0.0.0" + tag_format = "${version}-library-z" + ignored_tag_formats = ["${version}-library-*"] # Avoid noise from other tags + update_changelog_on_bump = true + ``` + +3. **Bump each component independently** + + ```sh + cz --config library-b/.cz.toml bump --yes + cz --config library-z/.cz.toml bump --yes + ``` + + +## Changelog per component + +To filter the correct commits for each component, you'll need to define a strategy. + +For example: + +- Trigger the pipeline based on the changed path. This can have some downsides, as you'll rely on the developer not including files from unrelated components. + - [GitHub Actions](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore) uses `path` + - [Jenkins](https://www.jenkins.io/doc/book/pipeline/syntax/#built-in-conditions) uses `changeset` + - [GitLab](https://docs.gitlab.com/ee/ci/yaml/#ruleschanges) uses `rules:changes` +- Filter commits by a specific pattern in the commit message (recommended) + + +### Example with scope in conventional commits + +In this example, we want `library-b`'s changelog to only include commits that use the `library-b` scope. +To achieve this, we configure Commitizen to match only commit messages with that scope. + +Here is an example configuration for `library-b`: + +```toml +[tool.commitizen.customize] +changelog_pattern = "^(feat|fix)\\(library-b\\)(!)?:" # the type pattern can be a wildcard or any types you wish to include +``` + +With this configuration, a commit message like the following would be included in `library-b`'s changelog: + +```text +fix(library-b): Some awesome message +``` diff --git a/docs/tutorials/tag_format.md b/docs/tutorials/tag_format.md new file mode 100644 index 0000000000..2d439e38ca --- /dev/null +++ b/docs/tutorials/tag_format.md @@ -0,0 +1,100 @@ +# Managing tag formats + +## Tag format and version scheme + +For most projects, the tag format is simply the version number which is set like this: + +```yaml +[tool.commitizen] +tag_format: $version +version_scheme: pep440 +``` + +As this is the default value, you don't have to specify it. + +This setting means that: + +- The tag generated on bump will have this format: `1.0.0` : + - the version is generated following PEP440 scheme + - the tag is exactly the generated version +- All tags having this format will be recognized as version tag when: + - searching the last while bumping a release + - searching previous versions while: + - generating incremental changelog + - generating a changelog for a version range +- The changelog versions (section titles) will have this format +- The `scm` version provider will identify the current version using this tag format + +The version format will change depending on your configured version scheme. +For most, it will only impact pre-releases and [developmental releases](dev_releases.md) formats (i.e. `1.0.0-rc.1` vs. `1.0.0.rc1`) + +But you may need a different tagging convention, let's say using `semver` and prefixed with a `v`. +In this case you will define your settings like this: + +```yaml +[tool.commitizen] +tag_format: v${version} +version_scheme: semver +``` + +As a result, the tag generated on bump will have this format: `v1.0.0` and the version will be generated following `semver` scheme. + +!!! note + Both `$version` and `${version}` syntaxes are strictly equivalent. You can use the one you prefer. + +See [`tag_format`](../commands/bump.md#-tag-format) and [`version_scheme`](../commands/bump.md#-version-scheme) settings for more details. + +## Changing convention + +Now, let's say you need to change the tag format for some reason (company convention, [migration to a monorepo](monorepo_guidance.md)...). +You will obviously want to keep all those features working as expected. + +Commitizen can deal with it as long as you provide the legacy tag format in the configuration. + +Using the previous example, let's say you want to move from `v${version}` to `component-${version}`. +Then `component-${version}` will be the new tag format and `v${version}` the legacy one. + +```yaml +[tool.commitizen] +tag_format: component-${version} +legacy_tag_formats: + - v${version} +``` + +This way, you won't lose your version history, you'll still be able to generate your changelog properly, +and on the next version bump, your last version in the form `v${version}` will be properly recognized if you use the `scm` version provider. +Your new tag will be in the form `component-${version}`. + +## Known tags to ignore + +Now let's say you have some known tags you want to ignore, either because they are not versions, or because they are not versions of the component you are dealing with. +As a consequence, you don't want them to trigger a warning because Commitizen detected an unknown tag format. + +Then you can tell Commitizen about it using the [`ignored_tag_formats`](../config/bump.md#ignored_tag_formats) setting: + +```yaml +[tool.commitizen] +ignored_tag_formats: + - prod + - other-component-${version} + - prefix-* +``` + +This will ignore: + +- The `prod` tag +- Any version tag prefixed with `other-component-` +- Any tag prefixed with `prefix-` + + +!!! tip + Note the `*` in the `prefix-*` pattern. This is a wildcard and only exists for `ignored_tag_formats`. + It will match any string from any length. This allows to exclude by prefix, whether it is followed by a version or not. + +!!! tip + If you don't want to be warned when Commitizen detects an unknown tag, you can do so by setting: + ``` + [tool.commitizen] + ignored_tag_formats = ["*"] + ``` + But be aware that you will not be warned if you have a typo in your tag formats. diff --git a/docs/tutorials/writing_commits.md b/docs/tutorials/writing_commits.md new file mode 100644 index 0000000000..b8aa7f30f0 --- /dev/null +++ b/docs/tutorials/writing_commits.md @@ -0,0 +1,160 @@ +# Commit Message Best Practices + +## About + +For Commitizen to work effectively in your development pipeline, commits must follow a consistent convention. By default, Commitizen uses the [Conventional Commits][conventional_commits] specification, which provides a standardized format for commit messages that enables automatic versioning and changelog generation. + +You can also create your own custom commit convention by following the [customization documentation][customization]. + +## Conventional Commits Format + +The Conventional Commits specification follows this structure: + +``` +<type>[optional scope]: <description> + +[optional body] + +[optional footer] +``` + +### Commit Types + +Commit types categorize the nature of your changes. The most important types for semantic versioning are: + +- **`feat`**: Introduces a new feature (correlates with **MINOR** version increment) +- **`fix`**: Patches a bug (correlates with **PATCH** version increment) + +Other commonly used types include: + +- **`docs`**: Documentation only changes +- **`style`**: Code style changes (formatting, missing semicolons, etc.) +- **`refactor`**: Code refactoring without changing functionality +- **`perf`**: Performance improvements +- **`test`**: Adding or updating tests +- **`build`**: Changes to build system or dependencies +- **`ci`**: Changes to CI configuration files +- **`chore`**: Other changes that don't modify source or test files + +!!! note + While `feat` and `fix` directly affect semantic versioning, other types (like `build`, `chore`, `docs`) typically don't trigger version bumps unless they include a `BREAKING CHANGE`. + +### Breaking Changes + +Breaking changes trigger a **MAJOR** version increment. You can indicate breaking changes in two ways: + +1. **In the commit body or footer**: + ``` + feat(api): change authentication method + + BREAKING CHANGE: The authentication API now requires OAuth2 instead of API keys. + ``` + +2. **In the commit title** (when enabled): + ``` + feat!: change authentication method + ``` + + To enable this syntax, set `breaking_change_exclamation_in_title = true` in your configuration. [Read more][breaking-change-config] + +### Scope + +An optional scope can be added to provide additional context about the area of the codebase affected: + +``` +feat(parser): add support for JSON arrays +fix(api): handle null response gracefully +``` + +## Writing Effective Commit Messages + +Well-written commit messages are crucial for maintaining a clear project history. When writing commits, consider: + +- **Your future self**: You'll need to understand these changes months later +- **Your team**: Clear messages help colleagues understand the codebase evolution +- **Automated tools**: Good messages enable better changelog generation and versioning + +### Best Practices + +#### 1. Keep the Subject Line Concise + +The subject line should be clear and concise (aim for ~50 characters). It should summarize what the commit does in one line. + +**Good:** +``` +fix(commands): handle missing user input gracefully +feat(api): add pagination support +``` + +**Avoid:** +``` +fix: stuff +feat: commit command introduced +``` + +#### 2. Use Imperative Mood + +Write commit messages in the imperative mood, as if completing the sentence: "If applied, this commit will..." + +**Good:** +``` +feat: add user authentication +fix: resolve memory leak in parser +``` + +**Avoid:** +``` +feat: added user authentication +fix: resolved memory leak in parser +``` + +#### 3. Think About the Changelog + +Your commits will likely appear in the automatically generated changelog. Write messages that make sense in that context. If you want to exclude a commit from the changelog, use types like `build`, `chore`, or `ci`. + +#### 4. One Feature Per Commit + +Keep commits focused on a single change. If you introduce multiple related changes, consider squashing them into a single commit. This makes the history cleaner and improves changelog generation. + +#### 5. Use the Body for Context + +For complex changes, use the commit body to explain: + +- **Why** the change was made +- **What** was changed (if not obvious from the subject) +- **How** it differs from previous behavior + +``` +feat(api): add rate limiting + +Implement rate limiting to prevent API abuse. The system now +enforces a maximum of 100 requests per minute per IP address. +Exceeding this limit returns a 429 status code. +``` + +### Examples + +| ✅ Good Examples | ❌ Poor Examples | +| ---------------- | ---------------- | +| `fix(commands): bump error when no user provided` | `fix: stuff` | +| `feat(api): add pagination to user list endpoint` | `feat: commit command introduced` | +| `docs: update installation instructions` | `docs: changes` | +| `refactor(parser): simplify token extraction logic` | `refactor: code cleanup` | + +## Character Encoding + +Commitizen supports Unicode characters (including emojis) in commit messages. This is useful if you're using commit message formats that include emojis, such as [cz-emoji][cz_emoji]. + +By default, Commitizen uses `utf-8` encoding. You can configure a different encoding through the `encoding` [configuration option][configuration]. + +## Related Documentation + +- [Conventional Commits Specification][conventional_commits] +- [Custom Commit Conventions][customization] +- [Commit Configuration Options](../config/commit.md) + +[customization]: ../customization/config_file.md +[conventional_commits]: https://www.conventionalcommits.org +[cz_emoji]: ../third-party-plugins/cz-emoji.md +[configuration]: ../config/commit.md#encoding +[breaking-change-config]: ../config/commit.md#breaking_change_exclamation_in_title diff --git a/hooks/post-commit.py b/hooks/post-commit.py new file mode 100755 index 0000000000..d242b6b354 --- /dev/null +++ b/hooks/post-commit.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python + +try: + from commitizen.cz.utils import get_backup_file_path +except ImportError as error: + print(f"could not import commitizen:\n{error}") + exit(1) + + +def post_commit() -> None: + backup_file_path = get_backup_file_path() + + # remove backup file if it exists + if backup_file_path.is_file(): + backup_file_path.unlink() + + +if __name__ == "__main__": + post_commit() + exit(0) diff --git a/hooks/prepare-commit-msg.py b/hooks/prepare-commit-msg.py new file mode 100755 index 0000000000..017ecc28ea --- /dev/null +++ b/hooks/prepare-commit-msg.py @@ -0,0 +1,62 @@ +#!/usr/bin/env python +import shutil +import subprocess +import sys +from pathlib import Path + +try: + from commitizen.cz.utils import get_backup_file_path +except ImportError as error: + print("could not import commitizen:") + print(error) + exit(1) + + +def prepare_commit_msg(commit_msg_file: str) -> int: + # check if the commit message needs to be generated using commitizen + exit_code = subprocess.run( + [ + "cz", + "check", + "--commit-msg-file", + commit_msg_file, + ], + capture_output=True, + ).returncode + if exit_code == 0: + return 0 + + backup_file = Path(get_backup_file_path()) + if backup_file.is_file(): + # confirm if commit message from backup file should be reused + answer = input("retry with previous message? [y/N]: ") + if answer.lower() == "y": + shutil.copyfile(backup_file, commit_msg_file) + return 0 + + # use commitizen to generate the commit message + exit_code = subprocess.run( + [ + "cz", + "commit", + "--dry-run", + "--write-message-to-file", + commit_msg_file, + ], + stdin=sys.stdin, + stdout=sys.stdout, + ).returncode + if exit_code: + return exit_code + + # write message to backup file + shutil.copyfile(commit_msg_file, backup_file) + return 0 + + +if __name__ == "__main__": + # make hook interactive by attaching /dev/tty to stdin + with open("/dev/tty") as tty: + sys.stdin = tty + exit_code = prepare_commit_msg(sys.argv[1]) + exit(exit_code) diff --git a/lychee.toml b/lychee.toml new file mode 100644 index 0000000000..f434f0727f --- /dev/null +++ b/lychee.toml @@ -0,0 +1,6 @@ +exclude_path = ["./tests"] + +exclude = [ + "https://conventionalcommits.org/", # Sometimes it's benign network error + "https://blog.devgenius.io/continuous-delivery-made-easy-in-python-c085e9c82e69" # Membership only article, sometimes it's 403 forbidden +] diff --git a/mkdocs.yml b/mkdocs.yml index 699e06b196..21d6376c50 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,22 +1,115 @@ site_name: Commitizen +site_url: https://commitizen-tools.github.io/commitizen/ site_description: commit rules, semantic version, conventional commits theme: - name: 'material' + name: material + logo: images/cz_logo.png + favicon: images/cz_logo.png + features: + - content.code.copy + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode -repo_name: Woile/commitizen -repo_url: https://github.com/Woile/commitizen + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: deep purple + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: deep purple + toggle: + icon: material/brightness-4 + name: Switch to system preference + +repo_name: commitizen-tools/commitizen +repo_url: https://github.com/commitizen-tools/commitizen edit_uri: "" nav: - - Introduction: 'index.md' - - Configuration: 'config.md' - - Bump: 'bump.md' - - Customization: 'customization.md' + - Introduction: "README.md" + - Commands: + - init: "commands/init.md" + - commit: "commands/commit.md" + - bump: "commands/bump.md" + - check: "commands/check.md" + - changelog: "commands/changelog.md" + - example: "commands/example.md" + - info: "commands/info.md" + - ls: "commands/ls.md" + - schema: "commands/schema.md" + - version: "commands/version.md" + - Configuration: + - Configuration File: "config/configuration_file.md" + - Version Provider: "config/version_provider.md" + - bump: "config/bump.md" + - commit: "config/commit.md" + - check: "config/check.md" + - changelog: "config/changelog.md" + - Misc Options: "config/option.md" + - Advanced Customization: + - Customize via config file: "customization/config_file.md" + - Customized Python Class: "customization/python_class.md" + - Changelog Template: "customization/changelog_template.md" + - Tutorials: + - Commit Message Best Practices: "tutorials/writing_commits.md" + - Managing tags formats: "tutorials/tag_format.md" + - Auto check commits: "tutorials/auto_check.md" + - Auto prepare commit message: "tutorials/auto_prepare_commit_message.md" + - GitLab CI: "tutorials/gitlab_ci.md" + - GitHub Actions: "tutorials/github_actions.md" + - Jenkins pipeline: "tutorials/jenkins_pipeline.md" + - Developmental releases: "tutorials/dev_releases.md" + - Monorepo support: "tutorials/monorepo_guidance.md" + - FAQ: "faq.md" + - "features_wont_add.md" + - Exit Codes: "exit_codes.md" + - Third-Party Commitizen Plugins: + - About: "third-party-plugins/about.md" + # Please sort the plugins alphabetically + - "third-party-plugins/commitizen-deno-provider.md" + - "third-party-plugins/commitizen-emoji.md" + - "third-party-plugins/conventional-jira.md" + - "third-party-plugins/cz-ai.md" + - "third-party-plugins/cz-conventional-gitmoji.md" + - "third-party-plugins/cz-emoji.md" + - "third-party-plugins/cz-legacy.md" + - "third-party-plugins/cz-path.md" + - "third-party-plugins/github-jira-conventional.md" + - Contributing: + - "contributing/contributing_tldr.md" + - "contributing/contributing.md" + - "contributing/pull_request.md" + - "history.md" + - Resources: "external_links.md" markdown_extensions: - markdown.extensions.codehilite: guess_lang: false - admonition - codehilite - - extra \ No newline at end of file + - extra + - pymdownx.highlight + - pymdownx.superfences + - toc: + permalink: true + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + +plugins: + - search + - git-revision-date-localized diff --git a/pyproject.toml b/pyproject.toml index 1b068f3156..64f7d7c914 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,73 +1,321 @@ -[tool.commitizen] -version = "1.8.0" -tag_format = "v$version" -files = [ - "pyproject.toml:version", - "commitizen/__version__.py" -] - -[tool.black] -line-length = 88 -include = '\.pyi?$' -exclude = ''' -/( - \.git - | \.hg - | \.mypy_cache - | \.tox - | \.venv - | _build - | buck-out - | build - | dist - # The following are specific to Black, you probably don't want those. - | blib2to3 - | tests/data - | profiling -)/ -''' - -[tool.poetry] +[project] name = "commitizen" -version = "1.8.0" +version = "4.13.9" description = "Python commitizen client tool" -authors = ["Santiago Fraire <santiwilly@gmail.com>"] -license = "MIT" +authors = [{ name = "Santiago Fraire", email = "santiwilly@gmail.com" }] +maintainers = [ + { name = "Wei Lee", email = "weilee.rx@gmail.com" }, + { name = "Axel H.", email = "noirbizarre@gmail.com" }, + { name = "Tim Hsiung", email = "bear890707@gmail.com" }, +] +license = { file = "LICENSE" } +readme = "docs/README.md" +requires-python = ">=3.10,<4.0" +dependencies = [ + "questionary (>=2.0,<3.0)", + # Exclude transitive dependency due to known issue in questionary: https://github.com/tmbo/questionary/issues/454 + "prompt_toolkit!=3.0.52", + "decli (>=0.6.0,<1.0)", + "colorama (>=0.4.1,<1.0)", + "termcolor (>=1.1.0,<4.0.0)", + "packaging>=19", + "tomlkit (>=0.8.0,<1.0.0)", + "jinja2>=2.10.3", + "pyyaml>=3.08", + "argcomplete >=1.12.1,<3.7", + "typing-extensions (>=4.0.1,<5.0.0) ; python_version < '3.11'", + "charset-normalizer (>=2.1.0,<4)", + "deprecated (>=1.2.13, <2)", + # Use the Python 3.11 and 3.12 compatible API: https://github.com/python/importlib_metadata#compatibility + "importlib-metadata >=8.0.0,<8.7.0 ; python_version < '3.10'", +] keywords = ["commitizen", "conventional", "commits", "git"] -readme = "README.rst" -homepage = "https://github.com/woile/commitizen" +# See also: https://pypi.org/classifiers/ classifiers = [ - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Intended Audience :: Developers", + "Natural Language :: English", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", "Programming Language :: Python :: Implementation :: CPython", + "License :: OSI Approved :: MIT License", ] -[tool.poetry.dependencies] -python = "^3.6" -questionary = "^1.4.0" -decli = "^0.5.0" -colorama = "^0.4.1" -termcolor = "^1.1" -packaging = "^19.0" -tomlkit = "^0.5.3" - -[tool.poetry.dev-dependencies] -ipython = "^7.2" -black = "^19.3b0" -pytest = "^5.0" -flake8 = "^3.6" -pytest-cov = "^2.6" -pytest-mock = "^1.10" -codecov = "^2.0" -mypy = "^0.740" -mkdocs = "^1.0" -mkdocs-material = "^4.1" -isort = "^4.3.21" - -[tool.poetry.scripts] +[project.urls] +Homepage = "https://github.com/commitizen-tools/commitizen" +Documentation = "https://commitizen-tools.github.io/commitizen/" +Repository = "https://github.com/commitizen-tools/commitizen" +Issues = "https://github.com/commitizen-tools/commitizen/issues" +Changelog = "https://github.com/commitizen-tools/commitizen/blob/master/CHANGELOG.md" + +[project.scripts] cz = "commitizen.cli:main" +git-cz = "commitizen.cli:main" + +[project.entry-points."commitizen.plugin"] +cz_conventional_commits = "commitizen.cz.conventional_commits:ConventionalCommitsCz" +cz_jira = "commitizen.cz.jira:JiraSmartCz" +cz_customize = "commitizen.cz.customize:CustomizeCommitsCz" + +[project.entry-points."commitizen.changelog_format"] +markdown = "commitizen.changelog_formats.markdown:Markdown" +asciidoc = "commitizen.changelog_formats.asciidoc:AsciiDoc" +textile = "commitizen.changelog_formats.textile:Textile" +restructuredtext = "commitizen.changelog_formats.restructuredtext:RestructuredText" + +[project.entry-points."commitizen.provider"] +cargo = "commitizen.providers:CargoProvider" +commitizen = "commitizen.providers:CommitizenProvider" +composer = "commitizen.providers:ComposerProvider" +npm = "commitizen.providers:NpmProvider" +pep621 = "commitizen.providers:Pep621Provider" +poetry = "commitizen.providers:PoetryProvider" +scm = "commitizen.providers:ScmProvider" +uv = "commitizen.providers:UvProvider" + +[project.entry-points."commitizen.scheme"] +pep440 = "commitizen.version_schemes:Pep440" +semver = "commitizen.version_schemes:SemVer" +semver2 = "commitizen.version_schemes:SemVer2" + +[dependency-groups] +dev = [ + { include-group = "base" }, + { include-group = "test" }, + { include-group = "linters" }, + { include-group = "documentation" }, + { include-group = "script" }, + "ipython>=8.0", + "tox>4", + "tox-uv", +] + +base = ["poethepoet>=0.34.0"] + +test = [ + "pytest>=9", + "pytest-cov>=4", + "pytest-mock>=3.10", + "pytest-regressions>=2.4.0", + "pytest-freezer>=0.4.6", + "pytest-xdist>=3.1.0", + "pytest-gitconfig>=0.9.0", + "pre-commit>=4.5.1", +] + +linters = [ + "ruff>=0.11.5", + "mypy>=1.16.0", + "types-deprecated>=1.2.9.2", + "types-python-dateutil>=2.8.19.13", + "types-PyYAML>=5.4.3", + "types-termcolor>=0.1.1", + "types-colorama>=0.4.15.20240311", + "prek>=0.2.28", +] + +documentation = [ + "mkdocs>=1.4.2", + "mkdocs-git-revision-date-localized-plugin>=1.5.0", + "mkdocs-material>=9.1.6", +] + +script = [ + # for scripts/gen_cli_help_screenshots.py + "rich>=13.7.1", +] [build-system] -requires = ["poetry>=0.12"] -build-backend = "poetry.masonry.api" +requires = ["uv_build >= 0.9.17, <0.10.0"] +build-backend = "uv_build" + + +[tool.commitizen] +tag_format = "v$version" +version_files = [ + "commitizen/__version__.py", + ".pre-commit-config.yaml:rev:.+Commitizen", +] +version_provider = "uv" +version_scheme = "pep440" + + +[tool.uv.build-backend] +module-name = "commitizen" +module-root = "" +include = ["commitizen/py.typed"] + +[tool.coverage] +[tool.coverage.report] +show_missing = true +exclude_lines = [ + # Have to re-enable the standard pragma + 'pragma: no cover', + + # Don't complain about missing debug-only code: + 'def __repr__', + 'if self\.debug', + + # Don't complain if tests don't hit defensive assertion code: + 'raise AssertionError', + 'raise NotImplementedError', + + # Don't complain if non-runnable code isn't run: + 'if 0:', + 'if __name__ == .__main__.:', + 'if TYPE_CHECKING:', +] +omit = [ + 'env/*', + 'venv/*', + '.venv/*', + '*/virtualenv/*', + '*/virtualenvs/*', + '*/tests/*', +] + + +[tool.pytest] +addopts = ["--strict-markers"] +testpaths = ["tests/"] +filterwarnings = [ + # get_smart_tag_range is deprecated and will be removed in v5 + "ignore:Call to deprecated function \\(or staticmethod\\) get_smart_tag_range:DeprecationWarning", +] + +[tool.tox] +requires = ["tox>=4.22"] +env_list = ["3.10", "3.11", "3.12", "3.13", "3.14"] + +[tool.tox.env_run_base] +description = "Run tests suite against Python {base_python}" +dependency_groups = ["test"] +commands = [["pytest", { replace = "posargs", extend = true }]] + +[tool.ruff] +required-version = ">=0.11.5" +line-length = 88 + +[tool.ruff.lint] +select = [ + # flake8-annotations + "ANN001", + "ANN2", + # pycodestyle + "E", + # Pyflakes + "F", + # pyupgrade + "UP", + # isort + "I", + # pygrep-hooks + "PGH003", + "PGH004", + # unsorted-dunder-all + "RUF022", + # unused-noqa + "RUF100", + # flake8-pytest-style + "PT", + # Checks for uses of the assert keyword. + "S101", + # flake8-type-checking (TC) + "TC001", + "TC002", + "TC003", + "TC004", + "TC005", + "TC006", +] +ignore = ["E501", "D1", "D415"] +extend-safe-fixes = [ + "TC", # Move imports inside/outside TYPE_CHECKING blocks + "UP", # Update syntaxes for current Python version recommendations + "PT006", # Use tuple in pytest.mark.parametrize +] + +[tool.ruff.lint.per-file-ignores] +"tests/*" = ["ANN", "S101"] + +[tool.ruff.lint.isort] +known-first-party = ["commitizen", "tests"] + +[tool.ruff.lint.pydocstyle] +convention = "google" + +[tool.mypy] +files = ["commitizen", "tests", "scripts"] +disallow_untyped_decorators = true +disallow_subclassing_any = true +warn_return_any = true +warn_redundant_casts = true +warn_unused_ignores = true +warn_unused_configs = true + +[[tool.mypy.overrides]] +module = "py.*" # Legacy pytest dependencies +ignore_missing_imports = true + +[tool.codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = '.git*,*.svg,*.lock' +check-hidden = true +ignore-words-list = 'asend' + +[tool.poe] +executor.type = "uv" + +[tool.poe.tasks] +format.help = "Format the code" +format.sequence = [{ cmd = "ruff check --fix" }, { cmd = "ruff format" }] + +lint.help = "Lint the code" +lint.sequence = [{ cmd = "ruff check" }, { cmd = "mypy" }] + +check-commit.help = "Check the commit messages" +check-commit.cmd = "cz --no-raise 3 check --rev-range origin/master.." + +test.help = "Run the test suite" +test.cmd = "pytest -n auto --dist=loadfile" + +"test:all".help = "Run the test suite on all supported Python versions" +"test:all".cmd = "tox --parallel" + +"test:regen".help = "Regenerate the test fixtures" +"test:regen".parallel = [ + { ref = "test -k 'not py_' --regen-all" }, + { ref = "test:all -- -k py_ --regen-all" }, +] + +cover.help = "Run the test suite with coverage" +cover.ref = "test --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen --junitxml=junit.xml -o junit_family=legacy" + +all.help = "Run all tasks" +all.sequence = ["format", "lint", "check-commit", "cover"] + +"doc:screenshots".help = "Render documentation screenshots" +"doc:screenshots".parallel = [ + { script = "scripts.gen_cli_help_screenshots:gen_cli_help_screenshots" }, + { script = "scripts.gen_cli_interactive_gifs:gen_cli_interactive_gifs" }, +] + +"doc:build".help = "Build the documentation" +"doc:build".cmd = "mkdocs build" + +doc.help = "Live documentation server" +doc.cmd = "mkdocs serve --livereload" # mkdocs hot reload failure workaround. Ref: https://github.com/mkdocs/mkdocs/issues/4032#issuecomment-3591002290 + +ci.help = "Run all tasks in CI" +ci.sequence = ["check-commit", { cmd = "prek run --all-files" }, "cover"] +ci.env = { SKIP = "no-commit-to-branch" } + +setup-pre-commit.help = "Install pre-commit hooks" +setup-pre-commit.cmd = "prek install" diff --git a/scripts/deploy b/scripts/deploy deleted file mode 100755 index 52c914c71a..0000000000 --- a/scripts/deploy +++ /dev/null @@ -1,5 +0,0 @@ -# Publish to pypi -poetry publish --build - -# Publish docs -mkdocs gh-deploy diff --git a/scripts/gen_cli_help_screenshots.py b/scripts/gen_cli_help_screenshots.py new file mode 100644 index 0000000000..fce95eb9cd --- /dev/null +++ b/scripts/gen_cli_help_screenshots.py @@ -0,0 +1,41 @@ +import os +import subprocess +from itertools import chain +from pathlib import Path + +from rich.console import Console + +from commitizen.cli import data + + +def gen_cli_help_screenshots() -> None: + """Generate the screenshot for help message on each cli command and save them as svg files.""" + images_root = Path(__file__).parent.parent / "docs" / "images" / "cli_help" + images_root.mkdir(parents=True, exist_ok=True) + + cz_commands = ( + command["name"] if isinstance(command["name"], str) else command["name"][0] + for command in data["subcommands"]["commands"] # type: ignore[index] + ) + for cmd in chain( + ["cz --help"], (f"cz {cz_command} --help" for cz_command in cz_commands) + ): + file_name = f"{cmd.replace(' ', '_').replace('-', '_')}.svg" + _export_cmd_as_svg(cmd, images_root / file_name) + + +def _export_cmd_as_svg(cmd: str, file_path: Path) -> None: + console = Console(record=True, width=80, file=open(os.devnull, "w")) + + print("Processing command:", cmd) + + console.print(f"$ {cmd}") + stdout = subprocess.run(cmd, shell=True, capture_output=True).stdout.decode("utf-8") + console.print(stdout) + console.save_svg(file_path.as_posix(), title="") + + print("Saved to:", file_path.as_posix()) + + +if __name__ == "__main__": + gen_cli_help_screenshots() diff --git a/scripts/gen_cli_interactive_gifs.py b/scripts/gen_cli_interactive_gifs.py new file mode 100644 index 0000000000..d60c476059 --- /dev/null +++ b/scripts/gen_cli_interactive_gifs.py @@ -0,0 +1,39 @@ +import subprocess +from pathlib import Path + + +def gen_cli_interactive_gifs() -> None: + """Generate GIF screenshots for interactive commands using VHS.""" + vhs_dir = Path(__file__).parent.parent / "docs" / "images" + output_dir = Path(__file__).parent.parent / "docs" / "images" / "cli_interactive" + output_dir.mkdir(parents=True, exist_ok=True) + + vhs_files = list(vhs_dir.glob("*.tape")) + + if not vhs_files: + print("No VHS tape files found in docs/images/, skipping") + return + + for vhs_file in vhs_files: + print(f"Processing: {vhs_file.name}") + try: + subprocess.run( + ["vhs", vhs_file.name], + check=True, + cwd=vhs_dir, + ) + gif_name = vhs_file.stem + ".gif" + print(f"✓ Generated {gif_name}") + except FileNotFoundError: + print( + "✗ VHS is not installed. Please install it from: " + "https://github.com/charmbracelet/vhs" + ) + raise + except subprocess.CalledProcessError as e: + print(f"✗ Error processing {vhs_file.name}: {e}") + raise + + +if __name__ == "__main__": + gen_cli_interactive_gifs() diff --git a/scripts/lint b/scripts/lint deleted file mode 100755 index d737c8f476..0000000000 --- a/scripts/lint +++ /dev/null @@ -1,11 +0,0 @@ -#!/bin/sh -e - -export PREFIX="" -if [ -d 'venv' ] ; then - export PREFIX="venv/bin/" -fi - -set -x - -${PREFIX}isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width 88 --recursive --apply commitizen tests -${PREFIX}black commitizen tests diff --git a/scripts/test b/scripts/test deleted file mode 100755 index 2234ddc65c..0000000000 --- a/scripts/test +++ /dev/null @@ -1,8 +0,0 @@ -export PREFIX="poetry run python -m " -if [ -d 'venv' ] ; then - export PREFIX="venv/bin/" -fi - -${PREFIX}pytest --cov-report term-missing --cov-report=xml:coverage.xml --cov=commitizen tests/ -${PREFIX}black commitizen tests --check -${PREFIX}flake8 --max-line-length=88 commitizen/ tests/ diff --git a/tests/commands/conftest.py b/tests/commands/conftest.py new file mode 100644 index 0000000000..ad7e1bc766 --- /dev/null +++ b/tests/commands/conftest.py @@ -0,0 +1,50 @@ +from pathlib import Path + +import pytest +from pytest_mock import MockerFixture, MockType + +from commitizen.config.json_config import JsonConfig + + +@pytest.fixture +def config_customize() -> JsonConfig: + json_string = r"""{ + "commitizen": { + "name": "cz_customize", + "version": "3.0.0", + "changelog_incremental": "true", + "customize": { + "message_template": "{{prefix}}({{scope}}): {{subject}}\n\n{{body}}{% if is_breaking_change %}\nBREAKING CHANGE: {{footer}}{% endif %}", + "schema": "<type>(<scope>): <subject>\n<BLANK LINE>\n<body>\n<BLANK LINE>\n(BREAKING CHANGE: <footer>)", + "schema_pattern": "(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)(\\(\\S+\\))?!?:(\\s.*)", + "change_type_map": { + "feat": "Feat", + "fix": "Fix", + "refactor": "Refactor", + "perf": "Perf" + }, + "change_type_order": ["Refactor", "Feat"], + "commit_parser": "^(?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\\((?P<scope>[^()\\r\\n]*)\\)|\\()?(?P<breaking>!)?:\\s(?P<message>.*)?", + "changelog_pattern": "^(BREAKING[\\-\\ ]CHANGE|feat|fix|refactor|perf)(\\(.+\\))?(!)?", + "questions": [ + + ] + } + } + }""" + return JsonConfig(data=json_string, path=Path("not_exist.json")) + + +@pytest.fixture +def changelog_path() -> Path: + return Path("CHANGELOG.md") + + +@pytest.fixture +def config_path() -> Path: + return Path("pyproject.toml") + + +@pytest.fixture +def success_mock(mocker: MockerFixture) -> MockType: + return mocker.patch("commitizen.out.success") diff --git a/tests/commands/test_bump_command.py b/tests/commands/test_bump_command.py new file mode 100644 index 0000000000..bf78e339c7 --- /dev/null +++ b/tests/commands/test_bump_command.py @@ -0,0 +1,1539 @@ +from __future__ import annotations + +import inspect +import re +from textwrap import dedent +from typing import TYPE_CHECKING +from unittest.mock import call + +import pytest + +import commitizen.commands.bump as bump +from commitizen import cmd, defaults, git, hooks +from commitizen.config.base_config import BaseConfig +from commitizen.exceptions import ( + BumpTagFailedError, + CommitizenException, + CurrentVersionNotFoundError, + DryRunExit, + ExitCode, + ExpectedExit, + InvalidManualVersion, + NoCommitsFoundError, + NoneIncrementExit, + NoPatternMapError, + NotAGitProjectError, + NotAllowed, + NoVersionSpecifiedError, +) + +if TYPE_CHECKING: + from pathlib import Path + + from pytest_mock import MockFixture + from pytest_regressions.file_regression import FileRegressionFixture + + from commitizen.changelog_formats import ChangelogFormat + from commitizen.cz.base import BaseCommitizen + from tests.utils import UtilFixture + + +@pytest.mark.parametrize( + "commit_msg", + [ + "fix: username exception", + "fix(user): username exception", + "refactor: remove ini configuration support", + "refactor(config): remove ini configuration support", + "perf: update to use multiprocess", + "perf(worker): update to use multiprocess", + ], +) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_patch_increment(commit_msg: str, util: UtilFixture): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes") + assert git.tag_exist("0.1.1") is True + + +@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_minor_increment(commit_msg: str, util: UtilFixture): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + assert ( + "commit:refs/tags/0.2.0" + in cmd.run('git for-each-ref refs/tags --format "%(objecttype):%(refname)"').out + ) + + +@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_minor_increment_annotated(commit_msg: str, util: UtilFixture): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes", "--annotated-tag") + assert git.tag_exist("0.2.0") is True + assert ( + "tag:refs/tags/0.2.0" + in cmd.run('git for-each-ref refs/tags --format "%(objecttype):%(refname)"').out + ) + + assert git.is_signed_tag("0.2.0") is False + + +@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"]) +@pytest.mark.usefixtures("tmp_commitizen_project_with_gpg") +def test_bump_minor_increment_signed(commit_msg: str, util: UtilFixture): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes", "--gpg-sign") + assert git.tag_exist("0.2.0") is True + assert ( + "tag:refs/tags/0.2.0" + in cmd.run('git for-each-ref refs/tags --format "%(objecttype):%(refname)"').out + ) + + assert git.is_signed_tag("0.2.0") is True + + +@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"]) +def test_bump_minor_increment_annotated_config_file( + commit_msg: str, util: UtilFixture, pyproject: Path +): + with pyproject.open("a", encoding="utf-8") as f: + f.write("\nannotated_tag = 1") + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + assert ( + "tag:refs/tags/0.2.0" + in cmd.run('git for-each-ref refs/tags --format "%(objecttype):%(refname)"').out + ) + + assert git.is_signed_tag("0.2.0") is False + + +@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"]) +def test_bump_minor_increment_signed_config_file( + commit_msg: str, util: UtilFixture, tmp_commitizen_project_with_gpg +): + tmp_commitizen_cfg_file = tmp_commitizen_project_with_gpg / "pyproject.toml" + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write("\ngpg_sign = 1") + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + assert ( + "tag:refs/tags/0.2.0" + in cmd.run('git for-each-ref refs/tags --format "%(objecttype):%(refname)"').out + ) + + assert git.is_signed_tag("0.2.0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize( + "commit_msg", + [ + "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat!: new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat!: new user interface", + "feat(user): new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat(user)!: new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat(user)!: new user interface", + "BREAKING CHANGE: age is no longer supported", + "BREAKING-CHANGE: age is no longer supported", + ], +) +def test_bump_major_increment(commit_msg: str, util: UtilFixture): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes") + assert git.tag_exist("1.0.0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize( + "commit_msg", + [ + "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat!: new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat!: new user interface", + "feat(user): new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat(user)!: new user interface\n\nBREAKING CHANGE: age is no longer supported", + "feat(user)!: new user interface", + "BREAKING CHANGE: age is no longer supported", + "BREAKING-CHANGE: age is no longer supported", + ], +) +def test_bump_major_increment_major_version_zero(commit_msg: str, util: UtilFixture): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes", "--major-version-zero") + assert git.tag_exist("0.2.0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize( + ("commit_msg", "increment", "expected_tag"), + [ + ("feat: new file", "PATCH", "0.1.1"), + ("fix: username exception", "major", "1.0.0"), + ("refactor: remove ini configuration support", "patch", "0.1.1"), + ("BREAKING CHANGE: age is no longer supported", "minor", "0.2.0"), + ], +) +def test_bump_command_increment_option( + commit_msg: str, increment: str, expected_tag: str, util: UtilFixture +): + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--increment", increment, "--yes") + assert git.tag_exist(expected_tag) is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_command_prerelease(util: UtilFixture): + util.create_file_and_commit("feat: location") + + # Create an alpha pre-release. + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0a0") is True + + # Create a beta pre-release. + util.run_cli("bump", "--prerelease", "beta", "--yes") + assert git.tag_exist("0.2.0b0") is True + + # With a current beta pre-release, bumping alpha must bump beta + # because we can't bump "backwards". + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0a1") is False + assert git.tag_exist("0.2.0b1") is True + + # Create a rc pre-release. + util.run_cli("bump", "--prerelease", "rc", "--yes") + assert git.tag_exist("0.2.0rc0") is True + + # With a current rc pre-release, bumping alpha must bump rc. + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0a1") is False + assert git.tag_exist("0.2.0b2") is False + assert git.tag_exist("0.2.0rc1") is True + + # With a current rc pre-release, bumping beta must bump rc. + util.run_cli("bump", "--prerelease", "beta", "--yes") + assert git.tag_exist("0.2.0a2") is False + assert git.tag_exist("0.2.0b2") is False + assert git.tag_exist("0.2.0rc2") is True + + # Create a final release from the current pre-release. + util.run_cli("bump") + assert git.tag_exist("0.2.0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_command_prerelease_increment(util: UtilFixture): + # FINAL RELEASE + util.create_file_and_commit("fix: location") + util.run_cli("bump", "--yes") + assert git.tag_exist("0.1.1") is True + + # PRERELEASE + util.create_file_and_commit("fix: location") + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.1.2a0") is True + + util.create_file_and_commit("feat: location") + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0a0") is True + + util.create_file_and_commit("feat!: breaking") + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("1.0.0a0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_command_prerelease_exact_mode(util: UtilFixture): + # PRERELEASE + util.create_file_and_commit("feat: location") + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0a0") is True + + # PRERELEASE + PATCH BUMP + util.run_cli("bump", "--prerelease", "alpha", "--yes", "--increment-mode=exact") + assert git.tag_exist("0.2.0a1") is True + + # PRERELEASE + MINOR BUMP + # --increment-mode allows the minor version to bump, and restart the prerelease + util.create_file_and_commit("feat: location") + util.run_cli("bump", "--prerelease", "alpha", "--yes", "--increment-mode=exact") + assert git.tag_exist("0.3.0a0") is True + + # PRERELEASE + MAJOR BUMP + # --increment-mode=exact allows the major version to bump, and restart the prerelease + util.run_cli( + "bump", + "--prerelease", + "alpha", + "--yes", + "--increment=MAJOR", + "--increment-mode=exact", + ) + + assert git.tag_exist("1.0.0a0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_on_git_with_hooks_no_verify_disabled(util: UtilFixture): + """Bump commit without --no-verify""" + cmd.run("mkdir .git/hooks") + with open(".git/hooks/pre-commit", "w", encoding="utf-8") as f: + f.write('#!/usr/bin/env bash\necho "0.1.0"') + cmd.run("chmod +x .git/hooks/pre-commit") + + # MINOR + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_tag_exists_raises_exception(util: UtilFixture): + cmd.run("mkdir .git/hooks") + with open(".git/hooks/post-commit", "w", encoding="utf-8") as f: + f.write("#!/usr/bin/env bash\nexit 9") + cmd.run("chmod +x .git/hooks/post-commit") + + # MINOR + util.create_file_and_commit("feat: new file") + git.tag("0.2.0") + + with pytest.raises(BumpTagFailedError) as excinfo: + util.run_cli("bump", "--yes") + assert "0.2.0" in str(excinfo.value) # This should be a fatal error + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_on_git_with_hooks_no_verify_enabled(util: UtilFixture): + cmd.run("mkdir .git/hooks") + with open(".git/hooks/pre-commit", "w", encoding="utf-8") as f: + f.write('#!/usr/bin/env bash\necho "0.1.0"') + cmd.run("chmod +x .git/hooks/pre-commit") + + # MINOR + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes", "--no-verify") + assert git.tag_exist("0.2.0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_when_bumping_is_not_support(util: UtilFixture): + util.create_file_and_commit( + "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported" + ) + + with pytest.raises(NoPatternMapError) as excinfo: + util.run_cli("-n", "cz_jira", "bump", "--yes") + assert "'cz_jira' rule does not support bump" in str(excinfo.value) + + +@pytest.mark.usefixtures("tmp_git_project") +def test_bump_when_version_is_not_specify(util: UtilFixture): + with pytest.raises(NoVersionSpecifiedError) as excinfo: + util.run_cli("bump") + + assert NoVersionSpecifiedError.message in str(excinfo.value) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_when_no_new_commit(util: UtilFixture): + """bump without any commits since the last bump.""" + # We need this first commit otherwise the revision is invalid. + util.create_file_and_commit("feat: initial") + + util.run_cli("bump", "--yes") + + # bump without a new commit. + with pytest.raises(NoCommitsFoundError) as excinfo: + util.run_cli("bump", "--yes") + + assert "[NO_COMMITS_FOUND]\nNo new commits found." in str(excinfo.value) + + +def test_bump_when_version_inconsistent_in_version_files( + tmp_commitizen_project, util: UtilFixture +): + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_version_file.write_text("100.999.10000") + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + tmp_version_file_string = str(tmp_version_file).replace("\\", "/") + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write(f'\nversion_files = ["{tmp_version_file_string}"]') + + util.create_file_and_commit("feat: new file") + + with pytest.raises(CurrentVersionNotFoundError) as excinfo: + util.run_cli("bump", "--yes", "--check-consistency") + + assert "Current version 0.1.0 is not found in" in str(excinfo.value) + + +def test_bump_major_version_zero_when_major_is_not_zero( + tmp_commitizen_project, util: UtilFixture +): + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_version_file.write_text("1.0.0") + tmp_version_file_string = str(tmp_version_file).replace("\\", "/") + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + tmp_commitizen_cfg_file.write_text( + f"[tool.commitizen]\n" + 'version="1.0.0"\n' + f'version_files = ["{str(tmp_version_file_string)}"]' + ) + tmp_changelog_file = tmp_commitizen_project / "CHANGELOG.md" + tmp_changelog_file.write_text("## v1.0.0") + + util.create_file_and_commit("feat(user): new file") + util.create_tag("v1.0.0") + util.create_file_and_commit("feat(user)!: new file") + + with pytest.raises(NotAllowed) as excinfo: + util.run_cli("bump", "--yes", "--major-version-zero") + + assert "--major-version-zero is meaningless for current version 1.0.0" in str( + excinfo.value + ) + + +def test_bump_files_only(tmp_commitizen_project, util: UtilFixture): + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_version_file.write_text("0.1.0") + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + tmp_version_file_string = str(tmp_version_file).replace("\\", "/") + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write(f'\nversion_files = ["{tmp_version_file_string}"]') + + util.create_file_and_commit("feat: new user interface") + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + + util.create_file_and_commit("feat: another new feature") + with pytest.raises(ExpectedExit): + util.run_cli("bump", "--yes", "--version-files-only") + + assert git.tag_exist("0.3.0") is False + + assert "0.3.0" in tmp_version_file.read_text(encoding="utf-8") + + assert "0.3.0" in tmp_commitizen_cfg_file.read_text(encoding="utf-8") + + +def test_bump_local_version(tmp_commitizen_project, util: UtilFixture): + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_version_file.write_text("4.5.1+0.1.0") + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + tmp_version_file_string = str(tmp_version_file).replace("\\", "/") + tmp_commitizen_cfg_file.write_text( + f"[tool.commitizen]\n" + 'version="4.5.1+0.1.0"\n' + f'version_files = ["{tmp_version_file_string}"]' + ) + + util.create_file_and_commit("feat: new user interface") + util.run_cli("bump", "--yes", "--local-version") + assert git.tag_exist("4.5.1+0.2.0") is True + + assert "4.5.1+0.2.0" in tmp_version_file.read_text(encoding="utf-8") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_dry_run(util: UtilFixture, capsys: pytest.CaptureFixture): + util.create_file_and_commit("feat: new file") + + with pytest.raises(DryRunExit): + util.run_cli("bump", "--yes", "--dry-run") + + out, _ = capsys.readouterr() + assert "0.2.0" in out + assert git.tag_exist("0.2.0") is False + + +def test_bump_in_non_git_project(tmp_path, monkeypatch, util: UtilFixture): + monkeypatch.chdir(tmp_path) + with pytest.raises(NotAGitProjectError): + util.run_cli("bump", "--yes") + + +def test_none_increment_exit_should_be_a_class(): + assert inspect.isclass(NoneIncrementExit) + + +def test_none_increment_exit_should_be_expected_exit_subclass(): + assert issubclass(NoneIncrementExit, CommitizenException) + + +def test_none_increment_exit_should_exist_in_bump(): + assert hasattr(bump, "NoneIncrementExit") + + +def test_none_increment_exit_is_exception(): + assert bump.NoneIncrementExit == NoneIncrementExit + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_none_increment_should_not_call_git_tag_and_error_code_is_not_zero( + mocker: MockFixture, + util: UtilFixture, +): + util.create_file_and_commit("test(test_get_all_droplets): fix bad comparison test") + git_tag_mock = mocker.patch("commitizen.git.tag") + + with pytest.raises(NoneIncrementExit) as e: + util.run_cli("bump", "--yes") + + git_tag_mock.assert_not_called() + assert e.value.exit_code == ExitCode.NO_INCREMENT + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_with_changelog_arg(util: UtilFixture, changelog_path): + util.create_file_and_commit("feat(user): new file") + util.run_cli("bump", "--yes", "--changelog") + assert git.tag_exist("0.2.0") is True + + out = changelog_path.read_text(encoding="utf-8") + assert out.startswith("#") + assert "0.2.0" in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_with_changelog_config(util: UtilFixture, changelog_path, config_path): + util.create_file_and_commit("feat(user): new file") + with config_path.open("a", encoding="utf-8") as fp: + fp.write("update_changelog_on_bump = true\n") + + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + + out = changelog_path.read_text(encoding="utf-8") + assert out.startswith("#") + assert "0.2.0" in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_prevent_prerelease_when_no_increment_detected( + util: UtilFixture, capsys: pytest.CaptureFixture +): + util.create_file_and_commit("feat: new file") + + util.run_cli("bump", "--yes") + out, _ = capsys.readouterr() + + assert "0.2.0" in out + + util.create_file_and_commit("test: new file") + + with pytest.raises(NoCommitsFoundError) as excinfo: + util.run_cli("bump", "-pr", "beta") + + assert "[NO_COMMITS_FOUND]\nNo commits found to generate a pre-release." in str( + excinfo.value + ) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_with_changelog_to_stdout_arg( + util: UtilFixture, capsys: pytest.CaptureFixture, changelog_path: Path +): + util.create_file_and_commit("feat(user): this should appear in stdout") + util.run_cli("bump", "--yes", "--changelog-to-stdout") + out, _ = capsys.readouterr() + + assert "this should appear in stdout" in out + assert git.tag_exist("0.2.0") is True + + out = changelog_path.read_text(encoding="utf-8") + assert out.startswith("#") + assert "0.2.0" in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_with_changelog_to_stdout_dry_run_arg( + util: UtilFixture, capsys: pytest.CaptureFixture, changelog_path: Path +): + util.create_file_and_commit( + "feat(user): this should appear in stdout with dry-run enabled" + ) + with pytest.raises(DryRunExit): + util.run_cli("bump", "--yes", "--changelog-to-stdout", "--dry-run") + out, _ = capsys.readouterr() + + assert git.tag_exist("0.2.0") is False + assert out.startswith("#") + assert "this should appear in stdout with dry-run enabled" in out + assert "0.2.0" in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_without_git_to_stdout_arg( + util: UtilFixture, capsys: pytest.CaptureFixture +): + util.create_file_and_commit("feat(user): this should appear in stdout") + util.run_cli("bump", "--yes") + out, _ = capsys.readouterr() + + assert ( + re.search(r"^\[master \w+] bump: version 0.1.0 → 0.2.0", out, re.MULTILINE) + is not None + ) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_with_git_to_stdout_arg(util: UtilFixture, capsys: pytest.CaptureFixture): + util.create_file_and_commit("feat(user): this should appear in stdout") + util.run_cli("bump", "--yes", "--git-output-to-stderr") + out, _ = capsys.readouterr() + + assert ( + re.search(r"^\[master \w+] bump: version 0.1.0 → 0.2.0", out, re.MULTILINE) + is None + ) + + +@pytest.mark.parametrize( + ("version_filepath", "version_regex", "version_file_content"), + [ + pytest.param( + "pyproject.toml", + "pyproject.toml:^version", + """ +[tool.poetry] +name = "my_package" +version = "0.1.0" +""", + id="version in pyproject.toml with regex", + ), + pytest.param( + "pyproject.toml", + "pyproject.toml", + """ +[tool.poetry] +name = "my_package" +version = "0.1.0" +""", + id="version in pyproject.toml without regex", + ), + pytest.param( + "__init__.py", + "__init__.py:^__version__", + """ +'''This is a test file.''' +__version__ = "0.1.0" +""", + id="version in __init__.py with regex", + ), + pytest.param( + "pyproject.toml", + "*.toml:^version", + """ +[tool.poetry] +name = "my_package" +version = "0.1.0" +""", + id="version in pyproject.toml with glob and regex", + ), + ], +) +@pytest.mark.parametrize( + "cli_bump_changelog_args", + [ + ("bump", "--changelog", "--yes"), + ( + "bump", + "--changelog", + "--changelog-to-stdout", + "--annotated-tag", + "--check-consistency", + "--yes", + ), + ], + ids=lambda cmd_tuple: " ".join(["cz", *cmd_tuple]) + if isinstance(cmd_tuple, tuple) + else cmd_tuple, +) +def test_bump_changelog_command_commits_untracked_changelog_and_version_files( + tmp_commitizen_project, + util: UtilFixture, + cli_bump_changelog_args: tuple[str, ...], + version_filepath: str, + version_regex: str, + version_file_content: str, +): + """Ensure that changelog always gets committed, no matter what version file or cli options get passed. + + Steps: + - Append the version file's name and regex commitizen configuration lines to `pyproject.toml`. + - Append to or create the version file. + - Add a commit of type fix to be eligible for a version bump. + - Call commitizen main cli and assert that the `CHANGELOG.md` and the version file were committed. + """ + + with (tmp_commitizen_project / "pyproject.toml").open( + mode="a", + encoding="utf-8", + ) as commitizen_config: + commitizen_config.write(f"version_files = [\n'{version_regex}'\n]") + + with (tmp_commitizen_project / version_filepath).open( + mode="a+", encoding="utf-8" + ) as version_file: + version_file.write(version_file_content) + + util.create_file_and_commit("fix: some test commit") + + util.run_cli(*cli_bump_changelog_args) + + commit_file_names = git.get_filenames_in_commit() + assert "CHANGELOG.md" in commit_file_names + assert version_filepath in commit_file_names + + +@pytest.mark.parametrize( + "testargs", + [ + ["--local-version", "1.2.3"], + ["--prerelease", "rc", "1.2.3"], + ["--devrelease", "0", "1.2.3"], + ["--devrelease", "1", "1.2.3"], + ["--increment", "PATCH", "1.2.3"], + ["--build-metadata=a.b.c", "1.2.3"], + ["--local-version", "--build-metadata=a.b.c"], + ], +) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_invalid_manual_args_raises_exception(util: UtilFixture, testargs): + with pytest.raises(NotAllowed): + util.run_cli("bump", *testargs) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize( + "manual_version", + [ + "noversion", + "1.2..3", + ], +) +def test_bump_invalid_manual_version_raises_exception( + util: UtilFixture, manual_version +): + util.create_file_and_commit("feat: new file") + + with pytest.raises(InvalidManualVersion) as excinfo: + util.run_cli("bump", "--yes", manual_version) + + assert ( + f"[INVALID_MANUAL_VERSION]\nInvalid manual version: '{manual_version}'" + in str(excinfo.value) + ) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize( + "manual_version", + [ + "0.0.1", + "0.1.0rc2", + "0.1.0.dev2", + "0.1.0+1.0.0", + "0.1.0rc2.dev2+1.0.0", + "0.1.1", + "0.2.0", + "1.0.0", + "1.2", + "1", + ], +) +def test_bump_manual_version(util: UtilFixture, manual_version): + util.create_file_and_commit("feat: new file") + + util.run_cli("bump", "--yes", manual_version) + assert git.tag_exist(manual_version) is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_manual_version_disallows_major_version_zero(util: UtilFixture): + util.create_file_and_commit("feat: new file") + with pytest.raises(NotAllowed) as excinfo: + util.run_cli("bump", "--yes", "--major-version-zero", "0.2.0") + + assert "--major-version-zero cannot be combined with MANUAL_VERSION" in str( + excinfo.value + ) + + +@pytest.mark.parametrize( + ("initial_version", "expected_version_after_bump"), + [ + ("1", "1.1.0"), + ("1.2", "1.3.0"), + ], +) +def test_bump_version_with_less_components_in_config( + tmp_commitizen_project_initial, + initial_version, + expected_version_after_bump, + util: UtilFixture, +): + tmp_commitizen_project = tmp_commitizen_project_initial(version=initial_version) + util.run_cli("bump", "--yes") + + assert git.tag_exist(expected_version_after_bump) is True + + for version_file in [ + tmp_commitizen_project / "__version__.py", + tmp_commitizen_project / "pyproject.toml", + ]: + assert expected_version_after_bump in version_file.read_text(encoding="utf-8") + + +@pytest.mark.parametrize("commit_msg", ["feat: new file", "feat(user): new file"]) +def test_bump_with_pre_bump_hooks( + commit_msg, mocker: MockFixture, tmp_commitizen_project, util: UtilFixture +): + pre_bump_hook = "scripts/pre_bump_hook.sh" + post_bump_hook = "scripts/post_bump_hook.sh" + + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write( + f'\npre_bump_hooks = ["{pre_bump_hook}"]\n' + f'post_bump_hooks = ["{post_bump_hook}"]\n' + ) + + run_mock = mocker.Mock() + mocker.patch.object(hooks, "run", run_mock) + + util.create_file_and_commit(commit_msg) + util.run_cli("bump", "--yes") + + assert git.tag_exist("0.2.0") is True + + run_mock.assert_has_calls( + [ + call( + [pre_bump_hook], + _env_prefix="CZ_PRE_", + is_initial=True, + current_version="0.1.0", + current_tag_version="0.1.0", + new_version="0.2.0", + new_tag_version="0.2.0", + message="bump: version 0.1.0 → 0.2.0", + increment="MINOR", + changelog_file_name=None, + ), + call( + [post_bump_hook], + _env_prefix="CZ_POST_", + was_initial=True, + previous_version="0.1.0", + previous_tag_version="0.1.0", + current_version="0.2.0", + current_tag_version="0.2.0", + message="bump: version 0.1.0 → 0.2.0", + increment="MINOR", + changelog_file_name=None, + ), + ] + ) + + +def test_bump_with_hooks_and_increment( + mocker: MockFixture, tmp_commitizen_project, util: UtilFixture +): + pre_bump_hook = "scripts/pre_bump_hook.sh" + post_bump_hook = "scripts/post_bump_hook.sh" + + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write( + f'\npre_bump_hooks = ["{pre_bump_hook}"]\n' + f'post_bump_hooks = ["{post_bump_hook}"]\n' + ) + + run_mock = mocker.Mock() + mocker.patch.object(hooks, "run", run_mock) + + util.create_file_and_commit("test: some test") + util.run_cli("bump", "--yes", "--increment", "MINOR") + + assert git.tag_exist("0.2.0") is True + + +@pytest.mark.usefixtures("tmp_git_project") +def test_bump_use_version_provider(mocker: MockFixture, util: UtilFixture): + mock = mocker.MagicMock(name="provider") + mock.get_version.return_value = "0.0.0" + get_provider = mocker.patch( + "commitizen.commands.bump.get_provider", return_value=mock + ) + + util.create_file_and_commit("fix: fake commit") + util.run_cli("bump", "--yes", "--changelog") + + assert git.tag_exist("0.0.1") is True + get_provider.assert_called_once() + mock.get_version.assert_called_once() + mock.set_version.assert_called_once_with("0.0.1") + + +def test_bump_command_prerelease_scheme_via_cli( + tmp_commitizen_project_initial, util: UtilFixture +): + tmp_commitizen_project = tmp_commitizen_project_initial() + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + + util.run_cli( + "bump", + "--prerelease", + "alpha", + "--yes", + "--version-scheme", + "semver", + ) + assert git.tag_exist("0.2.0-a0") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0-a0" in version_file.read_text(encoding="utf-8") + + # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0" in version_file.read_text(encoding="utf-8") + + +def test_bump_command_prerelease_scheme_via_config( + tmp_commitizen_project_initial, util: UtilFixture +): + tmp_commitizen_project = tmp_commitizen_project_initial( + config_extra='version_scheme = "semver"\n', + ) + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0-a0") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0-a0" in version_file.read_text(encoding="utf-8") + + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("0.2.0-a1") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0-a1" in version_file.read_text(encoding="utf-8") + + # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE + util.run_cli("bump", "--yes") + assert git.tag_exist("0.2.0") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0" in version_file.read_text(encoding="utf-8") + + +def test_bump_command_prerelease_scheme_check_old_tags( + tmp_commitizen_project_initial, util: UtilFixture +): + tmp_commitizen_project = tmp_commitizen_project_initial( + config_extra=('tag_format = "v$version"\nversion_scheme = "semver"\n'), + ) + tmp_version_file = tmp_commitizen_project / "__version__.py" + tmp_commitizen_cfg_file = tmp_commitizen_project / "pyproject.toml" + + util.run_cli("bump", "--prerelease", "alpha", "--yes") + assert git.tag_exist("v0.2.0-a0") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0-a0" in version_file.read_text(encoding="utf-8") + + util.run_cli("bump", "--prerelease", "alpha") + assert git.tag_exist("v0.2.0-a1") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0-a1" in version_file.read_text(encoding="utf-8") + + # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE + util.run_cli("bump") + assert git.tag_exist("v0.2.0") is True + + for version_file in [tmp_version_file, tmp_commitizen_cfg_file]: + assert "0.2.0" in version_file.read_text(encoding="utf-8") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.usefixtures("use_cz_semver") +@pytest.mark.parametrize( + ("message", "expected_tag"), + [ + ("minor: add users", "0.2.0"), + ("patch: bug affecting users", "0.1.1"), + ("major: bug affecting users", "1.0.0"), + ], +) +def test_bump_with_plugin(util: UtilFixture, message: str, expected_tag: str): + util.create_file_and_commit(message) + util.run_cli("--name", "cz_semver", "bump", "--yes") + assert git.tag_exist(expected_tag) is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.usefixtures("use_cz_semver") +@pytest.mark.parametrize( + ("message", "expected_tag"), + [ + ("minor: add users", "0.2.0"), + ("patch: bug affecting users", "0.1.1"), + ("major: bug affecting users", "0.2.0"), + ], +) +def test_bump_with_major_version_zero_with_plugin( + util: UtilFixture, message: str, expected_tag: str +): + util.create_file_and_commit(message) + util.run_cli("--name", "cz_semver", "bump", "--yes", "--major-version-zero") + assert git.tag_exist(expected_tag) is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_command_version_type_deprecation(util: UtilFixture): + util.create_file_and_commit("feat: check deprecation on --version-type") + + with pytest.warns(DeprecationWarning, match=r".*--version-type.*deprecated"): + util.run_cli( + "bump", + "--prerelease", + "alpha", + "--yes", + "--version-type", + "semver", + ) + + assert git.tag_exist("0.2.0-a0") is True + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_command_version_scheme_priority_over_version_type(util: UtilFixture): + util.create_file_and_commit("feat: check deprecation on --version-type") + + with pytest.warns(DeprecationWarning, match=r".*--version-type.*deprecated"): + util.run_cli( + "bump", + "--prerelease", + "alpha", + "--yes", + "--version-type", + "semver", + "--version-scheme", + "pep440", + ) + + assert git.tag_exist("0.2.0a0") is True + + +@pytest.mark.parametrize( + ("arg", "cfg", "expected"), + [ + pytest.param("", "", "default", id="default"), + pytest.param("", "changelog.cfg", "from config", id="from-config"), + pytest.param( + "--template=changelog.cmd", "changelog.cfg", "from cmd", id="from-command" + ), + ], +) +def test_bump_template_option_precedence( + tmp_commitizen_project: Path, + util: UtilFixture, + any_changelog_format: ChangelogFormat, + arg: str, + cfg: str, + expected: str, +): + project_root = tmp_commitizen_project + cfg_template = project_root / "changelog.cfg" + cmd_template = project_root / "changelog.cmd" + default_template = project_root / any_changelog_format.template + changelog = project_root / any_changelog_format.default_changelog_file + + cfg_template.write_text("from config") + cmd_template.write_text("from cmd") + default_template.write_text("default") + + util.create_file_and_commit("feat: new file") + + if cfg: + pyproject = project_root / "pyproject.toml" + pyproject.write_text( + dedent( + f"""\ + [tool.commitizen] + version = "0.1.0" + template = "{cfg}" + """ + ) + ) + + args = ["bump", "--yes", "--changelog"] + if arg: + args.append(arg) + args.append("0.1.1") + util.run_cli(*args) + + assert changelog.read_text() == expected + + +def test_bump_template_extras_precedence( + tmp_commitizen_project: Path, + util: UtilFixture, + any_changelog_format: ChangelogFormat, + mock_plugin: BaseCommitizen, +): + project_root = tmp_commitizen_project + changelog_tpl = project_root / any_changelog_format.template + changelog_tpl.write_text("{{first}} - {{second}} - {{third}}") + + mock_plugin.template_extras = dict( + first="from-plugin", second="from-plugin", third="from-plugin" + ) + + pyproject = project_root / "pyproject.toml" + pyproject.write_text( + dedent( + """\ + [tool.commitizen] + version = "0.1.0" + [tool.commitizen.extras] + first = "from-config" + second = "from-config" + """ + ) + ) + + util.create_file_and_commit("feat: new file") + + util.run_cli( + "bump", + "--yes", + "--changelog", + "--extra", + "first=from-command", + "0.1.1", + ) + + changelog = project_root / any_changelog_format.default_changelog_file + assert changelog.read_text() == "from-command - from-config - from-plugin" + + +def test_bump_template_extra_quotes( + tmp_commitizen_project: Path, + util: UtilFixture, + any_changelog_format: ChangelogFormat, +): + project_root = tmp_commitizen_project + changelog_tpl = project_root / any_changelog_format.template + changelog_tpl.write_text("{{first}} - {{second}} - {{third}}") + + util.create_file_and_commit("feat: new file") + + util.run_cli( + "bump", + "--changelog", + "--yes", + "-e", + "first=no-quote", + "-e", + "second='single quotes'", + "-e", + 'third="double quotes"', + "0.1.1", + ) + + changelog = project_root / any_changelog_format.default_changelog_file + assert changelog.read_text() == "no-quote - single quotes - double quotes" + + +def test_bump_changelog_contains_increment_only( + tmp_commitizen_project: Path, util: UtilFixture, capsys: pytest.CaptureFixture +): + """Issue 1024""" + # Initialize commitizen up to v1.0.0 + project_root = tmp_commitizen_project + tmp_commitizen_cfg_file = project_root / "pyproject.toml" + tmp_commitizen_cfg_file.write_text( + '[tool.commitizen]\nversion="1.0.0"\nupdate_changelog_on_bump = true\n' + ) + tmp_changelog_file = project_root / "CHANGELOG.md" + tmp_changelog_file.write_text("## v1.0.0") + util.create_file_and_commit("feat(user): new file") + util.create_tag("v1.0.0") + + # Add a commit and bump to v2.0.0 + util.create_file_and_commit("feat(user)!: new file") + util.run_cli("bump", "--yes") + _ = capsys.readouterr() + + # Add a commit and create the incremental changelog to v3.0.0 + # it should only include v3 changes + util.create_file_and_commit("feat(next)!: next version") + with pytest.raises(ExpectedExit): + util.run_cli("bump", "--yes", "--version-files-only", "--changelog-to-stdout") + out, _ = capsys.readouterr() + + assert "3.0.0" in out + assert "2.0.0" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_get_next(util: UtilFixture, capsys: pytest.CaptureFixture): + util.create_file_and_commit("feat: new file") + + with pytest.raises(DryRunExit): + util.run_cli("bump", "--yes", "--get-next") + + out, _ = capsys.readouterr() + assert "0.2.0" in out + assert git.tag_exist("0.2.0") is False + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_get_next_update_changelog_on_bump( + util: UtilFixture, capsys: pytest.CaptureFixture, config_path: Path +): + util.create_file_and_commit("feat: new file") + with config_path.open("a", encoding="utf-8") as fp: + fp.write("update_changelog_on_bump = true\n") + + with pytest.raises(DryRunExit): + util.run_cli("bump", "--yes", "--get-next") + + out, _ = capsys.readouterr() + assert "0.2.0" in out + assert git.tag_exist("0.2.0") is False + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_get_next__no_eligible_commits_raises(util: UtilFixture): + util.create_file_and_commit("chore: new commit") + + with pytest.raises(NoneIncrementExit): + util.run_cli("bump", "--yes", "--get-next") + + +def test_bump_allow_no_commit_with_no_commit( + tmp_commitizen_project, monkeypatch, util: UtilFixture, capsys +): + monkeypatch.chdir(tmp_commitizen_project) + # Create the first commit and bump to 1.0.0 + util.create_file_and_commit("feat(user)!: new file") + util.run_cli("bump", "--yes") + + # Verify NoCommitsFoundError should be raised + # when there's no new commit and "--allow-no-commit" is not set + with pytest.raises(NoCommitsFoundError): + util.run_cli("bump") + + # bump to 1.0.1 with new commit when "--allow-no-commit" is set + util.run_cli("bump", "--allow-no-commit") + out, _ = capsys.readouterr() + assert "bump: version 1.0.0 → 1.0.1" in out + + +def test_bump_allow_no_commit_with_no_eligible_commit( + tmp_commitizen_project, monkeypatch, util: UtilFixture, capsys +): + monkeypatch.chdir(tmp_commitizen_project) + # Create the first commit and bump to 1.0.0 + util.create_file_and_commit("feat(user)!: new file") + util.run_cli("bump", "--yes") + + # Create a commit that is ineligible to bump + util.create_file_and_commit("docs(bump): add description for allow no commit") + + # Verify NoneIncrementExit should be raised + # when there's no eligible bumping commit and "--allow-no-commit" is not set + with pytest.raises(NoneIncrementExit): + util.run_cli("bump", "--yes") + + # bump to 1.0.1 with ineligible commit when "--allow-no-commit" is set + util.run_cli("bump", "--allow-no-commit") + out, _ = capsys.readouterr() + assert "bump: version 1.0.0 → 1.0.1" in out + + +def test_bump_allow_no_commit_with_increment( + tmp_commitizen_project, monkeypatch, util: UtilFixture, capsys +): + monkeypatch.chdir(tmp_commitizen_project) + # # Create the first commit and bump to 1.0.0 + util.create_file_and_commit("feat(user)!: new file") + util.run_cli("bump", "--yes") + + # Verify NoCommitsFoundError should be raised + # when there's no new commit and "--allow-no-commit" is not set + with pytest.raises(NoCommitsFoundError): + util.run_cli("bump", "--yes") + + # bump to 1.1.0 with no new commit when "--allow-no-commit" is set + # and increment is specified + util.run_cli("bump", "--yes", "--allow-no-commit", "--increment", "MINOR") + out, _ = capsys.readouterr() + assert "bump: version 1.0.0 → 1.1.0" in out + + +def test_bump_allow_no_commit_with_manual_version( + tmp_commitizen_project, monkeypatch, util: UtilFixture, capsys +): + monkeypatch.chdir(tmp_commitizen_project) + # # Create the first commit and bump to 1.0.0 + util.create_file_and_commit("feat(user)!: new file") + util.run_cli("bump", "--yes") + + # Verify NoCommitsFoundError should be raised + # when there's no new commit and "--allow-no-commit" is not set + with pytest.raises(NoCommitsFoundError): + util.run_cli("bump", "--yes") + + # bump to 1.1.0 with no new commit when "--allow-no-commit" is set + # and increment is specified + util.run_cli("bump", "--yes", "--allow-no-commit", "2.0.0") + out, _ = capsys.readouterr() + assert "bump: version 1.0.0 → 2.0.0" in out + + +def test_bump_detect_legacy_tags_from_scm( + tmp_commitizen_project: Path, util: UtilFixture +): + project_root = tmp_commitizen_project + tmp_commitizen_cfg_file = project_root / "pyproject.toml" + tmp_commitizen_cfg_file.write_text( + "\n".join( + [ + "[tool.commitizen]", + 'version_provider = "scm"', + 'tag_format = "v$version"', + "legacy_tag_formats = [", + ' "legacy-${version}"', + "]", + ] + ), + ) + util.create_file_and_commit("feat: new file") + util.create_tag("legacy-0.4.2") + util.create_file_and_commit("feat: new file") + + util.run_cli("bump", "--increment", "patch", "--changelog") + + assert git.tag_exist("v0.4.3") is True + + +def test_bump_warn_but_dont_fail_on_invalid_tags( + tmp_commitizen_project: Path, + util: UtilFixture, + capsys: pytest.CaptureFixture, +): + project_root = tmp_commitizen_project + tmp_commitizen_cfg_file = project_root / "pyproject.toml" + tmp_commitizen_cfg_file.write_text( + "\n".join( + [ + "[tool.commitizen]", + 'version_provider = "scm"', + 'version_scheme = "pep440"', + ] + ), + ) + util.create_file_and_commit("feat: new file") + util.create_tag("0.4.2") + util.create_file_and_commit("feat: new file") + util.create_tag("0.4.3.deadbeaf") + util.create_file_and_commit("feat: new file") + + util.run_cli("bump", "--increment", "patch", "--changelog") + + _, err = capsys.readouterr() + + assert err.count("Invalid version tag: '0.4.3.deadbeaf'") == 1 + assert git.tag_exist("0.4.3") is True + + +def test_is_initial_tag(mocker: MockFixture, tmp_commitizen_project, util: UtilFixture): + """Test the _is_initial_tag method behavior.""" + # Create a commit but no tags + util.create_file_and_commit("feat: initial commit") + + # Initialize Bump with minimal config + config = BaseConfig() + config.settings.update( + { + "name": defaults.DEFAULT_SETTINGS["name"], + "encoding": "utf-8", + "pre_bump_hooks": [], + "post_bump_hooks": [], + } + ) + + # Initialize with required arguments + arguments = { + "changelog": False, + "changelog_to_stdout": False, + "git_output_to_stderr": False, + "no_verify": False, + "check_consistency": False, + "retry": False, + "version_scheme": None, + "file_name": None, + "template": None, + "extras": None, + } + + bump_cmd = bump.Bump(config, arguments) # type: ignore[arg-type] + + # Test case 1: No current tag, not yes mode + mocker.patch("questionary.confirm", return_value=mocker.Mock(ask=lambda: True)) + assert bump_cmd._is_initial_tag(None, is_yes=False) is True + + # Test case 2: No current tag, yes mode + assert bump_cmd._is_initial_tag(None, is_yes=True) is True + + # Test case 3: Has current tag + mock_tag = mocker.Mock() + assert bump_cmd._is_initial_tag(mock_tag, is_yes=False) is False + + # Test case 4: No current tag, user denies + mocker.patch("questionary.confirm", return_value=mocker.Mock(ask=lambda: False)) + assert bump_cmd._is_initial_tag(None, is_yes=False) is False + + +@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2025-01-01") +def test_changelog_config_flag_merge_prerelease( + mocker: MockFixture, + util: UtilFixture, + changelog_path: Path, + config_path: Path, + file_regression: FileRegressionFixture, + test_input: str, +): + with config_path.open("a") as f: + f.write("changelog_merge_prerelease = true\n") + f.write("update_changelog_on_bump = true\n") + f.write("annotated_tag = true\n") + + util.create_file_and_commit("irrelevant commit") + mocker.patch("commitizen.git.GitTag.date", "1970-01-01") + git.tag("0.1.0") + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.run_cli("bump", "--prerelease", test_input, "--yes") + + util.run_cli("bump", "--changelog") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2025-01-01") +def test_changelog_config_flag_merge_prerelease_only_prerelease_present( + util: UtilFixture, + changelog_path: Path, + config_path: Path, + file_regression: FileRegressionFixture, + test_input: str, +): + with config_path.open("a") as f: + f.write("changelog_merge_prerelease = true\n") + f.write("update_changelog_on_bump = true\n") + f.write("annotated_tag = true\n") + + util.create_file_and_commit("feat: more relevant commit") + util.run_cli("bump", "--prerelease", test_input, "--yes") + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.run_cli("bump", "--prerelease", test_input, "--yes") + + util.run_cli("bump", "--changelog") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_deprecate_files_only(util: UtilFixture): + util.create_file_and_commit("feat: new file") + with ( + pytest.warns(DeprecationWarning, match=r".*--files-only.*deprecated"), + pytest.raises(ExpectedExit), + ): + util.run_cli("bump", "--yes", "--files-only") + + +@pytest.mark.parametrize( + ("prerelease", "merge"), + [ + pytest.param(True, "true", id="with_prerelease_merge"), + pytest.param(True, "false", id="with_prerelease_no_merge"), + pytest.param(False, "true", id="without_prerelease"), + ], +) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2025-01-01") +def test_changelog_merge_preserves_header( + mocker: MockFixture, + util: UtilFixture, + changelog_path: Path, + config_path: Path, + file_regression: FileRegressionFixture, + prerelease: bool, + merge: str, +): + """Test that merge_prerelease preserves existing changelog header.""" + with config_path.open("a") as f: + f.write(f"changelog_merge_prerelease = {merge}\n") + f.write("update_changelog_on_bump = true\n") + f.write("annotated_tag = true\n") + + # Create initial version with changelog that has a header + util.create_file_and_commit("irrelevant commit") + mocker.patch("commitizen.git.GitTag.date", "1970-01-01") + git.tag("0.1.0") + + # Create a changelog with a header manually + changelog_path.write_text( + dedent("""\ + # Changelog + + All notable changes to this project will be documented here. + + ## 0.1.0 (1970-01-01) + """) + ) + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + + if prerelease: + util.run_cli("bump", "--prerelease", "alpha", "--yes") + + util.create_file_and_commit("feat: new feature right before the bump") + util.run_cli("bump", "--changelog") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") diff --git a/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_alpha_.md b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_alpha_.md new file mode 100644 index 0000000000..6061938125 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_alpha_.md @@ -0,0 +1,11 @@ +## 0.2.0 (2025-01-01) + +### Feat + +- add new output + +### Fix + +- output glitch + +## 0.1.0 (1970-01-01) diff --git a/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_beta_.md b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_beta_.md new file mode 100644 index 0000000000..6061938125 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_beta_.md @@ -0,0 +1,11 @@ +## 0.2.0 (2025-01-01) + +### Feat + +- add new output + +### Fix + +- output glitch + +## 0.1.0 (1970-01-01) diff --git a/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_alpha_.md b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_alpha_.md new file mode 100644 index 0000000000..1f04057964 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_alpha_.md @@ -0,0 +1,10 @@ +## 0.2.0 (2025-01-01) + +### Feat + +- add new output +- more relevant commit + +### Fix + +- output glitch diff --git a/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_beta_.md b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_beta_.md new file mode 100644 index 0000000000..1f04057964 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_beta_.md @@ -0,0 +1,10 @@ +## 0.2.0 (2025-01-01) + +### Feat + +- add new output +- more relevant commit + +### Fix + +- output glitch diff --git a/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_rc_.md b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_rc_.md new file mode 100644 index 0000000000..1f04057964 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_only_prerelease_present_rc_.md @@ -0,0 +1,10 @@ +## 0.2.0 (2025-01-01) + +### Feat + +- add new output +- more relevant commit + +### Fix + +- output glitch diff --git a/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_rc_.md b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_rc_.md new file mode 100644 index 0000000000..6061938125 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_config_flag_merge_prerelease_rc_.md @@ -0,0 +1,11 @@ +## 0.2.0 (2025-01-01) + +### Feat + +- add new output + +### Fix + +- output glitch + +## 0.1.0 (1970-01-01) diff --git a/tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_merge_.md b/tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_merge_.md new file mode 100644 index 0000000000..c0ac9c5c9c --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_merge_.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will be documented here. + +## 0.2.0 (2025-01-01) + +### Feat + +- new feature right before the bump +- add new output + +### Fix + +- output glitch + +## 0.1.0 (1970-01-01) diff --git a/tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_no_merge_.md b/tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_no_merge_.md new file mode 100644 index 0000000000..6058182503 --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_merge_preserves_header_with_prerelease_no_merge_.md @@ -0,0 +1,21 @@ +# Changelog + +All notable changes to this project will be documented here. + +## 0.2.0 (2025-01-01) + +### Feat + +- new feature right before the bump + +## 0.2.0a0 (2025-01-01) + +### Feat + +- add new output + +### Fix + +- output glitch + +## 0.1.0 (1970-01-01) diff --git a/tests/commands/test_bump_command/test_changelog_merge_preserves_header_without_prerelease_.md b/tests/commands/test_bump_command/test_changelog_merge_preserves_header_without_prerelease_.md new file mode 100644 index 0000000000..c0ac9c5c9c --- /dev/null +++ b/tests/commands/test_bump_command/test_changelog_merge_preserves_header_without_prerelease_.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will be documented here. + +## 0.2.0 (2025-01-01) + +### Feat + +- new feature right before the bump +- add new output + +### Fix + +- output glitch + +## 0.1.0 (1970-01-01) diff --git a/tests/commands/test_changelog_command.py b/tests/commands/test_changelog_command.py new file mode 100644 index 0000000000..b2d024ac7f --- /dev/null +++ b/tests/commands/test_changelog_command.py @@ -0,0 +1,1697 @@ +from __future__ import annotations + +import itertools +from pathlib import Path +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest +from jinja2 import FileSystemLoader + +from commitizen import git +from commitizen.commands.changelog import Changelog +from commitizen.exceptions import ( + DryRunExit, + InvalidCommandArgumentError, + NoCommitsFoundError, + NoRevisionError, + NotAGitProjectError, + NotAllowed, +) + +if TYPE_CHECKING: + from pytest_mock import MockFixture + from pytest_regressions.file_regression import FileRegressionFixture + + from commitizen.changelog_formats import ChangelogFormat + from commitizen.config.base_config import BaseConfig + from commitizen.config.json_config import JsonConfig + from commitizen.cz.base import BaseCommitizen + from tests.utils import UtilFixture + + +@pytest.fixture +def changelog_jinja_file(tmp_commitizen_project: Path) -> Path: + return tmp_commitizen_project / "changelog.jinja" + + +@pytest.fixture +def changelog_tpl( + tmp_commitizen_project: Path, any_changelog_format: ChangelogFormat +) -> Path: + return tmp_commitizen_project / any_changelog_format.template + + +@pytest.fixture +def changelog_file( + tmp_commitizen_project: Path, any_changelog_format: ChangelogFormat +) -> Path: + return tmp_commitizen_project / any_changelog_format.default_changelog_file + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_from_version_zero_point_two( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + util.create_file_and_commit("feat: new file") + util.create_file_and_commit("refactor: not in changelog") + + # create tag + util.run_cli("bump", "--yes") + capsys.readouterr() + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: after 0.2") + + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run", "--start-rev", "0.2.0") + + out, _ = capsys.readouterr() + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_with_different_cz( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + util.create_file_and_commit("JRA-34 #comment corrected indent issue") + util.create_file_and_commit("JRA-35 #time 1w 2d 4h 30m Total work logged") + + with pytest.raises(DryRunExit): + util.run_cli("-n", "cz_jira", "changelog", "--dry-run") + out, _ = capsys.readouterr() + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_from_start( + changelog_format: ChangelogFormat, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + util.create_file_and_commit("feat: new file") + util.create_file_and_commit("refactor: is in changelog") + util.create_file_and_commit("Merge into master") + changelog_file = f"CHANGELOG.{changelog_format.extension}" + template = f"CHANGELOG.{changelog_format.extension}.j2" + + util.run_cli("changelog", "--file-name", changelog_file, "--template", template) + + out = Path(changelog_file).read_text(encoding="utf-8") + file_regression.check(out, extension=changelog_format.ext) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-08-14") +def test_changelog_replacing_unreleased_using_incremental( + changelog_format: ChangelogFormat, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.create_file_and_commit("Merge into master") + changelog_file = f"CHANGELOG.{changelog_format.extension}" + template = f"CHANGELOG.{changelog_format.extension}.j2" + + util.run_cli("changelog", "--file-name", changelog_file, "--template", template) + + util.run_cli("bump", "--yes", "--file-name", changelog_file, "--template", template) + + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli( + "changelog", + "--incremental", + "--file-name", + changelog_file, + "--template", + template, + ) + + out = Path(changelog_file).read_text(encoding="utf-8") + + file_regression.check(out, extension=changelog_format.ext) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-08-14") +def test_changelog_is_persisted_using_incremental( + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.create_file_and_commit("Merge into master") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog") + + with changelog_path.open("a", encoding="utf-8") as f: + f.write("\nnote: this should be persisted using increment\n") + + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--incremental") + + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_incremental_angular_sample( + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with changelog_path.open("w", encoding="utf-8") as f: + f.write( + "# [10.0.0-rc.3](https://github.com/angular/angular/compare/10.0.0-rc.2...10.0.0-rc.3) (2020-04-22)\n" + "\n" + "### Bug Fixes" + "\n" + "* **common:** format day-periods that cross midnight ([#36611](https://github.com/angular/angular/issues/36611)) ([c6e5fc4](https://github.com/angular/angular/commit/c6e5fc4)), closes [#36566](https://github.com/angular/angular/issues/36566)\n" + ) + util.create_file_and_commit("irrelevant commit") + util.create_tag("10.0.0-rc.3") + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--incremental") + + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +KEEP_A_CHANGELOG = """# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). +""" + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_incremental_keep_a_changelog_sample( + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with changelog_path.open("w", encoding="utf-8") as f: + f.write(KEEP_A_CHANGELOG) + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0") + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--incremental") + + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize("dry_run", [True, False]) +def test_changelog_hook( + mocker: MockFixture, config: BaseConfig, dry_run: bool, util: UtilFixture +): + changelog_hook_mock = mocker.Mock() + changelog_hook_mock.return_value = "cool changelog hook" + + util.create_file_and_commit("feat: new file") + util.create_file_and_commit("refactor: is in changelog") + util.create_file_and_commit("Merge into master") + + config.settings["change_type_order"] = ["Refactor", "Feat"] # type: ignore[typeddict-unknown-key] + changelog = Changelog( + config, {"unreleased_version": None, "incremental": True, "dry_run": dry_run} + ) + mocker.patch.object(changelog.cz, "changelog_hook", changelog_hook_mock) + if dry_run: + with pytest.raises(DryRunExit): + changelog() + else: + changelog() + + full_changelog = ( + "## Unreleased\n\n### Refactor\n\n- is in changelog\n\n### Feat\n\n- new file\n" + ) + partial_changelog = full_changelog + if dry_run: + partial_changelog = "" + + changelog_hook_mock.assert_called_with(full_changelog, partial_changelog) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_hook_customize( + mocker: MockFixture, config_customize: JsonConfig, util: UtilFixture +): + changelog_hook_mock = mocker.Mock() + changelog_hook_mock.return_value = "cool changelog hook" + + util.create_file_and_commit("feat: new file") + util.create_file_and_commit("refactor: is in changelog") + util.create_file_and_commit("Merge into master") + + changelog = Changelog( + config_customize, + {"unreleased_version": None, "incremental": True, "dry_run": False}, + ) + mocker.patch.object(changelog.cz, "changelog_hook", changelog_hook_mock) + changelog() + full_changelog = ( + "## Unreleased\n\n### Refactor\n\n- is in changelog\n\n### Feat\n\n- new file\n" + ) + + changelog_hook_mock.assert_called_with(full_changelog, full_changelog) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_release_hook( + mocker: MockFixture, config: BaseConfig, util: UtilFixture +): + def changelog_release_hook(release: dict, tag: git.GitTag) -> dict: + return release + + for i in range(3): + util.create_file_and_commit("feat: new file") + util.create_file_and_commit("refactor: is in changelog") + util.create_file_and_commit("Merge into master") + util.create_tag(f"0.{i + 1}.0") + + # changelog = Changelog(config, {}) + changelog = Changelog( + config, {"unreleased_version": None, "incremental": True, "dry_run": False} + ) + mocker.patch.object(changelog.cz, "changelog_release_hook", changelog_release_hook) + spy = mocker.spy(changelog.cz, "changelog_release_hook") + changelog() + + assert spy.call_count == 3 + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_with_non_linear_merges_commit_order( + mocker: MockFixture, config_customize: JsonConfig, util: UtilFixture +): + """Test that commits merged non-linearly are correctly ordered in the changelog + + A typical scenario is having two branches from main like so: + * feat: I will be merged first - (2023-03-01 11:35:51 +0100) | (branchB) + | * feat: I will be merged second - (2023-03-01 11:35:22 +0100) | (branchA) + |/ + * feat: initial commit - (2023-03-01 11:34:54 +0100) | (HEAD -> main) + + And merging them, for example in the reverse order they were created on would give the following: + * Merge branch 'branchA' - (2023-03-01 11:42:59 +0100) | (HEAD -> main) + |\ + | * feat: I will be merged second - (2023-03-01 11:35:22 +0100) | (branchA) + * | feat: I will be merged first - (2023-03-01 11:35:51 +0100) | (branchB) + |/ + * feat: initial commit - (2023-03-01 11:34:54 +0100) | + + In this case we want the changelog to reflect the topological order of commits, + i.e. the order in which they were merged into the main branch + + So the above example should result in the following: + ## Unreleased + + ### Feat + - I will be merged second + - I will be merged first + - initial commit + """ + changelog_hook_mock = mocker.Mock() + changelog_hook_mock.return_value = "cool changelog hook" + + util.create_file_and_commit("feat: initial commit") + + main_branch = util.get_current_branch() + + util.create_branch("branchA") + util.create_branch("branchB") + + util.switch_branch("branchA") + util.create_file_and_commit("feat: I will be merged second") + + util.switch_branch("branchB") + util.create_file_and_commit("feat: I will be merged first") + + # Note we merge branches opposite order than author_date + util.switch_branch(main_branch) + util.merge_branch("branchB") + util.merge_branch("branchA") + + changelog = Changelog( + config_customize, + {"unreleased_version": None, "incremental": True, "dry_run": False}, + ) + mocker.patch.object(changelog.cz, "changelog_hook", changelog_hook_mock) + changelog() + full_changelog = "\ +## Unreleased\n\n\ +\ +### Feat\n\n\ +- I will be merged second\n\ +- I will be merged first\n\ +- initial commit\n" + + changelog_hook_mock.assert_called_with(full_changelog, full_changelog) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_multiple_incremental_do_not_add_new_lines( + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + """Test for bug https://github.com/commitizen-tools/commitizen/issues/192""" + for commit_message in [ + "feat: add new output", + "fix: output glitch", + "fix: no more explosions", + "feat: add more stuff", + ]: + util.create_file_and_commit(commit_message) + util.run_cli("changelog", "--incremental") + + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_incremental_newline_separates_new_content_from_old( + changelog_path: Path, + util: UtilFixture, + file_regression: FileRegressionFixture, +): + """Test for https://github.com/commitizen-tools/commitizen/issues/509""" + with changelog_path.open("w", encoding="utf-8") as f: + f.write("Pre-existing content that should be kept\n") + + util.create_file_and_commit("feat: add more cat videos") + util.run_cli("changelog", "--incremental") + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +def test_changelog_without_revision(tmp_commitizen_project, util: UtilFixture): + (tmp_commitizen_project / "CHANGELOG.md").write_text( + """ + # Unreleased + + ## v1.0.0 + """ + ) + + # No revision + with pytest.raises(NoRevisionError): + util.run_cli("changelog", "--incremental") + + util.create_file_and_commit("feat: new file") + util.create_tag("2.0.0") + + # With different tag name and changelog content + with pytest.raises(NoRevisionError): + util.run_cli("changelog", "--incremental") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_incremental_with_revision(util: UtilFixture): + """combining incremental with a revision doesn't make sense""" + with pytest.raises(NotAllowed): + util.run_cli("changelog", "--incremental", "0.2.0") + + +@pytest.mark.usefixtures("chdir") +def test_changelog_in_non_git_project(util: UtilFixture): + with pytest.raises(NotAGitProjectError): + util.run_cli("changelog", "--incremental") + + +@pytest.mark.parametrize( + "commit_message", + [ + "feat(users): email pattern corrected\n\n" + "BREAKING CHANGE: migrate by renaming user to users\n\n" + "footer content", + "feat(users): email pattern corrected\n\n" + "body content\n\n" + "BREAKING CHANGE: migrate by renaming user to users", + ], +) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_breaking_change_content_v1_beta( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, + commit_message: str, +): + util.create_file_and_commit(commit_message) + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run") + out, _ = capsys.readouterr() + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_breaking_change_content_v1_multiline( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + commit_message = ( + "feat(users): email pattern corrected\n\n" + "body content\n\n" + "BREAKING CHANGE: migrate by renaming user to users.\n" + "and then connect the thingy with the other thingy\n\n" + "footer content" + ) + util.create_file_and_commit(commit_message) + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run") + out, _ = capsys.readouterr() + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_breaking_change_content_v1_with_exclamation_mark( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + commit_message = "chore!: drop support for py36" + util.create_file_and_commit(commit_message) + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run") + out, _ = capsys.readouterr() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_breaking_change_content_v1_with_exclamation_mark_feat( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + commit_message = "feat(pipeline)!: some text with breaking change" + util.create_file_and_commit(commit_message) + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run") + out, _ = capsys.readouterr() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_config_flag_increment( + changelog_path: Path, + config_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write("changelog_incremental = true\n") + with changelog_path.open("a", encoding="utf-8") as f: + f.write("\nnote: this should be persisted using increment\n") + + util.create_file_and_commit("feat: add new output") + + util.run_cli("changelog") + + out = changelog_path.read_text(encoding="utf-8") + + assert "this should be persisted using increment" in out + file_regression.check(out, extension=".md") + + +@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2025-12-29") +def test_changelog_config_flag_merge_prerelease( + changelog_path: Path, + config_path: Path, + file_regression: FileRegressionFixture, + test_input: str, + util: UtilFixture, +): + with config_path.open("a") as f: + f.write("changelog_merge_prerelease = true\n") + + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0") + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + + util.run_cli("bump", "--prerelease", test_input, "--yes") + + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_config_start_rev_option( + capsys: pytest.CaptureFixture, + config_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + capsys.readouterr() + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: after 0.2") + + with config_path.open("a", encoding="utf-8") as f: + f.write('changelog_start_rev = "0.2.0"\n') + + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run") + + out, _ = capsys.readouterr() + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_incremental_keep_a_changelog_sample_with_annotated_tag( + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + """Fix #378""" + with changelog_path.open("w", encoding="utf-8") as f: + f.write(KEEP_A_CHANGELOG) + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0", annotated=True) + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--incremental") + + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2021-06-11") +def test_changelog_incremental_with_release_candidate_version( + changelog_path: Path, + file_regression: FileRegressionFixture, + test_input: str, + util: UtilFixture, +): + """Fix #357""" + with changelog_path.open("w", encoding="utf-8") as f: + f.write(KEEP_A_CHANGELOG) + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0", annotated=True) + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + + util.run_cli("bump", "--changelog", "--prerelease", test_input, "--yes") + + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--incremental") + + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.parametrize( + ("from_pre", "to_pre"), itertools.product(["alpha", "beta", "rc"], repeat=2) +) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2021-06-11") +def test_changelog_incremental_with_prerelease_version_to_prerelease_version( + changelog_path: Path, + file_regression: FileRegressionFixture, + from_pre: str, + to_pre: str, + util: UtilFixture, +): + with changelog_path.open("w") as f: + f.write(KEEP_A_CHANGELOG) + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0", annotated=True) + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + + util.run_cli("bump", "--changelog", "--prerelease", from_pre, "--yes") + + util.run_cli("bump", "--changelog", "--prerelease", to_pre, "--yes") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2025-12-29") +def test_changelog_release_candidate_version_with_merge_prerelease( + changelog_path: Path, + file_regression: FileRegressionFixture, + test_input: str, + util: UtilFixture, +): + """Fix #357""" + with changelog_path.open("w") as f: + f.write(KEEP_A_CHANGELOG) + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0") + + util.create_file_and_commit("feat: add new output") + util.create_file_and_commit("fix: output glitch") + + util.run_cli("bump", "--prerelease", test_input, "--yes") + + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--merge-prerelease") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.parametrize("test_input", ["rc", "alpha", "beta"]) +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2023-04-16") +def test_changelog_incremental_with_merge_prerelease( + changelog_path: Path, + file_regression: FileRegressionFixture, + test_input: str, + util: UtilFixture, +): + """Fix #357""" + with changelog_path.open("w") as f: + f.write(KEEP_A_CHANGELOG) + util.create_file_and_commit("irrelevant commit") + util.create_tag("1.0.0") + + util.create_file_and_commit("feat: add new output") + + util.run_cli("bump", "--prerelease", test_input, "--yes", "--changelog") + + util.create_file_and_commit("fix: output glitch") + + util.run_cli("bump", "--prerelease", test_input, "--yes") + + util.create_file_and_commit("fix: mama gotta work") + util.create_file_and_commit("feat: add more stuff") + util.create_file_and_commit("Merge into master") + + util.run_cli("changelog", "--merge-prerelease", "--incremental") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_with_filename_as_empty_string(config_path: Path, util: UtilFixture): + with config_path.open("a", encoding="utf-8") as f: + f.write("changelog_file = true\n") + + util.create_file_and_commit("feat: add new output") + + with pytest.raises(NotAllowed): + util.run_cli("changelog") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_first_version_from_arg( + config_path: Path, + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog", "0.2.0") + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_latest_version_from_arg( + config_path: Path, + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog", "0.3.0") + + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize( + ("rev_range", "tag"), + [ + pytest.param("0.8.0", "0.2.0", id="single-not-found"), + pytest.param("0.1.0..0.3.0", "0.3.0", id="lower-bound-not-found"), + pytest.param("0.1.0..0.3.0", "0.1.0", id="upper-bound-not-found"), + pytest.param("0.3.0..0.4.0", "0.2.0", id="none-found"), + ], +) +def test_changelog_from_rev_range_not_found( + config_path: Path, rev_range: str, tag: str, util: UtilFixture +): + """Provides an invalid revision ID to changelog command""" + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.create_tag(tag) + util.create_file_and_commit("feat: new file") + util.create_tag("1.0.0") + + with pytest.raises(NoCommitsFoundError) as excinfo: + util.run_cli("changelog", rev_range) # it shouldn't exist + + assert "Could not find a valid revision" in str(excinfo) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_multiple_matching_tags( + config_path: Path, changelog_path: Path, util: UtilFixture +): + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "new-$version"\nlegacy_tag_formats = ["legacy-$version"]') + + util.create_file_and_commit("feat: new file") + util.create_tag("legacy-1.0.0") + util.create_file_and_commit("feat: new file") + util.create_tag("legacy-2.0.0") + util.create_tag("new-2.0.0") + + with pytest.warns() as warnings: + util.run_cli("changelog", "1.0.0..2.0.0") # it shouldn't exist + + assert len(warnings) == 1 + warning = warnings[0] + assert "Multiple tags found for version 2.0.0" in str(warning.message) + + out = changelog_path.read_text() + + # Ensure only one tag is rendered + assert out.count("2.0.0") == 1 + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_from_rev_range_default_tag_format( + changelog_path: Path, util: UtilFixture +): + """Checks that rev_range is calculated with the default (None) tag format""" + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog", "0.3.0") + + out = changelog_path.read_text() + + assert "new file" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_version_range_including_first_tag( + config_path: Path, + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog", "0.2.0..0.3.0") + out = changelog_path.read_text(encoding="utf-8") + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_version_range_from_arg( + config_path: Path, + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: getting ready for this") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog", "0.3.0..0.4.0") + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_version_range_with_legacy_tags( + config_path: Path, + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + Path(config_path).write_text( + "\n".join( + [ + "[tool.commitizen]", + 'version_provider = "scm"', + 'tag_format = "v$version"', + "legacy_tag_formats = [", + ' "legacy-${version}",', + ' "old-${version}",', + "]", + ] + ), + ) + + util.create_file_and_commit("feat: new file") + util.create_tag("old-0.2.0") + util.create_file_and_commit("feat: new file") + util.create_tag("legacy-0.3.0") + util.create_file_and_commit("feat: new file") + util.create_tag("legacy-0.4.0") + + util.run_cli("changelog", "0.2.0..0.4.0") + file_regression.check(Path(changelog_path).read_text(), extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_version_with_big_range_from_arg( + config_path, changelog_path, file_regression, util: UtilFixture +): + with config_path.open("a", encoding="utf-8") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") # 0.3.0 + util.create_file_and_commit("feat: getting ready for this") + + util.run_cli("bump", "--yes") # 0.4.0 + util.create_file_and_commit("fix: small error") + + util.run_cli("bump", "--yes") # 0.4.1 + util.create_file_and_commit("feat: new shinny feature") + + util.run_cli("bump", "--yes") # 0.5.0 + util.create_file_and_commit("feat: amazing different shinny feature") + + util.run_cli("bump", "--yes") # 0.6.0 + + util.run_cli("changelog", "0.3.0..0.5.0") + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_rev_latest_version_dry_run( + capsys: pytest.CaptureFixture, + config_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a") as f: + f.write('tag_format = "$version"\n') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes") + capsys.readouterr() + + with pytest.raises(DryRunExit): + util.run_cli("changelog", "0.3.0", "--dry-run") + + out, _ = capsys.readouterr() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_invalid_subject_is_skipped( + capsys: pytest.CaptureFixture, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + """Fix #510""" + non_conformant_commit_title = ( + "Merge pull request #487 from manang/master\n\n" + "feat: skip merge messages that start with Pull request\n" + ) + util.create_file_and_commit(non_conformant_commit_title) + util.create_file_and_commit("feat: a new world") + with pytest.raises(DryRunExit): + util.run_cli("changelog", "--dry-run") + out, _ = capsys.readouterr() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_with_customized_change_type_order( + config_path: Path, + changelog_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a") as f: + f.write('tag_format = "$version"\n') + f.write( + 'change_type_order = ["BREAKING CHANGE", "Perf", "Fix", "Feat", "Refactor"]\n' + ) + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + util.create_file_and_commit("fix: fix bug") + + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: getting ready for this") + util.create_file_and_commit("perf: perf improvement") + + util.run_cli("bump", "--yes") + + util.run_cli("changelog", "0.3.0..0.4.0") + out = changelog_path.read_text() + + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_empty_commit_list(mocker: MockFixture, util: UtilFixture): + util.create_file_and_commit("feat: a new world") + + # test changelog properly handles when no commits are found for the revision + mocker.patch("commitizen.git.get_commits", return_value=[]) + with pytest.raises(NoCommitsFoundError): + util.run_cli("changelog") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_prerelease_rev_with_use_scheme_semver( + capsys: pytest.CaptureFixture, + config_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + with config_path.open("a") as f: + f.write('tag_format = "$version"\nversion_scheme = "semver"') + + # create commit and tag + util.create_file_and_commit("feat: new file") + util.run_cli("bump", "--yes") + + util.create_file_and_commit("feat: after 0.2.0") + util.create_file_and_commit("feat: another feature") + + util.run_cli("bump", "--yes", "--prerelease", "alpha") + capsys.readouterr() + + assert git.tag_exist("0.3.0-a0") + + with pytest.raises(DryRunExit): + util.run_cli("changelog", "0.3.0-a0", "--dry-run") + + out, _ = capsys.readouterr() + file_regression.check(out, extension=".md") + + util.run_cli("bump", "--yes", "--prerelease", "alpha") + capsys.readouterr() + + assert git.tag_exist("0.3.0-a1") + + with pytest.raises(DryRunExit): + util.run_cli("changelog", "0.3.0-a1", "--dry-run") + + out, _ = capsys.readouterr() + file_regression.check(out, extension=".second-prerelease.md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_uses_version_tags_for_header( + mocker: MockFixture, config: BaseConfig, util: UtilFixture +): + """Tests that changelog headers always use version tags even if there are non-version tags + + This tests a scenario fixed in this commit: + The first header was using a non-version tag and outputting "## 0-not-a-version" instead of "## 1.0.0 + """ + util.create_file_and_commit("feat: commit in 1.0.0") + util.create_tag("0-not-a-version") + util.create_tag("1.0.0") + util.create_tag("also-not-a-version") + + write_patch = mocker.patch("commitizen.commands.changelog.out.write") + + changelog = Changelog( + config, {"dry_run": True, "incremental": True, "unreleased_version": None} + ) + + with pytest.raises(DryRunExit): + changelog() + + changelog_output = write_patch.call_args[0][0] + + assert changelog_output.startswith("## 1.0.0") + assert "0-no-a-version" not in changelog_output + assert "also-not-a-version" not in changelog_output + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2022-02-13") +def test_changelog_from_current_version_tag_with_nonversion_tag( + mocker: MockFixture, config: BaseConfig, util: UtilFixture +): + """Tests that changelog generation for a single version works even if + there is a non-version tag in the list of tags + + This tests a scenario which is fixed in this commit: + You have a commit in between two versions (1.0.0..2.0.0) which is tagged with a non-version tag (not-a-version). + In this case commitizen should disregard the non-version tag when determining the rev-range & generating the changelog. + """ + util.create_file_and_commit("feat: initial commit") + util.create_tag("1.0.0") + + util.create_file_and_commit("feat: commit 1") + util.create_tag("1-not-a-version") + + util.create_file_and_commit("feat: commit 2") + + util.create_file_and_commit("bump: version 1.0.0 → 2.0.0") + util.create_tag("2.0.0") + + write_patch = mocker.patch("commitizen.commands.changelog.out.write") + + with pytest.raises(DryRunExit): + Changelog( + config, + { + "dry_run": True, + "incremental": False, + "unreleased_version": None, + "rev_range": "2.0.0", + }, + )() + + write_patch.assert_called_with( + "\ +## 2.0.0 (2022-02-13)\n\n\ +### Feat\n\n\ +- commit 2\n\ +- commit 1\n" + ) + + +@pytest.mark.parametrize( + ("arg", "cfg", "expected"), + [ + pytest.param("", "", "default", id="default"), + pytest.param("", "changelog.cfg", "from config", id="from-config"), + pytest.param( + "--template=changelog.cmd", "changelog.cfg", "from cmd", id="from-command" + ), + ], +) +def test_changelog_template_option_precedence( + tmp_commitizen_project: Path, + arg: str, + cfg: str, + expected: str, + util: UtilFixture, + changelog_file: Path, + changelog_tpl: Path, +): + project_root = tmp_commitizen_project + cfg_template = project_root / "changelog.cfg" + cmd_template = project_root / "changelog.cmd" + + cfg_template.write_text("from config") + cmd_template.write_text("from cmd") + changelog_tpl.write_text("default") + + util.create_file_and_commit("feat: new file") + + if cfg: + pyproject = project_root / "pyproject.toml" + pyproject.write_text( + dedent( + f"""\ + [tool.commitizen] + version = "0.1.0" + template = "{cfg}" + """ + ) + ) + + testargs = ["changelog"] + if arg: + testargs.append(arg) + util.run_cli(*testargs) + + assert changelog_file.read_text() == expected + + +def test_changelog_template_extras_precedence( + changelog_tpl: Path, + mock_plugin: BaseCommitizen, + pyproject: Path, + changelog_file: Path, + util: UtilFixture, +): + changelog_tpl.write_text("{{first}} - {{second}} - {{third}}") + + mock_plugin.template_extras = dict( + first="from-plugin", second="from-plugin", third="from-plugin" + ) + + pyproject.write_text( + dedent( + """\ + [tool.commitizen] + version = "0.1.0" + [tool.commitizen.extras] + first = "from-config" + second = "from-config" + """ + ) + ) + + util.create_file_and_commit("feat: new file") + util.run_cli("changelog", "--extra", "first=from-command") + + assert changelog_file.read_text() == "from-command - from-config - from-plugin" + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2021-06-11") +def test_changelog_only_tag_matching_tag_format_included_prefix( + changelog_path: Path, + config_path: Path, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('\ntag_format = "custom${version}"\n') + util.create_file_and_commit("feat: new file") + util.create_tag("v0.2.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("0.2.0") + util.create_tag("random0.2.0") + util.run_cli("bump", "--changelog", "--yes") + util.create_file_and_commit("feat: another new file") + util.run_cli("bump", "--changelog", "--yes") + out = changelog_path.read_text() + assert out.startswith("## custom0.3.0 (2021-06-11)") + assert "## v0.2.0 (2021-06-11)" not in out + assert "## 0.2.0 (2021-06-11)" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_only_tag_matching_tag_format_included_prefix_sep( + changelog_path: Path, + config_path: Path, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('\ntag_format = "custom-${version}"\n') + util.create_file_and_commit("feat: new file") + util.create_tag("v0.2.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("0.2.0") + util.create_tag("random0.2.0") + util.run_cli("bump", "--changelog", "--yes") + util.create_file_and_commit("feat: new version another new file") + util.create_file_and_commit("feat: new version some new file") + util.run_cli("bump", "--changelog") + out = changelog_path.read_text() + assert out.startswith("## custom-0.3.0") + assert "## v0.2.0" not in out + assert "## 0.2.0" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2021-06-11") +def test_changelog_only_tag_matching_tag_format_included_suffix( + changelog_path: Path, + config_path: Path, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('\ntag_format = "${version}custom"\n') + util.create_file_and_commit("feat: new file") + util.create_tag("v0.2.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("0.2.0") + util.create_tag("random0.2.0") + # bump to 0.2.0custom + util.run_cli("bump", "--changelog", "--yes") + + util.create_file_and_commit("feat: another new file") + # bump to 0.3.0custom + util.run_cli("bump", "--changelog", "--yes") + out = changelog_path.read_text() + assert out.startswith("## 0.3.0custom (2021-06-11)") + assert "## v0.2.0 (2021-06-11)" not in out + assert "## 0.2.0 (2021-06-11)" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2021-06-11") +def test_changelog_only_tag_matching_tag_format_included_suffix_sep( + changelog_path: Path, + config_path: Path, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.write('\ntag_format = "${version}-custom"\n') + util.create_file_and_commit("feat: new file") + util.create_tag("v0.2.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("0.2.0") + util.create_tag("random0.2.0") + util.run_cli("bump", "--changelog", "--yes") + util.create_file_and_commit("feat: another new file") + util.run_cli("bump", "--changelog", "--yes") + out = changelog_path.read_text() + assert out.startswith("## 0.3.0-custom (2021-06-11)") + assert "## v0.2.0 (2021-06-11)" not in out + assert "## 0.2.0 (2021-06-11)" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_legacy_tags( + changelog_path: Path, + config_path: Path, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.writelines( + [ + 'tag_format = "v${version}"\n', + "legacy_tag_formats = [\n", + ' "older-${version}",\n', + ' "oldest-${version}",\n', + "]\n", + ] + ) + util.create_file_and_commit("feat: new file") + util.create_tag("oldest-0.1.0") + util.create_file_and_commit("feat: new file") + util.create_tag("older-0.2.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("v0.3.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("not-0.3.1") + util.run_cli("bump", "--changelog", "--yes") + out = changelog_path.read_text() + assert "## v0.3.0" in out + assert "## older-0.2.0" in out + assert "## oldest-0.1.0" in out + assert "## v0.3.0" in out + assert "## not-0.3.1" not in out + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.freeze_time("2024-11-18") +def test_changelog_incremental_change_tag_format( + changelog_path: Path, + config_path: Path, + file_regression: FileRegressionFixture, + util: UtilFixture, +): + util.freezer.move_to("2024-11-18") + config = Path(config_path) + base_config = config.read_text() + config.write_text( + "\n".join( + ( + base_config, + 'tag_format = "older-${version}"', + ) + ) + ) + util.create_file_and_commit("feat: new file") + util.create_tag("older-0.1.0") + util.create_file_and_commit("feat: new file") + util.create_tag("older-0.2.0") + util.run_cli("changelog") + + config.write_text( + "\n".join( + ( + base_config, + 'tag_format = "v${version}"', + 'legacy_tag_formats = ["older-${version}"]', + ) + ) + ) + util.create_file_and_commit("feat: another new file") + util.create_tag("v0.3.0") + util.run_cli("changelog", "--incremental") + out = changelog_path.read_text() + assert "## v0.3.0" in out + assert "## older-0.2.0" in out + assert "## older-0.1.0" in out + file_regression.check(out, extension=".md") + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_changelog_ignored_tags( + changelog_path: Path, + config_path: Path, + capsys: pytest.CaptureFixture, + util: UtilFixture, +): + with config_path.open("a", encoding="utf-8") as f: + f.writelines( + [ + 'tag_format = "v${version}"\n', + "ignored_tag_formats = [\n", + ' "ignored",\n', + ' "ignore-${version}",\n', + "]\n", + ] + ) + util.create_file_and_commit("feat: new file") + util.create_tag("ignore-0.1.0") + util.create_file_and_commit("feat: new file") + util.create_tag("ignored") + util.create_file_and_commit("feat: another new file") + util.create_tag("v0.3.0") + util.create_file_and_commit("feat: another new file") + util.create_tag("not-ignored") + util.run_cli("bump", "--changelog", "--yes") + out = changelog_path.read_text() + assert "## ignore-0.1.0" not in out + assert "## ignored" not in out + assert "## not-ignored" not in out + assert "## v0.3.0" in out + + _, err = capsys.readouterr() + assert "Invalid version tag: 'ignore-0.1.0'" not in err + assert "Invalid version tag: 'ignored'" not in err + assert "Invalid version tag: 'not-ignored'" in err + assert "Invalid version tag: 'v0.3.0'" not in err + + +def test_changelog_template_extra_quotes( + changelog_tpl: Path, + changelog_file: Path, + util: UtilFixture, +): + changelog_tpl.write_text("{{first}} - {{second}} - {{third}}") + util.create_file_and_commit("feat: new file") + util.run_cli( + "changelog", + "-e", + "first=no-quote", + "-e", + "second='single quotes'", + "-e", + 'third="double quotes"', + ) + + assert changelog_file.read_text() == "no-quote - single quotes - double quotes" + + +@pytest.mark.parametrize( + ("extra", "expected"), + [ + pytest.param("key=value=", "value=", id="2-equals"), + pytest.param("key==value", "=value", id="2-consecutive-equals"), + pytest.param("key==value==", "=value==", id="multiple-equals"), + ], +) +def test_changelog_template_extra_weird_but_valid( + changelog_tpl: Path, + changelog_file: Path, + extra: str, + expected: str, + util: UtilFixture, +): + changelog_tpl.write_text("{{key}}") + util.create_file_and_commit("feat: new file") + util.run_cli("changelog", "-e", extra) + + assert changelog_file.read_text() == expected + + +@pytest.mark.parametrize("extra", ["no-equal", "", "=no-key"]) +def test_changelog_template_extra_bad_format( + changelog_tpl: Path, + extra: str, + util: UtilFixture, +): + changelog_tpl.write_text("") + util.create_file_and_commit("feat: new file") + with pytest.raises(InvalidCommandArgumentError): + util.run_cli("changelog", "-e", extra) + + +def test_export_changelog_template_from_default( + any_changelog_format: ChangelogFormat, + util: UtilFixture, + changelog_jinja_file: Path, + repo_root: Path, +): + src = repo_root / "commitizen" / "templates" / any_changelog_format.template + + util.run_cli("changelog", "--export-template", str(changelog_jinja_file)) + + assert changelog_jinja_file.exists() + assert changelog_jinja_file.read_text() == src.read_text() + + +def test_export_changelog_template_from_plugin( + changelog_jinja_file: Path, + mock_plugin: BaseCommitizen, + changelog_format: ChangelogFormat, + tmp_path: Path, + util: UtilFixture, +): + src = tmp_path / changelog_format.template + tpl = "I am a custom template" + src.write_text(tpl) + mock_plugin.template_loader = FileSystemLoader(tmp_path) + + util.run_cli("changelog", "--export-template", str(changelog_jinja_file)) + + assert changelog_jinja_file.exists() + assert changelog_jinja_file.read_text() == tpl + + +def test_export_changelog_template_fails_when_template_has_no_filename( + mocker: MockFixture, + changelog_jinja_file: Path, + util: UtilFixture, +): + # Mock a template object with no filename + class FakeTemplate: + filename = None + + # Patch get_changelog_template to return a template without a filename + mocker.patch( + "commitizen.changelog.get_changelog_template", return_value=FakeTemplate() + ) + + with pytest.raises(NotAllowed) as exc_info: + util.run_cli("changelog", "--export-template", str(changelog_jinja_file)) + + assert not changelog_jinja_file.exists() + assert "Template filename is not set" in str(exc_info.value) + + +def test_changelog_template_incremental_variable( + tmp_commitizen_project: Path, + any_changelog_format: ChangelogFormat, + util: UtilFixture, + file_regression: FileRegressionFixture, +): + """ + Test that the changelog template is not rendered when the incremental flag is not set. + Reference: https://github.com/commitizen-tools/commitizen/discussions/1620 + """ + project_root = tmp_commitizen_project + changelog_tpl = project_root / any_changelog_format.template + changelog_tpl.write_text( + dedent(""" + {% if not incremental %} + # CHANGELOG + {% endif %} + + {% for entry in tree %} + + ## {{ entry.version }}{% if entry.date %} ({{ entry.date }}){% endif %} + + {% for change_key, changes in entry.changes.items() %} + + {% if change_key %} + ### {{ change_key }} + {% endif %} + + {% for change in changes %} + {% if change.scope %} + - **{{ change.scope }}**: {{ change.message }} + {% elif change.message %} + - {{ change.message }} + {% endif %} + {% endfor %} + {% endfor %} + {% endfor %} + """) + ) + target = "CHANGELOG.md" + + util.create_file_and_commit("feat(foo): new file") + util.run_cli("changelog", "--file-name", target) + out = Path(target).read_text(encoding="utf-8") + file_regression.check(out, extension=".md") + + util.create_file_and_commit("refactor(bar): another new file") + util.run_cli("changelog", "--file-name", target, "--incremental") + out = Path(target).read_text(encoding="utf-8") + file_regression.check(out, extension=".incremental.md") diff --git a/tests/commands/test_changelog_command/test_breaking_change_content_v1.md b/tests/commands/test_changelog_command/test_breaking_change_content_v1.md new file mode 100644 index 0000000000..c4809739a9 --- /dev/null +++ b/tests/commands/test_changelog_command/test_breaking_change_content_v1.md @@ -0,0 +1,10 @@ +## Unreleased + +### BREAKING CHANGE + +- migrate by renaming user to users + +### Feat + +- **users**: email pattern corrected + diff --git a/tests/commands/test_changelog_command/test_breaking_change_content_v1_beta_feat_users___email_pattern_corrected_n_nBREAKING_CHANGE__migrate_by_renaming_user_to_users_n_nfooter_content_.md b/tests/commands/test_changelog_command/test_breaking_change_content_v1_beta_feat_users___email_pattern_corrected_n_nBREAKING_CHANGE__migrate_by_renaming_user_to_users_n_nfooter_content_.md new file mode 100644 index 0000000000..c4809739a9 --- /dev/null +++ b/tests/commands/test_changelog_command/test_breaking_change_content_v1_beta_feat_users___email_pattern_corrected_n_nBREAKING_CHANGE__migrate_by_renaming_user_to_users_n_nfooter_content_.md @@ -0,0 +1,10 @@ +## Unreleased + +### BREAKING CHANGE + +- migrate by renaming user to users + +### Feat + +- **users**: email pattern corrected + diff --git a/tests/commands/test_changelog_command/test_breaking_change_content_v1_beta_feat_users___email_pattern_corrected_n_nbody_content_n_nBREAKING_CHANGE__migrate_by_renaming_user_to_users_.md b/tests/commands/test_changelog_command/test_breaking_change_content_v1_beta_feat_users___email_pattern_corrected_n_nbody_content_n_nBREAKING_CHANGE__migrate_by_renaming_user_to_users_.md new file mode 100644 index 0000000000..c4809739a9 --- /dev/null +++ b/tests/commands/test_changelog_command/test_breaking_change_content_v1_beta_feat_users___email_pattern_corrected_n_nbody_content_n_nBREAKING_CHANGE__migrate_by_renaming_user_to_users_.md @@ -0,0 +1,10 @@ +## Unreleased + +### BREAKING CHANGE + +- migrate by renaming user to users + +### Feat + +- **users**: email pattern corrected + diff --git a/tests/commands/test_changelog_command/test_breaking_change_content_v1_multiline.md b/tests/commands/test_changelog_command/test_breaking_change_content_v1_multiline.md new file mode 100644 index 0000000000..7becef3dc3 --- /dev/null +++ b/tests/commands/test_changelog_command/test_breaking_change_content_v1_multiline.md @@ -0,0 +1,11 @@ +## Unreleased + +### BREAKING CHANGE + +- migrate by renaming user to users. +and then connect the thingy with the other thingy + +### Feat + +- **users**: email pattern corrected + diff --git a/tests/commands/test_changelog_command/test_breaking_change_content_v1_with_exclamation_mark.md b/tests/commands/test_changelog_command/test_breaking_change_content_v1_with_exclamation_mark.md new file mode 100644 index 0000000000..d12d780dab --- /dev/null +++ b/tests/commands/test_changelog_command/test_breaking_change_content_v1_with_exclamation_mark.md @@ -0,0 +1,5 @@ +## Unreleased + + +- drop support for py36 + diff --git a/tests/commands/test_changelog_command/test_breaking_change_content_v1_with_exclamation_mark_feat.md b/tests/commands/test_changelog_command/test_breaking_change_content_v1_with_exclamation_mark_feat.md new file mode 100644 index 0000000000..84c23687c4 --- /dev/null +++ b/tests/commands/test_changelog_command/test_breaking_change_content_v1_with_exclamation_mark_feat.md @@ -0,0 +1,6 @@ +## Unreleased + +### Feat + +- **pipeline**: some text with breaking change + diff --git a/tests/commands/test_changelog_command/test_changelog_config_flag_increment.md b/tests/commands/test_changelog_command/test_changelog_config_flag_increment.md new file mode 100644 index 0000000000..5bdace3053 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_config_flag_increment.md @@ -0,0 +1,8 @@ + +note: this should be persisted using increment + +## Unreleased + +### Feat + +- add new output diff --git a/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_alpha_.md b/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_alpha_.md new file mode 100644 index 0000000000..f20281df71 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_alpha_.md @@ -0,0 +1,13 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## 1.0.0 (2025-12-29) diff --git a/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_beta_.md b/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_beta_.md new file mode 100644 index 0000000000..f20281df71 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_beta_.md @@ -0,0 +1,13 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## 1.0.0 (2025-12-29) diff --git a/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_rc_.md b/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_rc_.md new file mode 100644 index 0000000000..f20281df71 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_config_flag_merge_prerelease_rc_.md @@ -0,0 +1,13 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## 1.0.0 (2025-12-29) diff --git a/tests/commands/test_changelog_command/test_changelog_config_start_rev_option.md b/tests/commands/test_changelog_command/test_changelog_config_start_rev_option.md new file mode 100644 index 0000000000..d1baef26aa --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_config_start_rev_option.md @@ -0,0 +1,7 @@ +## Unreleased + +### Feat + +- after 0.2 +- after 0.2.0 + diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_first_version_from_arg.md b/tests/commands/test_changelog_command/test_changelog_from_rev_first_version_from_arg.md new file mode 100644 index 0000000000..3519498ac2 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_first_version_from_arg.md @@ -0,0 +1,5 @@ +## 0.2.0 (2022-02-13) + +### Feat + +- new file diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_latest_version_dry_run.md b/tests/commands/test_changelog_command/test_changelog_from_rev_latest_version_dry_run.md new file mode 100644 index 0000000000..e6531e6b3c --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_latest_version_dry_run.md @@ -0,0 +1,7 @@ +## 0.3.0 (2022-02-13) + +### Feat + +- another feature +- after 0.2.0 + diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_latest_version_from_arg.md b/tests/commands/test_changelog_command/test_changelog_from_rev_latest_version_from_arg.md new file mode 100644 index 0000000000..91880643eb --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_latest_version_from_arg.md @@ -0,0 +1,6 @@ +## 0.3.0 (2022-02-13) + +### Feat + +- another feature +- after 0.2.0 diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_from_arg.md b/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_from_arg.md new file mode 100644 index 0000000000..0c483c740a --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_from_arg.md @@ -0,0 +1,12 @@ +## 0.4.0 (2022-02-13) + +### Feat + +- getting ready for this + +## 0.3.0 (2022-02-13) + +### Feat + +- another feature +- after 0.2.0 diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_including_first_tag.md b/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_including_first_tag.md new file mode 100644 index 0000000000..44bffb319d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_including_first_tag.md @@ -0,0 +1,12 @@ +## 0.3.0 (2022-02-13) + +### Feat + +- another feature +- after 0.2.0 + +## 0.2.0 (2022-02-13) + +### Feat + +- new file diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_with_legacy_tags.md b/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_with_legacy_tags.md new file mode 100644 index 0000000000..5d37333aa5 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_version_range_with_legacy_tags.md @@ -0,0 +1,17 @@ +## legacy-0.4.0 (2022-02-13) + +### Feat + +- new file + +## legacy-0.3.0 (2022-02-13) + +### Feat + +- new file + +## old-0.2.0 (2022-02-13) + +### Feat + +- new file diff --git a/tests/commands/test_changelog_command/test_changelog_from_rev_version_with_big_range_from_arg.md b/tests/commands/test_changelog_command/test_changelog_from_rev_version_with_big_range_from_arg.md new file mode 100644 index 0000000000..376424db3e --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_rev_version_with_big_range_from_arg.md @@ -0,0 +1,24 @@ +## 0.5.0 (2022-02-13) + +### Feat + +- new shinny feature + +## 0.4.1 (2022-02-13) + +### Fix + +- small error + +## 0.4.0 (2022-02-13) + +### Feat + +- getting ready for this + +## 0.3.0 (2022-02-13) + +### Feat + +- another feature +- after 0.2.0 diff --git a/tests/commands/test_changelog_command/test_changelog_from_start_asciidoc_.adoc b/tests/commands/test_changelog_command/test_changelog_from_start_asciidoc_.adoc new file mode 100644 index 0000000000..842e120ba8 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_start_asciidoc_.adoc @@ -0,0 +1,9 @@ +== Unreleased + +=== Feat + +* new file + +=== Refactor + +* is in changelog diff --git a/tests/commands/test_changelog_command/test_changelog_from_start_markdown_.md b/tests/commands/test_changelog_command/test_changelog_from_start_markdown_.md new file mode 100644 index 0000000000..bdc78660d5 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_start_markdown_.md @@ -0,0 +1,9 @@ +## Unreleased + +### Feat + +- new file + +### Refactor + +- is in changelog diff --git a/tests/commands/test_changelog_command/test_changelog_from_start_restructuredtext_.rst b/tests/commands/test_changelog_command/test_changelog_from_start_restructuredtext_.rst new file mode 100644 index 0000000000..555f5bc64d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_start_restructuredtext_.rst @@ -0,0 +1,12 @@ +Unreleased +========== + +Feat +---- + +- new file + +Refactor +-------- + +- is in changelog diff --git a/tests/commands/test_changelog_command/test_changelog_from_start_textile_.textile b/tests/commands/test_changelog_command/test_changelog_from_start_textile_.textile new file mode 100644 index 0000000000..e71fb99cf5 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_start_textile_.textile @@ -0,0 +1,9 @@ +h2. Unreleased + +h3. Feat + +- new file + +h3. Refactor + +- is in changelog diff --git a/tests/commands/test_changelog_command/test_changelog_from_version_zero_point_two.md b/tests/commands/test_changelog_command/test_changelog_from_version_zero_point_two.md new file mode 100644 index 0000000000..d1baef26aa --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_from_version_zero_point_two.md @@ -0,0 +1,7 @@ +## Unreleased + +### Feat + +- after 0.2 +- after 0.2.0 + diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_angular_sample.md b/tests/commands/test_changelog_command/test_changelog_incremental_angular_sample.md new file mode 100644 index 0000000000..83bfdfe852 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_angular_sample.md @@ -0,0 +1,16 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +# [10.0.0-rc.3](https://github.com/angular/angular/compare/10.0.0-rc.2...10.0.0-rc.3) (2020-04-22) + +### Bug Fixes +* **common:** format day-periods that cross midnight ([#36611](https://github.com/angular/angular/issues/36611)) ([c6e5fc4](https://github.com/angular/angular/commit/c6e5fc4)), closes [#36566](https://github.com/angular/angular/issues/36566) diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_change_tag_format.md b/tests/commands/test_changelog_command/test_changelog_incremental_change_tag_format.md new file mode 100644 index 0000000000..2f0cc2909e --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_change_tag_format.md @@ -0,0 +1,17 @@ +## v0.3.0 (2024-11-18) + +### Feat + +- another new file + +## older-0.2.0 (2024-11-18) + +### Feat + +- new file + +## older-0.1.0 (2024-11-18) + +### Feat + +- new file diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_keep_a_changelog_sample.md b/tests/commands/test_changelog_command/test_changelog_incremental_keep_a_changelog_sample.md new file mode 100644 index 0000000000..56e2cf81f5 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_keep_a_changelog_sample.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_keep_a_changelog_sample_with_annotated_tag.md b/tests/commands/test_changelog_command/test_changelog_incremental_keep_a_changelog_sample_with_annotated_tag.md new file mode 100644 index 0000000000..56e2cf81f5 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_keep_a_changelog_sample_with_annotated_tag.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_newline_separates_new_content_from_old.md b/tests/commands/test_changelog_command/test_changelog_incremental_newline_separates_new_content_from_old.md new file mode 100644 index 0000000000..788105a3f6 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_newline_separates_new_content_from_old.md @@ -0,0 +1,7 @@ +Pre-existing content that should be kept + +## Unreleased + +### Feat + +- add more cat videos diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_alpha_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_alpha_.md new file mode 100644 index 0000000000..8e81f62572 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_alpha_.md @@ -0,0 +1,37 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work +- output glitch + +## 0.2.0a0 (2023-04-16) + +### Feat + +- add new output + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_beta_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_beta_.md new file mode 100644 index 0000000000..65f14c068e --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_beta_.md @@ -0,0 +1,37 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work +- output glitch + +## 0.2.0b0 (2023-04-16) + +### Feat + +- add new output + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_rc_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_rc_.md new file mode 100644 index 0000000000..0987e1127d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_merge_prerelease_rc_.md @@ -0,0 +1,37 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work +- output glitch + +## 0.2.0rc0 (2023-04-16) + +### Feat + +- add new output + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_alpha_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_alpha_.md new file mode 100644 index 0000000000..cfaca36ab9 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_alpha_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0a1 (2021-06-11) + +## 0.2.0a0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_beta_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_beta_.md new file mode 100644 index 0000000000..013e16fc22 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_beta_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0b0 (2021-06-11) + +## 0.2.0a0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_rc_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_rc_.md new file mode 100644 index 0000000000..25cc27682b --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_alpha_rc_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0rc0 (2021-06-11) + +## 0.2.0a0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_alpha_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_alpha_.md new file mode 100644 index 0000000000..ec9ab11d7b --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_alpha_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0b1 (2021-06-11) + +## 0.2.0b0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_beta_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_beta_.md new file mode 100644 index 0000000000..ec9ab11d7b --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_beta_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0b1 (2021-06-11) + +## 0.2.0b0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_rc_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_rc_.md new file mode 100644 index 0000000000..22b1e14dba --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_beta_rc_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0rc0 (2021-06-11) + +## 0.2.0b0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_alpha_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_alpha_.md new file mode 100644 index 0000000000..e1c20b7e0d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_alpha_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0rc1 (2021-06-11) + +## 0.2.0rc0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_beta_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_beta_.md new file mode 100644 index 0000000000..e1c20b7e0d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_beta_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0rc1 (2021-06-11) + +## 0.2.0rc0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_rc_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_rc_.md new file mode 100644 index 0000000000..e1c20b7e0d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_prerelease_version_to_prerelease_version_rc_rc_.md @@ -0,0 +1,32 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## 0.2.0rc1 (2021-06-11) + +## 0.2.0rc0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_alpha_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_alpha_.md new file mode 100644 index 0000000000..9a598e69c8 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_alpha_.md @@ -0,0 +1,40 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work + +## 0.2.0a0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_beta_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_beta_.md new file mode 100644 index 0000000000..1f8de4f8f0 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_beta_.md @@ -0,0 +1,40 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work + +## 0.2.0b0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_rc_.md b/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_rc_.md new file mode 100644 index 0000000000..3ba4eb2d36 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_incremental_with_release_candidate_version_rc_.md @@ -0,0 +1,40 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work + +## 0.2.0rc0 (2021-06-11) + +### Feat + +- add new output + +### Fix + +- output glitch + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. + +### Changed +- Start using "changelog" over "change log" since it's the common usage. + +### Removed +- Section about "changelog" vs "CHANGELOG". + +## [0.3.0] - 2015-12-03 +### Added +- RU translation from [@aishek](https://github.com/aishek). diff --git a/tests/commands/test_changelog_command/test_changelog_is_persisted_using_incremental.md b/tests/commands/test_changelog_command/test_changelog_is_persisted_using_incremental.md new file mode 100644 index 0000000000..721d11d8cb --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_is_persisted_using_incremental.md @@ -0,0 +1,21 @@ +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work + +## 0.2.0 (2022-08-14) + +### Feat + +- add new output + +### Fix + +- output glitch + +note: this should be persisted using increment diff --git a/tests/commands/test_changelog_command/test_changelog_multiple_incremental_do_not_add_new_lines.md b/tests/commands/test_changelog_command/test_changelog_multiple_incremental_do_not_add_new_lines.md new file mode 100644 index 0000000000..85834c2d38 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_multiple_incremental_do_not_add_new_lines.md @@ -0,0 +1,11 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- no more explosions +- output glitch diff --git a/tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_scheme_semver.md b/tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_scheme_semver.md new file mode 100644 index 0000000000..9a66210a74 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_scheme_semver.md @@ -0,0 +1,7 @@ +## 0.3.0-a0 (2022-02-13) + +### Feat + +- another feature +- after 0.2.0 + diff --git a/tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_scheme_semver.second-prerelease.md b/tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_scheme_semver.second-prerelease.md new file mode 100644 index 0000000000..09fd10ee8d --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_prerelease_rev_with_use_scheme_semver.second-prerelease.md @@ -0,0 +1,2 @@ +## 0.3.0-a1 (2022-02-13) + diff --git a/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_alpha_.md b/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_alpha_.md new file mode 100644 index 0000000000..f20281df71 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_alpha_.md @@ -0,0 +1,13 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## 1.0.0 (2025-12-29) diff --git a/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_beta_.md b/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_beta_.md new file mode 100644 index 0000000000..f20281df71 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_beta_.md @@ -0,0 +1,13 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## 1.0.0 (2025-12-29) diff --git a/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_rc_.md b/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_rc_.md new file mode 100644 index 0000000000..f20281df71 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_release_candidate_version_with_merge_prerelease_rc_.md @@ -0,0 +1,13 @@ +## Unreleased + +### Feat + +- add more stuff +- add new output + +### Fix + +- mama gotta work +- output glitch + +## 1.0.0 (2025-12-29) diff --git a/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_asciidoc_.adoc b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_asciidoc_.adoc new file mode 100644 index 0000000000..2e789bcf2f --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_asciidoc_.adoc @@ -0,0 +1,19 @@ +== Unreleased + +=== Feat + +* add more stuff + +=== Fix + +* mama gotta work + +== 0.2.0 (2022-08-14) + +=== Feat + +* add new output + +=== Fix + +* output glitch diff --git a/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_markdown_.md b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_markdown_.md new file mode 100644 index 0000000000..8fca3c6b5e --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_markdown_.md @@ -0,0 +1,19 @@ +## Unreleased + +### Feat + +- add more stuff + +### Fix + +- mama gotta work + +## 0.2.0 (2022-08-14) + +### Feat + +- add new output + +### Fix + +- output glitch diff --git a/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_restructuredtext_.rst b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_restructuredtext_.rst new file mode 100644 index 0000000000..ca0077a2d8 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_restructuredtext_.rst @@ -0,0 +1,25 @@ +Unreleased +========== + +Feat +---- + +- add more stuff + +Fix +--- + +- mama gotta work + +0.2.0 (2022-08-14) +================== + +Feat +---- + +- add new output + +Fix +--- + +- output glitch diff --git a/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_textile_.textile b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_textile_.textile new file mode 100644 index 0000000000..07f2ba5ed0 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_replacing_unreleased_using_incremental_textile_.textile @@ -0,0 +1,19 @@ +h2. Unreleased + +h3. Feat + +- add more stuff + +h3. Fix + +- mama gotta work + +h2. 0.2.0 (2022-08-14) + +h3. Feat + +- add new output + +h3. Fix + +- output glitch diff --git a/tests/commands/test_changelog_command/test_changelog_template_incremental_variable.incremental.md b/tests/commands/test_changelog_command/test_changelog_template_incremental_variable.incremental.md new file mode 100644 index 0000000000..4a851c6627 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_template_incremental_variable.incremental.md @@ -0,0 +1,12 @@ +# CHANGELOG + + +## Unreleased + +### Feat + +- **foo**: new file + +### Refactor + +- **bar**: another new file diff --git a/tests/commands/test_changelog_command/test_changelog_template_incremental_variable.md b/tests/commands/test_changelog_command/test_changelog_template_incremental_variable.md new file mode 100644 index 0000000000..7c9034d27a --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_template_incremental_variable.md @@ -0,0 +1,8 @@ +# CHANGELOG + + +## Unreleased + +### Feat + +- **foo**: new file diff --git a/tests/commands/test_changelog_command/test_changelog_with_customized_change_type_order.md b/tests/commands/test_changelog_command/test_changelog_with_customized_change_type_order.md new file mode 100644 index 0000000000..358908ea29 --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_with_customized_change_type_order.md @@ -0,0 +1,20 @@ +## 0.4.0 (2022-02-13) + +### Perf + +- perf improvement + +### Feat + +- getting ready for this + +## 0.3.0 (2022-02-13) + +### Fix + +- fix bug + +### Feat + +- another feature +- after 0.2.0 diff --git a/tests/commands/test_changelog_command/test_changelog_with_different_cz.md b/tests/commands/test_changelog_command/test_changelog_with_different_cz.md new file mode 100644 index 0000000000..e9d306236a --- /dev/null +++ b/tests/commands/test_changelog_command/test_changelog_with_different_cz.md @@ -0,0 +1,6 @@ +## Unreleased + + +- JRA-35 #time 1w 2d 4h 30m Total work logged +- JRA-34 #comment corrected indent issue + diff --git a/tests/commands/test_changelog_command/test_invalid_subject_is_skipped.md b/tests/commands/test_changelog_command/test_invalid_subject_is_skipped.md new file mode 100644 index 0000000000..d24ea7ba7c --- /dev/null +++ b/tests/commands/test_changelog_command/test_invalid_subject_is_skipped.md @@ -0,0 +1,6 @@ +## Unreleased + +### Feat + +- a new world + diff --git a/tests/commands/test_check_command.py b/tests/commands/test_check_command.py new file mode 100644 index 0000000000..f3f860313d --- /dev/null +++ b/tests/commands/test_check_command.py @@ -0,0 +1,450 @@ +from __future__ import annotations + +from io import StringIO +from typing import TYPE_CHECKING, Any + +import pytest + +from commitizen import commands, git +from commitizen.cz import registry +from commitizen.cz.base import BaseCommitizen +from commitizen.exceptions import ( + CommitMessageLengthExceededError, + InvalidCommandArgumentError, + InvalidCommitMessageError, + NoCommitsFoundError, +) + +if TYPE_CHECKING: + from collections.abc import Mapping + + from pytest_mock import MockFixture, MockType + + from commitizen.config.base_config import BaseConfig + from commitizen.question import CzQuestion + from tests.utils import UtilFixture + + +COMMIT_LOG = [ + "refactor: A code change that neither fixes a bug nor adds a feature", + r"refactor(cz/conventional_commit): use \S to check scope", + "refactor(git): remove unnecessary dot between git range", + "bump: version 1.16.3 → 1.16.4", + ( + "Merge pull request #139 from Lee-W/fix-init-clean-config-file\n\n" + "Fix init clean config file" + ), + "ci(pyproject.toml): add configuration for coverage", + "fix(commands/init): fix clean up file when initialize commitizen config\n\n#138", + "refactor(defaults): split config files into long term support and deprecated ones", + "bump: version 1.16.2 → 1.16.3", + ( + "Merge pull request #136 from Lee-W/remove-redundant-readme\n\n" + "Remove redundant readme" + ), + "fix: replace README.rst with docs/README.md in config files", + ( + "refactor(docs): remove README.rst and use docs/README.md\n\n" + "By removing README.rst, we no longer need to maintain " + "two document with almost the same content\n" + "Github can read docs/README.md as README for the project." + ), + "docs(check): pin pre-commit to v1.16.2", + "docs(check): fix pre-commit setup", + "bump: version 1.16.1 → 1.16.2", + "Merge pull request #135 from Lee-W/fix-pre-commit-hook\n\nFix pre commit hook", + "docs(check): enforce cz check only when committing", + ( + 'Revert "fix(pre-commit): set pre-commit check stage to commit-msg"\n\n' + "This reverts commit afc70133e4a81344928561fbf3bb20738dfc8a0b." + ), + "feat!: add user stuff", + "fixup! test(commands): ignore fixup! prefix", + "fixup! test(commands): ignore squash! prefix", +] + + +def _build_fake_git_commits(commit_msgs: list[str]) -> list[git.GitCommit]: + return [git.GitCommit("test_rev", commit_msg) for commit_msg in commit_msgs] + + +def test_check_jira_fails(mocker: MockFixture, util: UtilFixture): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = ( + "random message for J-2 #fake_command blah" + ) + with pytest.raises(InvalidCommitMessageError) as excinfo: + util.run_cli("-n", "cz_jira", "check", "--commit-msg-file", "some_file") + assert "commit validation: failed!" in str(excinfo.value) + + +@pytest.mark.parametrize( + "commit_msg", + [ + "JR-23 #command some arguments etc", + "JR-2 #command some arguments etc", + "JR-234 some text #command some arguments etc", + "JRA-23 some text #command1 args #command2 args", + ], +) +def test_check_jira_command_after_issue( + mocker: MockFixture, capsys, util: UtilFixture, commit_msg: str +): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = commit_msg + util.run_cli("-n", "cz_jira", "check", "--commit-msg-file", "some_file") + out, _ = capsys.readouterr() + assert "Commit validation: successful!" in out + + +def test_check_conventional_commit_succeeds( + mocker: MockFixture, capsys, util: UtilFixture +): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = "fix(scope): some commit message" + util.run_cli("check", "--commit-msg-file", "some_file") + out, _ = capsys.readouterr() + assert "Commit validation: successful!" in out + + +@pytest.mark.parametrize( + "commit_msg", + [ + "feat!(lang): removed polish language", + "no conventional commit", + ( + "ci: check commit message on merge\n" + "testing with more complex commit mes\n\n" + "age with error" + ), + ], +) +def test_check_no_conventional_commit(commit_msg, config, tmp_path): + tempfile = tmp_path / "temp_commit_file" + tempfile.write_text(commit_msg) + + with pytest.raises(InvalidCommitMessageError): + commands.Check(config=config, arguments={"commit_msg_file": tempfile})() + + +@pytest.mark.parametrize( + "commit_msg", + [ + "feat(lang)!: removed polish language", + "feat(lang): added polish language", + "feat: add polish language", + "bump: 0.0.1 -> 1.0.0", + ], +) +def test_check_conventional_commit( + commit_msg, config, success_mock: MockType, tmp_path +): + tempfile = tmp_path / "temp_commit_file" + tempfile.write_text(commit_msg) + commands.Check(config=config, arguments={"commit_msg_file": tempfile})() + success_mock.assert_called_once() + + +def test_check_command_when_commit_file_not_found(config): + with pytest.raises(FileNotFoundError): + commands.Check(config=config, arguments={"commit_msg_file": "no_such_file"})() + + +def test_check_a_range_of_git_commits( + config, success_mock: MockType, mocker: MockFixture +): + mocker.patch( + "commitizen.git.get_commits", return_value=_build_fake_git_commits(COMMIT_LOG) + ) + + commands.Check(config=config, arguments={"rev_range": "HEAD~10..master"})() + success_mock.assert_called_once() + + +def test_check_a_range_of_git_commits_and_failed(config, mocker: MockFixture): + mocker.patch( + "commitizen.git.get_commits", + return_value=_build_fake_git_commits(["This commit does not follow rule"]), + ) + + with pytest.raises(InvalidCommitMessageError) as excinfo: + commands.Check(config=config, arguments={"rev_range": "HEAD~10..master"})() + assert "This commit does not follow rule" in str(excinfo.value) + + +def test_check_command_with_invalid_argument(config): + with pytest.raises(InvalidCommandArgumentError) as excinfo: + commands.Check( + config=config, + arguments={"commit_msg_file": "some_file", "rev_range": "HEAD~10..master"}, + ) + assert ( + "Only one of --rev-range, --message, and --commit-msg-file is permitted by check command!" + in str(excinfo.value) + ) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_check_command_with_empty_range(config: BaseConfig, util: UtilFixture): + # must initialize git with a commit + util.create_file_and_commit("feat: initial") + with pytest.raises(NoCommitsFoundError) as excinfo: + commands.Check(config=config, arguments={"rev_range": "master..master"})() + assert "No commit found with range: 'master..master'" in str(excinfo) + + +def test_check_a_range_of_failed_git_commits(config, mocker: MockFixture): + ill_formatted_commits_msgs = [ + "First commit does not follow rule", + "Second commit does not follow rule", + ("Third commit does not follow rule\nIll-formatted commit with body"), + ] + mocker.patch( + "commitizen.git.get_commits", + return_value=_build_fake_git_commits(ill_formatted_commits_msgs), + ) + + with pytest.raises(InvalidCommitMessageError) as excinfo: + commands.Check(config=config, arguments={"rev_range": "HEAD~10..master"})() + assert all([msg in str(excinfo.value) for msg in ill_formatted_commits_msgs]) + + +def test_check_command_with_valid_message(config, success_mock: MockType): + commands.Check( + config=config, arguments={"message": "fix(scope): some commit message"} + )() + success_mock.assert_called_once() + + +@pytest.mark.parametrize("message", ["bad commit", ""]) +def test_check_command_with_invalid_message(config, message): + with pytest.raises(InvalidCommitMessageError): + commands.Check(config=config, arguments={"message": message})() + + +def test_check_command_with_allow_abort_arg(config, success_mock): + commands.Check(config=config, arguments={"message": "", "allow_abort": True})() + success_mock.assert_called_once() + + +def test_check_command_with_allow_abort_config(config, success_mock): + config.settings["allow_abort"] = True + commands.Check(config=config, arguments={"message": ""})() + success_mock.assert_called_once() + + +def test_check_command_override_allow_abort_config(config): + config.settings["allow_abort"] = True + with pytest.raises(InvalidCommitMessageError): + commands.Check(config=config, arguments={"message": "", "allow_abort": False})() + + +def test_check_command_with_allowed_prefixes_arg(config, success_mock): + commands.Check( + config=config, + arguments={"message": "custom! test", "allowed_prefixes": ["custom!"]}, + )() + success_mock.assert_called_once() + + +def test_check_command_with_allowed_prefixes_config(config, success_mock): + config.settings["allowed_prefixes"] = ["custom!"] + commands.Check(config=config, arguments={"message": "custom! test"})() + success_mock.assert_called_once() + + +def test_check_command_override_allowed_prefixes_config(config): + config.settings["allow_abort"] = ["fixup!"] + with pytest.raises(InvalidCommitMessageError): + commands.Check( + config=config, + arguments={"message": "fixup! test", "allowed_prefixes": ["custom!"]}, + )() + + +def test_check_command_with_pipe_message( + mocker: MockFixture, capsys, util: UtilFixture +): + mocker.patch("sys.stdin", StringIO("fix(scope): some commit message")) + + util.run_cli("check") + out, _ = capsys.readouterr() + assert "Commit validation: successful!" in out + + +def test_check_command_with_pipe_message_and_failed( + mocker: MockFixture, util: UtilFixture +): + mocker.patch("sys.stdin", StringIO("bad commit message")) + + with pytest.raises(InvalidCommitMessageError) as excinfo: + util.run_cli("check") + assert "commit validation: failed!" in str(excinfo.value) + + +def test_check_command_with_comment_in_message_file( + mocker: MockFixture, capsys, util: UtilFixture +): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = ( + "# <type>: (If applied, this commit will...) <subject>\n" + "# |<---- Try to Limit to a Max of 50 char ---->|\n" + "ci: add commitizen pre-commit hook\n" + "\n" + "# Explain why this change is being made\n" + "# |<---- Try To Limit Each Line to a Max Of 72 Char ---->|\n" + "This pre-commit hook will check our commits automatically." + ) + util.run_cli("check", "--commit-msg-file", "some_file") + out, _ = capsys.readouterr() + assert "Commit validation: successful!" in out + + +def test_check_conventional_commit_succeed_with_git_diff( + mocker, capsys, util: UtilFixture +): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = ( + "feat: This is a test commit\n" + "# Please enter the commit message for your changes. Lines starting\n" + "# with '#' will be ignored, and an empty message aborts the commit.\n" + "#\n" + "# On branch ...\n" + "# Changes to be committed:\n" + "# modified: ...\n" + "#\n" + "# ------------------------ >8 ------------------------\n" + "# Do not modify or remove the line above.\n" + "# Everything below it will be ignored.\n" + "diff --git a/... b/...\n" + "index f1234c..1c5678 1234\n" + "--- a/...\n" + "+++ b/...\n" + "@@ -92,3 +92,4 @@ class Command(BaseCommand):\n" + '+ "this is a test"\n' + ) + util.run_cli("check", "--commit-msg-file", "some_file") + out, _ = capsys.readouterr() + assert "Commit validation: successful!" in out + + +def test_check_command_with_message_length_limit(config, success_mock): + message = "fix(scope): some commit message" + commands.Check( + config=config, + arguments={"message": message, "message_length_limit": len(message) + 1}, + )() + success_mock.assert_called_once() + + +def test_check_command_with_message_length_limit_exceeded(config): + message = "fix(scope): some commit message" + with pytest.raises(CommitMessageLengthExceededError): + commands.Check( + config=config, + arguments={"message": message, "message_length_limit": len(message) - 1}, + )() + + +def test_check_command_with_amend_prefix_default(config, success_mock): + commands.Check(config=config, arguments={"message": "amend! test"})() + success_mock.assert_called_once() + + +def test_check_command_with_config_message_length_limit(config, success_mock): + message = "fix(scope): some commit message" + config.settings["message_length_limit"] = len(message) + 1 + commands.Check( + config=config, + arguments={"message": message}, + )() + success_mock.assert_called_once() + + +def test_check_command_with_config_message_length_limit_exceeded(config): + message = "fix(scope): some commit message" + config.settings["message_length_limit"] = len(message) - 1 + with pytest.raises(CommitMessageLengthExceededError): + commands.Check( + config=config, + arguments={"message": message}, + )() + + +def test_check_command_cli_overrides_config_message_length_limit( + config, success_mock: MockType +): + message = "fix(scope): some commit message" + config.settings["message_length_limit"] = len(message) - 1 + for message_length_limit in [len(message) + 1, 0]: + success_mock.reset_mock() + commands.Check( + config=config, + arguments={ + "message": message, + "message_length_limit": message_length_limit, + }, + )() + success_mock.assert_called_once() + + +class ValidationCz(BaseCommitizen): + def questions(self) -> list[CzQuestion]: + return [ + {"type": "input", "name": "commit", "message": "Initial commit:\n"}, + {"type": "input", "name": "issue_nb", "message": "ABC-123"}, + ] + + def message(self, answers: Mapping[str, Any]) -> str: + return f"{answers['issue_nb']}: {answers['commit']}" + + def schema(self) -> str: + return "<issue_nb>: <commit>" + + def schema_pattern(self) -> str: + return r"^(?P<issue_nb>[A-Z]{3}-\d+): (?P<commit>.*)$" + + def example(self) -> str: + return "ABC-123: fixed a bug" + + def info(self) -> str: + return "Commit message must start with an issue number like ABC-123" + + +@pytest.fixture +def use_cz_custom_validator(mocker): + new_cz = {**registry, "cz_custom_validator": ValidationCz} + mocker.patch.dict("commitizen.cz.registry", new_cz) + + +@pytest.mark.usefixtures("use_cz_custom_validator") +def test_check_command_with_custom_validator_succeed( + mocker: MockFixture, capsys, util: UtilFixture +): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = ( + "ABC-123: add commitizen pre-commit hook" + ) + util.run_cli( + "--name", "cz_custom_validator", "check", "--commit-msg-file", "some_file" + ) + out, _ = capsys.readouterr() + assert "Commit validation: successful!" in out + + +@pytest.mark.usefixtures("use_cz_custom_validator") +def test_check_command_with_custom_validator_failed( + mocker: MockFixture, util: UtilFixture +): + mock_path = mocker.patch("commitizen.commands.check.Path") + mock_path.return_value.read_text.return_value = ( + "123-ABC issue id has wrong format and misses colon" + ) + with pytest.raises(InvalidCommitMessageError) as excinfo: + util.run_cli( + "--name", "cz_custom_validator", "check", "--commit-msg-file", "some_file" + ) + assert "commit validation: failed!" in str(excinfo.value), ( + "Pattern validation unexpectedly passed" + ) + assert "pattern: " in str(excinfo.value), "Pattern not found in error message" diff --git a/tests/commands/test_commit_command.py b/tests/commands/test_commit_command.py new file mode 100644 index 0000000000..2322cb3cb6 --- /dev/null +++ b/tests/commands/test_commit_command.py @@ -0,0 +1,369 @@ +from pathlib import Path +from unittest.mock import ANY + +import pytest +from pytest_mock import MockFixture, MockType + +from commitizen import cmd, commands +from commitizen.cz.exceptions import CzException +from commitizen.cz.utils import get_backup_file_path +from commitizen.exceptions import ( + CommitError, + CommitMessageLengthExceededError, + CustomError, + DryRunExit, + NoAnswersError, + NoCommitBackupError, + NotAGitProjectError, + NotAllowed, + NothingToCommitError, +) + + +@pytest.fixture +def commit_mock(mocker: MockFixture): + return mocker.patch( + "commitizen.git.commit", return_value=cmd.Command("success", "", b"", b"", 0) + ) + + +@pytest.fixture +def prompt_mock_feat(mocker: MockFixture): + return mocker.patch( + "questionary.prompt", + return_value={ + "prefix": "feat", + "subject": "user created", + "scope": "", + "is_breaking_change": False, + "body": "closes #21", + "footer": "", + }, + ) + + +@pytest.fixture +def staging_is_clean(mocker: MockFixture, tmp_git_project): + mocker.patch("commitizen.git.is_staging_clean", return_value=False) + return tmp_git_project + + +@pytest.fixture +def backup_file(tmp_git_project, monkeypatch): + """Write backup message so Commit finds it when run from tmp_git_project.""" + monkeypatch.chdir(tmp_git_project) + path = get_backup_file_path() + path.write_text("backup commit", encoding="utf-8") + + +@pytest.mark.usefixtures("staging_is_clean", "commit_mock", "prompt_mock_feat") +def test_commit(config, success_mock: MockType): + commands.Commit(config, {})() + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_backup_on_failure( + config, mocker: MockFixture, prompt_mock_feat: MockType +): + mocker.patch( + "commitizen.git.commit", return_value=cmd.Command("", "error", b"", b"", 9) + ) + error_mock = mocker.patch("commitizen.out.error") + + commit_cmd = commands.Commit(config, {}) + temp_file = commit_cmd.backup_file_path + with pytest.raises(CommitError): + commit_cmd() + + prompt_mock_feat.assert_called_once() + error_mock.assert_called_once() + assert Path(temp_file).exists() + + +@pytest.mark.usefixtures("staging_is_clean", "commit_mock") +def test_commit_retry_fails_no_backup(config): + with pytest.raises(NoCommitBackupError) as excinfo: + commands.Commit(config, {"retry": True})() + + assert NoCommitBackupError.message in str(excinfo.value) + + +@pytest.mark.usefixtures("staging_is_clean", "backup_file") +def test_commit_retry_works( + config, success_mock: MockType, mocker: MockFixture, commit_mock: MockType +): + prompt_mock = mocker.patch("questionary.prompt") + + commit_cmd = commands.Commit(config, {"retry": True}) + temp_file = commit_cmd.backup_file_path + commit_cmd() + + commit_mock.assert_called_with("backup commit", args="") + prompt_mock.assert_not_called() + success_mock.assert_called_once() + assert not Path(temp_file).exists() + + +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_retry_after_failure_no_backup( + config, success_mock: MockType, commit_mock: MockType, prompt_mock_feat: MockType +): + config.settings["retry_after_failure"] = True + commands.Commit(config, {})() + + commit_mock.assert_called_with("feat: user created\n\ncloses #21", args="") + prompt_mock_feat.assert_called_once() + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean", "backup_file") +def test_commit_retry_after_failure_works( + config, success_mock: MockType, mocker: MockFixture, commit_mock: MockType +): + prompt_mock = mocker.patch("questionary.prompt") + + config.settings["retry_after_failure"] = True + commit_cmd = commands.Commit(config, {}) + temp_file = commit_cmd.backup_file_path + commit_cmd() + + commit_mock.assert_called_with("backup commit", args="") + prompt_mock.assert_not_called() + success_mock.assert_called_once() + assert not Path(temp_file).exists() + + +@pytest.mark.usefixtures("staging_is_clean", "backup_file") +def test_commit_retry_after_failure_with_no_retry_works( + config, success_mock: MockType, commit_mock: MockType, prompt_mock_feat: MockType +): + config.settings["retry_after_failure"] = True + commit_cmd = commands.Commit(config, {"no_retry": True}) + temp_file = commit_cmd.backup_file_path + commit_cmd() + + commit_mock.assert_called_with("feat: user created\n\ncloses #21", args="") + prompt_mock_feat.assert_called_once() + success_mock.assert_called_once() + assert not Path(temp_file).exists() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_command_with_dry_run_option(config): + with pytest.raises(DryRunExit): + commands.Commit(config, {"dry_run": True})() + + +@pytest.mark.usefixtures("staging_is_clean", "commit_mock", "prompt_mock_feat") +def test_commit_command_with_write_message_to_file_option( + config, tmp_path, success_mock: MockType +): + tmp_file = tmp_path / "message" + commands.Commit(config, {"write_message_to_file": tmp_file})() + success_mock.assert_called_once() + assert tmp_file.exists() + assert "feat: user created" in tmp_file.read_text() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_command_with_invalid_write_message_to_file_option(config, tmp_path): + with pytest.raises(NotAllowed): + commands.Commit(config, {"write_message_to_file": tmp_path})() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_command_with_signoff_option( + config, success_mock: MockType, commit_mock: MockType +): + commands.Commit(config, {"signoff": True})() + + commit_mock.assert_called_once_with(ANY, args="-s") + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_command_with_always_signoff_enabled( + config, success_mock: MockType, commit_mock: MockType +): + config.settings["always_signoff"] = True + commands.Commit(config, {})() + + commit_mock.assert_called_once_with(ANY, args="-s") + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_command_with_gpgsign_and_always_signoff_enabled( + config, success_mock: MockType, commit_mock: MockType +): + config.settings["always_signoff"] = True + commands.Commit(config, {"extra_cli_args": "-S"})() + + commit_mock.assert_called_once_with(ANY, args="-S -s") + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("tmp_git_project") +def test_commit_when_nothing_to_commit(config, mocker: MockFixture): + mocker.patch("commitizen.git.is_staging_clean", return_value=True) + + with pytest.raises(NothingToCommitError) as excinfo: + commands.Commit(config, {})() + + assert "No files added to staging!" in str(excinfo.value) + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_with_allow_empty(config, success_mock: MockType, commit_mock: MockType): + commands.Commit(config, {"extra_cli_args": "--allow-empty"})() + commit_mock.assert_called_with( + "feat: user created\n\ncloses #21", args="--allow-empty" + ) + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_with_signoff_and_allow_empty( + config, success_mock: MockType, commit_mock: MockType +): + config.settings["always_signoff"] = True + commands.Commit(config, {"extra_cli_args": "--allow-empty"})() + + commit_mock.assert_called_with( + "feat: user created\n\ncloses #21", args="--allow-empty -s" + ) + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_when_customized_expected_raised(config, mocker: MockFixture): + _err = ValueError() + _err.__context__ = CzException("This is the root custom err") + mocker.patch("questionary.prompt", side_effect=_err) + with pytest.raises(CustomError) as excinfo: + commands.Commit(config, {})() + + # Assert only the content in the formatted text + assert "This is the root custom err" in str(excinfo.value) + + +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_when_non_customized_expected_raised(config, mocker: MockFixture): + mocker.patch("questionary.prompt", side_effect=ValueError("error message")) + with pytest.raises(ValueError, match="error message"): + commands.Commit(config, {})() + + +@pytest.mark.usefixtures("staging_is_clean") +def test_commit_when_no_user_answer(config, mocker: MockFixture): + mocker.patch("questionary.prompt", return_value=None) + with pytest.raises(NoAnswersError): + commands.Commit(config, {})() + + +def test_commit_in_non_git_project(tmp_path, monkeypatch, config): + monkeypatch.chdir(tmp_path) + with pytest.raises(NotAGitProjectError): + commands.Commit(config, {}) + + +@pytest.mark.usefixtures("staging_is_clean", "commit_mock", "prompt_mock_feat") +def test_commit_command_with_all_option( + config, success_mock: MockType, mocker: MockFixture +): + add_mock = mocker.patch("commitizen.git.add") + commands.Commit(config, {"all": True})() + add_mock.assert_called() + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +def test_commit_command_with_extra_args( + config, success_mock: MockType, commit_mock: MockType +): + commands.Commit(config, {"extra_cli_args": "-- -extra-args1 -extra-arg2"})() + commit_mock.assert_called_once_with(ANY, args="-- -extra-args1 -extra-arg2") + success_mock.assert_called_once() + + +@pytest.mark.usefixtures("staging_is_clean") +@pytest.mark.parametrize("editor", ["vim", None]) +def test_manual_edit(editor, config, mocker: MockFixture, tmp_path): + mocker.patch("commitizen.git.get_core_editor", return_value=editor) + subprocess_mock = mocker.patch("subprocess.call") + + mocker.patch("shutil.which", return_value=editor) + + test_message = "Initial commit message" + temp_file = tmp_path / "temp_commit_message" + temp_file.write_text(test_message) + + mock_temp_file = mocker.patch("tempfile.NamedTemporaryFile") + mock_temp_file.return_value.__enter__.return_value.name = str(temp_file) + + commit_cmd = commands.Commit(config, {"edit": True}) + + if editor is None: + with pytest.raises(RuntimeError): + commit_cmd.manual_edit(test_message) + else: + edited_message = commit_cmd.manual_edit(test_message) + subprocess_mock.assert_called_once_with(["vim", str(temp_file)]) + assert edited_message == test_message.strip() + + +@pytest.mark.usefixtures("staging_is_clean", "prompt_mock_feat") +@pytest.mark.parametrize( + "out", ["no changes added to commit", "nothing added to commit"] +) +def test_commit_when_nothing_added_to_commit(config, mocker: MockFixture, out): + commit_mock = mocker.patch( + "commitizen.git.commit", + return_value=cmd.Command( + out=out, + err="", + stdout=out.encode(), + stderr=b"", + return_code=0, + ), + ) + error_mock = mocker.patch("commitizen.out.error") + + commands.Commit(config, {})() + + commit_mock.assert_called_once() + error_mock.assert_called_once_with(out) + + +@pytest.mark.usefixtures("staging_is_clean", "commit_mock") +def test_commit_command_with_config_message_length_limit( + config, success_mock: MockType, prompt_mock_feat: MockType +): + prefix = prompt_mock_feat.return_value["prefix"] + subject = prompt_mock_feat.return_value["subject"] + message_length = len(f"{prefix}: {subject}") + + commands.Commit(config, {"message_length_limit": message_length})() + success_mock.assert_called_once() + + with pytest.raises(CommitMessageLengthExceededError): + commands.Commit(config, {"message_length_limit": message_length - 1})() + + config.settings["message_length_limit"] = message_length + success_mock.reset_mock() + commands.Commit(config, {})() + success_mock.assert_called_once() + + config.settings["message_length_limit"] = message_length - 1 + with pytest.raises(CommitMessageLengthExceededError): + commands.Commit(config, {})() + + # Test config message length limit is overridden by CLI argument + success_mock.reset_mock() + commands.Commit(config, {"message_length_limit": message_length})() + success_mock.assert_called_once() + + success_mock.reset_mock() + commands.Commit(config, {"message_length_limit": 0})() + success_mock.assert_called_once() diff --git a/tests/commands/test_common_command.py b/tests/commands/test_common_command.py new file mode 100644 index 0000000000..c70bc96e94 --- /dev/null +++ b/tests/commands/test_common_command.py @@ -0,0 +1,54 @@ +import pytest +from pytest_mock import MockFixture + +from commitizen.commands import Example, Info, ListCz, Schema +from tests.utils import UtilFixture + + +@pytest.mark.parametrize( + "command", + [ + "bump", + "changelog", + "check", + "commit", + "example", + "info", + "init", + "ls", + "schema", + "version", + ], +) +@pytest.mark.usefixtures("python_version", "consistent_terminal_output") +def test_command_shows_description_when_use_help_option( + capsys, + file_regression, + command: str, + util: UtilFixture, +): + """Test that the command shows the description when the help option is used. + + Note: If the command description changes, please run `poe test:regen` to regenerate the test files. + """ + + with pytest.raises(SystemExit): + util.run_cli(command, "--help") + + out, _ = capsys.readouterr() + file_regression.check(out, extension=".txt") + + +@pytest.mark.parametrize( + "command", + [ + Example, + Info, + ListCz, + Schema, + ], +) +def test_simple_command_call_once(config, mocker: MockFixture, command): + write_mock = mocker.patch("commitizen.out.write") + command(config)() + write_mock.assert_called_once() diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_bump_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_bump_.txt new file mode 100644 index 0000000000..fa696d063d --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_bump_.txt @@ -0,0 +1,87 @@ +usage: cz bump [-h] [--dry-run] [--files-only] [--version-files-only] + [--local-version] [--changelog] [--no-verify] [--yes] + [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] + [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE] + [--increment {MAJOR,MINOR,PATCH}] + [--increment-mode {linear,exact}] [--check-consistency] + [--annotated-tag] + [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign] + [--changelog-to-stdout] [--git-output-to-stderr] [--retry] + [--major-version-zero] [--template TEMPLATE] [--extra EXTRA] + [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET] + [--version-scheme {pep440,semver,semver2}] + [--version-type {pep440,semver,semver2}] + [--build-metadata BUILD_METADATA] [--get-next] + [--allow-no-commit] + [MANUAL_VERSION] + +Bump semantic version based on the git log + +positional arguments: + MANUAL_VERSION Bump to the given version (e.g., 1.5.3). + +options: + -h, --help show this help message and exit + --dry-run Perform a dry run, without committing or modifying + files. + --files-only Bump version in the `version_files` specified in the + configuration file only(deprecated; use --version- + files-only instead). + --version-files-only Bump version in the files from the config + --local-version Bump version only the local version portion (ignoring + the public version). + --changelog, -ch Generate the changelog for the latest version. + --no-verify Bypass the pre-commit and commit-msg hooks. + --yes Accept automatically answered questions. + --tag-format TAG_FORMAT + The format used to tag the commit and read it. Use it + in existing projects, and wrap around simple quotes. + --bump-message BUMP_MESSAGE + Template used to create the release commit, useful + when working with CI. + --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc} + Type of prerelease. + --devrelease DEVRELEASE, -d DEVRELEASE + Specify non-negative integer for dev release. + --increment {MAJOR,MINOR,PATCH} + Specify the desired increment. + --increment-mode {linear,exact} + Set the method by which the new version is chosen. + 'linear' (default) resolves the next version based on + typical linear version progression, where bumping of a + pre-release with lower precedence than the current + pre-release phase maintains the current phase of + higher precedence. 'exact' applies the changes that + have been specified (or determined from the commit + log) without interpretation, ensuring the increment + and pre-release are always honored. + --check-consistency, -cc + Check consistency among versions defined in Commitizen + configuration file and `version_files`. + --annotated-tag, -at Create annotated tag instead of lightweight one. + --annotated-tag-message ANNOTATED_TAG_MESSAGE, -atm ANNOTATED_TAG_MESSAGE + Create annotated tag message. + --gpg-sign, -s Sign tag instead of lightweight one. + --changelog-to-stdout + Output changelog to stdout. + --git-output-to-stderr + Redirect git output to stderr. + --retry Retry commit if it fails for the first time. + --major-version-zero Keep major version at zero, even for breaking changes. + --template TEMPLATE, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra EXTRA, -e EXTRA + Changelog extra variables (in the form 'key=value'). + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --prerelease-offset PRERELEASE_OFFSET + Start pre-releases with this offset. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --version-type {pep440,semver,semver2} + Deprecated, use `--version-scheme` instead. + --build-metadata BUILD_METADATA + Add additional build-metadata to the version-number. + --get-next Determine the next version and write to stdout. + --allow-no-commit Bump version without eligible commits. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_changelog_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_changelog_.txt new file mode 100644 index 0000000000..2d1135af74 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_changelog_.txt @@ -0,0 +1,42 @@ +usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] + [--unreleased-version UNRELEASED_VERSION] [--incremental] + [--start-rev START_REV] [--merge-prerelease] + [--version-scheme {pep440,semver,semver2}] + [--export-template EXPORT_TEMPLATE] [--template TEMPLATE] + [--extra EXTRA] [--tag-format TAG_FORMAT] + [rev_range] + +Generate changelog (note that it will overwrite existing files) + +positional arguments: + rev_range Generate changelog for the given version (e.g., 1.5.3) + or version range (e.g., 1.5.3..1.7.9). + +options: + -h, --help show this help message and exit + --dry-run Show changelog to stdout. + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --unreleased-version UNRELEASED_VERSION + Set the value for the new version (use the tag value), + instead of using unreleased versions. + --incremental Generate changelog from the last created version, + useful if the changelog has been manually modified. + --start-rev START_REV + Start rev of the changelog. If not set, it will + generate changelog from the beginning. + --merge-prerelease Collect all changes from prereleases into the next + non-prerelease. If not set, it will include + prereleases in the changelog. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --export-template EXPORT_TEMPLATE + Export the changelog template into this file instead + of rendering it. + --template TEMPLATE, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra EXTRA, -e EXTRA + Changelog extra variables (in the form 'key=value'). + --tag-format TAG_FORMAT + The format of the tag, wrap around simple quotes. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_check_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_check_.txt new file mode 100644 index 0000000000..144e91b61a --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_check_.txt @@ -0,0 +1,29 @@ +usage: cz check [-h] + [--commit-msg-file COMMIT_MSG_FILE | --rev-range REV_RANGE | -d | -m MESSAGE] + [--allow-abort] [--allowed-prefixes [ALLOWED_PREFIXES ...]] + [-l MESSAGE_LENGTH_LIMIT] + +Validate that a commit message matches the commitizen schema + +options: + -h, --help show this help message and exit + --commit-msg-file COMMIT_MSG_FILE + Ask for the name of the temporary file that contains + the commit message. Use it in a git hook script: + MSG_FILE=$1. + --rev-range REV_RANGE + Validate the commits in the given range of git rev, + e.g., master..HEAD. + -d, --use-default-range + Validate the commits from the default branch to HEAD, + e.g., refs/remotes/origin/master..HEAD. + -m MESSAGE, --message MESSAGE + Validate the given commit message. + --allow-abort Allow empty commit messages, which typically abort a + commit. + --allowed-prefixes [ALLOWED_PREFIXES ...] + Skip validation for commit messages that start with + the specified prefixes. + -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT + Restrict the length of the **first line** of the + commit message; 0 for no limit. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_commit_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_commit_.txt new file mode 100644 index 0000000000..bd256ccf8c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_commit_.txt @@ -0,0 +1,25 @@ +usage: cz commit [-h] [--retry] [--no-retry] [--dry-run] + [--write-message-to-file FILE_PATH] [-s] [-a] [-e] + [-l MESSAGE_LENGTH_LIMIT] [--] + +Create new commit + +options: + -h, --help show this help message and exit + --retry Retry the last commit. + --no-retry Skip retry if --retry or `retry_after_failure` is set + to true. + --dry-run Perform a dry run, without committing or modifying + files. + --write-message-to-file FILE_PATH + Write message to FILE_PATH before committing (can be + used with --dry-run). + -s, --signoff Deprecated, use `cz commit -- -s` instead. + -a, --all Automatically stage files that have been modified and + deleted, but new files you have not told Git about are + not affected. + -e, --edit Edit the commit message before committing. + -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT + Set the length limit of the commit message; 0 for no + limit. + -- Positional arguments separator (recommended). diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_example_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_example_.txt new file mode 100644 index 0000000000..8a0f1c9d94 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_example_.txt @@ -0,0 +1,6 @@ +usage: cz example [-h] + +Show commit example + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_info_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_info_.txt new file mode 100644 index 0000000000..ed5ae2522e --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_info_.txt @@ -0,0 +1,6 @@ +usage: cz info [-h] + +Show information about the cz + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_init_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_init_.txt new file mode 100644 index 0000000000..546ab51cb3 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_init_.txt @@ -0,0 +1,6 @@ +usage: cz init [-h] + +Initialize commitizen configuration + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_ls_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_ls_.txt new file mode 100644 index 0000000000..253da1722c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_ls_.txt @@ -0,0 +1,6 @@ +usage: cz ls [-h] + +Show available Commitizens + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_schema_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_schema_.txt new file mode 100644 index 0000000000..dd05ead81b --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_schema_.txt @@ -0,0 +1,6 @@ +usage: cz schema [-h] + +Show commit schema + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_version_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_version_.txt new file mode 100644 index 0000000000..5085d0fd3c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_version_.txt @@ -0,0 +1,18 @@ +usage: cz version [-h] [-r | -p | -c | -v] [--major | --minor | --tag] + +Get the version of the installed commitizen or the current project (default: +installed commitizen) + +options: + -h, --help show this help message and exit + -r, --report Output the system information for reporting bugs. + -p, --project Output the version of the current project. + -c, --commitizen Output the version of the installed commitizen. + -v, --verbose Output the version of both the installed commitizen and + the current project. + --major Output just the major version. Must be used with --project + or --verbose. + --minor Output just the minor version. Must be used with --project + or --verbose. + --tag get the version with tag prefix. Need to be used with + --project or --verbose. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_bump_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_bump_.txt new file mode 100644 index 0000000000..fa696d063d --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_bump_.txt @@ -0,0 +1,87 @@ +usage: cz bump [-h] [--dry-run] [--files-only] [--version-files-only] + [--local-version] [--changelog] [--no-verify] [--yes] + [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] + [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE] + [--increment {MAJOR,MINOR,PATCH}] + [--increment-mode {linear,exact}] [--check-consistency] + [--annotated-tag] + [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign] + [--changelog-to-stdout] [--git-output-to-stderr] [--retry] + [--major-version-zero] [--template TEMPLATE] [--extra EXTRA] + [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET] + [--version-scheme {pep440,semver,semver2}] + [--version-type {pep440,semver,semver2}] + [--build-metadata BUILD_METADATA] [--get-next] + [--allow-no-commit] + [MANUAL_VERSION] + +Bump semantic version based on the git log + +positional arguments: + MANUAL_VERSION Bump to the given version (e.g., 1.5.3). + +options: + -h, --help show this help message and exit + --dry-run Perform a dry run, without committing or modifying + files. + --files-only Bump version in the `version_files` specified in the + configuration file only(deprecated; use --version- + files-only instead). + --version-files-only Bump version in the files from the config + --local-version Bump version only the local version portion (ignoring + the public version). + --changelog, -ch Generate the changelog for the latest version. + --no-verify Bypass the pre-commit and commit-msg hooks. + --yes Accept automatically answered questions. + --tag-format TAG_FORMAT + The format used to tag the commit and read it. Use it + in existing projects, and wrap around simple quotes. + --bump-message BUMP_MESSAGE + Template used to create the release commit, useful + when working with CI. + --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc} + Type of prerelease. + --devrelease DEVRELEASE, -d DEVRELEASE + Specify non-negative integer for dev release. + --increment {MAJOR,MINOR,PATCH} + Specify the desired increment. + --increment-mode {linear,exact} + Set the method by which the new version is chosen. + 'linear' (default) resolves the next version based on + typical linear version progression, where bumping of a + pre-release with lower precedence than the current + pre-release phase maintains the current phase of + higher precedence. 'exact' applies the changes that + have been specified (or determined from the commit + log) without interpretation, ensuring the increment + and pre-release are always honored. + --check-consistency, -cc + Check consistency among versions defined in Commitizen + configuration file and `version_files`. + --annotated-tag, -at Create annotated tag instead of lightweight one. + --annotated-tag-message ANNOTATED_TAG_MESSAGE, -atm ANNOTATED_TAG_MESSAGE + Create annotated tag message. + --gpg-sign, -s Sign tag instead of lightweight one. + --changelog-to-stdout + Output changelog to stdout. + --git-output-to-stderr + Redirect git output to stderr. + --retry Retry commit if it fails for the first time. + --major-version-zero Keep major version at zero, even for breaking changes. + --template TEMPLATE, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra EXTRA, -e EXTRA + Changelog extra variables (in the form 'key=value'). + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --prerelease-offset PRERELEASE_OFFSET + Start pre-releases with this offset. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --version-type {pep440,semver,semver2} + Deprecated, use `--version-scheme` instead. + --build-metadata BUILD_METADATA + Add additional build-metadata to the version-number. + --get-next Determine the next version and write to stdout. + --allow-no-commit Bump version without eligible commits. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_changelog_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_changelog_.txt new file mode 100644 index 0000000000..2d1135af74 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_changelog_.txt @@ -0,0 +1,42 @@ +usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] + [--unreleased-version UNRELEASED_VERSION] [--incremental] + [--start-rev START_REV] [--merge-prerelease] + [--version-scheme {pep440,semver,semver2}] + [--export-template EXPORT_TEMPLATE] [--template TEMPLATE] + [--extra EXTRA] [--tag-format TAG_FORMAT] + [rev_range] + +Generate changelog (note that it will overwrite existing files) + +positional arguments: + rev_range Generate changelog for the given version (e.g., 1.5.3) + or version range (e.g., 1.5.3..1.7.9). + +options: + -h, --help show this help message and exit + --dry-run Show changelog to stdout. + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --unreleased-version UNRELEASED_VERSION + Set the value for the new version (use the tag value), + instead of using unreleased versions. + --incremental Generate changelog from the last created version, + useful if the changelog has been manually modified. + --start-rev START_REV + Start rev of the changelog. If not set, it will + generate changelog from the beginning. + --merge-prerelease Collect all changes from prereleases into the next + non-prerelease. If not set, it will include + prereleases in the changelog. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --export-template EXPORT_TEMPLATE + Export the changelog template into this file instead + of rendering it. + --template TEMPLATE, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra EXTRA, -e EXTRA + Changelog extra variables (in the form 'key=value'). + --tag-format TAG_FORMAT + The format of the tag, wrap around simple quotes. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_check_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_check_.txt new file mode 100644 index 0000000000..144e91b61a --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_check_.txt @@ -0,0 +1,29 @@ +usage: cz check [-h] + [--commit-msg-file COMMIT_MSG_FILE | --rev-range REV_RANGE | -d | -m MESSAGE] + [--allow-abort] [--allowed-prefixes [ALLOWED_PREFIXES ...]] + [-l MESSAGE_LENGTH_LIMIT] + +Validate that a commit message matches the commitizen schema + +options: + -h, --help show this help message and exit + --commit-msg-file COMMIT_MSG_FILE + Ask for the name of the temporary file that contains + the commit message. Use it in a git hook script: + MSG_FILE=$1. + --rev-range REV_RANGE + Validate the commits in the given range of git rev, + e.g., master..HEAD. + -d, --use-default-range + Validate the commits from the default branch to HEAD, + e.g., refs/remotes/origin/master..HEAD. + -m MESSAGE, --message MESSAGE + Validate the given commit message. + --allow-abort Allow empty commit messages, which typically abort a + commit. + --allowed-prefixes [ALLOWED_PREFIXES ...] + Skip validation for commit messages that start with + the specified prefixes. + -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT + Restrict the length of the **first line** of the + commit message; 0 for no limit. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_commit_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_commit_.txt new file mode 100644 index 0000000000..bd256ccf8c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_commit_.txt @@ -0,0 +1,25 @@ +usage: cz commit [-h] [--retry] [--no-retry] [--dry-run] + [--write-message-to-file FILE_PATH] [-s] [-a] [-e] + [-l MESSAGE_LENGTH_LIMIT] [--] + +Create new commit + +options: + -h, --help show this help message and exit + --retry Retry the last commit. + --no-retry Skip retry if --retry or `retry_after_failure` is set + to true. + --dry-run Perform a dry run, without committing or modifying + files. + --write-message-to-file FILE_PATH + Write message to FILE_PATH before committing (can be + used with --dry-run). + -s, --signoff Deprecated, use `cz commit -- -s` instead. + -a, --all Automatically stage files that have been modified and + deleted, but new files you have not told Git about are + not affected. + -e, --edit Edit the commit message before committing. + -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT + Set the length limit of the commit message; 0 for no + limit. + -- Positional arguments separator (recommended). diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_example_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_example_.txt new file mode 100644 index 0000000000..8a0f1c9d94 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_example_.txt @@ -0,0 +1,6 @@ +usage: cz example [-h] + +Show commit example + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_info_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_info_.txt new file mode 100644 index 0000000000..ed5ae2522e --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_info_.txt @@ -0,0 +1,6 @@ +usage: cz info [-h] + +Show information about the cz + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_init_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_init_.txt new file mode 100644 index 0000000000..546ab51cb3 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_init_.txt @@ -0,0 +1,6 @@ +usage: cz init [-h] + +Initialize commitizen configuration + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_ls_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_ls_.txt new file mode 100644 index 0000000000..253da1722c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_ls_.txt @@ -0,0 +1,6 @@ +usage: cz ls [-h] + +Show available Commitizens + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_schema_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_schema_.txt new file mode 100644 index 0000000000..dd05ead81b --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_schema_.txt @@ -0,0 +1,6 @@ +usage: cz schema [-h] + +Show commit schema + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_version_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_version_.txt new file mode 100644 index 0000000000..5085d0fd3c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_version_.txt @@ -0,0 +1,18 @@ +usage: cz version [-h] [-r | -p | -c | -v] [--major | --minor | --tag] + +Get the version of the installed commitizen or the current project (default: +installed commitizen) + +options: + -h, --help show this help message and exit + -r, --report Output the system information for reporting bugs. + -p, --project Output the version of the current project. + -c, --commitizen Output the version of the installed commitizen. + -v, --verbose Output the version of both the installed commitizen and + the current project. + --major Output just the major version. Must be used with --project + or --verbose. + --minor Output just the minor version. Must be used with --project + or --verbose. + --tag get the version with tag prefix. Need to be used with + --project or --verbose. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_bump_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_bump_.txt new file mode 100644 index 0000000000..fa696d063d --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_bump_.txt @@ -0,0 +1,87 @@ +usage: cz bump [-h] [--dry-run] [--files-only] [--version-files-only] + [--local-version] [--changelog] [--no-verify] [--yes] + [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] + [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE] + [--increment {MAJOR,MINOR,PATCH}] + [--increment-mode {linear,exact}] [--check-consistency] + [--annotated-tag] + [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign] + [--changelog-to-stdout] [--git-output-to-stderr] [--retry] + [--major-version-zero] [--template TEMPLATE] [--extra EXTRA] + [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET] + [--version-scheme {pep440,semver,semver2}] + [--version-type {pep440,semver,semver2}] + [--build-metadata BUILD_METADATA] [--get-next] + [--allow-no-commit] + [MANUAL_VERSION] + +Bump semantic version based on the git log + +positional arguments: + MANUAL_VERSION Bump to the given version (e.g., 1.5.3). + +options: + -h, --help show this help message and exit + --dry-run Perform a dry run, without committing or modifying + files. + --files-only Bump version in the `version_files` specified in the + configuration file only(deprecated; use --version- + files-only instead). + --version-files-only Bump version in the files from the config + --local-version Bump version only the local version portion (ignoring + the public version). + --changelog, -ch Generate the changelog for the latest version. + --no-verify Bypass the pre-commit and commit-msg hooks. + --yes Accept automatically answered questions. + --tag-format TAG_FORMAT + The format used to tag the commit and read it. Use it + in existing projects, and wrap around simple quotes. + --bump-message BUMP_MESSAGE + Template used to create the release commit, useful + when working with CI. + --prerelease {alpha,beta,rc}, -pr {alpha,beta,rc} + Type of prerelease. + --devrelease DEVRELEASE, -d DEVRELEASE + Specify non-negative integer for dev release. + --increment {MAJOR,MINOR,PATCH} + Specify the desired increment. + --increment-mode {linear,exact} + Set the method by which the new version is chosen. + 'linear' (default) resolves the next version based on + typical linear version progression, where bumping of a + pre-release with lower precedence than the current + pre-release phase maintains the current phase of + higher precedence. 'exact' applies the changes that + have been specified (or determined from the commit + log) without interpretation, ensuring the increment + and pre-release are always honored. + --check-consistency, -cc + Check consistency among versions defined in Commitizen + configuration file and `version_files`. + --annotated-tag, -at Create annotated tag instead of lightweight one. + --annotated-tag-message ANNOTATED_TAG_MESSAGE, -atm ANNOTATED_TAG_MESSAGE + Create annotated tag message. + --gpg-sign, -s Sign tag instead of lightweight one. + --changelog-to-stdout + Output changelog to stdout. + --git-output-to-stderr + Redirect git output to stderr. + --retry Retry commit if it fails for the first time. + --major-version-zero Keep major version at zero, even for breaking changes. + --template TEMPLATE, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra EXTRA, -e EXTRA + Changelog extra variables (in the form 'key=value'). + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --prerelease-offset PRERELEASE_OFFSET + Start pre-releases with this offset. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --version-type {pep440,semver,semver2} + Deprecated, use `--version-scheme` instead. + --build-metadata BUILD_METADATA + Add additional build-metadata to the version-number. + --get-next Determine the next version and write to stdout. + --allow-no-commit Bump version without eligible commits. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_changelog_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_changelog_.txt new file mode 100644 index 0000000000..2d1135af74 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_changelog_.txt @@ -0,0 +1,42 @@ +usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] + [--unreleased-version UNRELEASED_VERSION] [--incremental] + [--start-rev START_REV] [--merge-prerelease] + [--version-scheme {pep440,semver,semver2}] + [--export-template EXPORT_TEMPLATE] [--template TEMPLATE] + [--extra EXTRA] [--tag-format TAG_FORMAT] + [rev_range] + +Generate changelog (note that it will overwrite existing files) + +positional arguments: + rev_range Generate changelog for the given version (e.g., 1.5.3) + or version range (e.g., 1.5.3..1.7.9). + +options: + -h, --help show this help message and exit + --dry-run Show changelog to stdout. + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --unreleased-version UNRELEASED_VERSION + Set the value for the new version (use the tag value), + instead of using unreleased versions. + --incremental Generate changelog from the last created version, + useful if the changelog has been manually modified. + --start-rev START_REV + Start rev of the changelog. If not set, it will + generate changelog from the beginning. + --merge-prerelease Collect all changes from prereleases into the next + non-prerelease. If not set, it will include + prereleases in the changelog. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --export-template EXPORT_TEMPLATE + Export the changelog template into this file instead + of rendering it. + --template TEMPLATE, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra EXTRA, -e EXTRA + Changelog extra variables (in the form 'key=value'). + --tag-format TAG_FORMAT + The format of the tag, wrap around simple quotes. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_check_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_check_.txt new file mode 100644 index 0000000000..144e91b61a --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_check_.txt @@ -0,0 +1,29 @@ +usage: cz check [-h] + [--commit-msg-file COMMIT_MSG_FILE | --rev-range REV_RANGE | -d | -m MESSAGE] + [--allow-abort] [--allowed-prefixes [ALLOWED_PREFIXES ...]] + [-l MESSAGE_LENGTH_LIMIT] + +Validate that a commit message matches the commitizen schema + +options: + -h, --help show this help message and exit + --commit-msg-file COMMIT_MSG_FILE + Ask for the name of the temporary file that contains + the commit message. Use it in a git hook script: + MSG_FILE=$1. + --rev-range REV_RANGE + Validate the commits in the given range of git rev, + e.g., master..HEAD. + -d, --use-default-range + Validate the commits from the default branch to HEAD, + e.g., refs/remotes/origin/master..HEAD. + -m MESSAGE, --message MESSAGE + Validate the given commit message. + --allow-abort Allow empty commit messages, which typically abort a + commit. + --allowed-prefixes [ALLOWED_PREFIXES ...] + Skip validation for commit messages that start with + the specified prefixes. + -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT + Restrict the length of the **first line** of the + commit message; 0 for no limit. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_commit_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_commit_.txt new file mode 100644 index 0000000000..bd256ccf8c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_commit_.txt @@ -0,0 +1,25 @@ +usage: cz commit [-h] [--retry] [--no-retry] [--dry-run] + [--write-message-to-file FILE_PATH] [-s] [-a] [-e] + [-l MESSAGE_LENGTH_LIMIT] [--] + +Create new commit + +options: + -h, --help show this help message and exit + --retry Retry the last commit. + --no-retry Skip retry if --retry or `retry_after_failure` is set + to true. + --dry-run Perform a dry run, without committing or modifying + files. + --write-message-to-file FILE_PATH + Write message to FILE_PATH before committing (can be + used with --dry-run). + -s, --signoff Deprecated, use `cz commit -- -s` instead. + -a, --all Automatically stage files that have been modified and + deleted, but new files you have not told Git about are + not affected. + -e, --edit Edit the commit message before committing. + -l MESSAGE_LENGTH_LIMIT, --message-length-limit MESSAGE_LENGTH_LIMIT + Set the length limit of the commit message; 0 for no + limit. + -- Positional arguments separator (recommended). diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_example_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_example_.txt new file mode 100644 index 0000000000..8a0f1c9d94 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_example_.txt @@ -0,0 +1,6 @@ +usage: cz example [-h] + +Show commit example + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_info_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_info_.txt new file mode 100644 index 0000000000..ed5ae2522e --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_info_.txt @@ -0,0 +1,6 @@ +usage: cz info [-h] + +Show information about the cz + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_init_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_init_.txt new file mode 100644 index 0000000000..546ab51cb3 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_init_.txt @@ -0,0 +1,6 @@ +usage: cz init [-h] + +Initialize commitizen configuration + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_ls_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_ls_.txt new file mode 100644 index 0000000000..253da1722c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_ls_.txt @@ -0,0 +1,6 @@ +usage: cz ls [-h] + +Show available Commitizens + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_schema_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_schema_.txt new file mode 100644 index 0000000000..dd05ead81b --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_schema_.txt @@ -0,0 +1,6 @@ +usage: cz schema [-h] + +Show commit schema + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_version_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_version_.txt new file mode 100644 index 0000000000..5085d0fd3c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_version_.txt @@ -0,0 +1,18 @@ +usage: cz version [-h] [-r | -p | -c | -v] [--major | --minor | --tag] + +Get the version of the installed commitizen or the current project (default: +installed commitizen) + +options: + -h, --help show this help message and exit + -r, --report Output the system information for reporting bugs. + -p, --project Output the version of the current project. + -c, --commitizen Output the version of the installed commitizen. + -v, --verbose Output the version of both the installed commitizen and + the current project. + --major Output just the major version. Must be used with --project + or --verbose. + --minor Output just the minor version. Must be used with --project + or --verbose. + --tag get the version with tag prefix. Need to be used with + --project or --verbose. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_bump_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_bump_.txt new file mode 100644 index 0000000000..8e4c863585 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_bump_.txt @@ -0,0 +1,86 @@ +usage: cz bump [-h] [--dry-run] [--files-only] [--version-files-only] + [--local-version] [--changelog] [--no-verify] [--yes] + [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] + [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE] + [--increment {MAJOR,MINOR,PATCH}] + [--increment-mode {linear,exact}] [--check-consistency] + [--annotated-tag] + [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign] + [--changelog-to-stdout] [--git-output-to-stderr] [--retry] + [--major-version-zero] [--template TEMPLATE] [--extra EXTRA] + [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET] + [--version-scheme {pep440,semver,semver2}] + [--version-type {pep440,semver,semver2}] + [--build-metadata BUILD_METADATA] [--get-next] + [--allow-no-commit] + [MANUAL_VERSION] + +Bump semantic version based on the git log + +positional arguments: + MANUAL_VERSION Bump to the given version (e.g., 1.5.3). + +options: + -h, --help show this help message and exit + --dry-run Perform a dry run, without committing or modifying + files. + --files-only Bump version in the `version_files` specified in the + configuration file only(deprecated; use --version- + files-only instead). + --version-files-only Bump version in the files from the config + --local-version Bump version only the local version portion (ignoring + the public version). + --changelog, -ch Generate the changelog for the latest version. + --no-verify Bypass the pre-commit and commit-msg hooks. + --yes Accept automatically answered questions. + --tag-format TAG_FORMAT + The format used to tag the commit and read it. Use it + in existing projects, and wrap around simple quotes. + --bump-message BUMP_MESSAGE + Template used to create the release commit, useful + when working with CI. + --prerelease, -pr {alpha,beta,rc} + Type of prerelease. + --devrelease, -d DEVRELEASE + Specify non-negative integer for dev release. + --increment {MAJOR,MINOR,PATCH} + Specify the desired increment. + --increment-mode {linear,exact} + Set the method by which the new version is chosen. + 'linear' (default) resolves the next version based on + typical linear version progression, where bumping of a + pre-release with lower precedence than the current + pre-release phase maintains the current phase of + higher precedence. 'exact' applies the changes that + have been specified (or determined from the commit + log) without interpretation, ensuring the increment + and pre-release are always honored. + --check-consistency, -cc + Check consistency among versions defined in Commitizen + configuration file and `version_files`. + --annotated-tag, -at Create annotated tag instead of lightweight one. + --annotated-tag-message, -atm ANNOTATED_TAG_MESSAGE + Create annotated tag message. + --gpg-sign, -s Sign tag instead of lightweight one. + --changelog-to-stdout + Output changelog to stdout. + --git-output-to-stderr + Redirect git output to stderr. + --retry Retry commit if it fails for the first time. + --major-version-zero Keep major version at zero, even for breaking changes. + --template, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra, -e EXTRA Changelog extra variables (in the form 'key=value'). + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --prerelease-offset PRERELEASE_OFFSET + Start pre-releases with this offset. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --version-type {pep440,semver,semver2} + Deprecated, use `--version-scheme` instead. + --build-metadata BUILD_METADATA + Add additional build-metadata to the version-number. + --get-next Determine the next version and write to stdout. + --allow-no-commit Bump version without eligible commits. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_changelog_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_changelog_.txt new file mode 100644 index 0000000000..50ab468d64 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_changelog_.txt @@ -0,0 +1,41 @@ +usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] + [--unreleased-version UNRELEASED_VERSION] [--incremental] + [--start-rev START_REV] [--merge-prerelease] + [--version-scheme {pep440,semver,semver2}] + [--export-template EXPORT_TEMPLATE] [--template TEMPLATE] + [--extra EXTRA] [--tag-format TAG_FORMAT] + [rev_range] + +Generate changelog (note that it will overwrite existing files) + +positional arguments: + rev_range Generate changelog for the given version (e.g., 1.5.3) + or version range (e.g., 1.5.3..1.7.9). + +options: + -h, --help show this help message and exit + --dry-run Show changelog to stdout. + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --unreleased-version UNRELEASED_VERSION + Set the value for the new version (use the tag value), + instead of using unreleased versions. + --incremental Generate changelog from the last created version, + useful if the changelog has been manually modified. + --start-rev START_REV + Start rev of the changelog. If not set, it will + generate changelog from the beginning. + --merge-prerelease Collect all changes from prereleases into the next + non-prerelease. If not set, it will include + prereleases in the changelog. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --export-template EXPORT_TEMPLATE + Export the changelog template into this file instead + of rendering it. + --template, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra, -e EXTRA Changelog extra variables (in the form 'key=value'). + --tag-format TAG_FORMAT + The format of the tag, wrap around simple quotes. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_check_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_check_.txt new file mode 100644 index 0000000000..6f8297e1ee --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_check_.txt @@ -0,0 +1,29 @@ +usage: cz check [-h] [--commit-msg-file COMMIT_MSG_FILE | + --rev-range REV_RANGE | -d | -m MESSAGE] [--allow-abort] + [--allowed-prefixes [ALLOWED_PREFIXES ...]] + [-l MESSAGE_LENGTH_LIMIT] + +Validate that a commit message matches the commitizen schema + +options: + -h, --help show this help message and exit + --commit-msg-file COMMIT_MSG_FILE + Ask for the name of the temporary file that contains + the commit message. Use it in a git hook script: + MSG_FILE=$1. + --rev-range REV_RANGE + Validate the commits in the given range of git rev, + e.g., master..HEAD. + -d, --use-default-range + Validate the commits from the default branch to HEAD, + e.g., refs/remotes/origin/master..HEAD. + -m, --message MESSAGE + Validate the given commit message. + --allow-abort Allow empty commit messages, which typically abort a + commit. + --allowed-prefixes [ALLOWED_PREFIXES ...] + Skip validation for commit messages that start with + the specified prefixes. + -l, --message-length-limit MESSAGE_LENGTH_LIMIT + Restrict the length of the **first line** of the + commit message; 0 for no limit. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_commit_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_commit_.txt new file mode 100644 index 0000000000..cbd5780f6d --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_commit_.txt @@ -0,0 +1,25 @@ +usage: cz commit [-h] [--retry] [--no-retry] [--dry-run] + [--write-message-to-file FILE_PATH] [-s] [-a] [-e] + [-l MESSAGE_LENGTH_LIMIT] [--] + +Create new commit + +options: + -h, --help show this help message and exit + --retry Retry the last commit. + --no-retry Skip retry if --retry or `retry_after_failure` is set + to true. + --dry-run Perform a dry run, without committing or modifying + files. + --write-message-to-file FILE_PATH + Write message to FILE_PATH before committing (can be + used with --dry-run). + -s, --signoff Deprecated, use `cz commit -- -s` instead. + -a, --all Automatically stage files that have been modified and + deleted, but new files you have not told Git about are + not affected. + -e, --edit Edit the commit message before committing. + -l, --message-length-limit MESSAGE_LENGTH_LIMIT + Set the length limit of the commit message; 0 for no + limit. + -- Positional arguments separator (recommended). diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_example_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_example_.txt new file mode 100644 index 0000000000..8a0f1c9d94 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_example_.txt @@ -0,0 +1,6 @@ +usage: cz example [-h] + +Show commit example + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_info_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_info_.txt new file mode 100644 index 0000000000..ed5ae2522e --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_info_.txt @@ -0,0 +1,6 @@ +usage: cz info [-h] + +Show information about the cz + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_init_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_init_.txt new file mode 100644 index 0000000000..546ab51cb3 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_init_.txt @@ -0,0 +1,6 @@ +usage: cz init [-h] + +Initialize commitizen configuration + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_ls_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_ls_.txt new file mode 100644 index 0000000000..253da1722c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_ls_.txt @@ -0,0 +1,6 @@ +usage: cz ls [-h] + +Show available Commitizens + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_schema_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_schema_.txt new file mode 100644 index 0000000000..dd05ead81b --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_schema_.txt @@ -0,0 +1,6 @@ +usage: cz schema [-h] + +Show commit schema + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_version_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_version_.txt new file mode 100644 index 0000000000..5085d0fd3c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_version_.txt @@ -0,0 +1,18 @@ +usage: cz version [-h] [-r | -p | -c | -v] [--major | --minor | --tag] + +Get the version of the installed commitizen or the current project (default: +installed commitizen) + +options: + -h, --help show this help message and exit + -r, --report Output the system information for reporting bugs. + -p, --project Output the version of the current project. + -c, --commitizen Output the version of the installed commitizen. + -v, --verbose Output the version of both the installed commitizen and + the current project. + --major Output just the major version. Must be used with --project + or --verbose. + --minor Output just the minor version. Must be used with --project + or --verbose. + --tag get the version with tag prefix. Need to be used with + --project or --verbose. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_bump_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_bump_.txt new file mode 100644 index 0000000000..8e4c863585 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_bump_.txt @@ -0,0 +1,86 @@ +usage: cz bump [-h] [--dry-run] [--files-only] [--version-files-only] + [--local-version] [--changelog] [--no-verify] [--yes] + [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] + [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE] + [--increment {MAJOR,MINOR,PATCH}] + [--increment-mode {linear,exact}] [--check-consistency] + [--annotated-tag] + [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign] + [--changelog-to-stdout] [--git-output-to-stderr] [--retry] + [--major-version-zero] [--template TEMPLATE] [--extra EXTRA] + [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET] + [--version-scheme {pep440,semver,semver2}] + [--version-type {pep440,semver,semver2}] + [--build-metadata BUILD_METADATA] [--get-next] + [--allow-no-commit] + [MANUAL_VERSION] + +Bump semantic version based on the git log + +positional arguments: + MANUAL_VERSION Bump to the given version (e.g., 1.5.3). + +options: + -h, --help show this help message and exit + --dry-run Perform a dry run, without committing or modifying + files. + --files-only Bump version in the `version_files` specified in the + configuration file only(deprecated; use --version- + files-only instead). + --version-files-only Bump version in the files from the config + --local-version Bump version only the local version portion (ignoring + the public version). + --changelog, -ch Generate the changelog for the latest version. + --no-verify Bypass the pre-commit and commit-msg hooks. + --yes Accept automatically answered questions. + --tag-format TAG_FORMAT + The format used to tag the commit and read it. Use it + in existing projects, and wrap around simple quotes. + --bump-message BUMP_MESSAGE + Template used to create the release commit, useful + when working with CI. + --prerelease, -pr {alpha,beta,rc} + Type of prerelease. + --devrelease, -d DEVRELEASE + Specify non-negative integer for dev release. + --increment {MAJOR,MINOR,PATCH} + Specify the desired increment. + --increment-mode {linear,exact} + Set the method by which the new version is chosen. + 'linear' (default) resolves the next version based on + typical linear version progression, where bumping of a + pre-release with lower precedence than the current + pre-release phase maintains the current phase of + higher precedence. 'exact' applies the changes that + have been specified (or determined from the commit + log) without interpretation, ensuring the increment + and pre-release are always honored. + --check-consistency, -cc + Check consistency among versions defined in Commitizen + configuration file and `version_files`. + --annotated-tag, -at Create annotated tag instead of lightweight one. + --annotated-tag-message, -atm ANNOTATED_TAG_MESSAGE + Create annotated tag message. + --gpg-sign, -s Sign tag instead of lightweight one. + --changelog-to-stdout + Output changelog to stdout. + --git-output-to-stderr + Redirect git output to stderr. + --retry Retry commit if it fails for the first time. + --major-version-zero Keep major version at zero, even for breaking changes. + --template, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra, -e EXTRA Changelog extra variables (in the form 'key=value'). + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --prerelease-offset PRERELEASE_OFFSET + Start pre-releases with this offset. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --version-type {pep440,semver,semver2} + Deprecated, use `--version-scheme` instead. + --build-metadata BUILD_METADATA + Add additional build-metadata to the version-number. + --get-next Determine the next version and write to stdout. + --allow-no-commit Bump version without eligible commits. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_changelog_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_changelog_.txt new file mode 100644 index 0000000000..50ab468d64 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_changelog_.txt @@ -0,0 +1,41 @@ +usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] + [--unreleased-version UNRELEASED_VERSION] [--incremental] + [--start-rev START_REV] [--merge-prerelease] + [--version-scheme {pep440,semver,semver2}] + [--export-template EXPORT_TEMPLATE] [--template TEMPLATE] + [--extra EXTRA] [--tag-format TAG_FORMAT] + [rev_range] + +Generate changelog (note that it will overwrite existing files) + +positional arguments: + rev_range Generate changelog for the given version (e.g., 1.5.3) + or version range (e.g., 1.5.3..1.7.9). + +options: + -h, --help show this help message and exit + --dry-run Show changelog to stdout. + --file-name FILE_NAME + File name of changelog (default: 'CHANGELOG.md'). + --unreleased-version UNRELEASED_VERSION + Set the value for the new version (use the tag value), + instead of using unreleased versions. + --incremental Generate changelog from the last created version, + useful if the changelog has been manually modified. + --start-rev START_REV + Start rev of the changelog. If not set, it will + generate changelog from the beginning. + --merge-prerelease Collect all changes from prereleases into the next + non-prerelease. If not set, it will include + prereleases in the changelog. + --version-scheme {pep440,semver,semver2} + Choose version scheme. + --export-template EXPORT_TEMPLATE + Export the changelog template into this file instead + of rendering it. + --template, -t TEMPLATE + Changelog template file name (relative to the current + working directory). + --extra, -e EXTRA Changelog extra variables (in the form 'key=value'). + --tag-format TAG_FORMAT + The format of the tag, wrap around simple quotes. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_check_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_check_.txt new file mode 100644 index 0000000000..6f8297e1ee --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_check_.txt @@ -0,0 +1,29 @@ +usage: cz check [-h] [--commit-msg-file COMMIT_MSG_FILE | + --rev-range REV_RANGE | -d | -m MESSAGE] [--allow-abort] + [--allowed-prefixes [ALLOWED_PREFIXES ...]] + [-l MESSAGE_LENGTH_LIMIT] + +Validate that a commit message matches the commitizen schema + +options: + -h, --help show this help message and exit + --commit-msg-file COMMIT_MSG_FILE + Ask for the name of the temporary file that contains + the commit message. Use it in a git hook script: + MSG_FILE=$1. + --rev-range REV_RANGE + Validate the commits in the given range of git rev, + e.g., master..HEAD. + -d, --use-default-range + Validate the commits from the default branch to HEAD, + e.g., refs/remotes/origin/master..HEAD. + -m, --message MESSAGE + Validate the given commit message. + --allow-abort Allow empty commit messages, which typically abort a + commit. + --allowed-prefixes [ALLOWED_PREFIXES ...] + Skip validation for commit messages that start with + the specified prefixes. + -l, --message-length-limit MESSAGE_LENGTH_LIMIT + Restrict the length of the **first line** of the + commit message; 0 for no limit. diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_commit_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_commit_.txt new file mode 100644 index 0000000000..cbd5780f6d --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_commit_.txt @@ -0,0 +1,25 @@ +usage: cz commit [-h] [--retry] [--no-retry] [--dry-run] + [--write-message-to-file FILE_PATH] [-s] [-a] [-e] + [-l MESSAGE_LENGTH_LIMIT] [--] + +Create new commit + +options: + -h, --help show this help message and exit + --retry Retry the last commit. + --no-retry Skip retry if --retry or `retry_after_failure` is set + to true. + --dry-run Perform a dry run, without committing or modifying + files. + --write-message-to-file FILE_PATH + Write message to FILE_PATH before committing (can be + used with --dry-run). + -s, --signoff Deprecated, use `cz commit -- -s` instead. + -a, --all Automatically stage files that have been modified and + deleted, but new files you have not told Git about are + not affected. + -e, --edit Edit the commit message before committing. + -l, --message-length-limit MESSAGE_LENGTH_LIMIT + Set the length limit of the commit message; 0 for no + limit. + -- Positional arguments separator (recommended). diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_example_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_example_.txt new file mode 100644 index 0000000000..8a0f1c9d94 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_example_.txt @@ -0,0 +1,6 @@ +usage: cz example [-h] + +Show commit example + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_info_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_info_.txt new file mode 100644 index 0000000000..ed5ae2522e --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_info_.txt @@ -0,0 +1,6 @@ +usage: cz info [-h] + +Show information about the cz + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_init_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_init_.txt new file mode 100644 index 0000000000..546ab51cb3 --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_init_.txt @@ -0,0 +1,6 @@ +usage: cz init [-h] + +Initialize commitizen configuration + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_ls_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_ls_.txt new file mode 100644 index 0000000000..253da1722c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_ls_.txt @@ -0,0 +1,6 @@ +usage: cz ls [-h] + +Show available Commitizens + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_schema_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_schema_.txt new file mode 100644 index 0000000000..dd05ead81b --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_schema_.txt @@ -0,0 +1,6 @@ +usage: cz schema [-h] + +Show commit schema + +options: + -h, --help show this help message and exit diff --git a/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_version_.txt b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_version_.txt new file mode 100644 index 0000000000..5085d0fd3c --- /dev/null +++ b/tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_version_.txt @@ -0,0 +1,18 @@ +usage: cz version [-h] [-r | -p | -c | -v] [--major | --minor | --tag] + +Get the version of the installed commitizen or the current project (default: +installed commitizen) + +options: + -h, --help show this help message and exit + -r, --report Output the system information for reporting bugs. + -p, --project Output the version of the current project. + -c, --commitizen Output the version of the installed commitizen. + -v, --verbose Output the version of both the installed commitizen and + the current project. + --major Output just the major version. Must be used with --project + or --verbose. + --minor Output just the minor version. Must be used with --project + or --verbose. + --tag get the version with tag prefix. Need to be used with + --project or --verbose. diff --git a/tests/commands/test_init_command.py b/tests/commands/test_init_command.py new file mode 100644 index 0000000000..db47fd064a --- /dev/null +++ b/tests/commands/test_init_command.py @@ -0,0 +1,485 @@ +from __future__ import annotations + +import json +from pathlib import Path +from typing import TYPE_CHECKING, Any + +import pytest +import yaml + +from commitizen import cmd, commands +from commitizen.__version__ import __version__ +from commitizen.exceptions import InitFailedError, NoAnswersError + +if TYPE_CHECKING: + from pytest_mock import MockFixture + + from commitizen.config.base_config import BaseConfig + + +class FakeQuestion: + def __init__(self, expected_return): + self.expected_return = expected_return + + def ask(self): + return self.expected_return + + def unsafe_ask(self): + return self.expected_return + + +pre_commit_config_filename = ".pre-commit-config.yaml" +cz_hook_config = { + "repo": "https://github.com/commitizen-tools/commitizen", + "rev": f"v{__version__}", + "hooks": [ + {"id": "commitizen"}, + {"id": "commitizen-branch", "stages": ["pre-push"]}, + ], +} + +expected_config = ( + "[tool.commitizen]\n" + 'name = "cz_conventional_commits"\n' + 'tag_format = "$version"\n' + 'version_scheme = "semver"\n' + 'version = "0.0.1"\n' + "update_changelog_on_bump = true\n" + "major_version_zero = true\n" +) + +EXPECTED_DICT_CONFIG = { + "commitizen": { + "name": "cz_conventional_commits", + "tag_format": "$version", + "version_scheme": "semver", + "version": "0.0.1", + "update_changelog_on_bump": True, + "major_version_zero": True, + } +} + + +def test_init_without_setup_pre_commit_hook( + tmp_path, monkeypatch, mocker: MockFixture, config: BaseConfig +): + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + # Return None to skip hook installation + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + monkeypatch.chdir(tmp_path) + commands.Init(config)() + + config_data = Path("pyproject.toml").read_text(encoding="utf-8") + assert config_data == expected_config + + assert not Path(pre_commit_config_filename).exists() + + +def test_init_when_config_already_exists(config: BaseConfig, capsys): + # Set config path + path = Path("tests") / "pyproject.toml" + config.path = path + + commands.Init(config)() + captured = capsys.readouterr() + assert captured.out == f"Config file {path} already exists\n" + + +def test_init_without_choosing_tag( + config: BaseConfig, mocker: MockFixture, tmp_path, monkeypatch +): + mocker.patch( + "commitizen.commands.init.get_tag_names", return_value=["0.0.2", "0.0.1"] + ) + mocker.patch("commitizen.commands.init.get_latest_tag_name", return_value="0.0.2") + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion(""), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(False)) + mocker.patch("questionary.text", return_value=FakeQuestion("y")) + + monkeypatch.chdir(tmp_path) + with pytest.raises(NoAnswersError): + commands.Init(config)() + + +@pytest.fixture +def pre_commit_installed(mocker: MockFixture): + # Assume the `pre-commit` is installed + mocker.patch( + "commitizen.project_info.is_pre_commit_installed", + return_value=True, + ) + # And installation success (i.e. no exception raised) + mocker.patch( + "commitizen.cmd.run", + return_value=cmd.Command("0.0.1", "", b"", b"", 0), + ) + + +@pytest.fixture(params=["pyproject.toml", ".cz.json", ".cz.yaml"]) +def default_choice(request, mocker: MockFixture): + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion(request.param), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch( + "questionary.checkbox", + return_value=FakeQuestion(["commit-msg", "pre-push"]), + ) + return request.param + + +def check_cz_config(config_filepath: str): + """ + Check the content of commitizen config is as expected + """ + content = Path(config_filepath).read_text(encoding="utf-8") + if "json" in config_filepath: + assert json.loads(content) == EXPECTED_DICT_CONFIG + elif "yaml" in config_filepath: + assert yaml.load(content, Loader=yaml.FullLoader) == EXPECTED_DICT_CONFIG + else: + assert content == expected_config + + +def check_pre_commit_config(expected: list[dict[str, Any]]): + """ + Check the content of pre-commit config is as expected + """ + pre_commit_config_data = yaml.safe_load( + Path(pre_commit_config_filename).read_text(encoding="utf-8") + ) + assert pre_commit_config_data == {"repos": expected} + + +@pytest.mark.usefixtures("pre_commit_installed") +class TestPreCommitCases: + def test_no_existing_pre_commit_config( + self, default_choice: str, tmp_path, monkeypatch, config: BaseConfig + ): + monkeypatch.chdir(tmp_path) + commands.Init(config)() + check_cz_config(default_choice) + check_pre_commit_config([cz_hook_config]) + + def test_empty_pre_commit_config( + self, default_choice: str, tmp_path, monkeypatch, config: BaseConfig + ): + monkeypatch.chdir(tmp_path) + p = tmp_path / pre_commit_config_filename + p.write_text("") + + commands.Init(config)() + check_cz_config(default_choice) + check_pre_commit_config([cz_hook_config]) + + def test_pre_commit_config_without_cz_hook( + self, default_choice: str, tmp_path, monkeypatch, config: BaseConfig + ): + existing_hook_config = { + "repo": "https://github.com/pre-commit/pre-commit-hooks", + "rev": "v1.2.3", + "hooks": [{"id", "trailing-whitespace"}], + } + + monkeypatch.chdir(tmp_path) + p = tmp_path / pre_commit_config_filename + p.write_text(yaml.safe_dump({"repos": [existing_hook_config]})) + + commands.Init(config)() + check_cz_config(default_choice) + check_pre_commit_config([existing_hook_config, cz_hook_config]) + + def test_cz_hook_exists_in_pre_commit_config( + self, default_choice: str, tmp_path, monkeypatch, config: BaseConfig + ): + monkeypatch.chdir(tmp_path) + p = tmp_path / pre_commit_config_filename + p.write_text(yaml.safe_dump({"repos": [cz_hook_config]})) + + commands.Init(config)() + check_cz_config(default_choice) + # check that config is not duplicated + check_pre_commit_config([cz_hook_config]) + + +class TestNoPreCommitInstalled: + @pytest.mark.usefixtures("default_choice") + def test_pre_commit_not_installed( + self, mocker: MockFixture, config: BaseConfig, tmp_path, monkeypatch + ): + # Assume `pre-commit` is not installed + mocker.patch( + "commitizen.project_info.is_pre_commit_installed", + return_value=False, + ) + monkeypatch.chdir(tmp_path) + with pytest.raises(InitFailedError): + commands.Init(config)() + + +class TestAskTagFormat: + def test_confirm_v_tag_format(self, mocker: MockFixture, config: BaseConfig): + init = commands.Init(config) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + + result = init._ask_tag_format("v1.0.0") + assert result == r"v$version" + + def test_reject_v_tag_format(self, mocker: MockFixture, config: BaseConfig): + init = commands.Init(config) + mocker.patch("questionary.confirm", return_value=FakeQuestion(False)) + mocker.patch("questionary.text", return_value=FakeQuestion("custom-$version")) + + result = init._ask_tag_format("v1.0.0") + assert result == "custom-$version" + + def test_non_v_tag_format(self, mocker: MockFixture, config: BaseConfig): + init = commands.Init(config) + mocker.patch("questionary.text", return_value=FakeQuestion("custom-$version")) + + result = init._ask_tag_format("1.0.0") + assert result == "custom-$version" + + def test_empty_input_returns_default(self, mocker: MockFixture, config: BaseConfig): + init = commands.Init(config) + mocker.patch("questionary.confirm", return_value=FakeQuestion(False)) + mocker.patch("questionary.text", return_value=FakeQuestion("")) + + result = init._ask_tag_format("v1.0.0") + assert result == "$version" # This is the default format from DEFAULT_SETTINGS + + +def test_init_with_confirmed_tag_format( + config: BaseConfig, mocker: MockFixture, tmp_path, monkeypatch +): + mocker.patch( + "commitizen.commands.init.get_tag_names", return_value=["v0.0.2", "v0.0.1"] + ) + mocker.patch("commitizen.commands.init.get_latest_tag_name", return_value="v0.0.2") + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + assert 'tag_format = "v$version"' in Path("pyproject.toml").read_text( + encoding="utf-8" + ) + + +def test_init_with_no_existing_tags( + config: BaseConfig, mocker: MockFixture, tmp_path, monkeypatch +): + mocker.patch("commitizen.commands.init.get_tag_names", return_value=[]) + mocker.patch("commitizen.commands.init.get_latest_tag_name", return_value="v1.0.0") + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(False)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + assert 'version = "0.0.1"' in Path("pyproject.toml").read_text(encoding="utf-8") + + +def test_init_with_no_existing_latest_tag( + config: BaseConfig, mocker: MockFixture, tmp_path, monkeypatch +): + mocker.patch("commitizen.commands.init.get_latest_tag_name", return_value=None) + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + assert 'version = "0.0.1"' in Path("pyproject.toml").read_text(encoding="utf-8") + + +def test_init_with_existing_tags( + config: BaseConfig, mocker: MockFixture, tmp_path, monkeypatch +): + expected_tags = ["v1.0.0", "v0.9.0", "v0.8.0"] + mocker.patch("commitizen.commands.init.get_tag_names", return_value=expected_tags) + mocker.patch("commitizen.commands.init.get_latest_tag_name", return_value="v1.0.0") + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), # Select version scheme first + FakeQuestion("v1.0.0"), # Then select the latest tag + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + assert 'version = "1.0.0"' in Path("pyproject.toml").read_text(encoding="utf-8") + + +def test_init_with_valid_tag_selection( + config: BaseConfig, mocker: MockFixture, tmp_path, monkeypatch +): + expected_tags = ["v1.0.0", "v0.9.0", "v0.8.0"] + mocker.patch("commitizen.commands.init.get_tag_names", return_value=expected_tags) + mocker.patch("commitizen.commands.init.get_latest_tag_name", return_value="v1.0.0") + + # Mock all questionary.select calls in the exact order they appear in Init.__call__ + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), # _ask_config_path + FakeQuestion("cz_conventional_commits"), # _ask_name + FakeQuestion("commitizen"), # _ask_version_provider + FakeQuestion("v0.9.0"), # _ask_tag (after confirm=False) + FakeQuestion("semver"), # _ask_version_scheme + ], + ) + + mocker.patch( + "questionary.confirm", return_value=FakeQuestion(False) + ) # Don't confirm latest tag + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + content = Path("pyproject.toml").read_text(encoding="utf-8") + assert 'version = "0.9.0"' in content + assert 'version_scheme = "semver"' in content + + +def test_init_configuration_settings( + tmp_path, monkeypatch, mocker: MockFixture, config: BaseConfig +): + """Test that all configuration settings are properly initialized.""" + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("commitizen"), + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + + config_data = Path("pyproject.toml").read_text(encoding="utf-8") + + # Verify all expected settings are present + assert 'name = "cz_conventional_commits"' in config_data + assert 'tag_format = "$version"' in config_data + assert 'version_scheme = "semver"' in config_data + assert 'version = "0.0.1"' in config_data + assert "update_changelog_on_bump = true" in config_data + assert "major_version_zero = true" in config_data + + +def test_init_configuration_with_version_provider( + tmp_path, monkeypatch, mocker: MockFixture, config: BaseConfig +): + """Test configuration initialization with a different version provider.""" + mocker.patch( + "questionary.select", + side_effect=[ + FakeQuestion("pyproject.toml"), + FakeQuestion("cz_conventional_commits"), + FakeQuestion("pep621"), # Different version provider + FakeQuestion("semver"), + ], + ) + mocker.patch("questionary.confirm", return_value=FakeQuestion(True)) + mocker.patch("questionary.text", return_value=FakeQuestion("$version")) + mocker.patch("questionary.checkbox", return_value=FakeQuestion(None)) + + monkeypatch.chdir(tmp_path) + commands.Init(config)() + + config_data = Path("pyproject.toml").read_text(encoding="utf-8") + + # Verify version provider is set instead of version + assert 'name = "cz_conventional_commits"' in config_data + assert 'tag_format = "$version"' in config_data + assert 'version_scheme = "semver"' in config_data + assert 'version_provider = "pep621"' in config_data + assert "update_changelog_on_bump = true" in config_data + assert "major_version_zero = true" in config_data + assert ( + "version = " not in config_data + ) # Version should not be set when using version_provider + + +def test_construct_name_choice_from_registry(config: BaseConfig): + """Test the construction of cz name choices with descriptions.""" + choices = commands.Init(config)._construct_name_choices_from_registry() + assert choices[0].title == "cz_conventional_commits" + assert choices[0].value == "cz_conventional_commits" + assert choices[0].description == "<type>(<scope>): <subject>" + assert choices[1].title == "cz_customize" + assert choices[1].value == "cz_customize" + assert choices[1].description is None + assert choices[2].title == "cz_jira" + assert choices[2].value == "cz_jira" + assert ( + choices[2].description + == "<ignored text> <ISSUE_KEY> <ignored text> #<COMMAND> <optional COMMAND_ARGUMENTS>" + ) diff --git a/tests/commands/test_version_command.py b/tests/commands/test_version_command.py new file mode 100644 index 0000000000..dce710ac84 --- /dev/null +++ b/tests/commands/test_version_command.py @@ -0,0 +1,202 @@ +import platform +import sys + +import pytest +from pytest_mock import MockerFixture + +from commitizen import commands +from commitizen.__version__ import __version__ +from commitizen.config.base_config import BaseConfig + + +def test_version_for_showing_project_version_error(config, capsys): + # No version specified in config + commands.Version( + config, + {"project": True}, + )() + captured = capsys.readouterr() + assert "No project information in this project." in captured.err + + +def test_version_for_showing_project_version(config, capsys): + config.settings["version"] = "v0.0.1" + commands.Version( + config, + {"project": True}, + )() + captured = capsys.readouterr() + assert "v0.0.1" in captured.out + + +@pytest.mark.parametrize("project", [True, False]) +def test_version_for_showing_commitizen_version(config, capsys, project: bool): + commands.Version( + config, + {"project": project, "commitizen": True}, + )() + captured = capsys.readouterr() + assert f"{__version__}" in captured.out + + +def test_version_for_showing_both_versions_no_project(config, capsys): + commands.Version( + config, + {"verbose": True}, + )() + captured = capsys.readouterr() + assert f"Installed Commitizen Version: {__version__}" in captured.out + assert "No project information in this project." in captured.err + + +def test_version_for_showing_both_versions(config, capsys): + config.settings["version"] = "v0.0.1" + commands.Version( + config, + {"verbose": True}, + )() + captured = capsys.readouterr() + expected_out = ( + f"Installed Commitizen Version: {__version__}\nProject Version: v0.0.1" + ) + assert expected_out in captured.out + + +def test_version_for_showing_commitizen_system_info(config, capsys): + commands.Version( + config, + {"report": True}, + )() + captured = capsys.readouterr() + assert f"Commitizen Version: {__version__}" in captured.out + assert f"Python Version: {sys.version}" in captured.out + assert f"Operating System: {platform.system()}" in captured.out + + +@pytest.mark.parametrize("project", [True, False]) +@pytest.mark.usefixtures("tmp_git_project") +def test_version_use_version_provider( + mocker: MockerFixture, + config: BaseConfig, + capsys: pytest.CaptureFixture, + project: bool, +): + version = "0.0.0" + mock = mocker.MagicMock(name="provider") + mock.get_version.return_value = version + get_provider = mocker.patch( + "commitizen.commands.version.get_provider", return_value=mock + ) + + commands.Version( + config, + { + "project": project, + "verbose": not project, + }, + )() + captured = capsys.readouterr() + + assert version in captured.out + get_provider.assert_called_once() + mock.get_version.assert_called_once() + mock.set_version.assert_not_called() + + +@pytest.mark.parametrize( + ("version", "expected_version"), + [ + ("1.0.0", "1\n"), + ("2.1.3", "2\n"), + ("0.0.1", "0\n"), + ("0.1.0", "0\n"), + ], +) +def test_version_just_major(config, capsys, version: str, expected_version: str): + config.settings["version"] = version + commands.Version( + config, + { + "project": True, + "major": True, + }, + )() + captured = capsys.readouterr() + assert expected_version == captured.out + + +@pytest.mark.parametrize( + ("version", "expected_version"), + [ + ("1.0.0", "0\n"), + ("2.1.3", "1\n"), + ("0.0.1", "0\n"), + ("0.1.0", "1\n"), + ], +) +def test_version_just_minor(config, capsys, version: str, expected_version: str): + config.settings["version"] = version + commands.Version( + config, + { + "project": True, + "minor": True, + }, + )() + captured = capsys.readouterr() + assert expected_version == captured.out + + +@pytest.mark.parametrize("argument", ["major", "minor"]) +def test_version_just_major_error_no_project(config, capsys, argument: str): + commands.Version( + config, + { + argument: True, # type: ignore[misc] + }, + )() + captured = capsys.readouterr() + assert not captured.out + assert ( + "Major or minor version can only be used with --project or --verbose." + in captured.err + ) + + +@pytest.mark.parametrize( + ("version", "tag_format", "expected_output"), + [ + ("1.2.3", "v$version", "v1.2.3\n"), + ("1.2.3", "$version", "1.2.3\n"), + ("2.0.0", "release-$version", "release-2.0.0\n"), + ("0.1.0", "ver$version", "ver0.1.0\n"), + ], +) +def test_version_with_tag_format( + config, capsys, version: str, tag_format: str, expected_output: str +): + """Test --tag option applies tag_format to version""" + config.settings["version"] = version + config.settings["tag_format"] = tag_format + commands.Version( + config, + { + "project": True, + "tag": True, + }, + )() + captured = capsys.readouterr() + assert captured.out == expected_output + + +def test_version_tag_without_project_error(config, capsys): + """Test --tag requires --project or --verbose""" + commands.Version( + config, + { + "tag": True, + }, + )() + captured = capsys.readouterr() + assert not captured.out + assert "Tag can only be used with --project or --verbose." in captured.err diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000000..178b92200a --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,334 @@ +from __future__ import annotations + +import os +import re +import subprocess +import sys +import tempfile +from pathlib import Path +from typing import TYPE_CHECKING, cast + +import pytest + +from commitizen import cmd, defaults +from commitizen.changelog_formats import ( + ChangelogFormat, + get_changelog_format, +) +from commitizen.config import BaseConfig +from commitizen.cz import registry +from commitizen.cz.base import BaseCommitizen + +if TYPE_CHECKING: + from collections.abc import Iterator, Mapping + + from pytest_mock import MockerFixture + + from commitizen.question import CzQuestion + from tests.utils import UtilFixture + + +SIGNER = "GitHub Action" +SIGNER_MAIL = "action@github.com" +PYTHON_VERSION = f"{sys.version_info.major}.{sys.version_info.minor}" + +pytest_plugins = [ + "tests.utils", +] + + +@pytest.fixture +def repo_root() -> Path: + return Path(__file__).parent.parent + + +@pytest.fixture +def in_repo_root(repo_root: Path) -> Iterator[Path]: + cwd = os.getcwd() + os.chdir(repo_root) + yield repo_root + os.chdir(cwd) + + +@pytest.fixture +def data_dir(repo_root: Path) -> Path: + return repo_root / "tests" / "data" + + +@pytest.fixture(scope="session") +def set_default_gitconfig() -> dict[str, str]: + return { + "user.name": "SIGNER", + "user.email": SIGNER_MAIL, + "safe.directory": "*", + "init.defaultBranch": "master", + } + + +@pytest.fixture +def chdir(tmp_path: Path) -> Iterator[Path]: + cwd = os.getcwd() + os.chdir(tmp_path) + yield tmp_path + os.chdir(cwd) + + +@pytest.fixture +def tmp_git_project(tmp_path: Path, monkeypatch: pytest.MonkeyPatch): + monkeypatch.chdir(tmp_path) + cmd.run("git init") + + return tmp_path + + +@pytest.fixture +def tmp_commitizen_project(tmp_git_project: Path): + (tmp_git_project / "pyproject.toml").write_text( + '[tool.commitizen]\nversion="0.1.0"\n' + ) + + return tmp_git_project + + +@pytest.fixture +def pyproject(tmp_commitizen_project: Path) -> Path: + return tmp_commitizen_project / "pyproject.toml" + + +@pytest.fixture +def tmp_commitizen_project_initial( + tmp_git_project: Path, util: UtilFixture, monkeypatch: pytest.MonkeyPatch +): + def _initial( + config_extra: str | None = None, + version="0.1.0", + initial_commit="feat: new user interface", + ): + monkeypatch.chdir(tmp_git_project) + tmp_commitizen_cfg_file = tmp_git_project / "pyproject.toml" + tmp_commitizen_cfg_file.write_text(f'[tool.commitizen]\nversion="{version}"\n') + tmp_version_file = tmp_git_project / "__version__.py" + tmp_version_file.write_text(version) + tmp_version_file_string = str(tmp_version_file).replace("\\", "/") + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write(f'\nversion_files = ["{tmp_version_file_string}"]\n') + if config_extra: + with tmp_commitizen_cfg_file.open("a", encoding="utf-8") as f: + f.write(config_extra) + util.create_file_and_commit(initial_commit) + + return tmp_git_project + + return _initial + + +def _get_gpg_keyid(signer_mail): + _new_key = cmd.run(f"gpg --list-secret-keys {signer_mail}") + _m = re.search( + r"[a-zA-Z0-9 \[\]-_]*\n[ ]*([0-9A-Za-z]*)\n[\na-zA-Z0-9 \[\]-_<>@]*", + _new_key.out, + ) + return _m.group(1) if _m else None + + +@pytest.fixture +def tmp_commitizen_project_with_gpg(tmp_commitizen_project): + # create a temporary GPGHOME to store a temporary keyring. + # Home path must be less than 104 characters + gpg_home = tempfile.TemporaryDirectory(suffix="_cz") + old_gnupghome = os.environ.get("GNUPGHOME") + if os.name != "nt": + os.environ["GNUPGHOME"] = gpg_home.name # tempdir = temp keyring + + try: + # create a key (a keyring will be generated within GPUPGHOME) + subprocess.run( + [ + "gpg", + "--batch", + "--yes", + "--debug-quick-random", + "--passphrase", + "", + "--quick-gen-key", + f"{SIGNER} {SIGNER_MAIL}", + ], + check=True, + ) + key_id = _get_gpg_keyid(SIGNER_MAIL) + assert key_id + + # configure git to use gpg signing + cmd.run("git config commit.gpgsign true") + cmd.run(f"git config user.signingkey {key_id}") + + yield tmp_commitizen_project + finally: + if old_gnupghome is not None: + os.environ["GNUPGHOME"] = old_gnupghome + elif "GNUPGHOME" in os.environ and os.name != "nt": + os.environ.pop("GNUPGHOME") + gpg_home.cleanup() + + +@pytest.fixture +def config(): + _config = BaseConfig() + _config.settings.update({"name": defaults.DEFAULT_SETTINGS["name"]}) + return _config + + +class SemverCommitizen(BaseCommitizen): + """A minimal cz rules used to test changelog and bump. + + Samples: + ``` + minor(users): add email to user + major: removed user profile + patch(deps): updated dependency for security + ``` + """ + + bump_pattern = r"^(patch|minor|major)" + bump_map = { + "major": "MAJOR", + "minor": "MINOR", + "patch": "PATCH", + } + bump_map_major_version_zero = { + "major": "MINOR", + "minor": "MINOR", + "patch": "PATCH", + } + changelog_pattern = r"^(patch|minor|major)" + commit_parser = r"^(?P<change_type>patch|minor|major)(?:\((?P<scope>[^()\r\n]*)\)|\()?:?\s(?P<message>.+)" + change_type_map = { + "major": "Breaking Changes", + "minor": "Features", + "patch": "Bugs", + } + + def questions(self) -> list[CzQuestion]: + return [ + { + "type": "list", + "name": "prefix", + "message": "Select the type of change you are committing", + "choices": [ + { + "value": "patch", + "name": "patch: a bug fix", + "key": "p", + }, + { + "value": "minor", + "name": "minor: a new feature, non-breaking", + "key": "m", + }, + { + "value": "major", + "name": "major: a breaking change", + "key": "b", + }, + ], + }, + { + "type": "input", + "name": "subject", + "message": ( + "Write a short and imperative summary of the code changes: (lower case and no period)\n" + ), + }, + ] + + def message(self, answers: Mapping) -> str: + prefix = answers["prefix"] + subject = answers.get("subject", "default message").trim() + return f"{prefix}: {subject}" + + def example(self) -> str: + return "" + + def schema(self) -> str: + return "" + + def schema_pattern(self) -> str: + return "" + + def info(self) -> str: + return "" + + +@pytest.fixture +def use_cz_semver(mocker): + new_cz = {**registry, "cz_semver": SemverCommitizen} + mocker.patch.dict("commitizen.cz.registry", new_cz) + + +class MockPlugin(BaseCommitizen): + def questions(self) -> list[CzQuestion]: + return [] + + def message(self, answers: Mapping) -> str: + return "" + + def example(self) -> str: + return "" + + def schema(self) -> str: + return "" + + def schema_pattern(self) -> str: + return "" + + def info(self) -> str: + return "" + + +@pytest.fixture +def mock_plugin(mocker: MockerFixture, config: BaseConfig) -> BaseCommitizen: + mock = MockPlugin(config) + mocker.patch("commitizen.factory.committer_factory", return_value=mock) + return mock + + +SUPPORTED_FORMATS = ("markdown", "textile", "asciidoc", "restructuredtext") + + +@pytest.fixture(params=SUPPORTED_FORMATS) +def changelog_format( + config: BaseConfig, request: pytest.FixtureRequest +) -> ChangelogFormat: + """For tests relying on formats specifics""" + format: str = request.param + config.settings["changelog_format"] = format + if "tmp_commitizen_project" in request.fixturenames: + tmp_commitizen_project = request.getfixturevalue("tmp_commitizen_project") + pyproject = tmp_commitizen_project / "pyproject.toml" + with pyproject.open("a", encoding="utf-8") as f: + f.write(f'\nchangelog_format = "{format}"\n') + return get_changelog_format(config) + + +@pytest.fixture +def any_changelog_format(config: BaseConfig) -> ChangelogFormat: + """For test not relying on formats specifics, use the default""" + config.settings["changelog_format"] = defaults.CHANGELOG_FORMAT + return get_changelog_format(config) + + +@pytest.fixture(params=[pytest.param(PYTHON_VERSION, id=f"py_{PYTHON_VERSION}")]) +def python_version(request: pytest.FixtureRequest) -> str: + """The current python version in '{major}.{minor}' format""" + return cast("str", request.param) + + +@pytest.fixture +def consistent_terminal_output(monkeypatch: pytest.MonkeyPatch): + """Force consistent terminal output.""" + monkeypatch.setenv("COLUMNS", "80") + monkeypatch.setenv("TERM", "dumb") + monkeypatch.setenv("LC_ALL", "C") + monkeypatch.setenv("LANG", "C") + monkeypatch.setenv("NO_COLOR", "1") + monkeypatch.setenv("PAGER", "cat") diff --git a/tests/data/CHANGELOG_FOR_TEST.md b/tests/data/CHANGELOG_FOR_TEST.md new file mode 100644 index 0000000000..e92ca1ce39 --- /dev/null +++ b/tests/data/CHANGELOG_FOR_TEST.md @@ -0,0 +1,129 @@ + +## v1.2.0 (2019-04-19) + +### feat + +- custom cz plugins now support bumping version + +## v1.1.1 (2019-04-18) + +### refactor + +- changed stdout statements +- **schema**: command logic removed from commitizen base +- **info**: command logic removed from commitizen base +- **example**: command logic removed from commitizen base +- **commit**: moved most of the commit logic to the commit command + +### fix + +- **bump**: commit message now fits better with semver +- conventional commit 'breaking change' in body instead of title + +## v1.1.0 (2019-04-14) + +### feat + +- new working bump command +- create version tag +- update given files with new version +- **config**: new set key, used to set version to cfg +- support for pyproject.toml +- first semantic version bump implementation + +### fix + +- removed all from commit +- fix config file not working + +### refactor + +- added commands folder, better integration with decli + +## v1.0.0 (2019-03-01) + +### refactor + +- removed delegator, added decli and many tests + +### BREAKING CHANGE + +- API is stable + +## 1.0.0b2 (2019-01-18) + +## v1.0.0b1 (2019-01-17) + +### feat + +- py3 only, tests and conventional commits 1.0 + +## v0.9.11 (2018-12-17) + +### fix + +- **config**: load config reads in order without failing if there is no commitizen section + +## v0.9.10 (2018-09-22) + +### fix + +- parse scope (this is my punishment for not having tests) + +## v0.9.9 (2018-09-22) + +### fix + +- parse scope empty + +## v0.9.8 (2018-09-22) + +### fix + +- **scope**: parse correctly again + +## v0.9.7 (2018-09-22) + +### fix + +- **scope**: parse correctly + +## v0.9.6 (2018-09-19) + +### refactor + +- **conventionalCommit**: moved filters to questions instead of message + +### fix + +- **manifest**: included missing files + +## v0.9.5 (2018-08-24) + +### fix + +- **config**: home path for python versions between 3.0 and 3.5 + +## v0.9.4 (2018-08-02) + +### feat + +- **cli**: added version + +## v0.9.3 (2018-07-28) + +### feat + +- **committer**: conventional commit is a bit more intelligent now + +## v0.9.2 (2017-11-11) + +### refactor + +- renamed conventional_changelog to conventional_commits, not backward compatible + +## v0.9.1 (2017-11-11) + +### fix + +- **setup.py**: future is now required for every python version diff --git a/tests/data/encoding_test_composer.json b/tests/data/encoding_test_composer.json new file mode 100644 index 0000000000..2cbf2e70cc --- /dev/null +++ b/tests/data/encoding_test_composer.json @@ -0,0 +1,6 @@ +{ + "name": "encoding-test-composer", + "description": "Тест описания для проверки кодировки", + "version": "0.1.0" +} + diff --git a/tests/data/encoding_test_pyproject.toml b/tests/data/encoding_test_pyproject.toml new file mode 100644 index 0000000000..6e47e88ecd --- /dev/null +++ b/tests/data/encoding_test_pyproject.toml @@ -0,0 +1,36 @@ +[project] +name = "pythonproject-test" +version = "0.4.1" +description = "Add your description here" +readme = "README.md" +requires-python = ">=3.12" +dependencies = [] + + +[tool.commitizen] +name = "cz_customize" +tag_format = "v$version" +version_scheme = "pep440" +version_provider = "uv" +update_changelog_on_bump = true +changelog_start_rev = "v1.1.0" + +[tool.commitizen.customize] +message_template = "{{ change_type }}{% if scope != 'none' %}({{ scope }}){% endif %}: {{ message }}" +commit_parser = '^(?P<change_type>feat|fix|refactor|test|perf|misc):\s(?P<message>.*)' +schema_pattern = '(feat|fix|refactor|test|perf|misc)(\((api|core)\))?:\s(.{3,})' +bump_pattern = "^(feat|fix|refactor|test|perf|misc)" +change_type_map = { "feat" = "Новое", "fix" = "Исправление" } + +[[tool.commitizen.customize.questions]] +name = "change_type" +type = "list" +message = "Выберите тип изменений" +choices = [ + { value = "feat", name = "feat: Новая функциональность" }, + { value = "fix", name = "fix: Исправление" }, + { value = "refactor", name = "refactor: Рефакторинг" }, + { value = "test", name = "test: Изменение авто-тестов" }, + { value = "perf", name = "perf: Оптимизации" }, + { value = "misc", name = "misc: Другое" }, +] \ No newline at end of file diff --git a/tests/data/inconsistent_version.py b/tests/data/inconsistent_version.py new file mode 100644 index 0000000000..47646762dc --- /dev/null +++ b/tests/data/inconsistent_version.py @@ -0,0 +1,4 @@ +__title__ = "requests" +__description__ = "Python HTTP for Humans." +__url__ = "http://python-requests.org" +__version__ = "2.10.3" diff --git a/tests/data/multiple_versions_to_update_pyproject.toml b/tests/data/multiple_versions_to_update_pyproject.toml new file mode 100644 index 0000000000..de4ead0343 --- /dev/null +++ b/tests/data/multiple_versions_to_update_pyproject.toml @@ -0,0 +1,27 @@ +[[package]] +name = "to-update-1" +version = "1.2.9" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "to-update-2" +version = "1.2.9" diff --git a/tests/data/multiple_versions_to_update_pyproject_wo_eol.toml b/tests/data/multiple_versions_to_update_pyproject_wo_eol.toml new file mode 100644 index 0000000000..e2746fa9eb --- /dev/null +++ b/tests/data/multiple_versions_to_update_pyproject_wo_eol.toml @@ -0,0 +1,27 @@ +[[package]] +name = "to-update-1" +version = "1.2.9" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "to-update-2" +version = "1.2.9" \ No newline at end of file diff --git a/tests/data/repeated_version_number.json b/tests/data/repeated_version_number.json new file mode 100644 index 0000000000..8421026df9 --- /dev/null +++ b/tests/data/repeated_version_number.json @@ -0,0 +1,7 @@ +{ + "name": "magictool", + "version": "1.2.3", + "dependencies": { + "lodash": "1.2.3" + } +} diff --git a/tests/data/sample_cargo.lock b/tests/data/sample_cargo.lock new file mode 100644 index 0000000000..d9dbd792bb --- /dev/null +++ b/tests/data/sample_cargo.lock @@ -0,0 +1,11 @@ +[[package]] +name = "textwrap" +version = "1.2.3" + +[[package]] +name = "there-i-fixed-it" +version = "1.2.3" # automatically bumped by Commitizen + +[[package]] +name = "other-project" +version = "1.2.3" diff --git a/tests/data/sample_docker_compose.yaml b/tests/data/sample_docker_compose.yaml new file mode 100644 index 0000000000..9da8caf1f6 --- /dev/null +++ b/tests/data/sample_docker_compose.yaml @@ -0,0 +1,6 @@ +version: "3.3" + +services: + app: + image: my-repo/my-container:v1.2.3 + command: my-command diff --git a/tests/data/sample_pyproject.toml b/tests/data/sample_pyproject.toml new file mode 100644 index 0000000000..9f50155cb7 --- /dev/null +++ b/tests/data/sample_pyproject.toml @@ -0,0 +1,3 @@ +[tool.poetry] +name = "commitizen" +version = "1.2.3" diff --git a/tests/data/sample_version.py b/tests/data/sample_version.py new file mode 100644 index 0000000000..4dd4512dba --- /dev/null +++ b/tests/data/sample_version.py @@ -0,0 +1,4 @@ +__title__ = "requests" +__description__ = "Python HTTP for Humans." +__url__ = "http://python-requests.org" +__version__ = "1.2.3" diff --git a/tests/providers/test_base_provider.py b/tests/providers/test_base_provider.py new file mode 100644 index 0000000000..4129fa8c22 --- /dev/null +++ b/tests/providers/test_base_provider.py @@ -0,0 +1,124 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen.exceptions import VersionProviderUnknown +from commitizen.providers import get_provider +from commitizen.providers.commitizen_provider import CommitizenProvider +from commitizen.providers.composer_provider import ComposerProvider +from commitizen.providers.pep621_provider import Pep621Provider +from commitizen.providers.uv_provider import UvProvider + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + + +def test_default_version_provider_is_commitizen_config(config: BaseConfig): + provider = get_provider(config) + + assert isinstance(provider, CommitizenProvider) + + +def test_raise_for_unknown_provider(config: BaseConfig): + config.settings["version_provider"] = "unknown" + with pytest.raises(VersionProviderUnknown): + get_provider(config) + + +@pytest.mark.parametrize("encoding", ["utf-8", "latin-1"]) +def test_file_provider_get_encoding(config: BaseConfig, encoding: str): + """_get_encoding should return the configured encoding.""" + config.settings["encoding"] = encoding + provider = ComposerProvider(config) + assert provider._get_encoding() == encoding + + +def test_json_provider_uses_encoding_with_encoding_fixture( + config: BaseConfig, + chdir: Path, + data_dir: Path, +): + """JsonProvider should correctly read a JSON file with non-ASCII content.""" + source = data_dir / "encoding_test_composer.json" + target = chdir / "composer.json" + target.write_text(source.read_text(encoding="utf-8"), encoding="utf-8") + + config.settings["encoding"] = "utf-8" + config.settings["version_provider"] = "composer" + + provider = get_provider(config) + assert isinstance(provider, ComposerProvider) + assert provider.get_version() == "0.1.0" + + +def test_toml_provider_uses_encoding_with_encoding_fixture( + config: BaseConfig, + chdir: Path, + data_dir: Path, +): + """TomlProvider should correctly read a TOML file with non-ASCII content.""" + source = data_dir / "encoding_test_pyproject.toml" + target = chdir / "pyproject.toml" + target.write_text(source.read_text(encoding="utf-8"), encoding="utf-8") + + config.settings["encoding"] = "utf-8" + config.settings["version_provider"] = "uv" + + provider = get_provider(config) + assert isinstance(provider, UvProvider) + assert provider.get_version() == "0.4.1" + + +def test_json_provider_handles_various_unicode_characters( + config: BaseConfig, + chdir: Path, +): + """JsonProvider should handle a wide range of Unicode characters.""" + config.settings["encoding"] = "utf-8" + config.settings["version_provider"] = "composer" + + filename = ComposerProvider.filename + file = chdir / filename + file.write_text( + ( + "{\n" + ' "name": "多言語-имя-árbol",\n' + ' "description": "Emoji 😀 – 漢字 – العربية",\n' + ' "version": "0.1.0"\n' + "}\n" + ), + encoding="utf-8", + ) + + provider = get_provider(config) + assert isinstance(provider, ComposerProvider) + assert provider.get_version() == "0.1.0" + + +def test_toml_provider_handles_various_unicode_characters( + config: BaseConfig, + chdir: Path, +): + """TomlProvider should handle a wide range of Unicode characters.""" + config.settings["encoding"] = "utf-8" + config.settings["version_provider"] = "pep621" + + filename = Pep621Provider.filename + file = chdir / filename + file.write_text( + ( + "[project]\n" + 'name = "多言語-имя-árbol"\n' + 'description = "Emoji 😀 – 漢字 – العربية"\n' + 'version = "0.1.0"\n' + ), + encoding="utf-8", + ) + + provider = get_provider(config) + assert isinstance(provider, Pep621Provider) + assert provider.get_version() == "0.1.0" diff --git a/tests/providers/test_cargo_provider.py b/tests/providers/test_cargo_provider.py new file mode 100644 index 0000000000..63f143b291 --- /dev/null +++ b/tests/providers/test_cargo_provider.py @@ -0,0 +1,453 @@ +from __future__ import annotations + +import os +from pathlib import Path +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.cargo_provider import CargoProvider + +if TYPE_CHECKING: + from commitizen.config.base_config import BaseConfig + +CARGO_TOML = """\ +[package] +name = "whatever" +version = "0.1.0" +""" + +CARGO_TOML_EXPECTED = """\ +[package] +name = "whatever" +version = "42.1" +""" + +CARGO_WORKSPACE_TOML = """\ +[workspace] +members = ["member1", "folder/member2", "crates/*"] +exclude = ["crates/member4", "folder/member5"] + +[workspace.package] +version = "0.1.0" +""" + +CARGO_WORKSPACE_MEMBERS = [ + { + "path": "member1", + "content": """\ +[package] +name = "member1" +version.workspace = true +""", + }, + { + "path": "folder/member2", + "content": """\ +[package] +name = "member2" +version.workspace = "1.1.1" +""", + }, + { + "path": "crates/member3", + "content": """\ +[package] +name = "member3" +version.workspace = true +""", + }, + { + "path": "crates/member4", + "content": """\ +[package] +name = "member4" +version.workspace = "2.2.2" +""", + }, + { + "path": "folder/member5", + "content": """\ +[package] +name = "member5" +version.workspace = "3.3.3" +""", + }, +] + + +CARGO_WORKSPACE_TOML_EXPECTED = """\ +[workspace] +members = ["member1", "folder/member2", "crates/*"] +exclude = ["crates/member4", "folder/member5"] + +[workspace.package] +version = "42.1" +""" + +CARGO_LOCK = """\ +[[package]] +name = "whatever" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] +""" + +CARGO_LOCK_EXPECTED = """\ +[[package]] +name = "whatever" +version = "42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] +""" + +CARGO_WORKSPACE_LOCK = """\ +[[package]] +name = "member1" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member2" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member3" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member4" +version = "2.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member5" +version = "3.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] +""" + +CARGO_WORKSPACE_LOCK_EXPECTED = """\ +[[package]] +name = "member1" +version = "42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member2" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member3" +version = "42.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member4" +version = "2.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] + +[[package]] +name = "member5" +version = "3.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +dependencies = [ + "packageA", + "packageB", + "packageC", +] +""" + + +@pytest.mark.parametrize( + ("content", "expected"), + [ + (CARGO_TOML, CARGO_TOML_EXPECTED), + (CARGO_WORKSPACE_TOML, CARGO_WORKSPACE_TOML_EXPECTED), + ], +) +def test_cargo_provider( + config: BaseConfig, + chdir: Path, + content: str, + expected: str, +): + filename = CargoProvider.filename + file = chdir / filename + file.write_text(dedent(content)) + config.settings["version_provider"] = "cargo" + + provider = get_provider(config) + assert isinstance(provider, CargoProvider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + assert file.read_text() == dedent(expected) + + +@pytest.mark.parametrize( + ("toml_content", "lock_content", "toml_expected", "lock_expected"), + [ + ( + CARGO_TOML, + CARGO_LOCK, + CARGO_TOML_EXPECTED, + CARGO_LOCK_EXPECTED, + ), + ( + CARGO_WORKSPACE_TOML, + CARGO_WORKSPACE_LOCK, + CARGO_WORKSPACE_TOML_EXPECTED, + CARGO_WORKSPACE_LOCK_EXPECTED, + ), + ], +) +def test_cargo_provider_with_lock( + config: BaseConfig, + chdir: Path, + toml_content: str, + lock_content: str, + toml_expected: str, + lock_expected: str, +): + filename = CargoProvider.filename + file = chdir / filename + file.write_text(dedent(toml_content)) + + # Create workspace members + os.mkdir(chdir / "crates") + os.mkdir(chdir / "folder") + for i in range(0, 5): + member_folder = Path(CARGO_WORKSPACE_MEMBERS[i]["path"]) + os.mkdir(member_folder) + member_file = member_folder / "Cargo.toml" + member_file.write_text(dedent(CARGO_WORKSPACE_MEMBERS[i]["content"])) + + lock_filename = CargoProvider.lock_filename + lock_file = chdir / lock_filename + lock_file.write_text(dedent(lock_content)) + config.settings["version_provider"] = "cargo" + + provider = get_provider(config) + assert isinstance(provider, CargoProvider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + assert file.read_text() == dedent(toml_expected) + assert lock_file.read_text() == dedent(lock_expected) + + +def test_cargo_provider_workspace_member_without_version_key( + config: BaseConfig, + chdir: Path, +): + """Test workspace member that has no version key at all (should not crash).""" + workspace_toml = """\ +[workspace] +members = ["member_without_version"] + +[workspace.package] +version = "0.1.0" +""" + + # Create a member that has no version key at all + member_content = """\ +[package] +name = "member_without_version" +# No version key - this should trigger NonExistentKey exception +""" + + lock_content = """\ +[[package]] +name = "member_without_version" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +""" + + expected_workspace_toml = """\ +[workspace] +members = ["member_without_version"] + +[workspace.package] +version = "42.1" +""" + + expected_lock_content = """\ +[[package]] +name = "member_without_version" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +""" + + # Create the workspace file + filename = CargoProvider.filename + file = chdir / filename + file.write_text(dedent(workspace_toml)) + + # Create the member directory and file + os.mkdir(chdir / "member_without_version") + member_file = chdir / "member_without_version" / "Cargo.toml" + member_file.write_text(dedent(member_content)) + + # Create the lock file + lock_filename = CargoProvider.lock_filename + lock_file = chdir / lock_filename + lock_file.write_text(dedent(lock_content)) + + config.settings["version_provider"] = "cargo" + + provider = get_provider(config) + assert isinstance(provider, CargoProvider) + assert provider.get_version() == "0.1.0" + + # This should not crash even though the member has no version key + provider.set_version("42.1") + assert file.read_text() == dedent(expected_workspace_toml) + # The lock file should remain unchanged since the member doesn't inherit workspace version + assert lock_file.read_text() == dedent(expected_lock_content) + + +def test_cargo_provider_workspace_member_without_workspace_key( + config: BaseConfig, + chdir: Path, +): + """Test workspace member that has version key but no workspace subkey.""" + workspace_toml = """\ +[workspace] +members = ["member_without_workspace"] + +[workspace.package] +version = "0.1.0" +""" + + # Create a member that has version as a table but no workspace subkey + # This should trigger NonExistentKey when trying to access version["workspace"] + member_content = """\ +[package] +name = "member_without_workspace" + +[package.version] +# Has version table but no workspace key - should trigger NonExistentKey +""" + + lock_content = """\ +[[package]] +name = "member_without_workspace" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +""" + + expected_workspace_toml = """\ +[workspace] +members = ["member_without_workspace"] + +[workspace.package] +version = "42.1" +""" + + expected_lock_content = """\ +[[package]] +name = "member_without_workspace" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "123abc" +""" + + # Create the workspace file + filename = CargoProvider.filename + file = chdir / filename + file.write_text(dedent(workspace_toml)) + + # Create the member directory and file + os.mkdir(chdir / "member_without_workspace") + member_file = chdir / "member_without_workspace" / "Cargo.toml" + member_file.write_text(dedent(member_content)) + + # Create the lock file + lock_filename = CargoProvider.lock_filename + lock_file = chdir / lock_filename + lock_file.write_text(dedent(lock_content)) + + config.settings["version_provider"] = "cargo" + + provider = get_provider(config) + assert isinstance(provider, CargoProvider) + assert provider.get_version() == "0.1.0" + + # This should not crash even though the member has no version.workspace key + provider.set_version("42.1") + assert file.read_text() == dedent(expected_workspace_toml) + # The lock file should remain unchanged since the member doesn't inherit workspace version + assert lock_file.read_text() == dedent(expected_lock_content) diff --git a/tests/providers/test_commitizen_provider.py b/tests/providers/test_commitizen_provider.py new file mode 100644 index 0000000000..c28dc90f79 --- /dev/null +++ b/tests/providers/test_commitizen_provider.py @@ -0,0 +1,21 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +from commitizen.providers.commitizen_provider import CommitizenProvider + +if TYPE_CHECKING: + from pytest_mock import MockerFixture + + from commitizen.config.base_config import BaseConfig + + +def test_commitizen_provider(config: BaseConfig, mocker: MockerFixture): + config.settings["version"] = "42" + mock = mocker.patch.object(config, "set_key") + + provider = CommitizenProvider(config) + assert provider.get_version() == "42" + + provider.set_version("43.1") + mock.assert_called_once_with("version", "43.1") diff --git a/tests/providers/test_composer_provider.py b/tests/providers/test_composer_provider.py new file mode 100644 index 0000000000..b3068a6fd6 --- /dev/null +++ b/tests/providers/test_composer_provider.py @@ -0,0 +1,51 @@ +from __future__ import annotations + +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.composer_provider import ComposerProvider + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +COMPOSER_JSON = """\ +{ + "name": "whatever", + "version": "0.1.0" +} +""" + +COMPOSER_EXPECTED = """\ +{ + "name": "whatever", + "version": "42.1" +} +""" + + +@pytest.mark.parametrize( + ("content", "expected"), + [(COMPOSER_JSON, COMPOSER_EXPECTED)], +) +def test_composer_provider( + config: BaseConfig, + chdir: Path, + content: str, + expected: str, +): + filename = ComposerProvider.filename + file = chdir / filename + file.write_text(dedent(content)) + config.settings["version_provider"] = "composer" + + provider = get_provider(config) + assert isinstance(provider, ComposerProvider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + assert file.read_text() == dedent(expected) diff --git a/tests/providers/test_npm_provider.py b/tests/providers/test_npm_provider.py new file mode 100644 index 0000000000..429b46fac9 --- /dev/null +++ b/tests/providers/test_npm_provider.py @@ -0,0 +1,158 @@ +from __future__ import annotations + +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.npm_provider import NpmProvider + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +NPM_PACKAGE_JSON = """\ +{ + "name": "whatever", + "version": "0.1.0" +} +""" + +NPM_PACKAGE_EXPECTED = """\ +{ + "name": "whatever", + "version": "42.1" +} +""" + +NPM_LOCKFILE_JSON = """\ +{ + "name": "whatever", + "version": "0.1.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "whatever", + "version": "0.1.0" + }, + "someotherpackage": { + "version": "0.1.0" + } + } +} +""" + +NPM_LOCKFILE_EXPECTED = """\ +{ + "name": "whatever", + "version": "42.1", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "whatever", + "version": "42.1" + }, + "someotherpackage": { + "version": "0.1.0" + } + } +} +""" + +NPM_PACKAGE_JSON_LATIN1 = """\ +{ + "name": "calf\u00e9-n\u00famero", + "version": "0.1.0" +} +""" + +NPM_LOCKFILE_JSON_LATIN1 = """\ +{ + "name": "calf\u00e9-n\u00famero", + "version": "0.1.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "calf\u00e9-n\u00famero", + "version": "0.1.0" + } + } +} +""" + + +@pytest.mark.parametrize( + ("pkg_shrinkwrap_content", "pkg_shrinkwrap_expected"), + [(NPM_LOCKFILE_JSON, NPM_LOCKFILE_EXPECTED), (None, None)], +) +@pytest.mark.parametrize( + ("pkg_lock_content", "pkg_lock_expected"), + [(NPM_LOCKFILE_JSON, NPM_LOCKFILE_EXPECTED), (None, None)], +) +def test_npm_provider( + config: BaseConfig, + chdir: Path, + pkg_lock_content: str, + pkg_lock_expected: str, + pkg_shrinkwrap_content: str, + pkg_shrinkwrap_expected: str, +): + pkg = chdir / NpmProvider.package_filename + pkg.write_text(dedent(NPM_PACKAGE_JSON)) + if pkg_lock_content: + pkg_lock = chdir / NpmProvider.lock_filename + pkg_lock.write_text(dedent(pkg_lock_content)) + if pkg_shrinkwrap_content: + pkg_shrinkwrap = chdir / NpmProvider.shrinkwrap_filename + pkg_shrinkwrap.write_text(dedent(pkg_shrinkwrap_content)) + config.settings["version_provider"] = "npm" + + provider = get_provider(config) + assert isinstance(provider, NpmProvider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + assert pkg.read_text() == dedent(NPM_PACKAGE_EXPECTED) + if pkg_lock_content: + assert pkg_lock.read_text() == dedent(pkg_lock_expected) + if pkg_shrinkwrap_content: + assert pkg_shrinkwrap.read_text() == dedent(pkg_shrinkwrap_expected) + + +def test_npm_provider_respects_configured_encoding_for_all_files( + config: BaseConfig, + chdir: Path, +): + """NpmProvider should use the configured encoding for all files it touches.""" + config.settings["encoding"] = "latin-1" + config.settings["version_provider"] = "npm" + + pkg = chdir / NpmProvider.package_filename + pkg_lock = chdir / NpmProvider.lock_filename + pkg_shrinkwrap = chdir / NpmProvider.shrinkwrap_filename + + # Write initial contents using latin-1 encoding + pkg.write_text(dedent(NPM_PACKAGE_JSON_LATIN1), encoding="latin-1") + pkg_lock.write_text(dedent(NPM_LOCKFILE_JSON_LATIN1), encoding="latin-1") + pkg_shrinkwrap.write_text(dedent(NPM_LOCKFILE_JSON_LATIN1), encoding="latin-1") + + provider = get_provider(config) + assert isinstance(provider, NpmProvider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + + # Verify that the files can be read back using the configured encoding + pkg_text = pkg.read_text(encoding="latin-1") + pkg_lock_text = pkg_lock.read_text(encoding="latin-1") + pkg_shrinkwrap_text = pkg_shrinkwrap.read_text(encoding="latin-1") + + # Version was updated everywhere + assert '"version": "42.1"' in pkg_text + assert '"version": "42.1"' in pkg_lock_text + assert '"version": "42.1"' in pkg_shrinkwrap_text diff --git a/tests/providers/test_pep621_provider.py b/tests/providers/test_pep621_provider.py new file mode 100644 index 0000000000..e0ae0ba949 --- /dev/null +++ b/tests/providers/test_pep621_provider.py @@ -0,0 +1,47 @@ +from __future__ import annotations + +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.pep621_provider import Pep621Provider + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +PEP621_TOML = """\ +[project] +version = "0.1.0" +""" + +PEP621_EXPECTED = """\ +[project] +version = "42.1" +""" + + +@pytest.mark.parametrize( + ("content", "expected"), + [(PEP621_TOML, PEP621_EXPECTED)], +) +def test_cargo_provider( + config: BaseConfig, + chdir: Path, + content: str, + expected: str, +): + filename = Pep621Provider.filename + file = chdir / filename + file.write_text(dedent(content)) + config.settings["version_provider"] = "pep621" + + provider = get_provider(config) + assert isinstance(provider, Pep621Provider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + assert file.read_text() == dedent(expected) diff --git a/tests/providers/test_poetry_provider.py b/tests/providers/test_poetry_provider.py new file mode 100644 index 0000000000..2a7841b8a1 --- /dev/null +++ b/tests/providers/test_poetry_provider.py @@ -0,0 +1,47 @@ +from __future__ import annotations + +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.poetry_provider import PoetryProvider + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +POETRY_TOML = """\ +[tool.poetry] +version = "0.1.0" +""" + +POETRY_EXPECTED = """\ +[tool.poetry] +version = "42.1" +""" + + +@pytest.mark.parametrize( + ("content", "expected"), + [(POETRY_TOML, POETRY_EXPECTED)], +) +def test_cargo_provider( + config: BaseConfig, + chdir: Path, + content: str, + expected: str, +): + filename = PoetryProvider.filename + file = chdir / filename + file.write_text(dedent(content)) + config.settings["version_provider"] = "poetry" + + provider = get_provider(config) + assert isinstance(provider, PoetryProvider) + assert provider.get_version() == "0.1.0" + + provider.set_version("42.1") + assert file.read_text() == dedent(expected) diff --git a/tests/providers/test_scm_provider.py b/tests/providers/test_scm_provider.py new file mode 100644 index 0000000000..d3f0299f47 --- /dev/null +++ b/tests/providers/test_scm_provider.py @@ -0,0 +1,142 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.scm_provider import ScmProvider + +if TYPE_CHECKING: + from commitizen.config.base_config import BaseConfig + from tests.utils import UtilFixture + + +@pytest.mark.parametrize( + ("tag_format", "tag", "expected_version"), + [ + # If tag_format is $version (the default), version_scheme.parser is used. + # Its DEFAULT_VERSION_PARSER allows a v prefix, but matches PEP440 otherwise. + ("$version", "no-match-because-version-scheme-is-strict", "0.0.0"), + ("$version", "0.1.0", "0.1.0"), + ("$version", "v0.1.0", "0.1.0"), + ("$version", "v-0.1.0", "0.0.0"), + # If tag_format is not None or $version, TAG_FORMAT_REGEXS are used, which are + # much more lenient but require a v prefix. + ("v$version", "v0.1.0", "0.1.0"), + ("v$version", "no-match-because-no-v-prefix", "0.0.0"), + # no match because not a valid version + ("v$version", "v-match-TAG_FORMAT_REGEXS", "0.0.0"), + ("version-$version", "version-0.1.0", "0.1.0"), + ("version-$version", "version-0.1", "0.1"), + ("version-$version", "version-0.1.0rc1", "0.1.0rc1"), + ("v$minor.$major.$patch", "v1.0.0", "0.1.0"), + ("version-$major.$minor.$patch", "version-0.1.0", "0.1.0"), + ("v$major.$minor$prerelease$devrelease", "v1.0rc1", "1.0rc1"), + ("v$major.$minor.$patch$prerelease$devrelease", "v0.1.0", "0.1.0"), + ("v$major.$minor.$patch$prerelease$devrelease", "v0.1.0rc1", "0.1.0rc1"), + ("v$major.$minor.$patch$prerelease$devrelease", "v1.0.0.dev0", "1.0.0.dev0"), + ], +) +@pytest.mark.usefixtures("tmp_git_project") +def test_scm_provider( + config: BaseConfig, + tag_format: str, + tag: str, + expected_version: str, + util: UtilFixture, +): + util.create_file_and_commit("test: fake commit") + util.create_tag(tag) + util.create_file_and_commit("test: fake commit") + util.create_tag("should-not-match") + + config.settings["version_provider"] = "scm" + config.settings["tag_format"] = tag_format + + provider = get_provider(config) + assert isinstance(provider, ScmProvider) + actual_version = provider.get_version() + assert actual_version == expected_version + + # Should not fail on set_version() + provider.set_version("43.1") + + +@pytest.mark.usefixtures("tmp_git_project") +def test_scm_provider_default_without_commits_and_tags(config: BaseConfig): + config.settings["version_provider"] = "scm" + + provider = get_provider(config) + assert isinstance(provider, ScmProvider) + assert provider.get_version() == "0.0.0" + + +@pytest.mark.usefixtures("tmp_git_project") +def test_scm_provider_default_with_commits_and_tags( + config: BaseConfig, util: UtilFixture +): + config.settings["version_provider"] = "scm" + + provider = get_provider(config) + assert isinstance(provider, ScmProvider) + assert provider.get_version() == "0.0.0" + + util.create_file_and_commit("Initial state") + util.create_tag("1.0.0") + # create develop + util.create_branch("develop") + util.switch_branch("develop") + + # add a feature to develop + util.create_file_and_commit("develop: add beta feature1") + assert provider.get_version() == "1.0.0" + util.create_tag("1.1.0b0") + + # create staging + util.create_branch("staging") + util.switch_branch("staging") + util.create_file_and_commit("staging: Starting release candidate") + assert provider.get_version() == "1.1.0b0" + util.create_tag("1.1.0rc0") + + # add another feature to develop + util.switch_branch("develop") + util.create_file_and_commit("develop: add beta feature2") + assert provider.get_version() == "1.1.0b0" + util.create_tag("1.2.0b0") + + # add a hotfix to master + util.switch_branch("master") + util.create_file_and_commit("master: add hotfix") + assert provider.get_version() == "1.0.0" + util.create_tag("1.0.1") + + # merge the hotfix to staging + util.switch_branch("staging") + util.merge_branch("master") + + assert provider.get_version() == "1.1.0rc0" + + +@pytest.mark.usefixtures("tmp_git_project") +def test_scm_provider_detect_legacy_tags(config: BaseConfig, util: UtilFixture): + config.settings["version_provider"] = "scm" + config.settings["tag_format"] = "v${version}" + config.settings["legacy_tag_formats"] = [ + "legacy-${version}", + "old-${version}", + ] + provider = get_provider(config) + + util.create_file_and_commit("test: fake commit") + util.create_tag("old-0.4.1") + assert provider.get_version() == "0.4.1" + + util.create_file_and_commit("test: fake commit") + util.create_tag("legacy-0.4.2") + assert provider.get_version() == "0.4.2" + + util.create_file_and_commit("test: fake commit") + util.create_tag("v0.5.0") + assert provider.get_version() == "0.5.0" diff --git a/tests/providers/test_uv_provider.py b/tests/providers/test_uv_provider.py new file mode 100644 index 0000000000..e0da979160 --- /dev/null +++ b/tests/providers/test_uv_provider.py @@ -0,0 +1,121 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen.providers import get_provider +from commitizen.providers.uv_provider import UvProvider + +if TYPE_CHECKING: + from pytest_regressions.file_regression import FileRegressionFixture + + from commitizen.config.base_config import BaseConfig + + +PYPROJECT_TOML = """ +[project] +name = "test-uv" +version = "4.2.1" +description = "Add your description here" +readme = "README.md" +requires-python = ">=3.13" +dependencies = ["commitizen==4.2.1"] +""" + +PYPROJECT_TOML_UNDERSCORE = """ +[project] +name = "test_uv" +version = "4.2.1" +description = "Add your description here" +readme = "README.md" +requires-python = ">=3.13" +dependencies = ["commitizen==4.2.1"] +""" + +UV_LOCK_SIMPLIFIED = """ +version = 1 +revision = 1 +requires-python = ">=3.13" + +[[package]] +name = "commitizen" +version = "4.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "argcomplete" }, + { name = "charset-normalizer" }, + { name = "colorama" }, + { name = "decli" }, + { name = "jinja2" }, + { name = "packaging" }, + { name = "pyyaml" }, + { name = "questionary" }, + { name = "termcolor" }, + { name = "tomlkit" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d8/a3/77ffc9aee014cbf46c84c9f156a1ddef2d4c7cfb87d567decf2541464245/commitizen-4.2.1.tar.gz", hash = "sha256:5255416f6d6071068159f0b97605777f3e25d00927ff157b7a8d01efeda7b952", size = 50645 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/57/ce/2f5d8ebe8376991b5f805e9f33d20c7f4c9ca6155bdbda761117dc41dff1/commitizen-4.2.1-py3-none-any.whl", hash = "sha256:a347889e0fe408c3b920a34130d8f35616be3ea8ac6b7b20c5b9aac19762661b", size = 72646 }, +] + +[[package]] +name = "decli" +version = "0.6.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3d/a0/a4658f93ecb589f479037b164dc13c68d108b50bf6594e54c820749f97ac/decli-0.6.2.tar.gz", hash = "sha256:36f71eb55fd0093895efb4f416ec32b7f6e00147dda448e3365cf73ceab42d6f", size = 7424 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bf/70/3ea48dc9e958d7d66c44c9944809181f1ca79aaef25703c023b5092d34ff/decli-0.6.2-py3-none-any.whl", hash = "sha256:2fc84106ce9a8f523ed501ca543bdb7e416c064917c12a59ebdc7f311a97b7ed", size = 7854 }, +] + +[[package]] +name = "test-uv" +version = "4.2.1" +source = { virtual = "." } +dependencies = [ + { name = "commitizen" }, +] +""" + + +@pytest.mark.parametrize( + "pyproject_content", + [ + pytest.param(PYPROJECT_TOML, id="hyphenated"), + pytest.param(PYPROJECT_TOML_UNDERSCORE, id="underscore"), + ], +) +def test_uv_provider( + config: BaseConfig, + tmp_path, + monkeypatch, + file_regression: FileRegressionFixture, + pyproject_content: str, +): + monkeypatch.chdir(tmp_path) + pyproject_toml_file = tmp_path / UvProvider.filename + pyproject_toml_file.write_text(pyproject_content, encoding="utf-8") + + uv_lock_file = tmp_path / UvProvider.lock_filename + uv_lock_file.write_text(UV_LOCK_SIMPLIFIED, encoding="utf-8") + + config.settings["version_provider"] = "uv" + + provider = get_provider(config) + assert isinstance(provider, UvProvider) + assert provider.get_version() == "4.2.1" + + provider.set_version("100.100.100") + assert provider.get_version() == "100.100.100" + + updated_pyproject_toml_content = pyproject_toml_file.read_text(encoding="utf-8") + updated_uv_lock_content = uv_lock_file.read_text(encoding="utf-8") + + for content in (updated_pyproject_toml_content, updated_uv_lock_content): + # updated project version + assert "100.100.100" in content + # commitizen version which was the same as project version and should not be affected + assert "4.2.1" in content + + file_regression.check(updated_pyproject_toml_content, extension=".toml") + file_regression.check(updated_uv_lock_content, extension=".lock") diff --git a/tests/providers/test_uv_provider/test_uv_provider_hyphenated_.lock b/tests/providers/test_uv_provider/test_uv_provider_hyphenated_.lock new file mode 100644 index 0000000000..d353763ce3 --- /dev/null +++ b/tests/providers/test_uv_provider/test_uv_provider_hyphenated_.lock @@ -0,0 +1,42 @@ + +version = 1 +revision = 1 +requires-python = ">=3.13" + +[[package]] +name = "commitizen" +version = "4.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "argcomplete" }, + { name = "charset-normalizer" }, + { name = "colorama" }, + { name = "decli" }, + { name = "jinja2" }, + { name = "packaging" }, + { name = "pyyaml" }, + { name = "questionary" }, + { name = "termcolor" }, + { name = "tomlkit" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d8/a3/77ffc9aee014cbf46c84c9f156a1ddef2d4c7cfb87d567decf2541464245/commitizen-4.2.1.tar.gz", hash = "sha256:5255416f6d6071068159f0b97605777f3e25d00927ff157b7a8d01efeda7b952", size = 50645 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/57/ce/2f5d8ebe8376991b5f805e9f33d20c7f4c9ca6155bdbda761117dc41dff1/commitizen-4.2.1-py3-none-any.whl", hash = "sha256:a347889e0fe408c3b920a34130d8f35616be3ea8ac6b7b20c5b9aac19762661b", size = 72646 }, +] + +[[package]] +name = "decli" +version = "0.6.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3d/a0/a4658f93ecb589f479037b164dc13c68d108b50bf6594e54c820749f97ac/decli-0.6.2.tar.gz", hash = "sha256:36f71eb55fd0093895efb4f416ec32b7f6e00147dda448e3365cf73ceab42d6f", size = 7424 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bf/70/3ea48dc9e958d7d66c44c9944809181f1ca79aaef25703c023b5092d34ff/decli-0.6.2-py3-none-any.whl", hash = "sha256:2fc84106ce9a8f523ed501ca543bdb7e416c064917c12a59ebdc7f311a97b7ed", size = 7854 }, +] + +[[package]] +name = "test-uv" +version = "100.100.100" +source = { virtual = "." } +dependencies = [ + { name = "commitizen" }, +] diff --git a/tests/providers/test_uv_provider/test_uv_provider_hyphenated_.toml b/tests/providers/test_uv_provider/test_uv_provider_hyphenated_.toml new file mode 100644 index 0000000000..9fdb6eb5aa --- /dev/null +++ b/tests/providers/test_uv_provider/test_uv_provider_hyphenated_.toml @@ -0,0 +1,8 @@ + +[project] +name = "test-uv" +version = "100.100.100" +description = "Add your description here" +readme = "README.md" +requires-python = ">=3.13" +dependencies = ["commitizen==4.2.1"] diff --git a/tests/providers/test_uv_provider/test_uv_provider_underscore_.lock b/tests/providers/test_uv_provider/test_uv_provider_underscore_.lock new file mode 100644 index 0000000000..d353763ce3 --- /dev/null +++ b/tests/providers/test_uv_provider/test_uv_provider_underscore_.lock @@ -0,0 +1,42 @@ + +version = 1 +revision = 1 +requires-python = ">=3.13" + +[[package]] +name = "commitizen" +version = "4.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "argcomplete" }, + { name = "charset-normalizer" }, + { name = "colorama" }, + { name = "decli" }, + { name = "jinja2" }, + { name = "packaging" }, + { name = "pyyaml" }, + { name = "questionary" }, + { name = "termcolor" }, + { name = "tomlkit" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d8/a3/77ffc9aee014cbf46c84c9f156a1ddef2d4c7cfb87d567decf2541464245/commitizen-4.2.1.tar.gz", hash = "sha256:5255416f6d6071068159f0b97605777f3e25d00927ff157b7a8d01efeda7b952", size = 50645 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/57/ce/2f5d8ebe8376991b5f805e9f33d20c7f4c9ca6155bdbda761117dc41dff1/commitizen-4.2.1-py3-none-any.whl", hash = "sha256:a347889e0fe408c3b920a34130d8f35616be3ea8ac6b7b20c5b9aac19762661b", size = 72646 }, +] + +[[package]] +name = "decli" +version = "0.6.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3d/a0/a4658f93ecb589f479037b164dc13c68d108b50bf6594e54c820749f97ac/decli-0.6.2.tar.gz", hash = "sha256:36f71eb55fd0093895efb4f416ec32b7f6e00147dda448e3365cf73ceab42d6f", size = 7424 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bf/70/3ea48dc9e958d7d66c44c9944809181f1ca79aaef25703c023b5092d34ff/decli-0.6.2-py3-none-any.whl", hash = "sha256:2fc84106ce9a8f523ed501ca543bdb7e416c064917c12a59ebdc7f311a97b7ed", size = 7854 }, +] + +[[package]] +name = "test-uv" +version = "100.100.100" +source = { virtual = "." } +dependencies = [ + { name = "commitizen" }, +] diff --git a/tests/providers/test_uv_provider/test_uv_provider_underscore_.toml b/tests/providers/test_uv_provider/test_uv_provider_underscore_.toml new file mode 100644 index 0000000000..99b24ee8f2 --- /dev/null +++ b/tests/providers/test_uv_provider/test_uv_provider_underscore_.toml @@ -0,0 +1,8 @@ + +[project] +name = "test_uv" +version = "100.100.100" +description = "Add your description here" +readme = "README.md" +requires-python = ">=3.13" +dependencies = ["commitizen==4.2.1"] diff --git a/tests/test_bump_command.py b/tests/test_bump_command.py deleted file mode 100644 index 861057d46d..0000000000 --- a/tests/test_bump_command.py +++ /dev/null @@ -1,88 +0,0 @@ -import os -import shutil -import sys -import uuid -from pathlib import Path -from typing import Optional - -import pytest - -from commitizen import cli, cmd, git - - -@pytest.fixture -def create_project(): - current_directory = os.getcwd() - tmp_proj_path = "tests/tmp-proj" - full_tmp_path = os.path.join(current_directory, tmp_proj_path) - if not os.path.exists(full_tmp_path): - os.makedirs(full_tmp_path) - os.chdir(full_tmp_path) - yield - os.chdir(current_directory) - shutil.rmtree(full_tmp_path) - - -def create_file_and_commit(message: str, filename: Optional[str] = None): - if not filename: - filename = str(uuid.uuid4()) - Path(f"./{filename}").touch() - cmd.run("git add .") - git.commit(message) - - -def test_bump_command(mocker, create_project): - with open("./pyproject.toml", "w") as f: - f.write("[tool.commitizen]\n" 'version="0.1.0"') - - cmd.run("git init") - - # MINOR - create_file_and_commit("feat: new file") - - testargs = ["cz", "bump", "--yes"] - mocker.patch.object(sys, "argv", testargs) - cli.main() - - tag_exists = git.tag_exist("0.2.0") - assert tag_exists is True - - # PATCH - create_file_and_commit("fix: username exception") - - testargs = ["cz", "bump"] - mocker.patch.object(sys, "argv", testargs) - cli.main() - - tag_exists = git.tag_exist("0.2.1") - assert tag_exists is True - - # PRERELEASE - create_file_and_commit("feat: location") - - testargs = ["cz", "bump", "--prerelease", "alpha"] - mocker.patch.object(sys, "argv", testargs) - cli.main() - - tag_exists = git.tag_exist("0.3.0a0") - assert tag_exists is True - - # PRERELEASE BUMP CREATES VERSION WITHOUT PRERELEASE - testargs = ["cz", "bump"] - mocker.patch.object(sys, "argv", testargs) - cli.main() - - tag_exists = git.tag_exist("0.3.0") - assert tag_exists is True - - # MAJOR - create_file_and_commit( - "feat: new user interface\n\nBREAKING CHANGE: age is no longer supported" - ) - - testargs = ["cz", "bump"] - mocker.patch.object(sys, "argv", testargs) - cli.main() - - tag_exists = git.tag_exist("1.0.0") - assert tag_exists is True diff --git a/tests/test_bump_create_commit_message.py b/tests/test_bump_create_commit_message.py index 4923d0a66c..54b375335d 100644 --- a/tests/test_bump_create_commit_message.py +++ b/tests/test_bump_create_commit_message.py @@ -1,7 +1,11 @@ +import sys +from pathlib import Path +from textwrap import dedent + import pytest -from packaging.version import Version -from commitizen import bump +from commitizen import bump, cmd, exceptions +from tests.utils import UtilFixture conversion = [ ( @@ -13,10 +17,143 @@ ] -@pytest.mark.parametrize("test_input,expected", conversion) +@pytest.mark.parametrize(("test_input", "expected"), conversion) def test_create_tag(test_input, expected): current_version, new_version, message_template = test_input - new_tag = bump.create_commit_message( - Version(current_version), Version(new_version), message_template - ) + new_tag = bump.create_commit_message(current_version, new_version, message_template) assert new_tag == expected + + +@pytest.mark.parametrize("hook_runner", ["pre-commit", "prek"]) +@pytest.mark.parametrize( + "retry", + [ + pytest.param( + True, + marks=pytest.mark.skipif( + sys.version_info >= (3, 13), + reason="mirrors-prettier is not supported with Python 3.13 or higher", + ), + ), + False, + ], +) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_pre_commit_changelog(util: UtilFixture, retry, hook_runner): + util.freezer.move_to("2022-04-01") + bump_args = ["bump", "--changelog", "--yes"] + if retry: + bump_args.append("--retry") + else: + pytest.xfail("it will fail because pre-commit will reformat CHANGELOG.md") + # Configure prettier as a pre-commit hook + Path(".pre-commit-config.yaml").write_text( + dedent( + """\ + repos: + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v3.0.3 + hooks: + - id: prettier + stages: [commit] + """ + ) + ) + # Prettier inherits editorconfig + Path(".editorconfig").write_text( + dedent( + """\ + [*] + indent_size = 4 + """ + ) + ) + cmd.run("git add -A") + cmd.run('git commit -m "fix: _test"') + cmd.run(f"{hook_runner} install") + util.run_cli(*bump_args) + # Pre-commit fixed last line adding extra indent and "\" char + assert Path("CHANGELOG.md").read_text() == dedent( + """\ + ## 0.1.1 (2022-04-01) + + ### Fix + + - \\_test + """ + ) + + +@pytest.mark.parametrize("hook_runner", ["pre-commit", "prek"]) +@pytest.mark.parametrize("retry", [True, False]) +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_pre_commit_changelog_fails_always(util: UtilFixture, retry, hook_runner): + util.freezer.move_to("2022-04-01") + bump_args = ["bump", "--changelog", "--yes"] + if retry: + bump_args.append("--retry") + Path(".pre-commit-config.yaml").write_text( + dedent( + """\ + repos: + - repo: local + hooks: + - id: forbid-changelog + name: changelogs are forbidden + entry: changelogs are forbidden + language: fail + files: CHANGELOG.md + """ + ) + ) + cmd.run("git add -A") + cmd.run('git commit -m "feat: forbid changelogs"') + cmd.run(f"{hook_runner} install") + with pytest.raises(exceptions.BumpCommitFailedError): + util.run_cli(*bump_args) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_bump_with_build_metadata(util: UtilFixture): + def _add_entry(test_str: str, args: list): + Path(test_str).write_text("") + cmd.run("git add -A") + cmd.run(f'git commit -m "fix: test-{test_str}"') + cz_args = ["bump", "--changelog", "--yes"] + args + util.run_cli(*cz_args) + + util.freezer.move_to("2024-01-01") + + _add_entry("a", ["--build-metadata", "a.b.c"]) + _add_entry("b", []) + _add_entry("c", ["--build-metadata", "alongmetadatastring"]) + _add_entry("d", []) + + # Pre-commit fixed last line adding extra indent and "\" char + assert Path("CHANGELOG.md").read_text() == dedent( + """\ + ## 0.1.4 (2024-01-01) + + ### Fix + + - test-d + + ## 0.1.3+alongmetadatastring (2024-01-01) + + ### Fix + + - test-c + + ## 0.1.2 (2024-01-01) + + ### Fix + + - test-b + + ## 0.1.1+a.b.c (2024-01-01) + + ### Fix + + - test-a + """ + ) diff --git a/tests/test_bump_find_increment.py b/tests/test_bump_find_increment.py index 160457c870..8209278ed5 100644 --- a/tests/test_bump_find_increment.py +++ b/tests/test_bump_find_increment.py @@ -2,26 +2,67 @@ CC: Conventional commits SVE: Semantic version at the end """ + +import pytest + from commitizen import bump +from commitizen.cz.conventional_commits import ConventionalCommitsCz +from commitizen.git import GitCommit -NONE_INCREMENT_CC = ["docs(README): motivation", "ci: added travis"] +NONE_INCREMENT_CC = [ + "docs(README): motivation", + "ci: added travis", + "performance. Remove or disable the reimplemented linters", + "refactor that how this line starts", +] PATCH_INCREMENTS_CC = [ - "docs(README): motivation", "fix(setup.py): future is now required for every python version", + "docs(README): motivation", ] MINOR_INCREMENTS_CC = [ "feat(cli): added version", "docs(README): motivation", "fix(setup.py): future is now required for every python version", + "perf: app is much faster", + "refactor: app is much faster", +] + +MAJOR_INCREMENTS_BREAKING_CHANGE_CC = [ + "feat(cli): added version", + "docs(README): motivation", + "BREAKING CHANGE: `extends` key in config file is now used for extending other config files", + "fix(setup.py): future is now required for every python version", ] -MAJOR_INCREMENTS_CC = [ +MAJOR_INCREMENTS_BREAKING_CHANGE_ALT_CC = [ "feat(cli): added version", "docs(README): motivation", + "BREAKING-CHANGE: `extends` key in config file is now used for extending other config files", + "fix(setup.py): future is now required for every python version", +] + +MAJOR_INCREMENTS_EXCLAMATION_CC = [ + "feat(cli)!: added version", + "docs(README): motivation", + "fix(setup.py): future is now required for every python version", +] + +MAJOR_INCREMENTS_EXCLAMATION_CC_SAMPLE_2 = [ + "feat(pipeline)!: some text with breaking change" +] + +MAJOR_INCREMENTS_EXCLAMATION_OTHER_TYPE_CC = [ + "chore!: drop support for Python 3.9", + "docs(README): motivation", + "fix(setup.py): future is now required for every python version", +] + +MAJOR_INCREMENTS_EXCLAMATION_OTHER_TYPE_WITH_SCOPE_CC = [ + "chore(deps)!: drop support for Python 3.9", + "docs(README): motivation", "fix(setup.py): future is now required for every python version", - "BREAKING CHANGE: `extends` key in config file is now used for extending other config files", # noqa ] PATCH_INCREMENTS_SVE = ["readme motivation PATCH", "fix setup.py PATCH"] @@ -43,51 +84,41 @@ semantic_version_map = {"MAJOR": "MAJOR", "MINOR": "MINOR", "PATCH": "PATCH"} -def test_find_increment_type_patch(): - messages = PATCH_INCREMENTS_CC - increment_type = bump.find_increment(messages) - assert increment_type == "PATCH" - - -def test_find_increment_type_minor(): - messages = MINOR_INCREMENTS_CC - increment_type = bump.find_increment(messages) - assert increment_type == "MINOR" - - -def test_find_increment_type_major(): - messages = MAJOR_INCREMENTS_CC - increment_type = bump.find_increment(messages) - assert increment_type == "MAJOR" - - -def test_find_increment_type_patch_sve(): - messages = PATCH_INCREMENTS_SVE +@pytest.mark.parametrize( + ("messages", "expected_type"), + [ + (PATCH_INCREMENTS_CC, "PATCH"), + (MINOR_INCREMENTS_CC, "MINOR"), + (MAJOR_INCREMENTS_BREAKING_CHANGE_CC, "MAJOR"), + (MAJOR_INCREMENTS_BREAKING_CHANGE_ALT_CC, "MAJOR"), + (MAJOR_INCREMENTS_EXCLAMATION_OTHER_TYPE_CC, "MAJOR"), + (MAJOR_INCREMENTS_EXCLAMATION_OTHER_TYPE_WITH_SCOPE_CC, "MAJOR"), + (MAJOR_INCREMENTS_EXCLAMATION_CC, "MAJOR"), + (MAJOR_INCREMENTS_EXCLAMATION_CC_SAMPLE_2, "MAJOR"), + (NONE_INCREMENT_CC, None), + ], +) +def test_find_increment(messages, expected_type): + commits = [GitCommit(rev="test", title=message) for message in messages] increment_type = bump.find_increment( - messages, regex=semantic_version_pattern, increments_map=semantic_version_map + commits, + regex=ConventionalCommitsCz.bump_pattern, + increments_map=ConventionalCommitsCz.bump_map, ) - assert increment_type == "PATCH" - - -def test_find_increment_type_minor_sve(): - messages = MINOR_INCREMENTS_SVE - increment_type = bump.find_increment( - messages, regex=semantic_version_pattern, increments_map=semantic_version_map - ) - assert increment_type == "MINOR" - - -def test_find_increment_type_major_sve(): - messages = MAJOR_INCREMENTS_SVE - increment_type = bump.find_increment( - messages, regex=semantic_version_pattern, increments_map=semantic_version_map - ) - assert increment_type == "MAJOR" - - -def test_find_increment_type_none(): - messages = NONE_INCREMENT_CC + assert increment_type == expected_type + + +@pytest.mark.parametrize( + ("messages", "expected_type"), + [ + (PATCH_INCREMENTS_SVE, "PATCH"), + (MINOR_INCREMENTS_SVE, "MINOR"), + (MAJOR_INCREMENTS_SVE, "MAJOR"), + ], +) +def test_find_increment_sve(messages, expected_type): + commits = [GitCommit(rev="test", title=message) for message in messages] increment_type = bump.find_increment( - messages, regex=semantic_version_pattern, increments_map=semantic_version_map + commits, regex=semantic_version_pattern, increments_map=semantic_version_map ) - assert increment_type is None + assert increment_type == expected_type diff --git a/tests/test_bump_find_version.py b/tests/test_bump_find_version.py deleted file mode 100644 index ca1a6b57d5..0000000000 --- a/tests/test_bump_find_version.py +++ /dev/null @@ -1,75 +0,0 @@ -import itertools - -import pytest -from packaging.version import Version - -from commitizen.bump import generate_version - -simple_flow = [ - (("0.1.0", "PATCH", None), "0.1.1"), - (("0.1.1", "MINOR", None), "0.2.0"), - (("0.2.0", "MINOR", None), "0.3.0"), - (("0.3.0", "PATCH", None), "0.3.1"), - (("0.3.0", "PATCH", "alpha"), "0.3.1a0"), - (("0.3.1a0", None, "alpha"), "0.3.1a1"), - (("0.3.1a0", None, None), "0.3.1"), - (("0.3.1", "PATCH", None), "0.3.2"), - (("0.4.2", "MAJOR", "alpha"), "1.0.0a0"), - (("1.0.0a0", None, "alpha"), "1.0.0a1"), - (("1.0.0a1", None, "alpha"), "1.0.0a2"), - (("1.0.0a1", None, "beta"), "1.0.0b0"), - (("1.0.0b0", None, "beta"), "1.0.0b1"), - (("1.0.0b1", None, "rc"), "1.0.0rc0"), - (("1.0.0rc0", None, "rc"), "1.0.0rc1"), - (("1.0.0rc0", "PATCH", None), "1.0.0"), - (("1.0.0", "PATCH", None), "1.0.1"), - (("1.0.1", "PATCH", None), "1.0.2"), - (("1.0.2", "MINOR", None), "1.1.0"), - (("1.1.0", "MINOR", None), "1.2.0"), - (("1.2.0", "PATCH", None), "1.2.1"), - (("1.2.1", "MAJOR", None), "2.0.0"), -] - -# this cases should be handled gracefully -unexpected_cases = [ - (("0.1.1rc0", None, "alpha"), "0.1.1a0"), - (("0.1.1b1", None, "alpha"), "0.1.1a0"), -] - -weird_cases = [ - (("1.1", "PATCH", None), "1.1.1"), - (("1", "MINOR", None), "1.1.0"), - (("1", "MAJOR", None), "2.0.0"), - (("1a0", None, "alpha"), "1.0.0a1"), - (("1", None, "beta"), "1.0.0b0"), - (("1beta", None, "beta"), "1.0.0b1"), - (("1.0.0alpha1", None, "alpha"), "1.0.0a2"), - (("1", None, "rc"), "1.0.0rc0"), - (("1.0.0rc1+e20d7b57f3eb", "PATCH", None), "1.0.0"), -] - -# test driven development -tdd_cases = [ - (("0.1.1", "PATCH", None), "0.1.2"), - (("0.1.1", "MINOR", None), "0.2.0"), - (("2.1.1", "MAJOR", None), "3.0.0"), - (("0.9.0", "PATCH", "alpha"), "0.9.1a0"), - (("0.9.0", "MINOR", "alpha"), "0.10.0a0"), - (("0.9.0", "MAJOR", "alpha"), "1.0.0a0"), - (("1.0.0a2", None, "beta"), "1.0.0b0"), - (("1.0.0beta1", None, "rc"), "1.0.0rc0"), - (("1.0.0rc1", None, "rc"), "1.0.0rc2"), -] - - -@pytest.mark.parametrize( - "test_input,expected", - itertools.chain(tdd_cases, weird_cases, simple_flow, unexpected_cases), -) -def test_generate_version(test_input, expected): - current_version = test_input[0] - increment = test_input[1] - prerelease = test_input[2] - assert generate_version( - current_version, increment=increment, prerelease=prerelease - ) == Version(expected) diff --git a/tests/test_bump_hooks.py b/tests/test_bump_hooks.py new file mode 100644 index 0000000000..739d1ce6ad --- /dev/null +++ b/tests/test_bump_hooks.py @@ -0,0 +1,42 @@ +import os +from unittest.mock import call + +import pytest +from pytest_mock import MockFixture + +from commitizen import cmd, hooks +from commitizen.exceptions import RunHookError + + +def test_run(mocker: MockFixture): + bump_hooks = ["pre_bump_hook", "pre_bump_hook_1"] + + cmd_run_mock = mocker.Mock() + cmd_run_mock.return_value.return_code = 0 + mocker.patch.object(cmd, "run", cmd_run_mock) + + hooks.run(bump_hooks) + + cmd_run_mock.assert_has_calls( + [ + call("pre_bump_hook", env=dict(os.environ)), + call("pre_bump_hook_1", env=dict(os.environ)), + ] + ) + + +def test_run_error(mocker: MockFixture): + bump_hooks = ["pre_bump_hook", "pre_bump_hook_1"] + + cmd_run_mock = mocker.Mock() + cmd_run_mock.return_value.return_code = 1 + mocker.patch.object(cmd, "run", cmd_run_mock) + + with pytest.raises(RunHookError): + hooks.run(bump_hooks) + + +def test_format_env(): + result = hooks._format_env("TEST_", {"foo": "bar", "bar": "baz"}) + assert result["TEST_FOO"] == "bar" + assert result["TEST_BAR"] == "baz" diff --git a/tests/test_bump_create_tag.py b/tests/test_bump_normalize_tag.py similarity index 57% rename from tests/test_bump_create_tag.py rename to tests/test_bump_normalize_tag.py index b6e06bcf51..558550c5ad 100644 --- a/tests/test_bump_create_tag.py +++ b/tests/test_bump_normalize_tag.py @@ -1,7 +1,6 @@ import pytest -from packaging.version import Version -from commitizen import bump +from commitizen.tags import TagRules conversion = [ (("1.2.3", "v$version"), "v1.2.3"), @@ -10,11 +9,15 @@ (("1.2.3", "ver$major.$minor.$patch"), "ver1.2.3"), (("1.2.3a0", "ver$major.$minor.$patch.$prerelease"), "ver1.2.3.a0"), (("1.2.3rc2", "$major.$minor.$patch.$prerelease-majestic"), "1.2.3.rc2-majestic"), + (("1.2.3+1.0.0", "v$version"), "v1.2.3+1.0.0"), + (("1.2.3+1.0.0", "v$version-local"), "v1.2.3+1.0.0-local"), + (("1.2.3+1.0.0", "ver$major.$minor.$patch"), "ver1.2.3"), ] -@pytest.mark.parametrize("test_input,expected", conversion) +@pytest.mark.parametrize(("test_input", "expected"), conversion) def test_create_tag(test_input, expected): version, format = test_input - new_tag = bump.create_tag(Version(version), format) + rules = TagRules() + new_tag = rules.normalize_tag(version, format) assert new_tag == expected diff --git a/tests/test_bump_update_version_in_files.py b/tests/test_bump_update_version_in_files.py index e94c5544c4..80823a4e1d 100644 --- a/tests/test_bump_update_version_in_files.py +++ b/tests/test_bump_update_version_in_files.py @@ -1,72 +1,399 @@ -import os +from collections.abc import Callable +from pathlib import Path +from shutil import copyfile +from typing import TypeAlias import pytest +from _pytest.fixtures import FixtureRequest from commitizen import bump +from commitizen.exceptions import CurrentVersionNotFoundError -PYPROJECT = """ -[tool.poetry] -name = "commitizen" -version = "1.2.3" -""" - -VERSION_PY = """ -__title__ = 'requests' -__description__ = 'Python HTTP for Humans.' -__url__ = 'http://python-requests.org' -__version__ = '1.2.3' -""" - -REPEATED_VERSION_NUMBER = """ -{ - "name": "magictool", - "version": "1.2.3", - "dependencies": { - "lodash": "1.2.3" - } -} -""" - -files_with_content = ( - ("pyproject.toml", PYPROJECT), - ("__version__.py", VERSION_PY), - ("package.json", REPEATED_VERSION_NUMBER), +MULTIPLE_VERSIONS_INCREASE_STRING = 'version = "1.2.9"\n' * 30 +MULTIPLE_VERSIONS_REDUCE_STRING = 'version = "1.2.10"\n' * 30 + + +SampleFileFixture: TypeAlias = Callable[[str, str], Path] + + +@pytest.fixture +def sample_file(tmp_path: Path, data_dir: Path) -> SampleFileFixture: + def fixture(source: str, destination: str) -> Path: + tmp_file = tmp_path / destination + copyfile(data_dir / source, tmp_file) + return tmp_file + + return fixture + + +@pytest.fixture +def commitizen_config_file(sample_file: SampleFileFixture) -> Path: + return sample_file("sample_pyproject.toml", "pyproject.toml") + + +@pytest.fixture +def python_version_file(sample_file: SampleFileFixture) -> Path: + return sample_file("sample_version.py", "__version__.py") + + +@pytest.fixture +def inconsistent_python_version_file(sample_file: SampleFileFixture) -> Path: + return sample_file("inconsistent_version.py", "__version__.py") + + +@pytest.fixture +def random_location_version_file(sample_file: SampleFileFixture) -> Path: + return sample_file("sample_cargo.lock", "Cargo.lock") + + +@pytest.fixture +def version_repeated_file(sample_file: SampleFileFixture) -> Path: + return sample_file("repeated_version_number.json", "package.json") + + +@pytest.fixture +def docker_compose_file(sample_file: SampleFileFixture) -> Path: + return sample_file("sample_docker_compose.yaml", "docker-compose.yaml") + + +@pytest.fixture( + params=( + "multiple_versions_to_update_pyproject.toml", + "multiple_versions_to_update_pyproject_wo_eol.toml", + ), + ids=("with_eol", "without_eol"), ) +def multiple_versions_to_update_poetry_lock( + sample_file: SampleFileFixture, request: FixtureRequest +) -> Path: + return sample_file(request.param, "pyproject.toml") + + +@pytest.fixture +def multiple_versions_increase_string(tmp_path: Path) -> str: + tmp_file = tmp_path / "anyfile" + tmp_file.write_text(MULTIPLE_VERSIONS_INCREASE_STRING) + return str(tmp_file) @pytest.fixture -def create_files(): - files = [] - for fileconf in files_with_content: - filename, content = fileconf - filepath = os.path.join("tests", filename) - with open(filepath, "w") as f: - f.write(content) - files.append(filepath) - yield files - for filepath in files: - os.remove(filepath) - - -def test_update_version_in_files(create_files): +def multiple_versions_reduce_string(tmp_path: Path) -> str: + tmp_file = tmp_path / "anyfile" + tmp_file.write_text(MULTIPLE_VERSIONS_REDUCE_STRING) + return str(tmp_file) + + +@pytest.fixture +def version_files( + commitizen_config_file: Path, + python_version_file: Path, + version_repeated_file: Path, + docker_compose_file: Path, +) -> tuple[str, ...]: + return ( + str(commitizen_config_file), + str(python_version_file), + str(version_repeated_file), + str(docker_compose_file), + ) + + +def test_update_version_in_files(version_files, file_regression): old_version = "1.2.3" new_version = "2.0.0" - bump.update_version_in_files(old_version, new_version, create_files) - for filepath in create_files: - with open(filepath, "r") as f: - data = f.read() - assert new_version in data + bump.update_version_in_files( + old_version, + new_version, + version_files, + check_consistency=False, + encoding="utf-8", + ) + file_contents = "" + for filepath in version_files: + file_contents += Path(filepath).read_text(encoding="utf-8") + file_regression.check(file_contents, extension=".txt") -def test_partial_update_of_file(create_files): + +def test_partial_update_of_file(version_repeated_file, file_regression): old_version = "1.2.3" new_version = "2.0.0" - filepath = "tests/package.json" regex = "version" - location = f"{filepath}:{regex}" + location = f"{version_repeated_file}:{regex}" + + bump.update_version_in_files( + old_version, new_version, [location], check_consistency=False, encoding="utf-8" + ) + file_regression.check( + version_repeated_file.read_text(encoding="utf-8"), extension=".json" + ) + + +def test_random_location(random_location_version_file, file_regression): + old_version = "1.2.3" + new_version = "2.0.0" + location = f"{random_location_version_file}:version.+Commitizen" + + bump.update_version_in_files( + old_version, new_version, [location], check_consistency=False, encoding="utf-8" + ) + file_regression.check( + random_location_version_file.read_text(encoding="utf-8"), extension=".lock" + ) + + +def test_duplicates_are_change_with_no_regex( + random_location_version_file, file_regression +): + old_version = "1.2.3" + new_version = "2.0.0" + location = f"{random_location_version_file}:version" + + bump.update_version_in_files( + old_version, new_version, [location], check_consistency=False, encoding="utf-8" + ) + file_regression.check( + random_location_version_file.read_text(encoding="utf-8"), extension=".lock" + ) + + +def test_version_bump_increase_string_length( + multiple_versions_increase_string, file_regression +): + old_version = "1.2.9" + new_version = "1.2.10" + location = f"{multiple_versions_increase_string}:version" + + bump.update_version_in_files( + old_version, new_version, [location], check_consistency=False, encoding="utf-8" + ) + file_regression.check( + Path(multiple_versions_increase_string).read_text(encoding="utf-8"), + extension=".txt", + ) + + +def test_version_bump_reduce_string_length( + multiple_versions_reduce_string, file_regression +): + old_version = "1.2.10" + new_version = "2.0.0" + location = f"{multiple_versions_reduce_string}:version" + + bump.update_version_in_files( + old_version, new_version, [location], check_consistency=False, encoding="utf-8" + ) + file_regression.check( + Path(multiple_versions_reduce_string).read_text(encoding="utf-8"), + extension=".txt", + ) + + +def test_file_version_inconsistent_error( + commitizen_config_file, inconsistent_python_version_file, version_repeated_file +): + version_files = [ + commitizen_config_file, + inconsistent_python_version_file, + version_repeated_file, + ] + old_version = "1.2.3" + new_version = "2.0.0" + with pytest.raises(CurrentVersionNotFoundError) as excinfo: + bump.update_version_in_files( + old_version, + new_version, + version_files, + check_consistency=True, + encoding="utf-8", + ) + + expected_msg = ( + f"Current version 1.2.3 is not found in {inconsistent_python_version_file}.\n" + "The version defined in commitizen configuration and the ones in " + "version_files are possibly inconsistent." + ) + assert expected_msg in str(excinfo.value) + + +def test_multiple_versions_to_bump( + multiple_versions_to_update_poetry_lock, file_regression +): + old_version = "1.2.9" + new_version = "1.2.10" + location = f"{multiple_versions_to_update_poetry_lock}:version" + + bump.update_version_in_files( + old_version, new_version, [location], check_consistency=False, encoding="utf-8" + ) + file_regression.check( + multiple_versions_to_update_poetry_lock.read_text(encoding="utf-8"), + extension=".toml", + ) + + +def test_update_version_in_globbed_files(commitizen_config_file, file_regression): + old_version = "1.2.3" + new_version = "2.0.0" + other = commitizen_config_file.parent / "other.toml" + + copyfile(commitizen_config_file, other) + + # Prepend full path as test assume absolute paths or cwd-relative + version_files = [ + str(file_path) for file_path in commitizen_config_file.parent.glob("*.toml") + ] + + bump.update_version_in_files( + old_version, + new_version, + version_files, + check_consistency=False, + encoding="utf-8", + ) + + for file in commitizen_config_file, other: + file_regression.check(file.read_text("utf-8"), extension=".toml") + + +def test_update_version_in_files_with_check_consistency_true( + version_files: tuple[str, ...], +): + """Test update_version_in_files with check_consistency=True (success case).""" + old_version = "1.2.3" + new_version = "2.0.0" + + # This should succeed because all files contain the current version + updated_files: list[str] = bump.update_version_in_files( + old_version, + new_version, + version_files, + check_consistency=True, + encoding="utf-8", + ) + + # Verify that all files were updated + assert set(updated_files) == set(version_files) + + +def test_update_version_in_files_with_check_consistency_true_failure( + commitizen_config_file, inconsistent_python_version_file +): + """Test update_version_in_files with check_consistency=True (failure case).""" + old_version = "1.2.3" + new_version = "2.0.0" + version_files = [commitizen_config_file, inconsistent_python_version_file] + + # This should fail because inconsistent_python_version_file doesn't contain the current version + with pytest.raises(CurrentVersionNotFoundError) as excinfo: + bump.update_version_in_files( + old_version, + new_version, + version_files, + check_consistency=True, + encoding="utf-8", + ) + + expected_msg = ( + f"Current version {old_version} is not found in {inconsistent_python_version_file}.\n" + "The version defined in commitizen configuration and the ones in " + "version_files are possibly inconsistent." + ) + assert expected_msg in str(excinfo.value) + + +@pytest.mark.parametrize( + ("encoding", "filename"), + [ + ("latin-1", "test_latin1.txt"), + ("utf-16", "test_utf16.txt"), + ], + ids=["latin-1", "utf-16"], +) +def test_update_version_in_files_with_different_encodings(tmp_path, encoding, filename): + """Test update_version_in_files with different encodings.""" + # Create a test file with the specified encoding + test_file = tmp_path / filename + content = f'version = "1.2.3"\n# This is a test file with {encoding} encoding\n' + test_file.write_text(content, encoding=encoding) + + old_version = "1.2.3" + new_version = "2.0.0" + + updated_files = bump.update_version_in_files( + old_version, + new_version, + [str(test_file)], + check_consistency=True, + encoding=encoding, + ) + + # Verify the file was updated + assert len(updated_files) == 1 + assert str(test_file) in updated_files + + # Verify the content was updated correctly + updated_content = test_file.read_text(encoding=encoding) + assert f'version = "{new_version}"' in updated_content + assert f'version = "{old_version}"' not in updated_content + + +def test_update_version_in_files_return_value(version_files): + """Test that update_version_in_files returns the correct list of updated files.""" + old_version = "1.2.3" + new_version = "2.0.0" + + updated_files = bump.update_version_in_files( + old_version, + new_version, + version_files, + check_consistency=False, + encoding="utf-8", + ) + + # Verify return value is a list + assert isinstance(updated_files, list) + + # Verify all files in the input are in the returned list + assert set(version_files) == set(updated_files) + + # Verify the returned paths are strings + assert all(isinstance(file_path, str) for file_path in updated_files) + + +def test_update_version_in_files_return_value_partial_update(tmp_path): + """Test return value when only some files are updated.""" + # Create two test files + file1 = tmp_path / "file1.txt" + file2 = tmp_path / "file2.txt" + + # File1 contains the version to update + file1.write_text('version = "1.2.3"\n') + + # File2 doesn't contain the version + file2.write_text("some other content\n") + + old_version = "1.2.3" + new_version = "2.0.0" + + updated_files = bump.update_version_in_files( + old_version, + new_version, + [str(file1), str(file2)], + check_consistency=False, + encoding="utf-8", + ) + + # Verify return value + assert isinstance(updated_files, list) + assert len(updated_files) == 2 # Both files should be in the list + assert str(file1) in updated_files + assert str(file2) in updated_files + + # Verify file1 was actually updated + content1 = file1.read_text(encoding="utf-8") + assert f'version = "{new_version}"' in content1 - bump.update_version_in_files(old_version, new_version, [location]) - with open(filepath, "r") as f: - data = f.read() - assert new_version in data - assert old_version in data + # Verify file2 was not changed + content2 = file2.read_text(encoding="utf-8") + assert content2 == "some other content\n" diff --git a/tests/test_bump_update_version_in_files/test_duplicates_are_change_with_no_regex.lock b/tests/test_bump_update_version_in_files/test_duplicates_are_change_with_no_regex.lock new file mode 100644 index 0000000000..8fe75b80ca --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_duplicates_are_change_with_no_regex.lock @@ -0,0 +1,11 @@ +[[package]] +name = "textwrap" +version = "2.0.0" + +[[package]] +name = "there-i-fixed-it" +version = "2.0.0" # automatically bumped by Commitizen + +[[package]] +name = "other-project" +version = "2.0.0" diff --git a/tests/test_bump_update_version_in_files/test_multiple_versions_to_bump_with_eol_.toml b/tests/test_bump_update_version_in_files/test_multiple_versions_to_bump_with_eol_.toml new file mode 100644 index 0000000000..f279eb4d61 --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_multiple_versions_to_bump_with_eol_.toml @@ -0,0 +1,27 @@ +[[package]] +name = "to-update-1" +version = "1.2.10" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "to-update-2" +version = "1.2.10" diff --git a/tests/test_bump_update_version_in_files/test_multiple_versions_to_bump_without_eol_.toml b/tests/test_bump_update_version_in_files/test_multiple_versions_to_bump_without_eol_.toml new file mode 100644 index 0000000000..47092b958b --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_multiple_versions_to_bump_without_eol_.toml @@ -0,0 +1,27 @@ +[[package]] +name = "to-update-1" +version = "1.2.10" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "to-update-2" +version = "1.2.10" \ No newline at end of file diff --git a/tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump_with_eol_.toml b/tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump_with_eol_.toml new file mode 100644 index 0000000000..f279eb4d61 --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump_with_eol_.toml @@ -0,0 +1,27 @@ +[[package]] +name = "to-update-1" +version = "1.2.10" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "to-update-2" +version = "1.2.10" diff --git a/tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump_without_eol_.toml b/tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump_without_eol_.toml new file mode 100644 index 0000000000..47092b958b --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_multiplt_versions_to_bump_without_eol_.toml @@ -0,0 +1,27 @@ +[[package]] +name = "to-update-1" +version = "1.2.10" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "not-to-update" +version = "1.3.3" + +[[package]] +name = "to-update-2" +version = "1.2.10" \ No newline at end of file diff --git a/tests/test_bump_update_version_in_files/test_partial_update_of_file.json b/tests/test_bump_update_version_in_files/test_partial_update_of_file.json new file mode 100644 index 0000000000..59224bca04 --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_partial_update_of_file.json @@ -0,0 +1,7 @@ +{ + "name": "magictool", + "version": "2.0.0", + "dependencies": { + "lodash": "1.2.3" + } +} diff --git a/tests/test_bump_update_version_in_files/test_random_location.lock b/tests/test_bump_update_version_in_files/test_random_location.lock new file mode 100644 index 0000000000..20dfe7f65c --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_random_location.lock @@ -0,0 +1,11 @@ +[[package]] +name = "textwrap" +version = "1.2.3" + +[[package]] +name = "there-i-fixed-it" +version = "2.0.0" # automatically bumped by Commitizen + +[[package]] +name = "other-project" +version = "1.2.3" diff --git a/tests/test_bump_update_version_in_files/test_update_version_in_files.txt b/tests/test_bump_update_version_in_files/test_update_version_in_files.txt new file mode 100644 index 0000000000..c4e527ac47 --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_update_version_in_files.txt @@ -0,0 +1,20 @@ +[tool.poetry] +name = "commitizen" +version = "2.0.0" +__title__ = "requests" +__description__ = "Python HTTP for Humans." +__url__ = "http://python-requests.org" +__version__ = "2.0.0" +{ + "name": "magictool", + "version": "2.0.0", + "dependencies": { + "lodash": "2.0.0" + } +} +version: "3.3" + +services: + app: + image: my-repo/my-container:v2.0.0 + command: my-command diff --git a/tests/test_bump_update_version_in_files/test_update_version_in_globbed_files.toml b/tests/test_bump_update_version_in_files/test_update_version_in_globbed_files.toml new file mode 100644 index 0000000000..bf82cfe859 --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_update_version_in_globbed_files.toml @@ -0,0 +1,3 @@ +[tool.poetry] +name = "commitizen" +version = "2.0.0" diff --git a/tests/test_bump_update_version_in_files/test_version_bump_increase_string_length.txt b/tests/test_bump_update_version_in_files/test_version_bump_increase_string_length.txt new file mode 100644 index 0000000000..4b6d6d64be --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_version_bump_increase_string_length.txt @@ -0,0 +1,30 @@ +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" +version = "1.2.10" diff --git a/tests/test_bump_update_version_in_files/test_version_bump_reduce_string_length.txt b/tests/test_bump_update_version_in_files/test_version_bump_reduce_string_length.txt new file mode 100644 index 0000000000..8e619de1ab --- /dev/null +++ b/tests/test_bump_update_version_in_files/test_version_bump_reduce_string_length.txt @@ -0,0 +1,30 @@ +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" +version = "2.0.0" diff --git a/tests/test_changelog.py b/tests/test_changelog.py new file mode 100644 index 0000000000..11c3a60446 --- /dev/null +++ b/tests/test_changelog.py @@ -0,0 +1,1685 @@ +from __future__ import annotations + +import re +from dataclasses import dataclass +from pathlib import Path +from typing import TYPE_CHECKING, Any +from unittest.mock import Mock + +import pytest +from jinja2 import FileSystemLoader + +from commitizen import changelog, git +from commitizen.commands.changelog import Changelog +from commitizen.config import BaseConfig +from commitizen.cz.conventional_commits.conventional_commits import ( + ConventionalCommitsCz, +) +from commitizen.exceptions import InvalidConfigurationError +from commitizen.version_schemes import Pep440 + +if TYPE_CHECKING: + from commitizen.changelog_formats import ChangelogFormat + +COMMITS_DATA: list[dict[str, Any]] = [ + { + "rev": "141ee441c9c9da0809c554103a558eb17c30ed17", + "parents": ["6c4948501031b7d6405b54b21d3d635827f9421b"], + "title": "bump: version 1.1.1 → 1.2.0", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "6c4948501031b7d6405b54b21d3d635827f9421b", + "parents": ["ddd220ad515502200fe2dde443614c1075d26238"], + "title": "docs: how to create custom bumps", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "ddd220ad515502200fe2dde443614c1075d26238", + "parents": ["ad17acff2e3a2e141cbc3c6efd7705e4e6de9bfc"], + "title": "feat: custom cz plugins now support bumping version", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "ad17acff2e3a2e141cbc3c6efd7705e4e6de9bfc", + "parents": ["56c8a8da84e42b526bcbe130bd194306f7c7e813"], + "title": "docs: added bump gif", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "56c8a8da84e42b526bcbe130bd194306f7c7e813", + "parents": ["74c6134b1b2e6bb8b07ed53410faabe99b204f36"], + "title": "bump: version 1.1.0 → 1.1.1", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "74c6134b1b2e6bb8b07ed53410faabe99b204f36", + "parents": ["cbc7b5f22c4e74deff4bc92d14e19bd93524711e"], + "title": "refactor: changed stdout statements", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "cbc7b5f22c4e74deff4bc92d14e19bd93524711e", + "parents": ["1ba46f2a63cb9d6e7472eaece21528c8cd28b118"], + "title": "fix(bump): commit message now fits better with semver", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "1ba46f2a63cb9d6e7472eaece21528c8cd28b118", + "parents": ["c35dbffd1bb98bb0b3d1593797e79d1c3366af8f"], + "title": "fix: conventional commit 'breaking change' in body instead of title", + "body": "closes #16", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "c35dbffd1bb98bb0b3d1593797e79d1c3366af8f", + "parents": ["25313397a4ac3dc5b5c986017bee2a614399509d"], + "title": "refactor(schema): command logic removed from commitizen base", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "25313397a4ac3dc5b5c986017bee2a614399509d", + "parents": ["d2f13ac41b4e48995b3b619d931c82451886e6ff"], + "title": "refactor(info): command logic removed from commitizen base", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "d2f13ac41b4e48995b3b619d931c82451886e6ff", + "parents": ["d839e317e5b26671b010584ad8cc6bf362400fa1"], + "title": "refactor(example): command logic removed from commitizen base", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "d839e317e5b26671b010584ad8cc6bf362400fa1", + "parents": ["12d0e65beda969f7983c444ceedc2a01584f4e08"], + "title": "refactor(commit): moved most of the commit logic to the commit command", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "12d0e65beda969f7983c444ceedc2a01584f4e08", + "parents": ["fb4c85abe51c228e50773e424cbd885a8b6c610d"], + "title": "docs(README): updated documentation url)", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "fb4c85abe51c228e50773e424cbd885a8b6c610d", + "parents": ["17efb44d2cd16f6621413691a543e467c7d2dda6"], + "title": "docs: mkdocs documentation", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "17efb44d2cd16f6621413691a543e467c7d2dda6", + "parents": ["6012d9eecfce8163d75c8fff179788e9ad5347da"], + "title": "Bump version 1.0.0 → 1.1.0", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "6012d9eecfce8163d75c8fff179788e9ad5347da", + "parents": ["0c7fb0ca0168864dfc55d83c210da57771a18319"], + "title": "test: fixed issues with conf", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "0c7fb0ca0168864dfc55d83c210da57771a18319", + "parents": ["cb1dd2019d522644da5bdc2594dd6dee17122d7f"], + "title": "docs(README): some new information about bump", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "cb1dd2019d522644da5bdc2594dd6dee17122d7f", + "parents": ["9c7450f85df6bf6be508e79abf00855a30c3c73c"], + "title": "feat: new working bump command", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "9c7450f85df6bf6be508e79abf00855a30c3c73c", + "parents": ["9f3af3772baab167e3fd8775d37f041440184251"], + "title": "feat: create version tag", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "9f3af3772baab167e3fd8775d37f041440184251", + "parents": ["b0d6a3defbfde14e676e7eb34946409297d0221b"], + "title": "docs: added new changelog", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "b0d6a3defbfde14e676e7eb34946409297d0221b", + "parents": ["d630d07d912e420f0880551f3ac94e933f9d3beb"], + "title": "feat: update given files with new version", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "d630d07d912e420f0880551f3ac94e933f9d3beb", + "parents": ["1792b8980c58787906dbe6836f93f31971b1ec2d"], + "title": "fix: removed all from commit", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "1792b8980c58787906dbe6836f93f31971b1ec2d", + "parents": ["52def1ea3555185ba4b936b463311949907e31ec"], + "title": "feat(config): new set key, used to set version to cfg", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "52def1ea3555185ba4b936b463311949907e31ec", + "parents": ["3127e05077288a5e2b62893345590bf1096141b7"], + "title": "feat: support for pyproject.toml", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "3127e05077288a5e2b62893345590bf1096141b7", + "parents": ["fd480ed90a80a6ffa540549408403d5b60d0e90c"], + "title": "feat: first semantic version bump implementation", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "fd480ed90a80a6ffa540549408403d5b60d0e90c", + "parents": ["e4840a059731c0bf488381ffc77e989e85dd81ad"], + "title": "fix: fix config file not working", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "e4840a059731c0bf488381ffc77e989e85dd81ad", + "parents": ["aa44a92d68014d0da98965c0c2cb8c07957d4362"], + "title": "refactor: added commands folder, better integration with decli", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "aa44a92d68014d0da98965c0c2cb8c07957d4362", + "parents": ["58bb709765380dbd46b74ce6e8978515764eb955"], + "title": "Bump version: 1.0.0b2 → 1.0.0", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "58bb709765380dbd46b74ce6e8978515764eb955", + "parents": ["97afb0bb48e72b6feca793091a8a23c706693257"], + "title": "docs(README): new badges", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "97afb0bb48e72b6feca793091a8a23c706693257", + "parents": [ + "9cecb9224aa7fa68d4afeac37eba2a25770ef251", + "e004a90b81ea5b374f118759bce5951202d03d69", + ], + "title": "Merge pull request #10 from Woile/feat/decli", + "body": "Feat/decli", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "9cecb9224aa7fa68d4afeac37eba2a25770ef251", + "parents": ["f5781d1a2954d71c14ade2a6a1a95b91310b2577"], + "title": "style: black to files", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "f5781d1a2954d71c14ade2a6a1a95b91310b2577", + "parents": ["80105fb3c6d45369bc0cbf787bd329fba603864c"], + "title": "ci: added travis", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "80105fb3c6d45369bc0cbf787bd329fba603864c", + "parents": ["a96008496ffefb6b1dd9b251cb479eac6a0487f7"], + "title": "refactor: removed delegator, added decli and many tests", + "body": "BREAKING CHANGE: API is stable", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "a96008496ffefb6b1dd9b251cb479eac6a0487f7", + "parents": ["aab33d13110f26604fb786878856ec0b9e5fc32b"], + "title": "docs: updated test command", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "aab33d13110f26604fb786878856ec0b9e5fc32b", + "parents": ["b73791563d2f218806786090fb49ef70faa51a3a"], + "title": "Bump version: 1.0.0b1 → 1.0.0b2", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "b73791563d2f218806786090fb49ef70faa51a3a", + "parents": ["7aa06a454fb717408b3657faa590731fb4ab3719"], + "title": "docs(README): updated to reflect current state", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "7aa06a454fb717408b3657faa590731fb4ab3719", + "parents": [ + "7c7e96b723c2aaa1aec3a52561f680adf0b60e97", + "9589a65880016996cff156b920472b9d28d771ca", + ], + "title": "Merge pull request #9 from Woile/dev", + "body": "feat: py3 only, tests and conventional commits 1.0", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "7c7e96b723c2aaa1aec3a52561f680adf0b60e97", + "parents": ["ed830019581c83ba633bfd734720e6758eca6061"], + "title": "Bump version: 0.9.11 → 1.0.0b1", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "ed830019581c83ba633bfd734720e6758eca6061", + "parents": ["c52eca6f74f844ab3ffbde61d98ef96071e132b7"], + "title": "feat: py3 only, tests and conventional commits 1.0", + "body": "more tests\npyproject instead of Pipfile\nquestionary instead of whaaaaat (promptkit 2.0.0 support)", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "c52eca6f74f844ab3ffbde61d98ef96071e132b7", + "parents": ["0326652b2657083929507ee66d4d1a0899e861ba"], + "title": "Bump version: 0.9.10 → 0.9.11", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "0326652b2657083929507ee66d4d1a0899e861ba", + "parents": ["b3f89892222340150e32631ae6b7aab65230036f"], + "title": "fix(config): load config reads in order without failing if there is no commitizen section", + "body": "Closes #8", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "b3f89892222340150e32631ae6b7aab65230036f", + "parents": ["5e837bf8ef0735193597372cd2d85e31a8f715b9"], + "title": "Bump version: 0.9.9 → 0.9.10", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "5e837bf8ef0735193597372cd2d85e31a8f715b9", + "parents": ["684e0259cc95c7c5e94854608cd3dcebbd53219e"], + "title": "fix: parse scope (this is my punishment for not having tests)", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "684e0259cc95c7c5e94854608cd3dcebbd53219e", + "parents": ["ca38eac6ff09870851b5c76a6ff0a2a8e5ecda15"], + "title": "Bump version: 0.9.8 → 0.9.9", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "ca38eac6ff09870851b5c76a6ff0a2a8e5ecda15", + "parents": ["64168f18d4628718c49689ee16430549e96c5d4b"], + "title": "fix: parse scope empty", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "64168f18d4628718c49689ee16430549e96c5d4b", + "parents": ["9d4def716ef235a1fa5ae61614366423fbc8256f"], + "title": "Bump version: 0.9.7 → 0.9.8", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "9d4def716ef235a1fa5ae61614366423fbc8256f", + "parents": ["33b0bf1a0a4dc60aac45ed47476d2e5473add09e"], + "title": "fix(scope): parse correctly again", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "33b0bf1a0a4dc60aac45ed47476d2e5473add09e", + "parents": ["696885e891ec35775daeb5fec3ba2ab92c2629e1"], + "title": "Bump version: 0.9.6 → 0.9.7", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "696885e891ec35775daeb5fec3ba2ab92c2629e1", + "parents": ["bef4a86761a3bda309c962bae5d22ce9b57119e4"], + "title": "fix(scope): parse correctly", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "bef4a86761a3bda309c962bae5d22ce9b57119e4", + "parents": ["72472efb80f08ee3fd844660afa012c8cb256e4b"], + "title": "Bump version: 0.9.5 → 0.9.6", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "72472efb80f08ee3fd844660afa012c8cb256e4b", + "parents": ["b5561ce0ab3b56bb87712c8f90bcf37cf2474f1b"], + "title": "refactor(conventionalCommit): moved filters to questions instead of message", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "b5561ce0ab3b56bb87712c8f90bcf37cf2474f1b", + "parents": ["3e31714dc737029d96898f412e4ecd2be1bcd0ce"], + "title": "fix(manifest): included missing files", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "3e31714dc737029d96898f412e4ecd2be1bcd0ce", + "parents": ["9df721e06595fdd216884c36a28770438b4f4a39"], + "title": "Bump version: 0.9.4 → 0.9.5", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "9df721e06595fdd216884c36a28770438b4f4a39", + "parents": ["0cf6ada372470c8d09e6c9e68ebf94bbd5a1656f"], + "title": "fix(config): home path for python versions between 3.0 and 3.5", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "0cf6ada372470c8d09e6c9e68ebf94bbd5a1656f", + "parents": ["973c6b3e100f6f69a3fe48bd8ee55c135b96c318"], + "title": "Bump version: 0.9.3 → 0.9.4", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "973c6b3e100f6f69a3fe48bd8ee55c135b96c318", + "parents": ["dacc86159b260ee98eb5f57941c99ba731a01399"], + "title": "feat(cli): added version", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "dacc86159b260ee98eb5f57941c99ba731a01399", + "parents": ["4368f3c3cbfd4a1ced339212230d854bc5bab496"], + "title": "Bump version: 0.9.2 → 0.9.3", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "4368f3c3cbfd4a1ced339212230d854bc5bab496", + "parents": ["da94133288727d35dae9b91866a25045038f2d38"], + "title": "feat(committer): conventional commit is a bit more intelligent now", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "da94133288727d35dae9b91866a25045038f2d38", + "parents": ["1541f54503d2e1cf39bd777c0ca5ab5eb78772ba"], + "title": "docs(README): motivation", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "1541f54503d2e1cf39bd777c0ca5ab5eb78772ba", + "parents": ["ddc855a637b7879108308b8dbd85a0fd27c7e0e7"], + "title": "Bump version: 0.9.1 → 0.9.2", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "ddc855a637b7879108308b8dbd85a0fd27c7e0e7", + "parents": ["46e9032e18a819e466618c7a014bcb0e9981af9e"], + "title": "refactor: renamed conventional_changelog to conventional_commits, not backward compatible", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "46e9032e18a819e466618c7a014bcb0e9981af9e", + "parents": ["0fef73cd7dc77a25b82e197e7c1d3144a58c1350"], + "title": "Bump version: 0.9.0 → 0.9.1", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, + { + "rev": "0fef73cd7dc77a25b82e197e7c1d3144a58c1350", + "parents": [], + "title": "fix(setup.py): future is now required for every python version", + "body": "", + "author": "Commitizen", + "author_email": "author@cz.dev", + }, +] + + +TAGS = [ + ("v1.2.0", "141ee441c9c9da0809c554103a558eb17c30ed17", "2019-04-19"), + ("v1.1.1", "56c8a8da84e42b526bcbe130bd194306f7c7e813", "2019-04-18"), + ("v1.1.0", "17efb44d2cd16f6621413691a543e467c7d2dda6", "2019-04-14"), + ("v1.0.0", "aa44a92d68014d0da98965c0c2cb8c07957d4362", "2019-03-01"), + ("1.0.0b2", "aab33d13110f26604fb786878856ec0b9e5fc32b", "2019-01-18"), + ("v1.0.0b1", "7c7e96b723c2aaa1aec3a52561f680adf0b60e97", "2019-01-17"), + ("v0.9.11", "c52eca6f74f844ab3ffbde61d98ef96071e132b7", "2018-12-17"), + ("v0.9.10", "b3f89892222340150e32631ae6b7aab65230036f", "2018-09-22"), + ("v0.9.9", "684e0259cc95c7c5e94854608cd3dcebbd53219e", "2018-09-22"), + ("v0.9.8", "64168f18d4628718c49689ee16430549e96c5d4b", "2018-09-22"), + ("v0.9.7", "33b0bf1a0a4dc60aac45ed47476d2e5473add09e", "2018-09-22"), + ("v0.9.6", "bef4a86761a3bda309c962bae5d22ce9b57119e4", "2018-09-19"), + ("v0.9.5", "3e31714dc737029d96898f412e4ecd2be1bcd0ce", "2018-08-24"), + ("v0.9.4", "0cf6ada372470c8d09e6c9e68ebf94bbd5a1656f", "2018-08-02"), + ("v0.9.3", "dacc86159b260ee98eb5f57941c99ba731a01399", "2018-07-28"), + ("v0.9.2", "1541f54503d2e1cf39bd777c0ca5ab5eb78772ba", "2017-11-11"), + ("v0.9.1", "46e9032e18a819e466618c7a014bcb0e9981af9e", "2017-11-11"), +] + + +@pytest.fixture +def gitcommits() -> list[git.GitCommit]: + return [ + git.GitCommit( + commit["rev"], + commit["title"], + commit["body"], + commit["author"], + commit["author_email"], + commit["parents"], + ) + for commit in COMMITS_DATA + ] + + +@pytest.fixture +def tags() -> list[git.GitTag]: + return [git.GitTag(*tag) for tag in TAGS] + + +@pytest.fixture +def changelog_content(data_dir: Path) -> str: + changelog = data_dir / "CHANGELOG_FOR_TEST.md" + return changelog.read_text(encoding="utf-8") + + +def test_get_commit_tag_is_a_version(gitcommits, tags): + commit = gitcommits[0] + tag = git.GitTag(*TAGS[0]) + assert changelog.get_commit_tag(commit, tags) == tag + + +def test_get_commit_tag_is_None(gitcommits, tags): + commit = gitcommits[1] + assert changelog.get_commit_tag(commit, tags) is None + + +@pytest.mark.parametrize("test_input", TAGS) +def test_valid_tag_included_in_changelog(test_input): + tag = git.GitTag(*test_input) + rules = changelog.TagRules() + assert rules.include_in_changelog(tag) is True + + +def test_invalid_tag_included_in_changelog(): + tag = git.GitTag("not_a_version", "rev", "date") + rules = changelog.TagRules() + assert rules.include_in_changelog(tag) is False + + +COMMITS_TREE = ( + { + "version": "v1.2.0", + "date": "2019-04-19", + "changes": { + "feat": [ + { + "scope": None, + "breaking": None, + "message": "custom cz plugins now support bumping version", + } + ] + }, + }, + { + "version": "v1.1.1", + "date": "2019-04-18", + "changes": { + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "changed stdout statements", + }, + { + "scope": "schema", + "breaking": None, + "message": "command logic removed from commitizen base", + }, + { + "scope": "info", + "breaking": None, + "message": "command logic removed from commitizen base", + }, + { + "scope": "example", + "breaking": None, + "message": "command logic removed from commitizen base", + }, + { + "scope": "commit", + "breaking": None, + "message": "moved most of the commit logic to the commit command", + }, + ], + "fix": [ + { + "scope": "bump", + "breaking": None, + "message": "commit message now fits better with semver", + }, + { + "scope": None, + "breaking": None, + "message": "conventional commit 'breaking change' in body instead of title", + }, + ], + }, + }, + { + "version": "v1.1.0", + "date": "2019-04-14", + "changes": { + "feat": [ + { + "scope": None, + "breaking": None, + "message": "new working bump command", + }, + {"scope": None, "breaking": None, "message": "create version tag"}, + { + "scope": None, + "breaking": None, + "message": "update given files with new version", + }, + { + "scope": "config", + "breaking": None, + "message": "new set key, used to set version to cfg", + }, + { + "scope": None, + "breaking": None, + "message": "support for pyproject.toml", + }, + { + "scope": None, + "breaking": None, + "message": "first semantic version bump implementation", + }, + ], + "fix": [ + { + "scope": None, + "breaking": None, + "message": "removed all from commit", + }, + { + "scope": None, + "breaking": None, + "message": "fix config file not working", + }, + ], + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "added commands folder, better integration with decli", + } + ], + }, + }, + { + "version": "v1.0.0", + "date": "2019-03-01", + "changes": { + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "removed delegator, added decli and many tests", + } + ], + "BREAKING CHANGE": [ + {"scope": None, "breaking": None, "message": "API is stable"} + ], + }, + }, + {"version": "1.0.0b2", "date": "2019-01-18", "changes": {}}, + { + "version": "v1.0.0b1", + "date": "2019-01-17", + "changes": { + "feat": [ + { + "scope": None, + "breaking": None, + "message": "py3 only, tests and conventional commits 1.0", + } + ] + }, + }, + { + "version": "v0.9.11", + "date": "2018-12-17", + "changes": { + "fix": [ + { + "scope": "config", + "breaking": None, + "message": "load config reads in order without failing if there is no commitizen section", + } + ] + }, + }, + { + "version": "v0.9.10", + "date": "2018-09-22", + "changes": { + "fix": [ + { + "scope": None, + "breaking": None, + "message": "parse scope (this is my punishment for not having tests)", + } + ] + }, + }, + { + "version": "v0.9.9", + "date": "2018-09-22", + "changes": { + "fix": [{"scope": None, "breaking": None, "message": "parse scope empty"}] + }, + }, + { + "version": "v0.9.8", + "date": "2018-09-22", + "changes": { + "fix": [ + { + "scope": "scope", + "breaking": None, + "message": "parse correctly again", + } + ] + }, + }, + { + "version": "v0.9.7", + "date": "2018-09-22", + "changes": { + "fix": [{"scope": "scope", "breaking": None, "message": "parse correctly"}] + }, + }, + { + "version": "v0.9.6", + "date": "2018-09-19", + "changes": { + "refactor": [ + { + "scope": "conventionalCommit", + "breaking": None, + "message": "moved filters to questions instead of message", + } + ], + "fix": [ + { + "scope": "manifest", + "breaking": None, + "message": "included missing files", + } + ], + }, + }, + { + "version": "v0.9.5", + "date": "2018-08-24", + "changes": { + "fix": [ + { + "scope": "config", + "breaking": None, + "message": "home path for python versions between 3.0 and 3.5", + } + ] + }, + }, + { + "version": "v0.9.4", + "date": "2018-08-02", + "changes": { + "feat": [{"scope": "cli", "breaking": None, "message": "added version"}] + }, + }, + { + "version": "v0.9.3", + "date": "2018-07-28", + "changes": { + "feat": [ + { + "scope": "committer", + "breaking": None, + "message": "conventional commit is a bit more intelligent now", + } + ] + }, + }, + { + "version": "v0.9.2", + "date": "2017-11-11", + "changes": { + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "renamed conventional_changelog to conventional_commits, not backward compatible", + } + ] + }, + }, + { + "version": "v0.9.1", + "date": "2017-11-11", + "changes": { + "fix": [ + { + "scope": "setup.py", + "breaking": None, + "message": "future is now required for every python version", + } + ] + }, + }, +) + +COMMITS_TREE_AFTER_MERGED_PRERELEASES = ( + { + "version": "v1.2.0", + "date": "2019-04-19", + "changes": { + "feat": [ + { + "scope": None, + "breaking": None, + "message": "custom cz plugins now support bumping version", + } + ] + }, + }, + { + "version": "v1.1.1", + "date": "2019-04-18", + "changes": { + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "changed stdout statements", + }, + { + "scope": "schema", + "breaking": None, + "message": "command logic removed from commitizen base", + }, + { + "scope": "info", + "breaking": None, + "message": "command logic removed from commitizen base", + }, + { + "scope": "example", + "breaking": None, + "message": "command logic removed from commitizen base", + }, + { + "scope": "commit", + "breaking": None, + "message": "moved most of the commit logic to the commit command", + }, + ], + "fix": [ + { + "scope": "bump", + "breaking": None, + "message": "commit message now fits better with semver", + }, + { + "scope": None, + "breaking": None, + "message": "conventional commit 'breaking change' in body instead of title", + }, + ], + }, + }, + { + "version": "v1.1.0", + "date": "2019-04-14", + "changes": { + "feat": [ + { + "scope": None, + "breaking": None, + "message": "new working bump command", + }, + {"scope": None, "breaking": None, "message": "create version tag"}, + { + "scope": None, + "breaking": None, + "message": "update given files with new version", + }, + { + "scope": "config", + "breaking": None, + "message": "new set key, used to set version to cfg", + }, + { + "scope": None, + "breaking": None, + "message": "support for pyproject.toml", + }, + { + "scope": None, + "breaking": None, + "message": "first semantic version bump implementation", + }, + ], + "fix": [ + { + "scope": None, + "breaking": None, + "message": "removed all from commit", + }, + { + "scope": None, + "breaking": None, + "message": "fix config file not working", + }, + ], + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "added commands folder, better integration with decli", + } + ], + }, + }, + { + "version": "v1.0.0", + "date": "2019-03-01", + "changes": { + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "removed delegator, added decli and many tests", + } + ], + "feat": [ + { + "scope": None, + "breaking": None, + "message": "py3 only, tests and conventional commits 1.0", + } + ], + "BREAKING CHANGE": [ + {"scope": None, "breaking": None, "message": "API is stable"} + ], + }, + }, + { + "version": "v0.9.11", + "date": "2018-12-17", + "changes": { + "fix": [ + { + "scope": "config", + "breaking": None, + "message": "load config reads in order without failing if there is no commitizen section", + } + ] + }, + }, + { + "version": "v0.9.10", + "date": "2018-09-22", + "changes": { + "fix": [ + { + "scope": None, + "breaking": None, + "message": "parse scope (this is my punishment for not having tests)", + } + ] + }, + }, + { + "version": "v0.9.9", + "date": "2018-09-22", + "changes": { + "fix": [{"scope": None, "breaking": None, "message": "parse scope empty"}] + }, + }, + { + "version": "v0.9.8", + "date": "2018-09-22", + "changes": { + "fix": [ + { + "scope": "scope", + "breaking": None, + "message": "parse correctly again", + } + ] + }, + }, + { + "version": "v0.9.7", + "date": "2018-09-22", + "changes": { + "fix": [{"scope": "scope", "breaking": None, "message": "parse correctly"}] + }, + }, + { + "version": "v0.9.6", + "date": "2018-09-19", + "changes": { + "refactor": [ + { + "scope": "conventionalCommit", + "breaking": None, + "message": "moved filters to questions instead of message", + } + ], + "fix": [ + { + "scope": "manifest", + "breaking": None, + "message": "included missing files", + } + ], + }, + }, + { + "version": "v0.9.5", + "date": "2018-08-24", + "changes": { + "fix": [ + { + "scope": "config", + "breaking": None, + "message": "home path for python versions between 3.0 and 3.5", + } + ] + }, + }, + { + "version": "v0.9.4", + "date": "2018-08-02", + "changes": { + "feat": [{"scope": "cli", "breaking": None, "message": "added version"}] + }, + }, + { + "version": "v0.9.3", + "date": "2018-07-28", + "changes": { + "feat": [ + { + "scope": "committer", + "breaking": None, + "message": "conventional commit is a bit more intelligent now", + } + ] + }, + }, + { + "version": "v0.9.2", + "date": "2017-11-11", + "changes": { + "refactor": [ + { + "scope": None, + "breaking": None, + "message": "renamed conventional_changelog to conventional_commits, not backward compatible", + } + ] + }, + }, + { + "version": "v0.9.1", + "date": "2017-11-11", + "changes": { + "fix": [ + { + "scope": "setup.py", + "breaking": None, + "message": "future is now required for every python version", + } + ] + }, + }, +) + + +@pytest.mark.parametrize("merge_prereleases", [True, False]) +def test_generate_tree_from_commits(gitcommits, tags, merge_prereleases): + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.bump_pattern + rules = changelog.TagRules( + merge_prereleases=merge_prereleases, + ) + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern, rules=rules + ) + expected = ( + COMMITS_TREE_AFTER_MERGED_PRERELEASES if merge_prereleases else COMMITS_TREE + ) + + for release, expected_release in zip(tree, expected): + assert release["version"] == expected_release["version"] + assert release["date"] == expected_release["date"] + assert release["changes"].keys() == expected_release["changes"].keys() + for change_type in release["changes"]: + changes = release["changes"][change_type] + expected_changes = expected_release["changes"][change_type] + for change, expected_change in zip(changes, expected_changes): + assert change["scope"] == expected_change["scope"] + assert change["breaking"] == expected_change["breaking"] + assert change["message"] == expected_change["message"] + assert change["author"] == "Commitizen" + assert change["author_email"] in "author@cz.dev" + assert "sha1" in change + assert "parents" in change + + +def test_generate_tree_from_commits_with_no_commits(tags): + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.bump_pattern + tree = changelog.generate_tree_from_commits([], tags, parser, changelog_pattern) + + assert tuple(tree) == ({"changes": {}, "date": "", "version": "Unreleased"},) + + +@pytest.mark.parametrize( + ("change_type_order", "expected_reordering"), + [ + ([], {}), + ( + ["BREAKING CHANGE", "refactor"], + { + "1.1.0": { + "original": ["feat", "fix", "refactor"], + "sorted": ["refactor", "feat", "fix"], + }, + "1.0.0": { + "original": ["refactor", "BREAKING CHANGE"], + "sorted": ["BREAKING CHANGE", "refactor"], + }, + }, + ), + ], +) +def test_generate_ordered_changelog_tree(change_type_order, expected_reordering): + tree = changelog.generate_ordered_changelog_tree(COMMITS_TREE, change_type_order) + + for index, entry in enumerate(tuple(tree)): + version = entry["version"] + if version in expected_reordering: + # Verify that all keys are present + assert [*entry.keys()] == [*COMMITS_TREE[index].keys()] + # Verify that the reorder only impacted the returned dict and not the original + expected = expected_reordering[version] + assert [*entry["changes"].keys()] == expected["sorted"] + assert [*COMMITS_TREE[index]["changes"].keys()] == expected["original"] + else: + assert [*entry["changes"].keys()] == [*entry["changes"].keys()] + + +def test_generate_ordered_changelog_tree_raises(): + change_type_order = ["BREAKING CHANGE", "feat", "refactor", "feat"] + with pytest.raises(InvalidConfigurationError) as excinfo: + list(changelog.generate_ordered_changelog_tree(COMMITS_TREE, change_type_order)) + + assert "Change types contain duplicated types" in str(excinfo) + + +def test_render_changelog( + gitcommits, tags, changelog_content, any_changelog_format: ChangelogFormat +): + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, template) + assert result == changelog_content + + +def test_render_changelog_from_default_plugin_values( + gitcommits, tags, changelog_content, any_changelog_format: ChangelogFormat +): + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, template) + assert result == changelog_content + + +def test_render_changelog_override_loader(gitcommits, tags, tmp_path: Path): + loader = FileSystemLoader(tmp_path) + template = "tpl.j2" + tpl = "loader overridden" + (tmp_path / template).write_text(tpl) + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, template) + assert result == tpl + + +def test_render_changelog_override_template_from_cwd( + gitcommits, tags, chdir: Path, any_changelog_format: ChangelogFormat +): + tpl = "overridden from cwd" + template = any_changelog_format.template + (chdir / template).write_text(tpl) + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, template) + assert result == tpl + + +def test_render_changelog_override_template_from_cwd_with_custom_name( + gitcommits, tags, chdir: Path +): + tpl = "template overridden from cwd" + tpl_name = "tpl.j2" + (chdir / tpl_name).write_text(tpl) + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, tpl_name) + assert result == tpl + + +def test_render_changelog_override_loader_and_template( + gitcommits, tags, tmp_path: Path +): + loader = FileSystemLoader(tmp_path) + tpl = "loader and template overridden" + tpl_name = "tpl.j2" + (tmp_path / tpl_name).write_text(tpl) + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.bump_pattern + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, tpl_name) + assert result == tpl + + +def test_render_changelog_support_arbitrary_kwargs(gitcommits, tags, tmp_path: Path): + loader = FileSystemLoader(tmp_path) + tpl_name = "tpl.j2" + (tmp_path / tpl_name).write_text("{{ key }}") + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, tpl_name, key="value") + assert result == "value" + + +def test_render_changelog_unreleased(gitcommits, any_changelog_format: ChangelogFormat): + some_commits = gitcommits[:7] + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + some_commits, [], parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, template) + assert "Unreleased" in result + + +def test_render_changelog_tag_and_unreleased( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + some_commits = gitcommits[:7] + single_tag = [ + tag for tag in tags if tag.rev == "56c8a8da84e42b526bcbe130bd194306f7c7e813" + ] + + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + some_commits, single_tag, parser, changelog_pattern + ) + result = changelog.render_changelog(tree, loader, template) + + assert "Unreleased" in result + assert "## v1.1.1" in result + + +def test_render_changelog_with_change_type( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + new_title = ":some-emoji: feature" + change_type_map = {"feat": new_title} + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, tags, parser, changelog_pattern, change_type_map=change_type_map + ) + result = changelog.render_changelog(tree, loader, template) + assert new_title in result + + +def test_render_changelog_with_changelog_message_builder_hook( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + def changelog_message_builder_hook(message: dict, commit: git.GitCommit) -> dict: + message["message"] = ( + f"{message['message']} [link](github.com/232323232) {commit.author} {commit.author_email}" + ) + return message + + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, + tags, + parser, + changelog_pattern, + changelog_message_builder_hook=changelog_message_builder_hook, + ) + result = changelog.render_changelog(tree, loader, template) + + assert "[link](github.com/232323232) Commitizen author@cz.dev" in result + + +def test_changelog_message_builder_hook_can_remove_commits( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + def changelog_message_builder_hook(message: dict, commit: git.GitCommit): + return None + + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, + tags, + parser, + changelog_pattern, + changelog_message_builder_hook=changelog_message_builder_hook, + ) + result = changelog.render_changelog(tree, loader, template) + + RE_HEADER = re.compile(r"^## v?\d+\.\d+\.\d+(\w)* \(\d{4}-\d{2}-\d{2}\)$") + # Rendered changelog should be empty, only containing version headers + for no, line in enumerate(result.splitlines()): + if line := line.strip(): + assert RE_HEADER.match(line), f"Line {no} should not be there: {line}" + + +def test_render_changelog_with_changelog_message_builder_hook_multiple_entries( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + def changelog_message_builder_hook(message: dict, commit: git.GitCommit): + messages = [message.copy(), message.copy(), message.copy()] + for idx, msg in enumerate(messages): + msg["message"] = f"Message #{idx}" + return messages + + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, + tags, + parser, + changelog_pattern, + changelog_message_builder_hook=changelog_message_builder_hook, + ) + result = changelog.render_changelog(tree, loader, template) + + for idx in range(3): + assert f"Message #{idx}" in result + + +def test_changelog_message_builder_hook_can_access_and_modify_change_type( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + def changelog_message_builder_hook(message: dict, commit: git.GitCommit): + assert "change_type" in message + message["change_type"] = "overridden" + return message + + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + loader = ConventionalCommitsCz.template_loader + template = any_changelog_format.template + tree = changelog.generate_tree_from_commits( + gitcommits, + tags, + parser, + changelog_pattern, + changelog_message_builder_hook=changelog_message_builder_hook, + ) + result = changelog.render_changelog(tree, loader, template) + + RE_HEADER = re.compile(r"^### (?P<type>.+)$") + # There should be only "overridden" change type headers + for no, line in enumerate(result.splitlines()): + if (line := line.strip()) and (match := RE_HEADER.match(line)): + change_type = match.group("type") + assert change_type == "overridden", ( + f"Line {no}: type {change_type} should have been overridden" + ) + + +def test_render_changelog_with_changelog_release_hook( + gitcommits, tags, any_changelog_format: ChangelogFormat +): + def changelog_release_hook(release: dict, tag: git.GitTag | None) -> dict: + release["extra"] = "whatever" + return release + + parser = ConventionalCommitsCz.commit_parser + changelog_pattern = ConventionalCommitsCz.changelog_pattern + tree = changelog.generate_tree_from_commits( + gitcommits, + tags, + parser, + changelog_pattern, + changelog_release_hook=changelog_release_hook, + ) + for release in tree: + assert release["extra"] == "whatever" + + +def test_get_smart_tag_range_returns_an_extra_for_a_range(tags): + start, end = ( + tags[0], + tags[2], + ) # len here is 3, but we expect one more tag as designed + res = changelog.get_smart_tag_range(tags, start.name, end.name) + assert 4 == len(res) + + +def test_get_smart_tag_range_returns_an_extra_for_a_single_tag(tags): + start = tags[0] # len here is 1, but we expect one more tag as designed + res = changelog.get_smart_tag_range(tags, start.name) + assert 2 == len(res) + + +def test_get_next_tag_name_after_version(tags): + # Test finding next tag after a version + next_tag_name = changelog.get_next_tag_name_after_version(tags, "v1.2.0") + assert next_tag_name == "v1.1.1" + + next_tag_name = changelog.get_next_tag_name_after_version(tags, "v1.1.0") + assert next_tag_name == "v1.0.0" + + # Test finding last tag when given version is last + last_tag_name = changelog.get_next_tag_name_after_version(tags, "v0.9.1") + assert last_tag_name is None + + # Test error when version not found + with pytest.raises(changelog.NoCommitsFoundError) as exc_info: + changelog.get_next_tag_name_after_version(tags, "nonexistent") + assert "Could not find a valid revision range" in str(exc_info.value) + + +@dataclass +class TagDef: + name: str + is_version: bool + is_legacy: bool + is_ignored: bool + + +TAGS_PARAMS = ( + pytest.param(TagDef("1.2.3", True, False, False), id="version"), + # We test with `v-` prefix as `v` prefix is a special case kept for backward compatibility + pytest.param(TagDef("v-1.2.3", False, True, False), id="v-prefix"), + pytest.param(TagDef("project-1.2.3", False, True, False), id="project-prefix"), + pytest.param(TagDef("ignored", False, False, True), id="ignored"), + pytest.param(TagDef("unknown", False, False, False), id="unknown"), +) + + +@pytest.mark.parametrize("tag", TAGS_PARAMS) +def test_tag_rules_tag_format_only(tag: TagDef): + rules = changelog.TagRules(Pep440, "$version") + assert rules.is_version_tag(tag.name) is tag.is_version + + +@pytest.mark.parametrize("tag", TAGS_PARAMS) +def test_tag_rules_with_legacy_tags(tag: TagDef): + rules = changelog.TagRules( + scheme=Pep440, + tag_format="$version", + legacy_tag_formats=["v-$version", "project-${version}"], + ) + assert rules.is_version_tag(tag.name) is tag.is_version or tag.is_legacy + + +@pytest.mark.parametrize("tag", TAGS_PARAMS) +def test_tag_rules_with_ignored_tags(tag: TagDef): + rules = changelog.TagRules( + scheme=Pep440, tag_format="$version", ignored_tag_formats=["ignored"] + ) + assert rules.is_ignored_tag(tag.name) is tag.is_ignored + + +def test_tags_rules_get_version_tags(capsys: pytest.CaptureFixture): + tags = [ + git.GitTag("v1.1.0", "17efb44d2cd16f6621413691a543e467c7d2dda6", "2019-04-14"), + git.GitTag("v1.0.0", "aa44a92d68014d0da98965c0c2cb8c07957d4362", "2019-03-01"), + git.GitTag("1.0.0b2", "aab33d13110f26604fb786878856ec0b9e5fc32b", "2019-01-18"), + git.GitTag( + "project-not-a-version", + "7c7e96b723c2aaa1aec3a52561f680adf0b60e97", + "2019-01-17", + ), + git.GitTag( + "not-a-version", "c52eca6f74f844ab3ffbde61d98ef96071e132b7", "2018-12-17" + ), + git.GitTag( + "star-something", "c52eca6f74f844ab3ffbde61d98fe96071e132b2", "2018-11-12" + ), + git.GitTag("known", "b3f89892222340150e32631ae6b7aab65230036f", "2018-09-22"), + git.GitTag( + "ignored-0.9.3", "684e0259cc95c7c5e94854608cd3dcebbd53219e", "2018-09-22" + ), + git.GitTag( + "project-0.9.3", "dacc86159b260ee98eb5f57941c99ba731a01399", "2018-07-28" + ), + git.GitTag( + "anything-0.9", "5141f54503d2e1cf39bd666c0ca5ab5eb78772ab", "2018-01-10" + ), + git.GitTag( + "project-0.9.2", "1541f54503d2e1cf39bd777c0ca5ab5eb78772ba", "2017-11-11" + ), + git.GitTag( + "ignored-0.9.1", "46e9032e18a819e466618c7a014bcb0e9981af9e", "2017-11-11" + ), + ] + + rules = changelog.TagRules( + scheme=Pep440, + tag_format="v$version", + legacy_tag_formats=["$version", "project-${version}"], + ignored_tag_formats=[ + "known", + "ignored-${version}", + "star-*", + "*-${major}.${minor}", + ], + ) + + version_tags = rules.get_version_tags(tags, warn=True) + assert {t.name for t in version_tags} == { + "v1.1.0", + "v1.0.0", + "1.0.0b2", + "project-0.9.3", + "project-0.9.2", + } + + captured = capsys.readouterr() + assert captured.err.count("Invalid version tag:") == 2 + assert captured.err.count("not-a-version") == 2 + + +@pytest.mark.usefixtures("in_repo_root") +def test_changelog_file_name_from_args_and_config(): + mock_config = Mock(spec=BaseConfig) + mock_path = Mock(spec=Path) + mock_path.parent = Path("/my/project") + mock_config.path = mock_path + mock_config.settings = { + "name": "cz_conventional_commits", + "changelog_file": "CHANGELOG.md", + "encoding": "utf-8", + "changelog_start_rev": "v1.0.0", + "tag_format": "$version", + "legacy_tag_formats": [], + "ignored_tag_formats": [], + "incremental": True, + "changelog_merge_prerelease": True, + } + + args = { + "file_name": "CUSTOM.md", + "unreleased_version": "1.0.1", + } + changelog = Changelog(mock_config, args) + assert ( + Path(changelog.file_name).resolve() == Path("/my/project/CUSTOM.md").resolve() + ) + + args = {"unreleased_version": "1.0.1"} + changelog = Changelog(mock_config, args) + assert ( + Path(changelog.file_name).resolve() + == Path("/my/project/CHANGELOG.md").resolve() + ) diff --git a/tests/test_changelog_format_asciidoc.py b/tests/test_changelog_format_asciidoc.py new file mode 100644 index 0000000000..a56a05ba08 --- /dev/null +++ b/tests/test_changelog_format_asciidoc.py @@ -0,0 +1,209 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen.changelog import IncrementalMergeInfo, Metadata +from commitizen.changelog_formats.asciidoc import AsciiDoc + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +CHANGELOG_A = """ += Changelog + +All notable changes to this project will be documented in this file. + +The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog], +and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Versioning]. + +== [Unreleased] +* Start using "changelog" over "change log" since it's the common usage. + +== [1.0.0] - 2017-06-20 +=== Added +* New visual identity by https://github.com/tylerfortune8[@tylerfortune8]. +* Version navigation. +""".strip() + +EXPECTED_A = Metadata( + latest_version="1.0.0", + latest_version_position=10, + unreleased_end=10, + unreleased_start=7, +) + + +CHANGELOG_B = """ +== [Unreleased] +* Start using "changelog" over "change log" since it's the common usage. + +== 1.2.0 +""".strip() + +EXPECTED_B = Metadata( + latest_version="1.2.0", + latest_version_position=3, + unreleased_end=3, + unreleased_start=0, +) + + +CHANGELOG_C = """ += Unreleased + +== v1.0.0 +""" +EXPECTED_C = Metadata( + latest_version="1.0.0", + latest_version_tag="v1.0.0", + latest_version_position=3, + unreleased_end=3, + unreleased_start=1, +) + +CHANGELOG_D = """ +== Unreleased +* Start using "changelog" over "change log" since it's the common usage. +""" + +EXPECTED_D = Metadata( + latest_version=None, + latest_version_position=None, + unreleased_end=2, + unreleased_start=1, +) + +CHANGELOG_E = """ += Changelog + +All notable changes to this project will be documented in this file. + +The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog], +and this project adheres to https://semver.org/spec/v2.0.0.html[Semantic Versioning]. + +== [Unreleased] +* Start using "changelog" over "change log" since it's the common usage. + +== [{tag_formatted_version}] - 2017-06-20 +=== Added +* New visual identity by https://github.com/tylerfortune8[@tylerfortune8]. +* Version navigation. +""".strip() + +EXPECTED_E = Metadata( + latest_version="1.0.0", + latest_version_position=10, + unreleased_end=10, + unreleased_start=7, +) + + +@pytest.fixture +def format(config: BaseConfig) -> AsciiDoc: + return AsciiDoc(config) + + +@pytest.fixture +def format_with_tags(config: BaseConfig, request) -> AsciiDoc: + config.settings["tag_format"] = request.param + config.settings["legacy_tag_formats"] = ["legacy-${version}"] + return AsciiDoc(config) + + +VERSIONS_EXAMPLES = [ + ("== [1.0.0] - 2017-06-20", ("1.0.0", "1.0.0")), + ( + "= https://github.com/angular/angular/compare/10.0.0-next.2...10.0.0-next.3[10.0.0-next.3] (2020-04-22)", + ("10.0.0-next.3", "10.0.0-next.3"), + ), + ("=== 0.19.1 (Jan 7, 2020)", ("0.19.1", "0.19.1")), + ("== 1.0.0", ("1.0.0", "1.0.0")), + ("== v1.0.0", ("1.0.0", "v1.0.0")), + ("== v1.0.0 - (2012-24-32)", ("1.0.0", "v1.0.0")), + ("= version 2020.03.24", ("2020.03.24", "2020.03.24")), + ("== [Unreleased]", None), + ("All notable changes to this project will be documented in this file.", None), + ("= Changelog", None), + ("=== Bug Fixes", None), +] + + +@pytest.mark.parametrize(("line_from_changelog", "output_version"), VERSIONS_EXAMPLES) +def test_changelog_detect_version( + line_from_changelog: str, output_version: tuple[str, str] | None, format: AsciiDoc +): + version = format.parse_version_from_title(line_from_changelog) + assert version == output_version + + +TITLES_EXAMPLES = [ + ("== [1.0.0] - 2017-06-20", 2), + ("== [Unreleased]", 2), + ("= Unreleased", 1), +] + + +@pytest.mark.parametrize(("line_from_changelog", "output_title"), TITLES_EXAMPLES) +def test_parse_title_type_of_line( + line_from_changelog: str, output_title: str, format: AsciiDoc +): + title = format.parse_title_level(line_from_changelog) + assert title == output_title + + +@pytest.mark.parametrize( + ("content", "expected"), + [ + pytest.param(CHANGELOG_A, EXPECTED_A, id="A"), + pytest.param(CHANGELOG_B, EXPECTED_B, id="B"), + pytest.param(CHANGELOG_C, EXPECTED_C, id="C"), + pytest.param(CHANGELOG_D, EXPECTED_D, id="D"), + ], +) +def test_get_metadata( + tmp_path: Path, format: AsciiDoc, content: str, expected: Metadata +): + changelog = tmp_path / format.default_changelog_file + changelog.write_text(content) + + assert format.get_metadata(str(changelog)) == expected + + +def test_get_latest_full_release_no_file(format: AsciiDoc): + assert format.get_latest_full_release("/nonexistent") == IncrementalMergeInfo() + + +@pytest.mark.parametrize( + ("format_with_tags", "tag_string", "expected"), + [ + pytest.param("${version}-example", "1.0.0-example", "1.0.0"), + pytest.param("${version}example", "1.0.0example", "1.0.0"), + pytest.param("example${version}", "example1.0.0", "1.0.0"), + pytest.param("example-${version}", "example-1.0.0", "1.0.0"), + pytest.param("example-${major}-${minor}-${patch}", "example-1-0-0", "1.0.0"), + pytest.param("example-${major}-${minor}", "example-1-0-0", None), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}-example", + "1-0-0-rc1-example", + "1.0.0-rc1", + ), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}${devrelease}-example", + "1-0-0-a1.dev1-example", + "1.0.0-a1.dev1", + ), + pytest.param("new-${version}", "legacy-1.0.0", "1.0.0"), + ], + indirect=["format_with_tags"], +) +def test_get_metadata_custom_tag_format( + tmp_path: Path, format_with_tags: AsciiDoc, tag_string: str, expected: Metadata +): + content = CHANGELOG_E.format(tag_formatted_version=tag_string) + changelog = tmp_path / format_with_tags.default_changelog_file + changelog.write_text(content) + assert format_with_tags.get_metadata(str(changelog)).latest_version == expected diff --git a/tests/test_changelog_format_markdown.py b/tests/test_changelog_format_markdown.py new file mode 100644 index 0000000000..1b75ed1f7f --- /dev/null +++ b/tests/test_changelog_format_markdown.py @@ -0,0 +1,211 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen.changelog import Metadata +from commitizen.changelog_formats.markdown import Markdown + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +CHANGELOG_A = """ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +- Start using "changelog" over "change log" since it's the common usage. + +## [1.0.0] - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. +""".strip() + +EXPECTED_A = Metadata( + latest_version="1.0.0", + latest_version_position=10, + unreleased_end=10, + unreleased_start=7, +) + + +CHANGELOG_B = """ +## [Unreleased] +- Start using "changelog" over "change log" since it's the common usage. + +## 1.2.0 +""".strip() + +EXPECTED_B = Metadata( + latest_version="1.2.0", + latest_version_position=3, + unreleased_end=3, + unreleased_start=0, +) + + +CHANGELOG_C = """ +# Unreleased + +## v1.0.0 +""" +EXPECTED_C = Metadata( + latest_version="1.0.0", + latest_version_tag="v1.0.0", + latest_version_position=3, + unreleased_end=3, + unreleased_start=1, +) + +CHANGELOG_D = """ +## Unreleased +- Start using "changelog" over "change log" since it's the common usage. +""" + +EXPECTED_D = Metadata( + latest_version=None, + latest_version_position=None, + unreleased_end=2, + unreleased_start=1, +) + +CHANGELOG_E = """ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] +- Start using "changelog" over "change log" since it's the common usage. + +## {tag_formatted_version} - 2017-06-20 +### Added +- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +- Version navigation. +""".strip() + +EXPECTED_E = Metadata( + latest_version="1.0.0", + latest_version_position=10, + unreleased_end=10, + unreleased_start=7, +) + + +@pytest.fixture +def format(config: BaseConfig) -> Markdown: + return Markdown(config) + + +@pytest.fixture +def format_with_tags(config: BaseConfig, request) -> Markdown: + config.settings["tag_format"] = request.param + config.settings["legacy_tag_formats"] = ["legacy-${version}"] + return Markdown(config) + + +VERSIONS_EXAMPLES = [ + ("## [1.0.0] - 2017-06-20", ("1.0.0", "1.0.0")), + ( + "# [10.0.0-next.3](https://github.com/angular/angular/compare/10.0.0-next.2...10.0.0-next.3) (2020-04-22)", + ("10.0.0-next.3", "10.0.0-next.3"), + ), + ("### 0.19.1 (Jan 7, 2020)", ("0.19.1", "0.19.1")), + ("## 1.0.0", ("1.0.0", "1.0.0")), + ("## v1.0.0", ("1.0.0", "v1.0.0")), + ("## v1.0.0 - (2012-24-32)", ("1.0.0", "v1.0.0")), + ("# version 2020.03.24", ("2020.03.24", "2020.03.24")), + ("## [Unreleased]", None), + ("All notable changes to this project will be documented in this file.", None), + ("# Changelog", None), + ("### Bug Fixes", None), +] + + +@pytest.mark.parametrize(("line_from_changelog", "output_version"), VERSIONS_EXAMPLES) +def test_changelog_detect_version( + line_from_changelog: str, output_version: tuple[str, str] | None, format: Markdown +): + version = format.parse_version_from_title(line_from_changelog) + assert version == output_version + + +TITLES_EXAMPLES = [ + ("## [1.0.0] - 2017-06-20", 2), + ("## [Unreleased]", 2), + ("# Unreleased", 1), +] + + +@pytest.mark.parametrize(("line_from_changelog", "output_title"), TITLES_EXAMPLES) +def test_parse_title_type_of_line( + line_from_changelog: str, output_title: str, format: Markdown +): + title = format.parse_title_level(line_from_changelog) + assert title == output_title + + +@pytest.mark.parametrize( + ("content", "expected"), + [ + pytest.param(CHANGELOG_A, EXPECTED_A, id="A"), + pytest.param(CHANGELOG_B, EXPECTED_B, id="B"), + pytest.param(CHANGELOG_C, EXPECTED_C, id="C"), + pytest.param(CHANGELOG_D, EXPECTED_D, id="D"), + ], +) +def test_get_metadata( + tmp_path: Path, format: Markdown, content: str, expected: Metadata +): + changelog = tmp_path / format.default_changelog_file + changelog.write_text(content) + + assert format.get_metadata(str(changelog)) == expected + + +@pytest.mark.parametrize( + ("format_with_tags", "tag_string", "expected"), + [ + pytest.param("${version}-example", "1.0.0-example", "1.0.0"), + pytest.param("${version}example", "1.0.0example", "1.0.0"), + pytest.param("example${version}", "example1.0.0", "1.0.0"), + pytest.param("example-${version}", "example-1.0.0", "1.0.0"), + pytest.param("example-${major}-${minor}-${patch}", "example-1-0-0", "1.0.0"), + pytest.param("example-${major}-${minor}", "example-1-0-0", None), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}-example", + "1-0-0-rc1-example", + "1.0.0-rc1", + ), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}-example", + "1-0-0-a1-example", + "1.0.0-a1", + ), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}${devrelease}-example", + "1-0-0-a1.dev1-example", + "1.0.0-a1.dev1", + ), + pytest.param("new-${version}", "legacy-1.0.0", "1.0.0"), + ], + indirect=["format_with_tags"], +) +def test_get_metadata_custom_tag_format( + tmp_path: Path, format_with_tags: Markdown, tag_string: str, expected: Metadata +): + content = CHANGELOG_E.format(tag_formatted_version=tag_string) + changelog = tmp_path / format_with_tags.default_changelog_file + changelog.write_text(content) + + assert format_with_tags.get_metadata(str(changelog)).latest_version == expected diff --git a/tests/test_changelog_format_restructuredtext.py b/tests/test_changelog_format_restructuredtext.py new file mode 100644 index 0000000000..00f7740737 --- /dev/null +++ b/tests/test_changelog_format_restructuredtext.py @@ -0,0 +1,387 @@ +from __future__ import annotations + +from textwrap import dedent +from typing import TYPE_CHECKING + +import pytest + +from commitizen.changelog import Metadata +from commitizen.changelog_formats.restructuredtext import ( + RestructuredText, + _is_overlined_title, + _is_underlined_title, +) + +if TYPE_CHECKING: + from pathlib import Path + + from _pytest.mark.structures import ParameterSet + + from commitizen.config.base_config import BaseConfig + + +CASES: list[ParameterSet] = [] + + +def case( + id: str, + content: str, + latest_version: str | None = None, + latest_version_position: int | None = None, + latest_version_tag: str | None = None, + unreleased_start: int | None = None, + unreleased_end: int | None = None, +): + CASES.append( + pytest.param( + dedent(content).strip(), + Metadata( + latest_version=latest_version, + latest_version_tag=latest_version_tag, + latest_version_position=latest_version_position, + unreleased_start=unreleased_start, + unreleased_end=unreleased_end, + ), + id=id, + ) + ) + + +case( + "underlined title with intro and unreleased section", + """ + Changelog + ######### + + All notable changes to this project will be documented in this file. + + The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`, + and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`. + + Unreleased + ========== + * Start using "changelog" over "change log" since it's the common usage. + + 1.0.0 - 2017-06-20 + ================== + Added + ----- + * New visual identity by `@tylerfortune8 <https://github.com/tylerfortune8>`. + * Version navigation. + """, + latest_version="1.0.0", + latest_version_position=12, + unreleased_start=8, + unreleased_end=12, +) + +case( + "unreleased section without preamble", + """ + Unreleased + ========== + * Start using "changelog" over "change log" since it's the common usage. + + 1.2.0 + ===== + """, + latest_version="1.2.0", + latest_version_position=4, + unreleased_start=0, + unreleased_end=4, +) + +case( + "basic underlined titles with v-prefixed version", + """ + Unreleased + ========== + + v1.0.0 + ====== + """, + latest_version="1.0.0", + latest_version_tag="v1.0.0", + latest_version_position=3, + unreleased_start=0, + unreleased_end=3, +) + +case( + "intermediate section in unreleased", + """ + Unreleased + ========== + + intermediate + ------------ + + 1.0.0 + ===== + """, + latest_version="1.0.0", + latest_version_position=6, + unreleased_start=0, + unreleased_end=6, +) + +case( + "weird section with different level than versions", + """ + Unreleased + ########## + + 1.0.0 + ===== + """, + latest_version="1.0.0", + latest_version_position=3, + unreleased_start=0, + unreleased_end=3, +) + +case( + "overlined title without release and intro", + """ + ========== + Unreleased + ========== + * Start using "changelog" over "change log" since it's the common usage. + """, + unreleased_start=0, + unreleased_end=4, +) + +case( + "underlined title with date", + """ + 1.0.0 - 2017-06-20 + ================== + """, + latest_version="1.0.0", + latest_version_position=0, +) + + +UNDERLINED_TITLES = ( + """ + title + ===== + """, + """ + title + ====== + """, + """ + title + ##### + """, + """ + title + ..... + """, + """ + title + !!!!! + """, +) + +NOT_UNDERLINED_TITLES = ( + """ + title + =.=.= + """, + """ + title + ==== + """, + """ + title + aaaaa + """, + """ + title + + """, +) + + +OVERLINED_TITLES = ( + """ + ===== + title + ===== + """, + """ + ====== + title + ====== + """, + """ + ##### + title + ##### + """, + """ + ..... + title + ..... + """, +) + +NOT_OVERLINED_TITLES = ( + """ + ==== + title + ===== + """, + """ + ===== + title + ==== + """, + """ + ==== + title + ==== + """, + """ + ===== + title + ##### + """, + """ + ##### + title + ===== + """, + """ + =.=.= + title + ===== + """, + """ + ===== + title + =.=.= + """, + """ + + title + ===== + """, + """ + ===== + title + + """, + """ + aaaaa + title + aaaaa + """, +) + +CHANGELOG = """ +Changelog + ######### + + All notable changes to this project will be documented in this file. + + The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`, + and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`. + + Unreleased + ========== + * Start using "changelog" over "change log" since it's the common usage. + + {tag_formatted_version} - 2017-06-20 + {underline} + Added + ----- + * New visual identity by `@tylerfortune8 <https://github.com/tylerfortune8>`. + * Version navigation. +""".strip() + + +@pytest.fixture +def format(config: BaseConfig) -> RestructuredText: + return RestructuredText(config) + + +@pytest.fixture +def format_with_tags(config: BaseConfig, request) -> RestructuredText: + config.settings["tag_format"] = request.param + config.settings["legacy_tag_formats"] = ["legacy-${version}"] + return RestructuredText(config) + + +@pytest.mark.parametrize(("content", "expected"), CASES) +def test_get_metadata( + tmp_path: Path, format: RestructuredText, content: str, expected: Metadata +): + changelog = tmp_path / format.default_changelog_file + changelog.write_text(content) + + assert format.get_metadata(str(changelog)) == expected + + +@pytest.mark.parametrize( + ("text", "expected"), + [(text, True) for text in UNDERLINED_TITLES] + + [(text, False) for text in NOT_UNDERLINED_TITLES], +) +def test_is_underlined_title(text: str, expected: bool): + _, first, second = dedent(text).splitlines() + assert _is_underlined_title(first, second) is expected + + +@pytest.mark.parametrize( + ("text", "expected"), + [(text, True) for text in OVERLINED_TITLES] + + [(text, False) for text in NOT_OVERLINED_TITLES], +) +def test_is_overlined_title(text: str, expected: bool): + _, first, second, third = dedent(text).splitlines() + + assert _is_overlined_title(first, second, third) is expected + + +@pytest.mark.parametrize( + ("format_with_tags", "tag_string", "expected"), + [ + pytest.param("${version}-example", "1.0.0-example", "1.0.0"), + pytest.param("${version}", "1.0.0", "1.0.0"), + pytest.param("${version}example", "1.0.0example", "1.0.0"), + pytest.param("example${version}", "example1.0.0", "1.0.0"), + pytest.param("example-${version}", "example-1.0.0", "1.0.0"), + pytest.param("example-${major}-${minor}-${patch}", "example-1-0-0", "1.0.0"), + pytest.param("example-${major}-${minor}", "example-1-0-0", None), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}-example", + "1-0-0-rc1-example", + "1.0.0-rc1", + ), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}${devrelease}-example", + "1-0-0-a1.dev1-example", + "1.0.0-a1.dev1", + ), + pytest.param("new-${version}", "legacy-1.0.0", "1.0.0"), + ], + indirect=["format_with_tags"], +) +def test_get_metadata_custom_tag_format( + tmp_path: Path, + format_with_tags: RestructuredText, + tag_string: str, + expected: Metadata, +): + content = CHANGELOG.format( + tag_formatted_version=tag_string, + underline="=" * len(tag_string) + "=============", + ) + changelog = tmp_path / format_with_tags.default_changelog_file + changelog.write_text(content) + + assert format_with_tags.get_metadata(str(changelog)).latest_version == expected diff --git a/tests/test_changelog_format_textile.py b/tests/test_changelog_format_textile.py new file mode 100644 index 0000000000..481f903a7a --- /dev/null +++ b/tests/test_changelog_format_textile.py @@ -0,0 +1,199 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen.changelog import Metadata +from commitizen.changelog_formats.textile import Textile + +if TYPE_CHECKING: + from pathlib import Path + + from commitizen.config.base_config import BaseConfig + +CHANGELOG_A = """ +h1. Changelog + +All notable changes to this project will be documented in this file. + +The format is based on "Keep a Changelog":https://keepachangelog.com/en/1.0.0/, +and this project adheres to "Semantic Versioning":https://semver.org/spec/v2.0.0.html. + +h2. [Unreleased] +- Start using "changelog" over "change log" since it's the common usage. + +h2. [1.0.0] - 2017-06-20 +h3. Added +* New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +* Version navigation. +""".strip() + +EXPECTED_A = Metadata( + latest_version="1.0.0", + latest_version_position=10, + unreleased_end=10, + unreleased_start=7, +) + + +CHANGELOG_B = """ +h2. [Unreleased] +* Start using "changelog" over "change log" since it's the common usage. + +h2. 1.2.0 +""".strip() + +EXPECTED_B = Metadata( + latest_version="1.2.0", + latest_version_position=3, + unreleased_end=3, + unreleased_start=0, +) + + +CHANGELOG_C = """ +h1. Unreleased + +h2. v1.0.0 +""" +EXPECTED_C = Metadata( + latest_version="1.0.0", + latest_version_tag="v1.0.0", + latest_version_position=3, + unreleased_end=3, + unreleased_start=1, +) + +CHANGELOG_D = """ +h2. Unreleased +* Start using "changelog" over "change log" since it's the common usage. +""" + +EXPECTED_D = Metadata( + latest_version=None, + latest_version_position=None, + unreleased_end=2, + unreleased_start=1, +) + +CHANGELOG_E = """ +h1. Changelog + +All notable changes to this project will be documented in this file. + +The format is based on "Keep a Changelog":https://keepachangelog.com/en/1.0.0/, +and this project adheres to "Semantic Versioning":https://semver.org/spec/v2.0.0.html. + +h2. [Unreleased] +- Start using "changelog" over "change log" since it's the common usage. + +h2. [{tag_formatted_version}] - 2017-06-20 +h3. Added +* New visual identity by [@tylerfortune8](https://github.com/tylerfortune8). +* Version navigation. +""".strip() + + +@pytest.fixture +def format(config: BaseConfig) -> Textile: + return Textile(config) + + +@pytest.fixture +def format_with_tags(config: BaseConfig, request) -> Textile: + config.settings["tag_format"] = request.param + config.settings["legacy_tag_formats"] = ["legacy-${version}"] + return Textile(config) + + +VERSIONS_EXAMPLES = [ + ("h2. [1.0.0] - 2017-06-20", ("1.0.0", "1.0.0")), + ( + 'h1. "10.0.0-next.3":https://github.com/angular/angular/compare/10.0.0-next.2...10.0.0-next.3 (2020-04-22)', + ("10.0.0-next.3", "10.0.0-next.3"), + ), + ("h3. 0.19.1 (Jan 7, 2020)", ("0.19.1", "0.19.1")), + ("h2. 1.0.0", ("1.0.0", "1.0.0")), + ("h2. v1.0.0", ("1.0.0", "v1.0.0")), + ("h2. v1.0.0 - (2012-24-32)", ("1.0.0", "v1.0.0")), + ("h1. version 2020.03.24", ("2020.03.24", "2020.03.24")), + ("h2. [Unreleased]", None), + ("All notable changes to this project will be documented in this file.", None), + ("h1. Changelog", None), + ("h3. Bug Fixes", None), +] + + +@pytest.mark.parametrize(("line_from_changelog", "output_version"), VERSIONS_EXAMPLES) +def test_changelog_detect_version( + line_from_changelog: str, output_version: tuple[str, str] | None, format: Textile +): + version = format.parse_version_from_title(line_from_changelog) + assert version == output_version + + +TITLES_EXAMPLES = [ + ("h2. [1.0.0] - 2017-06-20", 2), + ("h2. [Unreleased]", 2), + ("h1. Unreleased", 1), +] + + +@pytest.mark.parametrize(("line_from_changelog", "output_title"), TITLES_EXAMPLES) +def test_parse_title_type_of_line( + line_from_changelog: str, output_title: str, format: Textile +): + title = format.parse_title_level(line_from_changelog) + assert title == output_title + + +@pytest.mark.parametrize( + ("content", "expected"), + [ + pytest.param(CHANGELOG_A, EXPECTED_A, id="A"), + pytest.param(CHANGELOG_B, EXPECTED_B, id="B"), + pytest.param(CHANGELOG_C, EXPECTED_C, id="C"), + pytest.param(CHANGELOG_D, EXPECTED_D, id="D"), + ], +) +def test_get_metadata( + tmp_path: Path, format: Textile, content: str, expected: Metadata +): + changelog = tmp_path / format.default_changelog_file + changelog.write_text(content) + + assert format.get_metadata(str(changelog)) == expected + + +@pytest.mark.parametrize( + ("format_with_tags", "tag_string", "expected"), + [ + pytest.param("${version}-example", "1.0.0-example", "1.0.0"), + pytest.param("${version}example", "1.0.0example", "1.0.0"), + pytest.param("example${version}", "example1.0.0", "1.0.0"), + pytest.param("example-${version}", "example-1.0.0", "1.0.0"), + pytest.param("example-${major}-${minor}-${patch}", "example-1-0-0", "1.0.0"), + pytest.param("example-${major}-${minor}", "example-1-0-0", None), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}-example", + "1-0-0-rc1-example", + "1.0.0-rc1", + ), + pytest.param( + "${major}-${minor}-${patch}-${prerelease}${devrelease}-example", + "1-0-0-a1.dev1-example", + "1.0.0-a1.dev1", + ), + pytest.param("new-${version}", "legacy-1.0.0", "1.0.0"), + ], + indirect=["format_with_tags"], +) +def test_get_metadata_custom_tag_format( + tmp_path: Path, format_with_tags: Textile, tag_string: str, expected: Metadata +): + content = CHANGELOG_E.format(tag_formatted_version=tag_string) + changelog = tmp_path / format_with_tags.default_changelog_file + changelog.write_text(content) + + assert format_with_tags.get_metadata(str(changelog)).latest_version == expected diff --git a/tests/test_changelog_formats.py b/tests/test_changelog_formats.py new file mode 100644 index 0000000000..6ffbc8dc33 --- /dev/null +++ b/tests/test_changelog_formats.py @@ -0,0 +1,63 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + +from commitizen import defaults +from commitizen.changelog_formats import ( + KNOWN_CHANGELOG_FORMATS, + ChangelogFormat, + _guess_changelog_format, + get_changelog_format, +) +from commitizen.exceptions import ChangelogFormatUnknown + +if TYPE_CHECKING: + from commitizen.config.base_config import BaseConfig + + +@pytest.mark.parametrize("format", KNOWN_CHANGELOG_FORMATS.values()) +def test_guess_format(format: type[ChangelogFormat]): + assert _guess_changelog_format(f"CHANGELOG.{format.extension}") is format + for ext in format.alternative_extensions: + assert _guess_changelog_format(f"CHANGELOG.{ext}") is format + + +@pytest.mark.parametrize("filename", ["CHANGELOG", "NEWS", "file.unknown", None]) +def test_guess_format_unknown(filename: str): + assert _guess_changelog_format(filename) is None + + +@pytest.mark.parametrize( + ("name", "expected"), + [ + pytest.param(name, format, id=name) + for name, format in KNOWN_CHANGELOG_FORMATS.items() + ], +) +def test_get_format(config: BaseConfig, name: str, expected: type[ChangelogFormat]): + config.settings["changelog_format"] = name + assert isinstance(get_changelog_format(config), expected) + + +@pytest.mark.parametrize("filename", [None, ""]) +def test_get_format_empty_filename(config: BaseConfig, filename: str | None): + config.settings["changelog_format"] = defaults.CHANGELOG_FORMAT + assert isinstance( + get_changelog_format(config, filename), + KNOWN_CHANGELOG_FORMATS[defaults.CHANGELOG_FORMAT], + ) + + +@pytest.mark.parametrize("filename", [None, ""]) +def test_get_format_empty_filename_no_setting(config: BaseConfig, filename: str | None): + config.settings["changelog_format"] = None + with pytest.raises(ChangelogFormatUnknown): + get_changelog_format(config, filename) + + +@pytest.mark.parametrize("filename", ["extensionless", "file.unknown"]) +def test_get_format_unknown(config: BaseConfig, filename: str | None): + with pytest.raises(ChangelogFormatUnknown): + get_changelog_format(config, filename) diff --git a/tests/test_cli.py b/tests/test_cli.py index 619f1c5057..c1f6d5beda 100644 --- a/tests/test_cli.py +++ b/tests/test_cli.py @@ -1,30 +1,234 @@ +import os +import subprocess import sys +import types +from functools import partial import pytest +from pytest_mock import MockFixture from commitizen import cli +from commitizen.exceptions import ( + ConfigFileNotFound, + ExpectedExit, + InvalidCommandArgumentError, + NoCommandFoundError, + NotAGitProjectError, +) +from tests.utils import UtilFixture -def test_sysexit_no_argv(): - with pytest.raises(SystemExit): - cli.main() +@pytest.mark.usefixtures("python_version", "consistent_terminal_output") +def test_no_argv(util: UtilFixture, capsys, file_regression): + with pytest.raises(ExpectedExit): + util.run_cli() + out, err = capsys.readouterr() + assert out == "" + file_regression.check(err, extension=".txt") + + +@pytest.mark.parametrize( + "arg", + [ + "--invalid-arg", + "invalidCommand", + ], +) +@pytest.mark.usefixtures("python_version", "consistent_terminal_output") +def test_invalid_command(util: UtilFixture, capsys, file_regression, arg): + with pytest.raises(NoCommandFoundError): + util.run_cli(arg) + out, err = capsys.readouterr() + assert out == "" + file_regression.check(err, extension=".txt") + + +def test_cz_config_file_without_correct_file_path(util: UtilFixture, capsys): + with pytest.raises(ConfigFileNotFound) as excinfo: + util.run_cli("--config", "./config/pyproject.toml", "example") + assert "Cannot found the config file" in str(excinfo.value) + + +def test_cz_with_arg_but_without_command(util: UtilFixture): + with pytest.raises(NoCommandFoundError) as excinfo: + util.run_cli("--name", "cz_jira") + assert "Command is required" in str(excinfo.value) + + +def test_name(util: UtilFixture, capsys): + util.run_cli("-n", "cz_jira", "example") + out, _ = capsys.readouterr() + assert out.startswith("JRA") + +@pytest.mark.usefixtures("tmp_git_project") +def test_name_default_value(util: UtilFixture, capsys): + util.run_cli("example") + out, _ = capsys.readouterr() + assert out.startswith("fix: correct minor typos in code") -def test_ls(mocker, capsys): - testargs = ["cz", "-n", "cz_jira", "ls"] - mocker.patch.object(sys, "argv", testargs) - cli.main() + +def test_ls(util: UtilFixture, capsys): + util.run_cli("-n", "cz_jira", "ls") out, err = capsys.readouterr() assert "cz_conventional_commits" in out assert isinstance(out, str) -def test_version(mocker): - testargs = ["cz", "--version"] - mocker.patch.object(sys, "argv", testargs) - error_mock = mocker.patch("commitizen.out.error") +def test_arg_debug(util: UtilFixture): + util.run_cli("--debug", "info") + excepthook = sys.excepthook + # `sys.excepthook` is replaced by a `partial` in `cli.main` + # it's not a normal function + assert isinstance(excepthook, partial) + assert excepthook.keywords.get("debug") is True + + +def test_commitizen_excepthook(capsys): + with pytest.raises(SystemExit) as excinfo: + cli.commitizen_excepthook(NotAGitProjectError, NotAGitProjectError(), "") + + assert excinfo.type is SystemExit + assert excinfo.value.code == NotAGitProjectError.exit_code + + +def test_commitizen_debug_excepthook(capsys): + with pytest.raises(SystemExit) as excinfo: + cli.commitizen_excepthook( + NotAGitProjectError, + NotAGitProjectError(), + "", + debug=True, + ) + + assert excinfo.type is SystemExit + assert excinfo.value.code == NotAGitProjectError.exit_code + assert "NotAGitProjectError" in str(excinfo.traceback[0]) + + +@pytest.mark.skipif( + os.name == "nt", + reason="`argcomplete` does not support Git Bash on Windows.", +) +def test_argcomplete_activation(): + """ + This function is testing the one-time activation of argcomplete for + commitizen only. + + Equivalent to run: + $ eval "$(register-python-argcomplete pytest)" + """ + output = subprocess.run(["register-python-argcomplete", "cz"]) + + assert output.returncode == 0 + + +def test_commitizen_excepthook_no_raises(capsys): + with pytest.raises(SystemExit) as excinfo: + cli.commitizen_excepthook( + NotAGitProjectError, + NotAGitProjectError(), + "", + no_raise=[NotAGitProjectError.exit_code], + ) + + assert excinfo.type is SystemExit + assert excinfo.value.code == 0 + + +@pytest.mark.parametrize( + ("input_str", "expected_result"), + [ + pytest.param("1", [1], id="single_code"), + pytest.param("1,2,3", [1, 2, 3], id="multiple_number_codes"), + pytest.param( + "NO_COMMITIZEN_FOUND,NO_COMMITS_FOUND,NO_PATTERN_MAP", + [1, 3, 5], + id="string_codes", + ), + pytest.param( + "NO_COMMITIZEN_FOUND,2,NO_COMMITS_FOUND,4", + [1, 2, 3, 4], + id="number_and_string_codes", + ), + pytest.param( + "NO_COMMITIZEN_FOUND,2,nothing,4", + [1, 2, 4], + id="number_and_string_codes_and_invalid_code", + ), + ], +) +def test_parse_no_raise(input_str, expected_result): + result = cli.parse_no_raise(input_str) + assert result == expected_result + + +def test_unknown_args_raises(util: UtilFixture): + with pytest.raises(InvalidCommandArgumentError) as excinfo: + util.run_cli("c", "-this_arg_is_not_supported") + assert "Invalid commitizen arguments were found" in str(excinfo.value) + + +def test_unknown_args_before_double_dash_raises(util: UtilFixture): + with pytest.raises(InvalidCommandArgumentError) as excinfo: + util.run_cli("c", "-this_arg_is_not_supported", "--") + assert "Invalid commitizen arguments were found before -- separator" in str( + excinfo.value + ) + + +def test_commitizen_excepthook_non_commitizen_exception(mocker: MockFixture): + """Test that commitizen_excepthook delegates to sys.__excepthook__ for non-CommitizenException.""" + # Mock the original excepthook + mock_original_excepthook = mocker.Mock() + mocker.patch("commitizen.cli.sys.__excepthook__", mock_original_excepthook) + + # Create a regular exception + test_exception = ValueError("test error") + + # Call commitizen_excepthook with the regular exception + cli.commitizen_excepthook(ValueError, test_exception, None) + + # Verify sys.__excepthook__ was called with correct arguments + mock_original_excepthook.assert_called_once_with(ValueError, test_exception, None) + + +def test_commitizen_excepthook_non_commitizen_exception_with_traceback( + mocker: MockFixture, +): + """Test that commitizen_excepthook handles traceback correctly for non-CommitizenException.""" + # Mock the original excepthook + mock_original_excepthook = mocker.Mock() + mocker.patch("commitizen.cli.sys.__excepthook__", mock_original_excepthook) + + # Create a regular exception with a traceback + test_exception = ValueError("test error") + test_traceback = mocker.Mock(spec=types.TracebackType) + + # Call commitizen_excepthook with the regular exception and traceback + cli.commitizen_excepthook(ValueError, test_exception, test_traceback) + + # Verify sys.__excepthook__ was called with correct arguments including traceback + mock_original_excepthook.assert_called_once_with( + ValueError, test_exception, test_traceback + ) + + +def test_commitizen_excepthook_non_commitizen_exception_with_invalid_traceback( + mocker: MockFixture, +): + """Test that commitizen_excepthook handles invalid traceback correctly for non-CommitizenException.""" + # Mock the original excepthook + mock_original_excepthook = mocker.Mock() + mocker.patch("commitizen.cli.sys.__excepthook__", mock_original_excepthook) + + # Create a regular exception with an invalid traceback + test_exception = ValueError("test error") + test_traceback = mocker.Mock() # Not a TracebackType - cli.main() + # Call commitizen_excepthook with the regular exception and invalid traceback + cli.commitizen_excepthook(ValueError, test_exception, test_traceback) - error_mock.assert_called_once() + # Verify sys.__excepthook__ was called with None as traceback + mock_original_excepthook.assert_called_once_with(ValueError, test_exception, None) diff --git a/tests/test_cli/test_invalid_command_py_3_10___invalid_arg_.txt b/tests/test_cli/test_invalid_command_py_3_10___invalid_arg_.txt new file mode 100644 index 0000000000..148b4eacdb --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_10___invalid_arg_.txt @@ -0,0 +1,4 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... +cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} diff --git a/tests/test_cli/test_invalid_command_py_3_10_invalidCommand_.txt b/tests/test_cli/test_invalid_command_py_3_10_invalidCommand_.txt new file mode 100644 index 0000000000..e2d4416b81 --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_10_invalidCommand_.txt @@ -0,0 +1,4 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... +cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from 'init', 'commit', 'c', 'ls', 'example', 'info', 'schema', 'bump', 'changelog', 'ch', 'check', 'version') diff --git a/tests/test_cli/test_invalid_command_py_3_11___invalid_arg_.txt b/tests/test_cli/test_invalid_command_py_3_11___invalid_arg_.txt new file mode 100644 index 0000000000..148b4eacdb --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_11___invalid_arg_.txt @@ -0,0 +1,4 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... +cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} diff --git a/tests/test_cli/test_invalid_command_py_3_11_invalidCommand_.txt b/tests/test_cli/test_invalid_command_py_3_11_invalidCommand_.txt new file mode 100644 index 0000000000..e2d4416b81 --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_11_invalidCommand_.txt @@ -0,0 +1,4 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... +cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from 'init', 'commit', 'c', 'ls', 'example', 'info', 'schema', 'bump', 'changelog', 'ch', 'check', 'version') diff --git a/tests/test_cli/test_invalid_command_py_3_12___invalid_arg_.txt b/tests/test_cli/test_invalid_command_py_3_12___invalid_arg_.txt new file mode 100644 index 0000000000..148b4eacdb --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_12___invalid_arg_.txt @@ -0,0 +1,4 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... +cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} diff --git a/tests/test_cli/test_invalid_command_py_3_12_invalidCommand_.txt b/tests/test_cli/test_invalid_command_py_3_12_invalidCommand_.txt new file mode 100644 index 0000000000..c92220c4dc --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_12_invalidCommand_.txt @@ -0,0 +1,4 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... +cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from init, commit, c, ls, example, info, schema, bump, changelog, ch, check, version) diff --git a/tests/test_cli/test_invalid_command_py_3_13___invalid_arg_.txt b/tests/test_cli/test_invalid_command_py_3_13___invalid_arg_.txt new file mode 100644 index 0000000000..4f0ba2b148 --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_13___invalid_arg_.txt @@ -0,0 +1,3 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ... +cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} diff --git a/tests/test_cli/test_invalid_command_py_3_13_invalidCommand_.txt b/tests/test_cli/test_invalid_command_py_3_13_invalidCommand_.txt new file mode 100644 index 0000000000..749066c556 --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_13_invalidCommand_.txt @@ -0,0 +1,3 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ... +cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from init, commit, c, ls, example, info, schema, bump, changelog, ch, check, version) diff --git a/tests/test_cli/test_invalid_command_py_3_14___invalid_arg_.txt b/tests/test_cli/test_invalid_command_py_3_14___invalid_arg_.txt new file mode 100644 index 0000000000..4f0ba2b148 --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_14___invalid_arg_.txt @@ -0,0 +1,3 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ... +cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} diff --git a/tests/test_cli/test_invalid_command_py_3_14_invalidCommand_.txt b/tests/test_cli/test_invalid_command_py_3_14_invalidCommand_.txt new file mode 100644 index 0000000000..749066c556 --- /dev/null +++ b/tests/test_cli/test_invalid_command_py_3_14_invalidCommand_.txt @@ -0,0 +1,3 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ... +cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from init, commit, c, ls, example, info, schema, bump, changelog, ch, check, version) diff --git a/tests/test_cli/test_no_argv_py_3_10_.txt b/tests/test_cli/test_no_argv_py_3_10_.txt new file mode 100644 index 0000000000..69f410e96d --- /dev/null +++ b/tests/test_cli/test_no_argv_py_3_10_.txt @@ -0,0 +1,34 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... + +Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management. +For more information, please visit https://commitizen-tools.github.io/commitizen + +options: + -h, --help show this help message and exit + --config CONFIG The path to the configuration file. + --debug Use debug mode. + -n NAME, --name NAME Use the given commitizen (default: + cz_conventional_commits). + -nr NO_RAISE, --no-raise NO_RAISE + Comma-separated error codes that won't raise error, + e.g., cz -nr 1,2,3 bump. See codes at + https://commitizen- + tools.github.io/commitizen/exit_codes/ + +commands: + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + init Initialize commitizen configuration. + commit (c) Create new commit. + ls Show available Commitizens. + example Show commit example. + info Show information about the cz. + schema Show commit schema. + bump Bump semantic version based on the git log. + changelog (ch) Generate changelog (note that it will overwrite + existing files). + check Validate that a commit message matches the commitizen + schema. + version Get the version of the installed commitizen or the + current project (default: installed commitizen). diff --git a/tests/test_cli/test_no_argv_py_3_11_.txt b/tests/test_cli/test_no_argv_py_3_11_.txt new file mode 100644 index 0000000000..69f410e96d --- /dev/null +++ b/tests/test_cli/test_no_argv_py_3_11_.txt @@ -0,0 +1,34 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... + +Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management. +For more information, please visit https://commitizen-tools.github.io/commitizen + +options: + -h, --help show this help message and exit + --config CONFIG The path to the configuration file. + --debug Use debug mode. + -n NAME, --name NAME Use the given commitizen (default: + cz_conventional_commits). + -nr NO_RAISE, --no-raise NO_RAISE + Comma-separated error codes that won't raise error, + e.g., cz -nr 1,2,3 bump. See codes at + https://commitizen- + tools.github.io/commitizen/exit_codes/ + +commands: + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + init Initialize commitizen configuration. + commit (c) Create new commit. + ls Show available Commitizens. + example Show commit example. + info Show information about the cz. + schema Show commit schema. + bump Bump semantic version based on the git log. + changelog (ch) Generate changelog (note that it will overwrite + existing files). + check Validate that a commit message matches the commitizen + schema. + version Get the version of the installed commitizen or the + current project (default: installed commitizen). diff --git a/tests/test_cli/test_no_argv_py_3_12_.txt b/tests/test_cli/test_no_argv_py_3_12_.txt new file mode 100644 index 0000000000..69f410e96d --- /dev/null +++ b/tests/test_cli/test_no_argv_py_3_12_.txt @@ -0,0 +1,34 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + ... + +Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management. +For more information, please visit https://commitizen-tools.github.io/commitizen + +options: + -h, --help show this help message and exit + --config CONFIG The path to the configuration file. + --debug Use debug mode. + -n NAME, --name NAME Use the given commitizen (default: + cz_conventional_commits). + -nr NO_RAISE, --no-raise NO_RAISE + Comma-separated error codes that won't raise error, + e.g., cz -nr 1,2,3 bump. See codes at + https://commitizen- + tools.github.io/commitizen/exit_codes/ + +commands: + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + init Initialize commitizen configuration. + commit (c) Create new commit. + ls Show available Commitizens. + example Show commit example. + info Show information about the cz. + schema Show commit schema. + bump Bump semantic version based on the git log. + changelog (ch) Generate changelog (note that it will overwrite + existing files). + check Validate that a commit message matches the commitizen + schema. + version Get the version of the installed commitizen or the + current project (default: installed commitizen). diff --git a/tests/test_cli/test_no_argv_py_3_13_.txt b/tests/test_cli/test_no_argv_py_3_13_.txt new file mode 100644 index 0000000000..b47528ec3e --- /dev/null +++ b/tests/test_cli/test_no_argv_py_3_13_.txt @@ -0,0 +1,33 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ... + +Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management. +For more information, please visit https://commitizen-tools.github.io/commitizen + +options: + -h, --help show this help message and exit + --config CONFIG The path to the configuration file. + --debug Use debug mode. + -n, --name NAME Use the given commitizen (default: + cz_conventional_commits). + -nr, --no-raise NO_RAISE + Comma-separated error codes that won't raise error, + e.g., cz -nr 1,2,3 bump. See codes at + https://commitizen- + tools.github.io/commitizen/exit_codes/ + +commands: + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + init Initialize commitizen configuration. + commit (c) Create new commit. + ls Show available Commitizens. + example Show commit example. + info Show information about the cz. + schema Show commit schema. + bump Bump semantic version based on the git log. + changelog (ch) Generate changelog (note that it will overwrite + existing files). + check Validate that a commit message matches the commitizen + schema. + version Get the version of the installed commitizen or the + current project (default: installed commitizen). diff --git a/tests/test_cli/test_no_argv_py_3_14_.txt b/tests/test_cli/test_no_argv_py_3_14_.txt new file mode 100644 index 0000000000..b47528ec3e --- /dev/null +++ b/tests/test_cli/test_no_argv_py_3_14_.txt @@ -0,0 +1,33 @@ +usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ... + +Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management. +For more information, please visit https://commitizen-tools.github.io/commitizen + +options: + -h, --help show this help message and exit + --config CONFIG The path to the configuration file. + --debug Use debug mode. + -n, --name NAME Use the given commitizen (default: + cz_conventional_commits). + -nr, --no-raise NO_RAISE + Comma-separated error codes that won't raise error, + e.g., cz -nr 1,2,3 bump. See codes at + https://commitizen- + tools.github.io/commitizen/exit_codes/ + +commands: + {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} + init Initialize commitizen configuration. + commit (c) Create new commit. + ls Show available Commitizens. + example Show commit example. + info Show information about the cz. + schema Show commit schema. + bump Bump semantic version based on the git log. + changelog (ch) Generate changelog (note that it will overwrite + existing files). + check Validate that a commit message matches the commitizen + schema. + version Get the version of the installed commitizen or the + current project (default: installed commitizen). diff --git a/tests/test_cmd.py b/tests/test_cmd.py new file mode 100644 index 0000000000..77a67cf4e2 --- /dev/null +++ b/tests/test_cmd.py @@ -0,0 +1,57 @@ +import pytest + +from commitizen import cmd +from commitizen.exceptions import CharacterSetDecodeError + + +# https://docs.python.org/3/howto/unicode.html +@pytest.mark.parametrize( + "s", + [ + "", + "ascii", + "🤦🏻‍♂️", + "﷽", + "\u0000", + ], +) +def test_valid_utf8_encoded_strings(s: str): + assert s == cmd._try_decode(s.encode("utf-8")) + + +# A word of caution: just because an encoding can be guessed for a given +# sequence of bytes and because that guessed encoding may yield a decoded +# string, does not mean that that string was the original! For more, see: +# https://docs.python.org/3/library/codecs.html#standard-encodings + + +@pytest.mark.parametrize( + "s", + [ + "", + "ascii", + "äöüß", + "ça va", + "jak se máte", + ], +) +def test_valid_cp1250_encoded_strings(s: str): + """Pick a random, non-utf8 encoding to test.""" + # We just want to make sure it doesn't raise an exception + cmd._try_decode(s.encode("cp1250")) + + +def test_invalid_bytes(): + with pytest.raises(CharacterSetDecodeError): + cmd._try_decode(b"\x73\xe2\x9d\xff\x00") + + +def test_always_fail_decode(): + class _bytes(bytes): + def decode(self, encoding="utf-8", errors="strict"): + raise UnicodeDecodeError( + encoding, self, 0, 0, "Failing intentionally for testing" + ) + + with pytest.raises(CharacterSetDecodeError): + cmd._try_decode(_bytes()) diff --git a/tests/test_commands.py b/tests/test_commands.py deleted file mode 100644 index bd08c3da8f..0000000000 --- a/tests/test_commands.py +++ /dev/null @@ -1,144 +0,0 @@ -import os -from unittest import mock - -import pytest - -from commitizen import cmd, commands, defaults -from commitizen.cz.exceptions import CzException - -config = {"name": defaults.name} - - -@pytest.fixture -def staging_is_clean(mocker): - is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean") - is_staging_clean_mock.return_value = False - - -@pytest.mark.usefixtures("staging_is_clean") -def test_commit(mocker): - prompt_mock = mocker.patch("questionary.prompt") - prompt_mock.return_value = { - "prefix": "feat", - "subject": "user created", - "scope": "", - "is_breaking_change": False, - "body": "", - "footer": "", - } - - commit_mock = mocker.patch("commitizen.git.commit") - commit_mock.return_value = cmd.Command("success", "", "", "") - success_mock = mocker.patch("commitizen.out.success") - - commands.Commit(config, {})() - success_mock.assert_called_once() - - -@pytest.mark.usefixtures("staging_is_clean") -def test_commit_retry_fails_no_backup(mocker): - commit_mock = mocker.patch("commitizen.git.commit") - commit_mock.return_value = cmd.Command("success", "", "", "") - - with pytest.raises(SystemExit): - commands.Commit(config, {"retry": True})() - - -@pytest.mark.usefixtures("staging_is_clean") -def test_commit_retry_works(mocker): - prompt_mock = mocker.patch("questionary.prompt") - prompt_mock.return_value = { - "prefix": "feat", - "subject": "user created", - "scope": "", - "is_breaking_change": False, - "body": "closes #21", - "footer": "", - } - - commit_mock = mocker.patch("commitizen.git.commit") - commit_mock.return_value = cmd.Command("", "error", "", "") - error_mock = mocker.patch("commitizen.out.error") - - with pytest.raises(SystemExit): - commit_cmd = commands.Commit(config, {}) - temp_file = commit_cmd.temp_file - commit_cmd() - - prompt_mock.assert_called_once() - error_mock.assert_called_once() - assert os.path.isfile(temp_file) - - # Previous commit failed, so retry should pick up the backup commit - # commit_mock = mocker.patch("commitizen.git.commit") - commit_mock.return_value = cmd.Command("success", "", "", "") - success_mock = mocker.patch("commitizen.out.success") - - commands.Commit(config, {"retry": True})() - - commit_mock.assert_called_with("feat: user created\n\ncloses #21") - prompt_mock.assert_called_once() - success_mock.assert_called_once() - assert not os.path.isfile(temp_file) - - -def test_commit_when_nothing_to_commit(mocker): - is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean") - is_staging_clean_mock.return_value = True - - with pytest.raises(SystemExit) as err: - commit_cmd = commands.Commit(config, {}) - commit_cmd() - - assert err.value.code == commands.commit.NOTHING_TO_COMMIT - - -def test_commit_when_customized_expected_raised(mocker, capsys): - _err = ValueError() - _err.__context__ = CzException("This is the root custom err") - git_mock = mocker.patch("commitizen.git.is_staging_clean") - git_mock.return_value = False - prompt_mock = mocker.patch("questionary.prompt") - prompt_mock.side_effect = _err - - with pytest.raises(SystemExit) as err: - commit_cmd = commands.Commit(config, {}) - commit_cmd() - - assert err.value.code == commands.commit.CUSTOM_ERROR - - # Assert only the content in the formatted text - captured = capsys.readouterr() - assert "This is the root custom err" in captured.err - - -def test_example(): - with mock.patch("commitizen.out.write") as write_mock: - commands.Example(config)() - write_mock.assert_called_once() - - -def test_info(): - with mock.patch("commitizen.out.write") as write_mock: - commands.Info(config)() - write_mock.assert_called_once() - - -def test_schema(): - with mock.patch("commitizen.out.write") as write_mock: - commands.Schema(config)() - write_mock.assert_called_once() - - -def test_list_cz(): - with mock.patch("commitizen.out.write") as mocked_write: - - commands.ListCz(config)() - mocked_write.assert_called_once() - - -def test_version(): - with mock.patch("commitizen.out.write") as mocked_write: - - commands.Version(config)() - mocked_write.assert_called_once() diff --git a/tests/test_conf.py b/tests/test_conf.py index 2544bd5c2d..94bca4e77b 100644 --- a/tests/test_conf.py +++ b/tests/test_conf.py @@ -1,14 +1,24 @@ +from __future__ import annotations + +import json import os +from pathlib import Path +from typing import Any import pytest +import yaml -from commitizen import config, defaults +from commitizen import cmd, config, defaults, git +from commitizen.config.json_config import JsonConfig +from commitizen.config.toml_config import TomlConfig +from commitizen.config.yaml_config import YAMLConfig +from commitizen.exceptions import ConfigFileIsEmpty, InvalidConfigurationError -PYPROJECT = """ +TOML_STR = """ [tool.commitizen] name = "cz_jira" version = "1.0.0" -files = [ +version_files = [ "commitizen/__version__.py", "pyproject.toml" ] @@ -16,140 +26,474 @@ ["pointer", "reverse"], ["question", "underline"] ] +pre_bump_hooks = [ + "scripts/generate_documentation.sh" +] +post_bump_hooks = ["scripts/slack_notification.sh"] +""" + +PYPROJECT = f""" +{TOML_STR} [tool.black] line-length = 88 target-version = ['py36', 'py37', 'py38'] """ -RAW_CONFIG = """ -[commitizen] -name = cz_jira -version = 1.0.0 -files = [ - "commitizen/__version__.py", - "pyproject.toml" - ] -style = [ - ["pointer", "reverse"], - ["question", "underline"] - ] + +DICT_CONFIG = { + "commitizen": { + "name": "cz_jira", + "version": "1.0.0", + "version_files": ["commitizen/__version__.py", "pyproject.toml"], + "style": [["pointer", "reverse"], ["question", "underline"]], + "pre_bump_hooks": ["scripts/generate_documentation.sh"], + "post_bump_hooks": ["scripts/slack_notification.sh"], + } +} + +JSON_STR = r""" + { + "commitizen": { + "name": "cz_jira", + "version": "1.0.0", + "version_files": [ + "commitizen/__version__.py", + "pyproject.toml" + ] + } + } +""" + +YAML_STR = """ +commitizen: + name: cz_jira + version: 1.0.0 + version_files: + - commitizen/__version__.py + - pyproject.toml """ -_config = { +_settings: dict[str, Any] = { "name": "cz_jira", "version": "1.0.0", - "tag_format": None, + "version_provider": "commitizen", + "version_scheme": None, + "tag_format": "$version", + "legacy_tag_formats": [], + "ignored_tag_formats": [], "bump_message": None, - "files": ["commitizen/__version__.py", "pyproject.toml"], + "retry_after_failure": False, + "allow_abort": False, + "allowed_prefixes": [ + "Merge", + "Revert", + "Pull request", + "fixup!", + "squash!", + "amend!", + ], + "version_files": ["commitizen/__version__.py", "pyproject.toml"], "style": [["pointer", "reverse"], ["question", "underline"]], + "changelog_file": "CHANGELOG.md", + "changelog_format": None, + "changelog_incremental": False, + "changelog_start_rev": None, + "changelog_merge_prerelease": False, + "update_changelog_on_bump": False, + "use_shortcuts": False, + "major_version_zero": False, + "pre_bump_hooks": ["scripts/generate_documentation.sh"], + "post_bump_hooks": ["scripts/slack_notification.sh"], + "prerelease_offset": 0, + "encoding": "utf-8", + "always_signoff": False, + "template": None, + "extras": {}, + "breaking_change_exclamation_in_title": False, + "message_length_limit": 0, } -_new_config = { +_new_settings: dict[str, Any] = { "name": "cz_jira", "version": "2.0.0", - "tag_format": None, + "version_provider": "commitizen", + "version_scheme": None, + "tag_format": "$version", + "legacy_tag_formats": [], + "ignored_tag_formats": [], "bump_message": None, - "files": ["commitizen/__version__.py", "pyproject.toml"], + "retry_after_failure": False, + "allow_abort": False, + "allowed_prefixes": [ + "Merge", + "Revert", + "Pull request", + "fixup!", + "squash!", + "amend!", + ], + "version_files": ["commitizen/__version__.py", "pyproject.toml"], "style": [["pointer", "reverse"], ["question", "underline"]], + "changelog_file": "CHANGELOG.md", + "changelog_format": None, + "changelog_incremental": False, + "changelog_start_rev": None, + "changelog_merge_prerelease": False, + "update_changelog_on_bump": False, + "use_shortcuts": False, + "major_version_zero": False, + "pre_bump_hooks": ["scripts/generate_documentation.sh"], + "post_bump_hooks": ["scripts/slack_notification.sh"], + "prerelease_offset": 0, + "encoding": "utf-8", + "always_signoff": False, + "template": None, + "extras": {}, + "breaking_change_exclamation_in_title": False, + "message_length_limit": 0, } -_read_conf = { - "name": "cz_jira", - "version": "1.0.0", - "files": ["commitizen/__version__.py", "pyproject.toml"], - "style": [["pointer", "reverse"], ["question", "underline"]], -} - - -@pytest.fixture -def configure_supported_files(): - config._conf = config.Config() - original = defaults.config_files.copy() - - # patch the defaults to include tests - defaults.config_files = [os.path.join("tests", f) for f in defaults.config_files] - yield - defaults.config_files = original - @pytest.fixture -def config_files_manager(request): +def config_files_manager(request, tmp_path, monkeypatch): + monkeypatch.chdir(tmp_path) filename = request.param - filepath = os.path.join("tests", filename) - with open(filepath, "w") as f: + path = tmp_path / filename + path.parent.mkdir(parents=True, exist_ok=True) + with path.open("w", encoding="utf-8") as f: if "toml" in filename: f.write(PYPROJECT) - else: - f.write(RAW_CONFIG) - yield - os.remove(filepath) + elif "json" in filename: + json.dump(DICT_CONFIG, f) + elif "yaml" in filename: + yaml.dump(DICT_CONFIG, f) + return -@pytest.fixture -def empty_pyproject_ok_cz(): - pyproject = "tests/pyproject.toml" - cz = "tests/.cz" - with open(pyproject, "w") as f: - f.write("") - with open(cz, "w") as f: - f.write(RAW_CONFIG) - yield - os.remove(pyproject) - os.remove(cz) - +@pytest.mark.usefixtures("in_repo_root") +def test_find_git_project_root(tmp_path, monkeypatch): + assert git.find_git_project_root() == Path(os.getcwd()) -def test_no_pyproject(mocker): - with mocker.patch("os.path.isfile", return_value=False): - assert config.has_pyproject() is False + monkeypatch.chdir(tmp_path) + assert git.find_git_project_root() is None -def test_has_pyproject(mocker): - with mocker.patch("os.path.isfile", return_value=True): - assert config.has_pyproject() is True +@pytest.mark.parametrize("config_files_manager", defaults.CONFIG_FILES, indirect=True) +def test_set_key(config_files_manager): + _conf = config.read_cfg() + _conf.set_key("version", "2.0.0") + cfg = config.read_cfg() + assert cfg.settings == _new_settings + + +class TestReadCfg: + @pytest.mark.parametrize( + "config_files_manager", defaults.CONFIG_FILES, indirect=True + ) + def test_load_conf(self, config_files_manager): + cfg = config.read_cfg() + assert cfg.settings == _settings + + def test_conf_returns_default_when_no_files(self, tmp_path, monkeypatch): + monkeypatch.chdir(tmp_path) + cfg = config.read_cfg() + assert cfg.settings == defaults.DEFAULT_SETTINGS + + def test_load_empty_pyproject_toml_and_cz_toml_with_config( + self, tmp_path, monkeypatch + ): + monkeypatch.chdir(tmp_path) + (tmp_path / "pyproject.toml").write_text("") + (tmp_path / ".cz.toml").write_text(TOML_STR) + + cfg = config.read_cfg() + assert cfg.settings == _settings + + def test_load_pyproject_toml_from_config_argument(self, tmp_path, monkeypatch): + monkeypatch.chdir(tmp_path) + _not_root_path = tmp_path / "not_in_root" / "pyproject.toml" + _not_root_path.parent.mkdir(parents=True, exist_ok=True) + _not_root_path.write_text(PYPROJECT) + + cfg = config.read_cfg(_not_root_path) + assert cfg.settings == _settings + + def test_load_cz_json_not_from_config_argument(self, tmp_path, monkeypatch): + monkeypatch.chdir(tmp_path) + _not_root_path = tmp_path / "not_in_root" / ".cz.json" + _not_root_path.parent.mkdir(parents=True, exist_ok=True) + _not_root_path.write_text(JSON_STR) + + cfg = config.read_cfg(_not_root_path) + json_cfg_by_class = JsonConfig(data=JSON_STR, path=_not_root_path) + assert cfg.settings == json_cfg_by_class.settings + + def test_load_cz_yaml_not_from_config_argument(self, tmp_path, monkeypatch): + monkeypatch.chdir(tmp_path) + _not_root_path = tmp_path / "not_in_root" / ".cz.yaml" + _not_root_path.parent.mkdir(parents=True, exist_ok=True) + _not_root_path.write_text(YAML_STR) + + cfg = config.read_cfg(_not_root_path) + yaml_cfg_by_class = YAMLConfig(data=YAML_STR, path=_not_root_path) + assert cfg.settings == yaml_cfg_by_class._settings + + def test_load_empty_pyproject_toml_from_config_argument( + self, tmp_path, monkeypatch + ): + monkeypatch.chdir(tmp_path) + _not_root_path = tmp_path / "not_in_root" / "pyproject.toml" + _not_root_path.parent.mkdir(parents=True, exist_ok=True) + _not_root_path.write_text("") + + with pytest.raises(ConfigFileIsEmpty): + config.read_cfg(_not_root_path) + + def test_load_empty_json_from_config_argument(self, tmpdir): + with tmpdir.as_cwd(): + _not_root_path = tmpdir.mkdir("not_in_root").join(".cz.json") + _not_root_path.write("") + + with pytest.raises(ConfigFileIsEmpty): + config.read_cfg(filepath="./not_in_root/.cz.json") + + def test_load_empty_yaml_from_config_argument(self, tmpdir): + with tmpdir.as_cwd(): + _not_root_path = tmpdir.mkdir("not_in_root").join(".cz.yaml") + _not_root_path.write("") + + with pytest.raises(ConfigFileIsEmpty): + config.read_cfg(filepath="./not_in_root/.cz.yaml") + + +class TestWarnMultipleConfigFiles: + @pytest.mark.parametrize( + ("files", "expected_path"), + [ + # Same directory, different file types + ([(".cz.toml", TOML_STR), (".cz.json", JSON_STR)], ".cz.toml"), + ([(".cz.json", JSON_STR), (".cz.yaml", YAML_STR)], ".cz.json"), + ([(".cz.toml", TOML_STR), (".cz.yaml", YAML_STR)], ".cz.toml"), + # With pyproject.toml + ( + [("pyproject.toml", PYPROJECT), (".cz.json", JSON_STR)], + ".cz.json", + ), + ( + [("pyproject.toml", PYPROJECT), (".cz.toml", TOML_STR)], + ".cz.toml", + ), + ], + ) + def test_warn_multiple_config_files_same_dir( + self, tmp_path, monkeypatch, capsys, files, expected_path + ): + """Test warning when multiple config files exist in same directory.""" + monkeypatch.chdir(tmp_path) + for filename, content in files: + (tmp_path / filename).write_text(content) + + cfg = config.read_cfg() + captured = capsys.readouterr() + + assert "Multiple config files detected" in captured.err + for filename, _ in files: + assert filename in captured.err + assert f"Using config file: '{expected_path}'" in captured.err + + assert cfg.path == Path(expected_path) + + @pytest.mark.parametrize( + ("config_file", "content"), + [ + (".cz.json", JSON_STR), + (".cz.toml", TOML_STR), + (".cz.yaml", YAML_STR), + ("cz.toml", TOML_STR), + ("cz.json", JSON_STR), + ("cz.yaml", YAML_STR), + ], + ) + def test_warn_same_filename_different_directories_with_git( + self, tmp_path, monkeypatch, capsys, config_file, content + ): + """Test warning when same config filename exists in the current directory and in the git root.""" + monkeypatch.chdir(tmp_path) + cmd.run("git init") + + # Create config in git root + (tmp_path / config_file).write_text(content) + + # Create same filename in subdirectory + subdir = tmp_path / "subdir" + subdir.mkdir() + (subdir / config_file).write_text(content) + + monkeypatch.chdir(subdir) + cfg = config.read_cfg() + captured = capsys.readouterr() + + assert "Multiple config files detected" in captured.err + assert f"Using config file: '{config_file}'" in captured.err + assert cfg.path == Path(config_file) + + def test_no_warn_with_explicit_config_path(self, tmp_path, monkeypatch, capsys): + """Test that no warning is issued when user explicitly specifies config.""" + monkeypatch.chdir(tmp_path) + # Create multiple config files + (tmp_path / ".cz.toml").write_text(PYPROJECT) + (tmp_path / ".cz.json").write_text(JSON_STR) + + # Read config with explicit path + cfg = config.read_cfg(Path(".cz.json")) + + # No warning should be issued + captured = capsys.readouterr() + assert "Multiple config files detected" not in captured.err + + # Verify the explicitly specified config is loaded (compare to expected JSON config) + json_cfg_expected = JsonConfig(data=JSON_STR, path=Path(".cz.json")) + assert cfg.settings == json_cfg_expected.settings + + @pytest.mark.parametrize( + ("config_file", "content", "with_git"), + [ + (file, content, with_git) + for file, content in [ + (".cz.toml", TOML_STR), + (".cz.json", JSON_STR), + (".cz.yaml", YAML_STR), + ("pyproject.toml", PYPROJECT), + ("cz.toml", TOML_STR), + ("cz.json", JSON_STR), + ("cz.yaml", YAML_STR), + ] + for with_git in [True, False] + ], + ) + def test_no_warn_with_single_config_file( + self, tmp_path, monkeypatch, capsys, config_file, content, with_git + ): + """Test that no warning is issued when user explicitly specifies config.""" + monkeypatch.chdir(tmp_path) + if with_git: + cmd.run("git init") + + (tmp_path / config_file).write_text(content) + + cfg = config.read_cfg() + captured = capsys.readouterr() + + # No warning should be issued + assert "Multiple config files detected" not in captured.err + assert cfg.path == Path(config_file) + + def test_no_warn_with_no_commitizen_section_in_pyproject_toml_and_cz_toml( + self, tmp_path, monkeypatch, capsys + ): + monkeypatch.chdir(tmp_path) + (tmp_path / "pyproject.toml").write_text("[tool.foo]\nbar = 'baz'") + (tmp_path / ".cz.toml").write_text(TOML_STR) + + cfg = config.read_cfg() + captured = capsys.readouterr() + assert "Multiple config files detected" not in captured.err + assert cfg.path == Path(".cz.toml") -def test_read_pyproject_conf(): - assert config.read_pyproject_conf(PYPROJECT) == _read_conf +@pytest.mark.parametrize( + "config_file", + [ + ".cz.toml", + "cz.toml", + "pyproject.toml", + ], +) +class TestTomlConfig: + def test_init_empty_config_content(self, tmp_path, config_file): + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) + toml_config = TomlConfig(data="", path=path) + toml_config.init_empty_config_content() + assert path.read_text(encoding="utf-8") == "[tool.commitizen]\n" -def test_read_pyproject_conf_empty(): - assert config.read_pyproject_conf("") == {} + def test_init_empty_config_content_with_existing_content( + self, tmp_path, config_file + ): + existing_content = "[tool.black]\nline-length = 88\n" + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) + path.write_text(existing_content) + toml_config = TomlConfig(data="", path=path) + toml_config.init_empty_config_content() -def test_read_raw_parser_conf(): - assert config.read_raw_parser_conf(RAW_CONFIG) == _read_conf + assert ( + path.read_text(encoding="utf-8") + == existing_content + "\n[tool.commitizen]\n" + ) + def test_init_with_invalid_config_content(self, tmp_path, config_file): + existing_content = "invalid toml content" + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) -def test_read_raw_parser_conf_empty(): - assert config.read_raw_parser_conf("") == {} + with pytest.raises(InvalidConfigurationError) as excinfo: + TomlConfig(data=existing_content, path=path) + assert config_file in str(excinfo.value) @pytest.mark.parametrize( - "config_files_manager", defaults.config_files.copy(), indirect=True + "config_file", + [ + ".cz.json", + "cz.json", + ], ) -def test_load_conf(config_files_manager, configure_supported_files): - cfg = config.read_cfg() - assert cfg == _config +class TestJsonConfig: + def test_init_empty_config_content(self, tmp_path, config_file): + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) + json_config = JsonConfig(data="{}", path=path) + json_config.init_empty_config_content() + with path.open(encoding="utf-8") as json_file: + assert json.load(json_file) == {"commitizen": {}} -def test_conf_is_loaded_with_empty_pyproject_but_ok_cz( - empty_pyproject_ok_cz, configure_supported_files -): - cfg = config.read_cfg() - assert cfg == _config - + def test_init_with_invalid_config_content(self, tmp_path, config_file): + existing_content = "invalid json content" + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) -def test_conf_returns_default_when_no_files(configure_supported_files): - cfg = config.read_cfg() - assert cfg == defaults.settings + with pytest.raises(InvalidConfigurationError) as excinfo: + JsonConfig(data=existing_content, path=path) + assert config_file in str(excinfo.value) @pytest.mark.parametrize( - "config_files_manager", defaults.config_files.copy(), indirect=True + "config_file", + [ + ".cz.yaml", + "cz.yaml", + ], ) -def test_set_key(configure_supported_files, config_files_manager): - config.read_cfg() - config.set_key("version", "2.0.0") - cfg = config.read_cfg() - assert cfg == _new_config +class TestYamlConfig: + def test_init_empty_config_content(self, tmp_path, config_file): + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) + yaml_config = YAMLConfig(data="{}", path=path) + yaml_config.init_empty_config_content() + + with path.open() as yaml_file: + assert yaml.safe_load(yaml_file) == {"commitizen": {}} + + def test_init_with_invalid_content(self, tmp_path, config_file): + existing_content = "invalid: .cz.yaml: content: maybe?" + path = tmp_path / "commitizen" / config_file + path.parent.mkdir(parents=True, exist_ok=True) + + with pytest.raises(InvalidConfigurationError) as excinfo: + YAMLConfig(data=existing_content, path=path) + assert config_file in str(excinfo.value) diff --git a/tests/test_cz_base.py b/tests/test_cz_base.py deleted file mode 100644 index e4b48d50a6..0000000000 --- a/tests/test_cz_base.py +++ /dev/null @@ -1,47 +0,0 @@ -import pytest - -from commitizen import defaults -from commitizen.cz.base import BaseCommitizen - -config = {"name": defaults.name} - - -class DummyCz(BaseCommitizen): - def questions(self): - return [{"type": "input", "name": "commit", "message": "Initial commit:\n"}] - - def message(self, answers): - return answers["commit"] - - -def test_base_raises_error(): - with pytest.raises(TypeError): - BaseCommitizen(config) - - -def test_questions(): - cz = DummyCz(config) - assert isinstance(cz.questions(), list) - - -def test_message(): - cz = DummyCz(config) - assert cz.message({"commit": "holis"}) == "holis" - - -def test_example(): - cz = DummyCz(config) - with pytest.raises(NotImplementedError): - cz.example() - - -def test_schema(): - cz = DummyCz(config) - with pytest.raises(NotImplementedError): - cz.schema() - - -def test_info(): - cz = DummyCz(config) - with pytest.raises(NotImplementedError): - cz.info() diff --git a/tests/test_cz_conventional_commits.py b/tests/test_cz_conventional_commits.py index 0f6be2d624..fc78b3fd49 100644 --- a/tests/test_cz_conventional_commits.py +++ b/tests/test_cz_conventional_commits.py @@ -1,62 +1,62 @@ import pytest -from commitizen import defaults from commitizen.cz.conventional_commits.conventional_commits import ( ConventionalCommitsCz, - NoSubjectException, - parse_scope, - parse_subject, + _parse_scope, + _parse_subject, ) +from commitizen.cz.exceptions import AnswerRequiredError -config = {"name": defaults.name} -valid_scopes = ["", "simple", "dash-separated", "camelCase" "UPPERCASE"] - -scopes_transformations = [["with spaces", "with-spaces"], [None, ""]] - -valid_subjects = ["this is a normal text", "aword"] - -subjects_transformations = [["with dot.", "with dot"]] - -invalid_subjects = ["", " ", ".", " .", "", None] - - -def test_parse_scope_valid_values(): - for valid_scope in valid_scopes: - assert valid_scope == parse_scope(valid_scope) +@pytest.mark.parametrize( + "valid_scope", ["", "simple", "dash-separated", "camelCaseUPPERCASE"] +) +def test_parse_scope_valid_values(valid_scope): + assert valid_scope == _parse_scope(valid_scope) -def test_scopes_transformations(): - for scopes_transformation in scopes_transformations: - invalid_scope, transformed_scope = scopes_transformation - assert transformed_scope == parse_scope(invalid_scope) +@pytest.mark.parametrize( + "scopes_transformation", [["with spaces", "with-spaces"], ["", ""]] +) +def test_scopes_transformations(scopes_transformation): + invalid_scope, transformed_scope = scopes_transformation + assert transformed_scope == _parse_scope(invalid_scope) -def test_parse_subject_valid_values(): - for valid_subject in valid_subjects: - assert valid_subject == parse_subject(valid_subject) +@pytest.mark.parametrize("valid_subject", ["this is a normal text", "aword"]) +def test_parse_subject_valid_values(valid_subject): + assert valid_subject == _parse_subject(valid_subject) -def test_parse_subject_invalid_values(): - for valid_subject in invalid_subjects: - with pytest.raises(NoSubjectException): - parse_subject(valid_subject) +@pytest.mark.parametrize("invalid_subject", ["", " ", ".", " .", "\t\t."]) +def test_parse_subject_invalid_values(invalid_subject): + with pytest.raises(AnswerRequiredError): + _parse_subject(invalid_subject) -def test_subject_transformations(): - for subject_transformation in subjects_transformations: - invalid_subject, transformed_subject = subject_transformation - assert transformed_subject == parse_subject(invalid_subject) +@pytest.mark.parametrize("subject_transformation", [["with dot.", "with dot"]]) +def test_subject_transformations(subject_transformation): + invalid_subject, transformed_subject = subject_transformation + assert transformed_subject == _parse_subject(invalid_subject) -def test_questions(): +def test_questions(config): conventional_commits = ConventionalCommitsCz(config) questions = conventional_commits.questions() assert isinstance(questions, list) assert isinstance(questions[0], dict) -def test_small_answer(): +def test_choices_all_have_keyboard_shortcuts(config): + conventional_commits = ConventionalCommitsCz(config) + questions = conventional_commits.questions() + + list_questions = (q for q in questions if q["type"] == "list") + for select in list_questions: + assert all("key" in choice for choice in select["choices"]) + + +def test_small_answer(config): conventional_commits = ConventionalCommitsCz(config) answers = { "prefix": "fix", @@ -70,38 +70,105 @@ def test_small_answer(): assert message == "fix(users): email pattern corrected" -def test_long_answer(): +def test_long_answer(config): conventional_commits = ConventionalCommitsCz(config) answers = { "prefix": "fix", "scope": "users", "subject": "email pattern corrected", - "is_breaking_change": True, + "is_breaking_change": False, "body": "complete content", "footer": "closes #24", } message = conventional_commits.message(answers) assert ( message - == "fix(users): email pattern corrected\n\nBREAKING CHANGE: complete content\n\ncloses #24" # noqa + == "fix(users): email pattern corrected\n\ncomplete content\n\ncloses #24" + ) + + +def test_breaking_change_in_footer(config): + conventional_commits = ConventionalCommitsCz(config) + answers = { + "prefix": "fix", + "scope": "users", + "subject": "email pattern corrected", + "is_breaking_change": True, + "body": "complete content", + "footer": "migrate by renaming user to users", + } + message = conventional_commits.message(answers) + print(message) + assert ( + message + == "fix(users): email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users" + ) + + +@pytest.mark.parametrize( + ("scope", "breaking_change_exclamation_in_title", "expected_message"), + [ + # Test with scope and breaking_change_exclamation_in_title enabled + ( + "users", + True, + "feat(users)!: email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users", + ), + # Test without scope and breaking_change_exclamation_in_title enabled + ( + "", + True, + "feat!: email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users", + ), + # Test with scope and breaking_change_exclamation_in_title disabled + ( + "users", + False, + "feat(users): email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users", + ), + # Test without scope and breaking_change_exclamation_in_title disabled + ( + "", + False, + "feat: email pattern corrected\n\ncomplete content\n\nBREAKING CHANGE: migrate by renaming user to users", + ), + ], +) +def test_breaking_change_message_formats( + config, scope, breaking_change_exclamation_in_title, expected_message +): + # Set the breaking_change_exclamation_in_title setting + config.settings["breaking_change_exclamation_in_title"] = ( + breaking_change_exclamation_in_title ) + conventional_commits = ConventionalCommitsCz(config) + answers = { + "prefix": "feat", + "scope": scope, + "subject": "email pattern corrected", + "is_breaking_change": True, + "body": "complete content", + "footer": "migrate by renaming user to users", + } + message = conventional_commits.message(answers) + assert message == expected_message -def test_example(): +def test_example(config): """just testing a string is returned. not the content""" conventional_commits = ConventionalCommitsCz(config) example = conventional_commits.example() assert isinstance(example, str) -def test_schema(): +def test_schema(config): """just testing a string is returned. not the content""" conventional_commits = ConventionalCommitsCz(config) schema = conventional_commits.schema() assert isinstance(schema, str) -def test_info(): +def test_info(config): """just testing a string is returned. not the content""" conventional_commits = ConventionalCommitsCz(config) info = conventional_commits.info() diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py new file mode 100644 index 0000000000..311eea19a9 --- /dev/null +++ b/tests/test_cz_customize.py @@ -0,0 +1,611 @@ +from pathlib import Path + +import pytest + +from commitizen.config import BaseConfig +from commitizen.config.json_config import JsonConfig +from commitizen.config.toml_config import TomlConfig +from commitizen.config.yaml_config import YAMLConfig +from commitizen.cz.customize import CustomizeCommitsCz +from commitizen.exceptions import MissingCzCustomizeConfigError + +TOML_STR = r""" + [tool.commitizen.customize] + message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example = "feature: this feature enables customization through a config file" + schema = "<type>: <body>" + schema_pattern = "(feature|bug fix):(\\s.*)" + commit_parser = "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?" + changelog_pattern = "^(feature|bug fix)?(!)?" + change_type_map = {"feature" = "Feat", "bug fix" = "Fix"} + + bump_pattern = "^(break|new|fix|hotfix)" + bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"} + change_type_order = ["perf", "BREAKING CHANGE", "feat", "fix", "refactor"] + info = "This is a customized cz." + + [[tool.commitizen.customize.questions]] + type = "list" + name = "change_type" + choices = [ + {value = "feature", name = "feature: A new feature."}, + {value = "bug fix", name = "bug fix: A bug fix."} + ] + message = "Select the type of change you are committing" + + [[tool.commitizen.customize.questions]] + type = "input" + name = "message" + message = "Body." + + [[tool.commitizen.customize.questions]] + type = "confirm" + name = "show_message" + message = "Do you want to add body message in commit?" +""" + +JSON_STR = r""" + { + "commitizen": { + "name": "cz_jira", + "version": "1.0.0", + "version_files": [ + "commitizen/__version__.py", + "pyproject.toml" + ], + "customize": { + "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}", + "example": "feature: this feature enables customization through a config file", + "schema": "<type>: <body>", + "schema_pattern": "(feature|bug fix):(\\s.*)", + "bump_pattern": "^(break|new|fix|hotfix)", + "bump_map": { + "break": "MAJOR", + "new": "MINOR", + "fix": "PATCH", + "hotfix": "PATCH" + }, + "commit_parser": "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?", + "changelog_pattern": "^(feature|bug fix)?(!)?", + "change_type_map": {"feature": "Feat", "bug fix": "Fix"}, + "change_type_order": ["perf", "BREAKING CHANGE", "feat", "fix", "refactor"], + "info": "This is a customized cz.", + "questions": [ + { + "type": "list", + "name": "change_type", + "choices": [ + { + "value": "feature", + "name": "feature: A new feature." + }, + { + "value": "bug fix", + "name": "bug fix: A bug fix." + } + ], + "message": "Select the type of change you are committing" + }, + { + "type": "input", + "name": "message", + "message": "Body." + }, + { + "type": "confirm", + "name": "show_message", + "message": "Do you want to add body message in commit?" + } + ] + } + } + } +""" + +YAML_STR = """ +commitizen: + name: cz_jira + version: 1.0.0 + version_files: + - commitizen/__version__.py + - pyproject.toml + customize: + message_template: '{{change_type}}:{% if show_message %} {{message}}{% endif %}' + example: 'feature: this feature enables customization through a config file' + schema: '<type>: <body>' + schema_pattern: '(feature|bug fix):(\\s.*)' + bump_pattern: '^(break|new|fix|hotfix)' + commit_parser: '^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?' + changelog_pattern: '^(feature|bug fix)?(!)?' + change_type_map: + feature: Feat + bug fix: Fix + bump_map: + break: MAJOR + new: MINOR + fix: PATCH + hotfix: PATCH + change_type_order: ['perf', 'BREAKING CHANGE', 'feat', 'fix', 'refactor'] + info: This is a customized cz. + questions: + - type: list + name: change_type + choices: + - value: feature + name: 'feature: A new feature.' + - value: bug fix + name: 'bug fix: A bug fix.' + message: Select the type of change you are committing + - type: input + name: message + message: Body. + - type: confirm + name: show_message + message: Do you want to add body message in commit? +""" + +TOML_WITH_UNICODE = r""" + [tool.commitizen] + name = "cz_customize" + version = "1.0.0" + version_files = [ + "commitizen/__version__.py", + "pyproject.toml:version" + ] + [tool.commitizen.customize] + message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example = "✨ feature: this feature enables customization through a config file" + schema = "<type>: <body>" + schema_pattern = "(✨ feature|🐛 bug fix):(\\s.*)" + commit_parser = "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?" + changelog_pattern = "^(✨ feature|🐛 bug fix)?(!)?" + change_type_map = {"✨ feature" = "Feat", "🐛 bug fix" = "Fix"} + bump_pattern = "^(✨ feat|🐛 bug fix)" + bump_map = {"break" = "MAJOR", "✨ feat" = "MINOR", "🐛 bug fix" = "MINOR"} + change_type_order = ["perf", "BREAKING CHANGE", "feat", "fix", "refactor"] + info = "This is a customized cz with emojis 🎉!" + [[tool.commitizen.customize.questions]] + type = "list" + name = "change_type" + choices = [ + {value = "✨ feature", name = "✨ feature: A new feature."}, + {value = "🐛 bug fix", name = "🐛 bug fix: A bug fix."} + ] + message = "Select the type of change you are committing" + [[tool.commitizen.customize.questions]] + type = "input" + name = "message" + message = "Body." + [[tool.commitizen.customize.questions]] + type = "confirm" + name = "show_message" + message = "Do you want to add body message in commit?" +""" + +JSON_WITH_UNICODE = r""" + { + "commitizen": { + "name": "cz_customize", + "version": "1.0.0", + "version_files": [ + "commitizen/__version__.py", + "pyproject.toml:version" + ], + "customize": { + "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}", + "example": "✨ feature: this feature enables customization through a config file", + "schema": "<type>: <body>", + "schema_pattern": "(✨ feature|🐛 bug fix):(\\s.*)", + "bump_pattern": "^(✨ feat|🐛 bug fix)", + "bump_map": { + "break": "MAJOR", + "✨ feat": "MINOR", + "🐛 bug fix": "MINOR" + }, + "commit_parser": "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?", + "changelog_pattern": "^(✨ feature|🐛 bug fix)?(!)?", + "change_type_map": {"✨ feature": "Feat", "🐛 bug fix": "Fix"}, + "change_type_order": ["perf", "BREAKING CHANGE", "feat", "fix", "refactor"], + "info": "This is a customized cz with emojis 🎉!", + "questions": [ + { + "type": "list", + "name": "change_type", + "choices": [ + { + "value": "✨ feature", + "name": "✨ feature: A new feature." + }, + { + "value": "🐛 bug fix", + "name": "🐛 bug fix: A bug fix." + } + ], + "message": "Select the type of change you are committing" + }, + { + "type": "input", + "name": "message", + "message": "Body." + }, + { + "type": "confirm", + "name": "show_message", + "message": "Do you want to add body message in commit?" + } + ] + } + } + } +""" + +TOML_STR_INFO_PATH = """ + [tool.commitizen.customize] + message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example = "feature: this feature enables customization through a config file" + schema = "<type>: <body>" + bump_pattern = "^(break|new|fix|hotfix)" + bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"} + info_path = "info.txt" +""" + +JSON_STR_INFO_PATH = r""" + { + "commitizen": { + "customize": { + "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}", + "example": "feature: this feature enables customization through a config file", + "schema": "<type>: <body>", + "bump_pattern": "^(break|new|fix|hotfix)", + "bump_map": { + "break": "MAJOR", + "new": "MINOR", + "fix": "PATCH", + "hotfix": "PATCH" + }, + "info_path": "info.txt" + } + } + } +""" + +YAML_STR_INFO_PATH = """ +commitizen: + customize: + message_template: "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example: 'feature: this feature enables customization through a config file' + schema: "<type>: <body>" + bump_pattern: "^(break|new|fix|hotfix)" + bump_map: + break: MAJOR + new: MINOR + fix: PATCH + hotfix: PATCH + info_path: info.txt +""" + +TOML_STR_WITHOUT_INFO = """ + [tool.commitizen.customize] + message_template = "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example = "feature: this feature enables customization through a config file" + schema = "<type>: <body>" + bump_pattern = "^(break|new|fix|hotfix)" + bump_map = {"break" = "MAJOR", "new" = "MINOR", "fix" = "PATCH", "hotfix" = "PATCH"} +""" + +JSON_STR_WITHOUT_PATH = r""" + { + "commitizen": { + "customize": { + "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}", + "example": "feature: this feature enables customization through a config file", + "schema": "<type>: <body>", + "bump_pattern": "^(break|new|fix|hotfix)", + "bump_map": { + "break": "MAJOR", + "new": "MINOR", + "fix": "PATCH", + "hotfix": "PATCH" + } + } + } + } +""" + +YAML_STR_WITHOUT_PATH = """ +commitizen: + customize: + message_template: "{{change_type}}:{% if show_message %} {{message}}{% endif %}" + example: 'feature: this feature enables customization through a config file' + schema: "<type>: <body>" + bump_pattern: "^(break|new|fix|hotfix)" + bump_map: + break: MAJOR + new: MINOR + fix: PATCH + hotfix: PATCH +""" + + +@pytest.fixture( + params=[ + TomlConfig(data=TOML_STR, path=Path("not_exist.toml")), + JsonConfig(data=JSON_STR, path=Path("not_exist.json")), + YAMLConfig(data=YAML_STR, path=Path("not_exist.yaml")), + ] +) +def config(request): + """Parametrize the config fixture + + This fixture allow to test multiple config formats, + without add the builtin parametrize decorator + """ + return request.param + + +@pytest.fixture( + params=[ + TomlConfig(data=TOML_STR_INFO_PATH, path=Path("not_exist.toml")), + JsonConfig(data=JSON_STR_INFO_PATH, path=Path("not_exist.json")), + YAMLConfig(data=YAML_STR_INFO_PATH, path=Path("not_exist.yaml")), + ] +) +def config_info(request): + return request.param + + +@pytest.fixture( + params=[ + TomlConfig(data=TOML_STR_WITHOUT_INFO, path=Path("not_exist.toml")), + JsonConfig(data=JSON_STR_WITHOUT_PATH, path=Path("not_exist.json")), + YAMLConfig(data=YAML_STR_WITHOUT_PATH, path=Path("not_exist.yaml")), + ] +) +def config_without_info(request): + return request.param + + +@pytest.fixture( + params=[ + TomlConfig(data=TOML_WITH_UNICODE, path=Path("not_exist.toml")), + JsonConfig(data=JSON_WITH_UNICODE, path=Path("not_exist.json")), + ] +) +def config_with_unicode(request): + return request.param + + +def test_initialize_cz_customize_failed(): + config = BaseConfig() + with pytest.raises(MissingCzCustomizeConfigError) as excinfo: + CustomizeCommitsCz(config) + + assert MissingCzCustomizeConfigError.message in str(excinfo.value) + + +def test_bump_pattern(config): + cz = CustomizeCommitsCz(config) + assert cz.bump_pattern == "^(break|new|fix|hotfix)" + + +def test_bump_pattern_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert cz.bump_pattern == "^(✨ feat|🐛 bug fix)" + + +def test_bump_map(config): + cz = CustomizeCommitsCz(config) + assert cz.bump_map == { + "break": "MAJOR", + "new": "MINOR", + "fix": "PATCH", + "hotfix": "PATCH", + } + + +def test_bump_map_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert cz.bump_map == { + "break": "MAJOR", + "✨ feat": "MINOR", + "🐛 bug fix": "MINOR", + } + + +def test_change_type_order(config): + cz = CustomizeCommitsCz(config) + assert cz.change_type_order == [ + "perf", + "BREAKING CHANGE", + "feat", + "fix", + "refactor", + ] + + +def test_change_type_order_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert cz.change_type_order == [ + "perf", + "BREAKING CHANGE", + "feat", + "fix", + "refactor", + ] + + +def test_questions(config): + cz = CustomizeCommitsCz(config) + questions = cz.questions() + expected_questions = [ + { + "type": "list", + "name": "change_type", + "choices": [ + {"value": "feature", "name": "feature: A new feature."}, + {"value": "bug fix", "name": "bug fix: A bug fix."}, + ], + "message": "Select the type of change you are committing", + }, + {"type": "input", "name": "message", "message": "Body."}, + { + "type": "confirm", + "name": "show_message", + "message": "Do you want to add body message in commit?", + }, + ] + assert list(questions) == expected_questions + + +def test_questions_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + questions = cz.questions() + expected_questions = [ + { + "type": "list", + "name": "change_type", + "choices": [ + {"value": "✨ feature", "name": "✨ feature: A new feature."}, + {"value": "🐛 bug fix", "name": "🐛 bug fix: A bug fix."}, + ], + "message": "Select the type of change you are committing", + }, + {"type": "input", "name": "message", "message": "Body."}, + { + "type": "confirm", + "name": "show_message", + "message": "Do you want to add body message in commit?", + }, + ] + assert list(questions) == expected_questions + + +def test_answer(config): + cz = CustomizeCommitsCz(config) + answers = { + "change_type": "feature", + "message": "this feature enable customize through config file", + "show_message": True, + } + message = cz.message(answers) + assert message == "feature: this feature enable customize through config file" + + cz = CustomizeCommitsCz(config) + answers = { + "change_type": "feature", + "message": "this feature enable customize through config file", + "show_message": False, + } + message = cz.message(answers) + assert message == "feature:" + + +def test_answer_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + answers = { + "change_type": "✨ feature", + "message": "this feature enables customization through a config file", + "show_message": True, + } + message = cz.message(answers) + assert ( + message + == "✨ feature: this feature enables customization through a config file" + ) + + cz = CustomizeCommitsCz(config_with_unicode) + answers = { + "change_type": "✨ feature", + "message": "this feature enables customization through a config file", + "show_message": False, + } + message = cz.message(answers) + assert message == "✨ feature:" + + +def test_example(config): + cz = CustomizeCommitsCz(config) + assert ( + "feature: this feature enables customization through a config file" + in cz.example() + ) + + +def test_example_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert ( + "✨ feature: this feature enables customization through a config file" + in cz.example() + ) + + +def test_schema(config): + cz = CustomizeCommitsCz(config) + assert "<type>: <body>" in cz.schema() + + +def test_schema_pattern(config): + cz = CustomizeCommitsCz(config) + assert r"(feature|bug fix):(\s.*)" in cz.schema_pattern() + + +def test_schema_pattern_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert r"(✨ feature|🐛 bug fix):(\s.*)" in cz.schema_pattern() + + +def test_info(config): + cz = CustomizeCommitsCz(config) + assert "This is a customized cz." in cz.info() + + +def test_info_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert "This is a customized cz with emojis 🎉!" in cz.info() + + +def test_info_with_info_path(tmp_path, monkeypatch, config_info): + monkeypatch.chdir(tmp_path) + tmpfile = tmp_path / "info.txt" + tmpfile.write_text("Test info") + + cz = CustomizeCommitsCz(config_info) + assert "Test info" in cz.info() + + +def test_info_without_info(config_without_info): + cz = CustomizeCommitsCz(config_without_info) + assert cz.info() == "" + + +def test_commit_parser(config): + cz = CustomizeCommitsCz(config) + assert cz.commit_parser == "^(?P<change_type>feature|bug fix):\\s(?P<message>.*)?" + + +def test_commit_parser_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert ( + cz.commit_parser + == "^(?P<change_type>✨ feature|🐛 bug fix):\\s(?P<message>.*)?" + ) + + +def test_changelog_pattern(config): + cz = CustomizeCommitsCz(config) + assert cz.changelog_pattern == "^(feature|bug fix)?(!)?" + + +def test_changelog_pattern_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert cz.changelog_pattern == "^(✨ feature|🐛 bug fix)?(!)?" + + +def test_change_type_map(config): + cz = CustomizeCommitsCz(config) + assert cz.change_type_map == {"feature": "Feat", "bug fix": "Fix"} + + +def test_change_type_map_unicode(config_with_unicode): + cz = CustomizeCommitsCz(config_with_unicode) + assert cz.change_type_map == {"✨ feature": "Feat", "🐛 bug fix": "Fix"} diff --git a/tests/test_cz_jira.py b/tests/test_cz_jira.py index 1092df56cc..03055c14b1 100644 --- a/tests/test_cz_jira.py +++ b/tests/test_cz_jira.py @@ -1,17 +1,14 @@ -from commitizen import defaults from commitizen.cz.jira import JiraSmartCz -config = {"name": defaults.name} - -def test_questions(): +def test_questions(config): cz = JiraSmartCz(config) questions = cz.questions() assert isinstance(questions, list) assert isinstance(questions[0], dict) -def test_answer(): +def test_answer(config): cz = JiraSmartCz(config) answers = { "message": "new test", @@ -24,17 +21,17 @@ def test_answer(): assert message == "new test JRA-34" -def test_example(): +def test_example(config): cz = JiraSmartCz(config) assert "JRA-34 #comment corrected indent issue\n" in cz.example() -def test_schema(): +def test_schema(config): cz = JiraSmartCz(config) assert "<ignored text>" in cz.schema() -def test_info(): +def test_info(config): cz = JiraSmartCz(config) assert ( "Smart Commits allow repository committers to perform " diff --git a/tests/test_cz_search_filter.py b/tests/test_cz_search_filter.py new file mode 100644 index 0000000000..cbceb8b887 --- /dev/null +++ b/tests/test_cz_search_filter.py @@ -0,0 +1,76 @@ +import pytest + +from commitizen.config.toml_config import TomlConfig +from commitizen.cz.customize import CustomizeCommitsCz + +TOML_WITH_SEARCH_FILTER = r""" +[tool.commitizen] +name = "cz_customize" + +[tool.commitizen.customize] +message_template = "{{change_type}}:{% if scope %} ({{scope}}){% endif %}{% if breaking %}!{% endif %} {{message}}" + +[[tool.commitizen.customize.questions]] +type = "select" +name = "change_type" +message = "Select the type of change you are committing" +use_search_filter = true +use_jk_keys = false +choices = [ + {value = "fix", name = "fix: A bug fix. Correlates with PATCH in SemVer"}, + {value = "feat", name = "feat: A new feature. Correlates with MINOR in SemVer"}, + {value = "docs", name = "docs: Documentation only changes"}, + {value = "style", name = "style: Changes that do not affect the meaning of the code"}, + {value = "refactor", name = "refactor: A code change that neither fixes a bug nor adds a feature"}, + {value = "perf", name = "perf: A code change that improves performance"}, + {value = "test", name = "test: Adding missing or correcting existing tests"}, + {value = "build", name = "build: Changes that affect the build system or external dependencies"}, + {value = "ci", name = "ci: Changes to CI configuration files and scripts"} +] + +[[tool.commitizen.customize.questions]] +type = "input" +name = "scope" +message = "What is the scope of this change? (class or file name): (press [enter] to skip)" + +[[tool.commitizen.customize.questions]] +type = "input" +name = "message" +message = "Write a short and imperative summary of the code changes: (lower case and no period)" +""" + + +@pytest.fixture +def config(): + return TomlConfig(data=TOML_WITH_SEARCH_FILTER, path="not_exist.toml") + + +def test_questions_with_search_filter(config): + """Test that questions are properly configured with search filter""" + cz = CustomizeCommitsCz(config) + questions = cz.questions() + + # Test that the first question (change_type) has search filter enabled + assert questions[0]["type"] == "select" + assert questions[0]["name"] == "change_type" + assert questions[0]["use_search_filter"] is True + assert questions[0]["use_jk_keys"] is False + + # Test that the choices are properly configured + choices = questions[0]["choices"] + assert len(choices) == 9 # We have 9 commit types + assert choices[0]["value"] == "fix" + assert choices[1]["value"] == "feat" + + +def test_message_template(config): + """Test that the message template is properly configured""" + cz = CustomizeCommitsCz(config) + template = cz.message( + { + "change_type": "feat", + "scope": "search", + "message": "add search filter support", + } + ) + assert template == "feat: (search) add search filter support" diff --git a/tests/test_cz_utils.py b/tests/test_cz_utils.py new file mode 100644 index 0000000000..25c960c9a7 --- /dev/null +++ b/tests/test_cz_utils.py @@ -0,0 +1,26 @@ +import pytest +from pytest_mock import MockFixture + +from commitizen.cz import exceptions, utils + + +def test_required_validator(): + assert utils.required_validator("test") == "test" + + with pytest.raises(exceptions.AnswerRequiredError): + utils.required_validator("") + + +def test_multiple_line_breaker(): + message = "this is the first line | and this is the second line " + result = utils.multiple_line_breaker(message) + assert result == "this is the first line\nand this is the second line" + + result = utils.multiple_line_breaker(message, "is") + assert result == "th\n\nthe first line | and th\n\nthe second line" + + +def test_get_backup_file_path_no_project_root(mocker: MockFixture): + project_root_mock = mocker.patch("commitizen.git.find_git_project_root") + project_root_mock.return_value = None + assert utils.get_backup_file_path() diff --git a/tests/test_deprecated.py b/tests/test_deprecated.py new file mode 100644 index 0000000000..ebaae82c37 --- /dev/null +++ b/tests/test_deprecated.py @@ -0,0 +1,35 @@ +import pytest + +from commitizen import changelog_formats, defaults + + +@pytest.mark.parametrize( + ("deprecated_var_getter", "replacement"), + [ + (lambda: defaults.bump_pattern, defaults.BUMP_PATTERN), + (lambda: defaults.bump_map, defaults.BUMP_MAP), + ( + lambda: defaults.bump_map_major_version_zero, + defaults.BUMP_MAP_MAJOR_VERSION_ZERO, + ), + (lambda: defaults.bump_message, defaults.BUMP_MESSAGE), + (lambda: defaults.change_type_order, defaults.CHANGE_TYPE_ORDER), + (lambda: defaults.encoding, defaults.ENCODING), + (lambda: defaults.name, defaults.DEFAULT_SETTINGS["name"]), + ( + lambda: changelog_formats.guess_changelog_format, + changelog_formats._guess_changelog_format, + ), + ], +) +def test_getattr_deprecated_vars(deprecated_var_getter, replacement): + # Test each deprecated variable + with pytest.warns(DeprecationWarning, match="is deprecated and will be removed"): + val = deprecated_var_getter() + assert val == replacement + + +def test_getattr_non_existent(): + # Test non-existent attribute + with pytest.raises(AttributeError, match="is not an attribute of"): + _ = defaults.non_existent_attribute diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py new file mode 100644 index 0000000000..f9ff733c95 --- /dev/null +++ b/tests/test_exceptions.py @@ -0,0 +1,38 @@ +import pytest + +from commitizen.exceptions import ExitCode + + +def test_from_str_with_decimal(): + """Test from_str with decimal values.""" + assert ExitCode.from_str("0") == ExitCode.EXPECTED_EXIT + assert ExitCode.from_str("1") == ExitCode.NO_COMMITIZEN_FOUND + assert ExitCode.from_str("32") == ExitCode.COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED + + +def test_from_str_with_enum_name(): + """Test from_str with enum names.""" + assert ExitCode.from_str("EXPECTED_EXIT") == ExitCode.EXPECTED_EXIT + assert ExitCode.from_str("NO_COMMITIZEN_FOUND") == ExitCode.NO_COMMITIZEN_FOUND + assert ( + ExitCode.from_str("COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED") + == ExitCode.COMMIT_MESSAGE_LENGTH_LIMIT_EXCEEDED + ) + + +def test_from_str_with_whitespace(): + """Test from_str with whitespace in enum names.""" + assert ExitCode.from_str(" EXPECTED_EXIT ") == ExitCode.EXPECTED_EXIT + assert ExitCode.from_str("\tNO_COMMITIZEN_FOUND\t") == ExitCode.NO_COMMITIZEN_FOUND + + +def test_from_str_with_invalid_values(): + """Test from_str with invalid values.""" + with pytest.raises(KeyError): + ExitCode.from_str("invalid_name") + with pytest.raises(ValueError, match="is not a valid ExitCode"): + ExitCode.from_str("999") # Out of range decimal + with pytest.raises(KeyError): + ExitCode.from_str("") + with pytest.raises(KeyError): + ExitCode.from_str(" ") diff --git a/tests/test_factory.py b/tests/test_factory.py index 2ec7b19364..303ae4e728 100644 --- a/tests/test_factory.py +++ b/tests/test_factory.py @@ -1,15 +1,92 @@ +import sys +from importlib import metadata +from textwrap import dedent + import pytest from commitizen import BaseCommitizen, defaults, factory +from commitizen.config import BaseConfig +from commitizen.cz import discover_plugins +from commitizen.cz.conventional_commits import ConventionalCommitsCz +from commitizen.cz.customize import CustomizeCommitsCz +from commitizen.cz.jira import JiraSmartCz +from commitizen.exceptions import NoCommitizenFoundException + + +class Plugin: + pass + + +class OtherPlugin: + pass def test_factory(): - config = {"name": defaults.name} - r = factory.commiter_factory(config) + config = BaseConfig() + config.settings.update({"name": defaults.DEFAULT_SETTINGS["name"]}) + r = factory.committer_factory(config) assert isinstance(r, BaseCommitizen) def test_factory_fails(): - config = {"name": "nothing"} - with pytest.raises(SystemExit): - factory.commiter_factory(config) + config = BaseConfig() + config.settings.update({"name": "Nothing"}) + with pytest.raises(NoCommitizenFoundException) as excinfo: + factory.committer_factory(config) + + assert "The committer has not been found in the system." in str(excinfo) + + +def test_discover_plugins(tmp_path): + legacy_plugin_folder = tmp_path / "cz_legacy" + legacy_plugin_folder.mkdir() + init_file = legacy_plugin_folder / "__init__.py" + init_file.write_text( + dedent( + """\ + class Plugin: pass + + discover_this = Plugin + """ + ) + ) + + sys.path.append(tmp_path.as_posix()) + with pytest.warns( + UserWarning, + match="Legacy plugin 'cz_legacy' has been ignored: please expose it the 'commitizen.plugin' entrypoint", + ): + discovered_plugins = discover_plugins([tmp_path.as_posix()]) + sys.path.pop() + + assert "cz_legacy" not in discovered_plugins + + +def test_discover_external_plugin(mocker): + ep_plugin = metadata.EntryPoint( + "test", "tests.test_factory:Plugin", "commitizen.plugin" + ) + ep_other_plugin = metadata.EntryPoint( + "not-selected", "tests.test_factory::OtherPlugin", "commitizen.not_a_plugin" + ) + eps = [ep_plugin, ep_other_plugin] + + def mock_entrypoints(**kwargs): + group = kwargs.get("group") + return metadata.EntryPoints(ep for ep in eps if ep.group == group) + + mocker.patch.object(metadata, "entry_points", side_effect=mock_entrypoints) + + assert discover_plugins() == {"test": Plugin} + + +def test_discover_internal_plugins(): + expected = { + "cz_conventional_commits": ConventionalCommitsCz, + "cz_jira": JiraSmartCz, + "cz_customize": CustomizeCommitsCz, + } + + discovered = discover_plugins() + + assert set(expected.items()).issubset(set(discovered.items())) diff --git a/tests/test_git.py b/tests/test_git.py new file mode 100644 index 0000000000..59098528a4 --- /dev/null +++ b/tests/test_git.py @@ -0,0 +1,512 @@ +from __future__ import annotations + +import inspect +import os +import platform +from typing import TYPE_CHECKING + +import pytest + +from commitizen import cmd, git +from commitizen.exceptions import GitCommandError + +if TYPE_CHECKING: + from pytest_gitconfig import GitConfig + from pytest_mock import MockFixture + + from tests.utils import UtilFixture + + +@pytest.mark.parametrize("date", ["2020-01-21", "1970-01-01"]) +def test_git_tag_date(date: str): + git_tag = git.GitTag(rev="sha1-code", name="0.0.1", date="2025-05-30") + git_tag.date = date + assert git_tag.date == date + + +def test_git_object_eq(): + git_commit = git.GitCommit( + rev="sha1-code", title="this is title", body="this is body" + ) + git_tag = git.GitTag(rev="sha1-code", name="0.0.1", date="2020-01-21") + + assert git_commit == git_tag + assert git_commit != "sha1-code" + + +def test_get_tags(util: UtilFixture): + tag_str = ( + "v1.0.0---inner_delimiter---333---inner_delimiter---2020-01-20---inner_delimiter---\n" + "v0.5.0---inner_delimiter---222---inner_delimiter---2020-01-17---inner_delimiter---\n" + "v0.0.1---inner_delimiter---111---inner_delimiter---2020-01-17---inner_delimiter---\n" + ) + util.mock_cmd(out=tag_str) + + git_tags = git.get_tags() + latest_git_tag = git_tags[0] + assert latest_git_tag.rev == "333" + assert latest_git_tag.name == "v1.0.0" + assert latest_git_tag.date == "2020-01-20" + + util.mock_cmd(out="", err="No tag available") + assert git.get_tags() == [] + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_reachable_tags(util: UtilFixture): + util.create_file_and_commit("Initial state") + util.create_tag("1.0.0") + # create develop + util.create_branch("develop") + util.switch_branch("develop") + + # add a feature to develop + util.create_file_and_commit("develop") + util.create_tag("1.1.0b0") + + # create staging + util.switch_branch("master") + util.create_file_and_commit("master") + util.create_tag("1.0.1") + + tags = git.get_tags(reachable_only=True) + tag_names = set([t.name for t in tags]) + # 1.1.0b0 is not present + assert tag_names == {"1.0.0", "1.0.1"} + + +@pytest.mark.usefixtures("tmp_commitizen_project") +@pytest.mark.parametrize("locale", ["en_US", "fr_FR"]) +def test_get_reachable_tags_with_commits(locale: str, monkeypatch: pytest.MonkeyPatch): + monkeypatch.setenv("LANG", f"{locale}.UTF-8") + monkeypatch.setenv("LANGUAGE", f"{locale}.UTF-8") + monkeypatch.setenv("LC_ALL", f"{locale}.UTF-8") + assert git.get_tags(reachable_only=True) == [] + + +def test_get_tag_names(util: UtilFixture): + tag_str = "v1.0.0\nv0.5.0\nv0.0.1\n" + util.mock_cmd(out=tag_str) + + assert git.get_tag_names() == ["v1.0.0", "v0.5.0", "v0.0.1"] + + util.mock_cmd(out="", err="No tag available") + assert git.get_tag_names() == [] + + +def test_git_message_with_empty_body(): + commit_title = "Some Title" + commit = git.GitCommit("test_rev", "Some Title", body="") + + assert commit.message == commit_title + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_log_as_str_list_empty(): + """ + Ensure an exception is raised or empty list in an empty project. + The behavior is different depending on the version of git. + """ + try: + gitlog = git._get_log_as_str_list(start=None, end="HEAD", args="") + except GitCommandError: + return + assert len(gitlog) == 0, "list should be empty if no assert" + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_commits(util: UtilFixture): + util.create_file_and_commit("feat(users): add username") + util.create_file_and_commit("fix: username exception") + commits = git.get_commits() + assert len(commits) == 2 + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_commits_author_and_email(util: UtilFixture): + util.create_file_and_commit("fix: username exception") + commit = git.get_commits()[0] + + assert commit.author != "" + assert "@" in commit.author_email + + +def test_get_commits_without_email(util: UtilFixture): + raw_commit = ( + "a515bb8f71c403f6f7d1c17b9d8ebf2ce3959395\n" + "95bbfc703eb99cb49ba0d6ffd8469911303dbe63 12d3b4bdaa996ea7067a07660bb5df4772297bdd\n" + "\n" + "user name\n" + "\n" + "----------commit-delimiter----------\n" + "12d3b4bdaa996ea7067a07660bb5df4772297bdd\n" + "de33bc5070de19600f2f00262b3c15efea762408\n" + "feat(users): add username\n" + "user name\n" + "\n" + "----------commit-delimiter----------\n" + ) + util.mock_cmd(out=raw_commit) + + commits = git.get_commits() + + assert commits[0].author == "user name" + assert commits[1].author == "user name" + + assert commits[0].author_email == "" + assert commits[1].author_email == "" + + assert commits[0].title == "" + assert commits[1].title == "feat(users): add username" + + +def test_get_commits_without_breakline_in_each_commit(util: UtilFixture): + raw_commit = ( + "ae9ba6fc5526cf478f52ef901418d85505109744\n" + "ff2f56ca844de72a9d59590831087bf5a97bac84\n" + "bump: version 2.13.0 → 2.14.0\n" + "GitHub Action\n" + "action@github.com\n" + "----------commit-delimiter----------\n" + "ff2f56ca844de72a9d59590831087bf5a97bac84\n" + "b4dc83284dc8c9729032a774a037df1d1f2397d5 20a54bf1b82cd7b573351db4d1e8814dd0be205d\n" + "Merge pull request #332 from cliles/feature/271-redux\n" + "User\n" + "user@email.com\n" + "Feature/271 redux----------commit-delimiter----------\n" + "20a54bf1b82cd7b573351db4d1e8814dd0be205d\n" + "658f38c3fe832cdab63ed4fb1f7b3a0969a583be\n" + "feat(#271): enable creation of annotated tags when bumping\n" + "User 2\n" + "user@email.edu\n" + "----------commit-delimiter----------\n" + ) + util.mock_cmd(out=raw_commit) + + commits = git.get_commits() + + assert commits[0].author == "GitHub Action" + assert commits[1].author == "User" + assert commits[2].author == "User 2" + + assert commits[0].author_email == "action@github.com" + assert commits[1].author_email == "user@email.com" + assert commits[2].author_email == "user@email.edu" + + assert commits[0].title == "bump: version 2.13.0 → 2.14.0" + assert commits[1].title == "Merge pull request #332 from cliles/feature/271-redux" + assert ( + commits[2].title == "feat(#271): enable creation of annotated tags when bumping" + ) + + +def test_get_commits_with_and_without_parents(util: UtilFixture): + raw_commit = ( + "4206e661bacf9643373255965f34bbdb382cb2b9\n" + "ae9ba6fc5526cf478f52ef901418d85505109744 bf8479e7aa1a5b9d2f491b79e3a4d4015519903e\n" + "Merge pull request from someone\n" + "Maintainer\n" + "maintainer@email.com\n" + "This is a much needed feature----------commit-delimiter----------\n" + "ae9ba6fc5526cf478f52ef901418d85505109744\n" + "ff2f56ca844de72a9d59590831087bf5a97bac84\n" + "Release 0.1.0\n" + "GitHub Action\n" + "action@github.com\n" + "----------commit-delimiter----------\n" + "ff2f56ca844de72a9d59590831087bf5a97bac84\n" + "\n" + "Initial commit\n" + "User\n" + "user@email.com\n" + "----------commit-delimiter----------\n" + ) + util.mock_cmd(out=raw_commit) + + commits = git.get_commits() + + assert commits[0].author == "Maintainer" + assert commits[1].author == "GitHub Action" + assert commits[2].author == "User" + + assert commits[0].author_email == "maintainer@email.com" + assert commits[1].author_email == "action@github.com" + assert commits[2].author_email == "user@email.com" + + assert commits[0].title == "Merge pull request from someone" + assert commits[1].title == "Release 0.1.0" + assert commits[2].title == "Initial commit" + + assert commits[0].body == "This is a much needed feature" + assert commits[1].body == "" + assert commits[2].body == "" + + assert commits[0].parents == [ + "ae9ba6fc5526cf478f52ef901418d85505109744", + "bf8479e7aa1a5b9d2f491b79e3a4d4015519903e", + ] + assert commits[1].parents == ["ff2f56ca844de72a9d59590831087bf5a97bac84"] + assert commits[2].parents == [] + + +@pytest.mark.usefixtures("in_repo_root") +def test_get_commits_with_signature(gitconfig: GitConfig): + # temporarily turn on --show-signature + gitconfig.set("log.showsignature", "true") + + # retrieve a commit that we know has a signature + commit = git.get_commits( + start="bec20ebf433f2281c70f1eb4b0b6a1d0ed83e9b2", + end="9eae518235d051f145807ddf971ceb79ad49953a", + )[0] + + assert commit.title.startswith("fix") + + +def test_get_tag_names_has_correct_arrow_annotation(): + arrow_annotation = inspect.getfullargspec(git.get_tag_names).annotations["return"] + + assert arrow_annotation == "list[str]" + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_latest_tag_name(util: UtilFixture): + tag_name = git.get_latest_tag_name() + assert tag_name is None + + util.create_file_and_commit("feat(test): test") + util.create_tag("1.0") + tag_name = git.get_latest_tag_name() + assert tag_name == "1.0" + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_is_staging_clean_when_adding_file(): + assert git.is_staging_clean() is True + + cmd.run("touch test_file") + + assert git.is_staging_clean() is True + + cmd.run("git add test_file") + + assert git.is_staging_clean() is False + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_is_staging_clean_when_updating_file(): + assert git.is_staging_clean() is True + + cmd.run("touch test_file") + cmd.run("git add test_file") + if os.name == "nt": + cmd.run('git commit -m "add test_file"') + else: + cmd.run("git commit -m 'add test_file'") + cmd.run("echo 'test' > test_file") + + assert git.is_staging_clean() is True + + cmd.run("git add test_file") + + assert git.is_staging_clean() is False + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_eol_for_open(): + assert git.EOLType.for_open() == os.linesep + + cmd.run("git config core.eol lf") + assert git.EOLType.for_open() == "\n" + + cmd.run("git config core.eol crlf") + assert git.EOLType.for_open() == "\r\n" + + cmd.run("git config core.eol native") + assert git.EOLType.for_open() == os.linesep + + +def test_get_core_editor(monkeypatch: pytest.MonkeyPatch, util: UtilFixture): + monkeypatch.setenv("GIT_EDITOR", "nano") + assert git.get_core_editor() == "nano" + + monkeypatch.delenv("GIT_EDITOR") + + util.mock_cmd(out="vim") + assert git.get_core_editor() == "vim" + + util.mock_cmd() + assert git.get_core_editor() is None + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_create_tag_with_message(util: UtilFixture): + util.create_file_and_commit("feat(test): test") + tag_name = "1.0" + tag_message = "test message" + util.create_tag(tag_name, tag_message) + assert git.get_latest_tag_name() == tag_name + assert git.get_tag_message(tag_name) == ( + tag_message if platform.system() != "Windows" else f"'{tag_message}'" + ) + + +@pytest.mark.parametrize( + ("file_path", "expected_cmd"), + [ + ( + "/tmp/temp file", + 'git commit --signoff -F "/tmp/temp file"', + ), + ( + "/tmp dir/temp file", + 'git commit --signoff -F "/tmp dir/temp file"', + ), + ( + "/tmp/tempfile", + 'git commit --signoff -F "/tmp/tempfile"', + ), + ], + ids=[ + "File contains spaces", + "Path contains spaces", + "Path does not contain spaces", + ], +) +def test_commit_with_spaces_in_path( + mocker: MockFixture, file_path: str, expected_cmd: str, util: UtilFixture +): + mock_run = util.mock_cmd() + mock_unlink = mocker.patch("os.unlink") + mock_temp_file = mocker.patch("commitizen.git.NamedTemporaryFile") + mock_temp_file.return_value.name = file_path + + git.commit("feat: new feature", "--signoff") + + mock_run.assert_called_once_with(expected_cmd) + mock_unlink.assert_called_once_with(file_path) + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_filenames_in_commit(util: UtilFixture): + """Test get_filenames_in_commit returns filenames from the last commit.""" + util.create_file_and_commit("feat: old feature", filename="old_file.txt") + + filename = "test_feature_file.txt" + util.create_file_and_commit("feat: add new feature", filename=filename) + + filenames = git.get_filenames_in_commit() + assert [filename] == filenames + + +@pytest.mark.usefixtures("tmp_commitizen_project") +def test_get_filenames_in_commit_with_git_reference(util: UtilFixture): + """Test get_filenames_in_commit with a specific git reference (commit SHA).""" + first_filename = "first_feature.txt" + util.create_file_and_commit("feat: first feature", filename=first_filename) + first_commit_rev = cmd.run("git rev-parse HEAD").out.strip() + + second_filename = "second_feature.txt" + util.create_file_and_commit("feat: second feature", filename=second_filename) + + # Query the first commit by its SHA + filenames = git.get_filenames_in_commit(git_reference=first_commit_rev) + assert first_filename in filenames + assert second_filename not in filenames + + +def test_get_filenames_in_commit_error(util: UtilFixture): + """Test that GitCommandError is raised when git command fails.""" + util.mock_cmd(err="fatal: bad object HEAD", return_code=1) + with pytest.raises(GitCommandError) as excinfo: + git.get_filenames_in_commit() + assert str(excinfo.value) == "fatal: bad object HEAD" + + +@pytest.mark.parametrize( + "linebreak", ["\n", "\r\n"], ids=["line_feed", "carriage_return"] +) +def test_git_commit_from_rev_and_commit(linebreak): + rev_and_commit = linebreak.join( + [ + "abc123", # rev + "def456 ghi789", # parents + "feat: add new feature", # title + "John Doe", # author + "john@example.com", # author_email + "This is a detailed description", # body + "of the new feature", + "with multiple lines", + ] + ) + + commit = git.GitCommit.from_rev_and_commit(rev_and_commit) + + assert commit.rev == "abc123" + assert commit.title == "feat: add new feature" + assert ( + commit.body + == "This is a detailed description\nof the new feature\nwith multiple lines" + ) + assert commit.author == "John Doe" + assert commit.author_email == "john@example.com" + assert commit.parents == ["def456", "ghi789"] + + # Test with minimal data + minimal_commit = linebreak.join( + [ + "abc123", # rev + "", # no parents + "feat: minimal commit", # title + "John Doe", # author + "john@example.com", # author_email + ] + ) + + commit = git.GitCommit.from_rev_and_commit(minimal_commit) + + assert commit.rev == "abc123" + assert commit.title == "feat: minimal commit" + assert commit.body == "" + assert commit.author == "John Doe" + assert commit.author_email == "john@example.com" + assert commit.parents == [] + + +@pytest.mark.parametrize( + ("os_name", "committer_date", "expected_cmd"), + [ + ( + "nt", + "2024-03-20", + 'cmd /v /c "set GIT_COMMITTER_DATE=2024-03-20&& git commit -F "temp.txt""', + ), + ( + "posix", + "2024-03-20", + 'GIT_COMMITTER_DATE=2024-03-20 git commit -F "temp.txt"', + ), + ("nt", None, 'git commit -F "temp.txt"'), + ("posix", None, 'git commit -F "temp.txt"'), + ], +) +def test_create_commit_cmd_string( + mocker: MockFixture, os_name: str, committer_date: str, expected_cmd: str +): + """Test the OS-specific behavior of _create_commit_cmd_string""" + mocker.patch("os.name", os_name) + result = git._create_commit_cmd_string("", committer_date, "temp.txt") + assert result == expected_cmd + + +def test_get_default_branch_success(util: UtilFixture): + util.mock_cmd(out="refs/remotes/origin/main\n") + assert git.get_default_branch() == "refs/remotes/origin/main" + + +def test_get_default_branch_error(util: UtilFixture): + util.mock_cmd( + err="fatal: ref refs/remotes/origin/HEAD is not a symbolic ref", return_code=1 + ) + with pytest.raises(GitCommandError): + git.get_default_branch() diff --git a/tests/test_incremental_build.py b/tests/test_incremental_build.py new file mode 100644 index 0000000000..13f123a651 --- /dev/null +++ b/tests/test_incremental_build.py @@ -0,0 +1,606 @@ +"""Tests for the incremental_build function in commitizen.changelog module.""" + +from commitizen.changelog import Metadata, incremental_build + + +class TestIncrementalBuild: + """Test cases for the incremental_build function.""" + + def test_basic_replacement_of_unreleased_section(self): + """Test basic functionality of replacing unreleased section with new content.""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=6, + latest_version="1.0.0", + latest_version_position=7, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- Another new feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + assert result == expected + + def test_replacement_when_latest_version_position_is_none(self): + """Test replacement when latest_version_position is None (append to end).""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=5, + latest_version=None, + latest_version_position=None, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- Another new feature", + ] + + assert result == expected + + def test_replacement_when_latest_version_position_after_unreleased_end(self): + """Test replacement when latest_version_position is after unreleased_end.""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=5, + latest_version="1.0.0", + latest_version_position=7, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "", + "## Unreleased\n\n### Added\n- Another new feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + assert result == expected + + def test_replacement_when_latest_version_position_before_unreleased_end(self): + """Test replacement when latest_version_position is before unreleased_end.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + ] + + metadata = Metadata( + unreleased_start=7, + unreleased_end=10, + latest_version="1.0.0", + latest_version_position=2, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- Another new feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "", + "- New feature", + ] + + assert result == expected + + def test_no_unreleased_section_append_to_end(self): + """Test appending new content when no unreleased section exists.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + metadata = Metadata( + unreleased_start=None, + unreleased_end=None, + latest_version=None, + latest_version_position=None, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "\n", + "## Unreleased\n\n### Added\n- New feature", + ] + + assert result == expected + + def test_no_unreleased_section_with_latest_version_position(self): + """Test inserting new content at latest_version_position when no unreleased section.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + metadata = Metadata( + unreleased_start=None, + unreleased_end=None, + latest_version="1.0.0", + latest_version_position=2, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- New feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + assert result == expected + + def test_empty_lines_list(self): + """Test behavior with empty lines list.""" + lines = [] + + metadata = Metadata( + unreleased_start=None, + unreleased_end=None, + latest_version=None, + latest_version_position=None, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "## Unreleased\n\n### Added\n- New feature", + ] + + assert result == expected + + def test_single_line_unreleased_section(self): + """Test replacement of single line unreleased section.""" + lines = [ + "# Changelog", + "## Unreleased", + "## 1.0.0 (2023-01-01)", + ] + + metadata = Metadata( + unreleased_start=1, + unreleased_end=1, + latest_version="1.0.0", + latest_version_position=2, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + ] + + assert result == expected + + def test_unreleased_section_at_end_of_file(self): + """Test replacement when unreleased section is at the end of file.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + ] + + metadata = Metadata( + unreleased_start=7, + unreleased_end=10, + latest_version="1.0.0", + latest_version_position=2, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- Another new feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "", + "- New feature", + ] + + assert result == expected + + def test_blank_line_handling_when_appending(self): + """Test that blank line is added when appending to non-empty content.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + ] + + metadata = Metadata( + unreleased_start=None, + unreleased_end=None, + latest_version=None, + latest_version_position=None, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "\n", + "## Unreleased\n\n### Added\n- New feature", + ] + + assert result == expected + + def test_no_blank_line_when_content_ends_with_blank_line(self): + """Test that no extra blank line is added when content already ends with blank line.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + ] + + metadata = Metadata( + unreleased_start=None, + unreleased_end=None, + latest_version=None, + latest_version_position=None, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "## Unreleased\n\n### Added\n- New feature", + ] + + assert result == expected + + def test_empty_new_content(self): + """Test behavior with empty new content.""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + "", + "## 1.0.0 (2023-01-01)", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=5, + latest_version="1.0.0", + latest_version_position=7, + ) + + new_content = "" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "", + "", + "\n", + "## 1.0.0 (2023-01-01)", + ] + + assert result == expected + + def test_multiline_new_content(self): + """Test behavior with multiline new content.""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + "", + "## 1.0.0 (2023-01-01)", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=5, + latest_version="1.0.0", + latest_version_position=7, + ) + + new_content = "## Unreleased\n\n### Added\n- Feature 1\n- Feature 2\n\n### Fixed\n- Bug fix" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "", + "## Unreleased\n\n### Added\n- Feature 1\n- Feature 2\n\n### Fixed\n- Bug fix", + "\n", + "## 1.0.0 (2023-01-01)", + ] + + assert result == expected + + def test_metadata_with_none_values(self): + """Test behavior when metadata has None values for unreleased positions.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + metadata = Metadata( + unreleased_start=None, + unreleased_end=None, + latest_version="1.0.0", + latest_version_position=2, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- New feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + assert result == expected + + def test_skip_behavior_during_unreleased_section(self): + """Test that lines are properly skipped during unreleased section processing.""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- Old feature 1", + "- Old feature 2", + "", + "### Fixed", + "- Old bug fix", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=9, + latest_version="1.0.0", + latest_version_position=11, + ) + + new_content = "## Unreleased\n\n### Added\n- New feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "", + "## Unreleased\n\n### Added\n- New feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + ] + + assert result == expected + + def test_latest_version_position_at_unreleased_end(self): + """Test behavior when latest_version_position equals unreleased_end.""" + lines = [ + "# Changelog", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + "", + "## 1.0.0 (2023-01-01)", + ] + + metadata = Metadata( + unreleased_start=2, + unreleased_end=5, + latest_version="1.0.0", + latest_version_position=5, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- Another new feature", + "\n", + "- New feature", + "", + "## 1.0.0 (2023-01-01)", + ] + + assert result == expected + + def test_latest_version_position_before_unreleased_start(self): + """Test behavior when latest_version_position is before unreleased_start.""" + lines = [ + "# Changelog", + "", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "", + "## Unreleased", + "", + "### Added", + "- New feature", + ] + + metadata = Metadata( + unreleased_start=7, + unreleased_end=9, + latest_version="1.0.0", + latest_version_position=2, + ) + + new_content = "## Unreleased\n\n### Added\n- Another new feature" + + result = incremental_build(new_content, lines, metadata) + + expected = [ + "# Changelog", + "", + "## Unreleased\n\n### Added\n- Another new feature", + "\n", + "## 1.0.0 (2023-01-01)", + "", + "### Fixed", + "- Bug fix", + "", + "### Added", + "- New feature", + ] + + assert result == expected diff --git a/tests/test_project_info.py b/tests/test_project_info.py new file mode 100644 index 0000000000..89359fe73e --- /dev/null +++ b/tests/test_project_info.py @@ -0,0 +1,91 @@ +"""Tests for project_info module.""" + +from __future__ import annotations + +from pathlib import Path + +import pytest + +from commitizen import project_info + + +def _create_project_files(files: dict[str, str | None]) -> None: + for file_path, content in files.items(): + path = Path(file_path) + if content is None: + path.touch() + else: + path.write_text(content) + + +@pytest.mark.parametrize( + ("which_return", "expected"), + [ + ("/usr/local/bin/pre-commit", True), + ("/usr/local/bin/prek", True), + (None, False), + ("", False), + ], +) +def test_is_pre_commit_installed(mocker, which_return, expected): + mocker.patch("shutil.which", return_value=which_return) + assert project_info.is_pre_commit_installed() is expected + + +@pytest.mark.parametrize( + ("files", "expected"), + [ + ( + {"pyproject.toml": '[tool.poetry]\nname = "test"\nversion = "0.1.0"'}, + "poetry", + ), + ({"pyproject.toml": "", "uv.lock": ""}, "uv"), + ( + {"pyproject.toml": '[tool.commitizen]\nversion = "0.1.0"'}, + "pep621", + ), + ({"setup.py": ""}, "pep621"), + ({"Cargo.toml": ""}, "cargo"), + ({"package.json": ""}, "npm"), + ({"composer.json": ""}, "composer"), + ({}, "commitizen"), + ( + { + "pyproject.toml": "", + "Cargo.toml": "", + "package.json": "", + "composer.json": "", + }, + "pep621", + ), + ], +) +def test_get_default_version_provider(chdir, files, expected): + _create_project_files(files) + assert project_info.get_default_version_provider() == expected + + +@pytest.mark.parametrize( + ("files", "expected"), + [ + ({"pyproject.toml": ""}, "pyproject.toml"), + ({}, ".cz.toml"), + ], +) +def test_get_default_config_filename(chdir, files, expected): + _create_project_files(files) + assert project_info.get_default_config_filename() == expected + + +@pytest.mark.parametrize( + ("files", "expected"), + [ + ({"pyproject.toml": ""}, "pep440"), + ({"setup.py": ""}, "pep440"), + ({"package.json": ""}, "semver"), + ({}, "semver"), + ], +) +def test_get_default_version_scheme(chdir, files, expected): + _create_project_files(files) + assert project_info.get_default_version_scheme() == expected diff --git a/tests/test_tags.py b/tests/test_tags.py new file mode 100644 index 0000000000..2471b8461b --- /dev/null +++ b/tests/test_tags.py @@ -0,0 +1,101 @@ +from commitizen.git import GitTag +from commitizen.tags import TagRules + + +def _git_tag(name: str) -> GitTag: + return GitTag(name, "rev", "2024-01-01") + + +def test_find_tag_for_partial_version_returns_latest_match(): + tags = [ + _git_tag("1.2.0"), + _git_tag("1.2.2"), + _git_tag("1.2.1"), + _git_tag("1.3.0"), + ] + + rules = TagRules() + + found = rules.find_tag_for(tags, "1.2") + + assert found is not None + assert found.name == "1.2.2" + + +def test_find_tag_for_full_version_remains_exact(): + tags = [ + _git_tag("1.2.0"), + _git_tag("1.2.2"), + _git_tag("1.2.1"), + ] + + rules = TagRules() + + found = rules.find_tag_for(tags, "1.2.1") + + assert found is not None + assert found.name == "1.2.1" + + +def test_find_tag_for_partial_version_with_prereleases_prefers_latest_version(): + tags = [ + _git_tag("1.2.0b1"), + _git_tag("1.2.0"), + _git_tag("1.2.1b1"), + ] + + rules = TagRules() + + found = rules.find_tag_for(tags, "1.2") + + assert found is not None + # 1.2.1b1 > 1.2.0 so it should be selected + assert found.name == "1.2.1b1" + + +def test_find_tag_for_partial_version_respects_tag_format(): + tags = [ + _git_tag("v1.2.0"), + _git_tag("v1.2.1"), + _git_tag("v1.3.0"), + ] + + rules = TagRules(tag_format="v$version") + + found = rules.find_tag_for(tags, "1.2") + + assert found is not None + assert found.name == "v1.2.1" + + found = rules.find_tag_for(tags, "1") + + assert found is not None + assert found.name == "v1.3.0" + + +def test_find_tag_for_partial_version_returns_none_when_no_match(): + tags = [ + _git_tag("2.0.0"), + _git_tag("2.1.0"), + ] + + rules = TagRules() + + found = rules.find_tag_for(tags, "1.2") + + assert found is None + + +def test_find_tag_for_partial_version_ignores_invalid_tags(): + tags = [ + _git_tag("not-a-version"), + _git_tag("1.2.0"), + _git_tag("1.2.1"), + ] + + rules = TagRules() + + found = rules.find_tag_for(tags, "1.2") + + assert found is not None + assert found.name == "1.2.1" diff --git a/tests/test_version_scheme_pep440.py b/tests/test_version_scheme_pep440.py new file mode 100644 index 0000000000..479c2f775d --- /dev/null +++ b/tests/test_version_scheme_pep440.py @@ -0,0 +1,1322 @@ +import pytest + +from commitizen.version_schemes import Pep440, VersionProtocol +from tests.utils import VersionSchemeTestArgs + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="0.1.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.1.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="2.1.1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.9.1a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.10.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0b0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2", + increment=None, + prerelease="beta", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0b1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0beta1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0rc2", + ), + # weird cases + ( + VersionSchemeTestArgs( + current_version="1.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="1a0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="1a0", + increment=None, + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0b0", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="beta", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0b1", + ), + ( + VersionSchemeTestArgs( + current_version="1beta", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0b1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0alpha1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0a2", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc1+e20d7b57f3eb", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.0", + ), + # simple flow + ( + VersionSchemeTestArgs( + current_version="0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=1, + ), + "0.1.1.dev1", + ), + ( + VersionSchemeTestArgs( + current_version="0.2.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.2.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=1, + ), + "0.3.0.dev1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.3.1a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1a0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.3.1a1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "0.3.1a1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1a0", + increment=None, + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "0.3.1a1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1a0", + increment=None, + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.4.2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0a2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0a2.dev1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2.dev0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0a3.dev1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2.dev0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=0, + ), + "1.0.0a3.dev0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0b0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0b1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0b1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0rc1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0rc1.dev1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a3.dev0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0b0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.2", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.2.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.2.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.2.1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + # linear prerelease cases + ( + VersionSchemeTestArgs( + current_version="0.1.1b1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1b2", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1rc0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1rc1", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1rc0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1rc1", + ), + # prerelease cases + ( + VersionSchemeTestArgs( + current_version="3.3.3", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.3.4a0", + ), + ( + VersionSchemeTestArgs( + current_version="3.3.4a0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.3.4a1", + ), + ( + VersionSchemeTestArgs( + current_version="3.3.4a1", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.4.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="3.4.0a0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.4.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="3.4.0a1", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.4.0a2", + ), + ( + VersionSchemeTestArgs( + current_version="3.4.0a2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "4.0.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="4.0.0a0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "4.0.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="4.0.0a1", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "4.0.0a2", + ), + ( + VersionSchemeTestArgs( + current_version="4.0.0a2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "4.0.0a3", + ), + # + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1a0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1a0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1a1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1a1", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a1", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0a2", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a0", + ), + # + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a2", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0a3", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a3", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a0", + ), + # + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a1", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a1", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a2", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a3", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a3", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a4", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a4", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a5", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a5", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0a6", + ), + # + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0b1", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.0b1", + ), + # + ( + VersionSchemeTestArgs( + current_version="1.0.1a0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1a0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1a0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + # + ( + VersionSchemeTestArgs( + current_version="1.1.0a0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0a0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + # + ( + VersionSchemeTestArgs( + current_version="2.0.0a0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="2.0.0a0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + # + ( + VersionSchemeTestArgs( + current_version="3.0.0a1", + increment=None, + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="3.0.0b1", + increment=None, + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="3.0.0rc1", + increment=None, + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + # + ( + VersionSchemeTestArgs( + current_version="3.1.4", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.1.4a0", + ), + ( + VersionSchemeTestArgs( + current_version="3.1.4", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "3.1.4b0", + ), + ( + VersionSchemeTestArgs( + current_version="3.1.4", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "3.1.4rc0", + ), + ( + VersionSchemeTestArgs( + current_version="3.1.4a0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.1.4a1", + ), + ( + VersionSchemeTestArgs( + current_version="3.1.4a0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.2.0a0", + ), + ( + VersionSchemeTestArgs( + current_version="3.1.4a0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "4.0.0a0", + ), + ], +) +def test_bump_pep440_version(version_args, expected_version): + assert ( + str( + Pep440(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + ) + ) + == expected_version + ) + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + # with exact_increment=False: "1.0.0b0" + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment="PATCH", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1b0", + ), + # with exact_increment=False: "1.0.0b1" + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment="PATCH", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1b0", + ), + # with exact_increment=False: "1.0.0rc0" + ( + VersionSchemeTestArgs( + current_version="1.0.0b1", + increment="PATCH", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1rc0", + ), + # with exact_increment=False: "1.0.0-rc1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="PATCH", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1rc0", + ), + # with exact_increment=False: "1.0.0rc1-dev1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="PATCH", + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.0.1rc0.dev1", + ), + # with exact_increment=False: "1.0.0b0" + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment="MINOR", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0b0", + ), + # with exact_increment=False: "1.0.0b1" + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment="MINOR", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0b0", + ), + # with exact_increment=False: "1.0.0b1" + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0a0", + ), + # with exact_increment=False: "1.0.0rc0" + ( + VersionSchemeTestArgs( + current_version="1.0.0b1", + increment="MINOR", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0rc0", + ), + # with exact_increment=False: "1.0.0rc1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="MINOR", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0rc0", + ), + # with exact_increment=False: "1.0.0rc1-dev1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="MINOR", + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.1.0rc0.dev1", + ), + # with exact_increment=False: "2.0.0" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + # with exact_increment=False: "2.0.0" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.1.0", + ), + # with exact_increment=False: "2.0.0" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.1", + ), + # same with exact_increment=False + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.0.0a0", + ), + # with exact_increment=False: "2.0.0b1" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.1.0a0", + ), + # with exact_increment=False: "2.0.0b1" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.1a0", + ), + ], +) +def test_bump_pep440_version_force(version_args, expected_version): + assert ( + str( + Pep440(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + exact_increment=True, + ) + ) + == expected_version + ) + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+0.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.1.1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+0.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.2.0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+1.0.0", + ), + ], +) +def test_bump_pep440_version_local(version_args, expected_version): + assert ( + str( + Pep440(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + is_local_version=True, + ) + ) + == expected_version + ) + + +def test_pep440_scheme_property(): + version = Pep440("0.0.1") + assert version.scheme is Pep440 + + +def test_pep440_implement_version_protocol(): + assert isinstance(Pep440("0.0.1"), VersionProtocol) diff --git a/tests/test_version_scheme_semver.py b/tests/test_version_scheme_semver.py new file mode 100644 index 0000000000..b5a275e980 --- /dev/null +++ b/tests/test_version_scheme_semver.py @@ -0,0 +1,879 @@ +from __future__ import annotations + +import pytest + +from commitizen.version_schemes import SemVer, VersionProtocol +from tests.utils import VersionSchemeTestArgs + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="0.1.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.1.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="2.1.1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.9.1-a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.10.0-a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-a1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-b0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2", + increment=None, + prerelease="beta", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-b1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0beta1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-a0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a2", + ), + # weird cases + ( + VersionSchemeTestArgs( + current_version="1.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="1a0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a1", + ), + ( + VersionSchemeTestArgs( + current_version="1a0", + increment=None, + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-a1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-b0", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="beta", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-b1", + ), + ( + VersionSchemeTestArgs( + current_version="1beta", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-b1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0alpha1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a2", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc1+e20d7b57f3eb", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.0", + ), + # simple flow + ( + VersionSchemeTestArgs( + current_version="0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=1, + ), + "0.1.1-dev1", + ), + ( + VersionSchemeTestArgs( + current_version="0.2.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.2.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=1, + ), + "0.3.0-dev1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.3.1-a0", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1a0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.3.1-a1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "0.3.1-a1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1a0", + increment=None, + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "0.3.1-a1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1a0", + increment=None, + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.4.2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-a2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0-a2-dev1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2.dev0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0-a3-dev1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a2.dev0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=0, + ), + "1.0.0-a3-dev0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-b0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-b1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0b1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0-rc1-dev1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0a3.dev0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-b0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.2", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.2.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.2.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.2.1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + # linear prerelease cases (never bump backwards on pre-releases) + ( + VersionSchemeTestArgs( + current_version="0.1.1b1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1-b2", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1rc0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1-rc1", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1rc0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1-rc1", + ), + ], +) +def test_bump_semver_version( + version_args: VersionSchemeTestArgs, expected_version: str +): + assert ( + str( + SemVer(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + ) + ) + == expected_version + ) + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + # with exact_increment=False: "1.0.0-b0" + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment="PATCH", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1-b0", + ), + # with exact_increment=False: "1.0.0-b1" + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment="PATCH", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1-b0", + ), + # with exact_increment=False: "1.0.0-rc0" + ( + VersionSchemeTestArgs( + current_version="1.0.0b1", + increment="PATCH", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1-rc0", + ), + # with exact_increment=False: "1.0.0-rc1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="PATCH", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.1-rc0", + ), + # with exact_increment=False: "1.0.0-rc1-dev1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="PATCH", + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.0.1-rc0-dev1", + ), + # with exact_increment=False: "1.0.0-b0" + ( + VersionSchemeTestArgs( + current_version="1.0.0a1", + increment="MINOR", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0-b0", + ), + # with exact_increment=False: "1.0.0-b1" + ( + VersionSchemeTestArgs( + current_version="1.0.0b0", + increment="MINOR", + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0-b0", + ), + # with exact_increment=False: "1.0.0-rc0" + ( + VersionSchemeTestArgs( + current_version="1.0.0b1", + increment="MINOR", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0-rc0", + ), + # with exact_increment=False: "1.0.0-rc1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="MINOR", + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.1.0-rc0", + ), + # with exact_increment=False: "1.0.0-rc1-dev1" + ( + VersionSchemeTestArgs( + current_version="1.0.0rc0", + increment="MINOR", + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.1.0-rc0-dev1", + ), + # with exact_increment=False: "2.0.0" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + # with exact_increment=False: "2.0.0" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.1.0", + ), + # with exact_increment=False: "2.0.0" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.1", + ), + # same with exact_increment=False + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "3.0.0-a0", + ), + # with exact_increment=False: "2.0.0b1" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.1.0-a0", + ), + # with exact_increment=False: "2.0.0b1" + ( + VersionSchemeTestArgs( + current_version="2.0.0b0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "2.0.1-a0", + ), + ], +) +def test_bump_semver_version_force( + version_args: VersionSchemeTestArgs, expected_version: str +): + assert ( + str( + SemVer(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + exact_increment=True, + ) + ) + == expected_version + ) + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+0.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.1.1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+0.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.2.0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+1.0.0", + ), + ], +) +def test_bump_semver_version_local( + version_args: VersionSchemeTestArgs, expected_version: str +): + assert ( + str( + SemVer(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + is_local_version=True, + ) + ) + == expected_version + ) + + +def test_semver_scheme_property(): + version = SemVer("0.0.1") + assert version.scheme is SemVer + + +def test_semver_implement_version_protocol(): + assert isinstance(SemVer("0.0.1"), VersionProtocol) diff --git a/tests/test_version_scheme_semver2.py b/tests/test_version_scheme_semver2.py new file mode 100644 index 0000000000..ddd975bf7a --- /dev/null +++ b/tests/test_version_scheme_semver2.py @@ -0,0 +1,631 @@ +from __future__ import annotations + +import pytest + +from commitizen.version_schemes import SemVer2, VersionProtocol +from tests.utils import VersionSchemeTestArgs + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="0.1.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.1.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="2.1.1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "3.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.9.1-alpha.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MINOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.10.0-alpha.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-alpha.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.9.0", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.2", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-beta.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.2", + increment=None, + prerelease="beta", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-beta.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-beta.1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-rc.1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc.2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-alpha.2", + ), + # weird_cases + ( + VersionSchemeTestArgs( + current_version="1.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="1-alpha.0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="1-alpha.0", + increment=None, + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-beta.0", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="beta", + prerelease_offset=1, + devrelease=None, + ), + "1.0.0-beta.1", + ), + ( + VersionSchemeTestArgs( + current_version="1-beta", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-beta.1", + ), + ( + VersionSchemeTestArgs( + current_version="1", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-rc.1+e20d7b57f3eb", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.0", + ), + # simple_flow + ( + VersionSchemeTestArgs( + current_version="0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=1, + ), + "0.1.1-dev.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.2.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.2.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=1, + ), + "0.3.0-dev.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.3.1-alpha.0", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1-alpha.0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.3.1-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.0", + increment="PATCH", + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "0.3.1-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1-alpha.0", + increment=None, + prerelease="alpha", + prerelease_offset=1, + devrelease=None, + ), + "0.3.1-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1-alpha.0", + increment=None, + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.3.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "0.3.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.4.2", + increment="MAJOR", + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-alpha.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-alpha.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0-alpha.2.dev.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.2.dev.0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0-alpha.3.dev.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.2.dev.0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=0, + ), + "1.0.0-alpha.3.dev.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.1", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-beta.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-beta.0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-beta.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-rc.0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-rc.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-rc.0", + increment=None, + prerelease="rc", + prerelease_offset=0, + devrelease=1, + ), + "1.0.0-rc.1.dev.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-rc.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0-alpha.3.dev.0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "1.0.0-beta.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.1", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.0.2", + ), + ( + VersionSchemeTestArgs( + current_version="1.0.2", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.1.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.1.0", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="1.2.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "1.2.1", + ), + ( + VersionSchemeTestArgs( + current_version="1.2.1", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "2.0.0", + ), + # linear prerelease cases (never bump backwards on pre-releases) + ( + VersionSchemeTestArgs( + current_version="0.1.1-beta.1", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1-beta.2", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1-rc.0", + increment=None, + prerelease="alpha", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1-rc.1", + ), + ( + VersionSchemeTestArgs( + current_version="0.1.1-rc.0", + increment=None, + prerelease="beta", + prerelease_offset=0, + devrelease=None, + ), + "0.1.1-rc.1", + ), + ], +) +def test_bump_semver_version( + version_args: VersionSchemeTestArgs, expected_version: str +): + assert ( + str( + SemVer2(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + ) + ) + == expected_version + ) + + +@pytest.mark.parametrize( + ("version_args", "expected_version"), + [ + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.1.0", + increment="PATCH", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+0.1.1", + ), + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.1.1", + increment="MINOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+0.2.0", + ), + ( + VersionSchemeTestArgs( + current_version="4.5.0+0.2.0", + increment="MAJOR", + prerelease=None, + prerelease_offset=0, + devrelease=None, + ), + "4.5.0+1.0.0", + ), + ], +) +def test_bump_semver_version_local( + version_args: VersionSchemeTestArgs, expected_version: str +): + assert ( + str( + SemVer2(version_args.current_version).bump( + increment=version_args.increment, + prerelease=version_args.prerelease, + prerelease_offset=version_args.prerelease_offset, + devrelease=version_args.devrelease, + is_local_version=True, + ) + ) + == expected_version + ) + + +def test_semver_scheme_property(): + version = SemVer2("0.0.1") + assert version.scheme is SemVer2 + + +def test_semver_implement_version_protocol(): + assert isinstance(SemVer2("0.0.1"), VersionProtocol) diff --git a/tests/test_version_schemes.py b/tests/test_version_schemes.py new file mode 100644 index 0000000000..0f38f90d80 --- /dev/null +++ b/tests/test_version_schemes.py @@ -0,0 +1,68 @@ +from __future__ import annotations + +from importlib import metadata +from typing import TYPE_CHECKING + +import pytest + +from commitizen.exceptions import VersionSchemeUnknown +from commitizen.version_schemes import Pep440, SemVer, get_version_scheme + +if TYPE_CHECKING: + from pytest_mock import MockerFixture + + from commitizen.config.base_config import BaseConfig + + +def test_default_version_scheme_is_pep440(config: BaseConfig): + scheme = get_version_scheme(config.settings) + assert scheme is Pep440 + + +def test_version_scheme_from_config(config: BaseConfig): + config.settings["version_scheme"] = "semver" + scheme = get_version_scheme(config.settings) + assert scheme is SemVer + + +def test_version_scheme_from_name(config: BaseConfig): + config.settings["version_scheme"] = "pep440" + scheme = get_version_scheme(config.settings, "semver") + assert scheme is SemVer + + +def test_raise_for_unknown_version_scheme(config: BaseConfig): + with pytest.raises(VersionSchemeUnknown): + get_version_scheme(config.settings, "unknown") + + +def test_version_scheme_from_deprecated_config(config: BaseConfig): + config.settings["version_type"] = "semver" + with pytest.warns(DeprecationWarning, match="Please use `version_scheme` instead"): + scheme = get_version_scheme(config.settings) + assert scheme is SemVer + + +def test_version_scheme_from_config_priority(config: BaseConfig): + config.settings["version_scheme"] = "pep440" + config.settings["version_type"] = "semver" + with pytest.warns(DeprecationWarning, match="Please use `version_scheme` instead"): + scheme = get_version_scheme(config.settings) + assert scheme is Pep440 + + +def test_warn_if_version_protocol_not_implemented( + config: BaseConfig, mocker: MockerFixture +): + class NotVersionProtocol: + pass + + ep = mocker.Mock() + ep.load.return_value = NotVersionProtocol + mocker.patch.object(metadata, "entry_points", return_value=(ep,)) + + with pytest.warns() as warnings: + get_version_scheme(config.settings, "any") + assert "Version scheme any does not implement the VersionProtocol" in str( + warnings[0].message + ) diff --git a/tests/utils.py b/tests/utils.py new file mode 100644 index 0000000000..bca565f78c --- /dev/null +++ b/tests/utils.py @@ -0,0 +1,133 @@ +from __future__ import annotations + +import sys +import uuid +from dataclasses import dataclass +from datetime import datetime +from pathlib import Path +from typing import TYPE_CHECKING, NamedTuple + +import pytest + +from commitizen import cli, cmd, exceptions, git +from commitizen.cmd import Command + +if TYPE_CHECKING: + from unittest.mock import Mock + + from freezegun.api import FrozenDateTimeFactory + from pytest_mock import MockerFixture + + from commitizen.version_schemes import Increment, Prerelease + + +class VersionSchemeTestArgs(NamedTuple): + current_version: str + increment: Increment | None + prerelease: Prerelease | None + prerelease_offset: int + devrelease: int | None + + +@dataclass +class UtilFixture: + """ + An helper fixture providing most common operations for tests. + + git and cli operations grant control over time. + """ + + mocker: MockerFixture + monkeypatch: pytest.MonkeyPatch + freezer: FrozenDateTimeFactory + + def __post_init__(self): + self.patch_env() + + def create_file_and_commit( + self, + message: str, + filename: str | None = None, + committer_date: str | None = None, + ) -> None: + """Create a file and commit it.""" + if not filename: + filename = str(uuid.uuid4()) + + Path(filename).touch() + c = cmd.run("git add .") + if c.return_code != 0: + raise exceptions.CommitError(c.err) + c = git.commit(message, committer_date=committer_date) + if c.return_code != 0: + raise exceptions.CommitError(c.err) + self.tick() + + def create_branch(self, name: str) -> None: + """Create a new branch.""" + c = cmd.run(f"git branch {name}") + if c.return_code != 0: + raise exceptions.GitCommandError(c.err) + + def switch_branch(self, branch: str) -> None: + """Switch to given branch.""" + c = cmd.run(f"git switch {branch}") + if c.return_code != 0: + raise exceptions.GitCommandError(c.err) + + def merge_branch(self, branch: str) -> None: + """Merge given branch into current branch.""" + c = cmd.run(f"git merge {branch}") + if c.return_code != 0: + raise exceptions.GitCommandError(c.err) + self.tick() + + def get_current_branch(self) -> str: + """Get current git branch name.""" + c = cmd.run("git rev-parse --abbrev-ref HEAD") + if c.return_code != 0: + raise exceptions.GitCommandError(c.err) + return c.out + + def create_tag( + self, tag: str, message: str | None = None, annotated: bool | None = None + ) -> None: + """Create a git tag.""" + c = git.tag( + tag, annotated=(annotated is True or message is not None), msg=message + ) + if c.return_code != 0: + raise exceptions.CommitError(c.err) + self.tick() + + def run_cli(self, *args: str) -> None: + """Execute commitizen CLI with given args.""" + self.mocker.patch.object(sys, "argv", ["cz", *args]) + cli.main() + self.tick() + + def patch_env(self) -> None: + """Patch environment variables to sync with FreezeGun time.""" + self.monkeypatch.setenv("DATE", datetime.now().isoformat()) + self.monkeypatch.setenv("GIT_AUTHOR_DATE", datetime.now().isoformat()) + self.monkeypatch.setenv("GIT_COMMITTER_DATE", datetime.now().isoformat()) + + def tick(self) -> None: + """Advance time by 1 second.""" + self.freezer.tick() + self.patch_env() + + def mock_cmd(self, out: str = "", err: str = "", return_code: int = 0) -> Mock: + """Mock cmd.run command.""" + return_value = Command(out, err, b"", b"", return_code) + return self.mocker.patch("commitizen.cmd.run", return_value=return_value) + + +@pytest.fixture +def util( + monkeypatch: pytest.MonkeyPatch, + mocker: MockerFixture, + freezer: FrozenDateTimeFactory, +) -> UtilFixture: + """An helper fixture""" + return UtilFixture(mocker=mocker, monkeypatch=monkeypatch, freezer=freezer) diff --git a/uv.lock b/uv.lock new file mode 100644 index 0000000000..2263aad3be --- /dev/null +++ b/uv.lock @@ -0,0 +1,1895 @@ +version = 1 +revision = 3 +requires-python = ">=3.10, <4.0" +resolution-markers = [ + "python_full_version >= '3.11'", + "python_full_version < '3.11'", +] + +[[package]] +name = "argcomplete" +version = "3.6.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/38/61/0b9ae6399dd4a58d8c1b1dc5a27d6f2808023d0b5dd3104bb99f45a33ff6/argcomplete-3.6.3.tar.gz", hash = "sha256:62e8ed4fd6a45864acc8235409461b72c9a28ee785a2011cc5eb78318786c89c", size = 73754, upload-time = "2025-10-20T03:33:34.741Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/74/f5/9373290775639cb67a2fce7f629a1c240dce9f12fe927bc32b2736e16dfc/argcomplete-3.6.3-py3-none-any.whl", hash = "sha256:f5007b3a600ccac5d25bbce33089211dfd49eab4a7718da3f10e3082525a92ce", size = 43846, upload-time = "2025-10-20T03:33:33.021Z" }, +] + +[[package]] +name = "asttokens" +version = "3.0.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/be/a5/8e3f9b6771b0b408517c82d97aed8f2036509bc247d46114925e32fe33f0/asttokens-3.0.1.tar.gz", hash = "sha256:71a4ee5de0bde6a31d64f6b13f2293ac190344478f081c3d1bccfcf5eacb0cb7", size = 62308, upload-time = "2025-11-15T16:43:48.578Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d2/39/e7eaf1799466a4aef85b6a4fe7bd175ad2b1c6345066aa33f1f58d4b18d0/asttokens-3.0.1-py3-none-any.whl", hash = "sha256:15a3ebc0f43c2d0a50eeafea25e19046c68398e487b9f1f5b517f7c0f40f976a", size = 27047, upload-time = "2025-11-15T16:43:16.109Z" }, +] + +[[package]] +name = "babel" +version = "2.17.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7d/6b/d52e42361e1aa00709585ecc30b3f9684b3ab62530771402248b1b1d6240/babel-2.17.0.tar.gz", hash = "sha256:0c54cffb19f690cdcc52a3b50bcbf71e07a808d1c80d549f2459b9d2cf0afb9d", size = 9951852, upload-time = "2025-02-01T15:17:41.026Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b7/b8/3fe70c75fe32afc4bb507f75563d39bc5642255d1d94f1f23604725780bf/babel-2.17.0-py3-none-any.whl", hash = "sha256:4d0b53093fdfb4b21c92b5213dba5a1b23885afa8383709427046b21c366e5f2", size = 10182537, upload-time = "2025-02-01T15:17:37.39Z" }, +] + +[[package]] +name = "backrefs" +version = "6.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/86/e3/bb3a439d5cb255c4774724810ad8073830fac9c9dee123555820c1bcc806/backrefs-6.1.tar.gz", hash = "sha256:3bba1749aafe1db9b915f00e0dd166cba613b6f788ffd63060ac3485dc9be231", size = 7011962, upload-time = "2025-11-15T14:52:08.323Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3b/ee/c216d52f58ea75b5e1841022bbae24438b19834a29b163cb32aa3a2a7c6e/backrefs-6.1-py310-none-any.whl", hash = "sha256:2a2ccb96302337ce61ee4717ceacfbf26ba4efb1d55af86564b8bbaeda39cac1", size = 381059, upload-time = "2025-11-15T14:51:59.758Z" }, + { url = "https://files.pythonhosted.org/packages/e6/9a/8da246d988ded941da96c7ed945d63e94a445637eaad985a0ed88787cb89/backrefs-6.1-py311-none-any.whl", hash = "sha256:e82bba3875ee4430f4de4b6db19429a27275d95a5f3773c57e9e18abc23fd2b7", size = 392854, upload-time = "2025-11-15T14:52:01.194Z" }, + { url = "https://files.pythonhosted.org/packages/37/c9/fd117a6f9300c62bbc33bc337fd2b3c6bfe28b6e9701de336b52d7a797ad/backrefs-6.1-py312-none-any.whl", hash = "sha256:c64698c8d2269343d88947c0735cb4b78745bd3ba590e10313fbf3f78c34da5a", size = 398770, upload-time = "2025-11-15T14:52:02.584Z" }, + { url = "https://files.pythonhosted.org/packages/eb/95/7118e935b0b0bd3f94dfec2d852fd4e4f4f9757bdb49850519acd245cd3a/backrefs-6.1-py313-none-any.whl", hash = "sha256:4c9d3dc1e2e558965202c012304f33d4e0e477e1c103663fd2c3cc9bb18b0d05", size = 400726, upload-time = "2025-11-15T14:52:04.093Z" }, + { url = "https://files.pythonhosted.org/packages/1d/72/6296bad135bfafd3254ae3648cd152980a424bd6fed64a101af00cc7ba31/backrefs-6.1-py314-none-any.whl", hash = "sha256:13eafbc9ccd5222e9c1f0bec563e6d2a6d21514962f11e7fc79872fd56cbc853", size = 412584, upload-time = "2025-11-15T14:52:05.233Z" }, + { url = "https://files.pythonhosted.org/packages/02/e3/a4fa1946722c4c7b063cc25043a12d9ce9b4323777f89643be74cef2993c/backrefs-6.1-py39-none-any.whl", hash = "sha256:a9e99b8a4867852cad177a6430e31b0f6e495d65f8c6c134b68c14c3c95bf4b0", size = 381058, upload-time = "2025-11-15T14:52:06.698Z" }, +] + +[[package]] +name = "cachetools" +version = "6.2.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/bc/1d/ede8680603f6016887c062a2cf4fc8fdba905866a3ab8831aa8aa651320c/cachetools-6.2.4.tar.gz", hash = "sha256:82c5c05585e70b6ba2d3ae09ea60b79548872185d2f24ae1f2709d37299fd607", size = 31731, upload-time = "2025-12-15T18:24:53.744Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2c/fc/1d7b80d0eb7b714984ce40efc78859c022cd930e402f599d8ca9e39c78a4/cachetools-6.2.4-py3-none-any.whl", hash = "sha256:69a7a52634fed8b8bf6e24a050fb60bff1c9bd8f6d24572b99c32d4e71e62a51", size = 11551, upload-time = "2025-12-15T18:24:52.332Z" }, +] + +[[package]] +name = "certifi" +version = "2025.11.12" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a2/8c/58f469717fa48465e4a50c014a0400602d3c437d7c0c468e17ada824da3a/certifi-2025.11.12.tar.gz", hash = "sha256:d8ab5478f2ecd78af242878415affce761ca6bc54a22a27e026d7c25357c3316", size = 160538, upload-time = "2025-11-12T02:54:51.517Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/70/7d/9bc192684cea499815ff478dfcdc13835ddf401365057044fb721ec6bddb/certifi-2025.11.12-py3-none-any.whl", hash = "sha256:97de8790030bbd5c2d96b7ec782fc2f7820ef8dba6db909ccf95449f2d062d4b", size = 159438, upload-time = "2025-11-12T02:54:49.735Z" }, +] + +[[package]] +name = "cfgv" +version = "3.5.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/4e/b5/721b8799b04bf9afe054a3899c6cf4e880fcf8563cc71c15610242490a0c/cfgv-3.5.0.tar.gz", hash = "sha256:d5b1034354820651caa73ede66a6294d6e95c1b00acc5e9b098e917404669132", size = 7334, upload-time = "2025-11-19T20:55:51.612Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/db/3c/33bac158f8ab7f89b2e59426d5fe2e4f63f7ed25df84c036890172b412b5/cfgv-3.5.0-py2.py3-none-any.whl", hash = "sha256:a8dc6b26ad22ff227d2634a65cb388215ce6cc96bbcc5cfde7641ae87e8dacc0", size = 7445, upload-time = "2025-11-19T20:55:50.744Z" }, +] + +[[package]] +name = "chardet" +version = "5.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f3/0d/f7b6ab21ec75897ed80c17d79b15951a719226b9fababf1e40ea74d69079/chardet-5.2.0.tar.gz", hash = "sha256:1b3b6ff479a8c414bc3fa2c0852995695c4a026dcd6d0633b2dd092ca39c1cf7", size = 2069618, upload-time = "2023-08-01T19:23:02.662Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/38/6f/f5fbc992a329ee4e0f288c1fe0e2ad9485ed064cac731ed2fe47dcc38cbf/chardet-5.2.0-py3-none-any.whl", hash = "sha256:e1cf59446890a00105fe7b7912492ea04b6e6f06d4b742b2c788469e34c82970", size = 199385, upload-time = "2023-08-01T19:23:00.661Z" }, +] + +[[package]] +name = "charset-normalizer" +version = "3.4.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/13/69/33ddede1939fdd074bce5434295f38fae7136463422fe4fd3e0e89b98062/charset_normalizer-3.4.4.tar.gz", hash = "sha256:94537985111c35f28720e43603b8e7b43a6ecfb2ce1d3058bbe955b73404e21a", size = 129418, upload-time = "2025-10-14T04:42:32.879Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/1f/b8/6d51fc1d52cbd52cd4ccedd5b5b2f0f6a11bbf6765c782298b0f3e808541/charset_normalizer-3.4.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:e824f1492727fa856dd6eda4f7cee25f8518a12f3c4a56a74e8095695089cf6d", size = 209709, upload-time = "2025-10-14T04:40:11.385Z" }, + { url = "https://files.pythonhosted.org/packages/5c/af/1f9d7f7faafe2ddfb6f72a2e07a548a629c61ad510fe60f9630309908fef/charset_normalizer-3.4.4-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4bd5d4137d500351a30687c2d3971758aac9a19208fc110ccb9d7188fbe709e8", size = 148814, upload-time = "2025-10-14T04:40:13.135Z" }, + { url = "https://files.pythonhosted.org/packages/79/3d/f2e3ac2bbc056ca0c204298ea4e3d9db9b4afe437812638759db2c976b5f/charset_normalizer-3.4.4-cp310-cp310-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:027f6de494925c0ab2a55eab46ae5129951638a49a34d87f4c3eda90f696b4ad", size = 144467, upload-time = "2025-10-14T04:40:14.728Z" }, + { url = "https://files.pythonhosted.org/packages/ec/85/1bf997003815e60d57de7bd972c57dc6950446a3e4ccac43bc3070721856/charset_normalizer-3.4.4-cp310-cp310-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f820802628d2694cb7e56db99213f930856014862f3fd943d290ea8438d07ca8", size = 162280, upload-time = "2025-10-14T04:40:16.14Z" }, + { url = "https://files.pythonhosted.org/packages/3e/8e/6aa1952f56b192f54921c436b87f2aaf7c7a7c3d0d1a765547d64fd83c13/charset_normalizer-3.4.4-cp310-cp310-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:798d75d81754988d2565bff1b97ba5a44411867c0cf32b77a7e8f8d84796b10d", size = 159454, upload-time = "2025-10-14T04:40:17.567Z" }, + { url = "https://files.pythonhosted.org/packages/36/3b/60cbd1f8e93aa25d1c669c649b7a655b0b5fb4c571858910ea9332678558/charset_normalizer-3.4.4-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9d1bb833febdff5c8927f922386db610b49db6e0d4f4ee29601d71e7c2694313", size = 153609, upload-time = "2025-10-14T04:40:19.08Z" }, + { url = "https://files.pythonhosted.org/packages/64/91/6a13396948b8fd3c4b4fd5bc74d045f5637d78c9675585e8e9fbe5636554/charset_normalizer-3.4.4-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:9cd98cdc06614a2f768d2b7286d66805f94c48cde050acdbbb7db2600ab3197e", size = 151849, upload-time = "2025-10-14T04:40:20.607Z" }, + { url = "https://files.pythonhosted.org/packages/b7/7a/59482e28b9981d105691e968c544cc0df3b7d6133152fb3dcdc8f135da7a/charset_normalizer-3.4.4-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:077fbb858e903c73f6c9db43374fd213b0b6a778106bc7032446a8e8b5b38b93", size = 151586, upload-time = "2025-10-14T04:40:21.719Z" }, + { url = "https://files.pythonhosted.org/packages/92/59/f64ef6a1c4bdd2baf892b04cd78792ed8684fbc48d4c2afe467d96b4df57/charset_normalizer-3.4.4-cp310-cp310-musllinux_1_2_armv7l.whl", hash = "sha256:244bfb999c71b35de57821b8ea746b24e863398194a4014e4c76adc2bbdfeff0", size = 145290, upload-time = "2025-10-14T04:40:23.069Z" }, + { url = "https://files.pythonhosted.org/packages/6b/63/3bf9f279ddfa641ffa1962b0db6a57a9c294361cc2f5fcac997049a00e9c/charset_normalizer-3.4.4-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:64b55f9dce520635f018f907ff1b0df1fdc31f2795a922fb49dd14fbcdf48c84", size = 163663, upload-time = "2025-10-14T04:40:24.17Z" }, + { url = "https://files.pythonhosted.org/packages/ed/09/c9e38fc8fa9e0849b172b581fd9803bdf6e694041127933934184e19f8c3/charset_normalizer-3.4.4-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:faa3a41b2b66b6e50f84ae4a68c64fcd0c44355741c6374813a800cd6695db9e", size = 151964, upload-time = "2025-10-14T04:40:25.368Z" }, + { url = "https://files.pythonhosted.org/packages/d2/d1/d28b747e512d0da79d8b6a1ac18b7ab2ecfd81b2944c4c710e166d8dd09c/charset_normalizer-3.4.4-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:6515f3182dbe4ea06ced2d9e8666d97b46ef4c75e326b79bb624110f122551db", size = 161064, upload-time = "2025-10-14T04:40:26.806Z" }, + { url = "https://files.pythonhosted.org/packages/bb/9a/31d62b611d901c3b9e5500c36aab0ff5eb442043fb3a1c254200d3d397d9/charset_normalizer-3.4.4-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:cc00f04ed596e9dc0da42ed17ac5e596c6ccba999ba6bd92b0e0aef2f170f2d6", size = 155015, upload-time = "2025-10-14T04:40:28.284Z" }, + { url = "https://files.pythonhosted.org/packages/1f/f3/107e008fa2bff0c8b9319584174418e5e5285fef32f79d8ee6a430d0039c/charset_normalizer-3.4.4-cp310-cp310-win32.whl", hash = "sha256:f34be2938726fc13801220747472850852fe6b1ea75869a048d6f896838c896f", size = 99792, upload-time = "2025-10-14T04:40:29.613Z" }, + { url = "https://files.pythonhosted.org/packages/eb/66/e396e8a408843337d7315bab30dbf106c38966f1819f123257f5520f8a96/charset_normalizer-3.4.4-cp310-cp310-win_amd64.whl", hash = "sha256:a61900df84c667873b292c3de315a786dd8dac506704dea57bc957bd31e22c7d", size = 107198, upload-time = "2025-10-14T04:40:30.644Z" }, + { url = "https://files.pythonhosted.org/packages/b5/58/01b4f815bf0312704c267f2ccb6e5d42bcc7752340cd487bc9f8c3710597/charset_normalizer-3.4.4-cp310-cp310-win_arm64.whl", hash = "sha256:cead0978fc57397645f12578bfd2d5ea9138ea0fac82b2f63f7f7c6877986a69", size = 100262, upload-time = "2025-10-14T04:40:32.108Z" }, + { url = "https://files.pythonhosted.org/packages/ed/27/c6491ff4954e58a10f69ad90aca8a1b6fe9c5d3c6f380907af3c37435b59/charset_normalizer-3.4.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6e1fcf0720908f200cd21aa4e6750a48ff6ce4afe7ff5a79a90d5ed8a08296f8", size = 206988, upload-time = "2025-10-14T04:40:33.79Z" }, + { url = "https://files.pythonhosted.org/packages/94/59/2e87300fe67ab820b5428580a53cad894272dbb97f38a7a814a2a1ac1011/charset_normalizer-3.4.4-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5f819d5fe9234f9f82d75bdfa9aef3a3d72c4d24a6e57aeaebba32a704553aa0", size = 147324, upload-time = "2025-10-14T04:40:34.961Z" }, + { url = "https://files.pythonhosted.org/packages/07/fb/0cf61dc84b2b088391830f6274cb57c82e4da8bbc2efeac8c025edb88772/charset_normalizer-3.4.4-cp311-cp311-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:a59cb51917aa591b1c4e6a43c132f0cdc3c76dbad6155df4e28ee626cc77a0a3", size = 142742, upload-time = "2025-10-14T04:40:36.105Z" }, + { url = "https://files.pythonhosted.org/packages/62/8b/171935adf2312cd745d290ed93cf16cf0dfe320863ab7cbeeae1dcd6535f/charset_normalizer-3.4.4-cp311-cp311-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:8ef3c867360f88ac904fd3f5e1f902f13307af9052646963ee08ff4f131adafc", size = 160863, upload-time = "2025-10-14T04:40:37.188Z" }, + { url = "https://files.pythonhosted.org/packages/09/73/ad875b192bda14f2173bfc1bc9a55e009808484a4b256748d931b6948442/charset_normalizer-3.4.4-cp311-cp311-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:d9e45d7faa48ee908174d8fe84854479ef838fc6a705c9315372eacbc2f02897", size = 157837, upload-time = "2025-10-14T04:40:38.435Z" }, + { url = "https://files.pythonhosted.org/packages/6d/fc/de9cce525b2c5b94b47c70a4b4fb19f871b24995c728e957ee68ab1671ea/charset_normalizer-3.4.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:840c25fb618a231545cbab0564a799f101b63b9901f2569faecd6b222ac72381", size = 151550, upload-time = "2025-10-14T04:40:40.053Z" }, + { url = "https://files.pythonhosted.org/packages/55/c2/43edd615fdfba8c6f2dfbd459b25a6b3b551f24ea21981e23fb768503ce1/charset_normalizer-3.4.4-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:ca5862d5b3928c4940729dacc329aa9102900382fea192fc5e52eb69d6093815", size = 149162, upload-time = "2025-10-14T04:40:41.163Z" }, + { url = "https://files.pythonhosted.org/packages/03/86/bde4ad8b4d0e9429a4e82c1e8f5c659993a9a863ad62c7df05cf7b678d75/charset_normalizer-3.4.4-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d9c7f57c3d666a53421049053eaacdd14bbd0a528e2186fcb2e672effd053bb0", size = 150019, upload-time = "2025-10-14T04:40:42.276Z" }, + { url = "https://files.pythonhosted.org/packages/1f/86/a151eb2af293a7e7bac3a739b81072585ce36ccfb4493039f49f1d3cae8c/charset_normalizer-3.4.4-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:277e970e750505ed74c832b4bf75dac7476262ee2a013f5574dd49075879e161", size = 143310, upload-time = "2025-10-14T04:40:43.439Z" }, + { url = "https://files.pythonhosted.org/packages/b5/fe/43dae6144a7e07b87478fdfc4dbe9efd5defb0e7ec29f5f58a55aeef7bf7/charset_normalizer-3.4.4-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:31fd66405eaf47bb62e8cd575dc621c56c668f27d46a61d975a249930dd5e2a4", size = 162022, upload-time = "2025-10-14T04:40:44.547Z" }, + { url = "https://files.pythonhosted.org/packages/80/e6/7aab83774f5d2bca81f42ac58d04caf44f0cc2b65fc6db2b3b2e8a05f3b3/charset_normalizer-3.4.4-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:0d3d8f15c07f86e9ff82319b3d9ef6f4bf907608f53fe9d92b28ea9ae3d1fd89", size = 149383, upload-time = "2025-10-14T04:40:46.018Z" }, + { url = "https://files.pythonhosted.org/packages/4f/e8/b289173b4edae05c0dde07f69f8db476a0b511eac556dfe0d6bda3c43384/charset_normalizer-3.4.4-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:9f7fcd74d410a36883701fafa2482a6af2ff5ba96b9a620e9e0721e28ead5569", size = 159098, upload-time = "2025-10-14T04:40:47.081Z" }, + { url = "https://files.pythonhosted.org/packages/d8/df/fe699727754cae3f8478493c7f45f777b17c3ef0600e28abfec8619eb49c/charset_normalizer-3.4.4-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:ebf3e58c7ec8a8bed6d66a75d7fb37b55e5015b03ceae72a8e7c74495551e224", size = 152991, upload-time = "2025-10-14T04:40:48.246Z" }, + { url = "https://files.pythonhosted.org/packages/1a/86/584869fe4ddb6ffa3bd9f491b87a01568797fb9bd8933f557dba9771beaf/charset_normalizer-3.4.4-cp311-cp311-win32.whl", hash = "sha256:eecbc200c7fd5ddb9a7f16c7decb07b566c29fa2161a16cf67b8d068bd21690a", size = 99456, upload-time = "2025-10-14T04:40:49.376Z" }, + { url = "https://files.pythonhosted.org/packages/65/f6/62fdd5feb60530f50f7e38b4f6a1d5203f4d16ff4f9f0952962c044e919a/charset_normalizer-3.4.4-cp311-cp311-win_amd64.whl", hash = "sha256:5ae497466c7901d54b639cf42d5b8c1b6a4fead55215500d2f486d34db48d016", size = 106978, upload-time = "2025-10-14T04:40:50.844Z" }, + { url = "https://files.pythonhosted.org/packages/7a/9d/0710916e6c82948b3be62d9d398cb4fcf4e97b56d6a6aeccd66c4b2f2bd5/charset_normalizer-3.4.4-cp311-cp311-win_arm64.whl", hash = "sha256:65e2befcd84bc6f37095f5961e68a6f077bf44946771354a28ad434c2cce0ae1", size = 99969, upload-time = "2025-10-14T04:40:52.272Z" }, + { url = "https://files.pythonhosted.org/packages/f3/85/1637cd4af66fa687396e757dec650f28025f2a2f5a5531a3208dc0ec43f2/charset_normalizer-3.4.4-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:0a98e6759f854bd25a58a73fa88833fba3b7c491169f86ce1180c948ab3fd394", size = 208425, upload-time = "2025-10-14T04:40:53.353Z" }, + { url = "https://files.pythonhosted.org/packages/9d/6a/04130023fef2a0d9c62d0bae2649b69f7b7d8d24ea5536feef50551029df/charset_normalizer-3.4.4-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b5b290ccc2a263e8d185130284f8501e3e36c5e02750fc6b6bdeb2e9e96f1e25", size = 148162, upload-time = "2025-10-14T04:40:54.558Z" }, + { url = "https://files.pythonhosted.org/packages/78/29/62328d79aa60da22c9e0b9a66539feae06ca0f5a4171ac4f7dc285b83688/charset_normalizer-3.4.4-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:74bb723680f9f7a6234dcf67aea57e708ec1fbdf5699fb91dfd6f511b0a320ef", size = 144558, upload-time = "2025-10-14T04:40:55.677Z" }, + { url = "https://files.pythonhosted.org/packages/86/bb/b32194a4bf15b88403537c2e120b817c61cd4ecffa9b6876e941c3ee38fe/charset_normalizer-3.4.4-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f1e34719c6ed0b92f418c7c780480b26b5d9c50349e9a9af7d76bf757530350d", size = 161497, upload-time = "2025-10-14T04:40:57.217Z" }, + { url = "https://files.pythonhosted.org/packages/19/89/a54c82b253d5b9b111dc74aca196ba5ccfcca8242d0fb64146d4d3183ff1/charset_normalizer-3.4.4-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:2437418e20515acec67d86e12bf70056a33abdacb5cb1655042f6538d6b085a8", size = 159240, upload-time = "2025-10-14T04:40:58.358Z" }, + { url = "https://files.pythonhosted.org/packages/c0/10/d20b513afe03acc89ec33948320a5544d31f21b05368436d580dec4e234d/charset_normalizer-3.4.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:11d694519d7f29d6cd09f6ac70028dba10f92f6cdd059096db198c283794ac86", size = 153471, upload-time = "2025-10-14T04:40:59.468Z" }, + { url = "https://files.pythonhosted.org/packages/61/fa/fbf177b55bdd727010f9c0a3c49eefa1d10f960e5f09d1d887bf93c2e698/charset_normalizer-3.4.4-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:ac1c4a689edcc530fc9d9aa11f5774b9e2f33f9a0c6a57864e90908f5208d30a", size = 150864, upload-time = "2025-10-14T04:41:00.623Z" }, + { url = "https://files.pythonhosted.org/packages/05/12/9fbc6a4d39c0198adeebbde20b619790e9236557ca59fc40e0e3cebe6f40/charset_normalizer-3.4.4-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:21d142cc6c0ec30d2efee5068ca36c128a30b0f2c53c1c07bd78cb6bc1d3be5f", size = 150647, upload-time = "2025-10-14T04:41:01.754Z" }, + { url = "https://files.pythonhosted.org/packages/ad/1f/6a9a593d52e3e8c5d2b167daf8c6b968808efb57ef4c210acb907c365bc4/charset_normalizer-3.4.4-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:5dbe56a36425d26d6cfb40ce79c314a2e4dd6211d51d6d2191c00bed34f354cc", size = 145110, upload-time = "2025-10-14T04:41:03.231Z" }, + { url = "https://files.pythonhosted.org/packages/30/42/9a52c609e72471b0fc54386dc63c3781a387bb4fe61c20231a4ebcd58bdd/charset_normalizer-3.4.4-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:5bfbb1b9acf3334612667b61bd3002196fe2a1eb4dd74d247e0f2a4d50ec9bbf", size = 162839, upload-time = "2025-10-14T04:41:04.715Z" }, + { url = "https://files.pythonhosted.org/packages/c4/5b/c0682bbf9f11597073052628ddd38344a3d673fda35a36773f7d19344b23/charset_normalizer-3.4.4-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:d055ec1e26e441f6187acf818b73564e6e6282709e9bcb5b63f5b23068356a15", size = 150667, upload-time = "2025-10-14T04:41:05.827Z" }, + { url = "https://files.pythonhosted.org/packages/e4/24/a41afeab6f990cf2daf6cb8c67419b63b48cf518e4f56022230840c9bfb2/charset_normalizer-3.4.4-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:af2d8c67d8e573d6de5bc30cdb27e9b95e49115cd9baad5ddbd1a6207aaa82a9", size = 160535, upload-time = "2025-10-14T04:41:06.938Z" }, + { url = "https://files.pythonhosted.org/packages/2a/e5/6a4ce77ed243c4a50a1fecca6aaaab419628c818a49434be428fe24c9957/charset_normalizer-3.4.4-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:780236ac706e66881f3b7f2f32dfe90507a09e67d1d454c762cf642e6e1586e0", size = 154816, upload-time = "2025-10-14T04:41:08.101Z" }, + { url = "https://files.pythonhosted.org/packages/a8/ef/89297262b8092b312d29cdb2517cb1237e51db8ecef2e9af5edbe7b683b1/charset_normalizer-3.4.4-cp312-cp312-win32.whl", hash = "sha256:5833d2c39d8896e4e19b689ffc198f08ea58116bee26dea51e362ecc7cd3ed26", size = 99694, upload-time = "2025-10-14T04:41:09.23Z" }, + { url = "https://files.pythonhosted.org/packages/3d/2d/1e5ed9dd3b3803994c155cd9aacb60c82c331bad84daf75bcb9c91b3295e/charset_normalizer-3.4.4-cp312-cp312-win_amd64.whl", hash = "sha256:a79cfe37875f822425b89a82333404539ae63dbdddf97f84dcbc3d339aae9525", size = 107131, upload-time = "2025-10-14T04:41:10.467Z" }, + { url = "https://files.pythonhosted.org/packages/d0/d9/0ed4c7098a861482a7b6a95603edce4c0d9db2311af23da1fb2b75ec26fc/charset_normalizer-3.4.4-cp312-cp312-win_arm64.whl", hash = "sha256:376bec83a63b8021bb5c8ea75e21c4ccb86e7e45ca4eb81146091b56599b80c3", size = 100390, upload-time = "2025-10-14T04:41:11.915Z" }, + { url = "https://files.pythonhosted.org/packages/97/45/4b3a1239bbacd321068ea6e7ac28875b03ab8bc0aa0966452db17cd36714/charset_normalizer-3.4.4-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:e1f185f86a6f3403aa2420e815904c67b2f9ebc443f045edd0de921108345794", size = 208091, upload-time = "2025-10-14T04:41:13.346Z" }, + { url = "https://files.pythonhosted.org/packages/7d/62/73a6d7450829655a35bb88a88fca7d736f9882a27eacdca2c6d505b57e2e/charset_normalizer-3.4.4-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6b39f987ae8ccdf0d2642338faf2abb1862340facc796048b604ef14919e55ed", size = 147936, upload-time = "2025-10-14T04:41:14.461Z" }, + { url = "https://files.pythonhosted.org/packages/89/c5/adb8c8b3d6625bef6d88b251bbb0d95f8205831b987631ab0c8bb5d937c2/charset_normalizer-3.4.4-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:3162d5d8ce1bb98dd51af660f2121c55d0fa541b46dff7bb9b9f86ea1d87de72", size = 144180, upload-time = "2025-10-14T04:41:15.588Z" }, + { url = "https://files.pythonhosted.org/packages/91/ed/9706e4070682d1cc219050b6048bfd293ccf67b3d4f5a4f39207453d4b99/charset_normalizer-3.4.4-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:81d5eb2a312700f4ecaa977a8235b634ce853200e828fbadf3a9c50bab278328", size = 161346, upload-time = "2025-10-14T04:41:16.738Z" }, + { url = "https://files.pythonhosted.org/packages/d5/0d/031f0d95e4972901a2f6f09ef055751805ff541511dc1252ba3ca1f80cf5/charset_normalizer-3.4.4-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:5bd2293095d766545ec1a8f612559f6b40abc0eb18bb2f5d1171872d34036ede", size = 158874, upload-time = "2025-10-14T04:41:17.923Z" }, + { url = "https://files.pythonhosted.org/packages/f5/83/6ab5883f57c9c801ce5e5677242328aa45592be8a00644310a008d04f922/charset_normalizer-3.4.4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a8a8b89589086a25749f471e6a900d3f662d1d3b6e2e59dcecf787b1cc3a1894", size = 153076, upload-time = "2025-10-14T04:41:19.106Z" }, + { url = "https://files.pythonhosted.org/packages/75/1e/5ff781ddf5260e387d6419959ee89ef13878229732732ee73cdae01800f2/charset_normalizer-3.4.4-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:bc7637e2f80d8530ee4a78e878bce464f70087ce73cf7c1caf142416923b98f1", size = 150601, upload-time = "2025-10-14T04:41:20.245Z" }, + { url = "https://files.pythonhosted.org/packages/d7/57/71be810965493d3510a6ca79b90c19e48696fb1ff964da319334b12677f0/charset_normalizer-3.4.4-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f8bf04158c6b607d747e93949aa60618b61312fe647a6369f88ce2ff16043490", size = 150376, upload-time = "2025-10-14T04:41:21.398Z" }, + { url = "https://files.pythonhosted.org/packages/e5/d5/c3d057a78c181d007014feb7e9f2e65905a6c4ef182c0ddf0de2924edd65/charset_normalizer-3.4.4-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:554af85e960429cf30784dd47447d5125aaa3b99a6f0683589dbd27e2f45da44", size = 144825, upload-time = "2025-10-14T04:41:22.583Z" }, + { url = "https://files.pythonhosted.org/packages/e6/8c/d0406294828d4976f275ffbe66f00266c4b3136b7506941d87c00cab5272/charset_normalizer-3.4.4-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:74018750915ee7ad843a774364e13a3db91682f26142baddf775342c3f5b1133", size = 162583, upload-time = "2025-10-14T04:41:23.754Z" }, + { url = "https://files.pythonhosted.org/packages/d7/24/e2aa1f18c8f15c4c0e932d9287b8609dd30ad56dbe41d926bd846e22fb8d/charset_normalizer-3.4.4-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:c0463276121fdee9c49b98908b3a89c39be45d86d1dbaa22957e38f6321d4ce3", size = 150366, upload-time = "2025-10-14T04:41:25.27Z" }, + { url = "https://files.pythonhosted.org/packages/e4/5b/1e6160c7739aad1e2df054300cc618b06bf784a7a164b0f238360721ab86/charset_normalizer-3.4.4-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:362d61fd13843997c1c446760ef36f240cf81d3ebf74ac62652aebaf7838561e", size = 160300, upload-time = "2025-10-14T04:41:26.725Z" }, + { url = "https://files.pythonhosted.org/packages/7a/10/f882167cd207fbdd743e55534d5d9620e095089d176d55cb22d5322f2afd/charset_normalizer-3.4.4-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:9a26f18905b8dd5d685d6d07b0cdf98a79f3c7a918906af7cc143ea2e164c8bc", size = 154465, upload-time = "2025-10-14T04:41:28.322Z" }, + { url = "https://files.pythonhosted.org/packages/89/66/c7a9e1b7429be72123441bfdbaf2bc13faab3f90b933f664db506dea5915/charset_normalizer-3.4.4-cp313-cp313-win32.whl", hash = "sha256:9b35f4c90079ff2e2edc5b26c0c77925e5d2d255c42c74fdb70fb49b172726ac", size = 99404, upload-time = "2025-10-14T04:41:29.95Z" }, + { url = "https://files.pythonhosted.org/packages/c4/26/b9924fa27db384bdcd97ab83b4f0a8058d96ad9626ead570674d5e737d90/charset_normalizer-3.4.4-cp313-cp313-win_amd64.whl", hash = "sha256:b435cba5f4f750aa6c0a0d92c541fb79f69a387c91e61f1795227e4ed9cece14", size = 107092, upload-time = "2025-10-14T04:41:31.188Z" }, + { url = "https://files.pythonhosted.org/packages/af/8f/3ed4bfa0c0c72a7ca17f0380cd9e4dd842b09f664e780c13cff1dcf2ef1b/charset_normalizer-3.4.4-cp313-cp313-win_arm64.whl", hash = "sha256:542d2cee80be6f80247095cc36c418f7bddd14f4a6de45af91dfad36d817bba2", size = 100408, upload-time = "2025-10-14T04:41:32.624Z" }, + { url = "https://files.pythonhosted.org/packages/2a/35/7051599bd493e62411d6ede36fd5af83a38f37c4767b92884df7301db25d/charset_normalizer-3.4.4-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:da3326d9e65ef63a817ecbcc0df6e94463713b754fe293eaa03da99befb9a5bd", size = 207746, upload-time = "2025-10-14T04:41:33.773Z" }, + { url = "https://files.pythonhosted.org/packages/10/9a/97c8d48ef10d6cd4fcead2415523221624bf58bcf68a802721a6bc807c8f/charset_normalizer-3.4.4-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:8af65f14dc14a79b924524b1e7fffe304517b2bff5a58bf64f30b98bbc5079eb", size = 147889, upload-time = "2025-10-14T04:41:34.897Z" }, + { url = "https://files.pythonhosted.org/packages/10/bf/979224a919a1b606c82bd2c5fa49b5c6d5727aa47b4312bb27b1734f53cd/charset_normalizer-3.4.4-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:74664978bb272435107de04e36db5a9735e78232b85b77d45cfb38f758efd33e", size = 143641, upload-time = "2025-10-14T04:41:36.116Z" }, + { url = "https://files.pythonhosted.org/packages/ba/33/0ad65587441fc730dc7bd90e9716b30b4702dc7b617e6ba4997dc8651495/charset_normalizer-3.4.4-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:752944c7ffbfdd10c074dc58ec2d5a8a4cd9493b314d367c14d24c17684ddd14", size = 160779, upload-time = "2025-10-14T04:41:37.229Z" }, + { url = "https://files.pythonhosted.org/packages/67/ed/331d6b249259ee71ddea93f6f2f0a56cfebd46938bde6fcc6f7b9a3d0e09/charset_normalizer-3.4.4-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:d1f13550535ad8cff21b8d757a3257963e951d96e20ec82ab44bc64aeb62a191", size = 159035, upload-time = "2025-10-14T04:41:38.368Z" }, + { url = "https://files.pythonhosted.org/packages/67/ff/f6b948ca32e4f2a4576aa129d8bed61f2e0543bf9f5f2b7fc3758ed005c9/charset_normalizer-3.4.4-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ecaae4149d99b1c9e7b88bb03e3221956f68fd6d50be2ef061b2381b61d20838", size = 152542, upload-time = "2025-10-14T04:41:39.862Z" }, + { url = "https://files.pythonhosted.org/packages/16/85/276033dcbcc369eb176594de22728541a925b2632f9716428c851b149e83/charset_normalizer-3.4.4-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:cb6254dc36b47a990e59e1068afacdcd02958bdcce30bb50cc1700a8b9d624a6", size = 149524, upload-time = "2025-10-14T04:41:41.319Z" }, + { url = "https://files.pythonhosted.org/packages/9e/f2/6a2a1f722b6aba37050e626530a46a68f74e63683947a8acff92569f979a/charset_normalizer-3.4.4-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:c8ae8a0f02f57a6e61203a31428fa1d677cbe50c93622b4149d5c0f319c1d19e", size = 150395, upload-time = "2025-10-14T04:41:42.539Z" }, + { url = "https://files.pythonhosted.org/packages/60/bb/2186cb2f2bbaea6338cad15ce23a67f9b0672929744381e28b0592676824/charset_normalizer-3.4.4-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:47cc91b2f4dd2833fddaedd2893006b0106129d4b94fdb6af1f4ce5a9965577c", size = 143680, upload-time = "2025-10-14T04:41:43.661Z" }, + { url = "https://files.pythonhosted.org/packages/7d/a5/bf6f13b772fbb2a90360eb620d52ed8f796f3c5caee8398c3b2eb7b1c60d/charset_normalizer-3.4.4-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:82004af6c302b5d3ab2cfc4cc5f29db16123b1a8417f2e25f9066f91d4411090", size = 162045, upload-time = "2025-10-14T04:41:44.821Z" }, + { url = "https://files.pythonhosted.org/packages/df/c5/d1be898bf0dc3ef9030c3825e5d3b83f2c528d207d246cbabe245966808d/charset_normalizer-3.4.4-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:2b7d8f6c26245217bd2ad053761201e9f9680f8ce52f0fcd8d0755aeae5b2152", size = 149687, upload-time = "2025-10-14T04:41:46.442Z" }, + { url = "https://files.pythonhosted.org/packages/a5/42/90c1f7b9341eef50c8a1cb3f098ac43b0508413f33affd762855f67a410e/charset_normalizer-3.4.4-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:799a7a5e4fb2d5898c60b640fd4981d6a25f1c11790935a44ce38c54e985f828", size = 160014, upload-time = "2025-10-14T04:41:47.631Z" }, + { url = "https://files.pythonhosted.org/packages/76/be/4d3ee471e8145d12795ab655ece37baed0929462a86e72372fd25859047c/charset_normalizer-3.4.4-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:99ae2cffebb06e6c22bdc25801d7b30f503cc87dbd283479e7b606f70aff57ec", size = 154044, upload-time = "2025-10-14T04:41:48.81Z" }, + { url = "https://files.pythonhosted.org/packages/b0/6f/8f7af07237c34a1defe7defc565a9bc1807762f672c0fde711a4b22bf9c0/charset_normalizer-3.4.4-cp314-cp314-win32.whl", hash = "sha256:f9d332f8c2a2fcbffe1378594431458ddbef721c1769d78e2cbc06280d8155f9", size = 99940, upload-time = "2025-10-14T04:41:49.946Z" }, + { url = "https://files.pythonhosted.org/packages/4b/51/8ade005e5ca5b0d80fb4aff72a3775b325bdc3d27408c8113811a7cbe640/charset_normalizer-3.4.4-cp314-cp314-win_amd64.whl", hash = "sha256:8a6562c3700cce886c5be75ade4a5db4214fda19fede41d9792d100288d8f94c", size = 107104, upload-time = "2025-10-14T04:41:51.051Z" }, + { url = "https://files.pythonhosted.org/packages/da/5f/6b8f83a55bb8278772c5ae54a577f3099025f9ade59d0136ac24a0df4bde/charset_normalizer-3.4.4-cp314-cp314-win_arm64.whl", hash = "sha256:de00632ca48df9daf77a2c65a484531649261ec9f25489917f09e455cb09ddb2", size = 100743, upload-time = "2025-10-14T04:41:52.122Z" }, + { url = "https://files.pythonhosted.org/packages/0a/4c/925909008ed5a988ccbb72dcc897407e5d6d3bd72410d69e051fc0c14647/charset_normalizer-3.4.4-py3-none-any.whl", hash = "sha256:7a32c560861a02ff789ad905a2fe94e3f840803362c84fecf1851cb4cf3dc37f", size = 53402, upload-time = "2025-10-14T04:42:31.76Z" }, +] + +[[package]] +name = "click" +version = "8.3.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "sys_platform == 'win32'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/3d/fa/656b739db8587d7b5dfa22e22ed02566950fbfbcdc20311993483657a5c0/click-8.3.1.tar.gz", hash = "sha256:12ff4785d337a1bb490bb7e9c2b1ee5da3112e94a8622f26a6c77f5d2fc6842a", size = 295065, upload-time = "2025-11-15T20:45:42.706Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/98/78/01c019cdb5d6498122777c1a43056ebb3ebfeef2076d9d026bfe15583b2b/click-8.3.1-py3-none-any.whl", hash = "sha256:981153a64e25f12d547d3426c367a4857371575ee7ad18df2a6183ab0545b2a6", size = 108274, upload-time = "2025-11-15T20:45:41.139Z" }, +] + +[[package]] +name = "colorama" +version = "0.4.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d8/53/6f443c9a4a8358a93a6792e2acffb9d9d5cb0a5cfd8802644b7b1c9a02e4/colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44", size = 27697, upload-time = "2022-10-25T02:36:22.414Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335, upload-time = "2022-10-25T02:36:20.889Z" }, +] + +[[package]] +name = "commitizen" +version = "4.13.9" +source = { editable = "." } +dependencies = [ + { name = "argcomplete" }, + { name = "charset-normalizer" }, + { name = "colorama" }, + { name = "decli" }, + { name = "deprecated" }, + { name = "jinja2" }, + { name = "packaging" }, + { name = "prompt-toolkit" }, + { name = "pyyaml" }, + { name = "questionary" }, + { name = "termcolor" }, + { name = "tomlkit" }, + { name = "typing-extensions", marker = "python_full_version < '3.11'" }, +] + +[package.dev-dependencies] +base = [ + { name = "poethepoet" }, +] +dev = [ + { name = "ipython", version = "8.37.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" }, + { name = "ipython", version = "9.8.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, + { name = "mkdocs" }, + { name = "mkdocs-git-revision-date-localized-plugin" }, + { name = "mkdocs-material" }, + { name = "mypy" }, + { name = "poethepoet" }, + { name = "pre-commit" }, + { name = "prek" }, + { name = "pytest" }, + { name = "pytest-cov" }, + { name = "pytest-freezer" }, + { name = "pytest-gitconfig" }, + { name = "pytest-mock" }, + { name = "pytest-regressions" }, + { name = "pytest-xdist" }, + { name = "rich" }, + { name = "ruff" }, + { name = "tox" }, + { name = "tox-uv" }, + { name = "types-colorama" }, + { name = "types-deprecated" }, + { name = "types-python-dateutil" }, + { name = "types-pyyaml" }, + { name = "types-termcolor" }, +] +documentation = [ + { name = "mkdocs" }, + { name = "mkdocs-git-revision-date-localized-plugin" }, + { name = "mkdocs-material" }, +] +linters = [ + { name = "mypy" }, + { name = "prek" }, + { name = "ruff" }, + { name = "types-colorama" }, + { name = "types-deprecated" }, + { name = "types-python-dateutil" }, + { name = "types-pyyaml" }, + { name = "types-termcolor" }, +] +script = [ + { name = "rich" }, +] +test = [ + { name = "pre-commit" }, + { name = "pytest" }, + { name = "pytest-cov" }, + { name = "pytest-freezer" }, + { name = "pytest-gitconfig" }, + { name = "pytest-mock" }, + { name = "pytest-regressions" }, + { name = "pytest-xdist" }, +] + +[package.metadata] +requires-dist = [ + { name = "argcomplete", specifier = ">=1.12.1,<3.7" }, + { name = "charset-normalizer", specifier = ">=2.1.0,<4" }, + { name = "colorama", specifier = ">=0.4.1,<1.0" }, + { name = "decli", specifier = ">=0.6.0,<1.0" }, + { name = "deprecated", specifier = ">=1.2.13,<2" }, + { name = "importlib-metadata", marker = "python_full_version < '3.10'", specifier = ">=8.0.0,<8.7.0" }, + { name = "jinja2", specifier = ">=2.10.3" }, + { name = "packaging", specifier = ">=19" }, + { name = "prompt-toolkit", specifier = "!=3.0.52" }, + { name = "pyyaml", specifier = ">=3.8" }, + { name = "questionary", specifier = ">=2.0,<3.0" }, + { name = "termcolor", specifier = ">=1.1.0,<4.0.0" }, + { name = "tomlkit", specifier = ">=0.8.0,<1.0.0" }, + { name = "typing-extensions", marker = "python_full_version < '3.11'", specifier = ">=4.0.1,<5.0.0" }, +] + +[package.metadata.requires-dev] +base = [{ name = "poethepoet", specifier = ">=0.34.0" }] +dev = [ + { name = "ipython", specifier = ">=8.0" }, + { name = "mkdocs", specifier = ">=1.4.2" }, + { name = "mkdocs-git-revision-date-localized-plugin", specifier = ">=1.5.0" }, + { name = "mkdocs-material", specifier = ">=9.1.6" }, + { name = "mypy", specifier = ">=1.16.0" }, + { name = "poethepoet", specifier = ">=0.34.0" }, + { name = "pre-commit", specifier = ">=4.5.1" }, + { name = "prek", specifier = ">=0.2.28" }, + { name = "pytest", specifier = ">=9" }, + { name = "pytest-cov", specifier = ">=4" }, + { name = "pytest-freezer", specifier = ">=0.4.6" }, + { name = "pytest-gitconfig", specifier = ">=0.9.0" }, + { name = "pytest-mock", specifier = ">=3.10" }, + { name = "pytest-regressions", specifier = ">=2.4.0" }, + { name = "pytest-xdist", specifier = ">=3.1.0" }, + { name = "rich", specifier = ">=13.7.1" }, + { name = "ruff", specifier = ">=0.11.5" }, + { name = "tox", specifier = ">4" }, + { name = "tox-uv" }, + { name = "types-colorama", specifier = ">=0.4.15.20240311" }, + { name = "types-deprecated", specifier = ">=1.2.9.2" }, + { name = "types-python-dateutil", specifier = ">=2.8.19.13" }, + { name = "types-pyyaml", specifier = ">=5.4.3" }, + { name = "types-termcolor", specifier = ">=0.1.1" }, +] +documentation = [ + { name = "mkdocs", specifier = ">=1.4.2" }, + { name = "mkdocs-git-revision-date-localized-plugin", specifier = ">=1.5.0" }, + { name = "mkdocs-material", specifier = ">=9.1.6" }, +] +linters = [ + { name = "mypy", specifier = ">=1.16.0" }, + { name = "prek", specifier = ">=0.2.28" }, + { name = "ruff", specifier = ">=0.11.5" }, + { name = "types-colorama", specifier = ">=0.4.15.20240311" }, + { name = "types-deprecated", specifier = ">=1.2.9.2" }, + { name = "types-python-dateutil", specifier = ">=2.8.19.13" }, + { name = "types-pyyaml", specifier = ">=5.4.3" }, + { name = "types-termcolor", specifier = ">=0.1.1" }, +] +script = [{ name = "rich", specifier = ">=13.7.1" }] +test = [ + { name = "pre-commit", specifier = ">=4.5.1" }, + { name = "pytest", specifier = ">=9" }, + { name = "pytest-cov", specifier = ">=4" }, + { name = "pytest-freezer", specifier = ">=0.4.6" }, + { name = "pytest-gitconfig", specifier = ">=0.9.0" }, + { name = "pytest-mock", specifier = ">=3.10" }, + { name = "pytest-regressions", specifier = ">=2.4.0" }, + { name = "pytest-xdist", specifier = ">=3.1.0" }, +] + +[[package]] +name = "coverage" +version = "7.13.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/b6/45/2c665ca77ec32ad67e25c77daf1cee28ee4558f3bc571cdbaf88a00b9f23/coverage-7.13.0.tar.gz", hash = "sha256:a394aa27f2d7ff9bc04cf703817773a59ad6dfbd577032e690f961d2460ee936", size = 820905, upload-time = "2025-12-08T13:14:38.055Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/db/08/bdd7ccca14096f7eb01412b87ac11e5d16e4cb54b6e328afc9dee8bdaec1/coverage-7.13.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:02d9fb9eccd48f6843c98a37bd6817462f130b86da8660461e8f5e54d4c06070", size = 217979, upload-time = "2025-12-08T13:12:14.505Z" }, + { url = "https://files.pythonhosted.org/packages/fa/f0/d1302e3416298a28b5663ae1117546a745d9d19fde7e28402b2c5c3e2109/coverage-7.13.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:367449cf07d33dc216c083f2036bb7d976c6e4903ab31be400ad74ad9f85ce98", size = 218496, upload-time = "2025-12-08T13:12:16.237Z" }, + { url = "https://files.pythonhosted.org/packages/07/26/d36c354c8b2a320819afcea6bffe72839efd004b98d1d166b90801d49d57/coverage-7.13.0-cp310-cp310-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:cdb3c9f8fef0a954c632f64328a3935988d33a6604ce4bf67ec3e39670f12ae5", size = 245237, upload-time = "2025-12-08T13:12:17.858Z" }, + { url = "https://files.pythonhosted.org/packages/91/52/be5e85631e0eec547873d8b08dd67a5f6b111ecfe89a86e40b89b0c1c61c/coverage-7.13.0-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:d10fd186aac2316f9bbb46ef91977f9d394ded67050ad6d84d94ed6ea2e8e54e", size = 247061, upload-time = "2025-12-08T13:12:19.132Z" }, + { url = "https://files.pythonhosted.org/packages/0f/45/a5e8fa0caf05fbd8fa0402470377bff09cc1f026d21c05c71e01295e55ab/coverage-7.13.0-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:7f88ae3e69df2ab62fb0bc5219a597cb890ba5c438190ffa87490b315190bb33", size = 248928, upload-time = "2025-12-08T13:12:20.702Z" }, + { url = "https://files.pythonhosted.org/packages/f5/42/ffb5069b6fd1b95fae482e02f3fecf380d437dd5a39bae09f16d2e2e7e01/coverage-7.13.0-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:c4be718e51e86f553bcf515305a158a1cd180d23b72f07ae76d6017c3cc5d791", size = 245931, upload-time = "2025-12-08T13:12:22.243Z" }, + { url = "https://files.pythonhosted.org/packages/95/6e/73e809b882c2858f13e55c0c36e94e09ce07e6165d5644588f9517efe333/coverage-7.13.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:a00d3a393207ae12f7c49bb1c113190883b500f48979abb118d8b72b8c95c032", size = 246968, upload-time = "2025-12-08T13:12:23.52Z" }, + { url = "https://files.pythonhosted.org/packages/87/08/64ebd9e64b6adb8b4a4662133d706fbaccecab972e0b3ccc23f64e2678ad/coverage-7.13.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:3a7b1cd820e1b6116f92c6128f1188e7afe421c7e1b35fa9836b11444e53ebd9", size = 244972, upload-time = "2025-12-08T13:12:24.781Z" }, + { url = "https://files.pythonhosted.org/packages/12/97/f4d27c6fe0cb375a5eced4aabcaef22de74766fb80a3d5d2015139e54b22/coverage-7.13.0-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:37eee4e552a65866f15dedd917d5e5f3d59805994260720821e2c1b51ac3248f", size = 245241, upload-time = "2025-12-08T13:12:28.041Z" }, + { url = "https://files.pythonhosted.org/packages/0c/94/42f8ae7f633bf4c118bf1038d80472f9dade88961a466f290b81250f7ab7/coverage-7.13.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:62d7c4f13102148c78d7353c6052af6d899a7f6df66a32bddcc0c0eb7c5326f8", size = 245847, upload-time = "2025-12-08T13:12:29.337Z" }, + { url = "https://files.pythonhosted.org/packages/a8/2f/6369ca22b6b6d933f4f4d27765d313d8914cc4cce84f82a16436b1a233db/coverage-7.13.0-cp310-cp310-win32.whl", hash = "sha256:24e4e56304fdb56f96f80eabf840eab043b3afea9348b88be680ec5986780a0f", size = 220573, upload-time = "2025-12-08T13:12:30.905Z" }, + { url = "https://files.pythonhosted.org/packages/f1/dc/a6a741e519acceaeccc70a7f4cfe5d030efc4b222595f0677e101af6f1f3/coverage-7.13.0-cp310-cp310-win_amd64.whl", hash = "sha256:74c136e4093627cf04b26a35dab8cbfc9b37c647f0502fc313376e11726ba303", size = 221509, upload-time = "2025-12-08T13:12:32.09Z" }, + { url = "https://files.pythonhosted.org/packages/f1/dc/888bf90d8b1c3d0b4020a40e52b9f80957d75785931ec66c7dfaccc11c7d/coverage-7.13.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:0dfa3855031070058add1a59fdfda0192fd3e8f97e7c81de0596c145dea51820", size = 218104, upload-time = "2025-12-08T13:12:33.333Z" }, + { url = "https://files.pythonhosted.org/packages/8d/ea/069d51372ad9c380214e86717e40d1a743713a2af191cfba30a0911b0a4a/coverage-7.13.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4fdb6f54f38e334db97f72fa0c701e66d8479af0bc3f9bfb5b90f1c30f54500f", size = 218606, upload-time = "2025-12-08T13:12:34.498Z" }, + { url = "https://files.pythonhosted.org/packages/68/09/77b1c3a66c2aa91141b6c4471af98e5b1ed9b9e6d17255da5eb7992299e3/coverage-7.13.0-cp311-cp311-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:7e442c013447d1d8d195be62852270b78b6e255b79b8675bad8479641e21fd96", size = 248999, upload-time = "2025-12-08T13:12:36.02Z" }, + { url = "https://files.pythonhosted.org/packages/0a/32/2e2f96e9d5691eaf1181d9040f850b8b7ce165ea10810fd8e2afa534cef7/coverage-7.13.0-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:1ed5630d946859de835a85e9a43b721123a8a44ec26e2830b296d478c7fd4259", size = 250925, upload-time = "2025-12-08T13:12:37.221Z" }, + { url = "https://files.pythonhosted.org/packages/7b/45/b88ddac1d7978859b9a39a8a50ab323186148f1d64bc068f86fc77706321/coverage-7.13.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:7f15a931a668e58087bc39d05d2b4bf4b14ff2875b49c994bbdb1c2217a8daeb", size = 253032, upload-time = "2025-12-08T13:12:38.763Z" }, + { url = "https://files.pythonhosted.org/packages/71/cb/e15513f94c69d4820a34b6bf3d2b1f9f8755fa6021be97c7065442d7d653/coverage-7.13.0-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:30a3a201a127ea57f7e14ba43c93c9c4be8b7d17a26e03bb49e6966d019eede9", size = 249134, upload-time = "2025-12-08T13:12:40.382Z" }, + { url = "https://files.pythonhosted.org/packages/09/61/d960ff7dc9e902af3310ce632a875aaa7860f36d2bc8fc8b37ee7c1b82a5/coverage-7.13.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:7a485ff48fbd231efa32d58f479befce52dcb6bfb2a88bb7bf9a0b89b1bc8030", size = 250731, upload-time = "2025-12-08T13:12:41.992Z" }, + { url = "https://files.pythonhosted.org/packages/98/34/c7c72821794afc7c7c2da1db8f00c2c98353078aa7fb6b5ff36aac834b52/coverage-7.13.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:22486cdafba4f9e471c816a2a5745337742a617fef68e890d8baf9f3036d7833", size = 248795, upload-time = "2025-12-08T13:12:43.331Z" }, + { url = "https://files.pythonhosted.org/packages/0a/5b/e0f07107987a43b2def9aa041c614ddb38064cbf294a71ef8c67d43a0cdd/coverage-7.13.0-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:263c3dbccc78e2e331e59e90115941b5f53e85cfcc6b3b2fbff1fd4e3d2c6ea8", size = 248514, upload-time = "2025-12-08T13:12:44.546Z" }, + { url = "https://files.pythonhosted.org/packages/71/c2/c949c5d3b5e9fc6dd79e1b73cdb86a59ef14f3709b1d72bf7668ae12e000/coverage-7.13.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:e5330fa0cc1f5c3c4c3bb8e101b742025933e7848989370a1d4c8c5e401ea753", size = 249424, upload-time = "2025-12-08T13:12:45.759Z" }, + { url = "https://files.pythonhosted.org/packages/11/f1/bbc009abd6537cec0dffb2cc08c17a7f03de74c970e6302db4342a6e05af/coverage-7.13.0-cp311-cp311-win32.whl", hash = "sha256:0f4872f5d6c54419c94c25dd6ae1d015deeb337d06e448cd890a1e89a8ee7f3b", size = 220597, upload-time = "2025-12-08T13:12:47.378Z" }, + { url = "https://files.pythonhosted.org/packages/c4/f6/d9977f2fb51c10fbaed0718ce3d0a8541185290b981f73b1d27276c12d91/coverage-7.13.0-cp311-cp311-win_amd64.whl", hash = "sha256:51a202e0f80f241ccb68e3e26e19ab5b3bf0f813314f2c967642f13ebcf1ddfe", size = 221536, upload-time = "2025-12-08T13:12:48.7Z" }, + { url = "https://files.pythonhosted.org/packages/be/ad/3fcf43fd96fb43e337a3073dea63ff148dcc5c41ba7a14d4c7d34efb2216/coverage-7.13.0-cp311-cp311-win_arm64.whl", hash = "sha256:d2a9d7f1c11487b1c69367ab3ac2d81b9b3721f097aa409a3191c3e90f8f3dd7", size = 220206, upload-time = "2025-12-08T13:12:50.365Z" }, + { url = "https://files.pythonhosted.org/packages/9b/f1/2619559f17f31ba00fc40908efd1fbf1d0a5536eb75dc8341e7d660a08de/coverage-7.13.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:0b3d67d31383c4c68e19a88e28fc4c2e29517580f1b0ebec4a069d502ce1e0bf", size = 218274, upload-time = "2025-12-08T13:12:52.095Z" }, + { url = "https://files.pythonhosted.org/packages/2b/11/30d71ae5d6e949ff93b2a79a2c1b4822e00423116c5c6edfaeef37301396/coverage-7.13.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:581f086833d24a22c89ae0fe2142cfaa1c92c930adf637ddf122d55083fb5a0f", size = 218638, upload-time = "2025-12-08T13:12:53.418Z" }, + { url = "https://files.pythonhosted.org/packages/79/c2/fce80fc6ded8d77e53207489d6065d0fed75db8951457f9213776615e0f5/coverage-7.13.0-cp312-cp312-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:0a3a30f0e257df382f5f9534d4ce3d4cf06eafaf5192beb1a7bd066cb10e78fb", size = 250129, upload-time = "2025-12-08T13:12:54.744Z" }, + { url = "https://files.pythonhosted.org/packages/5b/b6/51b5d1eb6fcbb9a1d5d6984e26cbe09018475c2922d554fd724dd0f056ee/coverage-7.13.0-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:583221913fbc8f53b88c42e8dbb8fca1d0f2e597cb190ce45916662b8b9d9621", size = 252885, upload-time = "2025-12-08T13:12:56.401Z" }, + { url = "https://files.pythonhosted.org/packages/0d/f8/972a5affea41de798691ab15d023d3530f9f56a72e12e243f35031846ff7/coverage-7.13.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5f5d9bd30756fff3e7216491a0d6d520c448d5124d3d8e8f56446d6412499e74", size = 253974, upload-time = "2025-12-08T13:12:57.718Z" }, + { url = "https://files.pythonhosted.org/packages/8a/56/116513aee860b2c7968aa3506b0f59b22a959261d1dbf3aea7b4450a7520/coverage-7.13.0-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:a23e5a1f8b982d56fa64f8e442e037f6ce29322f1f9e6c2344cd9e9f4407ee57", size = 250538, upload-time = "2025-12-08T13:12:59.254Z" }, + { url = "https://files.pythonhosted.org/packages/d6/75/074476d64248fbadf16dfafbf93fdcede389ec821f74ca858d7c87d2a98c/coverage-7.13.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9b01c22bc74a7fb44066aaf765224c0d933ddf1f5047d6cdfe4795504a4493f8", size = 251912, upload-time = "2025-12-08T13:13:00.604Z" }, + { url = "https://files.pythonhosted.org/packages/f2/d2/aa4f8acd1f7c06024705c12609d8698c51b27e4d635d717cd1934c9668e2/coverage-7.13.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:898cce66d0836973f48dda4e3514d863d70142bdf6dfab932b9b6a90ea5b222d", size = 250054, upload-time = "2025-12-08T13:13:01.892Z" }, + { url = "https://files.pythonhosted.org/packages/19/98/8df9e1af6a493b03694a1e8070e024e7d2cdc77adedc225a35e616d505de/coverage-7.13.0-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:3ab483ea0e251b5790c2aac03acde31bff0c736bf8a86829b89382b407cd1c3b", size = 249619, upload-time = "2025-12-08T13:13:03.236Z" }, + { url = "https://files.pythonhosted.org/packages/d8/71/f8679231f3353018ca66ef647fa6fe7b77e6bff7845be54ab84f86233363/coverage-7.13.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:1d84e91521c5e4cb6602fe11ece3e1de03b2760e14ae4fcf1a4b56fa3c801fcd", size = 251496, upload-time = "2025-12-08T13:13:04.511Z" }, + { url = "https://files.pythonhosted.org/packages/04/86/9cb406388034eaf3c606c22094edbbb82eea1fa9d20c0e9efadff20d0733/coverage-7.13.0-cp312-cp312-win32.whl", hash = "sha256:193c3887285eec1dbdb3f2bd7fbc351d570ca9c02ca756c3afbc71b3c98af6ef", size = 220808, upload-time = "2025-12-08T13:13:06.422Z" }, + { url = "https://files.pythonhosted.org/packages/1c/59/af483673df6455795daf5f447c2f81a3d2fcfc893a22b8ace983791f6f34/coverage-7.13.0-cp312-cp312-win_amd64.whl", hash = "sha256:4f3e223b2b2db5e0db0c2b97286aba0036ca000f06aca9b12112eaa9af3d92ae", size = 221616, upload-time = "2025-12-08T13:13:07.95Z" }, + { url = "https://files.pythonhosted.org/packages/64/b0/959d582572b30a6830398c60dd419c1965ca4b5fb38ac6b7093a0d50ca8d/coverage-7.13.0-cp312-cp312-win_arm64.whl", hash = "sha256:086cede306d96202e15a4b77ace8472e39d9f4e5f9fd92dd4fecdfb2313b2080", size = 220261, upload-time = "2025-12-08T13:13:09.581Z" }, + { url = "https://files.pythonhosted.org/packages/7c/cc/bce226595eb3bf7d13ccffe154c3c487a22222d87ff018525ab4dd2e9542/coverage-7.13.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:28ee1c96109974af104028a8ef57cec21447d42d0e937c0275329272e370ebcf", size = 218297, upload-time = "2025-12-08T13:13:10.977Z" }, + { url = "https://files.pythonhosted.org/packages/3b/9f/73c4d34600aae03447dff3d7ad1d0ac649856bfb87d1ca7d681cfc913f9e/coverage-7.13.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:d1e97353dcc5587b85986cda4ff3ec98081d7e84dd95e8b2a6d59820f0545f8a", size = 218673, upload-time = "2025-12-08T13:13:12.562Z" }, + { url = "https://files.pythonhosted.org/packages/63/ab/8fa097db361a1e8586535ae5073559e6229596b3489ec3ef2f5b38df8cb2/coverage-7.13.0-cp313-cp313-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:99acd4dfdfeb58e1937629eb1ab6ab0899b131f183ee5f23e0b5da5cba2fec74", size = 249652, upload-time = "2025-12-08T13:13:13.909Z" }, + { url = "https://files.pythonhosted.org/packages/90/3a/9bfd4de2ff191feb37ef9465855ca56a6f2f30a3bca172e474130731ac3d/coverage-7.13.0-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:ff45e0cd8451e293b63ced93161e189780baf444119391b3e7d25315060368a6", size = 252251, upload-time = "2025-12-08T13:13:15.553Z" }, + { url = "https://files.pythonhosted.org/packages/df/61/b5d8105f016e1b5874af0d7c67542da780ccd4a5f2244a433d3e20ceb1ad/coverage-7.13.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f4f72a85316d8e13234cafe0a9f81b40418ad7a082792fa4165bd7d45d96066b", size = 253492, upload-time = "2025-12-08T13:13:16.849Z" }, + { url = "https://files.pythonhosted.org/packages/f3/b8/0fad449981803cc47a4694768b99823fb23632150743f9c83af329bb6090/coverage-7.13.0-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:11c21557d0e0a5a38632cbbaca5f008723b26a89d70db6315523df6df77d6232", size = 249850, upload-time = "2025-12-08T13:13:18.142Z" }, + { url = "https://files.pythonhosted.org/packages/9a/e9/8d68337c3125014d918cf4327d5257553a710a2995a6a6de2ac77e5aa429/coverage-7.13.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:76541dc8d53715fb4f7a3a06b34b0dc6846e3c69bc6204c55653a85dd6220971", size = 251633, upload-time = "2025-12-08T13:13:19.56Z" }, + { url = "https://files.pythonhosted.org/packages/55/14/d4112ab26b3a1bc4b3c1295d8452dcf399ed25be4cf649002fb3e64b2d93/coverage-7.13.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:6e9e451dee940a86789134b6b0ffbe31c454ade3b849bb8a9d2cca2541a8e91d", size = 249586, upload-time = "2025-12-08T13:13:20.883Z" }, + { url = "https://files.pythonhosted.org/packages/2c/a9/22b0000186db663b0d82f86c2f1028099ae9ac202491685051e2a11a5218/coverage-7.13.0-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:5c67dace46f361125e6b9cace8fe0b729ed8479f47e70c89b838d319375c8137", size = 249412, upload-time = "2025-12-08T13:13:22.22Z" }, + { url = "https://files.pythonhosted.org/packages/a1/2e/42d8e0d9e7527fba439acdc6ed24a2b97613b1dc85849b1dd935c2cffef0/coverage-7.13.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:f59883c643cb19630500f57016f76cfdcd6845ca8c5b5ea1f6e17f74c8e5f511", size = 251191, upload-time = "2025-12-08T13:13:23.899Z" }, + { url = "https://files.pythonhosted.org/packages/a4/af/8c7af92b1377fd8860536aadd58745119252aaaa71a5213e5a8e8007a9f5/coverage-7.13.0-cp313-cp313-win32.whl", hash = "sha256:58632b187be6f0be500f553be41e277712baa278147ecb7559983c6d9faf7ae1", size = 220829, upload-time = "2025-12-08T13:13:25.182Z" }, + { url = "https://files.pythonhosted.org/packages/58/f9/725e8bf16f343d33cbe076c75dc8370262e194ff10072c0608b8e5cf33a3/coverage-7.13.0-cp313-cp313-win_amd64.whl", hash = "sha256:73419b89f812f498aca53f757dd834919b48ce4799f9d5cad33ca0ae442bdb1a", size = 221640, upload-time = "2025-12-08T13:13:26.836Z" }, + { url = "https://files.pythonhosted.org/packages/8a/ff/e98311000aa6933cc79274e2b6b94a2fe0fe3434fca778eba82003675496/coverage-7.13.0-cp313-cp313-win_arm64.whl", hash = "sha256:eb76670874fdd6091eedcc856128ee48c41a9bbbb9c3f1c7c3cf169290e3ffd6", size = 220269, upload-time = "2025-12-08T13:13:28.116Z" }, + { url = "https://files.pythonhosted.org/packages/cf/cf/bbaa2e1275b300343ea865f7d424cc0a2e2a1df6925a070b2b2d5d765330/coverage-7.13.0-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:6e63ccc6e0ad8986386461c3c4b737540f20426e7ec932f42e030320896c311a", size = 218990, upload-time = "2025-12-08T13:13:29.463Z" }, + { url = "https://files.pythonhosted.org/packages/21/1d/82f0b3323b3d149d7672e7744c116e9c170f4957e0c42572f0366dbb4477/coverage-7.13.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:494f5459ffa1bd45e18558cd98710c36c0b8fbfa82a5eabcbe671d80ecffbfe8", size = 219340, upload-time = "2025-12-08T13:13:31.524Z" }, + { url = "https://files.pythonhosted.org/packages/fb/e3/fe3fd4702a3832a255f4d43013eacb0ef5fc155a5960ea9269d8696db28b/coverage-7.13.0-cp313-cp313t-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:06cac81bf10f74034e055e903f5f946e3e26fc51c09fc9f584e4a1605d977053", size = 260638, upload-time = "2025-12-08T13:13:32.965Z" }, + { url = "https://files.pythonhosted.org/packages/ad/01/63186cb000307f2b4da463f72af9b85d380236965574c78e7e27680a2593/coverage-7.13.0-cp313-cp313t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:f2ffc92b46ed6e6760f1d47a71e56b5664781bc68986dbd1836b2b70c0ce2071", size = 262705, upload-time = "2025-12-08T13:13:34.378Z" }, + { url = "https://files.pythonhosted.org/packages/7c/a1/c0dacef0cc865f2455d59eed3548573ce47ed603205ffd0735d1d78b5906/coverage-7.13.0-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0602f701057c6823e5db1b74530ce85f17c3c5be5c85fc042ac939cbd909426e", size = 265125, upload-time = "2025-12-08T13:13:35.73Z" }, + { url = "https://files.pythonhosted.org/packages/ef/92/82b99223628b61300bd382c205795533bed021505eab6dd86e11fb5d7925/coverage-7.13.0-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:25dc33618d45456ccb1d37bce44bc78cf269909aa14c4db2e03d63146a8a1493", size = 259844, upload-time = "2025-12-08T13:13:37.69Z" }, + { url = "https://files.pythonhosted.org/packages/cf/2c/89b0291ae4e6cd59ef042708e1c438e2290f8c31959a20055d8768349ee2/coverage-7.13.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:71936a8b3b977ddd0b694c28c6a34f4fff2e9dd201969a4ff5d5fc7742d614b0", size = 262700, upload-time = "2025-12-08T13:13:39.525Z" }, + { url = "https://files.pythonhosted.org/packages/bf/f9/a5f992efae1996245e796bae34ceb942b05db275e4b34222a9a40b9fbd3b/coverage-7.13.0-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:936bc20503ce24770c71938d1369461f0c5320830800933bc3956e2a4ded930e", size = 260321, upload-time = "2025-12-08T13:13:41.172Z" }, + { url = "https://files.pythonhosted.org/packages/4c/89/a29f5d98c64fedbe32e2ac3c227fbf78edc01cc7572eee17d61024d89889/coverage-7.13.0-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:af0a583efaacc52ae2521f8d7910aff65cdb093091d76291ac5820d5e947fc1c", size = 259222, upload-time = "2025-12-08T13:13:43.282Z" }, + { url = "https://files.pythonhosted.org/packages/b3/c3/940fe447aae302a6701ee51e53af7e08b86ff6eed7631e5740c157ee22b9/coverage-7.13.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:f1c23e24a7000da892a312fb17e33c5f94f8b001de44b7cf8ba2e36fbd15859e", size = 261411, upload-time = "2025-12-08T13:13:44.72Z" }, + { url = "https://files.pythonhosted.org/packages/eb/31/12a4aec689cb942a89129587860ed4d0fd522d5fda81237147fde554b8ae/coverage-7.13.0-cp313-cp313t-win32.whl", hash = "sha256:5f8a0297355e652001015e93be345ee54393e45dc3050af4a0475c5a2b767d46", size = 221505, upload-time = "2025-12-08T13:13:46.332Z" }, + { url = "https://files.pythonhosted.org/packages/65/8c/3b5fe3259d863572d2b0827642c50c3855d26b3aefe80bdc9eba1f0af3b0/coverage-7.13.0-cp313-cp313t-win_amd64.whl", hash = "sha256:6abb3a4c52f05e08460bd9acf04fec027f8718ecaa0d09c40ffbc3fbd70ecc39", size = 222569, upload-time = "2025-12-08T13:13:47.79Z" }, + { url = "https://files.pythonhosted.org/packages/b0/39/f71fa8316a96ac72fc3908839df651e8eccee650001a17f2c78cdb355624/coverage-7.13.0-cp313-cp313t-win_arm64.whl", hash = "sha256:3ad968d1e3aa6ce5be295ab5fe3ae1bf5bb4769d0f98a80a0252d543a2ef2e9e", size = 220841, upload-time = "2025-12-08T13:13:49.243Z" }, + { url = "https://files.pythonhosted.org/packages/f8/4b/9b54bedda55421449811dcd5263a2798a63f48896c24dfb92b0f1b0845bd/coverage-7.13.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:453b7ec753cf5e4356e14fe858064e5520c460d3bbbcb9c35e55c0d21155c256", size = 218343, upload-time = "2025-12-08T13:13:50.811Z" }, + { url = "https://files.pythonhosted.org/packages/59/df/c3a1f34d4bba2e592c8979f924da4d3d4598b0df2392fbddb7761258e3dc/coverage-7.13.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:af827b7cbb303e1befa6c4f94fd2bf72f108089cfa0f8abab8f4ca553cf5ca5a", size = 218672, upload-time = "2025-12-08T13:13:52.284Z" }, + { url = "https://files.pythonhosted.org/packages/07/62/eec0659e47857698645ff4e6ad02e30186eb8afd65214fd43f02a76537cb/coverage-7.13.0-cp314-cp314-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:9987a9e4f8197a1000280f7cc089e3ea2c8b3c0a64d750537809879a7b4ceaf9", size = 249715, upload-time = "2025-12-08T13:13:53.791Z" }, + { url = "https://files.pythonhosted.org/packages/23/2d/3c7ff8b2e0e634c1f58d095f071f52ed3c23ff25be524b0ccae8b71f99f8/coverage-7.13.0-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:3188936845cd0cb114fa6a51842a304cdbac2958145d03be2377ec41eb285d19", size = 252225, upload-time = "2025-12-08T13:13:55.274Z" }, + { url = "https://files.pythonhosted.org/packages/aa/ac/fb03b469d20e9c9a81093575003f959cf91a4a517b783aab090e4538764b/coverage-7.13.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a2bdb3babb74079f021696cb46b8bb5f5661165c385d3a238712b031a12355be", size = 253559, upload-time = "2025-12-08T13:13:57.161Z" }, + { url = "https://files.pythonhosted.org/packages/29/62/14afa9e792383c66cc0a3b872a06ded6e4ed1079c7d35de274f11d27064e/coverage-7.13.0-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:7464663eaca6adba4175f6c19354feea61ebbdd735563a03d1e472c7072d27bb", size = 249724, upload-time = "2025-12-08T13:13:58.692Z" }, + { url = "https://files.pythonhosted.org/packages/31/b7/333f3dab2939070613696ab3ee91738950f0467778c6e5a5052e840646b7/coverage-7.13.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:8069e831f205d2ff1f3d355e82f511eb7c5522d7d413f5db5756b772ec8697f8", size = 251582, upload-time = "2025-12-08T13:14:00.642Z" }, + { url = "https://files.pythonhosted.org/packages/81/cb/69162bda9381f39b2287265d7e29ee770f7c27c19f470164350a38318764/coverage-7.13.0-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:6fb2d5d272341565f08e962cce14cdf843a08ac43bd621783527adb06b089c4b", size = 249538, upload-time = "2025-12-08T13:14:02.556Z" }, + { url = "https://files.pythonhosted.org/packages/e0/76/350387b56a30f4970abe32b90b2a434f87d29f8b7d4ae40d2e8a85aacfb3/coverage-7.13.0-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:5e70f92ef89bac1ac8a99b3324923b4749f008fdbd7aa9cb35e01d7a284a04f9", size = 249349, upload-time = "2025-12-08T13:14:04.015Z" }, + { url = "https://files.pythonhosted.org/packages/86/0d/7f6c42b8d59f4c7e43ea3059f573c0dcfed98ba46eb43c68c69e52ae095c/coverage-7.13.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:4b5de7d4583e60d5fd246dd57fcd3a8aa23c6e118a8c72b38adf666ba8e7e927", size = 251011, upload-time = "2025-12-08T13:14:05.505Z" }, + { url = "https://files.pythonhosted.org/packages/d7/f1/4bb2dff379721bb0b5c649d5c5eaf438462cad824acf32eb1b7ca0c7078e/coverage-7.13.0-cp314-cp314-win32.whl", hash = "sha256:a6c6e16b663be828a8f0b6c5027d36471d4a9f90d28444aa4ced4d48d7d6ae8f", size = 221091, upload-time = "2025-12-08T13:14:07.127Z" }, + { url = "https://files.pythonhosted.org/packages/ba/44/c239da52f373ce379c194b0ee3bcc121020e397242b85f99e0afc8615066/coverage-7.13.0-cp314-cp314-win_amd64.whl", hash = "sha256:0900872f2fdb3ee5646b557918d02279dc3af3dfb39029ac4e945458b13f73bc", size = 221904, upload-time = "2025-12-08T13:14:08.542Z" }, + { url = "https://files.pythonhosted.org/packages/89/1f/b9f04016d2a29c2e4a0307baefefad1a4ec5724946a2b3e482690486cade/coverage-7.13.0-cp314-cp314-win_arm64.whl", hash = "sha256:3a10260e6a152e5f03f26db4a407c4c62d3830b9af9b7c0450b183615f05d43b", size = 220480, upload-time = "2025-12-08T13:14:10.958Z" }, + { url = "https://files.pythonhosted.org/packages/16/d4/364a1439766c8e8647860584171c36010ca3226e6e45b1753b1b249c5161/coverage-7.13.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:9097818b6cc1cfb5f174e3263eba4a62a17683bcfe5c4b5d07f4c97fa51fbf28", size = 219074, upload-time = "2025-12-08T13:14:13.345Z" }, + { url = "https://files.pythonhosted.org/packages/ce/f4/71ba8be63351e099911051b2089662c03d5671437a0ec2171823c8e03bec/coverage-7.13.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:0018f73dfb4301a89292c73be6ba5f58722ff79f51593352759c1790ded1cabe", size = 219342, upload-time = "2025-12-08T13:14:15.02Z" }, + { url = "https://files.pythonhosted.org/packages/5e/25/127d8ed03d7711a387d96f132589057213e3aef7475afdaa303412463f22/coverage-7.13.0-cp314-cp314t-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:166ad2a22ee770f5656e1257703139d3533b4a0b6909af67c6b4a3adc1c98657", size = 260713, upload-time = "2025-12-08T13:14:16.907Z" }, + { url = "https://files.pythonhosted.org/packages/fd/db/559fbb6def07d25b2243663b46ba9eb5a3c6586c0c6f4e62980a68f0ee1c/coverage-7.13.0-cp314-cp314t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:f6aaef16d65d1787280943f1c8718dc32e9cf141014e4634d64446702d26e0ff", size = 262825, upload-time = "2025-12-08T13:14:18.68Z" }, + { url = "https://files.pythonhosted.org/packages/37/99/6ee5bf7eff884766edb43bd8736b5e1c5144d0fe47498c3779326fe75a35/coverage-7.13.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:e999e2dcc094002d6e2c7bbc1fb85b58ba4f465a760a8014d97619330cdbbbf3", size = 265233, upload-time = "2025-12-08T13:14:20.55Z" }, + { url = "https://files.pythonhosted.org/packages/d8/90/92f18fe0356ea69e1f98f688ed80cec39f44e9f09a1f26a1bbf017cc67f2/coverage-7.13.0-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:00c3d22cf6fb1cf3bf662aaaa4e563be8243a5ed2630339069799835a9cc7f9b", size = 259779, upload-time = "2025-12-08T13:14:22.367Z" }, + { url = "https://files.pythonhosted.org/packages/90/5d/b312a8b45b37a42ea7d27d7d3ff98ade3a6c892dd48d1d503e773503373f/coverage-7.13.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:22ccfe8d9bb0d6134892cbe1262493a8c70d736b9df930f3f3afae0fe3ac924d", size = 262700, upload-time = "2025-12-08T13:14:24.309Z" }, + { url = "https://files.pythonhosted.org/packages/63/f8/b1d0de5c39351eb71c366f872376d09386640840a2e09b0d03973d791e20/coverage-7.13.0-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:9372dff5ea15930fea0445eaf37bbbafbc771a49e70c0aeed8b4e2c2614cc00e", size = 260302, upload-time = "2025-12-08T13:14:26.068Z" }, + { url = "https://files.pythonhosted.org/packages/aa/7c/d42f4435bc40c55558b3109a39e2d456cddcec37434f62a1f1230991667a/coverage-7.13.0-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:69ac2c492918c2461bc6ace42d0479638e60719f2a4ef3f0815fa2df88e9f940", size = 259136, upload-time = "2025-12-08T13:14:27.604Z" }, + { url = "https://files.pythonhosted.org/packages/b8/d3/23413241dc04d47cfe19b9a65b32a2edd67ecd0b817400c2843ebc58c847/coverage-7.13.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:739c6c051a7540608d097b8e13c76cfa85263ced467168dc6b477bae3df7d0e2", size = 261467, upload-time = "2025-12-08T13:14:29.09Z" }, + { url = "https://files.pythonhosted.org/packages/13/e6/6e063174500eee216b96272c0d1847bf215926786f85c2bd024cf4d02d2f/coverage-7.13.0-cp314-cp314t-win32.whl", hash = "sha256:fe81055d8c6c9de76d60c94ddea73c290b416e061d40d542b24a5871bad498b7", size = 221875, upload-time = "2025-12-08T13:14:31.106Z" }, + { url = "https://files.pythonhosted.org/packages/3b/46/f4fb293e4cbe3620e3ac2a3e8fd566ed33affb5861a9b20e3dd6c1896cbc/coverage-7.13.0-cp314-cp314t-win_amd64.whl", hash = "sha256:445badb539005283825959ac9fa4a28f712c214b65af3a2c464f1adc90f5fcbc", size = 222982, upload-time = "2025-12-08T13:14:33.1Z" }, + { url = "https://files.pythonhosted.org/packages/68/62/5b3b9018215ed9733fbd1ae3b2ed75c5de62c3b55377a52cae732e1b7805/coverage-7.13.0-cp314-cp314t-win_arm64.whl", hash = "sha256:de7f6748b890708578fc4b7bb967d810aeb6fcc9bff4bb77dbca77dab2f9df6a", size = 221016, upload-time = "2025-12-08T13:14:34.601Z" }, + { url = "https://files.pythonhosted.org/packages/8d/4c/1968f32fb9a2604645827e11ff84a31e59d532e01995f904723b4f5328b3/coverage-7.13.0-py3-none-any.whl", hash = "sha256:850d2998f380b1e266459ca5b47bc9e7daf9af1d070f66317972f382d46f1904", size = 210068, upload-time = "2025-12-08T13:14:36.236Z" }, +] + +[package.optional-dependencies] +toml = [ + { name = "tomli", marker = "python_full_version <= '3.11'" }, +] + +[[package]] +name = "decli" +version = "0.6.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/0c/59/d4ffff1dee2c8f6f2dd8f87010962e60f7b7847504d765c91ede5a466730/decli-0.6.3.tar.gz", hash = "sha256:87f9d39361adf7f16b9ca6e3b614badf7519da13092f2db3c80ca223c53c7656", size = 7564, upload-time = "2025-06-01T15:23:41.25Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d8/fa/ec878c28bc7f65b77e7e17af3522c9948a9711b9fa7fc4c5e3140a7e3578/decli-0.6.3-py3-none-any.whl", hash = "sha256:5152347c7bb8e3114ad65db719e5709b28d7f7f45bdb709f70167925e55640f3", size = 7989, upload-time = "2025-06-01T15:23:40.228Z" }, +] + +[[package]] +name = "decorator" +version = "5.2.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/43/fa/6d96a0978d19e17b68d634497769987b16c8f4cd0a7a05048bec693caa6b/decorator-5.2.1.tar.gz", hash = "sha256:65f266143752f734b0a7cc83c46f4618af75b8c5911b00ccb61d0ac9b6da0360", size = 56711, upload-time = "2025-02-24T04:41:34.073Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/4e/8c/f3147f5c4b73e7550fe5f9352eaa956ae838d5c51eb58e7a25b9f3e2643b/decorator-5.2.1-py3-none-any.whl", hash = "sha256:d316bb415a2d9e2d2b3abcc4084c6502fc09240e292cd76a76afc106a1c8e04a", size = 9190, upload-time = "2025-02-24T04:41:32.565Z" }, +] + +[[package]] +name = "deprecated" +version = "1.3.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "wrapt" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/49/85/12f0a49a7c4ffb70572b6c2ef13c90c88fd190debda93b23f026b25f9634/deprecated-1.3.1.tar.gz", hash = "sha256:b1b50e0ff0c1fddaa5708a2c6b0a6588bb09b892825ab2b214ac9ea9d92a5223", size = 2932523, upload-time = "2025-10-30T08:19:02.757Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/84/d0/205d54408c08b13550c733c4b85429e7ead111c7f0014309637425520a9a/deprecated-1.3.1-py2.py3-none-any.whl", hash = "sha256:597bfef186b6f60181535a29fbe44865ce137a5079f295b479886c82729d5f3f", size = 11298, upload-time = "2025-10-30T08:19:00.758Z" }, +] + +[[package]] +name = "distlib" +version = "0.4.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/96/8e/709914eb2b5749865801041647dc7f4e6d00b549cfe88b65ca192995f07c/distlib-0.4.0.tar.gz", hash = "sha256:feec40075be03a04501a973d81f633735b4b69f98b05450592310c0f401a4e0d", size = 614605, upload-time = "2025-07-17T16:52:00.465Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/33/6b/e0547afaf41bf2c42e52430072fa5658766e3d65bd4b03a563d1b6336f57/distlib-0.4.0-py2.py3-none-any.whl", hash = "sha256:9659f7d87e46584a30b5780e43ac7a2143098441670ff0a49d5f9034c54a6c16", size = 469047, upload-time = "2025-07-17T16:51:58.613Z" }, +] + +[[package]] +name = "exceptiongroup" +version = "1.3.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "typing-extensions", marker = "python_full_version < '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/50/79/66800aadf48771f6b62f7eb014e352e5d06856655206165d775e675a02c9/exceptiongroup-1.3.1.tar.gz", hash = "sha256:8b412432c6055b0b7d14c310000ae93352ed6754f70fa8f7c34141f91c4e3219", size = 30371, upload-time = "2025-11-21T23:01:54.787Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8a/0e/97c33bf5009bdbac74fd2beace167cab3f978feb69cc36f1ef79360d6c4e/exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598", size = 16740, upload-time = "2025-11-21T23:01:53.443Z" }, +] + +[[package]] +name = "execnet" +version = "2.1.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/bf/89/780e11f9588d9e7128a3f87788354c7946a9cbb1401ad38a48c4db9a4f07/execnet-2.1.2.tar.gz", hash = "sha256:63d83bfdd9a23e35b9c6a3261412324f964c2ec8dcd8d3c6916ee9373e0befcd", size = 166622, upload-time = "2025-11-12T09:56:37.75Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ab/84/02fc1827e8cdded4aa65baef11296a9bbe595c474f0d6d758af082d849fd/execnet-2.1.2-py3-none-any.whl", hash = "sha256:67fba928dd5a544b783f6056f449e5e3931a5c378b128bc18501f7ea79e296ec", size = 40708, upload-time = "2025-11-12T09:56:36.333Z" }, +] + +[[package]] +name = "executing" +version = "2.2.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cc/28/c14e053b6762b1044f34a13aab6859bbf40456d37d23aa286ac24cfd9a5d/executing-2.2.1.tar.gz", hash = "sha256:3632cc370565f6648cc328b32435bd120a1e4ebb20c77e3fdde9a13cd1e533c4", size = 1129488, upload-time = "2025-09-01T09:48:10.866Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c1/ea/53f2148663b321f21b5a606bd5f191517cf40b7072c0497d3c92c4a13b1e/executing-2.2.1-py2.py3-none-any.whl", hash = "sha256:760643d3452b4d777d295bb167ccc74c64a81df23fb5e08eff250c425a4b2017", size = 28317, upload-time = "2025-09-01T09:48:08.5Z" }, +] + +[[package]] +name = "filelock" +version = "3.20.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/1d/65/ce7f1b70157833bf3cb851b556a37d4547ceafc158aa9b34b36782f23696/filelock-3.20.3.tar.gz", hash = "sha256:18c57ee915c7ec61cff0ecf7f0f869936c7c30191bb0cf406f1341778d0834e1", size = 19485, upload-time = "2026-01-09T17:55:05.421Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b5/36/7fb70f04bf00bc646cd5bb45aa9eddb15e19437a28b8fb2b4a5249fac770/filelock-3.20.3-py3-none-any.whl", hash = "sha256:4b0dda527ee31078689fc205ec4f1c1bf7d56cf88b6dc9426c4f230e46c2dce1", size = 16701, upload-time = "2026-01-09T17:55:04.334Z" }, +] + +[[package]] +name = "freezegun" +version = "1.5.5" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "python-dateutil" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/95/dd/23e2f4e357f8fd3bdff613c1fe4466d21bfb00a6177f238079b17f7b1c84/freezegun-1.5.5.tar.gz", hash = "sha256:ac7742a6cc6c25a2c35e9292dfd554b897b517d2dec26891a2e8debf205cb94a", size = 35914, upload-time = "2025-08-09T10:39:08.338Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5e/2e/b41d8a1a917d6581fc27a35d05561037b048e47df50f27f8ac9c7e27a710/freezegun-1.5.5-py3-none-any.whl", hash = "sha256:cd557f4a75cf074e84bc374249b9dd491eaeacd61376b9eb3c423282211619d2", size = 19266, upload-time = "2025-08-09T10:39:06.636Z" }, +] + +[[package]] +name = "ghp-import" +version = "2.1.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "python-dateutil" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d9/29/d40217cbe2f6b1359e00c6c307bb3fc876ba74068cbab3dde77f03ca0dc4/ghp-import-2.1.0.tar.gz", hash = "sha256:9c535c4c61193c2df8871222567d7fd7e5014d835f97dc7b7439069e2413d343", size = 10943, upload-time = "2022-05-02T15:47:16.11Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb/ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", size = 11034, upload-time = "2022-05-02T15:47:14.552Z" }, +] + +[[package]] +name = "gitdb" +version = "4.0.12" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "smmap" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/94/63b0fc47eb32792c7ba1fe1b694daec9a63620db1e313033d18140c2320a/gitdb-4.0.12.tar.gz", hash = "sha256:5ef71f855d191a3326fcfbc0d5da835f26b13fbcba60c32c21091c349ffdb571", size = 394684, upload-time = "2025-01-02T07:20:46.413Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a0/61/5c78b91c3143ed5c14207f463aecfc8f9dbb5092fb2869baf37c273b2705/gitdb-4.0.12-py3-none-any.whl", hash = "sha256:67073e15955400952c6565cc3e707c554a4eea2e428946f7a4c162fab9bd9bcf", size = 62794, upload-time = "2025-01-02T07:20:43.624Z" }, +] + +[[package]] +name = "gitpython" +version = "3.1.46" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "gitdb" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/df/b5/59d16470a1f0dfe8c793f9ef56fd3826093fc52b3bd96d6b9d6c26c7e27b/gitpython-3.1.46.tar.gz", hash = "sha256:400124c7d0ef4ea03f7310ac2fbf7151e09ff97f2a3288d64a440c584a29c37f", size = 215371, upload-time = "2026-01-01T15:37:32.073Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/6a/09/e21df6aef1e1ffc0c816f0522ddc3f6dcded766c3261813131c78a704470/gitpython-3.1.46-py3-none-any.whl", hash = "sha256:79812ed143d9d25b6d176a10bb511de0f9c67b1fa641d82097b0ab90398a2058", size = 208620, upload-time = "2026-01-01T15:37:30.574Z" }, +] + +[[package]] +name = "identify" +version = "2.6.16" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/5b/8d/e8b97e6bd3fb6fb271346f7981362f1e04d6a7463abd0de79e1fda17c067/identify-2.6.16.tar.gz", hash = "sha256:846857203b5511bbe94d5a352a48ef2359532bc8f6727b5544077a0dcfb24980", size = 99360, upload-time = "2026-01-12T18:58:58.201Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b8/58/40fbbcefeda82364720eba5cf2270f98496bdfa19ea75b4cccae79c698e6/identify-2.6.16-py2.py3-none-any.whl", hash = "sha256:391ee4d77741d994189522896270b787aed8670389bfd60f326d677d64a6dfb0", size = 99202, upload-time = "2026-01-12T18:58:56.627Z" }, +] + +[[package]] +name = "idna" +version = "3.11" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6f/6d/0703ccc57f3a7233505399edb88de3cbd678da106337b9fcde432b65ed60/idna-3.11.tar.gz", hash = "sha256:795dafcc9c04ed0c1fb032c2aa73654d8e8c5023a7df64a53f39190ada629902", size = 194582, upload-time = "2025-10-12T14:55:20.501Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0e/61/66938bbb5fc52dbdf84594873d5b51fb1f7c7794e9c0f5bd885f30bc507b/idna-3.11-py3-none-any.whl", hash = "sha256:771a87f49d9defaf64091e6e6fe9c18d4833f140bd19464795bc32d966ca37ea", size = 71008, upload-time = "2025-10-12T14:55:18.883Z" }, +] + +[[package]] +name = "iniconfig" +version = "2.3.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/72/34/14ca021ce8e5dfedc35312d08ba8bf51fdd999c576889fc2c24cb97f4f10/iniconfig-2.3.0.tar.gz", hash = "sha256:c76315c77db068650d49c5b56314774a7804df16fee4402c1f19d6d15d8c4730", size = 20503, upload-time = "2025-10-18T21:55:43.219Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cb/b1/3846dd7f199d53cb17f49cba7e651e9ce294d8497c8c150530ed11865bb8/iniconfig-2.3.0-py3-none-any.whl", hash = "sha256:f631c04d2c48c52b84d0d0549c99ff3859c98df65b3101406327ecc7d53fbf12", size = 7484, upload-time = "2025-10-18T21:55:41.639Z" }, +] + +[[package]] +name = "ipython" +version = "8.37.0" +source = { registry = "https://pypi.org/simple" } +resolution-markers = [ + "python_full_version < '3.11'", +] +dependencies = [ + { name = "colorama", marker = "python_full_version < '3.11' and sys_platform == 'win32'" }, + { name = "decorator", marker = "python_full_version < '3.11'" }, + { name = "exceptiongroup", marker = "python_full_version < '3.11'" }, + { name = "jedi", marker = "python_full_version < '3.11'" }, + { name = "matplotlib-inline", marker = "python_full_version < '3.11'" }, + { name = "pexpect", marker = "python_full_version < '3.11' and sys_platform != 'emscripten' and sys_platform != 'win32'" }, + { name = "prompt-toolkit", marker = "python_full_version < '3.11'" }, + { name = "pygments", marker = "python_full_version < '3.11'" }, + { name = "stack-data", marker = "python_full_version < '3.11'" }, + { name = "traitlets", marker = "python_full_version < '3.11'" }, + { name = "typing-extensions", marker = "python_full_version < '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/85/31/10ac88f3357fc276dc8a64e8880c82e80e7459326ae1d0a211b40abf6665/ipython-8.37.0.tar.gz", hash = "sha256:ca815841e1a41a1e6b73a0b08f3038af9b2252564d01fc405356d34033012216", size = 5606088, upload-time = "2025-05-31T16:39:09.613Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/91/d0/274fbf7b0b12643cbbc001ce13e6a5b1607ac4929d1b11c72460152c9fc3/ipython-8.37.0-py3-none-any.whl", hash = "sha256:ed87326596b878932dbcb171e3e698845434d8c61b8d8cd474bf663041a9dcf2", size = 831864, upload-time = "2025-05-31T16:39:06.38Z" }, +] + +[[package]] +name = "ipython" +version = "9.8.0" +source = { registry = "https://pypi.org/simple" } +resolution-markers = [ + "python_full_version >= '3.11'", +] +dependencies = [ + { name = "colorama", marker = "python_full_version >= '3.11' and sys_platform == 'win32'" }, + { name = "decorator", marker = "python_full_version >= '3.11'" }, + { name = "ipython-pygments-lexers", marker = "python_full_version >= '3.11'" }, + { name = "jedi", marker = "python_full_version >= '3.11'" }, + { name = "matplotlib-inline", marker = "python_full_version >= '3.11'" }, + { name = "pexpect", marker = "python_full_version >= '3.11' and sys_platform != 'emscripten' and sys_platform != 'win32'" }, + { name = "prompt-toolkit", marker = "python_full_version >= '3.11'" }, + { name = "pygments", marker = "python_full_version >= '3.11'" }, + { name = "stack-data", marker = "python_full_version >= '3.11'" }, + { name = "traitlets", marker = "python_full_version >= '3.11'" }, + { name = "typing-extensions", marker = "python_full_version == '3.11.*'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/12/51/a703c030f4928646d390b4971af4938a1b10c9dfce694f0d99a0bb073cb2/ipython-9.8.0.tar.gz", hash = "sha256:8e4ce129a627eb9dd221c41b1d2cdaed4ef7c9da8c17c63f6f578fe231141f83", size = 4424940, upload-time = "2025-12-03T10:18:24.353Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f1/df/8ee1c5dd1e3308b5d5b2f2dfea323bb2f3827da8d654abb6642051199049/ipython-9.8.0-py3-none-any.whl", hash = "sha256:ebe6d1d58d7d988fbf23ff8ff6d8e1622cfdb194daf4b7b73b792c4ec3b85385", size = 621374, upload-time = "2025-12-03T10:18:22.335Z" }, +] + +[[package]] +name = "ipython-pygments-lexers" +version = "1.1.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pygments", marker = "python_full_version >= '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ef/4c/5dd1d8af08107f88c7f741ead7a40854b8ac24ddf9ae850afbcf698aa552/ipython_pygments_lexers-1.1.1.tar.gz", hash = "sha256:09c0138009e56b6854f9535736f4171d855c8c08a563a0dcd8022f78355c7e81", size = 8393, upload-time = "2025-01-17T11:24:34.505Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d9/33/1f075bf72b0b747cb3288d011319aaf64083cf2efef8354174e3ed4540e2/ipython_pygments_lexers-1.1.1-py3-none-any.whl", hash = "sha256:a9462224a505ade19a605f71f8fa63c2048833ce50abc86768a0d81d876dc81c", size = 8074, upload-time = "2025-01-17T11:24:33.271Z" }, +] + +[[package]] +name = "jedi" +version = "0.19.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "parso" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/3a/79a912fbd4d8dd6fbb02bf69afd3bb72cf0c729bb3063c6f4498603db17a/jedi-0.19.2.tar.gz", hash = "sha256:4770dc3de41bde3966b02eb84fbcf557fb33cce26ad23da12c742fb50ecb11f0", size = 1231287, upload-time = "2024-11-11T01:41:42.873Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c0/5a/9cac0c82afec3d09ccd97c8b6502d48f165f9124db81b4bcb90b4af974ee/jedi-0.19.2-py2.py3-none-any.whl", hash = "sha256:a8ef22bde8490f57fe5c7681a3c83cb58874daf72b4784de3cce5b6ef6edb5b9", size = 1572278, upload-time = "2024-11-11T01:41:40.175Z" }, +] + +[[package]] +name = "jinja2" +version = "3.1.6" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markupsafe" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/df/bf/f7da0350254c0ed7c72f3e33cef02e048281fec7ecec5f032d4aac52226b/jinja2-3.1.6.tar.gz", hash = "sha256:0137fb05990d35f1275a587e9aee6d56da821fc83491a0fb838183be43f66d6d", size = 245115, upload-time = "2025-03-05T20:05:02.478Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/62/a1/3d680cbfd5f4b8f15abc1d571870c5fc3e594bb582bc3b64ea099db13e56/jinja2-3.1.6-py3-none-any.whl", hash = "sha256:85ece4451f492d0c13c5dd7c13a64681a86afae63a5f347908daf103ce6d2f67", size = 134899, upload-time = "2025-03-05T20:05:00.369Z" }, +] + +[[package]] +name = "librt" +version = "0.7.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/93/e4/b59bdf1197fdf9888452ea4d2048cdad61aef85eb83e99dc52551d7fdc04/librt-0.7.4.tar.gz", hash = "sha256:3871af56c59864d5fd21d1ac001eb2fb3b140d52ba0454720f2e4a19812404ba", size = 145862, upload-time = "2025-12-15T16:52:43.862Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/06/1e/3e61dff6c07a3b400fe907d3164b92b3b3023ef86eac1ee236869dc276f7/librt-0.7.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:dc300cb5a5a01947b1ee8099233156fdccd5001739e5f596ecfbc0dab07b5a3b", size = 54708, upload-time = "2025-12-15T16:51:03.752Z" }, + { url = "https://files.pythonhosted.org/packages/87/98/ab2428b0a80d0fd67decaeea84a5ec920e3dd4d95ecfd074c71f51bd7315/librt-0.7.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ee8d3323d921e0f6919918a97f9b5445a7dfe647270b2629ec1008aa676c0bc0", size = 56656, upload-time = "2025-12-15T16:51:05.038Z" }, + { url = "https://files.pythonhosted.org/packages/c1/ce/de1fad3a16e4fb5b6605bd6cbe6d0e5207cc8eca58993835749a1da0812b/librt-0.7.4-cp310-cp310-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:95cb80854a355b284c55f79674f6187cc9574df4dc362524e0cce98c89ee8331", size = 161024, upload-time = "2025-12-15T16:51:06.31Z" }, + { url = "https://files.pythonhosted.org/packages/88/00/ddfcdc1147dd7fb68321d7b064b12f0b9101d85f466a46006f86096fde8d/librt-0.7.4-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:3ca1caedf8331d8ad6027f93b52d68ed8f8009f5c420c246a46fe9d3be06be0f", size = 169529, upload-time = "2025-12-15T16:51:07.907Z" }, + { url = "https://files.pythonhosted.org/packages/dd/b3/915702c7077df2483b015030d1979404474f490fe9a071e9576f7b26fef6/librt-0.7.4-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c2a6f1236151e6fe1da289351b5b5bce49651c91554ecc7b70a947bced6fe212", size = 183270, upload-time = "2025-12-15T16:51:09.164Z" }, + { url = "https://files.pythonhosted.org/packages/45/19/ab2f217e8ec509fca4ea9e2e5022b9f72c1a7b7195f5a5770d299df807ea/librt-0.7.4-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:7766b57aeebaf3f1dac14fdd4a75c9a61f2ed56d8ebeefe4189db1cb9d2a3783", size = 179038, upload-time = "2025-12-15T16:51:10.538Z" }, + { url = "https://files.pythonhosted.org/packages/10/1c/d40851d187662cf50312ebbc0b277c7478dd78dbaaf5ee94056f1d7f2f83/librt-0.7.4-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:1c4c89fb01157dd0a3bfe9e75cd6253b0a1678922befcd664eca0772a4c6c979", size = 173502, upload-time = "2025-12-15T16:51:11.888Z" }, + { url = "https://files.pythonhosted.org/packages/07/52/d5880835c772b22c38db18660420fa6901fd9e9a433b65f0ba9b0f4da764/librt-0.7.4-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:f7fa8beef580091c02b4fd26542de046b2abfe0aaefa02e8bcf68acb7618f2b3", size = 193570, upload-time = "2025-12-15T16:51:13.168Z" }, + { url = "https://files.pythonhosted.org/packages/f1/35/22d3c424b82f86ce019c0addadf001d459dfac8036aecc07fadc5c541053/librt-0.7.4-cp310-cp310-win32.whl", hash = "sha256:543c42fa242faae0466fe72d297976f3c710a357a219b1efde3a0539a68a6997", size = 42596, upload-time = "2025-12-15T16:51:14.422Z" }, + { url = "https://files.pythonhosted.org/packages/95/b1/e7c316ac5fe60ac1fdfe515198087205220803c4cf923ee63e1cb8380b17/librt-0.7.4-cp310-cp310-win_amd64.whl", hash = "sha256:25cc40d8eb63f0a7ea4c8f49f524989b9df901969cb860a2bc0e4bad4b8cb8a8", size = 48972, upload-time = "2025-12-15T16:51:15.516Z" }, + { url = "https://files.pythonhosted.org/packages/84/64/44089b12d8b4714a7f0e2f33fb19285ba87702d4be0829f20b36ebeeee07/librt-0.7.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:3485b9bb7dfa66167d5500ffdafdc35415b45f0da06c75eb7df131f3357b174a", size = 54709, upload-time = "2025-12-15T16:51:16.699Z" }, + { url = "https://files.pythonhosted.org/packages/26/ef/6fa39fb5f37002f7d25e0da4f24d41b457582beea9369eeb7e9e73db5508/librt-0.7.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:188b4b1a770f7f95ea035d5bbb9d7367248fc9d12321deef78a269ebf46a5729", size = 56663, upload-time = "2025-12-15T16:51:17.856Z" }, + { url = "https://files.pythonhosted.org/packages/9d/e4/cbaca170a13bee2469c90df9e47108610b4422c453aea1aec1779ac36c24/librt-0.7.4-cp311-cp311-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:1b668b1c840183e4e38ed5a99f62fac44c3a3eef16870f7f17cfdfb8b47550ed", size = 161703, upload-time = "2025-12-15T16:51:19.421Z" }, + { url = "https://files.pythonhosted.org/packages/d0/32/0b2296f9cc7e693ab0d0835e355863512e5eac90450c412777bd699c76ae/librt-0.7.4-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0e8f864b521f6cfedb314d171630f827efee08f5c3462bcbc2244ab8e1768cd6", size = 171027, upload-time = "2025-12-15T16:51:20.721Z" }, + { url = "https://files.pythonhosted.org/packages/d8/33/c70b6d40f7342716e5f1353c8da92d9e32708a18cbfa44897a93ec2bf879/librt-0.7.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4df7c9def4fc619a9c2ab402d73a0c5b53899abe090e0100323b13ccb5a3dd82", size = 184700, upload-time = "2025-12-15T16:51:22.272Z" }, + { url = "https://files.pythonhosted.org/packages/e4/c8/555c405155da210e4c4113a879d378f54f850dbc7b794e847750a8fadd43/librt-0.7.4-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:f79bc3595b6ed159a1bf0cdc70ed6ebec393a874565cab7088a219cca14da727", size = 180719, upload-time = "2025-12-15T16:51:23.561Z" }, + { url = "https://files.pythonhosted.org/packages/6b/88/34dc1f1461c5613d1b73f0ecafc5316cc50adcc1b334435985b752ed53e5/librt-0.7.4-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:77772a4b8b5f77d47d883846928c36d730b6e612a6388c74cba33ad9eb149c11", size = 174535, upload-time = "2025-12-15T16:51:25.031Z" }, + { url = "https://files.pythonhosted.org/packages/b6/5a/f3fafe80a221626bcedfa9fe5abbf5f04070989d44782f579b2d5920d6d0/librt-0.7.4-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:064a286e6ab0b4c900e228ab4fa9cb3811b4b83d3e0cc5cd816b2d0f548cb61c", size = 195236, upload-time = "2025-12-15T16:51:26.328Z" }, + { url = "https://files.pythonhosted.org/packages/d8/77/5c048d471ce17f4c3a6e08419be19add4d291e2f7067b877437d482622ac/librt-0.7.4-cp311-cp311-win32.whl", hash = "sha256:42da201c47c77b6cc91fc17e0e2b330154428d35d6024f3278aa2683e7e2daf2", size = 42930, upload-time = "2025-12-15T16:51:27.853Z" }, + { url = "https://files.pythonhosted.org/packages/fb/3b/514a86305a12c3d9eac03e424b07cd312c7343a9f8a52719aa079590a552/librt-0.7.4-cp311-cp311-win_amd64.whl", hash = "sha256:d31acb5886c16ae1711741f22504195af46edec8315fe69b77e477682a87a83e", size = 49240, upload-time = "2025-12-15T16:51:29.037Z" }, + { url = "https://files.pythonhosted.org/packages/ba/01/3b7b1914f565926b780a734fac6e9a4d2c7aefe41f4e89357d73697a9457/librt-0.7.4-cp311-cp311-win_arm64.whl", hash = "sha256:114722f35093da080a333b3834fff04ef43147577ed99dd4db574b03a5f7d170", size = 42613, upload-time = "2025-12-15T16:51:30.194Z" }, + { url = "https://files.pythonhosted.org/packages/f3/e7/b805d868d21f425b7e76a0ea71a2700290f2266a4f3c8357fcf73efc36aa/librt-0.7.4-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:7dd3b5c37e0fb6666c27cf4e2c88ae43da904f2155c4cfc1e5a2fdce3b9fcf92", size = 55688, upload-time = "2025-12-15T16:51:31.571Z" }, + { url = "https://files.pythonhosted.org/packages/59/5e/69a2b02e62a14cfd5bfd9f1e9adea294d5bcfeea219c7555730e5d068ee4/librt-0.7.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:a9c5de1928c486201b23ed0cc4ac92e6e07be5cd7f3abc57c88a9cf4f0f32108", size = 57141, upload-time = "2025-12-15T16:51:32.714Z" }, + { url = "https://files.pythonhosted.org/packages/6e/6b/05dba608aae1272b8ea5ff8ef12c47a4a099a04d1e00e28a94687261d403/librt-0.7.4-cp312-cp312-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:078ae52ffb3f036396cc4aed558e5b61faedd504a3c1f62b8ae34bf95ae39d94", size = 165322, upload-time = "2025-12-15T16:51:33.986Z" }, + { url = "https://files.pythonhosted.org/packages/8f/bc/199533d3fc04a4cda8d7776ee0d79955ab0c64c79ca079366fbc2617e680/librt-0.7.4-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ce58420e25097b2fc201aef9b9f6d65df1eb8438e51154e1a7feb8847e4a55ab", size = 174216, upload-time = "2025-12-15T16:51:35.384Z" }, + { url = "https://files.pythonhosted.org/packages/62/ec/09239b912a45a8ed117cb4a6616d9ff508f5d3131bd84329bf2f8d6564f1/librt-0.7.4-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b719c8730c02a606dc0e8413287e8e94ac2d32a51153b300baf1f62347858fba", size = 189005, upload-time = "2025-12-15T16:51:36.687Z" }, + { url = "https://files.pythonhosted.org/packages/46/2e/e188313d54c02f5b0580dd31476bb4b0177514ff8d2be9f58d4a6dc3a7ba/librt-0.7.4-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3749ef74c170809e6dee68addec9d2458700a8de703de081c888e92a8b015cf9", size = 183960, upload-time = "2025-12-15T16:51:37.977Z" }, + { url = "https://files.pythonhosted.org/packages/eb/84/f1d568d254518463d879161d3737b784137d236075215e56c7c9be191cee/librt-0.7.4-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:b35c63f557653c05b5b1b6559a074dbabe0afee28ee2a05b6c9ba21ad0d16a74", size = 177609, upload-time = "2025-12-15T16:51:40.584Z" }, + { url = "https://files.pythonhosted.org/packages/5d/43/060bbc1c002f0d757c33a1afe6bf6a565f947a04841139508fc7cef6c08b/librt-0.7.4-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:1ef704e01cb6ad39ad7af668d51677557ca7e5d377663286f0ee1b6b27c28e5f", size = 199269, upload-time = "2025-12-15T16:51:41.879Z" }, + { url = "https://files.pythonhosted.org/packages/ff/7f/708f8f02d8012ee9f366c07ea6a92882f48bd06cc1ff16a35e13d0fbfb08/librt-0.7.4-cp312-cp312-win32.whl", hash = "sha256:c66c2b245926ec15188aead25d395091cb5c9df008d3b3207268cd65557d6286", size = 43186, upload-time = "2025-12-15T16:51:43.149Z" }, + { url = "https://files.pythonhosted.org/packages/f1/a5/4e051b061c8b2509be31b2c7ad4682090502c0a8b6406edcf8c6b4fe1ef7/librt-0.7.4-cp312-cp312-win_amd64.whl", hash = "sha256:71a56f4671f7ff723451f26a6131754d7c1809e04e22ebfbac1db8c9e6767a20", size = 49455, upload-time = "2025-12-15T16:51:44.336Z" }, + { url = "https://files.pythonhosted.org/packages/d0/d2/90d84e9f919224a3c1f393af1636d8638f54925fdc6cd5ee47f1548461e5/librt-0.7.4-cp312-cp312-win_arm64.whl", hash = "sha256:419eea245e7ec0fe664eb7e85e7ff97dcdb2513ca4f6b45a8ec4a3346904f95a", size = 42828, upload-time = "2025-12-15T16:51:45.498Z" }, + { url = "https://files.pythonhosted.org/packages/fe/4d/46a53ccfbb39fd0b493fd4496eb76f3ebc15bb3e45d8c2e695a27587edf5/librt-0.7.4-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:d44a1b1ba44cbd2fc3cb77992bef6d6fdb1028849824e1dd5e4d746e1f7f7f0b", size = 55745, upload-time = "2025-12-15T16:51:46.636Z" }, + { url = "https://files.pythonhosted.org/packages/7f/2b/3ac7f5212b1828bf4f979cf87f547db948d3e28421d7a430d4db23346ce4/librt-0.7.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:c9cab4b3de1f55e6c30a84c8cee20e4d3b2476f4d547256694a1b0163da4fe32", size = 57166, upload-time = "2025-12-15T16:51:48.219Z" }, + { url = "https://files.pythonhosted.org/packages/e8/99/6523509097cbe25f363795f0c0d1c6a3746e30c2994e25b5aefdab119b21/librt-0.7.4-cp313-cp313-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:2857c875f1edd1feef3c371fbf830a61b632fb4d1e57160bb1e6a3206e6abe67", size = 165833, upload-time = "2025-12-15T16:51:49.443Z" }, + { url = "https://files.pythonhosted.org/packages/fe/35/323611e59f8fe032649b4fb7e77f746f96eb7588fcbb31af26bae9630571/librt-0.7.4-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b370a77be0a16e1ad0270822c12c21462dc40496e891d3b0caf1617c8cc57e20", size = 174818, upload-time = "2025-12-15T16:51:51.015Z" }, + { url = "https://files.pythonhosted.org/packages/41/e6/40fb2bb21616c6e06b6a64022802228066e9a31618f493e03f6b9661548a/librt-0.7.4-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d05acd46b9a52087bfc50c59dfdf96a2c480a601e8898a44821c7fd676598f74", size = 189607, upload-time = "2025-12-15T16:51:52.671Z" }, + { url = "https://files.pythonhosted.org/packages/32/48/1b47c7d5d28b775941e739ed2bfe564b091c49201b9503514d69e4ed96d7/librt-0.7.4-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:70969229cb23d9c1a80e14225838d56e464dc71fa34c8342c954fc50e7516dee", size = 184585, upload-time = "2025-12-15T16:51:54.027Z" }, + { url = "https://files.pythonhosted.org/packages/75/a6/ee135dfb5d3b54d5d9001dbe483806229c6beac3ee2ba1092582b7efeb1b/librt-0.7.4-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:4450c354b89dbb266730893862dbff06006c9ed5b06b6016d529b2bf644fc681", size = 178249, upload-time = "2025-12-15T16:51:55.248Z" }, + { url = "https://files.pythonhosted.org/packages/04/87/d5b84ec997338be26af982bcd6679be0c1db9a32faadab1cf4bb24f9e992/librt-0.7.4-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:adefe0d48ad35b90b6f361f6ff5a1bd95af80c17d18619c093c60a20e7a5b60c", size = 199851, upload-time = "2025-12-15T16:51:56.933Z" }, + { url = "https://files.pythonhosted.org/packages/86/63/ba1333bf48306fe398e3392a7427ce527f81b0b79d0d91618c4610ce9d15/librt-0.7.4-cp313-cp313-win32.whl", hash = "sha256:21ea710e96c1e050635700695095962a22ea420d4b3755a25e4909f2172b4ff2", size = 43249, upload-time = "2025-12-15T16:51:58.498Z" }, + { url = "https://files.pythonhosted.org/packages/f9/8a/de2c6df06cdfa9308c080e6b060fe192790b6a48a47320b215e860f0e98c/librt-0.7.4-cp313-cp313-win_amd64.whl", hash = "sha256:772e18696cf5a64afee908662fbcb1f907460ddc851336ee3a848ef7684c8e1e", size = 49417, upload-time = "2025-12-15T16:51:59.618Z" }, + { url = "https://files.pythonhosted.org/packages/31/66/8ee0949efc389691381ed686185e43536c20e7ad880c122dd1f31e65c658/librt-0.7.4-cp313-cp313-win_arm64.whl", hash = "sha256:52e34c6af84e12921748c8354aa6acf1912ca98ba60cdaa6920e34793f1a0788", size = 42824, upload-time = "2025-12-15T16:52:00.784Z" }, + { url = "https://files.pythonhosted.org/packages/74/81/6921e65c8708eb6636bbf383aa77e6c7dad33a598ed3b50c313306a2da9d/librt-0.7.4-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:4f1ee004942eaaed6e06c087d93ebc1c67e9a293e5f6b9b5da558df6bf23dc5d", size = 55191, upload-time = "2025-12-15T16:52:01.97Z" }, + { url = "https://files.pythonhosted.org/packages/0d/d6/3eb864af8a8de8b39cc8dd2e9ded1823979a27795d72c4eea0afa8c26c9f/librt-0.7.4-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:d854c6dc0f689bad7ed452d2a3ecff58029d80612d336a45b62c35e917f42d23", size = 56898, upload-time = "2025-12-15T16:52:03.356Z" }, + { url = "https://files.pythonhosted.org/packages/49/bc/b1d4c0711fdf79646225d576faee8747b8528a6ec1ceb6accfd89ade7102/librt-0.7.4-cp314-cp314-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:a4f7339d9e445280f23d63dea842c0c77379c4a47471c538fc8feedab9d8d063", size = 163725, upload-time = "2025-12-15T16:52:04.572Z" }, + { url = "https://files.pythonhosted.org/packages/2c/08/61c41cd8f0a6a41fc99ea78a2205b88187e45ba9800792410ed62f033584/librt-0.7.4-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39003fc73f925e684f8521b2dbf34f61a5deb8a20a15dcf53e0d823190ce8848", size = 172469, upload-time = "2025-12-15T16:52:05.863Z" }, + { url = "https://files.pythonhosted.org/packages/8b/c7/4ee18b4d57f01444230bc18cf59103aeab8f8c0f45e84e0e540094df1df1/librt-0.7.4-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:6bb15ee29d95875ad697d449fe6071b67f730f15a6961913a2b0205015ca0843", size = 186804, upload-time = "2025-12-15T16:52:07.192Z" }, + { url = "https://files.pythonhosted.org/packages/a1/af/009e8ba3fbf830c936842da048eda1b34b99329f402e49d88fafff6525d1/librt-0.7.4-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:02a69369862099e37d00765583052a99d6a68af7e19b887e1b78fee0146b755a", size = 181807, upload-time = "2025-12-15T16:52:08.554Z" }, + { url = "https://files.pythonhosted.org/packages/85/26/51ae25f813656a8b117c27a974f25e8c1e90abcd5a791ac685bf5b489a1b/librt-0.7.4-cp314-cp314-musllinux_1_2_i686.whl", hash = "sha256:ec72342cc4d62f38b25a94e28b9efefce41839aecdecf5e9627473ed04b7be16", size = 175595, upload-time = "2025-12-15T16:52:10.186Z" }, + { url = "https://files.pythonhosted.org/packages/48/93/36d6c71f830305f88996b15c8e017aa8d1e03e2e947b40b55bbf1a34cf24/librt-0.7.4-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:776dbb9bfa0fc5ce64234b446995d8d9f04badf64f544ca036bd6cff6f0732ce", size = 196504, upload-time = "2025-12-15T16:52:11.472Z" }, + { url = "https://files.pythonhosted.org/packages/08/11/8299e70862bb9d704735bf132c6be09c17b00fbc7cda0429a9df222fdc1b/librt-0.7.4-cp314-cp314-win32.whl", hash = "sha256:0f8cac84196d0ffcadf8469d9ded4d4e3a8b1c666095c2a291e22bf58e1e8a9f", size = 39738, upload-time = "2025-12-15T16:52:12.962Z" }, + { url = "https://files.pythonhosted.org/packages/54/d5/656b0126e4e0f8e2725cd2d2a1ec40f71f37f6f03f135a26b663c0e1a737/librt-0.7.4-cp314-cp314-win_amd64.whl", hash = "sha256:037f5cb6fe5abe23f1dc058054d50e9699fcc90d0677eee4e4f74a8677636a1a", size = 45976, upload-time = "2025-12-15T16:52:14.441Z" }, + { url = "https://files.pythonhosted.org/packages/60/86/465ff07b75c1067da8fa7f02913c4ead096ef106cfac97a977f763783bfb/librt-0.7.4-cp314-cp314-win_arm64.whl", hash = "sha256:a5deebb53d7a4d7e2e758a96befcd8edaaca0633ae71857995a0f16033289e44", size = 39073, upload-time = "2025-12-15T16:52:15.621Z" }, + { url = "https://files.pythonhosted.org/packages/b3/a0/24941f85960774a80d4b3c2aec651d7d980466da8101cae89e8b032a3e21/librt-0.7.4-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:b4c25312c7f4e6ab35ab16211bdf819e6e4eddcba3b2ea632fb51c9a2a97e105", size = 57369, upload-time = "2025-12-15T16:52:16.782Z" }, + { url = "https://files.pythonhosted.org/packages/77/a0/ddb259cae86ab415786c1547d0fe1b40f04a7b089f564fd5c0242a3fafb2/librt-0.7.4-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:618b7459bb392bdf373f2327e477597fff8f9e6a1878fffc1b711c013d1b0da4", size = 59230, upload-time = "2025-12-15T16:52:18.259Z" }, + { url = "https://files.pythonhosted.org/packages/31/11/77823cb530ab8a0c6fac848ac65b745be446f6f301753b8990e8809080c9/librt-0.7.4-cp314-cp314t-manylinux1_i686.manylinux_2_28_i686.manylinux_2_5_i686.whl", hash = "sha256:1437c3f72a30c7047f16fd3e972ea58b90172c3c6ca309645c1c68984f05526a", size = 183869, upload-time = "2025-12-15T16:52:19.457Z" }, + { url = "https://files.pythonhosted.org/packages/a4/ce/157db3614cf3034b3f702ae5ba4fefda4686f11eea4b7b96542324a7a0e7/librt-0.7.4-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c96cb76f055b33308f6858b9b594618f1b46e147a4d03a4d7f0c449e304b9b95", size = 194606, upload-time = "2025-12-15T16:52:20.795Z" }, + { url = "https://files.pythonhosted.org/packages/30/ef/6ec4c7e3d6490f69a4fd2803516fa5334a848a4173eac26d8ee6507bff6e/librt-0.7.4-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:28f990e6821204f516d09dc39966ef8b84556ffd648d5926c9a3f681e8de8906", size = 206776, upload-time = "2025-12-15T16:52:22.229Z" }, + { url = "https://files.pythonhosted.org/packages/ad/22/750b37bf549f60a4782ab80e9d1e9c44981374ab79a7ea68670159905918/librt-0.7.4-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:bc4aebecc79781a1b77d7d4e7d9fe080385a439e198d993b557b60f9117addaf", size = 203205, upload-time = "2025-12-15T16:52:23.603Z" }, + { url = "https://files.pythonhosted.org/packages/7a/87/2e8a0f584412a93df5faad46c5fa0a6825fdb5eba2ce482074b114877f44/librt-0.7.4-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:022cc673e69283a42621dd453e2407cf1647e77f8bd857d7ad7499901e62376f", size = 196696, upload-time = "2025-12-15T16:52:24.951Z" }, + { url = "https://files.pythonhosted.org/packages/e5/ca/7bf78fa950e43b564b7de52ceeb477fb211a11f5733227efa1591d05a307/librt-0.7.4-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:2b3ca211ae8ea540569e9c513da052699b7b06928dcda61247cb4f318122bdb5", size = 217191, upload-time = "2025-12-15T16:52:26.194Z" }, + { url = "https://files.pythonhosted.org/packages/d6/49/3732b0e8424ae35ad5c3166d9dd5bcdae43ce98775e0867a716ff5868064/librt-0.7.4-cp314-cp314t-win32.whl", hash = "sha256:8a461f6456981d8c8e971ff5a55f2e34f4e60871e665d2f5fde23ee74dea4eeb", size = 40276, upload-time = "2025-12-15T16:52:27.54Z" }, + { url = "https://files.pythonhosted.org/packages/35/d6/d8823e01bd069934525fddb343189c008b39828a429b473fb20d67d5cd36/librt-0.7.4-cp314-cp314t-win_amd64.whl", hash = "sha256:721a7b125a817d60bf4924e1eec2a7867bfcf64cfc333045de1df7a0629e4481", size = 46772, upload-time = "2025-12-15T16:52:28.653Z" }, + { url = "https://files.pythonhosted.org/packages/36/e9/a0aa60f5322814dd084a89614e9e31139702e342f8459ad8af1984a18168/librt-0.7.4-cp314-cp314t-win_arm64.whl", hash = "sha256:76b2ba71265c0102d11458879b4d53ccd0b32b0164d14deb8d2b598a018e502f", size = 39724, upload-time = "2025-12-15T16:52:29.836Z" }, +] + +[[package]] +name = "markdown" +version = "3.10" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7d/ab/7dd27d9d863b3376fcf23a5a13cb5d024aed1db46f963f1b5735ae43b3be/markdown-3.10.tar.gz", hash = "sha256:37062d4f2aa4b2b6b32aefb80faa300f82cc790cb949a35b8caede34f2b68c0e", size = 364931, upload-time = "2025-11-03T19:51:15.007Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/70/81/54e3ce63502cd085a0c556652a4e1b919c45a446bd1e5300e10c44c8c521/markdown-3.10-py3-none-any.whl", hash = "sha256:b5b99d6951e2e4948d939255596523444c0e677c669700b1d17aa4a8a464cb7c", size = 107678, upload-time = "2025-11-03T19:51:13.887Z" }, +] + +[[package]] +name = "markdown-it-py" +version = "4.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mdurl" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/5b/f5/4ec618ed16cc4f8fb3b701563655a69816155e79e24a17b651541804721d/markdown_it_py-4.0.0.tar.gz", hash = "sha256:cb0a2b4aa34f932c007117b194e945bd74e0ec24133ceb5bac59009cda1cb9f3", size = 73070, upload-time = "2025-08-11T12:57:52.854Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/94/54/e7d793b573f298e1c9013b8c4dade17d481164aa517d1d7148619c2cedbf/markdown_it_py-4.0.0-py3-none-any.whl", hash = "sha256:87327c59b172c5011896038353a81343b6754500a08cd7a4973bb48c6d578147", size = 87321, upload-time = "2025-08-11T12:57:51.923Z" }, +] + +[[package]] +name = "markupsafe" +version = "3.0.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7e/99/7690b6d4034fffd95959cbe0c02de8deb3098cc577c67bb6a24fe5d7caa7/markupsafe-3.0.3.tar.gz", hash = "sha256:722695808f4b6457b320fdc131280796bdceb04ab50fe1795cd540799ebe1698", size = 80313, upload-time = "2025-09-27T18:37:40.426Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e8/4b/3541d44f3937ba468b75da9eebcae497dcf67adb65caa16760b0a6807ebb/markupsafe-3.0.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:2f981d352f04553a7171b8e44369f2af4055f888dfb147d55e42d29e29e74559", size = 11631, upload-time = "2025-09-27T18:36:05.558Z" }, + { url = "https://files.pythonhosted.org/packages/98/1b/fbd8eed11021cabd9226c37342fa6ca4e8a98d8188a8d9b66740494960e4/markupsafe-3.0.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e1c1493fb6e50ab01d20a22826e57520f1284df32f2d8601fdd90b6304601419", size = 12057, upload-time = "2025-09-27T18:36:07.165Z" }, + { url = "https://files.pythonhosted.org/packages/40/01/e560d658dc0bb8ab762670ece35281dec7b6c1b33f5fbc09ebb57a185519/markupsafe-3.0.3-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1ba88449deb3de88bd40044603fafffb7bc2b055d626a330323a9ed736661695", size = 22050, upload-time = "2025-09-27T18:36:08.005Z" }, + { url = "https://files.pythonhosted.org/packages/af/cd/ce6e848bbf2c32314c9b237839119c5a564a59725b53157c856e90937b7a/markupsafe-3.0.3-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f42d0984e947b8adf7dd6dde396e720934d12c506ce84eea8476409563607591", size = 20681, upload-time = "2025-09-27T18:36:08.881Z" }, + { url = "https://files.pythonhosted.org/packages/c9/2a/b5c12c809f1c3045c4d580b035a743d12fcde53cf685dbc44660826308da/markupsafe-3.0.3-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:c0c0b3ade1c0b13b936d7970b1d37a57acde9199dc2aecc4c336773e1d86049c", size = 20705, upload-time = "2025-09-27T18:36:10.131Z" }, + { url = "https://files.pythonhosted.org/packages/cf/e3/9427a68c82728d0a88c50f890d0fc072a1484de2f3ac1ad0bfc1a7214fd5/markupsafe-3.0.3-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:0303439a41979d9e74d18ff5e2dd8c43ed6c6001fd40e5bf2e43f7bd9bbc523f", size = 21524, upload-time = "2025-09-27T18:36:11.324Z" }, + { url = "https://files.pythonhosted.org/packages/bc/36/23578f29e9e582a4d0278e009b38081dbe363c5e7165113fad546918a232/markupsafe-3.0.3-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:d2ee202e79d8ed691ceebae8e0486bd9a2cd4794cec4824e1c99b6f5009502f6", size = 20282, upload-time = "2025-09-27T18:36:12.573Z" }, + { url = "https://files.pythonhosted.org/packages/56/21/dca11354e756ebd03e036bd8ad58d6d7168c80ce1fe5e75218e4945cbab7/markupsafe-3.0.3-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:177b5253b2834fe3678cb4a5f0059808258584c559193998be2601324fdeafb1", size = 20745, upload-time = "2025-09-27T18:36:13.504Z" }, + { url = "https://files.pythonhosted.org/packages/87/99/faba9369a7ad6e4d10b6a5fbf71fa2a188fe4a593b15f0963b73859a1bbd/markupsafe-3.0.3-cp310-cp310-win32.whl", hash = "sha256:2a15a08b17dd94c53a1da0438822d70ebcd13f8c3a95abe3a9ef9f11a94830aa", size = 14571, upload-time = "2025-09-27T18:36:14.779Z" }, + { url = "https://files.pythonhosted.org/packages/d6/25/55dc3ab959917602c96985cb1253efaa4ff42f71194bddeb61eb7278b8be/markupsafe-3.0.3-cp310-cp310-win_amd64.whl", hash = "sha256:c4ffb7ebf07cfe8931028e3e4c85f0357459a3f9f9490886198848f4fa002ec8", size = 15056, upload-time = "2025-09-27T18:36:16.125Z" }, + { url = "https://files.pythonhosted.org/packages/d0/9e/0a02226640c255d1da0b8d12e24ac2aa6734da68bff14c05dd53b94a0fc3/markupsafe-3.0.3-cp310-cp310-win_arm64.whl", hash = "sha256:e2103a929dfa2fcaf9bb4e7c091983a49c9ac3b19c9061b6d5427dd7d14d81a1", size = 13932, upload-time = "2025-09-27T18:36:17.311Z" }, + { url = "https://files.pythonhosted.org/packages/08/db/fefacb2136439fc8dd20e797950e749aa1f4997ed584c62cfb8ef7c2be0e/markupsafe-3.0.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1cc7ea17a6824959616c525620e387f6dd30fec8cb44f649e31712db02123dad", size = 11631, upload-time = "2025-09-27T18:36:18.185Z" }, + { url = "https://files.pythonhosted.org/packages/e1/2e/5898933336b61975ce9dc04decbc0a7f2fee78c30353c5efba7f2d6ff27a/markupsafe-3.0.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4bd4cd07944443f5a265608cc6aab442e4f74dff8088b0dfc8238647b8f6ae9a", size = 12058, upload-time = "2025-09-27T18:36:19.444Z" }, + { url = "https://files.pythonhosted.org/packages/1d/09/adf2df3699d87d1d8184038df46a9c80d78c0148492323f4693df54e17bb/markupsafe-3.0.3-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6b5420a1d9450023228968e7e6a9ce57f65d148ab56d2313fcd589eee96a7a50", size = 24287, upload-time = "2025-09-27T18:36:20.768Z" }, + { url = "https://files.pythonhosted.org/packages/30/ac/0273f6fcb5f42e314c6d8cd99effae6a5354604d461b8d392b5ec9530a54/markupsafe-3.0.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0bf2a864d67e76e5c9a34dc26ec616a66b9888e25e7b9460e1c76d3293bd9dbf", size = 22940, upload-time = "2025-09-27T18:36:22.249Z" }, + { url = "https://files.pythonhosted.org/packages/19/ae/31c1be199ef767124c042c6c3e904da327a2f7f0cd63a0337e1eca2967a8/markupsafe-3.0.3-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:bc51efed119bc9cfdf792cdeaa4d67e8f6fcccab66ed4bfdd6bde3e59bfcbb2f", size = 21887, upload-time = "2025-09-27T18:36:23.535Z" }, + { url = "https://files.pythonhosted.org/packages/b2/76/7edcab99d5349a4532a459e1fe64f0b0467a3365056ae550d3bcf3f79e1e/markupsafe-3.0.3-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:068f375c472b3e7acbe2d5318dea141359e6900156b5b2ba06a30b169086b91a", size = 23692, upload-time = "2025-09-27T18:36:24.823Z" }, + { url = "https://files.pythonhosted.org/packages/a4/28/6e74cdd26d7514849143d69f0bf2399f929c37dc2b31e6829fd2045b2765/markupsafe-3.0.3-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:7be7b61bb172e1ed687f1754f8e7484f1c8019780f6f6b0786e76bb01c2ae115", size = 21471, upload-time = "2025-09-27T18:36:25.95Z" }, + { url = "https://files.pythonhosted.org/packages/62/7e/a145f36a5c2945673e590850a6f8014318d5577ed7e5920a4b3448e0865d/markupsafe-3.0.3-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:f9e130248f4462aaa8e2552d547f36ddadbeaa573879158d721bbd33dfe4743a", size = 22923, upload-time = "2025-09-27T18:36:27.109Z" }, + { url = "https://files.pythonhosted.org/packages/0f/62/d9c46a7f5c9adbeeeda52f5b8d802e1094e9717705a645efc71b0913a0a8/markupsafe-3.0.3-cp311-cp311-win32.whl", hash = "sha256:0db14f5dafddbb6d9208827849fad01f1a2609380add406671a26386cdf15a19", size = 14572, upload-time = "2025-09-27T18:36:28.045Z" }, + { url = "https://files.pythonhosted.org/packages/83/8a/4414c03d3f891739326e1783338e48fb49781cc915b2e0ee052aa490d586/markupsafe-3.0.3-cp311-cp311-win_amd64.whl", hash = "sha256:de8a88e63464af587c950061a5e6a67d3632e36df62b986892331d4620a35c01", size = 15077, upload-time = "2025-09-27T18:36:29.025Z" }, + { url = "https://files.pythonhosted.org/packages/35/73/893072b42e6862f319b5207adc9ae06070f095b358655f077f69a35601f0/markupsafe-3.0.3-cp311-cp311-win_arm64.whl", hash = "sha256:3b562dd9e9ea93f13d53989d23a7e775fdfd1066c33494ff43f5418bc8c58a5c", size = 13876, upload-time = "2025-09-27T18:36:29.954Z" }, + { url = "https://files.pythonhosted.org/packages/5a/72/147da192e38635ada20e0a2e1a51cf8823d2119ce8883f7053879c2199b5/markupsafe-3.0.3-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:d53197da72cc091b024dd97249dfc7794d6a56530370992a5e1a08983ad9230e", size = 11615, upload-time = "2025-09-27T18:36:30.854Z" }, + { url = "https://files.pythonhosted.org/packages/9a/81/7e4e08678a1f98521201c3079f77db69fb552acd56067661f8c2f534a718/markupsafe-3.0.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1872df69a4de6aead3491198eaf13810b565bdbeec3ae2dc8780f14458ec73ce", size = 12020, upload-time = "2025-09-27T18:36:31.971Z" }, + { url = "https://files.pythonhosted.org/packages/1e/2c/799f4742efc39633a1b54a92eec4082e4f815314869865d876824c257c1e/markupsafe-3.0.3-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:3a7e8ae81ae39e62a41ec302f972ba6ae23a5c5396c8e60113e9066ef893da0d", size = 24332, upload-time = "2025-09-27T18:36:32.813Z" }, + { url = "https://files.pythonhosted.org/packages/3c/2e/8d0c2ab90a8c1d9a24f0399058ab8519a3279d1bd4289511d74e909f060e/markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d6dd0be5b5b189d31db7cda48b91d7e0a9795f31430b7f271219ab30f1d3ac9d", size = 22947, upload-time = "2025-09-27T18:36:33.86Z" }, + { url = "https://files.pythonhosted.org/packages/2c/54/887f3092a85238093a0b2154bd629c89444f395618842e8b0c41783898ea/markupsafe-3.0.3-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:94c6f0bb423f739146aec64595853541634bde58b2135f27f61c1ffd1cd4d16a", size = 21962, upload-time = "2025-09-27T18:36:35.099Z" }, + { url = "https://files.pythonhosted.org/packages/c9/2f/336b8c7b6f4a4d95e91119dc8521402461b74a485558d8f238a68312f11c/markupsafe-3.0.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:be8813b57049a7dc738189df53d69395eba14fb99345e0a5994914a3864c8a4b", size = 23760, upload-time = "2025-09-27T18:36:36.001Z" }, + { url = "https://files.pythonhosted.org/packages/32/43/67935f2b7e4982ffb50a4d169b724d74b62a3964bc1a9a527f5ac4f1ee2b/markupsafe-3.0.3-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:83891d0e9fb81a825d9a6d61e3f07550ca70a076484292a70fde82c4b807286f", size = 21529, upload-time = "2025-09-27T18:36:36.906Z" }, + { url = "https://files.pythonhosted.org/packages/89/e0/4486f11e51bbba8b0c041098859e869e304d1c261e59244baa3d295d47b7/markupsafe-3.0.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:77f0643abe7495da77fb436f50f8dab76dbc6e5fd25d39589a0f1fe6548bfa2b", size = 23015, upload-time = "2025-09-27T18:36:37.868Z" }, + { url = "https://files.pythonhosted.org/packages/2f/e1/78ee7a023dac597a5825441ebd17170785a9dab23de95d2c7508ade94e0e/markupsafe-3.0.3-cp312-cp312-win32.whl", hash = "sha256:d88b440e37a16e651bda4c7c2b930eb586fd15ca7406cb39e211fcff3bf3017d", size = 14540, upload-time = "2025-09-27T18:36:38.761Z" }, + { url = "https://files.pythonhosted.org/packages/aa/5b/bec5aa9bbbb2c946ca2733ef9c4ca91c91b6a24580193e891b5f7dbe8e1e/markupsafe-3.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:26a5784ded40c9e318cfc2bdb30fe164bdb8665ded9cd64d500a34fb42067b1c", size = 15105, upload-time = "2025-09-27T18:36:39.701Z" }, + { url = "https://files.pythonhosted.org/packages/e5/f1/216fc1bbfd74011693a4fd837e7026152e89c4bcf3e77b6692fba9923123/markupsafe-3.0.3-cp312-cp312-win_arm64.whl", hash = "sha256:35add3b638a5d900e807944a078b51922212fb3dedb01633a8defc4b01a3c85f", size = 13906, upload-time = "2025-09-27T18:36:40.689Z" }, + { url = "https://files.pythonhosted.org/packages/38/2f/907b9c7bbba283e68f20259574b13d005c121a0fa4c175f9bed27c4597ff/markupsafe-3.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e1cf1972137e83c5d4c136c43ced9ac51d0e124706ee1c8aa8532c1287fa8795", size = 11622, upload-time = "2025-09-27T18:36:41.777Z" }, + { url = "https://files.pythonhosted.org/packages/9c/d9/5f7756922cdd676869eca1c4e3c0cd0df60ed30199ffd775e319089cb3ed/markupsafe-3.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:116bb52f642a37c115f517494ea5feb03889e04df47eeff5b130b1808ce7c219", size = 12029, upload-time = "2025-09-27T18:36:43.257Z" }, + { url = "https://files.pythonhosted.org/packages/00/07/575a68c754943058c78f30db02ee03a64b3c638586fba6a6dd56830b30a3/markupsafe-3.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:133a43e73a802c5562be9bbcd03d090aa5a1fe899db609c29e8c8d815c5f6de6", size = 24374, upload-time = "2025-09-27T18:36:44.508Z" }, + { url = "https://files.pythonhosted.org/packages/a9/21/9b05698b46f218fc0e118e1f8168395c65c8a2c750ae2bab54fc4bd4e0e8/markupsafe-3.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ccfcd093f13f0f0b7fdd0f198b90053bf7b2f02a3927a30e63f3ccc9df56b676", size = 22980, upload-time = "2025-09-27T18:36:45.385Z" }, + { url = "https://files.pythonhosted.org/packages/7f/71/544260864f893f18b6827315b988c146b559391e6e7e8f7252839b1b846a/markupsafe-3.0.3-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:509fa21c6deb7a7a273d629cf5ec029bc209d1a51178615ddf718f5918992ab9", size = 21990, upload-time = "2025-09-27T18:36:46.916Z" }, + { url = "https://files.pythonhosted.org/packages/c2/28/b50fc2f74d1ad761af2f5dcce7492648b983d00a65b8c0e0cb457c82ebbe/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a4afe79fb3de0b7097d81da19090f4df4f8d3a2b3adaa8764138aac2e44f3af1", size = 23784, upload-time = "2025-09-27T18:36:47.884Z" }, + { url = "https://files.pythonhosted.org/packages/ed/76/104b2aa106a208da8b17a2fb72e033a5a9d7073c68f7e508b94916ed47a9/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:795e7751525cae078558e679d646ae45574b47ed6e7771863fcc079a6171a0fc", size = 21588, upload-time = "2025-09-27T18:36:48.82Z" }, + { url = "https://files.pythonhosted.org/packages/b5/99/16a5eb2d140087ebd97180d95249b00a03aa87e29cc224056274f2e45fd6/markupsafe-3.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:8485f406a96febb5140bfeca44a73e3ce5116b2501ac54fe953e488fb1d03b12", size = 23041, upload-time = "2025-09-27T18:36:49.797Z" }, + { url = "https://files.pythonhosted.org/packages/19/bc/e7140ed90c5d61d77cea142eed9f9c303f4c4806f60a1044c13e3f1471d0/markupsafe-3.0.3-cp313-cp313-win32.whl", hash = "sha256:bdd37121970bfd8be76c5fb069c7751683bdf373db1ed6c010162b2a130248ed", size = 14543, upload-time = "2025-09-27T18:36:51.584Z" }, + { url = "https://files.pythonhosted.org/packages/05/73/c4abe620b841b6b791f2edc248f556900667a5a1cf023a6646967ae98335/markupsafe-3.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:9a1abfdc021a164803f4d485104931fb8f8c1efd55bc6b748d2f5774e78b62c5", size = 15113, upload-time = "2025-09-27T18:36:52.537Z" }, + { url = "https://files.pythonhosted.org/packages/f0/3a/fa34a0f7cfef23cf9500d68cb7c32dd64ffd58a12b09225fb03dd37d5b80/markupsafe-3.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:7e68f88e5b8799aa49c85cd116c932a1ac15caaa3f5db09087854d218359e485", size = 13911, upload-time = "2025-09-27T18:36:53.513Z" }, + { url = "https://files.pythonhosted.org/packages/e4/d7/e05cd7efe43a88a17a37b3ae96e79a19e846f3f456fe79c57ca61356ef01/markupsafe-3.0.3-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:218551f6df4868a8d527e3062d0fb968682fe92054e89978594c28e642c43a73", size = 11658, upload-time = "2025-09-27T18:36:54.819Z" }, + { url = "https://files.pythonhosted.org/packages/99/9e/e412117548182ce2148bdeacdda3bb494260c0b0184360fe0d56389b523b/markupsafe-3.0.3-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:3524b778fe5cfb3452a09d31e7b5adefeea8c5be1d43c4f810ba09f2ceb29d37", size = 12066, upload-time = "2025-09-27T18:36:55.714Z" }, + { url = "https://files.pythonhosted.org/packages/bc/e6/fa0ffcda717ef64a5108eaa7b4f5ed28d56122c9a6d70ab8b72f9f715c80/markupsafe-3.0.3-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4e885a3d1efa2eadc93c894a21770e4bc67899e3543680313b09f139e149ab19", size = 25639, upload-time = "2025-09-27T18:36:56.908Z" }, + { url = "https://files.pythonhosted.org/packages/96/ec/2102e881fe9d25fc16cb4b25d5f5cde50970967ffa5dddafdb771237062d/markupsafe-3.0.3-cp313-cp313t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:8709b08f4a89aa7586de0aadc8da56180242ee0ada3999749b183aa23df95025", size = 23569, upload-time = "2025-09-27T18:36:57.913Z" }, + { url = "https://files.pythonhosted.org/packages/4b/30/6f2fce1f1f205fc9323255b216ca8a235b15860c34b6798f810f05828e32/markupsafe-3.0.3-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:b8512a91625c9b3da6f127803b166b629725e68af71f8184ae7e7d54686a56d6", size = 23284, upload-time = "2025-09-27T18:36:58.833Z" }, + { url = "https://files.pythonhosted.org/packages/58/47/4a0ccea4ab9f5dcb6f79c0236d954acb382202721e704223a8aafa38b5c8/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:9b79b7a16f7fedff2495d684f2b59b0457c3b493778c9eed31111be64d58279f", size = 24801, upload-time = "2025-09-27T18:36:59.739Z" }, + { url = "https://files.pythonhosted.org/packages/6a/70/3780e9b72180b6fecb83a4814d84c3bf4b4ae4bf0b19c27196104149734c/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:12c63dfb4a98206f045aa9563db46507995f7ef6d83b2f68eda65c307c6829eb", size = 22769, upload-time = "2025-09-27T18:37:00.719Z" }, + { url = "https://files.pythonhosted.org/packages/98/c5/c03c7f4125180fc215220c035beac6b9cb684bc7a067c84fc69414d315f5/markupsafe-3.0.3-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:8f71bc33915be5186016f675cd83a1e08523649b0e33efdb898db577ef5bb009", size = 23642, upload-time = "2025-09-27T18:37:01.673Z" }, + { url = "https://files.pythonhosted.org/packages/80/d6/2d1b89f6ca4bff1036499b1e29a1d02d282259f3681540e16563f27ebc23/markupsafe-3.0.3-cp313-cp313t-win32.whl", hash = "sha256:69c0b73548bc525c8cb9a251cddf1931d1db4d2258e9599c28c07ef3580ef354", size = 14612, upload-time = "2025-09-27T18:37:02.639Z" }, + { url = "https://files.pythonhosted.org/packages/2b/98/e48a4bfba0a0ffcf9925fe2d69240bfaa19c6f7507b8cd09c70684a53c1e/markupsafe-3.0.3-cp313-cp313t-win_amd64.whl", hash = "sha256:1b4b79e8ebf6b55351f0d91fe80f893b4743f104bff22e90697db1590e47a218", size = 15200, upload-time = "2025-09-27T18:37:03.582Z" }, + { url = "https://files.pythonhosted.org/packages/0e/72/e3cc540f351f316e9ed0f092757459afbc595824ca724cbc5a5d4263713f/markupsafe-3.0.3-cp313-cp313t-win_arm64.whl", hash = "sha256:ad2cf8aa28b8c020ab2fc8287b0f823d0a7d8630784c31e9ee5edea20f406287", size = 13973, upload-time = "2025-09-27T18:37:04.929Z" }, + { url = "https://files.pythonhosted.org/packages/33/8a/8e42d4838cd89b7dde187011e97fe6c3af66d8c044997d2183fbd6d31352/markupsafe-3.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:eaa9599de571d72e2daf60164784109f19978b327a3910d3e9de8c97b5b70cfe", size = 11619, upload-time = "2025-09-27T18:37:06.342Z" }, + { url = "https://files.pythonhosted.org/packages/b5/64/7660f8a4a8e53c924d0fa05dc3a55c9cee10bbd82b11c5afb27d44b096ce/markupsafe-3.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:c47a551199eb8eb2121d4f0f15ae0f923d31350ab9280078d1e5f12b249e0026", size = 12029, upload-time = "2025-09-27T18:37:07.213Z" }, + { url = "https://files.pythonhosted.org/packages/da/ef/e648bfd021127bef5fa12e1720ffed0c6cbb8310c8d9bea7266337ff06de/markupsafe-3.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f34c41761022dd093b4b6896d4810782ffbabe30f2d443ff5f083e0cbbb8c737", size = 24408, upload-time = "2025-09-27T18:37:09.572Z" }, + { url = "https://files.pythonhosted.org/packages/41/3c/a36c2450754618e62008bf7435ccb0f88053e07592e6028a34776213d877/markupsafe-3.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:457a69a9577064c05a97c41f4e65148652db078a3a509039e64d3467b9e7ef97", size = 23005, upload-time = "2025-09-27T18:37:10.58Z" }, + { url = "https://files.pythonhosted.org/packages/bc/20/b7fdf89a8456b099837cd1dc21974632a02a999ec9bf7ca3e490aacd98e7/markupsafe-3.0.3-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:e8afc3f2ccfa24215f8cb28dcf43f0113ac3c37c2f0f0806d8c70e4228c5cf4d", size = 22048, upload-time = "2025-09-27T18:37:11.547Z" }, + { url = "https://files.pythonhosted.org/packages/9a/a7/591f592afdc734f47db08a75793a55d7fbcc6902a723ae4cfbab61010cc5/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:ec15a59cf5af7be74194f7ab02d0f59a62bdcf1a537677ce67a2537c9b87fcda", size = 23821, upload-time = "2025-09-27T18:37:12.48Z" }, + { url = "https://files.pythonhosted.org/packages/7d/33/45b24e4f44195b26521bc6f1a82197118f74df348556594bd2262bda1038/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:0eb9ff8191e8498cca014656ae6b8d61f39da5f95b488805da4bb029cccbfbaf", size = 21606, upload-time = "2025-09-27T18:37:13.485Z" }, + { url = "https://files.pythonhosted.org/packages/ff/0e/53dfaca23a69fbfbbf17a4b64072090e70717344c52eaaaa9c5ddff1e5f0/markupsafe-3.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:2713baf880df847f2bece4230d4d094280f4e67b1e813eec43b4c0e144a34ffe", size = 23043, upload-time = "2025-09-27T18:37:14.408Z" }, + { url = "https://files.pythonhosted.org/packages/46/11/f333a06fc16236d5238bfe74daccbca41459dcd8d1fa952e8fbd5dccfb70/markupsafe-3.0.3-cp314-cp314-win32.whl", hash = "sha256:729586769a26dbceff69f7a7dbbf59ab6572b99d94576a5592625d5b411576b9", size = 14747, upload-time = "2025-09-27T18:37:15.36Z" }, + { url = "https://files.pythonhosted.org/packages/28/52/182836104b33b444e400b14f797212f720cbc9ed6ba34c800639d154e821/markupsafe-3.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:bdc919ead48f234740ad807933cdf545180bfbe9342c2bb451556db2ed958581", size = 15341, upload-time = "2025-09-27T18:37:16.496Z" }, + { url = "https://files.pythonhosted.org/packages/6f/18/acf23e91bd94fd7b3031558b1f013adfa21a8e407a3fdb32745538730382/markupsafe-3.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:5a7d5dc5140555cf21a6fefbdbf8723f06fcd2f63ef108f2854de715e4422cb4", size = 14073, upload-time = "2025-09-27T18:37:17.476Z" }, + { url = "https://files.pythonhosted.org/packages/3c/f0/57689aa4076e1b43b15fdfa646b04653969d50cf30c32a102762be2485da/markupsafe-3.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:1353ef0c1b138e1907ae78e2f6c63ff67501122006b0f9abad68fda5f4ffc6ab", size = 11661, upload-time = "2025-09-27T18:37:18.453Z" }, + { url = "https://files.pythonhosted.org/packages/89/c3/2e67a7ca217c6912985ec766c6393b636fb0c2344443ff9d91404dc4c79f/markupsafe-3.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:1085e7fbddd3be5f89cc898938f42c0b3c711fdcb37d75221de2666af647c175", size = 12069, upload-time = "2025-09-27T18:37:19.332Z" }, + { url = "https://files.pythonhosted.org/packages/f0/00/be561dce4e6ca66b15276e184ce4b8aec61fe83662cce2f7d72bd3249d28/markupsafe-3.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1b52b4fb9df4eb9ae465f8d0c228a00624de2334f216f178a995ccdcf82c4634", size = 25670, upload-time = "2025-09-27T18:37:20.245Z" }, + { url = "https://files.pythonhosted.org/packages/50/09/c419f6f5a92e5fadde27efd190eca90f05e1261b10dbd8cbcb39cd8ea1dc/markupsafe-3.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fed51ac40f757d41b7c48425901843666a6677e3e8eb0abcff09e4ba6e664f50", size = 23598, upload-time = "2025-09-27T18:37:21.177Z" }, + { url = "https://files.pythonhosted.org/packages/22/44/a0681611106e0b2921b3033fc19bc53323e0b50bc70cffdd19f7d679bb66/markupsafe-3.0.3-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:f190daf01f13c72eac4efd5c430a8de82489d9cff23c364c3ea822545032993e", size = 23261, upload-time = "2025-09-27T18:37:22.167Z" }, + { url = "https://files.pythonhosted.org/packages/5f/57/1b0b3f100259dc9fffe780cfb60d4be71375510e435efec3d116b6436d43/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:e56b7d45a839a697b5eb268c82a71bd8c7f6c94d6fd50c3d577fa39a9f1409f5", size = 24835, upload-time = "2025-09-27T18:37:23.296Z" }, + { url = "https://files.pythonhosted.org/packages/26/6a/4bf6d0c97c4920f1597cc14dd720705eca0bf7c787aebc6bb4d1bead5388/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:f3e98bb3798ead92273dc0e5fd0f31ade220f59a266ffd8a4f6065e0a3ce0523", size = 22733, upload-time = "2025-09-27T18:37:24.237Z" }, + { url = "https://files.pythonhosted.org/packages/14/c7/ca723101509b518797fedc2fdf79ba57f886b4aca8a7d31857ba3ee8281f/markupsafe-3.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:5678211cb9333a6468fb8d8be0305520aa073f50d17f089b5b4b477ea6e67fdc", size = 23672, upload-time = "2025-09-27T18:37:25.271Z" }, + { url = "https://files.pythonhosted.org/packages/fb/df/5bd7a48c256faecd1d36edc13133e51397e41b73bb77e1a69deab746ebac/markupsafe-3.0.3-cp314-cp314t-win32.whl", hash = "sha256:915c04ba3851909ce68ccc2b8e2cd691618c4dc4c4232fb7982bca3f41fd8c3d", size = 14819, upload-time = "2025-09-27T18:37:26.285Z" }, + { url = "https://files.pythonhosted.org/packages/1a/8a/0402ba61a2f16038b48b39bccca271134be00c5c9f0f623208399333c448/markupsafe-3.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4faffd047e07c38848ce017e8725090413cd80cbc23d86e55c587bf979e579c9", size = 15426, upload-time = "2025-09-27T18:37:27.316Z" }, + { url = "https://files.pythonhosted.org/packages/70/bc/6f1c2f612465f5fa89b95bead1f44dcb607670fd42891d8fdcd5d039f4f4/markupsafe-3.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:32001d6a8fc98c8cb5c947787c5d08b0a50663d139f1305bac5885d98d9b40fa", size = 14146, upload-time = "2025-09-27T18:37:28.327Z" }, +] + +[[package]] +name = "matplotlib-inline" +version = "0.2.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "traitlets" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/c7/74/97e72a36efd4ae2bccb3463284300f8953f199b5ffbc04cbbb0ec78f74b1/matplotlib_inline-0.2.1.tar.gz", hash = "sha256:e1ee949c340d771fc39e241ea75683deb94762c8fa5f2927ec57c83c4dffa9fe", size = 8110, upload-time = "2025-10-23T09:00:22.126Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/af/33/ee4519fa02ed11a94aef9559552f3b17bb863f2ecfe1a35dc7f548cde231/matplotlib_inline-0.2.1-py3-none-any.whl", hash = "sha256:d56ce5156ba6085e00a9d54fead6ed29a9c47e215cd1bba2e976ef39f5710a76", size = 9516, upload-time = "2025-10-23T09:00:20.675Z" }, +] + +[[package]] +name = "mdurl" +version = "0.1.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d6/54/cfe61301667036ec958cb99bd3efefba235e65cdeb9c84d24a8293ba1d90/mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba", size = 8729, upload-time = "2022-08-14T12:40:10.846Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979, upload-time = "2022-08-14T12:40:09.779Z" }, +] + +[[package]] +name = "mergedeep" +version = "1.3.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3a/41/580bb4006e3ed0361b8151a01d324fb03f420815446c7def45d02f74c270/mergedeep-1.3.4.tar.gz", hash = "sha256:0096d52e9dad9939c3d975a774666af186eda617e6ca84df4c94dec30004f2a8", size = 4661, upload-time = "2021-02-05T18:55:30.623Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2c/19/04f9b178c2d8a15b076c8b5140708fa6ffc5601fb6f1e975537072df5b2a/mergedeep-1.3.4-py3-none-any.whl", hash = "sha256:70775750742b25c0d8f36c55aed03d24c3384d17c951b3175d898bd778ef0307", size = 6354, upload-time = "2021-02-05T18:55:29.583Z" }, +] + +[[package]] +name = "mkdocs" +version = "1.6.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "click" }, + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "ghp-import" }, + { name = "jinja2" }, + { name = "markdown" }, + { name = "markupsafe" }, + { name = "mergedeep" }, + { name = "mkdocs-get-deps" }, + { name = "packaging" }, + { name = "pathspec" }, + { name = "pyyaml" }, + { name = "pyyaml-env-tag" }, + { name = "watchdog" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz", hash = "sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2", size = 3889159, upload-time = "2024-08-30T12:24:06.899Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c/mkdocs-1.6.1-py3-none-any.whl", hash = "sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e", size = 3864451, upload-time = "2024-08-30T12:24:05.054Z" }, +] + +[[package]] +name = "mkdocs-get-deps" +version = "0.2.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mergedeep" }, + { name = "platformdirs" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/98/f5/ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b/mkdocs_get_deps-0.2.0.tar.gz", hash = "sha256:162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c", size = 10239, upload-time = "2023-11-20T17:51:09.981Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9f/d4/029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea/mkdocs_get_deps-0.2.0-py3-none-any.whl", hash = "sha256:2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134", size = 9521, upload-time = "2023-11-20T17:51:08.587Z" }, +] + +[[package]] +name = "mkdocs-git-revision-date-localized-plugin" +version = "1.5.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "babel" }, + { name = "gitpython" }, + { name = "mkdocs" }, + { name = "tzdata", marker = "sys_platform == 'win32'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/0f/c5/1d3c4e6ddae6230b89d09105cb79de711655e3ebd6745f7a92efea0f5160/mkdocs_git_revision_date_localized_plugin-1.5.0.tar.gz", hash = "sha256:17345ccfdf69a1905dc96fb1070dce82d03a1eb6b0d48f958081a7589ce3c248", size = 460697, upload-time = "2025-10-31T16:11:34.44Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bc/51/fe0e3fdb16f6eed65c9459d12bae6a4e1f0bb4e2228cb037e7907b002678/mkdocs_git_revision_date_localized_plugin-1.5.0-py3-none-any.whl", hash = "sha256:933f9e35a8c135b113f21bb57610d82e9b7bcc71dd34fb06a029053c97e99656", size = 26153, upload-time = "2025-10-31T16:11:32.987Z" }, +] + +[[package]] +name = "mkdocs-material" +version = "9.7.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "babel" }, + { name = "backrefs" }, + { name = "colorama" }, + { name = "jinja2" }, + { name = "markdown" }, + { name = "mkdocs" }, + { name = "mkdocs-material-extensions" }, + { name = "paginate" }, + { name = "pygments" }, + { name = "pymdown-extensions" }, + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/27/e2/2ffc356cd72f1473d07c7719d82a8f2cbd261666828614ecb95b12169f41/mkdocs_material-9.7.1.tar.gz", hash = "sha256:89601b8f2c3e6c6ee0a918cc3566cb201d40bf37c3cd3c2067e26fadb8cce2b8", size = 4094392, upload-time = "2025-12-18T09:49:00.308Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3e/32/ed071cb721aca8c227718cffcf7bd539620e9799bbf2619e90c757bfd030/mkdocs_material-9.7.1-py3-none-any.whl", hash = "sha256:3f6100937d7d731f87f1e3e3b021c97f7239666b9ba1151ab476cabb96c60d5c", size = 9297166, upload-time = "2025-12-18T09:48:56.664Z" }, +] + +[[package]] +name = "mkdocs-material-extensions" +version = "1.3.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/79/9b/9b4c96d6593b2a541e1cb8b34899a6d021d208bb357042823d4d2cabdbe7/mkdocs_material_extensions-1.3.1.tar.gz", hash = "sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443", size = 11847, upload-time = "2023-11-22T19:09:45.208Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728, upload-time = "2023-11-22T19:09:43.465Z" }, +] + +[[package]] +name = "mypy" +version = "1.19.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "librt", marker = "platform_python_implementation != 'PyPy'" }, + { name = "mypy-extensions" }, + { name = "pathspec" }, + { name = "tomli", marker = "python_full_version < '3.11'" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f5/db/4efed9504bc01309ab9c2da7e352cc223569f05478012b5d9ece38fd44d2/mypy-1.19.1.tar.gz", hash = "sha256:19d88bb05303fe63f71dd2c6270daca27cb9401c4ca8255fe50d1d920e0eb9ba", size = 3582404, upload-time = "2025-12-15T05:03:48.42Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2f/63/e499890d8e39b1ff2df4c0c6ce5d371b6844ee22b8250687a99fd2f657a8/mypy-1.19.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:5f05aa3d375b385734388e844bc01733bd33c644ab48e9684faa54e5389775ec", size = 13101333, upload-time = "2025-12-15T05:03:03.28Z" }, + { url = "https://files.pythonhosted.org/packages/72/4b/095626fc136fba96effc4fd4a82b41d688ab92124f8c4f7564bffe5cf1b0/mypy-1.19.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:022ea7279374af1a5d78dfcab853fe6a536eebfda4b59deab53cd21f6cd9f00b", size = 12164102, upload-time = "2025-12-15T05:02:33.611Z" }, + { url = "https://files.pythonhosted.org/packages/0c/5b/952928dd081bf88a83a5ccd49aaecfcd18fd0d2710c7ff07b8fb6f7032b9/mypy-1.19.1-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ee4c11e460685c3e0c64a4c5de82ae143622410950d6be863303a1c4ba0e36d6", size = 12765799, upload-time = "2025-12-15T05:03:28.44Z" }, + { url = "https://files.pythonhosted.org/packages/2a/0d/93c2e4a287f74ef11a66fb6d49c7a9f05e47b0a4399040e6719b57f500d2/mypy-1.19.1-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:de759aafbae8763283b2ee5869c7255391fbc4de3ff171f8f030b5ec48381b74", size = 13522149, upload-time = "2025-12-15T05:02:36.011Z" }, + { url = "https://files.pythonhosted.org/packages/7b/0e/33a294b56aaad2b338d203e3a1d8b453637ac36cb278b45005e0901cf148/mypy-1.19.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:ab43590f9cd5108f41aacf9fca31841142c786827a74ab7cc8a2eacb634e09a1", size = 13810105, upload-time = "2025-12-15T05:02:40.327Z" }, + { url = "https://files.pythonhosted.org/packages/0e/fd/3e82603a0cb66b67c5e7abababce6bf1a929ddf67bf445e652684af5c5a0/mypy-1.19.1-cp310-cp310-win_amd64.whl", hash = "sha256:2899753e2f61e571b3971747e302d5f420c3fd09650e1951e99f823bc3089dac", size = 10057200, upload-time = "2025-12-15T05:02:51.012Z" }, + { url = "https://files.pythonhosted.org/packages/ef/47/6b3ebabd5474d9cdc170d1342fbf9dddc1b0ec13ec90bf9004ee6f391c31/mypy-1.19.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:d8dfc6ab58ca7dda47d9237349157500468e404b17213d44fc1cb77bce532288", size = 13028539, upload-time = "2025-12-15T05:03:44.129Z" }, + { url = "https://files.pythonhosted.org/packages/5c/a6/ac7c7a88a3c9c54334f53a941b765e6ec6c4ebd65d3fe8cdcfbe0d0fd7db/mypy-1.19.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e3f276d8493c3c97930e354b2595a44a21348b320d859fb4a2b9f66da9ed27ab", size = 12083163, upload-time = "2025-12-15T05:03:37.679Z" }, + { url = "https://files.pythonhosted.org/packages/67/af/3afa9cf880aa4a2c803798ac24f1d11ef72a0c8079689fac5cfd815e2830/mypy-1.19.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:2abb24cf3f17864770d18d673c85235ba52456b36a06b6afc1e07c1fdcd3d0e6", size = 12687629, upload-time = "2025-12-15T05:02:31.526Z" }, + { url = "https://files.pythonhosted.org/packages/2d/46/20f8a7114a56484ab268b0ab372461cb3a8f7deed31ea96b83a4e4cfcfca/mypy-1.19.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a009ffa5a621762d0c926a078c2d639104becab69e79538a494bcccb62cc0331", size = 13436933, upload-time = "2025-12-15T05:03:15.606Z" }, + { url = "https://files.pythonhosted.org/packages/5b/f8/33b291ea85050a21f15da910002460f1f445f8007adb29230f0adea279cb/mypy-1.19.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:f7cee03c9a2e2ee26ec07479f38ea9c884e301d42c6d43a19d20fb014e3ba925", size = 13661754, upload-time = "2025-12-15T05:02:26.731Z" }, + { url = "https://files.pythonhosted.org/packages/fd/a3/47cbd4e85bec4335a9cd80cf67dbc02be21b5d4c9c23ad6b95d6c5196bac/mypy-1.19.1-cp311-cp311-win_amd64.whl", hash = "sha256:4b84a7a18f41e167f7995200a1d07a4a6810e89d29859df936f1c3923d263042", size = 10055772, upload-time = "2025-12-15T05:03:26.179Z" }, + { url = "https://files.pythonhosted.org/packages/06/8a/19bfae96f6615aa8a0604915512e0289b1fad33d5909bf7244f02935d33a/mypy-1.19.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:a8174a03289288c1f6c46d55cef02379b478bfbc8e358e02047487cad44c6ca1", size = 13206053, upload-time = "2025-12-15T05:03:46.622Z" }, + { url = "https://files.pythonhosted.org/packages/a5/34/3e63879ab041602154ba2a9f99817bb0c85c4df19a23a1443c8986e4d565/mypy-1.19.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ffcebe56eb09ff0c0885e750036a095e23793ba6c2e894e7e63f6d89ad51f22e", size = 12219134, upload-time = "2025-12-15T05:03:24.367Z" }, + { url = "https://files.pythonhosted.org/packages/89/cc/2db6f0e95366b630364e09845672dbee0cbf0bbe753a204b29a944967cd9/mypy-1.19.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b64d987153888790bcdb03a6473d321820597ab8dd9243b27a92153c4fa50fd2", size = 12731616, upload-time = "2025-12-15T05:02:44.725Z" }, + { url = "https://files.pythonhosted.org/packages/00/be/dd56c1fd4807bc1eba1cf18b2a850d0de7bacb55e158755eb79f77c41f8e/mypy-1.19.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c35d298c2c4bba75feb2195655dfea8124d855dfd7343bf8b8c055421eaf0cf8", size = 13620847, upload-time = "2025-12-15T05:03:39.633Z" }, + { url = "https://files.pythonhosted.org/packages/6d/42/332951aae42b79329f743bf1da088cd75d8d4d9acc18fbcbd84f26c1af4e/mypy-1.19.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:34c81968774648ab5ac09c29a375fdede03ba253f8f8287847bd480782f73a6a", size = 13834976, upload-time = "2025-12-15T05:03:08.786Z" }, + { url = "https://files.pythonhosted.org/packages/6f/63/e7493e5f90e1e085c562bb06e2eb32cae27c5057b9653348d38b47daaecc/mypy-1.19.1-cp312-cp312-win_amd64.whl", hash = "sha256:b10e7c2cd7870ba4ad9b2d8a6102eb5ffc1f16ca35e3de6bfa390c1113029d13", size = 10118104, upload-time = "2025-12-15T05:03:10.834Z" }, + { url = "https://files.pythonhosted.org/packages/de/9f/a6abae693f7a0c697dbb435aac52e958dc8da44e92e08ba88d2e42326176/mypy-1.19.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e3157c7594ff2ef1634ee058aafc56a82db665c9438fd41b390f3bde1ab12250", size = 13201927, upload-time = "2025-12-15T05:02:29.138Z" }, + { url = "https://files.pythonhosted.org/packages/9a/a4/45c35ccf6e1c65afc23a069f50e2c66f46bd3798cbe0d680c12d12935caa/mypy-1.19.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:bdb12f69bcc02700c2b47e070238f42cb87f18c0bc1fc4cdb4fb2bc5fd7a3b8b", size = 12206730, upload-time = "2025-12-15T05:03:01.325Z" }, + { url = "https://files.pythonhosted.org/packages/05/bb/cdcf89678e26b187650512620eec8368fded4cfd99cfcb431e4cdfd19dec/mypy-1.19.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f859fb09d9583a985be9a493d5cfc5515b56b08f7447759a0c5deaf68d80506e", size = 12724581, upload-time = "2025-12-15T05:03:20.087Z" }, + { url = "https://files.pythonhosted.org/packages/d1/32/dd260d52babf67bad8e6770f8e1102021877ce0edea106e72df5626bb0ec/mypy-1.19.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c9a6538e0415310aad77cb94004ca6482330fece18036b5f360b62c45814c4ef", size = 13616252, upload-time = "2025-12-15T05:02:49.036Z" }, + { url = "https://files.pythonhosted.org/packages/71/d0/5e60a9d2e3bd48432ae2b454b7ef2b62a960ab51292b1eda2a95edd78198/mypy-1.19.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:da4869fc5e7f62a88f3fe0b5c919d1d9f7ea3cef92d3689de2823fd27e40aa75", size = 13840848, upload-time = "2025-12-15T05:02:55.95Z" }, + { url = "https://files.pythonhosted.org/packages/98/76/d32051fa65ecf6cc8c6610956473abdc9b4c43301107476ac03559507843/mypy-1.19.1-cp313-cp313-win_amd64.whl", hash = "sha256:016f2246209095e8eda7538944daa1d60e1e8134d98983b9fc1e92c1fc0cb8dd", size = 10135510, upload-time = "2025-12-15T05:02:58.438Z" }, + { url = "https://files.pythonhosted.org/packages/de/eb/b83e75f4c820c4247a58580ef86fcd35165028f191e7e1ba57128c52782d/mypy-1.19.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:06e6170bd5836770e8104c8fdd58e5e725cfeb309f0a6c681a811f557e97eac1", size = 13199744, upload-time = "2025-12-15T05:03:30.823Z" }, + { url = "https://files.pythonhosted.org/packages/94/28/52785ab7bfa165f87fcbb61547a93f98bb20e7f82f90f165a1f69bce7b3d/mypy-1.19.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:804bd67b8054a85447c8954215a906d6eff9cabeabe493fb6334b24f4bfff718", size = 12215815, upload-time = "2025-12-15T05:02:42.323Z" }, + { url = "https://files.pythonhosted.org/packages/0a/c6/bdd60774a0dbfb05122e3e925f2e9e846c009e479dcec4821dad881f5b52/mypy-1.19.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:21761006a7f497cb0d4de3d8ef4ca70532256688b0523eee02baf9eec895e27b", size = 12740047, upload-time = "2025-12-15T05:03:33.168Z" }, + { url = "https://files.pythonhosted.org/packages/32/2a/66ba933fe6c76bd40d1fe916a83f04fed253152f451a877520b3c4a5e41e/mypy-1.19.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:28902ee51f12e0f19e1e16fbe2f8f06b6637f482c459dd393efddd0ec7f82045", size = 13601998, upload-time = "2025-12-15T05:03:13.056Z" }, + { url = "https://files.pythonhosted.org/packages/e3/da/5055c63e377c5c2418760411fd6a63ee2b96cf95397259038756c042574f/mypy-1.19.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:481daf36a4c443332e2ae9c137dfee878fcea781a2e3f895d54bd3002a900957", size = 13807476, upload-time = "2025-12-15T05:03:17.977Z" }, + { url = "https://files.pythonhosted.org/packages/cd/09/4ebd873390a063176f06b0dbf1f7783dd87bd120eae7727fa4ae4179b685/mypy-1.19.1-cp314-cp314-win_amd64.whl", hash = "sha256:8bb5c6f6d043655e055be9b542aa5f3bdd30e4f3589163e85f93f3640060509f", size = 10281872, upload-time = "2025-12-15T05:03:05.549Z" }, + { url = "https://files.pythonhosted.org/packages/8d/f4/4ce9a05ce5ded1de3ec1c1d96cf9f9504a04e54ce0ed55cfa38619a32b8d/mypy-1.19.1-py3-none-any.whl", hash = "sha256:f1235f5ea01b7db5468d53ece6aaddf1ad0b88d9e7462b86ef96fe04995d7247", size = 2471239, upload-time = "2025-12-15T05:03:07.248Z" }, +] + +[[package]] +name = "mypy-extensions" +version = "1.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a2/6e/371856a3fb9d31ca8dac321cda606860fa4548858c0cc45d9d1d4ca2628b/mypy_extensions-1.1.0.tar.gz", hash = "sha256:52e68efc3284861e772bbcd66823fde5ae21fd2fdb51c62a211403730b916558", size = 6343, upload-time = "2025-04-22T14:54:24.164Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/79/7b/2c79738432f5c924bef5071f933bcc9efd0473bac3b4aa584a6f7c1c8df8/mypy_extensions-1.1.0-py3-none-any.whl", hash = "sha256:1be4cccdb0f2482337c4743e60421de3a356cd97508abadd57d47403e94f5505", size = 4963, upload-time = "2025-04-22T14:54:22.983Z" }, +] + +[[package]] +name = "nodeenv" +version = "1.10.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/24/bf/d1bda4f6168e0b2e9e5958945e01910052158313224ada5ce1fb2e1113b8/nodeenv-1.10.0.tar.gz", hash = "sha256:996c191ad80897d076bdfba80a41994c2b47c68e224c542b48feba42ba00f8bb", size = 55611, upload-time = "2025-12-20T14:08:54.006Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/88/b2/d0896bdcdc8d28a7fc5717c305f1a861c26e18c05047949fb371034d98bd/nodeenv-1.10.0-py2.py3-none-any.whl", hash = "sha256:5bb13e3eed2923615535339b3c620e76779af4cb4c6a90deccc9e36b274d3827", size = 23438, upload-time = "2025-12-20T14:08:52.782Z" }, +] + +[[package]] +name = "packaging" +version = "25.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a1/d4/1fc4078c65507b51b96ca8f8c3ba19e6a61c8253c72794544580a7b6c24d/packaging-25.0.tar.gz", hash = "sha256:d443872c98d677bf60f6a1f2f8c1cb748e8fe762d2bf9d3148b5599295b0fc4f", size = 165727, upload-time = "2025-04-19T11:48:59.673Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/20/12/38679034af332785aac8774540895e234f4d07f7545804097de4b666afd8/packaging-25.0-py3-none-any.whl", hash = "sha256:29572ef2b1f17581046b3a2227d5c611fb25ec70ca1ba8554b24b0e69331a484", size = 66469, upload-time = "2025-04-19T11:48:57.875Z" }, +] + +[[package]] +name = "paginate" +version = "0.5.7" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ec/46/68dde5b6bc00c1296ec6466ab27dddede6aec9af1b99090e1107091b3b84/paginate-0.5.7.tar.gz", hash = "sha256:22bd083ab41e1a8b4f3690544afb2c60c25e5c9a63a30fa2f483f6c60c8e5945", size = 19252, upload-time = "2024-08-25T14:17:24.139Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/90/96/04b8e52da071d28f5e21a805b19cb9390aa17a47462ac87f5e2696b9566d/paginate-0.5.7-py2.py3-none-any.whl", hash = "sha256:b885e2af73abcf01d9559fd5216b57ef722f8c42affbb63942377668e35c7591", size = 13746, upload-time = "2024-08-25T14:17:22.55Z" }, +] + +[[package]] +name = "parso" +version = "0.8.5" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d4/de/53e0bcf53d13e005bd8c92e7855142494f41171b34c2536b86187474184d/parso-0.8.5.tar.gz", hash = "sha256:034d7354a9a018bdce352f48b2a8a450f05e9d6ee85db84764e9b6bd96dafe5a", size = 401205, upload-time = "2025-08-23T15:15:28.028Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/16/32/f8e3c85d1d5250232a5d3477a2a28cc291968ff175caeadaf3cc19ce0e4a/parso-0.8.5-py2.py3-none-any.whl", hash = "sha256:646204b5ee239c396d040b90f9e272e9a8017c630092bf59980beb62fd033887", size = 106668, upload-time = "2025-08-23T15:15:25.663Z" }, +] + +[[package]] +name = "pastel" +version = "0.2.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/76/f1/4594f5e0fcddb6953e5b8fe00da8c317b8b41b547e2b3ae2da7512943c62/pastel-0.2.1.tar.gz", hash = "sha256:e6581ac04e973cac858828c6202c1e1e81fee1dc7de7683f3e1ffe0bfd8a573d", size = 7555, upload-time = "2020-09-16T19:21:12.43Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/aa/18/a8444036c6dd65ba3624c63b734d3ba95ba63ace513078e1580590075d21/pastel-0.2.1-py2.py3-none-any.whl", hash = "sha256:4349225fcdf6c2bb34d483e523475de5bb04a5c10ef711263452cb37d7dd4364", size = 5955, upload-time = "2020-09-16T19:21:11.409Z" }, +] + +[[package]] +name = "pathspec" +version = "0.12.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ca/bc/f35b8446f4531a7cb215605d100cd88b7ac6f44ab3fc94870c120ab3adbf/pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712", size = 51043, upload-time = "2023-12-10T22:30:45Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cc/20/ff623b09d963f88bfde16306a54e12ee5ea43e9b597108672ff3a408aad6/pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08", size = 31191, upload-time = "2023-12-10T22:30:43.14Z" }, +] + +[[package]] +name = "pexpect" +version = "4.9.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "ptyprocess" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/42/92/cc564bf6381ff43ce1f4d06852fc19a2f11d180f23dc32d9588bee2f149d/pexpect-4.9.0.tar.gz", hash = "sha256:ee7d41123f3c9911050ea2c2dac107568dc43b2d3b0c7557a33212c398ead30f", size = 166450, upload-time = "2023-11-25T09:07:26.339Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9e/c3/059298687310d527a58bb01f3b1965787ee3b40dce76752eda8b44e9a2c5/pexpect-4.9.0-py2.py3-none-any.whl", hash = "sha256:7236d1e080e4936be2dc3e326cec0af72acf9212a7e1d060210e70a47e253523", size = 63772, upload-time = "2023-11-25T06:56:14.81Z" }, +] + +[[package]] +name = "platformdirs" +version = "4.5.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cf/86/0248f086a84f01b37aaec0fa567b397df1a119f73c16f6c7a9aac73ea309/platformdirs-4.5.1.tar.gz", hash = "sha256:61d5cdcc6065745cdd94f0f878977f8de9437be93de97c1c12f853c9c0cdcbda", size = 21715, upload-time = "2025-12-05T13:52:58.638Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cb/28/3bfe2fa5a7b9c46fe7e13c97bda14c895fb10fa2ebf1d0abb90e0cea7ee1/platformdirs-4.5.1-py3-none-any.whl", hash = "sha256:d03afa3963c806a9bed9d5125c8f4cb2fdaf74a55ab60e5d59b3fde758104d31", size = 18731, upload-time = "2025-12-05T13:52:56.823Z" }, +] + +[[package]] +name = "pluggy" +version = "1.6.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f9/e2/3e91f31a7d2b083fe6ef3fa267035b518369d9511ffab804f839851d2779/pluggy-1.6.0.tar.gz", hash = "sha256:7dcc130b76258d33b90f61b658791dede3486c3e6bfb003ee5c9bfb396dd22f3", size = 69412, upload-time = "2025-05-15T12:30:07.975Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/54/20/4d324d65cc6d9205fabedc306948156824eb9f0ee1633355a8f7ec5c66bf/pluggy-1.6.0-py3-none-any.whl", hash = "sha256:e920276dd6813095e9377c0bc5566d94c932c33b27a3e3945d8389c374dd4746", size = 20538, upload-time = "2025-05-15T12:30:06.134Z" }, +] + +[[package]] +name = "poethepoet" +version = "0.38.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pastel" }, + { name = "pyyaml" }, + { name = "tomli", marker = "python_full_version < '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/4d/14/d1f795f314c4bf3ad6d64216e370bdfda73093ed76e979485778b655a7ac/poethepoet-0.38.0.tar.gz", hash = "sha256:aeeb2f0a2cf0d3afa833976eff3ac7b8f5e472ae64171824900d79d3c68163c7", size = 77339, upload-time = "2025-11-23T13:51:28.246Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/38/89/2bf7d43ef4b0d60f446933ae9d3649f95c2c45c47b6736d121b602c28361/poethepoet-0.38.0-py3-none-any.whl", hash = "sha256:214bd9fcb348ff3dfd1466579d67e0c02242451a7044aced1a79641adef9cad0", size = 101938, upload-time = "2025-11-23T13:51:26.518Z" }, +] + +[[package]] +name = "pre-commit" +version = "4.5.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "cfgv" }, + { name = "identify" }, + { name = "nodeenv" }, + { name = "pyyaml" }, + { name = "virtualenv" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/40/f1/6d86a29246dfd2e9b6237f0b5823717f60cad94d47ddc26afa916d21f525/pre_commit-4.5.1.tar.gz", hash = "sha256:eb545fcff725875197837263e977ea257a402056661f09dae08e4b149b030a61", size = 198232, upload-time = "2025-12-16T21:14:33.552Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5d/19/fd3ef348460c80af7bb4669ea7926651d1f95c23ff2df18b9d24bab4f3fa/pre_commit-4.5.1-py2.py3-none-any.whl", hash = "sha256:3b3afd891e97337708c1674210f8eba659b52a38ea5f822ff142d10786221f77", size = 226437, upload-time = "2025-12-16T21:14:32.409Z" }, +] + +[[package]] +name = "prek" +version = "0.2.28" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/54/d7/dda8a6b7819bdb9d1f54fa046911e80974d862bacba75a3539b43a9bb858/prek-0.2.28.tar.gz", hash = "sha256:ac54f58cad26e617a5c5459b705ff1cbaaa41640db03d8d35e39645aca1b82cf", size = 283945, upload-time = "2026-01-13T15:12:20.185Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7e/8c/2e18867e31d06dfa4974bf31c4e597dc1d2b3671b3c04d85f1f6a32ebc74/prek-0.2.28-py3-none-linux_armv6l.whl", hash = "sha256:1705c0bd035379cb5f1d03c19481821363d72d7923303fe8c84fd8cc7c6c3318", size = 4802811, upload-time = "2026-01-13T15:12:14.698Z" }, + { url = "https://files.pythonhosted.org/packages/26/fa/6c6d0b0d8b2f21301da2bb3441f22232ed5a8cba1b63eeb18244d2192a2e/prek-0.2.28-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:67677c08767c278335b31ebcbf00c1c73e14eadd99a0d8537dfb43c54482673a", size = 4904156, upload-time = "2026-01-13T15:12:21.184Z" }, + { url = "https://files.pythonhosted.org/packages/fc/5a/aa071ef1c2e6c3f58b50d9138676c96dd6de2323a44e1a3e56e18d25c382/prek-0.2.28-py3-none-macosx_11_0_arm64.whl", hash = "sha256:ffac92215058ea6ba954a8e3f978dcd2a5e89922a318fcb7035fb9c0ab4de395", size = 4630803, upload-time = "2026-01-13T15:12:06.158Z" }, + { url = "https://files.pythonhosted.org/packages/77/dc/66498e805a0bb17820de0c3575d75b202c66045a9bfeeff9305d9bedd126/prek-0.2.28-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl", hash = "sha256:413c3da1c9b252b3fd5113f4a04c2dead3c793b0ec56fc55294bb797ba7ca056", size = 4826037, upload-time = "2026-01-13T15:12:12.726Z" }, + { url = "https://files.pythonhosted.org/packages/27/ad/99cccc9283c7b34cd92356fcb301a2b1c25a8b65dc34b86c671b0f8e29d8/prek-0.2.28-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e99639bb68b70704e7b3f7f1a51cb23527c4dbd4b8a01dfccaa70f26f8f6c58b", size = 4723658, upload-time = "2026-01-13T15:12:01.538Z" }, + { url = "https://files.pythonhosted.org/packages/53/13/ce3edc2dda7b65485612e08ab038b8dd1ef7b10a94b0193f527b19a5e246/prek-0.2.28-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:33c4a1b2a8a76581476ae327d6d4f1b0af6af42a90d436e21e45c72cb1081b81", size = 5044611, upload-time = "2026-01-13T15:12:26.331Z" }, + { url = "https://files.pythonhosted.org/packages/48/47/6405d7ad7959d9b57d56fec9a1b4b2e00abeb955084dd45d100fb50a8377/prek-0.2.28-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6236dda18152fc56b9f802ce2914fbb2d19f9891595d552228c7894004b3332f", size = 5511371, upload-time = "2026-01-13T15:12:24.453Z" }, + { url = "https://files.pythonhosted.org/packages/92/cc/108c227fae40268ece36b80e5649037f1a816518e9b6d585d128b263df79/prek-0.2.28-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d6506709d9a52ee431d48b249b8b5fb93597a9511eb260ee85d868750425057f", size = 5099352, upload-time = "2026-01-13T15:12:18.876Z" }, + { url = "https://files.pythonhosted.org/packages/12/d6/156ad3996d3a078a1bc2c0839b8681634216a494dcb298b8751beb28b327/prek-0.2.28-py3-none-manylinux_2_28_aarch64.whl", hash = "sha256:7cc920c12613440c105a767dc19acf048e8a05342ba38b48450d673bea33bd62", size = 4834340, upload-time = "2026-01-13T15:11:59.811Z" }, + { url = "https://files.pythonhosted.org/packages/f4/06/c632d4c4bb9c63d25bcc26149f99c715206a40e414fb6b80e7f800ae2e2d/prek-0.2.28-py3-none-manylinux_2_31_riscv64.whl", hash = "sha256:322a1922e6d2fcb2a4c487e01b2613856dc3206269bdc317ad28770704159e63", size = 4844870, upload-time = "2026-01-13T15:12:03.243Z" }, + { url = "https://files.pythonhosted.org/packages/ba/03/763f62d292399ee962e2583e7bc3fd2f8ee2609813c89cc10ec89a39204c/prek-0.2.28-py3-none-musllinux_1_1_armv7l.whl", hash = "sha256:a07baefe3562371368135eac3c8b9cdb831bac17b83cb1b6a8f5688050918e6c", size = 4709011, upload-time = "2026-01-13T15:12:04.701Z" }, + { url = "https://files.pythonhosted.org/packages/e1/62/49397d1a5c2aaf5e7a8c0644be901ee97934a8a2cac0052652d01b7c6585/prek-0.2.28-py3-none-musllinux_1_1_i686.whl", hash = "sha256:17e95cab33067365028ffc1d4ab6c80c6c150f88e352d7c64bdc15e0570778f6", size = 4928435, upload-time = "2026-01-13T15:11:58.147Z" }, + { url = "https://files.pythonhosted.org/packages/5e/e8/8ec73b5bb3fb9d5daf77f181cc46c541bd476075c7613f9b4c9c953925cc/prek-0.2.28-py3-none-musllinux_1_1_x86_64.whl", hash = "sha256:bc5272e2e8d81438a3cd2785c3b14b6e73dcb8e61b8a2b7ce6e693d57f7181ac", size = 5209880, upload-time = "2026-01-13T15:12:10.329Z" }, + { url = "https://files.pythonhosted.org/packages/f3/52/a784a52bf72619bdfaafdbb6c964bda404b377213e7dc786f9ad6024501c/prek-0.2.28-py3-none-win32.whl", hash = "sha256:74657a1663191fb5f09f15873704c2d2640095ce56277d36860bbd08ba7eea94", size = 4622786, upload-time = "2026-01-13T15:12:22.967Z" }, + { url = "https://files.pythonhosted.org/packages/d0/b8/ec6aafefeb05ef3a0bfcc044d036890f2b732b90ed1426acbf1e33289a44/prek-0.2.28-py3-none-win_amd64.whl", hash = "sha256:c350046d623362db65e2be1455ef1c5a96ea476e235445752fa946a705f1c1c9", size = 5316389, upload-time = "2026-01-13T15:12:17.501Z" }, + { url = "https://files.pythonhosted.org/packages/df/3f/9d4aba92cb9199cad0b056de8292a78dcca1dc1f6a6a34550799f19bde3d/prek-0.2.28-py3-none-win_arm64.whl", hash = "sha256:81db6ba7e5cf1d5ceec7d3b04e01aded32b8db8f1238ad812ac6ebc0bd35f141", size = 4974627, upload-time = "2026-01-13T15:11:56.333Z" }, +] + +[[package]] +name = "prompt-toolkit" +version = "3.0.51" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "wcwidth" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/bb/6e/9d084c929dfe9e3bfe0c6a47e31f78a25c54627d64a66e884a8bf5474f1c/prompt_toolkit-3.0.51.tar.gz", hash = "sha256:931a162e3b27fc90c86f1b48bb1fb2c528c2761475e57c9c06de13311c7b54ed", size = 428940, upload-time = "2025-04-15T09:18:47.731Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ce/4f/5249960887b1fbe561d9ff265496d170b55a735b76724f10ef19f9e40716/prompt_toolkit-3.0.51-py3-none-any.whl", hash = "sha256:52742911fde84e2d423e2f9a4cf1de7d7ac4e51958f648d9540e0fb8db077b07", size = 387810, upload-time = "2025-04-15T09:18:44.753Z" }, +] + +[[package]] +name = "ptyprocess" +version = "0.7.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/20/e5/16ff212c1e452235a90aeb09066144d0c5a6a8c0834397e03f5224495c4e/ptyprocess-0.7.0.tar.gz", hash = "sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220", size = 70762, upload-time = "2020-12-28T15:15:30.155Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/22/a6/858897256d0deac81a172289110f31629fc4cee19b6f01283303e18c8db3/ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35", size = 13993, upload-time = "2020-12-28T15:15:28.35Z" }, +] + +[[package]] +name = "pure-eval" +version = "0.2.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cd/05/0a34433a064256a578f1783a10da6df098ceaa4a57bbeaa96a6c0352786b/pure_eval-0.2.3.tar.gz", hash = "sha256:5f4e983f40564c576c7c8635ae88db5956bb2229d7e9237d03b3c0b0190eaf42", size = 19752, upload-time = "2024-07-21T12:58:21.801Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8e/37/efad0257dc6e593a18957422533ff0f87ede7c9c6ea010a2177d738fb82f/pure_eval-0.2.3-py3-none-any.whl", hash = "sha256:1db8e35b67b3d218d818ae653e27f06c3aa420901fa7b081ca98cbedc874e0d0", size = 11842, upload-time = "2024-07-21T12:58:20.04Z" }, +] + +[[package]] +name = "pygments" +version = "2.19.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/b0/77/a5b8c569bf593b0140bde72ea885a803b82086995367bf2037de0159d924/pygments-2.19.2.tar.gz", hash = "sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887", size = 4968631, upload-time = "2025-06-21T13:39:12.283Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c7/21/705964c7812476f378728bdf590ca4b771ec72385c533964653c68e86bdc/pygments-2.19.2-py3-none-any.whl", hash = "sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b", size = 1225217, upload-time = "2025-06-21T13:39:07.939Z" }, +] + +[[package]] +name = "pymdown-extensions" +version = "10.19.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/2d/9f30cee56d4d6d222430d401e85b0a6a1ae229819362f5786943d1a8c03b/pymdown_extensions-10.19.1.tar.gz", hash = "sha256:4969c691009a389fb1f9712dd8e7bd70dcc418d15a0faf70acb5117d022f7de8", size = 847839, upload-time = "2025-12-14T17:25:24.42Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fb/35/b763e8fbcd51968329b9adc52d188fc97859f85f2ee15fe9f379987d99c5/pymdown_extensions-10.19.1-py3-none-any.whl", hash = "sha256:e8698a66055b1dc0dca2a7f2c9d0ea6f5faa7834a9c432e3535ab96c0c4e509b", size = 266693, upload-time = "2025-12-14T17:25:22.999Z" }, +] + +[[package]] +name = "pyproject-api" +version = "1.10.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "packaging" }, + { name = "tomli", marker = "python_full_version < '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/45/7b/c0e1333b61d41c69e59e5366e727b18c4992688caf0de1be10b3e5265f6b/pyproject_api-1.10.0.tar.gz", hash = "sha256:40c6f2d82eebdc4afee61c773ed208c04c19db4c4a60d97f8d7be3ebc0bbb330", size = 22785, upload-time = "2025-10-09T19:12:27.21Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/54/cc/cecf97be298bee2b2a37dd360618c819a2a7fd95251d8e480c1f0eb88f3b/pyproject_api-1.10.0-py3-none-any.whl", hash = "sha256:8757c41a79c0f4ab71b99abed52b97ecf66bd20b04fa59da43b5840bac105a09", size = 13218, upload-time = "2025-10-09T19:12:24.428Z" }, +] + +[[package]] +name = "pytest" +version = "9.0.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "exceptiongroup", marker = "python_full_version < '3.11'" }, + { name = "iniconfig" }, + { name = "packaging" }, + { name = "pluggy" }, + { name = "pygments" }, + { name = "tomli", marker = "python_full_version < '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/d1/db/7ef3487e0fb0049ddb5ce41d3a49c235bf9ad299b6a25d5780a89f19230f/pytest-9.0.2.tar.gz", hash = "sha256:75186651a92bd89611d1d9fc20f0b4345fd827c41ccd5c299a868a05d70edf11", size = 1568901, upload-time = "2025-12-06T21:30:51.014Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3b/ab/b3226f0bd7cdcf710fbede2b3548584366da3b19b5021e74f5bde2a8fa3f/pytest-9.0.2-py3-none-any.whl", hash = "sha256:711ffd45bf766d5264d487b917733b453d917afd2b0ad65223959f59089f875b", size = 374801, upload-time = "2025-12-06T21:30:49.154Z" }, +] + +[[package]] +name = "pytest-cov" +version = "7.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "coverage", extra = ["toml"] }, + { name = "pluggy" }, + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/5e/f7/c933acc76f5208b3b00089573cf6a2bc26dc80a8aece8f52bb7d6b1855ca/pytest_cov-7.0.0.tar.gz", hash = "sha256:33c97eda2e049a0c5298e91f519302a1334c26ac65c1a483d6206fd458361af1", size = 54328, upload-time = "2025-09-09T10:57:02.113Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ee/49/1377b49de7d0c1ce41292161ea0f721913fa8722c19fb9c1e3aa0367eecb/pytest_cov-7.0.0-py3-none-any.whl", hash = "sha256:3b8e9558b16cc1479da72058bdecf8073661c7f57f7d3c5f22a1c23507f2d861", size = 22424, upload-time = "2025-09-09T10:57:00.695Z" }, +] + +[[package]] +name = "pytest-datadir" +version = "1.8.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b4/46/db060b291999ca048edd06d6fa9ee95945d088edc38b1172c59eeb46ec45/pytest_datadir-1.8.0.tar.gz", hash = "sha256:7a15faed76cebe87cc91941dd1920a9a38eba56a09c11e9ddf1434d28a0f78eb", size = 11848, upload-time = "2025-07-30T13:52:12.518Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8f/7a/33895863aec26ac3bb5068a73583f935680d6ab6af2a9567d409430c3ee1/pytest_datadir-1.8.0-py3-none-any.whl", hash = "sha256:5c677bc097d907ac71ca418109adc3abe34cf0bddfe6cf78aecfbabd96a15cf0", size = 6512, upload-time = "2025-07-30T13:52:11.525Z" }, +] + +[[package]] +name = "pytest-freezer" +version = "0.4.9" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "freezegun" }, + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/81/f0/98dcbc5324064360b19850b14c84cea9ca50785d921741dbfc442346e925/pytest_freezer-0.4.9.tar.gz", hash = "sha256:21bf16bc9cc46bf98f94382c4b5c3c389be7056ff0be33029111ae11b3f1c82a", size = 3177, upload-time = "2024-12-12T08:53:08.684Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c1/e9/30252bc05bcf67200a17f4f0b4cc7598f0a68df4fa9fa356193aa899f145/pytest_freezer-0.4.9-py3-none-any.whl", hash = "sha256:8b6c50523b7d4aec4590b52bfa5ff766d772ce506e2bf4846c88041ea9ccae59", size = 3192, upload-time = "2024-12-12T08:53:07.641Z" }, +] + +[[package]] +name = "pytest-gitconfig" +version = "0.9.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f5/c7/39ad46d239bf49e6c1c8b4f6b99e75c8bee7bfc1e83cd8542d8701190508/pytest_gitconfig-0.9.0.tar.gz", hash = "sha256:5f9e8a29b4a8e55ddd740216ddb0a8a5e97f1c9c7f6bfdac91863473a8c60f9c", size = 10078, upload-time = "2025-12-28T01:52:17.821Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d9/78/460084e968adb270fa1b15d3b125d3d6da25514293e05c811820a19bfc04/pytest_gitconfig-0.9.0-py3-none-any.whl", hash = "sha256:3d855a9dd5fb3906010dbb1f8161366d4d86b34df8c14021fa012f23de3e5354", size = 7113, upload-time = "2025-12-28T01:52:16.395Z" }, +] + +[[package]] +name = "pytest-mock" +version = "3.15.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/68/14/eb014d26be205d38ad5ad20d9a80f7d201472e08167f0bb4361e251084a9/pytest_mock-3.15.1.tar.gz", hash = "sha256:1849a238f6f396da19762269de72cb1814ab44416fa73a8686deac10b0d87a0f", size = 34036, upload-time = "2025-09-16T16:37:27.081Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5a/cc/06253936f4a7fa2e0f48dfe6d851d9c56df896a9ab09ac019d70b760619c/pytest_mock-3.15.1-py3-none-any.whl", hash = "sha256:0a25e2eb88fe5168d535041d09a4529a188176ae608a6d249ee65abc0949630d", size = 10095, upload-time = "2025-09-16T16:37:25.734Z" }, +] + +[[package]] +name = "pytest-regressions" +version = "2.8.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytest" }, + { name = "pytest-datadir" }, + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/3a/63/cdb0ee15012a538fa07de21ec0a5c8eb113db9f28378f67b538d1c0b6d04/pytest_regressions-2.8.3.tar.gz", hash = "sha256:1ad90708bee02a3d36c78ef0b6f9692a9a30d312dd828680fd6d2a7235fcd221", size = 117168, upload-time = "2025-09-05T12:51:32.319Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/55/b9/7b2fe8407744cc37a74e29bed833256a305133505ea4979564911a98338b/pytest_regressions-2.8.3-py3-none-any.whl", hash = "sha256:72500dd95bde418c850f290a3108dacb56427067f364f7112cb5b16f6d6cc29c", size = 24894, upload-time = "2025-09-05T12:51:31.1Z" }, +] + +[[package]] +name = "pytest-xdist" +version = "3.8.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "execnet" }, + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/78/b4/439b179d1ff526791eb921115fca8e44e596a13efeda518b9d845a619450/pytest_xdist-3.8.0.tar.gz", hash = "sha256:7e578125ec9bc6050861aa93f2d59f1d8d085595d6551c2c90b6f4fad8d3a9f1", size = 88069, upload-time = "2025-07-01T13:30:59.346Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ca/31/d4e37e9e550c2b92a9cbc2e4d0b7420a27224968580b5a447f420847c975/pytest_xdist-3.8.0-py3-none-any.whl", hash = "sha256:202ca578cfeb7370784a8c33d6d05bc6e13b4f25b5053c30a152269fd10f0b88", size = 46396, upload-time = "2025-07-01T13:30:56.632Z" }, +] + +[[package]] +name = "python-dateutil" +version = "2.9.0.post0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "six" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/66/c0/0c8b6ad9f17a802ee498c46e004a0eb49bc148f2fd230864601a86dcf6db/python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3", size = 342432, upload-time = "2024-03-01T18:36:20.211Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ec/57/56b9bcc3c9c6a792fcbaf139543cee77261f3651ca9da0c93f5c1221264b/python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427", size = 229892, upload-time = "2024-03-01T18:36:18.57Z" }, +] + +[[package]] +name = "pyyaml" +version = "6.0.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/05/8e/961c0007c59b8dd7729d542c61a4d537767a59645b82a0b521206e1e25c2/pyyaml-6.0.3.tar.gz", hash = "sha256:d76623373421df22fb4cf8817020cbb7ef15c725b9d5e45f17e189bfc384190f", size = 130960, upload-time = "2025-09-25T21:33:16.546Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f4/a0/39350dd17dd6d6c6507025c0e53aef67a9293a6d37d3511f23ea510d5800/pyyaml-6.0.3-cp310-cp310-macosx_10_13_x86_64.whl", hash = "sha256:214ed4befebe12df36bcc8bc2b64b396ca31be9304b8f59e25c11cf94a4c033b", size = 184227, upload-time = "2025-09-25T21:31:46.04Z" }, + { url = "https://files.pythonhosted.org/packages/05/14/52d505b5c59ce73244f59c7a50ecf47093ce4765f116cdb98286a71eeca2/pyyaml-6.0.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:02ea2dfa234451bbb8772601d7b8e426c2bfa197136796224e50e35a78777956", size = 174019, upload-time = "2025-09-25T21:31:47.706Z" }, + { url = "https://files.pythonhosted.org/packages/43/f7/0e6a5ae5599c838c696adb4e6330a59f463265bfa1e116cfd1fbb0abaaae/pyyaml-6.0.3-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b30236e45cf30d2b8e7b3e85881719e98507abed1011bf463a8fa23e9c3e98a8", size = 740646, upload-time = "2025-09-25T21:31:49.21Z" }, + { url = "https://files.pythonhosted.org/packages/2f/3a/61b9db1d28f00f8fd0ae760459a5c4bf1b941baf714e207b6eb0657d2578/pyyaml-6.0.3-cp310-cp310-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:66291b10affd76d76f54fad28e22e51719ef9ba22b29e1d7d03d6777a9174198", size = 840793, upload-time = "2025-09-25T21:31:50.735Z" }, + { url = "https://files.pythonhosted.org/packages/7a/1e/7acc4f0e74c4b3d9531e24739e0ab832a5edf40e64fbae1a9c01941cabd7/pyyaml-6.0.3-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:9c7708761fccb9397fe64bbc0395abcae8c4bf7b0eac081e12b809bf47700d0b", size = 770293, upload-time = "2025-09-25T21:31:51.828Z" }, + { url = "https://files.pythonhosted.org/packages/8b/ef/abd085f06853af0cd59fa5f913d61a8eab65d7639ff2a658d18a25d6a89d/pyyaml-6.0.3-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:418cf3f2111bc80e0933b2cd8cd04f286338bb88bdc7bc8e6dd775ebde60b5e0", size = 732872, upload-time = "2025-09-25T21:31:53.282Z" }, + { url = "https://files.pythonhosted.org/packages/1f/15/2bc9c8faf6450a8b3c9fc5448ed869c599c0a74ba2669772b1f3a0040180/pyyaml-6.0.3-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:5e0b74767e5f8c593e8c9b5912019159ed0533c70051e9cce3e8b6aa699fcd69", size = 758828, upload-time = "2025-09-25T21:31:54.807Z" }, + { url = "https://files.pythonhosted.org/packages/a3/00/531e92e88c00f4333ce359e50c19b8d1de9fe8d581b1534e35ccfbc5f393/pyyaml-6.0.3-cp310-cp310-win32.whl", hash = "sha256:28c8d926f98f432f88adc23edf2e6d4921ac26fb084b028c733d01868d19007e", size = 142415, upload-time = "2025-09-25T21:31:55.885Z" }, + { url = "https://files.pythonhosted.org/packages/2a/fa/926c003379b19fca39dd4634818b00dec6c62d87faf628d1394e137354d4/pyyaml-6.0.3-cp310-cp310-win_amd64.whl", hash = "sha256:bdb2c67c6c1390b63c6ff89f210c8fd09d9a1217a465701eac7316313c915e4c", size = 158561, upload-time = "2025-09-25T21:31:57.406Z" }, + { url = "https://files.pythonhosted.org/packages/6d/16/a95b6757765b7b031c9374925bb718d55e0a9ba8a1b6a12d25962ea44347/pyyaml-6.0.3-cp311-cp311-macosx_10_13_x86_64.whl", hash = "sha256:44edc647873928551a01e7a563d7452ccdebee747728c1080d881d68af7b997e", size = 185826, upload-time = "2025-09-25T21:31:58.655Z" }, + { url = "https://files.pythonhosted.org/packages/16/19/13de8e4377ed53079ee996e1ab0a9c33ec2faf808a4647b7b4c0d46dd239/pyyaml-6.0.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:652cb6edd41e718550aad172851962662ff2681490a8a711af6a4d288dd96824", size = 175577, upload-time = "2025-09-25T21:32:00.088Z" }, + { url = "https://files.pythonhosted.org/packages/0c/62/d2eb46264d4b157dae1275b573017abec435397aa59cbcdab6fc978a8af4/pyyaml-6.0.3-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:10892704fc220243f5305762e276552a0395f7beb4dbf9b14ec8fd43b57f126c", size = 775556, upload-time = "2025-09-25T21:32:01.31Z" }, + { url = "https://files.pythonhosted.org/packages/10/cb/16c3f2cf3266edd25aaa00d6c4350381c8b012ed6f5276675b9eba8d9ff4/pyyaml-6.0.3-cp311-cp311-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:850774a7879607d3a6f50d36d04f00ee69e7fc816450e5f7e58d7f17f1ae5c00", size = 882114, upload-time = "2025-09-25T21:32:03.376Z" }, + { url = "https://files.pythonhosted.org/packages/71/60/917329f640924b18ff085ab889a11c763e0b573da888e8404ff486657602/pyyaml-6.0.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b8bb0864c5a28024fac8a632c443c87c5aa6f215c0b126c449ae1a150412f31d", size = 806638, upload-time = "2025-09-25T21:32:04.553Z" }, + { url = "https://files.pythonhosted.org/packages/dd/6f/529b0f316a9fd167281a6c3826b5583e6192dba792dd55e3203d3f8e655a/pyyaml-6.0.3-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1d37d57ad971609cf3c53ba6a7e365e40660e3be0e5175fa9f2365a379d6095a", size = 767463, upload-time = "2025-09-25T21:32:06.152Z" }, + { url = "https://files.pythonhosted.org/packages/f2/6a/b627b4e0c1dd03718543519ffb2f1deea4a1e6d42fbab8021936a4d22589/pyyaml-6.0.3-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:37503bfbfc9d2c40b344d06b2199cf0e96e97957ab1c1b546fd4f87e53e5d3e4", size = 794986, upload-time = "2025-09-25T21:32:07.367Z" }, + { url = "https://files.pythonhosted.org/packages/45/91/47a6e1c42d9ee337c4839208f30d9f09caa9f720ec7582917b264defc875/pyyaml-6.0.3-cp311-cp311-win32.whl", hash = "sha256:8098f252adfa6c80ab48096053f512f2321f0b998f98150cea9bd23d83e1467b", size = 142543, upload-time = "2025-09-25T21:32:08.95Z" }, + { url = "https://files.pythonhosted.org/packages/da/e3/ea007450a105ae919a72393cb06f122f288ef60bba2dc64b26e2646fa315/pyyaml-6.0.3-cp311-cp311-win_amd64.whl", hash = "sha256:9f3bfb4965eb874431221a3ff3fdcddc7e74e3b07799e0e84ca4a0f867d449bf", size = 158763, upload-time = "2025-09-25T21:32:09.96Z" }, + { url = "https://files.pythonhosted.org/packages/d1/33/422b98d2195232ca1826284a76852ad5a86fe23e31b009c9886b2d0fb8b2/pyyaml-6.0.3-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:7f047e29dcae44602496db43be01ad42fc6f1cc0d8cd6c83d342306c32270196", size = 182063, upload-time = "2025-09-25T21:32:11.445Z" }, + { url = "https://files.pythonhosted.org/packages/89/a0/6cf41a19a1f2f3feab0e9c0b74134aa2ce6849093d5517a0c550fe37a648/pyyaml-6.0.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:fc09d0aa354569bc501d4e787133afc08552722d3ab34836a80547331bb5d4a0", size = 173973, upload-time = "2025-09-25T21:32:12.492Z" }, + { url = "https://files.pythonhosted.org/packages/ed/23/7a778b6bd0b9a8039df8b1b1d80e2e2ad78aa04171592c8a5c43a56a6af4/pyyaml-6.0.3-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9149cad251584d5fb4981be1ecde53a1ca46c891a79788c0df828d2f166bda28", size = 775116, upload-time = "2025-09-25T21:32:13.652Z" }, + { url = "https://files.pythonhosted.org/packages/65/30/d7353c338e12baef4ecc1b09e877c1970bd3382789c159b4f89d6a70dc09/pyyaml-6.0.3-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:5fdec68f91a0c6739b380c83b951e2c72ac0197ace422360e6d5a959d8d97b2c", size = 844011, upload-time = "2025-09-25T21:32:15.21Z" }, + { url = "https://files.pythonhosted.org/packages/8b/9d/b3589d3877982d4f2329302ef98a8026e7f4443c765c46cfecc8858c6b4b/pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ba1cc08a7ccde2d2ec775841541641e4548226580ab850948cbfda66a1befcdc", size = 807870, upload-time = "2025-09-25T21:32:16.431Z" }, + { url = "https://files.pythonhosted.org/packages/05/c0/b3be26a015601b822b97d9149ff8cb5ead58c66f981e04fedf4e762f4bd4/pyyaml-6.0.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8dc52c23056b9ddd46818a57b78404882310fb473d63f17b07d5c40421e47f8e", size = 761089, upload-time = "2025-09-25T21:32:17.56Z" }, + { url = "https://files.pythonhosted.org/packages/be/8e/98435a21d1d4b46590d5459a22d88128103f8da4c2d4cb8f14f2a96504e1/pyyaml-6.0.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:41715c910c881bc081f1e8872880d3c650acf13dfa8214bad49ed4cede7c34ea", size = 790181, upload-time = "2025-09-25T21:32:18.834Z" }, + { url = "https://files.pythonhosted.org/packages/74/93/7baea19427dcfbe1e5a372d81473250b379f04b1bd3c4c5ff825e2327202/pyyaml-6.0.3-cp312-cp312-win32.whl", hash = "sha256:96b533f0e99f6579b3d4d4995707cf36df9100d67e0c8303a0c55b27b5f99bc5", size = 137658, upload-time = "2025-09-25T21:32:20.209Z" }, + { url = "https://files.pythonhosted.org/packages/86/bf/899e81e4cce32febab4fb42bb97dcdf66bc135272882d1987881a4b519e9/pyyaml-6.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:5fcd34e47f6e0b794d17de1b4ff496c00986e1c83f7ab2fb8fcfe9616ff7477b", size = 154003, upload-time = "2025-09-25T21:32:21.167Z" }, + { url = "https://files.pythonhosted.org/packages/1a/08/67bd04656199bbb51dbed1439b7f27601dfb576fb864099c7ef0c3e55531/pyyaml-6.0.3-cp312-cp312-win_arm64.whl", hash = "sha256:64386e5e707d03a7e172c0701abfb7e10f0fb753ee1d773128192742712a98fd", size = 140344, upload-time = "2025-09-25T21:32:22.617Z" }, + { url = "https://files.pythonhosted.org/packages/d1/11/0fd08f8192109f7169db964b5707a2f1e8b745d4e239b784a5a1dd80d1db/pyyaml-6.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:8da9669d359f02c0b91ccc01cac4a67f16afec0dac22c2ad09f46bee0697eba8", size = 181669, upload-time = "2025-09-25T21:32:23.673Z" }, + { url = "https://files.pythonhosted.org/packages/b1/16/95309993f1d3748cd644e02e38b75d50cbc0d9561d21f390a76242ce073f/pyyaml-6.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:2283a07e2c21a2aa78d9c4442724ec1eb15f5e42a723b99cb3d822d48f5f7ad1", size = 173252, upload-time = "2025-09-25T21:32:25.149Z" }, + { url = "https://files.pythonhosted.org/packages/50/31/b20f376d3f810b9b2371e72ef5adb33879b25edb7a6d072cb7ca0c486398/pyyaml-6.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ee2922902c45ae8ccada2c5b501ab86c36525b883eff4255313a253a3160861c", size = 767081, upload-time = "2025-09-25T21:32:26.575Z" }, + { url = "https://files.pythonhosted.org/packages/49/1e/a55ca81e949270d5d4432fbbd19dfea5321eda7c41a849d443dc92fd1ff7/pyyaml-6.0.3-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a33284e20b78bd4a18c8c2282d549d10bc8408a2a7ff57653c0cf0b9be0afce5", size = 841159, upload-time = "2025-09-25T21:32:27.727Z" }, + { url = "https://files.pythonhosted.org/packages/74/27/e5b8f34d02d9995b80abcef563ea1f8b56d20134d8f4e5e81733b1feceb2/pyyaml-6.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0f29edc409a6392443abf94b9cf89ce99889a1dd5376d94316ae5145dfedd5d6", size = 801626, upload-time = "2025-09-25T21:32:28.878Z" }, + { url = "https://files.pythonhosted.org/packages/f9/11/ba845c23988798f40e52ba45f34849aa8a1f2d4af4b798588010792ebad6/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f7057c9a337546edc7973c0d3ba84ddcdf0daa14533c2065749c9075001090e6", size = 753613, upload-time = "2025-09-25T21:32:30.178Z" }, + { url = "https://files.pythonhosted.org/packages/3d/e0/7966e1a7bfc0a45bf0a7fb6b98ea03fc9b8d84fa7f2229e9659680b69ee3/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:eda16858a3cab07b80edaf74336ece1f986ba330fdb8ee0d6c0d68fe82bc96be", size = 794115, upload-time = "2025-09-25T21:32:31.353Z" }, + { url = "https://files.pythonhosted.org/packages/de/94/980b50a6531b3019e45ddeada0626d45fa85cbe22300844a7983285bed3b/pyyaml-6.0.3-cp313-cp313-win32.whl", hash = "sha256:d0eae10f8159e8fdad514efdc92d74fd8d682c933a6dd088030f3834bc8e6b26", size = 137427, upload-time = "2025-09-25T21:32:32.58Z" }, + { url = "https://files.pythonhosted.org/packages/97/c9/39d5b874e8b28845e4ec2202b5da735d0199dbe5b8fb85f91398814a9a46/pyyaml-6.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:79005a0d97d5ddabfeeea4cf676af11e647e41d81c9a7722a193022accdb6b7c", size = 154090, upload-time = "2025-09-25T21:32:33.659Z" }, + { url = "https://files.pythonhosted.org/packages/73/e8/2bdf3ca2090f68bb3d75b44da7bbc71843b19c9f2b9cb9b0f4ab7a5a4329/pyyaml-6.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:5498cd1645aa724a7c71c8f378eb29ebe23da2fc0d7a08071d89469bf1d2defb", size = 140246, upload-time = "2025-09-25T21:32:34.663Z" }, + { url = "https://files.pythonhosted.org/packages/9d/8c/f4bd7f6465179953d3ac9bc44ac1a8a3e6122cf8ada906b4f96c60172d43/pyyaml-6.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:8d1fab6bb153a416f9aeb4b8763bc0f22a5586065f86f7664fc23339fc1c1fac", size = 181814, upload-time = "2025-09-25T21:32:35.712Z" }, + { url = "https://files.pythonhosted.org/packages/bd/9c/4d95bb87eb2063d20db7b60faa3840c1b18025517ae857371c4dd55a6b3a/pyyaml-6.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:34d5fcd24b8445fadc33f9cf348c1047101756fd760b4dacb5c3e99755703310", size = 173809, upload-time = "2025-09-25T21:32:36.789Z" }, + { url = "https://files.pythonhosted.org/packages/92/b5/47e807c2623074914e29dabd16cbbdd4bf5e9b2db9f8090fa64411fc5382/pyyaml-6.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:501a031947e3a9025ed4405a168e6ef5ae3126c59f90ce0cd6f2bfc477be31b7", size = 766454, upload-time = "2025-09-25T21:32:37.966Z" }, + { url = "https://files.pythonhosted.org/packages/02/9e/e5e9b168be58564121efb3de6859c452fccde0ab093d8438905899a3a483/pyyaml-6.0.3-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:b3bc83488de33889877a0f2543ade9f70c67d66d9ebb4ac959502e12de895788", size = 836355, upload-time = "2025-09-25T21:32:39.178Z" }, + { url = "https://files.pythonhosted.org/packages/88/f9/16491d7ed2a919954993e48aa941b200f38040928474c9e85ea9e64222c3/pyyaml-6.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c458b6d084f9b935061bc36216e8a69a7e293a2f1e68bf956dcd9e6cbcd143f5", size = 794175, upload-time = "2025-09-25T21:32:40.865Z" }, + { url = "https://files.pythonhosted.org/packages/dd/3f/5989debef34dc6397317802b527dbbafb2b4760878a53d4166579111411e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7c6610def4f163542a622a73fb39f534f8c101d690126992300bf3207eab9764", size = 755228, upload-time = "2025-09-25T21:32:42.084Z" }, + { url = "https://files.pythonhosted.org/packages/d7/ce/af88a49043cd2e265be63d083fc75b27b6ed062f5f9fd6cdc223ad62f03e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:5190d403f121660ce8d1d2c1bb2ef1bd05b5f68533fc5c2ea899bd15f4399b35", size = 789194, upload-time = "2025-09-25T21:32:43.362Z" }, + { url = "https://files.pythonhosted.org/packages/23/20/bb6982b26a40bb43951265ba29d4c246ef0ff59c9fdcdf0ed04e0687de4d/pyyaml-6.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:4a2e8cebe2ff6ab7d1050ecd59c25d4c8bd7e6f400f5f82b96557ac0abafd0ac", size = 156429, upload-time = "2025-09-25T21:32:57.844Z" }, + { url = "https://files.pythonhosted.org/packages/f4/f4/a4541072bb9422c8a883ab55255f918fa378ecf083f5b85e87fc2b4eda1b/pyyaml-6.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:93dda82c9c22deb0a405ea4dc5f2d0cda384168e466364dec6255b293923b2f3", size = 143912, upload-time = "2025-09-25T21:32:59.247Z" }, + { url = "https://files.pythonhosted.org/packages/7c/f9/07dd09ae774e4616edf6cda684ee78f97777bdd15847253637a6f052a62f/pyyaml-6.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:02893d100e99e03eda1c8fd5c441d8c60103fd175728e23e431db1b589cf5ab3", size = 189108, upload-time = "2025-09-25T21:32:44.377Z" }, + { url = "https://files.pythonhosted.org/packages/4e/78/8d08c9fb7ce09ad8c38ad533c1191cf27f7ae1effe5bb9400a46d9437fcf/pyyaml-6.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c1ff362665ae507275af2853520967820d9124984e0f7466736aea23d8611fba", size = 183641, upload-time = "2025-09-25T21:32:45.407Z" }, + { url = "https://files.pythonhosted.org/packages/7b/5b/3babb19104a46945cf816d047db2788bcaf8c94527a805610b0289a01c6b/pyyaml-6.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6adc77889b628398debc7b65c073bcb99c4a0237b248cacaf3fe8a557563ef6c", size = 831901, upload-time = "2025-09-25T21:32:48.83Z" }, + { url = "https://files.pythonhosted.org/packages/8b/cc/dff0684d8dc44da4d22a13f35f073d558c268780ce3c6ba1b87055bb0b87/pyyaml-6.0.3-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a80cb027f6b349846a3bf6d73b5e95e782175e52f22108cfa17876aaeff93702", size = 861132, upload-time = "2025-09-25T21:32:50.149Z" }, + { url = "https://files.pythonhosted.org/packages/b1/5e/f77dc6b9036943e285ba76b49e118d9ea929885becb0a29ba8a7c75e29fe/pyyaml-6.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:00c4bdeba853cc34e7dd471f16b4114f4162dc03e6b7afcc2128711f0eca823c", size = 839261, upload-time = "2025-09-25T21:32:51.808Z" }, + { url = "https://files.pythonhosted.org/packages/ce/88/a9db1376aa2a228197c58b37302f284b5617f56a5d959fd1763fb1675ce6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:66e1674c3ef6f541c35191caae2d429b967b99e02040f5ba928632d9a7f0f065", size = 805272, upload-time = "2025-09-25T21:32:52.941Z" }, + { url = "https://files.pythonhosted.org/packages/da/92/1446574745d74df0c92e6aa4a7b0b3130706a4142b2d1a5869f2eaa423c6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:16249ee61e95f858e83976573de0f5b2893b3677ba71c9dd36b9cf8be9ac6d65", size = 829923, upload-time = "2025-09-25T21:32:54.537Z" }, + { url = "https://files.pythonhosted.org/packages/f0/7a/1c7270340330e575b92f397352af856a8c06f230aa3e76f86b39d01b416a/pyyaml-6.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4ad1906908f2f5ae4e5a8ddfce73c320c2a1429ec52eafd27138b7f1cbe341c9", size = 174062, upload-time = "2025-09-25T21:32:55.767Z" }, + { url = "https://files.pythonhosted.org/packages/f1/12/de94a39c2ef588c7e6455cfbe7343d3b2dc9d6b6b2f40c4c6565744c873d/pyyaml-6.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:ebc55a14a21cb14062aa4162f906cd962b28e2e9ea38f9b4391244cd8de4ae0b", size = 149341, upload-time = "2025-09-25T21:32:56.828Z" }, +] + +[[package]] +name = "pyyaml-env-tag" +version = "1.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyyaml" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/eb/2e/79c822141bfd05a853236b504869ebc6b70159afc570e1d5a20641782eaa/pyyaml_env_tag-1.1.tar.gz", hash = "sha256:2eb38b75a2d21ee0475d6d97ec19c63287a7e140231e4214969d0eac923cd7ff", size = 5737, upload-time = "2025-05-13T15:24:01.64Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/04/11/432f32f8097b03e3cd5fe57e88efb685d964e2e5178a48ed61e841f7fdce/pyyaml_env_tag-1.1-py3-none-any.whl", hash = "sha256:17109e1a528561e32f026364712fee1264bc2ea6715120891174ed1b980d2e04", size = 4722, upload-time = "2025-05-13T15:23:59.629Z" }, +] + +[[package]] +name = "questionary" +version = "2.1.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "prompt-toolkit" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f6/45/eafb0bba0f9988f6a2520f9ca2df2c82ddfa8d67c95d6625452e97b204a5/questionary-2.1.1.tar.gz", hash = "sha256:3d7e980292bb0107abaa79c68dd3eee3c561b83a0f89ae482860b181c8bd412d", size = 25845, upload-time = "2025-08-28T19:00:20.851Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3c/26/1062c7ec1b053db9e499b4d2d5bc231743201b74051c973dadeac80a8f43/questionary-2.1.1-py3-none-any.whl", hash = "sha256:a51af13f345f1cdea62347589fbb6df3b290306ab8930713bfae4d475a7d4a59", size = 36753, upload-time = "2025-08-28T19:00:19.56Z" }, +] + +[[package]] +name = "requests" +version = "2.33.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "certifi" }, + { name = "charset-normalizer" }, + { name = "idna" }, + { name = "urllib3" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/34/64/8860370b167a9721e8956ae116825caff829224fbca0ca6e7bf8ddef8430/requests-2.33.0.tar.gz", hash = "sha256:c7ebc5e8b0f21837386ad0e1c8fe8b829fa5f544d8df3b2253bff14ef29d7652", size = 134232, upload-time = "2026-03-25T15:10:41.586Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/56/5d/c814546c2333ceea4ba42262d8c4d55763003e767fa169adc693bd524478/requests-2.33.0-py3-none-any.whl", hash = "sha256:3324635456fa185245e24865e810cecec7b4caf933d7eb133dcde67d48cee69b", size = 65017, upload-time = "2026-03-25T15:10:40.382Z" }, +] + +[[package]] +name = "rich" +version = "14.2.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown-it-py" }, + { name = "pygments" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/fb/d2/8920e102050a0de7bfabeb4c4614a49248cf8d5d7a8d01885fbb24dc767a/rich-14.2.0.tar.gz", hash = "sha256:73ff50c7c0c1c77c8243079283f4edb376f0f6442433aecb8ce7e6d0b92d1fe4", size = 219990, upload-time = "2025-10-09T14:16:53.064Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/25/7a/b0178788f8dc6cafce37a212c99565fa1fe7872c70c6c9c1e1a372d9d88f/rich-14.2.0-py3-none-any.whl", hash = "sha256:76bc51fe2e57d2b1be1f96c524b890b816e334ab4c1e45888799bfaab0021edd", size = 243393, upload-time = "2025-10-09T14:16:51.245Z" }, +] + +[[package]] +name = "ruff" +version = "0.14.10" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/57/08/52232a877978dd8f9cf2aeddce3e611b40a63287dfca29b6b8da791f5e8d/ruff-0.14.10.tar.gz", hash = "sha256:9a2e830f075d1a42cd28420d7809ace390832a490ed0966fe373ba288e77aaf4", size = 5859763, upload-time = "2025-12-18T19:28:57.98Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/60/01/933704d69f3f05ee16ef11406b78881733c186fe14b6a46b05cfcaf6d3b2/ruff-0.14.10-py3-none-linux_armv6l.whl", hash = "sha256:7a3ce585f2ade3e1f29ec1b92df13e3da262178df8c8bdf876f48fa0e8316c49", size = 13527080, upload-time = "2025-12-18T19:29:25.642Z" }, + { url = "https://files.pythonhosted.org/packages/df/58/a0349197a7dfa603ffb7f5b0470391efa79ddc327c1e29c4851e85b09cc5/ruff-0.14.10-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:674f9be9372907f7257c51f1d4fc902cb7cf014b9980152b802794317941f08f", size = 13797320, upload-time = "2025-12-18T19:29:02.571Z" }, + { url = "https://files.pythonhosted.org/packages/7b/82/36be59f00a6082e38c23536df4e71cdbc6af8d7c707eade97fcad5c98235/ruff-0.14.10-py3-none-macosx_11_0_arm64.whl", hash = "sha256:d85713d522348837ef9df8efca33ccb8bd6fcfc86a2cde3ccb4bc9d28a18003d", size = 12918434, upload-time = "2025-12-18T19:28:51.202Z" }, + { url = "https://files.pythonhosted.org/packages/a6/00/45c62a7f7e34da92a25804f813ebe05c88aa9e0c25e5cb5a7d23dd7450e3/ruff-0.14.10-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6987ebe0501ae4f4308d7d24e2d0fe3d7a98430f5adfd0f1fead050a740a3a77", size = 13371961, upload-time = "2025-12-18T19:29:04.991Z" }, + { url = "https://files.pythonhosted.org/packages/40/31/a5906d60f0405f7e57045a70f2d57084a93ca7425f22e1d66904769d1628/ruff-0.14.10-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:16a01dfb7b9e4eee556fbfd5392806b1b8550c9b4a9f6acd3dbe6812b193c70a", size = 13275629, upload-time = "2025-12-18T19:29:21.381Z" }, + { url = "https://files.pythonhosted.org/packages/3e/60/61c0087df21894cf9d928dc04bcd4fb10e8b2e8dca7b1a276ba2155b2002/ruff-0.14.10-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7165d31a925b7a294465fa81be8c12a0e9b60fb02bf177e79067c867e71f8b1f", size = 14029234, upload-time = "2025-12-18T19:29:00.132Z" }, + { url = "https://files.pythonhosted.org/packages/44/84/77d911bee3b92348b6e5dab5a0c898d87084ea03ac5dc708f46d88407def/ruff-0.14.10-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:c561695675b972effb0c0a45db233f2c816ff3da8dcfbe7dfc7eed625f218935", size = 15449890, upload-time = "2025-12-18T19:28:53.573Z" }, + { url = "https://files.pythonhosted.org/packages/e9/36/480206eaefa24a7ec321582dda580443a8f0671fdbf6b1c80e9c3e93a16a/ruff-0.14.10-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4bb98fcbbc61725968893682fd4df8966a34611239c9fd07a1f6a07e7103d08e", size = 15123172, upload-time = "2025-12-18T19:29:23.453Z" }, + { url = "https://files.pythonhosted.org/packages/5c/38/68e414156015ba80cef5473d57919d27dfb62ec804b96180bafdeaf0e090/ruff-0.14.10-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f24b47993a9d8cb858429e97bdf8544c78029f09b520af615c1d261bf827001d", size = 14460260, upload-time = "2025-12-18T19:29:27.808Z" }, + { url = "https://files.pythonhosted.org/packages/b3/19/9e050c0dca8aba824d67cc0db69fb459c28d8cd3f6855b1405b3f29cc91d/ruff-0.14.10-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:59aabd2e2c4fd614d2862e7939c34a532c04f1084476d6833dddef4afab87e9f", size = 14229978, upload-time = "2025-12-18T19:29:11.32Z" }, + { url = "https://files.pythonhosted.org/packages/51/eb/e8dd1dd6e05b9e695aa9dd420f4577debdd0f87a5ff2fedda33c09e9be8c/ruff-0.14.10-py3-none-manylinux_2_31_riscv64.whl", hash = "sha256:213db2b2e44be8625002dbea33bb9c60c66ea2c07c084a00d55732689d697a7f", size = 14338036, upload-time = "2025-12-18T19:29:09.184Z" }, + { url = "https://files.pythonhosted.org/packages/6a/12/f3e3a505db7c19303b70af370d137795fcfec136d670d5de5391e295c134/ruff-0.14.10-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:b914c40ab64865a17a9a5b67911d14df72346a634527240039eb3bd650e5979d", size = 13264051, upload-time = "2025-12-18T19:29:13.431Z" }, + { url = "https://files.pythonhosted.org/packages/08/64/8c3a47eaccfef8ac20e0484e68e0772013eb85802f8a9f7603ca751eb166/ruff-0.14.10-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:1484983559f026788e3a5c07c81ef7d1e97c1c78ed03041a18f75df104c45405", size = 13283998, upload-time = "2025-12-18T19:29:06.994Z" }, + { url = "https://files.pythonhosted.org/packages/12/84/534a5506f4074e5cc0529e5cd96cfc01bb480e460c7edf5af70d2bcae55e/ruff-0.14.10-py3-none-musllinux_1_2_i686.whl", hash = "sha256:c70427132db492d25f982fffc8d6c7535cc2fd2c83fc8888f05caaa248521e60", size = 13601891, upload-time = "2025-12-18T19:28:55.811Z" }, + { url = "https://files.pythonhosted.org/packages/0d/1e/14c916087d8598917dbad9b2921d340f7884824ad6e9c55de948a93b106d/ruff-0.14.10-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:5bcf45b681e9f1ee6445d317ce1fa9d6cba9a6049542d1c3d5b5958986be8830", size = 14336660, upload-time = "2025-12-18T19:29:16.531Z" }, + { url = "https://files.pythonhosted.org/packages/f2/1c/d7b67ab43f30013b47c12b42d1acd354c195351a3f7a1d67f59e54227ede/ruff-0.14.10-py3-none-win32.whl", hash = "sha256:104c49fc7ab73f3f3a758039adea978869a918f31b73280db175b43a2d9b51d6", size = 13196187, upload-time = "2025-12-18T19:29:19.006Z" }, + { url = "https://files.pythonhosted.org/packages/fb/9c/896c862e13886fae2af961bef3e6312db9ebc6adc2b156fe95e615dee8c1/ruff-0.14.10-py3-none-win_amd64.whl", hash = "sha256:466297bd73638c6bdf06485683e812db1c00c7ac96d4ddd0294a338c62fdc154", size = 14661283, upload-time = "2025-12-18T19:29:30.16Z" }, + { url = "https://files.pythonhosted.org/packages/74/31/b0e29d572670dca3674eeee78e418f20bdf97fa8aa9ea71380885e175ca0/ruff-0.14.10-py3-none-win_arm64.whl", hash = "sha256:e51d046cf6dda98a4633b8a8a771451107413b0f07183b2bef03f075599e44e6", size = 13729839, upload-time = "2025-12-18T19:28:48.636Z" }, +] + +[[package]] +name = "six" +version = "1.17.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/94/e7/b2c673351809dca68a0e064b6af791aa332cf192da575fd474ed7d6f16a2/six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81", size = 34031, upload-time = "2024-12-04T17:35:28.174Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050, upload-time = "2024-12-04T17:35:26.475Z" }, +] + +[[package]] +name = "smmap" +version = "5.0.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/44/cd/a040c4b3119bbe532e5b0732286f805445375489fceaec1f48306068ee3b/smmap-5.0.2.tar.gz", hash = "sha256:26ea65a03958fa0c8a1c7e8c7a58fdc77221b8910f6be2131affade476898ad5", size = 22329, upload-time = "2025-01-02T07:14:40.909Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/04/be/d09147ad1ec7934636ad912901c5fd7667e1c858e19d355237db0d0cd5e4/smmap-5.0.2-py3-none-any.whl", hash = "sha256:b30115f0def7d7531d22a0fb6502488d879e75b260a9db4d0819cfb25403af5e", size = 24303, upload-time = "2025-01-02T07:14:38.724Z" }, +] + +[[package]] +name = "stack-data" +version = "0.6.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "asttokens" }, + { name = "executing" }, + { name = "pure-eval" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/28/e3/55dcc2cfbc3ca9c29519eb6884dd1415ecb53b0e934862d3559ddcb7e20b/stack_data-0.6.3.tar.gz", hash = "sha256:836a778de4fec4dcd1dcd89ed8abff8a221f58308462e1c4aa2a3cf30148f0b9", size = 44707, upload-time = "2023-09-30T13:58:05.479Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f1/7b/ce1eafaf1a76852e2ec9b22edecf1daa58175c090266e9f6c64afcd81d91/stack_data-0.6.3-py3-none-any.whl", hash = "sha256:d5558e0c25a4cb0853cddad3d77da9891a08cb85dd9f9f91b9f8cd66e511e695", size = 24521, upload-time = "2023-09-30T13:58:03.53Z" }, +] + +[[package]] +name = "termcolor" +version = "3.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/87/56/ab275c2b56a5e2342568838f0d5e3e66a32354adcc159b495e374cda43f5/termcolor-3.2.0.tar.gz", hash = "sha256:610e6456feec42c4bcd28934a8c87a06c3fa28b01561d46aa09a9881b8622c58", size = 14423, upload-time = "2025-10-25T19:11:42.586Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f9/d5/141f53d7c1eb2a80e6d3e9a390228c3222c27705cbe7f048d3623053f3ca/termcolor-3.2.0-py3-none-any.whl", hash = "sha256:a10343879eba4da819353c55cb8049b0933890c2ebf9ad5d3ecd2bb32ea96ea6", size = 7698, upload-time = "2025-10-25T19:11:41.536Z" }, +] + +[[package]] +name = "tomli" +version = "2.3.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/52/ed/3f73f72945444548f33eba9a87fc7a6e969915e7b1acc8260b30e1f76a2f/tomli-2.3.0.tar.gz", hash = "sha256:64be704a875d2a59753d80ee8a533c3fe183e3f06807ff7dc2232938ccb01549", size = 17392, upload-time = "2025-10-08T22:01:47.119Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b3/2e/299f62b401438d5fe1624119c723f5d877acc86a4c2492da405626665f12/tomli-2.3.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:88bd15eb972f3664f5ed4b57c1634a97153b4bac4479dcb6a495f41921eb7f45", size = 153236, upload-time = "2025-10-08T22:01:00.137Z" }, + { url = "https://files.pythonhosted.org/packages/86/7f/d8fffe6a7aefdb61bced88fcb5e280cfd71e08939da5894161bd71bea022/tomli-2.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:883b1c0d6398a6a9d29b508c331fa56adbcdff647f6ace4dfca0f50e90dfd0ba", size = 148084, upload-time = "2025-10-08T22:01:01.63Z" }, + { url = "https://files.pythonhosted.org/packages/47/5c/24935fb6a2ee63e86d80e4d3b58b222dafaf438c416752c8b58537c8b89a/tomli-2.3.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:d1381caf13ab9f300e30dd8feadb3de072aeb86f1d34a8569453ff32a7dea4bf", size = 234832, upload-time = "2025-10-08T22:01:02.543Z" }, + { url = "https://files.pythonhosted.org/packages/89/da/75dfd804fc11e6612846758a23f13271b76d577e299592b4371a4ca4cd09/tomli-2.3.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a0e285d2649b78c0d9027570d4da3425bdb49830a6156121360b3f8511ea3441", size = 242052, upload-time = "2025-10-08T22:01:03.836Z" }, + { url = "https://files.pythonhosted.org/packages/70/8c/f48ac899f7b3ca7eb13af73bacbc93aec37f9c954df3c08ad96991c8c373/tomli-2.3.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:0a154a9ae14bfcf5d8917a59b51ffd5a3ac1fd149b71b47a3a104ca4edcfa845", size = 239555, upload-time = "2025-10-08T22:01:04.834Z" }, + { url = "https://files.pythonhosted.org/packages/ba/28/72f8afd73f1d0e7829bfc093f4cb98ce0a40ffc0cc997009ee1ed94ba705/tomli-2.3.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:74bf8464ff93e413514fefd2be591c3b0b23231a77f901db1eb30d6f712fc42c", size = 245128, upload-time = "2025-10-08T22:01:05.84Z" }, + { url = "https://files.pythonhosted.org/packages/b6/eb/a7679c8ac85208706d27436e8d421dfa39d4c914dcf5fa8083a9305f58d9/tomli-2.3.0-cp311-cp311-win32.whl", hash = "sha256:00b5f5d95bbfc7d12f91ad8c593a1659b6387b43f054104cda404be6bda62456", size = 96445, upload-time = "2025-10-08T22:01:06.896Z" }, + { url = "https://files.pythonhosted.org/packages/0a/fe/3d3420c4cb1ad9cb462fb52967080575f15898da97e21cb6f1361d505383/tomli-2.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:4dc4ce8483a5d429ab602f111a93a6ab1ed425eae3122032db7e9acf449451be", size = 107165, upload-time = "2025-10-08T22:01:08.107Z" }, + { url = "https://files.pythonhosted.org/packages/ff/b7/40f36368fcabc518bb11c8f06379a0fd631985046c038aca08c6d6a43c6e/tomli-2.3.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:d7d86942e56ded512a594786a5ba0a5e521d02529b3826e7761a05138341a2ac", size = 154891, upload-time = "2025-10-08T22:01:09.082Z" }, + { url = "https://files.pythonhosted.org/packages/f9/3f/d9dd692199e3b3aab2e4e4dd948abd0f790d9ded8cd10cbaae276a898434/tomli-2.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:73ee0b47d4dad1c5e996e3cd33b8a76a50167ae5f96a2607cbe8cc773506ab22", size = 148796, upload-time = "2025-10-08T22:01:10.266Z" }, + { url = "https://files.pythonhosted.org/packages/60/83/59bff4996c2cf9f9387a0f5a3394629c7efa5ef16142076a23a90f1955fa/tomli-2.3.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:792262b94d5d0a466afb5bc63c7daa9d75520110971ee269152083270998316f", size = 242121, upload-time = "2025-10-08T22:01:11.332Z" }, + { url = "https://files.pythonhosted.org/packages/45/e5/7c5119ff39de8693d6baab6c0b6dcb556d192c165596e9fc231ea1052041/tomli-2.3.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4f195fe57ecceac95a66a75ac24d9d5fbc98ef0962e09b2eddec5d39375aae52", size = 250070, upload-time = "2025-10-08T22:01:12.498Z" }, + { url = "https://files.pythonhosted.org/packages/45/12/ad5126d3a278f27e6701abde51d342aa78d06e27ce2bb596a01f7709a5a2/tomli-2.3.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e31d432427dcbf4d86958c184b9bfd1e96b5b71f8eb17e6d02531f434fd335b8", size = 245859, upload-time = "2025-10-08T22:01:13.551Z" }, + { url = "https://files.pythonhosted.org/packages/fb/a1/4d6865da6a71c603cfe6ad0e6556c73c76548557a8d658f9e3b142df245f/tomli-2.3.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b0882799624980785240ab732537fcfc372601015c00f7fc367c55308c186f6", size = 250296, upload-time = "2025-10-08T22:01:14.614Z" }, + { url = "https://files.pythonhosted.org/packages/a0/b7/a7a7042715d55c9ba6e8b196d65d2cb662578b4d8cd17d882d45322b0d78/tomli-2.3.0-cp312-cp312-win32.whl", hash = "sha256:ff72b71b5d10d22ecb084d345fc26f42b5143c5533db5e2eaba7d2d335358876", size = 97124, upload-time = "2025-10-08T22:01:15.629Z" }, + { url = "https://files.pythonhosted.org/packages/06/1e/f22f100db15a68b520664eb3328fb0ae4e90530887928558112c8d1f4515/tomli-2.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:1cb4ed918939151a03f33d4242ccd0aa5f11b3547d0cf30f7c74a408a5b99878", size = 107698, upload-time = "2025-10-08T22:01:16.51Z" }, + { url = "https://files.pythonhosted.org/packages/89/48/06ee6eabe4fdd9ecd48bf488f4ac783844fd777f547b8d1b61c11939974e/tomli-2.3.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:5192f562738228945d7b13d4930baffda67b69425a7f0da96d360b0a3888136b", size = 154819, upload-time = "2025-10-08T22:01:17.964Z" }, + { url = "https://files.pythonhosted.org/packages/f1/01/88793757d54d8937015c75dcdfb673c65471945f6be98e6a0410fba167ed/tomli-2.3.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:be71c93a63d738597996be9528f4abe628d1adf5e6eb11607bc8fe1a510b5dae", size = 148766, upload-time = "2025-10-08T22:01:18.959Z" }, + { url = "https://files.pythonhosted.org/packages/42/17/5e2c956f0144b812e7e107f94f1cc54af734eb17b5191c0bbfb72de5e93e/tomli-2.3.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c4665508bcbac83a31ff8ab08f424b665200c0e1e645d2bd9ab3d3e557b6185b", size = 240771, upload-time = "2025-10-08T22:01:20.106Z" }, + { url = "https://files.pythonhosted.org/packages/d5/f4/0fbd014909748706c01d16824eadb0307115f9562a15cbb012cd9b3512c5/tomli-2.3.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4021923f97266babc6ccab9f5068642a0095faa0a51a246a6a02fccbb3514eaf", size = 248586, upload-time = "2025-10-08T22:01:21.164Z" }, + { url = "https://files.pythonhosted.org/packages/30/77/fed85e114bde5e81ecf9bc5da0cc69f2914b38f4708c80ae67d0c10180c5/tomli-2.3.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a4ea38c40145a357d513bffad0ed869f13c1773716cf71ccaa83b0fa0cc4e42f", size = 244792, upload-time = "2025-10-08T22:01:22.417Z" }, + { url = "https://files.pythonhosted.org/packages/55/92/afed3d497f7c186dc71e6ee6d4fcb0acfa5f7d0a1a2878f8beae379ae0cc/tomli-2.3.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:ad805ea85eda330dbad64c7ea7a4556259665bdf9d2672f5dccc740eb9d3ca05", size = 248909, upload-time = "2025-10-08T22:01:23.859Z" }, + { url = "https://files.pythonhosted.org/packages/f8/84/ef50c51b5a9472e7265ce1ffc7f24cd4023d289e109f669bdb1553f6a7c2/tomli-2.3.0-cp313-cp313-win32.whl", hash = "sha256:97d5eec30149fd3294270e889b4234023f2c69747e555a27bd708828353ab606", size = 96946, upload-time = "2025-10-08T22:01:24.893Z" }, + { url = "https://files.pythonhosted.org/packages/b2/b7/718cd1da0884f281f95ccfa3a6cc572d30053cba64603f79d431d3c9b61b/tomli-2.3.0-cp313-cp313-win_amd64.whl", hash = "sha256:0c95ca56fbe89e065c6ead5b593ee64b84a26fca063b5d71a1122bf26e533999", size = 107705, upload-time = "2025-10-08T22:01:26.153Z" }, + { url = "https://files.pythonhosted.org/packages/19/94/aeafa14a52e16163008060506fcb6aa1949d13548d13752171a755c65611/tomli-2.3.0-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:cebc6fe843e0733ee827a282aca4999b596241195f43b4cc371d64fc6639da9e", size = 154244, upload-time = "2025-10-08T22:01:27.06Z" }, + { url = "https://files.pythonhosted.org/packages/db/e4/1e58409aa78eefa47ccd19779fc6f36787edbe7d4cd330eeeedb33a4515b/tomli-2.3.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:4c2ef0244c75aba9355561272009d934953817c49f47d768070c3c94355c2aa3", size = 148637, upload-time = "2025-10-08T22:01:28.059Z" }, + { url = "https://files.pythonhosted.org/packages/26/b6/d1eccb62f665e44359226811064596dd6a366ea1f985839c566cd61525ae/tomli-2.3.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c22a8bf253bacc0cf11f35ad9808b6cb75ada2631c2d97c971122583b129afbc", size = 241925, upload-time = "2025-10-08T22:01:29.066Z" }, + { url = "https://files.pythonhosted.org/packages/70/91/7cdab9a03e6d3d2bb11beae108da5bdc1c34bdeb06e21163482544ddcc90/tomli-2.3.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0eea8cc5c5e9f89c9b90c4896a8deefc74f518db5927d0e0e8d4a80953d774d0", size = 249045, upload-time = "2025-10-08T22:01:31.98Z" }, + { url = "https://files.pythonhosted.org/packages/15/1b/8c26874ed1f6e4f1fcfeb868db8a794cbe9f227299402db58cfcc858766c/tomli-2.3.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:b74a0e59ec5d15127acdabd75ea17726ac4c5178ae51b85bfe39c4f8a278e879", size = 245835, upload-time = "2025-10-08T22:01:32.989Z" }, + { url = "https://files.pythonhosted.org/packages/fd/42/8e3c6a9a4b1a1360c1a2a39f0b972cef2cc9ebd56025168c4137192a9321/tomli-2.3.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:b5870b50c9db823c595983571d1296a6ff3e1b88f734a4c8f6fc6188397de005", size = 253109, upload-time = "2025-10-08T22:01:34.052Z" }, + { url = "https://files.pythonhosted.org/packages/22/0c/b4da635000a71b5f80130937eeac12e686eefb376b8dee113b4a582bba42/tomli-2.3.0-cp314-cp314-win32.whl", hash = "sha256:feb0dacc61170ed7ab602d3d972a58f14ee3ee60494292d384649a3dc38ef463", size = 97930, upload-time = "2025-10-08T22:01:35.082Z" }, + { url = "https://files.pythonhosted.org/packages/b9/74/cb1abc870a418ae99cd5c9547d6bce30701a954e0e721821df483ef7223c/tomli-2.3.0-cp314-cp314-win_amd64.whl", hash = "sha256:b273fcbd7fc64dc3600c098e39136522650c49bca95df2d11cf3b626422392c8", size = 107964, upload-time = "2025-10-08T22:01:36.057Z" }, + { url = "https://files.pythonhosted.org/packages/54/78/5c46fff6432a712af9f792944f4fcd7067d8823157949f4e40c56b8b3c83/tomli-2.3.0-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:940d56ee0410fa17ee1f12b817b37a4d4e4dc4d27340863cc67236c74f582e77", size = 163065, upload-time = "2025-10-08T22:01:37.27Z" }, + { url = "https://files.pythonhosted.org/packages/39/67/f85d9bd23182f45eca8939cd2bc7050e1f90c41f4a2ecbbd5963a1d1c486/tomli-2.3.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:f85209946d1fe94416debbb88d00eb92ce9cd5266775424ff81bc959e001acaf", size = 159088, upload-time = "2025-10-08T22:01:38.235Z" }, + { url = "https://files.pythonhosted.org/packages/26/5a/4b546a0405b9cc0659b399f12b6adb750757baf04250b148d3c5059fc4eb/tomli-2.3.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a56212bdcce682e56b0aaf79e869ba5d15a6163f88d5451cbde388d48b13f530", size = 268193, upload-time = "2025-10-08T22:01:39.712Z" }, + { url = "https://files.pythonhosted.org/packages/42/4f/2c12a72ae22cf7b59a7fe75b3465b7aba40ea9145d026ba41cb382075b0e/tomli-2.3.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c5f3ffd1e098dfc032d4d3af5c0ac64f6d286d98bc148698356847b80fa4de1b", size = 275488, upload-time = "2025-10-08T22:01:40.773Z" }, + { url = "https://files.pythonhosted.org/packages/92/04/a038d65dbe160c3aa5a624e93ad98111090f6804027d474ba9c37c8ae186/tomli-2.3.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:5e01decd096b1530d97d5d85cb4dff4af2d8347bd35686654a004f8dea20fc67", size = 272669, upload-time = "2025-10-08T22:01:41.824Z" }, + { url = "https://files.pythonhosted.org/packages/be/2f/8b7c60a9d1612a7cbc39ffcca4f21a73bf368a80fc25bccf8253e2563267/tomli-2.3.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:8a35dd0e643bb2610f156cca8db95d213a90015c11fee76c946aa62b7ae7e02f", size = 279709, upload-time = "2025-10-08T22:01:43.177Z" }, + { url = "https://files.pythonhosted.org/packages/7e/46/cc36c679f09f27ded940281c38607716c86cf8ba4a518d524e349c8b4874/tomli-2.3.0-cp314-cp314t-win32.whl", hash = "sha256:a1f7f282fe248311650081faafa5f4732bdbfef5d45fe3f2e702fbc6f2d496e0", size = 107563, upload-time = "2025-10-08T22:01:44.233Z" }, + { url = "https://files.pythonhosted.org/packages/84/ff/426ca8683cf7b753614480484f6437f568fd2fda2edbdf57a2d3d8b27a0b/tomli-2.3.0-cp314-cp314t-win_amd64.whl", hash = "sha256:70a251f8d4ba2d9ac2542eecf008b3c8a9fc5c3f9f02c56a9d7952612be2fdba", size = 119756, upload-time = "2025-10-08T22:01:45.234Z" }, + { url = "https://files.pythonhosted.org/packages/77/b8/0135fadc89e73be292b473cb820b4f5a08197779206b33191e801feeae40/tomli-2.3.0-py3-none-any.whl", hash = "sha256:e95b1af3c5b07d9e643909b5abbec77cd9f1217e6d0bca72b0234736b9fb1f1b", size = 14408, upload-time = "2025-10-08T22:01:46.04Z" }, +] + +[[package]] +name = "tomlkit" +version = "0.13.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cc/18/0bbf3884e9eaa38819ebe46a7bd25dcd56b67434402b66a58c4b8e552575/tomlkit-0.13.3.tar.gz", hash = "sha256:430cf247ee57df2b94ee3fbe588e71d362a941ebb545dec29b53961d61add2a1", size = 185207, upload-time = "2025-06-05T07:13:44.947Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bd/75/8539d011f6be8e29f339c42e633aae3cb73bffa95dd0f9adec09b9c58e85/tomlkit-0.13.3-py3-none-any.whl", hash = "sha256:c89c649d79ee40629a9fda55f8ace8c6a1b42deb912b2a8fd8d942ddadb606b0", size = 38901, upload-time = "2025-06-05T07:13:43.546Z" }, +] + +[[package]] +name = "tox" +version = "4.32.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "cachetools" }, + { name = "chardet" }, + { name = "colorama" }, + { name = "filelock" }, + { name = "packaging" }, + { name = "platformdirs" }, + { name = "pluggy" }, + { name = "pyproject-api" }, + { name = "tomli", marker = "python_full_version < '3.11'" }, + { name = "typing-extensions", marker = "python_full_version < '3.11'" }, + { name = "virtualenv" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/59/bf/0e4dbd42724cbae25959f0e34c95d0c730df03ab03f54d52accd9abfc614/tox-4.32.0.tar.gz", hash = "sha256:1ad476b5f4d3679455b89a992849ffc3367560bbc7e9495ee8a3963542e7c8ff", size = 203330, upload-time = "2025-10-24T18:03:38.132Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fc/cc/e09c0d663a004945f82beecd4f147053567910479314e8d01ba71e5d5dea/tox-4.32.0-py3-none-any.whl", hash = "sha256:451e81dc02ba8d1ed20efd52ee409641ae4b5d5830e008af10fe8823ef1bd551", size = 175905, upload-time = "2025-10-24T18:03:36.337Z" }, +] + +[[package]] +name = "tox-uv" +version = "1.29.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "packaging" }, + { name = "tomli", marker = "python_full_version < '3.11'" }, + { name = "tox" }, + { name = "uv" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/4f/90/06752775b8cfadba8856190f5beae9f552547e0f287e0246677972107375/tox_uv-1.29.0.tar.gz", hash = "sha256:30fa9e6ad507df49d3c6a2f88894256bcf90f18e240a00764da6ecab1db24895", size = 23427, upload-time = "2025-10-09T20:40:27.384Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5c/17/221d62937c4130b044bb437caac4181e7e13d5536bbede65264db1f0ac9f/tox_uv-1.29.0-py3-none-any.whl", hash = "sha256:b1d251286edeeb4bc4af1e24c8acfdd9404700143c2199ccdbb4ea195f7de6cc", size = 17254, upload-time = "2025-10-09T20:40:25.885Z" }, +] + +[[package]] +name = "traitlets" +version = "5.14.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/eb/79/72064e6a701c2183016abbbfedaba506d81e30e232a68c9f0d6f6fcd1574/traitlets-5.14.3.tar.gz", hash = "sha256:9ed0579d3502c94b4b3732ac120375cda96f923114522847de4b3bb98b96b6b7", size = 161621, upload-time = "2024-04-19T11:11:49.746Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/00/c0/8f5d070730d7836adc9c9b6408dec68c6ced86b304a9b26a14df072a6e8c/traitlets-5.14.3-py3-none-any.whl", hash = "sha256:b74e89e397b1ed28cc831db7aea759ba6640cb3de13090ca145426688ff1ac4f", size = 85359, upload-time = "2024-04-19T11:11:46.763Z" }, +] + +[[package]] +name = "types-colorama" +version = "0.4.15.20250801" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/99/37/af713e7d73ca44738c68814cbacf7a655aa40ddd2e8513d431ba78ace7b3/types_colorama-0.4.15.20250801.tar.gz", hash = "sha256:02565d13d68963d12237d3f330f5ecd622a3179f7b5b14ee7f16146270c357f5", size = 10437, upload-time = "2025-08-01T03:48:22.605Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/95/3a/44ccbbfef6235aeea84c74041dc6dfee6c17ff3ddba782a0250e41687ec7/types_colorama-0.4.15.20250801-py3-none-any.whl", hash = "sha256:b6e89bd3b250fdad13a8b6a465c933f4a5afe485ea2e2f104d739be50b13eea9", size = 10743, upload-time = "2025-08-01T03:48:21.774Z" }, +] + +[[package]] +name = "types-deprecated" +version = "1.3.1.20251101" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/c6/96/0f96107945697e452c56a2e9f575da627e61d67940e5913d9c968e5e8be1/types_deprecated-1.3.1.20251101.tar.gz", hash = "sha256:f002d266b73201f46ec6fc712c1f016067ec6cb44357559cdb50c86b010951a7", size = 8358, upload-time = "2025-11-01T03:04:05.6Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9e/50/fb191dba89031e30c9ea07c3133c6fe8e7da038ef4d0b79539cf85fb1a97/types_deprecated-1.3.1.20251101-py3-none-any.whl", hash = "sha256:274edcc2a084d3fe31802d3c1379abd630716d3db34e40577e12ad84d6b73134", size = 9057, upload-time = "2025-11-01T03:04:04.633Z" }, +] + +[[package]] +name = "types-python-dateutil" +version = "2.9.0.20251115" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6a/36/06d01fb52c0d57e9ad0c237654990920fa41195e4b3d640830dabf9eeb2f/types_python_dateutil-2.9.0.20251115.tar.gz", hash = "sha256:8a47f2c3920f52a994056b8786309b43143faa5a64d4cbb2722d6addabdf1a58", size = 16363, upload-time = "2025-11-15T03:00:13.717Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/43/0b/56961d3ba517ed0df9b3a27bfda6514f3d01b28d499d1bce9068cfe4edd1/types_python_dateutil-2.9.0.20251115-py3-none-any.whl", hash = "sha256:9cf9c1c582019753b8639a081deefd7e044b9fa36bd8217f565c6c4e36ee0624", size = 18251, upload-time = "2025-11-15T03:00:12.317Z" }, +] + +[[package]] +name = "types-pyyaml" +version = "6.0.12.20250915" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/7e/69/3c51b36d04da19b92f9e815be12753125bd8bc247ba0470a982e6979e71c/types_pyyaml-6.0.12.20250915.tar.gz", hash = "sha256:0f8b54a528c303f0e6f7165687dd33fafa81c807fcac23f632b63aa624ced1d3", size = 17522, upload-time = "2025-09-15T03:01:00.728Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bd/e0/1eed384f02555dde685fff1a1ac805c1c7dcb6dd019c916fe659b1c1f9ec/types_pyyaml-6.0.12.20250915-py3-none-any.whl", hash = "sha256:e7d4d9e064e89a3b3cae120b4990cd370874d2bf12fa5f46c97018dd5d3c9ab6", size = 20338, upload-time = "2025-09-15T03:00:59.218Z" }, +] + +[[package]] +name = "types-termcolor" +version = "1.1.6.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/2e/c8/77b1d73399d1cb77823ad32a36490b6a9851a7bd84f3a54560adab7ae022/types-termcolor-1.1.6.2.tar.gz", hash = "sha256:d8f0f69cf5552cc59ce75aa5172937cec9b320c17453adefe4168b93d16daad6", size = 2594, upload-time = "2023-03-28T01:19:18.367Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d4/94/0b01039dcb59173fc1f172a29b455986108f02fad9c5e103ff48afe17f35/types_termcolor-1.1.6.2-py3-none-any.whl", hash = "sha256:44c4c762c54a90d99b5c1033ef008aaa5610056d31d5c66b9288a942682a64d7", size = 2360, upload-time = "2023-03-28T01:19:17.328Z" }, +] + +[[package]] +name = "typing-extensions" +version = "4.15.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/72/94/1a15dd82efb362ac84269196e94cf00f187f7ed21c242792a923cdb1c61f/typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466", size = 109391, upload-time = "2025-08-25T13:49:26.313Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/18/67/36e9267722cc04a6b9f15c7f3441c2363321a3ea07da7ae0c0707beb2a9c/typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548", size = 44614, upload-time = "2025-08-25T13:49:24.86Z" }, +] + +[[package]] +name = "tzdata" +version = "2025.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/5e/a7/c202b344c5ca7daf398f3b8a477eeb205cf3b6f32e7ec3a6bac0629ca975/tzdata-2025.3.tar.gz", hash = "sha256:de39c2ca5dc7b0344f2eba86f49d614019d29f060fc4ebc8a417896a620b56a7", size = 196772, upload-time = "2025-12-13T17:45:35.667Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c7/b0/003792df09decd6849a5e39c28b513c06e84436a54440380862b5aeff25d/tzdata-2025.3-py2.py3-none-any.whl", hash = "sha256:06a47e5700f3081aab02b2e513160914ff0694bce9947d6b76ebd6bf57cfc5d1", size = 348521, upload-time = "2025-12-13T17:45:33.889Z" }, +] + +[[package]] +name = "urllib3" +version = "2.6.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/c7/24/5f1b3bdffd70275f6661c76461e25f024d5a38a46f04aaca912426a2b1d3/urllib3-2.6.3.tar.gz", hash = "sha256:1b62b6884944a57dbe321509ab94fd4d3b307075e0c2eae991ac71ee15ad38ed", size = 435556, upload-time = "2026-01-07T16:24:43.925Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/39/08/aaaad47bc4e9dc8c725e68f9d04865dbcb2052843ff09c97b08904852d84/urllib3-2.6.3-py3-none-any.whl", hash = "sha256:bf272323e553dfb2e87d9bfd225ca7b0f467b919d7bbd355436d3fd37cb0acd4", size = 131584, upload-time = "2026-01-07T16:24:42.685Z" }, +] + +[[package]] +name = "uv" +version = "0.9.20" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/61/20/c7598c4a8b0a7d19a1927287876d5fabb4ad5150103c9b751740bea33396/uv-0.9.20.tar.gz", hash = "sha256:a8b45804a84e5dfd01127abea663f7ca508551cd705e3476cc050751e5788b32", size = 3832559, upload-time = "2025-12-29T20:54:08.844Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/87/2e/ff66dbb7389f03097ff83e4d08c093f32bed96752df58b9992ec5e7aa0ea/uv-0.9.20-py3-none-linux_armv6l.whl", hash = "sha256:025ff1890f7ae2ea93a6c9ba326d25e56ba6d9e4f05c372b82ff5a947d21c400", size = 21294993, upload-time = "2025-12-29T20:54:23.877Z" }, + { url = "https://files.pythonhosted.org/packages/3f/e0/5c14ac09dfebda68df962524cd191c5a4d7e0b02ac5503c34dce6788ffe6/uv-0.9.20-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:94f716f0e6e609d8c6804faa74797024c43e7aa2ea876778fa16ceb68dc4d80a", size = 20487595, upload-time = "2025-12-29T20:54:26.506Z" }, + { url = "https://files.pythonhosted.org/packages/e9/ba/089a115a898a8729074fcc2bf00dfbf8a90ef79eadf738b531c89794528e/uv-0.9.20-py3-none-macosx_11_0_arm64.whl", hash = "sha256:288fdf29b22b3034285e244c006bcdf5575e35fe14f1f2dd55bbb477d6c22d99", size = 18972327, upload-time = "2025-12-29T20:54:31.292Z" }, + { url = "https://files.pythonhosted.org/packages/b8/9f/3a880df832196a4113ed5b16322bd6d6cc21b80338406f2bdab7cbc31361/uv-0.9.20-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl", hash = "sha256:44076e26038fe37bd6aad7aaf411b72006ec01f124af3c1227d47a3fafa11b1b", size = 20825991, upload-time = "2025-12-29T20:54:21.359Z" }, + { url = "https://files.pythonhosted.org/packages/0c/c1/5b4bdc9b4637f061955200eda21d2285701b8dd979d745a9f5ac2f789abb/uv-0.9.20-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:b66e83fa1558b322194a297e9477e7e49f31136f95b88830a971ba23d8778fb5", size = 20885060, upload-time = "2025-12-29T20:54:10.973Z" }, + { url = "https://files.pythonhosted.org/packages/4d/11/9c44cea9b30dda6a9268d3496aae0c83afa6096afa83559de33181877ab8/uv-0.9.20-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9ae848f6760fce321a2be6cc98b37a31353178295c9e0ebb64e70be8a3c73b07", size = 21992898, upload-time = "2025-12-29T20:54:49.959Z" }, + { url = "https://files.pythonhosted.org/packages/f1/dd/6d5eaefec10ef5aceeb0957ebd49afede80c446354ecb463cc8f457144da/uv-0.9.20-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:47cda4b2dcdfb55fb4d77fe3ef138d30e89d69e138e96c30325509462e4c4386", size = 23540946, upload-time = "2025-12-29T20:54:15.976Z" }, + { url = "https://files.pythonhosted.org/packages/df/87/a8ce66e5ee35351a2c50f9cf125407e582e1d790e78cad79b614944f3f4a/uv-0.9.20-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f7551cd1a3a1516583021d43b2daef41ce36c2249aa19de10c0f108264099388", size = 23156794, upload-time = "2025-12-29T20:54:03.745Z" }, + { url = "https://files.pythonhosted.org/packages/c4/43/ca9653caba6123f83842ac81de2411316570fda3b7a5916c2b1ef858ab5a/uv-0.9.20-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:143783954e48abaea83d100eb7ca70a614c089d5933b55d59a5638d630b3f7c3", size = 22225527, upload-time = "2025-12-29T20:54:06.663Z" }, + { url = "https://files.pythonhosted.org/packages/f3/a4/f88d4e6806894a37b4018edfd196cd3689194e6ecbcee05fd7ae5ed4cf6f/uv-0.9.20-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d86724ae303c80d52712b335cfc9f1b5aa785244c18905fd605067303a305854", size = 22205705, upload-time = "2025-12-29T20:54:44.766Z" }, + { url = "https://files.pythonhosted.org/packages/3d/bc/202cfb8d47f83b633502b0b32e00abc019f91255e54aa6672a87495ef06c/uv-0.9.20-py3-none-manylinux_2_28_aarch64.whl", hash = "sha256:19e4ce680230f9148c777af4664a6a534821222dd4e8f06844c3d23b79e4778b", size = 20943437, upload-time = "2025-12-29T20:54:34.237Z" }, + { url = "https://files.pythonhosted.org/packages/a3/15/de8ecbf504c96cfb5af7fdf621e5497f0496a403d0883c31ee97702b97db/uv-0.9.20-py3-none-manylinux_2_31_riscv64.whl", hash = "sha256:02383c09eadd2518afb0eebbc651d74b2dd59ad5818d28037cbf7bcef76f8b56", size = 22071434, upload-time = "2025-12-29T20:54:47.395Z" }, + { url = "https://files.pythonhosted.org/packages/30/32/283604c72142e4550f04252d53ab591ed71a178ae044b3debbea1700018c/uv-0.9.20-py3-none-musllinux_1_1_armv7l.whl", hash = "sha256:277a7fc7e5229a809e6cc4dacc936dea1fa7260fb5802895ddbba0873fc4b6ec", size = 20838373, upload-time = "2025-12-29T20:54:28.975Z" }, + { url = "https://files.pythonhosted.org/packages/c4/d4/c56a14ae2a693260d227e60358f09f924b7e347bed4aef7a85f4d52e06f5/uv-0.9.20-py3-none-musllinux_1_1_i686.whl", hash = "sha256:c9a073116da198b0533e80828d765bbb30137eef37de68cbc3d21b0f614c843d", size = 21399009, upload-time = "2025-12-29T20:54:13.458Z" }, + { url = "https://files.pythonhosted.org/packages/99/35/e717a53df2d579fd57e9236ef3e13d9127c34e006c6ea1bb4294164d04df/uv-0.9.20-py3-none-musllinux_1_1_x86_64.whl", hash = "sha256:56bb00bc0d13f9e4913ef773f31659423faaffe408f6c24b24e25f2c1d5a93cf", size = 22426264, upload-time = "2025-12-29T20:54:37.053Z" }, + { url = "https://files.pythonhosted.org/packages/d4/18/563fc6703e882167b39270db83a57e36834b0d75a51c97a9e5e30a5b2a47/uv-0.9.20-py3-none-win32.whl", hash = "sha256:e620adcbd2e6d714e26928c1674af4581ba9e4b74c38745d6987b4d323d80edc", size = 20034131, upload-time = "2025-12-29T20:54:39.386Z" }, + { url = "https://files.pythonhosted.org/packages/c8/32/3359f7afeebadcaa472535f72ca48dc2d7f234de8570039ee556b470734e/uv-0.9.20-py3-none-win_amd64.whl", hash = "sha256:42d43b6cb7d84a3d4fce8a8a46f0b2c6c8b5d58b3b8062980cbfdb65b559fa8f", size = 22203935, upload-time = "2025-12-29T20:54:18.997Z" }, + { url = "https://files.pythonhosted.org/packages/b8/c4/65fd3981884a51971135547ebb0dddc5c32161374f90e162aca227f4832f/uv-0.9.20-py3-none-win_arm64.whl", hash = "sha256:d63f501a95ef74ea6d2004665eb2ae65429d039150f2c2e6bc12efb6e03fd702", size = 20578093, upload-time = "2025-12-29T20:54:41.944Z" }, +] + +[[package]] +name = "virtualenv" +version = "20.36.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "distlib" }, + { name = "filelock" }, + { name = "platformdirs" }, + { name = "typing-extensions", marker = "python_full_version < '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/aa/a3/4d310fa5f00863544e1d0f4de93bddec248499ccf97d4791bc3122c9d4f3/virtualenv-20.36.1.tar.gz", hash = "sha256:8befb5c81842c641f8ee658481e42641c68b5eab3521d8e092d18320902466ba", size = 6032239, upload-time = "2026-01-09T18:21:01.296Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/6a/2a/dc2228b2888f51192c7dc766106cd475f1b768c10caaf9727659726f7391/virtualenv-20.36.1-py3-none-any.whl", hash = "sha256:575a8d6b124ef88f6f51d56d656132389f961062a9177016a50e4f507bbcc19f", size = 6008258, upload-time = "2026-01-09T18:20:59.425Z" }, +] + +[[package]] +name = "watchdog" +version = "6.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/db/7d/7f3d619e951c88ed75c6037b246ddcf2d322812ee8ea189be89511721d54/watchdog-6.0.0.tar.gz", hash = "sha256:9ddf7c82fda3ae8e24decda1338ede66e1c99883db93711d8fb941eaa2d8c282", size = 131220, upload-time = "2024-11-01T14:07:13.037Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0c/56/90994d789c61df619bfc5ce2ecdabd5eeff564e1eb47512bd01b5e019569/watchdog-6.0.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d1cdb490583ebd691c012b3d6dae011000fe42edb7a82ece80965b42abd61f26", size = 96390, upload-time = "2024-11-01T14:06:24.793Z" }, + { url = "https://files.pythonhosted.org/packages/55/46/9a67ee697342ddf3c6daa97e3a587a56d6c4052f881ed926a849fcf7371c/watchdog-6.0.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:bc64ab3bdb6a04d69d4023b29422170b74681784ffb9463ed4870cf2f3e66112", size = 88389, upload-time = "2024-11-01T14:06:27.112Z" }, + { url = "https://files.pythonhosted.org/packages/44/65/91b0985747c52064d8701e1075eb96f8c40a79df889e59a399453adfb882/watchdog-6.0.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c897ac1b55c5a1461e16dae288d22bb2e412ba9807df8397a635d88f671d36c3", size = 89020, upload-time = "2024-11-01T14:06:29.876Z" }, + { url = "https://files.pythonhosted.org/packages/e0/24/d9be5cd6642a6aa68352ded4b4b10fb0d7889cb7f45814fb92cecd35f101/watchdog-6.0.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6eb11feb5a0d452ee41f824e271ca311a09e250441c262ca2fd7ebcf2461a06c", size = 96393, upload-time = "2024-11-01T14:06:31.756Z" }, + { url = "https://files.pythonhosted.org/packages/63/7a/6013b0d8dbc56adca7fdd4f0beed381c59f6752341b12fa0886fa7afc78b/watchdog-6.0.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ef810fbf7b781a5a593894e4f439773830bdecb885e6880d957d5b9382a960d2", size = 88392, upload-time = "2024-11-01T14:06:32.99Z" }, + { url = "https://files.pythonhosted.org/packages/d1/40/b75381494851556de56281e053700e46bff5b37bf4c7267e858640af5a7f/watchdog-6.0.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:afd0fe1b2270917c5e23c2a65ce50c2a4abb63daafb0d419fde368e272a76b7c", size = 89019, upload-time = "2024-11-01T14:06:34.963Z" }, + { url = "https://files.pythonhosted.org/packages/39/ea/3930d07dafc9e286ed356a679aa02d777c06e9bfd1164fa7c19c288a5483/watchdog-6.0.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:bdd4e6f14b8b18c334febb9c4425a878a2ac20efd1e0b231978e7b150f92a948", size = 96471, upload-time = "2024-11-01T14:06:37.745Z" }, + { url = "https://files.pythonhosted.org/packages/12/87/48361531f70b1f87928b045df868a9fd4e253d9ae087fa4cf3f7113be363/watchdog-6.0.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:c7c15dda13c4eb00d6fb6fc508b3c0ed88b9d5d374056b239c4ad1611125c860", size = 88449, upload-time = "2024-11-01T14:06:39.748Z" }, + { url = "https://files.pythonhosted.org/packages/5b/7e/8f322f5e600812e6f9a31b75d242631068ca8f4ef0582dd3ae6e72daecc8/watchdog-6.0.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6f10cb2d5902447c7d0da897e2c6768bca89174d0c6e1e30abec5421af97a5b0", size = 89054, upload-time = "2024-11-01T14:06:41.009Z" }, + { url = "https://files.pythonhosted.org/packages/68/98/b0345cabdce2041a01293ba483333582891a3bd5769b08eceb0d406056ef/watchdog-6.0.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:490ab2ef84f11129844c23fb14ecf30ef3d8a6abafd3754a6f75ca1e6654136c", size = 96480, upload-time = "2024-11-01T14:06:42.952Z" }, + { url = "https://files.pythonhosted.org/packages/85/83/cdf13902c626b28eedef7ec4f10745c52aad8a8fe7eb04ed7b1f111ca20e/watchdog-6.0.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:76aae96b00ae814b181bb25b1b98076d5fc84e8a53cd8885a318b42b6d3a5134", size = 88451, upload-time = "2024-11-01T14:06:45.084Z" }, + { url = "https://files.pythonhosted.org/packages/fe/c4/225c87bae08c8b9ec99030cd48ae9c4eca050a59bf5c2255853e18c87b50/watchdog-6.0.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a175f755fc2279e0b7312c0035d52e27211a5bc39719dd529625b1930917345b", size = 89057, upload-time = "2024-11-01T14:06:47.324Z" }, + { url = "https://files.pythonhosted.org/packages/30/ad/d17b5d42e28a8b91f8ed01cb949da092827afb9995d4559fd448d0472763/watchdog-6.0.0-pp310-pypy310_pp73-macosx_10_15_x86_64.whl", hash = "sha256:c7ac31a19f4545dd92fc25d200694098f42c9a8e391bc00bdd362c5736dbf881", size = 87902, upload-time = "2024-11-01T14:06:53.119Z" }, + { url = "https://files.pythonhosted.org/packages/5c/ca/c3649991d140ff6ab67bfc85ab42b165ead119c9e12211e08089d763ece5/watchdog-6.0.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:9513f27a1a582d9808cf21a07dae516f0fab1cf2d7683a742c498b93eedabb11", size = 88380, upload-time = "2024-11-01T14:06:55.19Z" }, + { url = "https://files.pythonhosted.org/packages/a9/c7/ca4bf3e518cb57a686b2feb4f55a1892fd9a3dd13f470fca14e00f80ea36/watchdog-6.0.0-py3-none-manylinux2014_aarch64.whl", hash = "sha256:7607498efa04a3542ae3e05e64da8202e58159aa1fa4acddf7678d34a35d4f13", size = 79079, upload-time = "2024-11-01T14:06:59.472Z" }, + { url = "https://files.pythonhosted.org/packages/5c/51/d46dc9332f9a647593c947b4b88e2381c8dfc0942d15b8edc0310fa4abb1/watchdog-6.0.0-py3-none-manylinux2014_armv7l.whl", hash = "sha256:9041567ee8953024c83343288ccc458fd0a2d811d6a0fd68c4c22609e3490379", size = 79078, upload-time = "2024-11-01T14:07:01.431Z" }, + { url = "https://files.pythonhosted.org/packages/d4/57/04edbf5e169cd318d5f07b4766fee38e825d64b6913ca157ca32d1a42267/watchdog-6.0.0-py3-none-manylinux2014_i686.whl", hash = "sha256:82dc3e3143c7e38ec49d61af98d6558288c415eac98486a5c581726e0737c00e", size = 79076, upload-time = "2024-11-01T14:07:02.568Z" }, + { url = "https://files.pythonhosted.org/packages/ab/cc/da8422b300e13cb187d2203f20b9253e91058aaf7db65b74142013478e66/watchdog-6.0.0-py3-none-manylinux2014_ppc64.whl", hash = "sha256:212ac9b8bf1161dc91bd09c048048a95ca3a4c4f5e5d4a7d1b1a7d5752a7f96f", size = 79077, upload-time = "2024-11-01T14:07:03.893Z" }, + { url = "https://files.pythonhosted.org/packages/2c/3b/b8964e04ae1a025c44ba8e4291f86e97fac443bca31de8bd98d3263d2fcf/watchdog-6.0.0-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:e3df4cbb9a450c6d49318f6d14f4bbc80d763fa587ba46ec86f99f9e6876bb26", size = 79078, upload-time = "2024-11-01T14:07:05.189Z" }, + { url = "https://files.pythonhosted.org/packages/62/ae/a696eb424bedff7407801c257d4b1afda455fe40821a2be430e173660e81/watchdog-6.0.0-py3-none-manylinux2014_s390x.whl", hash = "sha256:2cce7cfc2008eb51feb6aab51251fd79b85d9894e98ba847408f662b3395ca3c", size = 79077, upload-time = "2024-11-01T14:07:06.376Z" }, + { url = "https://files.pythonhosted.org/packages/b5/e8/dbf020b4d98251a9860752a094d09a65e1b436ad181faf929983f697048f/watchdog-6.0.0-py3-none-manylinux2014_x86_64.whl", hash = "sha256:20ffe5b202af80ab4266dcd3e91aae72bf2da48c0d33bdb15c66658e685e94e2", size = 79078, upload-time = "2024-11-01T14:07:07.547Z" }, + { url = "https://files.pythonhosted.org/packages/07/f6/d0e5b343768e8bcb4cda79f0f2f55051bf26177ecd5651f84c07567461cf/watchdog-6.0.0-py3-none-win32.whl", hash = "sha256:07df1fdd701c5d4c8e55ef6cf55b8f0120fe1aef7ef39a1c6fc6bc2e606d517a", size = 79065, upload-time = "2024-11-01T14:07:09.525Z" }, + { url = "https://files.pythonhosted.org/packages/db/d9/c495884c6e548fce18a8f40568ff120bc3a4b7b99813081c8ac0c936fa64/watchdog-6.0.0-py3-none-win_amd64.whl", hash = "sha256:cbafb470cf848d93b5d013e2ecb245d4aa1c8fd0504e863ccefa32445359d680", size = 79070, upload-time = "2024-11-01T14:07:10.686Z" }, + { url = "https://files.pythonhosted.org/packages/33/e8/e40370e6d74ddba47f002a32919d91310d6074130fe4e17dabcafc15cbf1/watchdog-6.0.0-py3-none-win_ia64.whl", hash = "sha256:a1914259fa9e1454315171103c6a30961236f508b9b623eae470268bbcc6a22f", size = 79067, upload-time = "2024-11-01T14:07:11.845Z" }, +] + +[[package]] +name = "wcwidth" +version = "0.2.14" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/24/30/6b0809f4510673dc723187aeaf24c7f5459922d01e2f794277a3dfb90345/wcwidth-0.2.14.tar.gz", hash = "sha256:4d478375d31bc5395a3c55c40ccdf3354688364cd61c4f6adacaa9215d0b3605", size = 102293, upload-time = "2025-09-22T16:29:53.023Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/af/b5/123f13c975e9f27ab9c0770f514345bd406d0e8d3b7a0723af9d43f710af/wcwidth-0.2.14-py2.py3-none-any.whl", hash = "sha256:a7bb560c8aee30f9957e5f9895805edd20602f2d7f720186dfd906e82b4982e1", size = 37286, upload-time = "2025-09-22T16:29:51.641Z" }, +] + +[[package]] +name = "wrapt" +version = "2.0.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/49/2a/6de8a50cb435b7f42c46126cf1a54b2aab81784e74c8595c8e025e8f36d3/wrapt-2.0.1.tar.gz", hash = "sha256:9c9c635e78497cacb81e84f8b11b23e0aacac7a136e73b8e5b2109a1d9fc468f", size = 82040, upload-time = "2025-11-07T00:45:33.312Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/61/0d/12d8c803ed2ce4e5e7d5b9f5f602721f9dfef82c95959f3ce97fa584bb5c/wrapt-2.0.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:64b103acdaa53b7caf409e8d45d39a8442fe6dcfec6ba3f3d141e0cc2b5b4dbd", size = 77481, upload-time = "2025-11-07T00:43:11.103Z" }, + { url = "https://files.pythonhosted.org/packages/05/3e/4364ebe221ebf2a44d9fc8695a19324692f7dd2795e64bd59090856ebf12/wrapt-2.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:91bcc576260a274b169c3098e9a3519fb01f2989f6d3d386ef9cbf8653de1374", size = 60692, upload-time = "2025-11-07T00:43:13.697Z" }, + { url = "https://files.pythonhosted.org/packages/1f/ff/ae2a210022b521f86a8ddcdd6058d137c051003812b0388a5e9a03d3fe10/wrapt-2.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ab594f346517010050126fcd822697b25a7031d815bb4fbc238ccbe568216489", size = 61574, upload-time = "2025-11-07T00:43:14.967Z" }, + { url = "https://files.pythonhosted.org/packages/c6/93/5cf92edd99617095592af919cb81d4bff61c5dbbb70d3c92099425a8ec34/wrapt-2.0.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:36982b26f190f4d737f04a492a68accbfc6fa042c3f42326fdfbb6c5b7a20a31", size = 113688, upload-time = "2025-11-07T00:43:18.275Z" }, + { url = "https://files.pythonhosted.org/packages/a0/0a/e38fc0cee1f146c9fb266d8ef96ca39fb14a9eef165383004019aa53f88a/wrapt-2.0.1-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:23097ed8bc4c93b7bf36fa2113c6c733c976316ce0ee2c816f64ca06102034ef", size = 115698, upload-time = "2025-11-07T00:43:19.407Z" }, + { url = "https://files.pythonhosted.org/packages/b0/85/bef44ea018b3925fb0bcbe9112715f665e4d5309bd945191da814c314fd1/wrapt-2.0.1-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:8bacfe6e001749a3b64db47bcf0341da757c95959f592823a93931a422395013", size = 112096, upload-time = "2025-11-07T00:43:16.5Z" }, + { url = "https://files.pythonhosted.org/packages/7c/0b/733a2376e413117e497aa1a5b1b78e8f3a28c0e9537d26569f67d724c7c5/wrapt-2.0.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:8ec3303e8a81932171f455f792f8df500fc1a09f20069e5c16bd7049ab4e8e38", size = 114878, upload-time = "2025-11-07T00:43:20.81Z" }, + { url = "https://files.pythonhosted.org/packages/da/03/d81dcb21bbf678fcda656495792b059f9d56677d119ca022169a12542bd0/wrapt-2.0.1-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:3f373a4ab5dbc528a94334f9fe444395b23c2f5332adab9ff4ea82f5a9e33bc1", size = 111298, upload-time = "2025-11-07T00:43:22.229Z" }, + { url = "https://files.pythonhosted.org/packages/c9/d5/5e623040e8056e1108b787020d56b9be93dbbf083bf2324d42cde80f3a19/wrapt-2.0.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:f49027b0b9503bf6c8cdc297ca55006b80c2f5dd36cecc72c6835ab6e10e8a25", size = 113361, upload-time = "2025-11-07T00:43:24.301Z" }, + { url = "https://files.pythonhosted.org/packages/a1/f3/de535ccecede6960e28c7b722e5744846258111d6c9f071aa7578ea37ad3/wrapt-2.0.1-cp310-cp310-win32.whl", hash = "sha256:8330b42d769965e96e01fa14034b28a2a7600fbf7e8f0cc90ebb36d492c993e4", size = 58035, upload-time = "2025-11-07T00:43:28.96Z" }, + { url = "https://files.pythonhosted.org/packages/21/15/39d3ca5428a70032c2ec8b1f1c9d24c32e497e7ed81aed887a4998905fcc/wrapt-2.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:1218573502a8235bb8a7ecaed12736213b22dcde9feab115fa2989d42b5ded45", size = 60383, upload-time = "2025-11-07T00:43:25.804Z" }, + { url = "https://files.pythonhosted.org/packages/43/c2/dfd23754b7f7a4dce07e08f4309c4e10a40046a83e9ae1800f2e6b18d7c1/wrapt-2.0.1-cp310-cp310-win_arm64.whl", hash = "sha256:eda8e4ecd662d48c28bb86be9e837c13e45c58b8300e43ba3c9b4fa9900302f7", size = 58894, upload-time = "2025-11-07T00:43:27.074Z" }, + { url = "https://files.pythonhosted.org/packages/98/60/553997acf3939079dab022e37b67b1904b5b0cc235503226898ba573b10c/wrapt-2.0.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:0e17283f533a0d24d6e5429a7d11f250a58d28b4ae5186f8f47853e3e70d2590", size = 77480, upload-time = "2025-11-07T00:43:30.573Z" }, + { url = "https://files.pythonhosted.org/packages/2d/50/e5b3d30895d77c52105c6d5cbf94d5b38e2a3dd4a53d22d246670da98f7c/wrapt-2.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:85df8d92158cb8f3965aecc27cf821461bb5f40b450b03facc5d9f0d4d6ddec6", size = 60690, upload-time = "2025-11-07T00:43:31.594Z" }, + { url = "https://files.pythonhosted.org/packages/f0/40/660b2898703e5cbbb43db10cdefcc294274458c3ca4c68637c2b99371507/wrapt-2.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:c1be685ac7700c966b8610ccc63c3187a72e33cab53526a27b2a285a662cd4f7", size = 61578, upload-time = "2025-11-07T00:43:32.918Z" }, + { url = "https://files.pythonhosted.org/packages/5b/36/825b44c8a10556957bc0c1d84c7b29a40e05fcf1873b6c40aa9dbe0bd972/wrapt-2.0.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:df0b6d3b95932809c5b3fecc18fda0f1e07452d05e2662a0b35548985f256e28", size = 114115, upload-time = "2025-11-07T00:43:35.605Z" }, + { url = "https://files.pythonhosted.org/packages/83/73/0a5d14bb1599677304d3c613a55457d34c344e9b60eda8a737c2ead7619e/wrapt-2.0.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4da7384b0e5d4cae05c97cd6f94faaf78cc8b0f791fc63af43436d98c4ab37bb", size = 116157, upload-time = "2025-11-07T00:43:37.058Z" }, + { url = "https://files.pythonhosted.org/packages/01/22/1c158fe763dbf0a119f985d945711d288994fe5514c0646ebe0eb18b016d/wrapt-2.0.1-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:ec65a78fbd9d6f083a15d7613b2800d5663dbb6bb96003899c834beaa68b242c", size = 112535, upload-time = "2025-11-07T00:43:34.138Z" }, + { url = "https://files.pythonhosted.org/packages/5c/28/4f16861af67d6de4eae9927799b559c20ebdd4fe432e89ea7fe6fcd9d709/wrapt-2.0.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:7de3cc939be0e1174969f943f3b44e0d79b6f9a82198133a5b7fc6cc92882f16", size = 115404, upload-time = "2025-11-07T00:43:39.214Z" }, + { url = "https://files.pythonhosted.org/packages/a0/8b/7960122e625fad908f189b59c4aae2d50916eb4098b0fb2819c5a177414f/wrapt-2.0.1-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:fb1a5b72cbd751813adc02ef01ada0b0d05d3dcbc32976ce189a1279d80ad4a2", size = 111802, upload-time = "2025-11-07T00:43:40.476Z" }, + { url = "https://files.pythonhosted.org/packages/3e/73/7881eee5ac31132a713ab19a22c9e5f1f7365c8b1df50abba5d45b781312/wrapt-2.0.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:3fa272ca34332581e00bf7773e993d4f632594eb2d1b0b162a9038df0fd971dd", size = 113837, upload-time = "2025-11-07T00:43:42.921Z" }, + { url = "https://files.pythonhosted.org/packages/45/00/9499a3d14e636d1f7089339f96c4409bbc7544d0889f12264efa25502ae8/wrapt-2.0.1-cp311-cp311-win32.whl", hash = "sha256:fc007fdf480c77301ab1afdbb6ab22a5deee8885f3b1ed7afcb7e5e84a0e27be", size = 58028, upload-time = "2025-11-07T00:43:47.369Z" }, + { url = "https://files.pythonhosted.org/packages/70/5d/8f3d7eea52f22638748f74b102e38fdf88cb57d08ddeb7827c476a20b01b/wrapt-2.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:47434236c396d04875180171ee1f3815ca1eada05e24a1ee99546320d54d1d1b", size = 60385, upload-time = "2025-11-07T00:43:44.34Z" }, + { url = "https://files.pythonhosted.org/packages/14/e2/32195e57a8209003587bbbad44d5922f13e0ced2a493bb46ca882c5b123d/wrapt-2.0.1-cp311-cp311-win_arm64.whl", hash = "sha256:837e31620e06b16030b1d126ed78e9383815cbac914693f54926d816d35d8edf", size = 58893, upload-time = "2025-11-07T00:43:46.161Z" }, + { url = "https://files.pythonhosted.org/packages/cb/73/8cb252858dc8254baa0ce58ce382858e3a1cf616acebc497cb13374c95c6/wrapt-2.0.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:1fdbb34da15450f2b1d735a0e969c24bdb8d8924892380126e2a293d9902078c", size = 78129, upload-time = "2025-11-07T00:43:48.852Z" }, + { url = "https://files.pythonhosted.org/packages/19/42/44a0db2108526ee6e17a5ab72478061158f34b08b793df251d9fbb9a7eb4/wrapt-2.0.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:3d32794fe940b7000f0519904e247f902f0149edbe6316c710a8562fb6738841", size = 61205, upload-time = "2025-11-07T00:43:50.402Z" }, + { url = "https://files.pythonhosted.org/packages/4d/8a/5b4b1e44b791c22046e90d9b175f9a7581a8cc7a0debbb930f81e6ae8e25/wrapt-2.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:386fb54d9cd903ee0012c09291336469eb7b244f7183d40dc3e86a16a4bace62", size = 61692, upload-time = "2025-11-07T00:43:51.678Z" }, + { url = "https://files.pythonhosted.org/packages/11/53/3e794346c39f462bcf1f58ac0487ff9bdad02f9b6d5ee2dc84c72e0243b2/wrapt-2.0.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:7b219cb2182f230676308cdcacd428fa837987b89e4b7c5c9025088b8a6c9faf", size = 121492, upload-time = "2025-11-07T00:43:55.017Z" }, + { url = "https://files.pythonhosted.org/packages/c6/7e/10b7b0e8841e684c8ca76b462a9091c45d62e8f2de9c4b1390b690eadf16/wrapt-2.0.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:641e94e789b5f6b4822bb8d8ebbdfc10f4e4eae7756d648b717d980f657a9eb9", size = 123064, upload-time = "2025-11-07T00:43:56.323Z" }, + { url = "https://files.pythonhosted.org/packages/0e/d1/3c1e4321fc2f5ee7fd866b2d822aa89b84495f28676fd976c47327c5b6aa/wrapt-2.0.1-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:fe21b118b9f58859b5ebaa4b130dee18669df4bd111daad082b7beb8799ad16b", size = 117403, upload-time = "2025-11-07T00:43:53.258Z" }, + { url = "https://files.pythonhosted.org/packages/a4/b0/d2f0a413cf201c8c2466de08414a15420a25aa83f53e647b7255cc2fab5d/wrapt-2.0.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:17fb85fa4abc26a5184d93b3efd2dcc14deb4b09edcdb3535a536ad34f0b4dba", size = 121500, upload-time = "2025-11-07T00:43:57.468Z" }, + { url = "https://files.pythonhosted.org/packages/bd/45/bddb11d28ca39970a41ed48a26d210505120f925918592283369219f83cc/wrapt-2.0.1-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:b89ef9223d665ab255ae42cc282d27d69704d94be0deffc8b9d919179a609684", size = 116299, upload-time = "2025-11-07T00:43:58.877Z" }, + { url = "https://files.pythonhosted.org/packages/81/af/34ba6dd570ef7a534e7eec0c25e2615c355602c52aba59413411c025a0cb/wrapt-2.0.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:a453257f19c31b31ba593c30d997d6e5be39e3b5ad9148c2af5a7314061c63eb", size = 120622, upload-time = "2025-11-07T00:43:59.962Z" }, + { url = "https://files.pythonhosted.org/packages/e2/3e/693a13b4146646fb03254636f8bafd20c621955d27d65b15de07ab886187/wrapt-2.0.1-cp312-cp312-win32.whl", hash = "sha256:3e271346f01e9c8b1130a6a3b0e11908049fe5be2d365a5f402778049147e7e9", size = 58246, upload-time = "2025-11-07T00:44:03.169Z" }, + { url = "https://files.pythonhosted.org/packages/a7/36/715ec5076f925a6be95f37917b66ebbeaa1372d1862c2ccd7a751574b068/wrapt-2.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:2da620b31a90cdefa9cd0c2b661882329e2e19d1d7b9b920189956b76c564d75", size = 60492, upload-time = "2025-11-07T00:44:01.027Z" }, + { url = "https://files.pythonhosted.org/packages/ef/3e/62451cd7d80f65cc125f2b426b25fbb6c514bf6f7011a0c3904fc8c8df90/wrapt-2.0.1-cp312-cp312-win_arm64.whl", hash = "sha256:aea9c7224c302bc8bfc892b908537f56c430802560e827b75ecbde81b604598b", size = 58987, upload-time = "2025-11-07T00:44:02.095Z" }, + { url = "https://files.pythonhosted.org/packages/ad/fe/41af4c46b5e498c90fc87981ab2972fbd9f0bccda597adb99d3d3441b94b/wrapt-2.0.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:47b0f8bafe90f7736151f61482c583c86b0693d80f075a58701dd1549b0010a9", size = 78132, upload-time = "2025-11-07T00:44:04.628Z" }, + { url = "https://files.pythonhosted.org/packages/1c/92/d68895a984a5ebbbfb175512b0c0aad872354a4a2484fbd5552e9f275316/wrapt-2.0.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:cbeb0971e13b4bd81d34169ed57a6dda017328d1a22b62fda45e1d21dd06148f", size = 61211, upload-time = "2025-11-07T00:44:05.626Z" }, + { url = "https://files.pythonhosted.org/packages/e8/26/ba83dc5ae7cf5aa2b02364a3d9cf74374b86169906a1f3ade9a2d03cf21c/wrapt-2.0.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:eb7cffe572ad0a141a7886a1d2efa5bef0bf7fe021deeea76b3ab334d2c38218", size = 61689, upload-time = "2025-11-07T00:44:06.719Z" }, + { url = "https://files.pythonhosted.org/packages/cf/67/d7a7c276d874e5d26738c22444d466a3a64ed541f6ef35f740dbd865bab4/wrapt-2.0.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:c8d60527d1ecfc131426b10d93ab5d53e08a09c5fa0175f6b21b3252080c70a9", size = 121502, upload-time = "2025-11-07T00:44:09.557Z" }, + { url = "https://files.pythonhosted.org/packages/0f/6b/806dbf6dd9579556aab22fc92908a876636e250f063f71548a8660382184/wrapt-2.0.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c654eafb01afac55246053d67a4b9a984a3567c3808bb7df2f8de1c1caba2e1c", size = 123110, upload-time = "2025-11-07T00:44:10.64Z" }, + { url = "https://files.pythonhosted.org/packages/e5/08/cdbb965fbe4c02c5233d185d070cabed2ecc1f1e47662854f95d77613f57/wrapt-2.0.1-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:98d873ed6c8b4ee2418f7afce666751854d6d03e3c0ec2a399bb039cd2ae89db", size = 117434, upload-time = "2025-11-07T00:44:08.138Z" }, + { url = "https://files.pythonhosted.org/packages/2d/d1/6aae2ce39db4cb5216302fa2e9577ad74424dfbe315bd6669725569e048c/wrapt-2.0.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:c9e850f5b7fc67af856ff054c71690d54fa940c3ef74209ad9f935b4f66a0233", size = 121533, upload-time = "2025-11-07T00:44:12.142Z" }, + { url = "https://files.pythonhosted.org/packages/79/35/565abf57559fbe0a9155c29879ff43ce8bd28d2ca61033a3a3dd67b70794/wrapt-2.0.1-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:e505629359cb5f751e16e30cf3f91a1d3ddb4552480c205947da415d597f7ac2", size = 116324, upload-time = "2025-11-07T00:44:13.28Z" }, + { url = "https://files.pythonhosted.org/packages/e1/e0/53ff5e76587822ee33e560ad55876d858e384158272cd9947abdd4ad42ca/wrapt-2.0.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:2879af909312d0baf35f08edeea918ee3af7ab57c37fe47cb6a373c9f2749c7b", size = 120627, upload-time = "2025-11-07T00:44:14.431Z" }, + { url = "https://files.pythonhosted.org/packages/7c/7b/38df30fd629fbd7612c407643c63e80e1c60bcc982e30ceeae163a9800e7/wrapt-2.0.1-cp313-cp313-win32.whl", hash = "sha256:d67956c676be5a24102c7407a71f4126d30de2a569a1c7871c9f3cabc94225d7", size = 58252, upload-time = "2025-11-07T00:44:17.814Z" }, + { url = "https://files.pythonhosted.org/packages/85/64/d3954e836ea67c4d3ad5285e5c8fd9d362fd0a189a2db622df457b0f4f6a/wrapt-2.0.1-cp313-cp313-win_amd64.whl", hash = "sha256:9ca66b38dd642bf90c59b6738af8070747b610115a39af2498535f62b5cdc1c3", size = 60500, upload-time = "2025-11-07T00:44:15.561Z" }, + { url = "https://files.pythonhosted.org/packages/89/4e/3c8b99ac93527cfab7f116089db120fef16aac96e5f6cdb724ddf286086d/wrapt-2.0.1-cp313-cp313-win_arm64.whl", hash = "sha256:5a4939eae35db6b6cec8e7aa0e833dcca0acad8231672c26c2a9ab7a0f8ac9c8", size = 58993, upload-time = "2025-11-07T00:44:16.65Z" }, + { url = "https://files.pythonhosted.org/packages/f9/f4/eff2b7d711cae20d220780b9300faa05558660afb93f2ff5db61fe725b9a/wrapt-2.0.1-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:a52f93d95c8d38fed0669da2ebdb0b0376e895d84596a976c15a9eb45e3eccb3", size = 82028, upload-time = "2025-11-07T00:44:18.944Z" }, + { url = "https://files.pythonhosted.org/packages/0c/67/cb945563f66fd0f61a999339460d950f4735c69f18f0a87ca586319b1778/wrapt-2.0.1-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:4e54bbf554ee29fcceee24fa41c4d091398b911da6e7f5d7bffda963c9aed2e1", size = 62949, upload-time = "2025-11-07T00:44:20.074Z" }, + { url = "https://files.pythonhosted.org/packages/ec/ca/f63e177f0bbe1e5cf5e8d9b74a286537cd709724384ff20860f8f6065904/wrapt-2.0.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:908f8c6c71557f4deaa280f55d0728c3bca0960e8c3dd5ceeeafb3c19942719d", size = 63681, upload-time = "2025-11-07T00:44:21.345Z" }, + { url = "https://files.pythonhosted.org/packages/39/a1/1b88fcd21fd835dca48b556daef750952e917a2794fa20c025489e2e1f0f/wrapt-2.0.1-cp313-cp313t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:e2f84e9af2060e3904a32cea9bb6db23ce3f91cfd90c6b426757cf7cc01c45c7", size = 152696, upload-time = "2025-11-07T00:44:24.318Z" }, + { url = "https://files.pythonhosted.org/packages/62/1c/d9185500c1960d9f5f77b9c0b890b7fc62282b53af7ad1b6bd779157f714/wrapt-2.0.1-cp313-cp313t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:e3612dc06b436968dfb9142c62e5dfa9eb5924f91120b3c8ff501ad878f90eb3", size = 158859, upload-time = "2025-11-07T00:44:25.494Z" }, + { url = "https://files.pythonhosted.org/packages/91/60/5d796ed0f481ec003220c7878a1d6894652efe089853a208ea0838c13086/wrapt-2.0.1-cp313-cp313t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:6d2d947d266d99a1477cd005b23cbd09465276e302515e122df56bb9511aca1b", size = 146068, upload-time = "2025-11-07T00:44:22.81Z" }, + { url = "https://files.pythonhosted.org/packages/04/f8/75282dd72f102ddbfba137e1e15ecba47b40acff32c08ae97edbf53f469e/wrapt-2.0.1-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:7d539241e87b650cbc4c3ac9f32c8d1ac8a54e510f6dca3f6ab60dcfd48c9b10", size = 155724, upload-time = "2025-11-07T00:44:26.634Z" }, + { url = "https://files.pythonhosted.org/packages/5a/27/fe39c51d1b344caebb4a6a9372157bdb8d25b194b3561b52c8ffc40ac7d1/wrapt-2.0.1-cp313-cp313t-musllinux_1_2_riscv64.whl", hash = "sha256:4811e15d88ee62dbf5c77f2c3ff3932b1e3ac92323ba3912f51fc4016ce81ecf", size = 144413, upload-time = "2025-11-07T00:44:27.939Z" }, + { url = "https://files.pythonhosted.org/packages/83/2b/9f6b643fe39d4505c7bf926d7c2595b7cb4b607c8c6b500e56c6b36ac238/wrapt-2.0.1-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:c1c91405fcf1d501fa5d55df21e58ea49e6b879ae829f1039faaf7e5e509b41e", size = 150325, upload-time = "2025-11-07T00:44:29.29Z" }, + { url = "https://files.pythonhosted.org/packages/bb/b6/20ffcf2558596a7f58a2e69c89597128781f0b88e124bf5a4cadc05b8139/wrapt-2.0.1-cp313-cp313t-win32.whl", hash = "sha256:e76e3f91f864e89db8b8d2a8311d57df93f01ad6bb1e9b9976d1f2e83e18315c", size = 59943, upload-time = "2025-11-07T00:44:33.211Z" }, + { url = "https://files.pythonhosted.org/packages/87/6a/0e56111cbb3320151eed5d3821ee1373be13e05b376ea0870711f18810c3/wrapt-2.0.1-cp313-cp313t-win_amd64.whl", hash = "sha256:83ce30937f0ba0d28818807b303a412440c4b63e39d3d8fc036a94764b728c92", size = 63240, upload-time = "2025-11-07T00:44:30.935Z" }, + { url = "https://files.pythonhosted.org/packages/1d/54/5ab4c53ea1f7f7e5c3e7c1095db92932cc32fd62359d285486d00c2884c3/wrapt-2.0.1-cp313-cp313t-win_arm64.whl", hash = "sha256:4b55cacc57e1dc2d0991dbe74c6419ffd415fb66474a02335cb10efd1aa3f84f", size = 60416, upload-time = "2025-11-07T00:44:32.002Z" }, + { url = "https://files.pythonhosted.org/packages/73/81/d08d83c102709258e7730d3cd25befd114c60e43ef3891d7e6877971c514/wrapt-2.0.1-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:5e53b428f65ece6d9dad23cb87e64506392b720a0b45076c05354d27a13351a1", size = 78290, upload-time = "2025-11-07T00:44:34.691Z" }, + { url = "https://files.pythonhosted.org/packages/f6/14/393afba2abb65677f313aa680ff0981e829626fed39b6a7e3ec807487790/wrapt-2.0.1-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:ad3ee9d0f254851c71780966eb417ef8e72117155cff04821ab9b60549694a55", size = 61255, upload-time = "2025-11-07T00:44:35.762Z" }, + { url = "https://files.pythonhosted.org/packages/c4/10/a4a1f2fba205a9462e36e708ba37e5ac95f4987a0f1f8fd23f0bf1fc3b0f/wrapt-2.0.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:d7b822c61ed04ee6ad64bc90d13368ad6eb094db54883b5dde2182f67a7f22c0", size = 61797, upload-time = "2025-11-07T00:44:37.22Z" }, + { url = "https://files.pythonhosted.org/packages/12/db/99ba5c37cf1c4fad35349174f1e38bd8d992340afc1ff27f526729b98986/wrapt-2.0.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:7164a55f5e83a9a0b031d3ffab4d4e36bbec42e7025db560f225489fa929e509", size = 120470, upload-time = "2025-11-07T00:44:39.425Z" }, + { url = "https://files.pythonhosted.org/packages/30/3f/a1c8d2411eb826d695fc3395a431757331582907a0ec59afce8fe8712473/wrapt-2.0.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:e60690ba71a57424c8d9ff28f8d006b7ad7772c22a4af432188572cd7fa004a1", size = 122851, upload-time = "2025-11-07T00:44:40.582Z" }, + { url = "https://files.pythonhosted.org/packages/b3/8d/72c74a63f201768d6a04a8845c7976f86be6f5ff4d74996c272cefc8dafc/wrapt-2.0.1-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:3cd1a4bd9a7a619922a8557e1318232e7269b5fb69d4ba97b04d20450a6bf970", size = 117433, upload-time = "2025-11-07T00:44:38.313Z" }, + { url = "https://files.pythonhosted.org/packages/c7/5a/df37cf4042cb13b08256f8e27023e2f9b3d471d553376616591bb99bcb31/wrapt-2.0.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:b4c2e3d777e38e913b8ce3a6257af72fb608f86a1df471cb1d4339755d0a807c", size = 121280, upload-time = "2025-11-07T00:44:41.69Z" }, + { url = "https://files.pythonhosted.org/packages/54/34/40d6bc89349f9931e1186ceb3e5fbd61d307fef814f09fbbac98ada6a0c8/wrapt-2.0.1-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:3d366aa598d69416b5afedf1faa539fac40c1d80a42f6b236c88c73a3c8f2d41", size = 116343, upload-time = "2025-11-07T00:44:43.013Z" }, + { url = "https://files.pythonhosted.org/packages/70/66/81c3461adece09d20781dee17c2366fdf0cb8754738b521d221ca056d596/wrapt-2.0.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:c235095d6d090aa903f1db61f892fffb779c1eaeb2a50e566b52001f7a0f66ed", size = 119650, upload-time = "2025-11-07T00:44:44.523Z" }, + { url = "https://files.pythonhosted.org/packages/46/3a/d0146db8be8761a9e388cc9cc1c312b36d583950ec91696f19bbbb44af5a/wrapt-2.0.1-cp314-cp314-win32.whl", hash = "sha256:bfb5539005259f8127ea9c885bdc231978c06b7a980e63a8a61c8c4c979719d0", size = 58701, upload-time = "2025-11-07T00:44:48.277Z" }, + { url = "https://files.pythonhosted.org/packages/1a/38/5359da9af7d64554be63e9046164bd4d8ff289a2dd365677d25ba3342c08/wrapt-2.0.1-cp314-cp314-win_amd64.whl", hash = "sha256:4ae879acc449caa9ed43fc36ba08392b9412ee67941748d31d94e3cedb36628c", size = 60947, upload-time = "2025-11-07T00:44:46.086Z" }, + { url = "https://files.pythonhosted.org/packages/aa/3f/96db0619276a833842bf36343685fa04f987dd6e3037f314531a1e00492b/wrapt-2.0.1-cp314-cp314-win_arm64.whl", hash = "sha256:8639b843c9efd84675f1e100ed9e99538ebea7297b62c4b45a7042edb84db03e", size = 59359, upload-time = "2025-11-07T00:44:47.164Z" }, + { url = "https://files.pythonhosted.org/packages/71/49/5f5d1e867bf2064bf3933bc6cf36ade23505f3902390e175e392173d36a2/wrapt-2.0.1-cp314-cp314t-macosx_10_13_universal2.whl", hash = "sha256:9219a1d946a9b32bb23ccae66bdb61e35c62773ce7ca6509ceea70f344656b7b", size = 82031, upload-time = "2025-11-07T00:44:49.4Z" }, + { url = "https://files.pythonhosted.org/packages/2b/89/0009a218d88db66ceb83921e5685e820e2c61b59bbbb1324ba65342668bc/wrapt-2.0.1-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:fa4184e74197af3adad3c889a1af95b53bb0466bced92ea99a0c014e48323eec", size = 62952, upload-time = "2025-11-07T00:44:50.74Z" }, + { url = "https://files.pythonhosted.org/packages/ae/18/9b968e920dd05d6e44bcc918a046d02afea0fb31b2f1c80ee4020f377cbe/wrapt-2.0.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c5ef2f2b8a53b7caee2f797ef166a390fef73979b15778a4a153e4b5fedce8fa", size = 63688, upload-time = "2025-11-07T00:44:52.248Z" }, + { url = "https://files.pythonhosted.org/packages/a6/7d/78bdcb75826725885d9ea26c49a03071b10c4c92da93edda612910f150e4/wrapt-2.0.1-cp314-cp314t-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:e042d653a4745be832d5aa190ff80ee4f02c34b21f4b785745eceacd0907b815", size = 152706, upload-time = "2025-11-07T00:44:54.613Z" }, + { url = "https://files.pythonhosted.org/packages/dd/77/cac1d46f47d32084a703df0d2d29d47e7eb2a7d19fa5cbca0e529ef57659/wrapt-2.0.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:2afa23318136709c4b23d87d543b425c399887b4057936cd20386d5b1422b6fa", size = 158866, upload-time = "2025-11-07T00:44:55.79Z" }, + { url = "https://files.pythonhosted.org/packages/8a/11/b521406daa2421508903bf8d5e8b929216ec2af04839db31c0a2c525eee0/wrapt-2.0.1-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:6c72328f668cf4c503ffcf9434c2b71fdd624345ced7941bc6693e61bbe36bef", size = 146148, upload-time = "2025-11-07T00:44:53.388Z" }, + { url = "https://files.pythonhosted.org/packages/0c/c0/340b272bed297baa7c9ce0c98ef7017d9c035a17a6a71dce3184b8382da2/wrapt-2.0.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:3793ac154afb0e5b45d1233cb94d354ef7a983708cc3bb12563853b1d8d53747", size = 155737, upload-time = "2025-11-07T00:44:56.971Z" }, + { url = "https://files.pythonhosted.org/packages/f3/93/bfcb1fb2bdf186e9c2883a4d1ab45ab099c79cbf8f4e70ea453811fa3ea7/wrapt-2.0.1-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:fec0d993ecba3991645b4857837277469c8cc4c554a7e24d064d1ca291cfb81f", size = 144451, upload-time = "2025-11-07T00:44:58.515Z" }, + { url = "https://files.pythonhosted.org/packages/d2/6b/dca504fb18d971139d232652656180e3bd57120e1193d9a5899c3c0b7cdd/wrapt-2.0.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:949520bccc1fa227274da7d03bf238be15389cd94e32e4297b92337df9b7a349", size = 150353, upload-time = "2025-11-07T00:44:59.753Z" }, + { url = "https://files.pythonhosted.org/packages/1d/f6/a1de4bd3653afdf91d250ca5c721ee51195df2b61a4603d4b373aa804d1d/wrapt-2.0.1-cp314-cp314t-win32.whl", hash = "sha256:be9e84e91d6497ba62594158d3d31ec0486c60055c49179edc51ee43d095f79c", size = 60609, upload-time = "2025-11-07T00:45:03.315Z" }, + { url = "https://files.pythonhosted.org/packages/01/3a/07cd60a9d26fe73efead61c7830af975dfdba8537632d410462672e4432b/wrapt-2.0.1-cp314-cp314t-win_amd64.whl", hash = "sha256:61c4956171c7434634401db448371277d07032a81cc21c599c22953374781395", size = 64038, upload-time = "2025-11-07T00:45:00.948Z" }, + { url = "https://files.pythonhosted.org/packages/41/99/8a06b8e17dddbf321325ae4eb12465804120f699cd1b8a355718300c62da/wrapt-2.0.1-cp314-cp314t-win_arm64.whl", hash = "sha256:35cdbd478607036fee40273be8ed54a451f5f23121bd9d4be515158f9498f7ad", size = 60634, upload-time = "2025-11-07T00:45:02.087Z" }, + { url = "https://files.pythonhosted.org/packages/15/d1/b51471c11592ff9c012bd3e2f7334a6ff2f42a7aed2caffcf0bdddc9cb89/wrapt-2.0.1-py3-none-any.whl", hash = "sha256:4d2ce1bf1a48c5277d7969259232b57645aae5686dba1eaeade39442277afbca", size = 44046, upload-time = "2025-11-07T00:45:32.116Z" }, +]