Merge pull request #1756 from atom/ku-tt-commit-msg-template

Re-introduce commit message template

lib/controllers/commit-controller.js

@@ -28,7 +28,6 @@ export default class CommitController extends React.Component {
 
     repository: PropTypes.object.isRequired,
     isMerging: PropTypes.bool.isRequired,
-    mergeMessage: PropTypes.string,
     mergeConflictsExist: PropTypes.bool.isRequired,
     stagedChangesExist: PropTypes.bool.isRequired,
     lastCommit: PropTypes.object.isRequired,
@@ -78,10 +77,6 @@ export default class CommitController extends React.Component {
         }
       }),
     );
-
-    if (this.props.isMerging && !this.getCommitMessage()) {
-      this.commitMessageBuffer.setText(this.props.mergeMessage || '');
-    }
   }
 
   render() {
@@ -115,11 +110,7 @@ export default class CommitController extends React.Component {
   }
 
   componentDidUpdate(prevProps) {
-    if (!prevProps.isMerging && this.props.isMerging && !this.getCommitMessage()) {
-      this.commitMessageBuffer.setText(this.props.mergeMessage || '');
-    } else {
-      this.commitMessageBuffer.setTextViaDiff(this.getCommitMessage());
-    }
+    this.commitMessageBuffer.setTextViaDiff(this.getCommitMessage());
   }
 
   componentWillUnmount() {
@@ -140,9 +131,9 @@ export default class CommitController extends React.Component {
     return this.props.commit(msg.trim(), {amend, coAuthors, verbatim});
   }
 
-  setCommitMessage(message) {
+  setCommitMessage(message, options) {
     if (!this.props.repository.isPresent()) { return; }
-    this.props.repository.setCommitMessage(message);
+    this.props.repository.setCommitMessage(message, options);
   }
 
   getCommitMessage() {
@@ -157,7 +148,7 @@ export default class CommitController extends React.Component {
     if (!this.props.repository.isPresent()) {
       return;
     }
-    this.setCommitMessage(this.commitMessageBuffer.getText());
+    this.setCommitMessage(this.commitMessageBuffer.getText(), {suppressUpdate: true});
   }
 
   getCommitMessageEditors() {

lib/controllers/git-tab-controller.js

@@ -269,13 +269,15 @@ export default class GitTabController extends React.Component {
     const repo = this.props.repository;
     const lastCommit = await repo.getLastCommit();
     if (lastCommit.isUnbornRef()) { return null; }
+
+    await repo.undoLastCommit();
     repo.setCommitMessage(lastCommit.getFullMessage());
 
     const coAuthors = lastCommit.getCoAuthors().map(author =>
       new Author(author.email, author.name));
 
     this.updateSelectedCoAuthors(coAuthors);
-    return repo.undoLastCommit();
+    return null;
   }
 
   async abortMerge() {

lib/get-repo-pipeline-manager.js

@@ -210,7 +210,8 @@ export default function({confirm, notificationManager, workspace}) {
   commitPipeline.addMiddleware('failed-to-commit-error', async (next, repository) => {
     try {
       const result = await next();
-      repository.setCommitMessage('');
+      const template = await repository.fetchCommitMessageTemplate();
+      repository.setCommitMessage(template || '');
       destroyFilePatchPaneItems({onlyStaged: true}, workspace);
       return result;
     } catch (error) {

lib/git-shell-out-strategy.js

@@ -53,6 +53,17 @@ const DISABLE_COLOR_FLAGS = [
   return acc;
 }, []);
 
+/**
+ * Expand config path name per
+ * https://git-scm.com/docs/git-config#git-config-pathname
+ * this regex attempts to get the specified user's home directory
+ * Ex: on Mac ~kuychaco/ is expanded to the specified user’s home directory (/Users/kuychaco)
+ * Regex translation:
+ * ^~ line starts with tilde
+ * ([^/]*)/ captures non-forwardslash characters before first slash
+ */
+const EXPAND_TILDE_REGEX = new RegExp('^~([^/]*)/');
+
 export default class GitShellOutStrategy {
   static defaultExecArgs = {
     stdin: null,
@@ -422,6 +433,29 @@ export default class GitShellOutStrategy {
     return this.exec(args, {writeOperation: true});
   }
 
+  async fetchCommitMessageTemplate() {
+    let templatePath = await this.getConfig('commit.template');
+    if (!templatePath) {
+      return null;
+    }
+
+    const homeDir = os.homedir();
+
+    templatePath = templatePath.trim().replace(EXPAND_TILDE_REGEX, (_, user) => {
+      // if no user is specified, fall back to using the home directory.
+      return `${user ? path.join(path.dirname(homeDir), user) : homeDir}/`;
+    });
+
+    if (!path.isAbsolute(templatePath)) {
+      templatePath = path.join(this.workingDir, templatePath);
+    }
+
+    if (!await fileExists(templatePath)) {
+      throw new Error(`Invalid commit template path set in Git config: ${templatePath}`);
+    }
+    return await fs.readFile(templatePath, {encoding: 'utf8'});
+  }
+
   unstageFiles(paths, commit = 'HEAD') {
     if (paths.length === 0) { return Promise.resolve(null); }
     const args = ['reset', commit, '--'].concat(paths.map(toGitPathSep));
@@ -889,7 +923,7 @@ export default class GitShellOutStrategy {
     let output;
     try {
       let args = ['config'];
-      if (local) { args.push('--local'); }
+      if (local || atom.inSpecMode()) { args.push('--local'); }
       args = args.concat(option);
       output = await this.exec(args);
     } catch (err) {

lib/helpers.js

@@ -320,6 +320,9 @@ export function toGitPathSep(rawPath) {
   }
 }
 
+export function filePathEndsWith(filePath, ...segments) {
+  return filePath.endsWith(path.join(...segments));
+}
 
 /**
  * Turns an array of things @kuychaco cannot eat

lib/models/repository-states/present.js

@@ -16,6 +16,7 @@ import RemoteSet from '../remote-set';
 import Commit from '../commit';
 import OperationStates from '../operation-states';
 import {addEvent} from '../../reporter-proxy';
+import {filePathEndsWith} from '../../helpers';
 
 /**
  * State used when the working directory contains a valid git repository and can be interacted with. Performs
@@ -39,20 +40,46 @@ export default class Present extends State {
     this.operationStates = new OperationStates({didUpdate: this.didUpdate.bind(this)});
 
     this.commitMessage = '';
+    this.commitMessageTemplate = null;
+    this.fetchInitialMessage();
 
     if (history) {
       this.discardHistory.updateHistory(history);
     }
   }
 
-  setCommitMessage(message) {
+  setCommitMessage(message, {suppressUpdate} = {suppressUpdate: false}) {
     this.commitMessage = message;
+    if (!suppressUpdate) {
+      this.didUpdate();
+    }
+  }
+
+  setCommitMessageTemplate(template) {
+    this.commitMessageTemplate = template;
+  }
+
+  async fetchInitialMessage() {
+    const mergeMessage = await this.repository.getMergeMessage();
+    const template = await this.fetchCommitMessageTemplate();
+    if (template) {
+      this.commitMessageTemplate = template;
+    }
+    if (mergeMessage) {
+      this.setCommitMessage(mergeMessage);
+    } else if (template) {
+      this.setCommitMessage(template);
+    }
   }
 
   getCommitMessage() {
     return this.commitMessage;
   }
 
+  fetchCommitMessageTemplate() {
+    return this.git().fetchCommitMessageTemplate();
+  }
+
   getOperationStates() {
     return this.operationStates;
   }
@@ -75,7 +102,8 @@ export default class Present extends State {
     this.didUpdate();
   }
 
-  observeFilesystemChange(paths) {
+  invalidateCacheAfterFilesystemChange(events) {
+    const paths = events.map(e => e.special || e.path);
     const keys = new Set();
     for (let i = 0; i < paths.length; i++) {
       const fullPath = paths[i];
@@ -88,18 +116,17 @@ export default class Present extends State {
         continue;
       }
 
-      const endsWith = (...segments) => fullPath.endsWith(path.join(...segments));
       const includes = (...segments) => fullPath.includes(path.join(...segments));
 
-      if (endsWith('.git', 'index')) {
+      if (filePathEndsWith(fullPath, '.git', 'index')) {
         keys.add(Keys.stagedChangesSinceParentCommit);
         keys.add(Keys.filePatch.all);
         keys.add(Keys.index.all);
         keys.add(Keys.statusBundle);
         continue;
       }
 
-      if (endsWith('.git', 'HEAD')) {
+      if (filePathEndsWith(fullPath, '.git', 'HEAD')) {
         keys.add(Keys.branches);
         keys.add(Keys.lastCommit);
         keys.add(Keys.recentCommits);
@@ -125,7 +152,7 @@ export default class Present extends State {
         continue;
       }
 
-      if (endsWith('.git', 'config')) {
+      if (filePathEndsWith(fullPath, '.git', 'config')) {
         keys.add(Keys.remotes);
         keys.add(Keys.config.all);
         keys.add(Keys.statusBundle);
@@ -144,6 +171,47 @@ export default class Present extends State {
     }
   }
 
+  isCommitMessageClean() {
+    if (this.commitMessage.trim() === '') {
+      return true;
+    } else if (this.commitMessageTemplate) {
+      return this.commitMessage === this.commitMessageTemplate;
+    }
+    return false;
+  }
+
+  async updateCommitMessageAfterFileSystemChange(events) {
+    for (let i = 0; i < events.length; i++) {
+      const event = events[i];
+
+      if (filePathEndsWith(event.path, '.git', 'MERGE_HEAD')) {
+        if (event.action === 'created') {
+          if (this.isCommitMessageClean()) {
+            this.setCommitMessage(await this.repository.getMergeMessage());
+          }
+        } else if (event.action === 'deleted') {
+          this.setCommitMessage(this.commitMessageTemplate || '');
+        }
+      }
+
+      if (filePathEndsWith(event.path, '.git', 'config')) {
+        // this won't catch changes made to the template file itself...
+        const template = await this.fetchCommitMessageTemplate();
+        if (template === null) {
+          this.setCommitMessage('');
+        } else if (this.commitMessageTemplate !== template) {
+          this.setCommitMessage(template);
+        }
+        this.setCommitMessageTemplate(template);
+      }
+    }
+  }
+
+  observeFilesystemChange(events) {
+    this.invalidateCacheAfterFilesystemChange(events);
+    this.updateCommitMessageAfterFileSystemChange(events);
+  }
+
   refresh() {
     this.cache.clear();
     this.didUpdate();
@@ -280,7 +348,10 @@ export default class Present extends State {
         Keys.filePatch.all,
         Keys.index.all,
       ],
-      () => this.git().abortMerge(),
+      async () => {
+        await this.git().abortMerge();
+        this.setCommitMessage(this.commitMessageTemplate || '');
+      },
     );
   }
 

lib/models/repository-states/state.js

@@ -374,6 +374,10 @@ export default class State {
     return '';
   }
 
+  fetchCommitMessageTemplate() {
+    return unsupportedOperationPromise(this, 'fetchCommitMessageTemplate');
+  }
+
   // Cache
 
   getCache() {

lib/models/repository.js

@@ -358,6 +358,7 @@ const delegates = [
 
   'setCommitMessage',
   'getCommitMessage',
+  'fetchCommitMessageTemplate',
   'getCache',
 ];
 

lib/models/workdir-context.js

@@ -50,8 +50,7 @@ export default class WorkdirContext {
     // Wire up event forwarding among models
     this.subs.add(this.repository.onDidChangeState(this.repositoryChangedState));
     this.subs.add(this.observer.onDidChange(events => {
-      const paths = events.map(e => e.special || e.path);
-      this.repository.observeFilesystemChange(paths);
+      this.repository.observeFilesystemChange(events);
     }));
     this.subs.add(this.observer.onDidChangeWorkdirOrHead(() => this.emitter.emit('did-change-workdir-or-head')));
 

lib/views/commit-view.js

@@ -460,13 +460,18 @@ export default class CommitView extends React.Component {
     }
   }
 
+  isValidMessage() {
+    // ensure that there are at least some non-comment lines in the commit message.
+    // Commented lines are stripped out of commit messages by git, by default configuration.
+    return this.props.messageBuffer.getText().replace(/^#.*$/gm, '').trim().length !== 0;
+  }
+
   commitIsEnabled(amend) {
-    const messageExists = this.props.messageBuffer.getLength() > 0;
     return !this.props.isCommitting &&
       (amend || this.props.stagedChangesExist) &&
       !this.props.mergeConflictsExist &&
       this.props.lastCommit.isPresent() &&
-      (this.props.deactivateCommitBox || (amend || messageExists));
+      (this.props.deactivateCommitBox || (amend || this.isValidMessage()));
   }
 
   commitButtonText() {
@@ -580,6 +585,11 @@ export default class CommitView extends React.Component {
 
     if (focus === CommitView.focus.EDITOR) {
       if (this.refEditorComponent.map(focusElement).getOr(false)) {
+        if (this.props.messageBuffer.getText().length > 0 && !this.isValidMessage()) {
+          // there is likely a commit message template present
+          // we want the cursor to be at the beginning, not at the and of the template
+          this.refEditorComponent.get().getModel().setCursorBufferPosition([0, 0]);
+        }
         return true;
       }
     }