Commit Scope may not contain dots

[ddluke]

Attempting to create a commit like feat(foo.bar): something currently makes conventional-pre-commit fail, raising an error as such:

[Bad commit message] >> feat(foo.bar): something
Your commit message does not follow Conventional Commits formatting
https://www.conventionalcommits.org/

Conventional Commit messages follow a pattern like:

    type(scope): subject

    extended body

Please correct the following errors:

  - Expected value for delim but found none.
  - Expected value for subject but found none.
  - Expected value for body but found none.

Run:

    git commit --edit --file=.git/COMMIT_EDITMSG

to edit the commit message and retry the commit.

IMHO, the https://www.conventionalcommits.org/en/v1.0.0/ doesn't state that dots must not be used inside the scope. To me, this feels like a bug in conventional-pre-commit 🤔

[Scotchester]

Interesting idea. The spec does say "A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis…" (emphasis added), and it seems like introducing punctuation would make it hard for it to be a noun, but I suppose you could make the argument that if you wanted to explicitly reference a specific part of the codebase – e.g., following the Python pattern of module.submodule – that could be considered a noun.

[thekaveman]

We do support other punctuation and special characters, see: https://github.com/compilerla/conventional-pre-commit/blob/main/conventional_pre_commit/format.py#L131

I'm not sure why "." is not in that list... 🤔 I don't see why it couldn't be.

@ddluke we'd welcome a PR to fix this if you'd like to put something together (with tests please 🙏)

[ddluke]

We do support other punctuation and special characters, see: https://github.com/compilerla/conventional-pre-commit/blob/main/conventional_pre_commit/format.py#L131

I'm not sure why "." is not in that list... 🤔 I don't see why it couldn't be.

@ddluke we'd welcome a PR to fix this if you'd like to put something together (with tests please 🙏)

Hey @thekaveman - I've just created a PR to support this request :) I haven't found a contribute guide (or otherwise I'm blind), I hope this PR follows your repositories conventions: #140

[thekaveman]

Thanks again for the report and the PR @ddluke!

This was released in v4.3.0

• https://github.com/compilerla/conventional-pre-commit/releases/tag/v4.3.0
• https://pypi.org/project/conventional-pre-commit/4.3.0/