feat: add option to disable completely title formatting

Author: garyng

bin/summary.js

@@ -27,9 +27,10 @@ program
  .option("-u, --unchanged [list]", "unchanged catalog like `request.js`, default is `[]`.")
  .option("-o, --outputfile [string]", "output file, defaut is `./SUMMARY.md`")
  .option("-s, --sortedBy [string]", "sorted by sortedBy, for example: `num-`, defaut is sorted by characters")
+ .option("-d, --disableTitleFormatting", "don't convert filename/folder name to start case (for example: `JavaScript` to `Java Script`), default is `false`")
  .action(function(options) {
  // generate `SUMMARY.md`
- // Fixme 
+ // Fixme
  // if (options.length >= 1) {
  // console.log(color.red('\nError! The sub commands "%s" has been deprecated, please read the follow messages:'), cmd);
  // program.help();

lib/bookJson.js

@@ -19,7 +19,8 @@ function BookConfig(root) {
  book.unchanged = config.unchanged || [];
  book.bookname = config.bookname || 'Your Book Name';
  book.sortedBy = config.sortedBy || '';
- 
+ book.disableTitleFormatting = config.disableTitleFormatting || false;
+
  return book;
 }
 

lib/summary/index.js

@@ -20,7 +20,8 @@ var root,
  catalog,
  ignores,
  unchanged,
- sortedBy;
+ sortedBy,
+ disableTitleFormatting;
 
 // Get options
 function init(options) {
@@ -34,6 +35,7 @@ function init(options) {
  unchanged = options.unchanged || bookConfig.unchanged;
  bookname = options.bookname || bookConfig.bookname;
  sortedBy = options.sortedBy || bookConfig.sortedBy;
+ disableTitleFormatting = options.disableTitleFormatting || bookConfig.disableTitleFormatting;
 }
 
 // Get summary
@@ -166,9 +168,8 @@ function prettyCatalogName(fileName) {
  fileName = fileName.match(folderNameReg)[1];
  }
  }
-
  // Don`t format the files like `req.options.*` using dot, unchanged or Chinese string.
- if (_.size(fileName.split(".")) > 1 || _.includes(unchanged, fileName) || isChinese(fileName)) {
+ if (_.size(fileName.split(".")) > 1 || _.includes(unchanged, fileName) || isChinese(fileName) || disableTitleFormatting) {
  return fileName;
  }
  return _.startCase(fileName);