feat: add support for git submodules

[ericcornelissen]

Implements build-in support for linting the commits of git sub modules, which currently doesn't work because sub modules don't have their own .git folder.

Description

I updated the read module to determine if it is running from a git sub module or not and find the COMMIT_EDITMSG accordingly. It still uses edit argument if present, otherwise it looks at .git and checks whether it is a directory (if it is, look for the COMMIT_EDITMSG as before) or a file, in which case it reads the file to figure out where the COMMIT_EDITMSG can be found.

Comments on my implementation are welcome, I'm happy to change it if needed 🙂

Motivation and Context

This change is required in order to support linting the commits of git sub modules.

Fixes #448

Usage examples

n/a

How Has This Been Tested?

Tests are missing from this PR (at least for now) as it requires an update to the @commitlint/test package (support for sub modules in the git helper has to be added). However, I did create a test locally with a rough outline of what the update to the @commitlint/test might look like. You can find the required changes in this gist, simply checkout on this branch and replace the local files with the two in the gist and you can test the new feature.

The reason I opened this PR first is because I wanted to be sure this would be included before updating the @commitlint/test code and adding something that wasn't really needed...

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes. (see "How Has This Been Tested?" for details)
• All new and existing tests passed.

[marionebl]

Thanks for the PR @ericcornelissen! Could you provide us with a minimal test case you used to implement this? I'd like to include it as a fixture/test pair for the cli package.

[ericcornelissen]

I'm unsure what you mean @marionebl, in the PR description I outlined how it has been tested. If you need more detail, the test scenario I added is "get edit commit message from git submodule" which requires the function submodule in @commitlint/test.

What the test scenario does in plain English is:

1. Bootstrap a git repository
2. Add a submodule to that repository
3. Make a commit in the submodule
4. read from the submodule
5. Verify read returned the commit message of the submodule's commit

Does that help?