Sub directory

README.md

@@ -69,6 +69,7 @@ $ changelog -h
     -x, --exclude <types>  exclude selected commit types (comma separated)
     -f, --file [file]      file to write to, defaults to ./CHANGELOG.md, use - for stdout
     -u, --repo-url [url]   specify the repo URL for commit links, defaults to checking the package.json
+    -s, --sub-directory <path>  specify a path to be passed into git log
 ```
 
 It's possible to create a `./CHANGELOG.md` file for a specific commit range:
@@ -107,6 +108,11 @@ The way that I would recommend using this module would be the way it's being use
 "release:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags",
 ```
 
+### Sub-directory
+
+Setting up the `--sub-directory` flag will run the `git log` command under the specified path.
+When combined with the `--file` flag, the input/output file would be ***relative to the sub-directory*** specified in the previous flag.
+
 ## Testing
 
 To run the test suite, just clone the repository and run the following:

bin/generate

@@ -2,19 +2,22 @@
 'use strict';
 
 var Bluebird = require('bluebird');
+var Path     = require('path');
 
 var CLI       = require('../lib/cli');
 var Changelog = require('../lib');
 var File      = require('../lib/file');
 
 CLI.parse(process.argv);
 
+var filePath = CLI.file !== '-' ? Path.join(CLI.subDirectory, CLI.file) : CLI.file;
+
 return Bluebird.all([
   Changelog.generate(CLI),
-  File.readIfExists(CLI.file)
+  File.readIfExists(filePath)
 ])
 .spread(function (newLogs, oldLogs) {
-  return File.writeToFile(CLI.file, newLogs + oldLogs);
+  return File.writeToFile(filePath, newLogs + oldLogs);
 })
 .catch(function (err) {
   console.error(err);

lib/cli.js

@@ -17,4 +17,5 @@ module.exports = CLI
   .option('-t, --tag <range>', 'generate from specific tag or range (e.g. v1.2.3 or v1.2.3..v1.2.4)')
   .option('-x, --exclude <types>', 'exclude selected commit types (comma separated)', list)
   .option('-f, --file [file]', 'file to write to, defaults to ./CHANGELOG.md, use - for stdout', './CHANGELOG.md')
-  .option('-u, --repo-url [url]', 'specify the repo URL for commit links, defaults to checking the package.json');
+  .option('-u, --repo-url [url]', 'specify the repo URL for commit links, defaults to checking the package.json')
+  .option('-s, --sub-directory <path>', 'specify a path to be passed into git log', '.');

lib/git.js

@@ -33,8 +33,10 @@ exports.getCommits = function (options) {
       revisions = tag ? tag + '..HEAD' : '';
     }
 
+    var gitLogCommand = 'git log -E --format=' + FORMAT + ' ' + revisions + ' -- ' + options.subDirectory;
+
     return CP.execAsync(
-      'git log -E --format=' + FORMAT + ' ' + revisions,
+      gitLogCommand,
       {
         maxBuffer: Number.MAX_SAFE_INTEGER
       }

test/git.test.js

@@ -126,6 +126,20 @@ describe('git', function () {
       });
     });
 
+    it('uses subDirectory for filtering git log command when `-s` / `--sub-directory` option was used', function () {
+      Sinon.stub(CP, 'execAsync')
+        .onFirstCall().returns(Bluebird.resolve('1.2.3.4'))
+        .onSecondCall().returns(Bluebird.resolve(VALID_COMMITS));
+
+      var subDirectory = 'subdirectory';
+
+      return Git.getCommits({ subDirectory: subDirectory })
+      .then(function () {
+        CP.execAsync.secondCall.calledWithMatch(new RegExp('-- ' + subDirectory + '$'));
+        CP.execAsync.restore();
+      });
+    });
+
   });
 
 });