ABBREVIATIONS-FLAG Added Settings Flag For Abbreviations (#77)

README.md

@@ -6,9 +6,10 @@ Firefox/Microsoft Edge Chromium add-on to automatically capitalise words while t
 
 - Capitalise the first letter of a sentence.
 - Capitalise `I`.
-- Capitalise constants such as [days](src/constants.js#L3), [months](src/constants.js#L13)
-- Capitalise common [abbreviations](src/constants.js#L78)
+- Capitalise constants such as [days](src/constants.js#L4), [months](src/constants.js#L14)
+- Capitalise common [abbreviations](src/abbreviation-constants.js#L1)
 - Capitalise common [names](src/name-constants.js#L1)
+- Add apostrophe to common [English words](src/constants.js#L81)
 
 ## Configuration
 

distribution/popup/settings.html

@@ -18,8 +18,12 @@
                 <input type="checkbox" id="shouldCapitaliseI" name="shouldCapitaliseI" checked>
                 <label for="shouldCapitaliseI">Should capitalise 'I'?</label><br>
 
+                <input type="checkbox" id="shouldCapitaliseAbbreviations" name="shouldCapitaliseAbbreviations" checked>
+                <label for="shouldCapitaliseAbbreviations">Should capitalise abbreviations?</label><br>
+
                 <input type="checkbox" id="shouldCapitaliseNames" name="shouldCapitaliseNames" checked>
                 <label for="shouldCapitaliseNames">Should capitalise names?</label><br>
+
             </div>
         </div>
     </body>

package.json

@@ -33,6 +33,7 @@
     "eslint": "^7.11.0",
     "eslint-webpack-plugin": "^2.1.0",
     "express": "^4.17.1",
+    "express-rate-limit": "^5.2.3",
     "husky": "^4.3.0",
     "jest": "^26.5.3",
     "jquery": "^3.5.1",
@@ -75,7 +76,7 @@
     "run": {
       "keepProfileChanges": true,
       "startUrl": [
-        "github.com"
+        "http://localhost:3000"
       ]
     }
   }

src/abbreviation-constants.js

@@ -0,0 +1,81 @@
+const common_abbreviations = [
+  'AFR',
+  'AMD',
+  'AOL',
+  'APM',
+  'ATM',
+  'AWS',
+  'BBB',
+  'BMW',
+  'BP',
+  'BRB',
+  'BSD',
+  'BTW',
+  'CRE',
+  'CVS',
+  'DIY',
+  'FAQ',
+  'FDR',
+  'FNMA',
+  'FSF',
+  'FTW',
+  'FYI',
+  'GE',
+  'GNU',
+  'GTE',
+  'GTG',
+  'HBO',
+  'HSBC',
+  'HTML',
+  'IBM',
+  'ICYMI',
+  'IDK',
+  'IKEA',
+  'IMO',
+  'IOW',
+  'ISO',
+  'ITT',
+  'JFK',
+  'KFC',
+  'LGTM',
+  'LOL',
+  'MCI',
+  'MGM',
+  'MIT',
+  'MMW',
+  'MSDN',
+  'NASCAR',
+  'NORAD',
+  'NP',
+  'NSA',
+  'NVIDIA',
+  'NW',
+  'OMG',
+  'OTOH',
+  'POV',
+  'RCA',
+  'RDS',
+  'ROTFL',
+  'RSVP',
+  'SARS',
+  'SMH',
+  'TBA',
+  'TBC',
+  'TBH',
+  'TC',
+  'TGIF',
+  'THX',
+  'TIA',
+  'TTYL',
+  'TWA',
+  'UBS',
+  'UCLA',
+  'UPS',
+  'USB',
+  'WFH',
+  'WSL',
+  'WTF',
+  'WTH',
+];
+
+export const abbreviations = common_abbreviations;

src/background.js

@@ -1,7 +1,8 @@
-import { constants_key_val, names_key_val } from './constants';
+import { constants_key_val, names_key_val, abbreviations_key_val } from './constants';
 import browser from 'webextension-polyfill';
 
 browser.storage.local.set({
   constants_key_val: constants_key_val,
   names_key_val: names_key_val,
+  abbreviations_key_val: abbreviations_key_val,
 });

src/constants.js

@@ -1,4 +1,5 @@
 import { names } from './name-constants'
+import { abbreviations } from './abbreviation-constants'
 
 const days = [
   'Monday',
@@ -77,85 +78,6 @@ const common_tech_words = [
   'iTunes',
 ]
 
-const abbreviations = [
-  'AFR',
-  'AMD',
-  'AOL',
-  'APM',
-  'ATM',
-  'AWS',
-  'BBB',
-  'BMW',
-  'BP',
-  'BRB',
-  'BSD',
-  'BTW',
-  'CRE',
-  'CVS',
-  'DIY',
-  'FAQ',
-  'FDR',
-  'FNMA',
-  'FSF',
-  'FTW',
-  'FYI',
-  'GE',
-  'GNU',
-  'GTE',
-  'GTG',
-  'HBO',
-  'HSBC',
-  'IBM',
-  'ICYMI',
-  'IDK',
-  'IKEA',
-  'IMO',
-  'IOW',
-  'ISO',
-  'ITT',
-  'JFK',
-  'KFC',
-  'LGTM',
-  'LOL',
-  'MCI',
-  'MGM',
-  'MIT',
-  'MMW',
-  'MSDN',
-  'NASCAR',
-  'NORAD',
-  'NP',
-  'NSA',
-  'NVIDIA',
-  'NW',
-  'OMG',
-  'OTOH',
-  'POV',
-  'RCA',
-  'RDS',
-  'ROTFL',
-  'RSVP',
-  'SARS',
-  'SMH',
-  'TBA',
-  'TBC',
-  'TBH',
-  'TC',
-  'TGIF',
-  'THX',
-  'TIA',
-  'TTYL',
-  'TWA',
-  'UBS',
-  'UCLA',
-  'UPS',
-  'USB',
-  'WFH',
-  'WSL',
-  'WTF',
-  'WTH',
-]
-
 let words_with_apostrophe = {
   arent: "aren't",
   doesnt: "doesn't",
@@ -173,17 +95,17 @@ let words_with_apostrophe = {
   wouldnt: "wouldn't",
 }
 
-let constants = days.concat(months, abbreviations, common_tech_words)
+let constants = days.concat(months, common_tech_words)
 
-let constants_map = constants.reduce((obj, val) => {
+let string_to_key_val = (obj, val) => {
   obj[val.toLowerCase()] = val
   return obj
-}, {})
+}
+
+let constants_map = constants.reduce(string_to_key_val, {})
 
 //convert array to key-value pairs
 export let constants_key_val = { ...constants_map, ...words_with_apostrophe }
 
-export let names_key_val = names.reduce((obj, val) => {
-  obj[val.toLowerCase()] = val
-  return obj
-}, {})
+export let names_key_val = names.reduce(string_to_key_val, {})
+export let abbreviations_key_val = abbreviations.reduce(string_to_key_val, {})

src/content.js

@@ -5,8 +5,10 @@ import {
   sites_to_ignore,
   should_capitalise_i,
   should_capitalise_names,
+  should_capitalise_abbreviations,
   constants_key_val,
   names_key_val,
+  abbreviations_key_val,
 } from './plugin-constants';
 
 const errorMsg = 'breaking loop';
@@ -17,16 +19,18 @@ browser.storage.local
     sites_to_ignore,
     should_capitalise_i,
     should_capitalise_names,
+    should_capitalise_abbreviations,
     constants_key_val,
     names_key_val,
+    abbreviations_key_val,
   ])
   .then(processResponse, utils.onError);
 
 /* Updating the value of this local storage variable in settings.js happens AFTER content.js.
  * The browser doesn't register the change and doesn't capitalise I by dfeault after installing the extension.
  * This block will capture the event and update the value of 'should_capitalise_i'.
  */
-browser.storage.onChanged.addListener(function(
+browser.storage.onChanged.addListener(function (
   changes, // object
   areaName // string
 ) {
@@ -46,6 +50,14 @@ browser.storage.onChanged.addListener(function(
         utils.setShouldCapitaliseNames(newValue);
       }
     }
+
+    if (changes.should_capitalise_abbreviations != null) {
+      const newValue = changes.should_capitalise_abbreviations.newValue;
+
+      if (newValue != null) {
+        utils.setShouldCapitaliseAbbreviations(newValue);
+      }
+    }
   }
 });
 
@@ -57,23 +69,23 @@ function hookupEventHandlers() {
 }
 
 function observeIframeInputTags() {
-  $('iframe').on('load', event => {
+  $('iframe').on('load', (event) => {
     let iframe = event.target;
     $(iframe)
       .contents()
       .find(':text,textarea')
       .each((_, item) => {
         //console.log(item);
 
-        $(item).on(`input.${pluginNamespace}`, function(event) {
+        $(item).on(`input.${pluginNamespace}`, function (event) {
           capitaliseText(event.target);
         });
       });
   });
 }
 
 function observeInputTags() {
-  $(':text,textarea').on(`input.${pluginNamespace}`, function(event) {
+  $(':text,textarea').on(`input.${pluginNamespace}`, function (event) {
     capitaliseText(event.target);
   });
 }
@@ -82,8 +94,10 @@ function processResponse(item) {
   sitesToExclude = item.sites_to_ignore;
   utils.setShouldCapitaliseI(item.should_capitalise_i);
   utils.setShouldCapitaliseNames(item.should_capitalise_names);
+  utils.setShouldCapitaliseAbbreviations(item.should_capitalise_abbreviations);
   utils.setConstantsKeyVal(item.constants_key_val);
   utils.setNamesKeyVal(item.names_key_val);
+  utils.setAbbreviationsKeyVal(item.abbreviations_key_val);
 
   if (item && sitesToExclude) {
     //https://stackoverflow.com/questions/406192/get-current-url-with-jquery
@@ -92,7 +106,7 @@ function processResponse(item) {
     try {
       var shouldEnableCapitalisingOnCurrentSite = true;
 
-      $.each(sitesToExclude, function(_i, siteToExclude) {
+      $.each(sitesToExclude, function (_i, siteToExclude) {
         if (currentUrlDomain.includes(siteToExclude)) {
           shouldEnableCapitalisingOnCurrentSite = false;
         }
@@ -120,8 +134,8 @@ function observeHtmlBody() {
   var tags = ['p', 'span'];
   var inputTags = ['input[type=\'text\']', 'textarea'];
 
-  var observer = new MutationObserver(function(mutations) {
-    $.each(mutations, function(_i, mutation) {
+  var observer = new MutationObserver(function (mutations) {
+    $.each(mutations, function (_i, mutation) {
       try {
         if (mutation.type === 'childList') {
           // add support for div block in gmail and outlook
@@ -132,30 +146,30 @@ function observeHtmlBody() {
 
           var addedNodes = mutation.addedNodes;
           if (addedNodes && addedNodes.length > 0) {
-            addedNodes.forEach(node => {
+            addedNodes.forEach((node) => {
               if (utils.isFirstTextOfEditableTextNode(node)) {
                 capitaliseText(node.parentNode);
-                addedNodes = addedNodes.filter(addedNode => {
+                addedNodes = addedNodes.filter((addedNode) => {
                   addedNode != node;
                 });
               }
             });
 
-            $.each(tags, function(_i, tagName) {
+            $.each(tags, function (_i, tagName) {
               var filteredEls = utils.getFilteredElements(addedNodes, tagName);
 
-              filteredEls.each(function(_index, element) {
+              filteredEls.each(function (_index, element) {
                 if (utils.shouldCapitaliseContent(element)) {
                   capitaliseText(element);
                 }
               });
             });
 
-            $.each(inputTags, function(_i, tagName) {
+            $.each(inputTags, function (_i, tagName) {
               var filteredEls = utils.getFilteredElements(addedNodes, tagName);
 
-              filteredEls.each(function(_index, element) {
-                $(element).on(`input.${pluginNamespace}`, function(event) {
+              filteredEls.each(function (_index, element) {
+                $(element).on(`input.${pluginNamespace}`, function (event) {
                   capitaliseText(event.target);
                 });
               });