From 31a0c073465cacf7622a3d00ab96c967cbaa1b3a Mon Sep 17 00:00:00 2001 From: Munir Abdinur Date: Thu, 8 Aug 2024 20:01:10 -0400 Subject: [PATCH] chore(hatch): adds lint:checks script (#9942) There is no one hatch script that runs all checks in `pre-check` ([ex](https://app.circleci.com/pipelines/github/DataDog/dd-trace-py/66755/workflows/193957fc-1523-468f-ba87-0acfeb8817f2/jobs/4099402)). This PR adds the `hatch run lint:check` command which validate changes against all pre_check rules. ## Potential next steps Update [gen_pre_checks](https://github.com/DataDog/dd-trace-py/blob/v2.10.0rc4/scripts/gen_circleci_config.py#L41) to use `hatch run lint:check` validate all linting rules. This will help prevent `lint:checks` from becoming outdated. ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) --------- Co-authored-by: Romain Komorn <136473744+romainkomorndatadog@users.noreply.github.com> --- hatch.toml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/hatch.toml b/hatch.toml index b580fc9c720..a21008eacb7 100644 --- a/hatch.toml +++ b/hatch.toml @@ -45,6 +45,16 @@ fmt = [ "ruff --fix {args:.}", "style", ] +# checks should encapsulate all rules used in pre-check +checks = [ + "style", + "typing", + "spelling", + "riot", + "security", + "test", + "suitespec-check", +] spelling = [ "codespell --skip='ddwaf.h,*cassettes*' {args:ddtrace/ tests/ releasenotes/ docs/}", ]