{"id":25705399,"url":"https://github.com/mmore500/git-commit-atom","last_synced_at":"2025-04-30T10:13:11.412Z","repository":{"id":57584053,"uuid":"66168106","full_name":"mmore500/git-commit-atom","owner":"mmore500","description":"Easily edit Git Commit messages in the current Atom pane 🌟 😏","archived":false,"fork":false,"pushed_at":"2017-07-20T17:48:12.000Z","size":15,"stargazers_count":4,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T10:13:03.490Z","etag":null,"topics":["atom","atom-pane","git","git-commit"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmore500.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-20T21:07:28.000Z","updated_at":"2021-08-15T20:55:38.000Z","dependencies_parsed_at":"2022-09-10T12:40:45.012Z","dependency_job_id":null,"html_url":"https://github.com/mmore500/git-commit-atom","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmore500%2Fgit-commit-atom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmore500%2Fgit-commit-atom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmore500%2Fgit-commit-atom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmore500%2Fgit-commit-atom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmore500","download_url":"https://codeload.github.com/mmore500/git-commit-atom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251683356,"owners_count":21626953,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atom","atom-pane","git","git-commit"],"created_at":"2025-02-25T06:47:37.209Z","updated_at":"2025-04-30T10:13:11.388Z","avatar_url":"https://github.com/mmore500.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## git-commit-atom\nWant to use Atom's handy `COMMIT_EDITMSG` syntax highlighting?\n🙋\n\nTired of waiting on Atom to open a new window with the `--wait` option?\n:hourglass: :sleeping:\n\nTogether with [sister Atom package `git-edit-atom`](https://atom.io/packages/git-edit-atom), this Go script allows Git commit files to be conveniently edited in the current editor pane... avoiding the launch of another instance of Atom!\n:star2: :smirk:\n\n![A screenshot of git-edit-atom and git-commit-atom in action together](https://thumbs.gfycat.com/BaggyFreshBoaconstrictor-size_restricted.gif)\n\n## Prerequisites\n * [Sister Atom package `git-edit-atom`](https://atom.io/packages/git-edit-atom), highly recommended.\n\n## Installation\nThere are two steps to the installation process:\n * installing the Go script, and\n * configuring Git to use the Go script.\n\nThere are two ways to install the Go script.\nIf you have Go installed on your machine (want it? see [here](https://golang.org/doc/install)), you can use the following commands to install from source.\n~~~bash\ngo get github.com/mmore500/git-commit-atom\ngo install github.com/mmore500/git-commit-atom\n~~~\nIf your are installing from source, be sure your `GOBIN` is included in your `PATH`! If your `PATH` isn't already properly configured, try adding the following lines to your `.bash_profile`.\n~~~bash\nexport GOPATH=$HOME/go\nexport GOBIN=$GOPATH/bin\nexport PATH=$PATH:$GOPATH/bin\n~~~\n\nIf you don't want to build from source, you can find pre-built executable binaries [here](https://github.com/mmore500/git-commit-atom/releases/latest).\nAll you have to do is\n * download zipped folder appropriate for your operating system and architecture,\n * unzip it, and\n * toss the executable into a bin on your `PATH`.\n\nTo configure Git to use the Go script, use the following command at your terminal.\n~~~bash\ngit config --global core.editor \"git-commit-atom\"\n~~~\nIf you have preexisting Git repositories, you might have to use\n~~~bash\ngit config core.editor \"git-commit-atom\"\n~~~\non them.\n\n## Usage\nOnce `git-commit-atom` is configured as Git's editor, Git `COMMIT_EDITMSG`, `TAG_EDITMSG`, `MERGE_MSG`, `git-rebase-todo`, and `.diff` files will open in the current pane of Atom.\n\nTo complete the message editing process simply close the tab (`cmd-w` is convenient) if the Atom package `git-edit-atom` is installed or, if not, enter `quit` or `done` at the terminal.\n\n## Implementation\nThis project has two components: a standalone Go script that acts as the editor called by Git during the commit process and the Atom package `git-edit-atom`.\n\nWhen the standalone Go script is activated, it opens the `COMMIT_EDITMSG` file in the current Atom pane.\nWhen that file is closed, Atom appends a \"magic marker\" (`## ATOM EDIT COMPLETE##`) to the end of the `COMMIT_EDITMSG` file.\nThe Go script, which is listening to the end of the `COMMIT_EDITMSG` file, recognizes the \"magic marker\" and terminates, ending the commit edit session.\n\nIn addition, the Go script listens for user input at the terminal.\nThe commit session can also be ended by entering `quit` or `done`.\n(This functionality allows the standalone script to function in some capacity without the Atom package in place).\n\nThis project is directly inspired by AJ Foster's `git-commit-atom.sh`, [presented on his personal blog](https://aj-foster.com/2016/git-commit-atom/).\nIt is hoped that this implementation in Go and as an Atom package will yield greater portability and reliability.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmore500%2Fgit-commit-atom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmore500%2Fgit-commit-atom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmore500%2Fgit-commit-atom/lists"}