Merge pull request #153 from cksource/i/151

Feature: Added support for presets. Closes #151.

Fix: Fixed message displayed by the `status` command when using a specific commit defined in the config file.

README.md

@@ -114,6 +114,8 @@ CLI options:
 
 --scope                     Restricts the command to packages which names match the given glob pattern.
                             Default: null
+
+--preset                    Uses an alternative set of dependencies defined in the config file.
 ```
 
 All these options can also be specified in `mrgit.json` (options passed through CLI takes precedence):
@@ -137,34 +139,54 @@ The dependency keys can be any strings, but it's recommended to use package name
 
 Examples:
 
-```js
+```json
 // Clone 'git@github.com:cksource/foo.git' and check out to 'master'.
 {
     "foo": "git@github.com:cksource/foo.git"
 }
 ```
 
-```js
+```json
 // Short format. Clone 'git@github.com:cksource/foo.git' and check out to branch 'dev'.
 {
     "@cksource/foo": "cksource/foo#dev"
 }
 ```
 
-```js
+```json
 // Clone 'https://github.com/cksource/foo.git' (via HTTPS) and check out to tag 'v1.2.3'.
 {
     "foo": "https://github.com/cksource/foo.git@v1.2.3"
 }
 ```
 
-```js
+```json
 // Clone 'cksource/foo' and check out to the latest available tag.
 {
     "foo": "cksource/foo@latest"
 }
 ```
 
+### The `presets` option
+
+This option allows the user to switch between different states of dependencies easily. When using any command with the `--preset` option, it will behave as if the `dependencies` option was using values from the given preset. Dependencies not specified in the preset but in the `dependencies` object will use a version from the latter as a fallback.
+
+Example:
+
+```json
+{
+    "presets": {
+        "dev": {
+            "@cksource/foo": "cksource/foo#dev"
+        },
+        "example-feature": {
+            "@cksource/foo": "cksource/foo#i/1-example-feature",
+            "@cksource/bar": "cksource/foo#i/1-example-feature"
+        }
+    }
+}
+```
+
 ### Recursive cloning
 
 When the `--recursive` option is used `mrgit` will clone repositories recursively. First, it will clone the `dependencies` specified in `mrgit.json` and, then, their `dependencies` and `devDependencies` specified in `package.json` files located in cloned repositories.

index.js

@@ -114,6 +114,8 @@ function handleCli() {
         ${ y( '--scope' ) }                     Restricts the command to packages which names match the given glob pattern.
                                     ${ g( 'Default: null' ) }
 
+        ${ y( '--preset' ) }                    Uses an alternative set of dependencies defined in the config file.
+
     ${ u( 'Git Options:' ) }
         Git options are supported by the following commands: commit, diff, fetch, push.
         Type "mrgit [command] -h" in order to see which options are supported.

lib/commands/save.js

@@ -99,8 +99,9 @@ module.exports = {
 	 *
 	 * @param {Set} processedPackages Collection of processed packages.
 	 * @param {Set} commandResponses Results of executed command for each package.
+	 * @param {Options} toolOptions Options resolved by mrgit.
 	 */
-	afterExecute( processedPackages, commandResponses ) {
+	afterExecute( processedPackages, commandResponses, toolOptions ) {
 		const cwd = require( '../utils/getcwd' )();
 		const mrgitJsonPath = path.join( cwd, 'mrgit.json' );
 
@@ -112,15 +113,42 @@ module.exports = {
 					.replace( tagPattern, '' )
 					.split( '#' )[ 0 ];
 
+				const objectToUpdate = getObjectToUpdate( json, toolOptions, response.packageName );
+
 				// If returned branch is equal to 'master', save only the repository path.
 				if ( response.branch && response.data === 'master' ) {
-					json.dependencies[ response.packageName ] = repository;
+					objectToUpdate[ response.packageName ] = repository;
 				} else {
-					json.dependencies[ response.packageName ] = `${ repository }#${ response.data }`;
+					objectToUpdate[ response.packageName ] = `${ repository }#${ response.data }`;
 				}
 			}
 
 			return json;
 		} );
+
+		/**
+		 * If preset is being used it should update the value defined in the preset,
+		 * rather than the one in the base "dependencies" object.
+		 *
+		 * @param {Object} json
+		 * @param {Options} toolOptions
+		 * @param {String} packageName
+		 * @returns
+		 */
+		function getObjectToUpdate( json, toolOptions ) {
+			if ( !toolOptions.preset ) {
+				return json.dependencies;
+			}
+
+			if ( !json.presets ) {
+				return json.dependencies;
+			}
+
+			if ( !json.presets[ toolOptions.preset ] ) {
+				return json.dependencies;
+			}
+
+			return json.presets[ toolOptions.preset ];
+		}
 	}
 };

lib/commands/status.js

@@ -146,11 +146,15 @@ module.exports = {
 				shouldDisplaySyncHint = true;
 			}
 
-			if ( !shouldUseTag && status.branch !== mrgitBranch ) {
+			if ( !shouldUseTag && status.branch !== mrgitBranch && commit !== mrgitBranch ) {
 				branchOrTag = `${ chalk.cyan( '!' ) } ${ branchOrTag }`;
 				shouldDisplaySyncHint = true;
 			}
 
+			if ( !shouldUseTag && mrgitBranch === commit ) {
+				branchOrTag = 'Using saved commit →';
+			}
+
 			if ( status.ahead ) {
 				branchOrTag += chalk.yellow( ` ↑${ status.ahead }` );
 			}
@@ -199,8 +203,9 @@ module.exports = {
 				hints.push( [
 					chalk.green( 'L' ),
 					'This is the latest local tag. To ensure having latest remote tag, execute',
-					chalk.blue( 'mrgit sync' )
-				].join( ' ' ) + '.' );
+					chalk.blue( 'mrgit fetch' ),
+					'before checking status.'
+				].join( ' ' ) );
 			}
 
 			if ( shouldDisplaySyncHint ) {

lib/utils/getoptions.js

@@ -14,7 +14,7 @@ const shell = require( 'shelljs' );
  * @param {String} cwd An absolute path to the directory where `mrgit.json` is available.
  * @returns {Options} The options object.
  */
-module.exports = function cwdResolver( callOptions, cwd ) {
+module.exports = function getOptions( callOptions, cwd ) {
 	const mrgitJsonPath = path.resolve( cwd, 'mrgit.json' );
 
 	// Default options.
@@ -52,6 +52,16 @@ module.exports = function cwdResolver( callOptions, cwd ) {
 		options.cwdPackageBranch = response.stdout.trim();
 	}
 
+	if ( !options.preset ) {
+		return options;
+	}
+
+	if ( !options.presets || !options.presets[ options.preset ] ) {
+		throw new Error( `Preset "${ options.preset }" is not defined in "mrgit.json" file.` );
+	}
+
+	options.dependencies = Object.assign( options.dependencies, options.presets[ options.preset ] );
+
 	return options;
 };