Update v3.9.0

Merge pull request #134 from joao-neves95/next

CHANGELOG.md

@@ -2,7 +2,35 @@
 
  
 
-#### *v3.8.5 - 21/10/2019
+#### *v3.9.0 - 19/11/2019
+
+  - Added support for optional custom source file configuration that overwrites the global merger configuration
+    (minfication for the moment).
+
+  - Fixed a bug on the imports parser, where the file extension had always to be `.js`.<br>
+    Now, it only defaults to `.js` in case there was no extension provided (like it is
+    stated on the docs: [README.md](https://github.com/joao-neves95/merger-js/blob/master/README.md#use)).<br>
+    With this fix, MergerJS can now merge any text files, for example HTML files.
+
+  - Fixed a bug on the `merger rm` command, where it was only possible to remove one file
+    and the program crashed if the user selected the "All" option on the source file selection.
+
+  - Fixed a bug on the `merger add` command, where if the user deleted its build file name input,
+    the name was set to ".js".
+
+  - Fixed a bug on the file path console output of the `merger build` command.<br/>
+    Example of the previous output: "path-to\js.system.collections\js.system.collections\distjs.system.collections.js"
+    Example of the fixed output: "path-to\js.system.collections\js.system.collections\dist\js.system.collections.js"
+
+  - Significant performance improvements.
+
+  - Big internal refactorings: Slowly migrating to the Node.js sync API and removed a lot of the "callback hell".
+
+  - Updated dependencies.
+
+&nbsp;
+
+#### v3.8.5 - 21/10/2019
 
   - Refactored the import parser and made multiple optimisations.
   - Updated dependencies.
@@ -13,7 +41,7 @@
 #### v3.8.4 - 07/10/2019
 
   - The output of `merger update` is now printed on the console.
-  
+
 &nbsp;
 
 #### v3.8.3 - 06/10/2019
@@ -55,7 +83,7 @@
 
 #### v3.7.1 - 04/05/2019
 
- - Fixed a bug when importing from directories. It was importing relative to the header file instead of the directory of the 
+ - Fixed a bug when importing from directories. It was importing relative to the header file instead of the directory of the
    header file, like it used to (bug from last update).
 
 &nbsp;
@@ -328,7 +356,7 @@
  It is advised to reinstall merger-js:<br/>
  1) "npm rm merger-js -g"<br/>
  2) "npm i merger-js -g"
- 
+
 &nbsp;
 
 #### v2.0.5/6/7 (Hotfixes) - 09/04/2018

README.md

@@ -23,6 +23,7 @@
  ├── [node-notifier](https://github.com/mikaelbr/node-notifier)<br/>
  ├── [chalk](https://github.com/chalk/chalk)<br/>
  ├── [line-by-line](https://github.com/Osterjour/line-by-line)<br/>
+ ├── [is-text-path](https://github.com/sindresorhus/is-text-path)<br/>
  ├── [js.system.collections](https://github.com/joao-neves95/js.system.collections)<br/>
 
 <br/>
@@ -199,32 +200,42 @@ npm install merger-js -g
 
 &nbsp;
 
-## Example of a File Structure
+## Custom Source File Configuration
+Since v3.9.0, it is possible to have custom source file configuration that overwrites the global
+configuration.</br>
+This is useful, for example, if you have multiple source files and want that only some file be
+minified or not.
+
+In the moment, there is no CLI command to edit custom source file configurations, so you will have
+to do it by hand. Just add a config object to your source file object.</br>
+In the moment there is only the minification (`uglify`) option.
+
+Example (`merger-config.json`):
+
+```json
+(...)
+"sourceFiles": [
+    {
+        "source": "path-to\\js.system.collections\\js.system.collections.header.js",
+        "output": {
+            "path": "path-to\\js.system.collections\\dist",
+            "name": "js.system.collections.js"
+        }
+    },
+    {
+        "source": "path-to\\js.system.collections\\js.system.collections.header.js",
+        "output": {
+            "path": "path-to\\js.system.collections\\dist",
+            "name": "js.system.collections.min.js"
+        },
+        "config": {
+            "uglify": true
+        }
+    }
+]
+(...)
 
-|-- root/</br>
-
->|-- **merger-config.json**</br>
->|-- package.json</br>
->|-- .env</br>
->|-- node_modules/</br>
->|-- (...)</br>
-
->|-- server/</br>
->>|-- (...)</br>
-
->|-- client/</br>
-
->>|-- css</br>
->>>|-- (...)</br>
-
->>|-- js</br>
->>>|-- mergerBuildFile.js</br>
->>>|-- src</br>
->>>>|-- sourceFile.header.js (the header file containing all the imports; the first file to be build)</br>
->>>>|-- utilities.js</br>
->>>>|-- someView.js</br>
->>>>|-- someModel.js</br>
->>>>|-- someController.js</br>
+```
 
 &nbsp;
 
@@ -244,10 +255,6 @@ Merger uses [SemVer](https://semver.org/) for versioning. You can read the chang
 
 See the style guide here: [merger-js/STYLE-GUIDE.md](https://github.com/joao-neves95/merger-js/blob/master/STYLE-GUIDE.md)
 
-Since version 3.6.5, every asynchronous function should make exclusive use of promises and the async/await syntax,
-avoiding multiple callback chaining (I.e.: "callback hell"), unless using a callback instead of a promise does make 
-sense and does not contribute to a more confusing code.
-
 &nbsp;
 
 ## Motivation

VERSION.md

@@ -1,3 +1,3 @@
 # Current Branch Version
 
-**v3.8.5**
+**v3.9.0**

enums/importType.js

@@ -6,7 +6,6 @@
  *
  */
 
-
 const ImportType = Object.freeze( {
   Unknown: -1,
   RelativePath: 1,

enums/promptResponseType.js

@@ -1,4 +1,4 @@
-/*
+/*
  * Copyright (c) 2018-2019 João Pedro Martins Neves - All Rights Reserved.
  *
  * MergerJS (merger-js) is licensed under the MIT license, located in

merger.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-
 /*
  * Copyright (c) 2018-2019 João Pedro Martins Neves - All Rights Reserved.
  *
@@ -13,61 +12,55 @@
 const path = require('path');
 const chokidar = require('chokidar');
 const mergerCLI = require('./modules/mergerCLI');
-const config = require('./modules/config');
+const Config = require('./modules/config');
 const async = require( './node_modules/neo-async' );
 const selectSourceFile = require('./modules/CLIModules/selectSourceFilePrompt');
 const parseImports = require( './modules/buildModules/parseImports' );
 const build = require( './modules/buildModules/build' );
-const sourceFileModel = require( './models/sourceFileModel' );
 
 // #region PROGRAM
 
-mergerCLI( ( newConfig ) => {
-  config( newConfig, () => {
-
-    selectSourceFile( ( sourceFile ) => {
-      /** @type { sourceFileModel[] } */
-      let files = [sourceFile];
+mergerCLI( async ( newConfig ) => {
+  await Config.init( newConfig );
+  let sourceFiles = await selectSourceFile();
 
-      // If "sourceFile" is Array it means that the user chose the "All" (files) option in selectSourceFile().
-      if (Array.isArray(sourceFile)) {
-        files = sourceFile;
-        // Execute a one time build only.
-        global.config.autoBuild = false;
-      }
+  // If "sourceFiles" is Array it means that the user chose the "All" (sourceFiles) option in selectSourceFile().
+  if ( Array.isArray( sourceFiles ) ) {
+    // Execute a one time build only.
+    global.config.autoBuild = false;
 
-      async.eachSeries( files, ( file, Callback ) => {
+  } else {
+    sourceFiles = [sourceFiles];
+  }
 
-        parseImports( file.source, async ( buildOrder ) => {
-          // Execute one time builds:
-          if ( !global.config.autoBuild ) {
-            await build( file, buildOrder );
-            return Callback();
-          }
+  async.eachSeries( sourceFiles, async ( sourceFile, Callback ) => {
+    await Config.setCustomConfig( sourceFile.source );
+    const buildOrder = await parseImports( sourceFile.source );
 
-          // Execute an auto builds (with file watcher):
-          else {
-            const whatcher = chokidar.watch( buildOrder, { persistent: true, cwd: path.dirname( file.source ) } );
+    // Execute one time builds:
+    if ( !global.config.autoBuild ) {
+      await build( sourceFile, buildOrder );
+      return Callback();
 
-            whatcher
-              .on( 'ready', async () => {
-                console.info( ' Inicial scan complete. Ready to build on changes...' );
-                await build( file, buildOrder );
-                return Callback();
-              })
-              .on('error', err => console.error('Auto build error: ', err))
-              .on( 'change', async ( path, stats ) => {
-                await build(file, null);
-            });
-          }
-        });
+      // Execute an auto build session (with file watcher):
+    } else {
+      const whatcher = chokidar.watch( buildOrder, { persistent: true, cwd: path.dirname( sourceFile.source ) } );
+      whatcher
+        .on( 'ready', async () => {
+          console.info( ' Inicial scan complete. Ready to build on changes...' );
+          await build( sourceFile, buildOrder );
+          return Callback();
+        } )
+        .on( 'error', err => console.error( 'Auto build error: ', err ) )
+        .on( 'change', async ( path, stats ) => {
+          await build( sourceFile, null );
+        } );
+    }
 
-      }, (err) => {
-          if (err) throw err;
-      });
+  }, ( err ) => {
+    if ( err ) throw err;
+  } );
 
-    });
-  });
 } );
 
 // #endregion

models/sourceFileConfigBase.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2018-2019 João Pedro Martins Neves - All Rights Reserved.
+ *
+ * MergerJS (merger-js) is licensed under the MIT license, located in
+ * the root of this project, under the name "LICENSE.md".
+ *
+ */
+
+'use string';
+
+class SourceFileConfigBase {
+
+  constructor( uglify ) {
+    this.uglify = uglify === undefined || uglify === null ? true : uglify;
+  }
+
+}
+
+module.exports = SourceFileConfigBase;

models/sourceFileModel.js

@@ -7,6 +7,7 @@
  */
 
 'use strict';
+const SourceFileConfigBase = require( './sourceFileConfigBase' );
 
 class SourceFileModel {
   constructor() {
@@ -16,6 +17,13 @@ class SourceFileModel {
       path: '',
       name: ''
     };
+
+    /** 
+     *  type { SourceFileConfigBase | null }
+     *  
+     *  @type { SourceFileConfigBase | null } 
+     */
+    this.config = null;
   }
 }
 

models/userConfigModel.js

@@ -8,22 +8,28 @@
 
 'use strict';
 const newTimestamp = require( '../modules/newTimestamp' ).completeLocale;
+const SourceFileConfigBase = require( './sourceFileConfigBase' );
+const SourceFileModel = require( './sourceFileModel' );
 
-class UserConfig {
+class UserConfig extends SourceFileConfigBase {
   constructor (uglify, autoBuild, notifications) {
+    super( uglify );
+
     this.mergerJsLinks = {
       npm: 'https://www.npmjs.com/package/merger-js',
       github: 'https://github.com/joao-neves95/merger-js',
       readme: 'https://github.com/joao-neves95/merger-js/blob/master/README.md',
       changelog: 'https://github.com/joao-neves95/merger-js/blob/master/CHANGELOG.md'
     };
 
-    this.uglify = uglify === undefined || uglify === null ? true : uglify;
     this.autoBuild = autoBuild === undefined || autoBuild === null ? false : autoBuild;
     this.notifications = notifications === undefined || notifications === null ? true : notifications;
+
     this.updateOnLaunch = true;
     this.lastUpdateCheck = newTimestamp();
     this.nodeModulesPath = "";
+
+    /** @type { SourceFileModel[] } */
     this.sourceFiles = [];
   }
 }