Option requiring all messages begin with a given prefix (Fixes #61)

Gruntfile.js

@@ -72,6 +72,24 @@ module.exports = function ( grunt ) {
 				options: {
 					requireLowerCase: false
 				}
+			},
+			testRequiringSingleKeyPrefix: {
+				src: 'test/requireKeyPrefix/single',
+				options: {
+					requireKeyPrefix: [ 'alice' ]
+				}
+			},
+			testRequiringSingleKeyPrefixShucked: {
+				src: 'test/requireKeyPrefix/single',
+				options: {
+					requireKeyPrefix: 'alice'
+				}
+			},
+			testRequiringMultipleKeyPrefices: {
+				src: 'test/requireKeyPrefix/multiple',
+				options: {
+					requireKeyPrefix: [ 'alice', 'bob', 'timmy' ]
+				}
 			}
 		},
 		watch: {

README.md

@@ -72,6 +72,13 @@ Default value: `true`
 Whether to fail if any message key is not lower case. If set to `"initial"`, fail only if the first
 character is not lower case.
 
+#### requireKeyPrefix
+Type: `string` or `string[]`
+Default value: `[]`
+
+Whether to fail if any message key is not prefixed by the given prefix, or if multiple, one of the
+given prefices.
+
 #### disallowUnusedDocumentation
 Type: `boolean`
 Default value: `true`

tasks/banana.js

@@ -22,6 +22,7 @@ module.exports = function ( grunt ) {
 				disallowUnusedTranslations: false,
 
 				requireLowerCase: true,
+				requireKeyPrefix: [],
 
 				requireCompleteTranslationLanguages: [],
 				requireCompleteTranslationMessages: [],
@@ -50,6 +51,7 @@ module.exports = function ( grunt ) {
 				documentationMessageBlanks = [],
 				sourceMessageMissing = [],
 				sourceMessageWrongCase = [],
+				sourceMessageWrongPrefix = [],
 				count = 0;
 
 			function messages( filename, type ) {
@@ -156,6 +158,20 @@ module.exports = function ( grunt ) {
 				} );
 			}
 
+			if ( options.requireKeyPrefix.length ) {
+				if ( typeof options.requireKeyPrefix === 'string' ) {
+					options.requireKeyPrefix = [ options.requireKeyPrefix ];
+				}
+				sourceMessageWrongPrefix = sourceMessageKeys.filter( function ( key ) {
+					return options.requireKeyPrefix
+						.map( function ( prefix ) {
+							return !key.startsWith( prefix );
+						} ).reduce( function ( failed, accumulator ) {
+							return accumulator && failed;
+						} );
+				} );
+			}
+
 			while ( sourceMessageKeys.length > 0 ) {
 				message = sourceMessageKeys[ 0 ];
 
@@ -231,6 +247,29 @@ module.exports = function ( grunt ) {
 				}
 			}
 
+			count = sourceMessageWrongPrefix.length;
+			if ( count > 0 ) {
+				ok = false;
+
+				if ( options.requireKeyPrefix.length === 1 ) {
+					grunt.log.error(
+						count + ' message' + ( count > 1 ? 's do' : ' does' ) + ' not start with the required prefix "' + options.requireKeyPrefix[ 0 ] + '".'
+					);
+
+					sourceMessageWrongPrefix.forEach( function ( message ) {
+						grunt.log.error( 'Message "' + message + '" should start with the required prefix "' + options.requireKeyPrefix[ 0 ] + '".' );
+					} );
+				} else {
+					grunt.log.error(
+						count + ' message' + ( count > 1 ? 's do' : ' does' ) + ' not start with any of the required prefices.'
+					);
+
+					sourceMessageWrongPrefix.forEach( function ( message ) {
+						grunt.log.error( 'Message "' + message + '" should start with one of the required prefices.' );
+					} );
+				}
+			}
+
 			if ( options.disallowUnusedDocumentation ) {
 				count = documentationMessageKeys.length;
 				if ( count > 0 ) {

test/requireKeyPrefix/multiple/en.json

@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"metadata-key": "metadata value"
+	},
+	"alice-first-message-key": "first message value",
+	"alice-second-message-key": "second message value",
+	"bob-third-message-key": "third message value",
+	"timmyfourth-message-key": "fourth message value"
+}

test/requireKeyPrefix/multiple/qqq.json

@@ -0,0 +1,10 @@
+{
+	"@metadata": {
+		"first-metadata-key": "metadata value",
+		"second-metadata-key": "metadata value"
+	},
+	"alice-first-message-key": "first message definition",
+	"alice-second-message-key": "second message definition",
+	"bob-third-message-key": "third message definition",
+	"timmyfourth-message-key": "fourth message definition"
+}

test/requireKeyPrefix/single/en.json

@@ -0,0 +1,9 @@
+{
+	"@metadata": {
+		"metadata-key": "metadata value"
+	},
+	"alice-first-message-key": "first message value",
+	"alice-second-message-key": "second message value",
+	"alice-third-message-key": "third message value",
+	"alice-fourth-message-key": "fourth message value"
+}

test/requireKeyPrefix/single/qqq.json

@@ -0,0 +1,10 @@
+{
+	"@metadata": {
+		"first-metadata-key": "metadata value",
+		"second-metadata-key": "metadata value"
+	},
+	"alice-first-message-key": "first message definition",
+	"alice-second-message-key": "second message definition",
+	"alice-third-message-key": "third message definition",
+	"alice-fourth-message-key": "fourth message definition"
+}