Merge pull request #11 from groupon/dbushong/feature/master/moar-pr-tmpl

support more PULL_REQUEST_TEMPLATE.md locs

Author: dbushong

lib/commands/pr.js

@@ -33,9 +33,8 @@
 'use strict';
 
 const open = require('open');
-const process = require('process');
 const fs = require('fs');
-const { join } = require('path');
+const path = require('path');
 
 const {
   ghURL,
@@ -76,6 +75,22 @@ function forkPrefix(git) {
   });
 }
 
+function prTemplateBodySuffix() {
+  // See: https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository
+  for (const subDir of ['', '.github', 'docs']) {
+    for (const file of [
+      'PULL_REQUEST_TEMPLATE.md',
+      'pull_request_template.md',
+    ]) {
+      const pathToPrTemplate = path.resolve(subDir, file);
+      if (fs.existsSync(pathToPrTemplate)) {
+        return `${fs.readFileSync(pathToPrTemplate)}\n`;
+      }
+    }
+  }
+  return '';
+}
+
 /** @type {import('../typedefs').ActionFn} */
 async function prAction({ deps: { git, log }, opts }) {
   log('Ensuring all work is pushed to remote');
@@ -124,18 +139,7 @@ async function prAction({ deps: { git, log }, opts }) {
   }
 
   body += '\n';
-
-  if (!opts.ignorePrTemplate) {
-    const pathToPrTemplate = join(
-      process.cwd(),
-      '.github',
-      'PULL_REQUEST_TEMPLATE.md'
-    );
-    if (fs.existsSync(pathToPrTemplate)) {
-      body += `${fs.readFileSync(pathToPrTemplate)}\n\n`;
-    }
-  }
-
+  if (!opts.ignorePrTemplate) body += prTemplateBodySuffix();
   body += `\n\n\n---\n_This PR was started by: ${cmdLine(true)}_`;
 
   const prURL = await ghURL(git, `/compare/${parent}...${remoteBranch}`, {

test/pr.test.js

@@ -9,6 +9,7 @@ const addHooks = require('./test-common');
 const verifySetup = require('../lib/setup');
 const { action: startAction } = require('../lib/commands/start');
 const { action: prAction } = require('../lib/commands/pr');
+const { writeFileSync, mkdirSync } = require('fs');
 
 function extractURL(logs) {
   return URL.parse(logs.match(/^Opening (https:\S+)/m)[1], true);
@@ -64,21 +65,34 @@ describe('pr', () => {
   });
 
   it('respects the contents of a PULL_REQUEST_TEMPLATE', async () => {
+    writeFileSync('PULL_REQUEST_TEMPLATE.md', 'Important stuff');
     const url = await setupForPR(t, ['feat: use a PR template']);
     assert.include(
       'contents of a PULL_REQUEST_TEMPLATE.md file',
-      "Please ensure you adequately describe both the problem you're solving for",
+      'Important stuff',
+      url.query.body
+    );
+  });
+
+  it('respects the contents of a .github/pull_request_template', async () => {
+    mkdirSync('.github');
+    writeFileSync('.github/pull_request_template.md', 'Other stuff');
+    const url = await setupForPR(t, ['feat: use a PR template']);
+    assert.include(
+      'contents of a pull_request_template.md file',
+      'Other stuff',
       url.query.body
     );
   });
 
   it('optionally ignores PULL_REQUEST_TEMPLATE', async () => {
+    writeFileSync('PULL_REQUEST_TEMPLATE.md', 'Important stuff');
     const url = await setupForPR(t, ['feat: use a PR template'], {
       ignorePrTemplate: true,
     });
     assert.notInclude(
       'contents of the PULL REQUEST TEMPLATE are not present',
-      "Please ensure you adequately describe both the problem you're solving for",
+      'Important stuff',
       url.query.body
     );
   });

test/test-common.js

@@ -122,19 +122,23 @@ function addHooks(main = 'master') {
   };
 
   let savedUser;
+  let savedDir;
 
   beforeEach('setup git dir', async () => {
     savedUser = process.env.USER;
+    savedDir = process.cwd();
     process.env.USER = FAKE_USER;
     [t.ghDir, t.ghGit] = await setupGitHubDir();
     [t.localDir, t.git] = await setupLocalDir(t.ghDir, t.ghGit, main);
     [t.localDir2, t.git2] = await setupLocalDir2(t.ghDir);
     [t.forkDir, t.gitFork] = await setupForkDir(t.ghDir);
     t.logged = '';
+    process.chdir(t.localDir);
   });
 
   afterEach(() => {
     process.env.USER = savedUser;
+    process.chdir(savedDir);
     delete t.forceBool;
     return Promise.all(
       [t.ghDir, t.localDir, t.localDir2, t.forkDir].map(dir =>