feat: add alternative annotation pattern GUS-W- (#168)

This commit adds an alternative annotation pattern, `GUS-W-`, to be used
to identify a work item.

The reason for this is that GitHub autolinks
(https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources#configuring-autolinks-to-reference-external-resources)
do not support patterns that begin with symbols (such as `@`). In order
to keep auto linking _and_ enable git2gus, we add support for this
additional pattern.

The pattern is case sensitive to help avoid issues with words ending
with "gus" e.g. `argus`, `bogus`, `asparagus`.

Author: mble-sfdc

api/services/Issues/__test__/getAnnotation.spec.js

@@ -13,7 +13,10 @@ describe('getAnnotation issues service', () => {
             '@W-12345678@',
             'some text @W-12345678@',
             'text@W-12345678@',
-            'some @W-12345678@ text'
+            'some @W-12345678@ text',
+            'GUS-W-12345678',
+            'some text GUS-W-12345678',
+            'some GUS-W-12345678 text'
         ];
         descriptions.forEach(description => {
             expect(getAnnotation(description)).toBe('W-12345678');
@@ -27,6 +30,8 @@ describe('getAnnotation issues service', () => {
             '@W12345678@',
             'some text W-12345678@',
             'text@W-12345678',
+            'GAS-W-12345678',
+            'textGUS-W-12345678',
             '',
             null,
             undefined,

api/services/Issues/__test__/isSameAnnotation.spec.js

@@ -8,16 +8,23 @@
 const isSameAnnotation = require('../isSameAnnotation');
 
 describe('isSameAnnotation issues service', () => {
+    const annotations = ['@W-12345@', 'GUS-W-12345'];
+
     it('should return true when is same annotation', () => {
         const descriptions = [
             '@W-12345@',
             'some text @W-12345@',
             'text@W-12345@',
             'some @W-12345@ text',
-            'some@W-12345@text'
+            'some@W-12345@text',
+            'GUS-W-12345',
+            'some text GUS-W-12345',
+            'some GUS-W-12345 text'
         ];
         descriptions.forEach(description => {
-            expect(isSameAnnotation(description, '@W-12345@')).toBe(true);
+            annotations.forEach(annotation => {
+                expect(isSameAnnotation(description, annotation)).toBe(true);
+            });
         });
     });
     it('should return false when is not the same annotation', () => {
@@ -30,6 +37,9 @@ describe('isSameAnnotation issues service', () => {
             '@W12345@',
             'some text W-12345@',
             'text@W-12345',
+            'GUS-W-12345678',
+            'some text GUS-W-12345678',
+            'some GUS-W-12345678 text',
             '',
             null,
             undefined,
@@ -38,7 +48,9 @@ describe('isSameAnnotation issues service', () => {
             12345
         ];
         descriptions.forEach(description => {
-            expect(isSameAnnotation(description, '@W-12345@')).toBe(false);
+            annotations.forEach(annotation => {
+                expect(isSameAnnotation(description, annotation)).toBe(false);
+            });
         });
     });
     it('should return false when both descriptions passed are null', () => {

api/services/Issues/getAnnotation.js

@@ -6,10 +6,28 @@
  */
 
 module.exports = function getAnnotation(description) {
+    const annotationMatchers = [
+        {
+            rex: /@w-\d+@/gi,
+            replace: /@/g
+        },
+        {
+            rex: /\bGUS-W-\d+\b/g,
+            replace: /GUS-/g
+        }
+    ];
+
     if (typeof description === 'string') {
-        const matches = description.match(/@w-\d+@/gi);
-        if (Array.isArray(matches) && matches.length > 0) {
-            return matches[0].replace(/@/g, '');
+        const matches = [];
+        annotationMatchers.forEach(matcher => {
+            let candidates = description.match(matcher.rex);
+            if (Array.isArray(candidates) && candidates.length > 0) {
+                matches.push(candidates[0].replace(matcher.replace, ''));
+            }
+        });
+
+        if (matches.length > 0) {
+            return matches[0];
         }
         return null;
     }