LeCoupa / vscode-commit-prompt

⛏ Commit faster and cleaner with keybound formatted commit prompt for VS Code

⛏ vscode-commit-prompt

Commit and manage issues faster and cleaner with keybound prompts for VS Code.

• 🕹️ Add & commit multiple files without using your mouse once.
• 💄 Improve your git history with two strong default presets.
• 👥 Specify your own questions, types, scopes and share them with your team.
• ✅ Minimalist approach to GitHub issues management from VS Code quick prompts.

⌨️ Actions

Committing

All actions that relates to committing code (add, push, commit, undo) resolves around Cmd+Y by default.

• cmd+y => commit
• shift+cmd+y => push
• alt+cmd+y => undo
• shift+alt+cmd+y => add

Commit

Opens the Commit prompt.

Prompts for Add beforehand if you enabled [addBeforeCommit].

Prompt for resolvable closable GitHub issues if you enabled [githubToken].

Push after your commit if you enabled [pushAfterCommit].

• Default:

  {
    "command": "vscode-commit-prompt.commit",
    "key": "ctrl+y",
    "mac": "cmd+y"
  }

Add

Opens the Add prompt.

Show changes from current working tree and allow you to add them individually.

Allows to add all (git add ${workspaceRoot}) with first prompt item.

Will rm unchecked files from the staged files.

Will be prompted in Commit flow with [addBeforeCommit], you usually won't need this keybinding.

• Default:

  {
    "command": "vscode-commit-prompt.add",
    "key": "shift+alt+ctrl+y",
    "mac": "shift+alt+cmd+y"
  }

Push

Opens the Push prompt.

Shows the list of commits that will be pushed.

• Default:

  {
    "command": "vscode-commit-prompt.push",
    "key": "shift+ctrl+y",
    "mac": "shift+cmd+y"
  }

Undo

Open the Undo prompt.

Allows to undo the last commit and keep the changes (git reset --soft HEAD^).

Allows to discard the changes (git reset --hard HEAD^).

• Default:

  {
    "command": "vscode-commit-prompt.undo",
    "key": "alt+ctrl+y",
    "mac": "alt+cmd+y" // Alt is Option on Mac 😉
  }

Issues

All actions that relates to GitHub issues resolves around Cmd+U by default.

Any action related to GitHub issues will need you to provide githubToken.

If you do not provide it or the extension fails to gather your issues, it will silently fail, and let you keep using the commit features.

• cmd+u => open
• shift+cmd+u => close
• alt+cmd+u => assign
• shift+alt+cmd+u => unassign

Open

Open issues on GitHub.

Allows to create a new minimal issue with a similar shape as a commit.

Lists open issues on GitHub and orders between assigned and unassigned issues.

You can toggle if new issues gets auto-assigned to you using [autoAssignOpenedIssues].

• Default:

  {
    "command": "vscode-commit-prompt.open",
    "key": "ctrl+u",
    "mac": "cmd+u"
  }

Close

Close open issues from GitHub.

Lists open issues on GitHub and orders between assigned and unassigned issues.

• Default:

  {
    "command": "vscode-commit-prompt.close",
    "key": "shift+ctrl+u",
    "mac": "shimft+cmd+u"
  }

Assign

Self-assign open issues from GitHub.

Lists open issues that are not assigned to you.

• Default:

  {
    "command": "vscode-commit-prompt.assign",
    "key": "alt+ctrl+u",
    "mac": "alt+cmd+u"
  }

Unassign

Self-unassign open issues from GitHub.

Lists open issues that are assigned to you.

• Default:

  {
    "command": "vscode-commit-prompt.unassign",
    "key": "shift+alt+ctrl+u",
    "mac": "shift+alt+cmd+u"
  }

⚙️ Config

There is two way to handle the configuration of this extension.

The first is to use the configuration parameters from VSCode, you will find all the available settings under commit-prompt keys.

The second is to use config files from the current repository you are working with.

The per repository config can be specified from 3 places:

• .cprc file placed at root.
• .cp.json file placed at root.
• "config" key in package.json.

The format must be the following:

{
  "config": {
    "commit-prompt": {}
  }
}

If you are willing to share settings like scopes with your team, I recommend you to use the package.json config key or .vscode/settings.json.

👤 VSCode settings

VSCode settings exposes four parameters:

Preset commit-prompt.preset

You can choose between conventional-commits and cz-emoji.

You can find preset types content here:

• conventional-commits
• cz-emoji

This parameter will be ignored if you overwrite types or questions from package.json or .cprc.

Default: conventional-commits.

Add Before Commit commit-prompt.addBeforeCommit

Whether or not you want the extension to show the add prompt before each commit.

Default: true

Push After Commit commit-prompt.pushAfterCommit

Whether or not your want the extension to git push after each commit.

Default: false

Subject Length commit-prompt.subjectLength

The max allowed length for the commit subject.

Default: 75

Show Output Channel commit-prompt.showOutputChannel

Show the output channel when you commit.

Supports:

• status: will output messages in your VSCode Status Bar.
• popup: will output messages in VSCode Information Messages.
• none: will make the extension fully silent.

👥 Per repository config

Per repository config exposes three parameters: scopes, types and questions.

scopes (optional)

Scopes is a text input by default, allowing you to define a custom scope on each commit.

If you want to lock scopes, and specify a list, you can by using the scopes attribute from config.

Specify a list of scope, and you will be prompted to chose between them on each commit.

const scopes: CommitPromptScopeType;

export interface CommitPromptScopeType {
  name: string;
  description: string;
}

{
  "config": {
    "commit-prompt": {
      "scopes": [
        {
          "name": "the-next-big-feature",
          "description": "Use this scope when working on our next big feature"
        }
      ]
    }
  }
}

types (optional)

If you specify this key in config, the default types will be overwritten by yours completely.

Default can be found in defaultTypes.ts, copy/pasting them can be a great starting point for your own config.

const types: CommitPromptType[];

interface CommitPromptType {
  emoji?: string; // The emoji displayed (optional)
  code: string; // The value added to the commit message (gitmojis works)
  description: string; // The description displayed in the prompt
  name: string; // An id
}

{
  "config": {
    "commit-prompt": {
      "types": [
        {
          "emoji": "💄",
          "code": ":lipstick:",
          "description": "Updating the UI.",
          "name": "ui"
        }
      ]
    }
  }
}

questions (optional)

Specifying questions key will result in overwriting the complete default scenario.

This means you can easily build your own scenario from the config file.

Note that using this key will result in both types and scopes keys to be useless, as you will have to specify these keys directly from your questions payloads.

const questions: Question[];

export interface Question {
  name: string;
  type: "oneOf" | "input";
  placeHolder: string;
  prompts?: CommitPromptType[];
  scopes?: CommitPromptScopeType[];
  format?: string;
}

{
  "config": {
    "commit-prompt": {
      "questions": [
        {
          "name": "type",
          "placeHolder": "Select the type of change you are committing (type)",
          "type": "oneOf",
          "prompts": [
            {
              "emoji": "💄",
              "code": ":lipstick:",
              "description": "Updating the UI.",
              "name": "ui"
            }
          ],
          "format": "({value})"
        }
      ]
    }
  }
}

You can take a look at the default commit questions for further customization.

⁉️ Why?

I would like to improve my commit / issues flow that currently is source of friction to my code sessions.

Switching between my issues tracker, my code editor and the Git CLI is the flow that takes most of my time outside of coding.

Also, I'm used to sending giant commits and that causes me pain everytime I review my git history.

This aims to be a minimal, fast and efficient way to improve my workflow and reduce friction. Maybe it could be yours too?

👨‍💻 Credits

This VSCode app has been written by Yaël GUILLOUX.

This has been heavily inspired by cz-emoji by ngryman.

If you have any question concerning this app, don't hesitate to reach me, on Twitter or by email.