feat(sub-directory): add -s, --sub-directory option

README.md

@@ -62,6 +62,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 an explicit relatvie path to a sub-directory
 
 ```
 

bin/generate

@@ -9,10 +9,15 @@ var File = require('../lib/file');
 
 CLI.parse(process.argv);
 
-return Bluebird.all([
- Changelog.generate(CLI),
- File.readIfExists(CLI.file)
-])
+return File.normalizeFilePath(CLI.file, CLI.subDirectory)
+.then(function (normalizedPath) {
+ CLI.file = normalizedPath;
+
+ return Bluebird.all([
+ Changelog.generate(CLI),
+ File.readIfExists(CLI.file)
+ ]);
+})
 .spread(function (newLogs, oldLogs) {
  return File.writeToFile(CLI.file, newLogs + oldLogs);
 })

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 an explicit relatvie path to a sub-directory');

lib/file.js

@@ -2,6 +2,7 @@
 
 var Bluebird = require('bluebird');
 var Fs = Bluebird.promisifyAll(require('fs'));
+var Path = Bluebird.promisifyAll(require('path'));
 
 var STDOUT_PATH = '-';
 
@@ -42,3 +43,26 @@ exports.writeToFile = function (path, data) {
  }
  });
 };
+
+/**
+ * Normalize the input/output file path according to a sub-directory if needed
+ * @param {String} file - path of the input/ouput file
+ * @param {String|null} subDirectory - an explicit path to a sub-directory if given
+ * @returns {Promise}
+ */
+exports.normalizeFilePath = function (file, subDirectory) {
+ return Bluebird.resolve()
+ .then(function () {
+ if (!subDirectory) {
+ return file;
+ }
+
+ file = Path.normalize(file);
+
+ if (Path.dirname(file) === '.') {
+ return Path.join(subDirectory, file);
+ }
+
+ return file;
+ });
+};

lib/git.js

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

lib/index.js

@@ -14,6 +14,7 @@ var Writer = require('./writer');
  * @param {Boolean} options.major - whether it should be a major changelog
  * @param {String} options.repoUrl - repo URL that will be used when linking commits
  * @param {Array} options.exclude - exclude listed commit types (e.g. ['chore', 'style', 'refactor'])
+ * @param {String} options.subDirectory - specify an explicit relatvie path to a sub-directory
  * @returns {Promise<String>} the \n separated changelog string
  */
 exports.generate = function (options) {

test/file.test.js

@@ -7,6 +7,7 @@ var Sinon = require('sinon');
 
 var File = require('../lib/file');
 
+var DEFAULT_FILE = './CHANGELOG.md';
 var NONEXISTENT = Path.resolve(__dirname, '../fake-file.txt');
 var README = Path.resolve(__dirname, '../README.md');
 var STDOUT_FD = 1;
@@ -79,4 +80,71 @@ describe('file', function () {
 
  });
 
+ describe('normalizePath', function () {
+
+ it('default output, no sub-directory given => CHANGELOG.md in current directory', function () {
+ return File.normalizeFilePath(DEFAULT_FILE)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(DEFAULT_FILE);
+ });
+ });
+
+ it('default name, with sub-directory given => CHANGELOG.md in sub directory', function () {
+ var subDirectory = 'subdirectory';
+
+ return File.normalizeFilePath(DEFAULT_FILE, subDirectory)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(Path.join(subDirectory, DEFAULT_FILE));
+ });
+ });
+
+ it('explicit name, no sub-directory given => explicit name in current directory', function () {
+ var someFile = 'SOMEFILE.md';
+
+ return File.normalizeFilePath(someFile)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(someFile);
+ });
+ });
+
+ it('explicit name, with sub-directory given => explicit name in sub directory', function () {
+ var subDirectory = 'subdirectory';
+ var someFile = 'SOMEFILE.md';
+
+ return File.normalizeFilePath(someFile, subDirectory)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(Path.join(subDirectory, someFile));
+ });
+ });
+
+ it('default name, with deep-sub-directory given => CHANGELOG.md in deep-sub directory', function () {
+ var subDirectory = Path.join('path', 'to', 'subdirectory');
+
+ return File.normalizeFilePath(DEFAULT_FILE, subDirectory)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(Path.join(subDirectory, DEFAULT_FILE));
+ });
+ });
+
+ it('explicit output path, without sub-directory given => explicit output path', function () {
+ var explicitPath = Path.join('path', 'to', DEFAULT_FILE);
+
+ return File.normalizeFilePath(explicitPath)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(explicitPath);
+ });
+ });
+
+ it('explicit output path, with sub-directory given => explicit output path', function () {
+ var explicitPath = Path.join('path', 'to', DEFAULT_FILE);
+ var subDirectory = Path.join('some', 'other', 'directory');
+
+ return File.normalizeFilePath(explicitPath, subDirectory)
+ .then(function (normalizedPath) {
+ Expect(normalizedPath).to.eql(explicitPath);
+ });
+ });
+
+ });
+
 });

test/git.test.js

@@ -108,6 +108,32 @@ 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();
+ });
+ });
+
+ it('git log command does not filter path when `-s` / `--sub-directory` option was not used', function () {
+ Sinon.stub(CP, 'execAsync')
+ .onFirstCall().returns(Bluebird.resolve('1.2.3.4'))
+ .onSecondCall().returns(Bluebird.resolve(VALID_COMMITS));
+
+ return Git.getCommits()
+ .then(function () {
+ CP.execAsync.secondCall.notCalledWithMatch(/-- /);
+ CP.execAsync.restore();
+ });
+ });
+
  });
 
 });