michaelcurrin / auto-commit-msg

A VS Code extension to generate a smart commit message based on file changes

Hi, I am a software maker

Also a "Data genie" and "open sourcerer"

I'm a Senior Software Engineer working in Amsterdam. I build projects for fun with Python, JavaScript, Jekyll and more. A big fan of elegant designs, clean code, and static site generators.

My profile links are here - bio.link/michaelcurrin.

Blogs and writing 📜

I've very active, writing content daily to at least one of these.

Area	Links
Blog writing
Reference and learning

I'm also active on Jekyll Forums - see my profile @MichaelCurrin.

Tools and skills 🎓

Python is my first love and preferred language - see my Python repos on GitHub.

• Backend (render HTML and build REST APIs)
• Frontend (HTML, CSS, JavaScript)
• Python packages (Requests, Pandas, Django, Flask)
• JavaScript packages (Express, Vue, React, TypeScript, ApexCharts)
• Shell scripting (Linux and macOS)
• Software testing (TDD, BDD, Selenium browser tests)
• Monitoring and observability (Datadog, New Relic, and PageDuty)
• Architect and build AWS cloud infrastructure using Terraform (SQS queues, Postgres, MongoDB, CloudFront, DNS, EC2, and Lambdas)
• Containerized services (Docker and Kubernetes)
• Deployment pipelines (Netlify, GitHub Actions, Buildkite, Jenkins)
• Data Science (web scraping, data visualization, machine learning)
• Write documentation and make documentation sites

More details on the tools:

Area	Tool
OS
Languages
Frameworks
Databases
Infrastructure

I've also done some programming in MySQL, Rust, C, Arduino, Deno...

I’m currently learning more about 🌱

• Go
• Vue
• Python

Open source contrbutions

GitHub Stats

Here are some stats from the GitHub Readme Stats project for my profile.

The S score means "Top 1%" and is better than A+. Stats generated using GitHub Readme Stats service.

Projects 💼

I like to make quickstarts which can be used as templates to make websites, such as with React, Vue, MkDocs, Jekyll or Docsify. See my quickstart projects on GitHub.

My gists are available on a one-page site - Gist Viewer

What is this README profile thing? 🤔

Read more

This page you are reading is a profile readme. Around July 2020, GitHub made this a public feature.

To make one, create a repo named after your username (matching case exactly) and create a README.md file in it. Then go to your GitHub profile and you'll see your README appear there ✨.

• MichaelCurrin/MichaelCurrin repo where this README lives
• GitHub topic: profile-readme
• Tutorial: How To Create A GitHub Profile README

auto-commit-msg's Issues

Respect commit message template

This is something part of standard git hook for commit message, where a check is done to see if the message comes from a template.

If this is not possible, then just read the actual value of commit.template e.g. _COMMIT_MESSAGE and use that as a prefix.

This is useful as a simple alternative to reading from the branch name (which is covered by the git-prefix extension already). And allows manually entering a ticket message or project name that is not based on branch name.

There is a low priority issue though

Fix multi repo handling

There is currently a not implemented message setup to be raised on multiple repos in a workspace, but this did not actually trigger.

So either do that, or get the functionality to work in multiple repos (using the scope of the current scope files and message box (there are multiple).

Detect comments

Detect if all changes in a file are whitespace (ignore those using a git diff-index flag) or start with # or //. This may not be practical for multi-line comments.

This may also required using diff.

Collapse package changes

If package.json and package-lock.json both change (or only the latter changed) and nothing else, then message can be:

build: Update dependencies

Same for pairs as yarn.lock, Gemfile.lock and maybe Pipfile.lock

Add scope

e.g. when working on package files.

chore(deps): - not yet supported
build(deps): - supported

---

This style is harder and depends on the knowing the codebase.

feat(lang): add polish language

Maybe it can be automated using the highest module for the file or files. e.g. src or lib (for src/lib). The directory could be nested a few levels deep. But also there is some risk of duplication of dir names across dirs.

It's not worth putting a filename.

---

Well maybe chore(docs) is a good way to mix docs directory with others.

---

https://www.conventionalcommits.org/en/v1.0.0/

A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.

A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., fix(parser):

Add VS Code integration

VS Code does not work with git hooks. So after getting the shell version working I can look at making a vs code extension based on this one

https://github.com/benjaminadk/emojigit

I could even use my existing command as using the confirmation flow there is a terminal git commit command, but one gets there after using the extension UI. Also the confirmation in the terminal can be toggled. Maybe it is just behind the scenes

if the msg is more than 50 characters then generate a message using counts.

Relates to #38

Add conventional commit support when counting of files

There is unused code in convCommit module - this can be refactored and more used such as arriving as "4 scripts", "3 configs" or 5 CI files"

Must be done after #38 sets the groundwork.

Infer action from lines

e.g. if the diff is all adding new lines, then "add to foo.txt" vs "update foo.txt" for modify. Or "remove lines from foo.txt" for delete.

Add conventional commit docs support

CONTRIBUTING
.md
.rst

Ruby doc format?

And

CONTRIBUTORS(.*)
CHANGELOG(.*)

Change multi-file approach to use action for each word

e.g. Create foo, update bar and delete bazz

refactor: move unused code to separate module

e.g. _lookupStatusAction and status

These don't add value and affect test coverage.

But are worth keeping as a reference for future git status behavior if ever needed

Add a marketplace badge

Add formatting

TODO

This has become confusing where testing also runs linting with pretest, but then you're locked
into a linting choice of fix or not. Same for fmt, if it even goes here.
Also should then fmt go in all?

And CI/CD

Replace images and rename project

See PNG and SVG files

Update move/rename

Use just dir for rename

Use move or rename word appropriately

Update tests

Detect rename vs modify use diff-index

e.g. R100 is rename
R96 is modify and rename

Note this assumes rename and move logic already works (and use one or both in the sentence already)

Apply style effect

Use style in Semantic section - check if the changes are all whitespace only.

For staged, check if there is a diff. and check if the no-whitespace diff is empty (need to check by hand). Then you know there are only whitespace changes.

Repeat for unstaged as fallback.

Otherwise you need to do regex checks against each file diff (maybe using plain diff and not diff-index? either way need patch output)

Flags for diff-index https://www.git-scm.com/docs/git-diff-index

-b
--ignore-space-change

    Ignore changes in amount of whitespace. This ignores whitespace at line end, and considers all other sequences of one or more whitespace characters to be equivalent.
-w
--ignore-all-space

    Ignore whitespace when comparing lines. This ignores differences even if one line has whitespace where the other line has none.

Add support for more than 8 files

The message would be

changed 16 files, deleted 2 files etc

Replace `create 1 file` with `create foo.txt` for 1 file

Relates to #38

Add Conventional Commit for X files changed

Depends on #38

How about the prefix before the message should always be feat if you add or update a file?

And if you only move or rename, it is refactor.

If you only delete files, then it is chore.

Then #50 later.

Suggestion: Allow you to define prefix

Can there be a way to define a custom prefix before each message? For example

ThisIsARequest - update 4 files delete 1 file

Can this be hooked into onSave?

I'm using this in a workspace where i don't care about commit messages, it's a static repo, of markdown files.

And while this is useful, i would rather it automatically populate the message onsave that way all i have to do is click one button.

Add CI caching of deps

Add coverage for prepareCommitMsg

The prepareCommitMsg module has missing coverage based on the reports.

The functions are used in the app but in the autofill and cli modules which are not practical to test and don't have tests, so prepareCommitMsg appears unused.

But the functions in prepareCommitMsg that are missing tests should still be tested directly.

Add integration tests

This is a long term goal as the app has simple UI. See the notes in test section of the docs.

Note that there are different approaches to integration tests. The approach in semantic commit messages is nice. It uses vscode-test as a package in dev deps, which is downloaded when added to .vscode-test dir at the root.

I got error messages before that vscode tests would not run while vscode is running, but this seems okay now in vscode-git-semantic-commit when running my fork and vscode 1.48 downloaded.

Here is the approach in git-prefix to downloading and running vscode

		"postinstall": "node ./node_modules/vscode/bin/install",
		"test": "npm run compile && node ./node_modules/vscode/bin/test"

But the tests doesn't actually do much because of limited coverage.

Lint on build

See max errors flag. Defaults to minus.

https://eslint.org/docs/user-guide/command-line-interface

Update cookbook. There is also an item there which could be useful

Note that fix flag might not fix everything when run locally but checking for errors without fix flag maybe can give error output

Build and attach to release using GH Actions

See recipes

https://github.com/MichaelCurrin/code-cookbook/tree/master/recipes/ci-cd/github-actions/workflows/build-release-assets

Figure out old/new msg for counts

Relates to #38

What happens when there is an old message when making a count message? Throw it away? Especially not useful if the old msg is a count and mixing old and new count messages doesn't make sense or look good.

Maybe keep the conv commit portion

Add `fix` semantic support

Perhaps assume feat if no other context can be found.

Then click the button again. If the output message is the same as the input message, then replace feat with fix

Such that clicking the button twice gives "fix".

Perhaps an option can be added in the command prompt to go straight to fix as well.
An extra button would not work so well on a small screen where there are a few other extensions already

And adding a pop-up on the single button would not be a nice flow because mostly its not needed

Setup CLI use for outside IDE

I've already setup a flow for using the compiled JS files outside of VS Code.

Test and document this, maybe more work is needed to build that and release it.

It could be used as a hook - not in VS Code otherwise it works badly because of VS Code limitations.

It can be available as a globally available NPM package or shell script that calls it. As an alternative to git commit maybe. Maybe as a bin or alias target.

To pre-fill the git message and wait for confirmation (force editing).

e.g.

$ git commit -m $(auto-commit-msg) --edit

Support changes in multiple files

Use feat and switch feat and fix

First make feat the default

Then if the message is identical, replace feat with fix. And back again?

I might be missing the behavior anyway to detect repeat message which is meant to do nothing, besides this new feature.

Update docs

Add badges

Add sample image

Get file extension for file counts

Relates to #38

e.g.

update 38 .svg files

OR

update 38 SVG files

Make Run extension work in temp dir

It's annoying if the extension is launched not in a dir

Then using open opens a normal window without the extension (or using the global one).

See semantic commit handling of test-temp even if not for integration tests but manual testing

Refactor enum

See if enum can be cleaned up

Reverse keys and values?

Change lookup with function or alternate use that is safer than any.

What is proper way to handle undefined, maybe just with if an error?

Add docs site

Use "🎉 Initial commit"

Check for this error in "Log (Window)"

When there are zero commits

: Error: Command failed: git diff-index --name-status --find-renames --find-copies --no-color --cached HEAD
fatal: ambiguous argument 'HEAD': unknown revision or path not in the working tree.

Handle multiple moves

Currently moving 3 files shows as "rename"

Refactor to rename semantic to conventional

Use full name on repeats

e.g.

update cli.ts and cli.ts

To

update cli.ts and git/cli.ts

Using common root src without using src in either.

Count the files for multi-file changes

e.g.

• update 3 files in foo
• update 16 files and delete 2 files

Relates to #13

Semantic choice in UI

When docs: etc. is not manually entered already or deducible...

Maybe one chooses from a droplist like the semantic commit message extension and then that is pushed to the commit message.

Filenames with spaces

Thanks for this extension, I find it very useful. One problem is that I need to work with some files with spaces in their filenames (nothing I can do about it), and the extension splits the file name at the first blank space. Is there a way to let it handle filenames with any Unicode characters like spaces (and other characters, like Russian letters)?

Improve docs

Published to marketplace!

Push message to input box

Perhaps a way in this extension to get close to the easy GH autofill flow.

To listen for when files are staged on unstaged and then push a message to the input box for you.

Unable to generate message as no changes files can be seen. Try saving your files or stage any new (untracked) files.

Says there is nothing to be updated when there are updates available

Add latest release URL

https://github.com/MichaelCurrin/auto-commit-msg/releases/download/v0.7.0/auto-commit-msg-0.7.0.vsix

Something like

https://github.com/MichaelCurrin/auto-commit-msg/releases/download/latest/auto-commit-msg.vsix

Use in the docs with a download button

Allow use of semantic support option only

Perhaps a command prompt option or a button. Or just a space in the message bar.

Fill the message bar with chore: etc. but don't fill in the message - this allows for custom messages.