Added name constants which are common in English vernacular (#70)

README.md

@@ -6,8 +6,9 @@ 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#L1), [months](src/constants.js#L11)
-- Capitalise common [abbreviations](src/constants.js#L24)
+- Capitalise constants such as [days](src/constants.js#L3), [months](src/constants.js#L13)
+- Capitalise common [abbreviations](src/constants.js#L78)
+- Capitalise common [names](src/name-constants.js#L1)
 
 ## Configuration
 

distribution/manifest.json

@@ -10,7 +10,7 @@
     "default_popup": "popup/settings.html"
   },
   "background": {
-    "scripts": ["dependencies/jquery.min.js"]
+    "scripts": ["dependencies/jquery.min.js", "lib/background.bundle.js"]
   },
   "content_scripts": [
     {

distribution/popup/settings.html

@@ -17,6 +17,9 @@
             <div class="form-group" style="margin-top:5%">
                 <input type="checkbox" id="shouldCapitaliseI" name="shouldCapitaliseI" checked>
                 <label for="shouldCapitaliseI">Should capitalise 'I'?</label><br>
+
+                <input type="checkbox" id="shouldCapitaliseNames" name="shouldCapitaliseNames" checked>
+                <label for="shouldCapitaliseNames">Should capitalise names?</label><br>
             </div>
         </div>
     </body>

package.json

@@ -11,7 +11,7 @@
     "build": "yarn webpack",
     "watch": "yarn webpack --watch",
     "test": "yarn jest",
-    "test-watch": "yarn jest --watch test/",
+    "test:watch": "yarn jest --watch test/",
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",
     "update-version": "yarn dot-json distribution/manifest.json version $VER",

src/background.js

@@ -0,0 +1,7 @@
+import { constants_key_val, names_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,
+});

src/constants.js

@@ -1,3 +1,5 @@
+import { names } from './name-constants';
+
 const days = [
   'Monday',
   'Tuesday',
@@ -21,37 +23,146 @@ const months = [
   'December',
 ];
 
-const abbreviations = [
-  'AFAIK',
-  'AKA',
+const common_tech_words = [
   'API',
+  'APIs',
+  'CSS',
+  'CosmosDB',
+  'DevOps',
+  'DynamoDB',
+  'ECMAScript',
+  'GitHub',
+  'Google',
+  'HBase',
+  'Instagram',
+  'JavaScript',
+  'MVC',
+  'MariaDB',
+  'Microsoft',
+  'MongoDB',
+  'Motorola',
+  'Mozilla',
+  'MySQL',
+  'MySpace',
+  'Ocaml',
+  'OpenOffice',
+  'PHP',
+  'PR',
+  'PRs',
+  'PayPal',
+  'Perl',
+  'PostgreSQL',
+  'PowerPC',
+  'PowerPoint',
+  'PyTorch',
+  'Qualcomm',
+  'Redis',
+  'Redshift',
+  'S3',
+  'SQLite',
+  'SUSE',
+  'SVN',
+  'Scala',
+  'Sega',
+  'UI',
+  'Ubuntu',
+  'VoIP',
+  'eBay',
+  'iOS',
+  'iPad',
+  'iPhone',
+  'iPod',
+  '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',
+  'ING',
   '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',
+  'TC',
   'TGIF',
   'THX',
   'TIA',
   'TTYL',
+  'TWA',
+  'UBS',
+  'UCLA',
+  'UPS',
   'USB',
+  'WFH',
+  'WSL',
   'WTF',
   'WTH',
 ];
 
-export let constants = days.concat(months, abbreviations);
+let constants = days.concat(months, abbreviations, common_tech_words);
+
+//convert array to key-value pairs
+export let constants_key_val = constants.reduce((obj, val) => {
+  obj[val.toLowerCase()] = val;
+  return obj;
+}, {});
+
+export let names_key_val = names.reduce((obj, val) => {
+  obj[val.toLowerCase()] = val;
+  return obj;
+}, {});

src/content.js

@@ -4,20 +4,29 @@ import {
   pluginNamespace,
   sites_to_ignore,
   should_capitalise_i,
+  should_capitalise_names,
+  constants_key_val,
+  names_key_val,
 } from './plugin-constants';
 
 const errorMsg = 'breaking loop';
 let sitesToExclude = [];
 
 browser.storage.local
-  .get([sites_to_ignore, should_capitalise_i])
+  .get([
+    sites_to_ignore,
+    should_capitalise_i,
+    should_capitalise_names,
+    constants_key_val,
+    names_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
 ) {
@@ -29,6 +38,14 @@ browser.storage.onChanged.addListener(function(
         utils.setShouldCapitaliseI(newValue);
       }
     }
+
+    if (changes.should_capitalise_names != null) {
+      const newValue = changes.should_capitalise_names.newValue;
+
+      if (newValue != null) {
+        utils.setShouldCapitaliseNames(newValue);
+      }
+    }
   }
 });
 
@@ -38,14 +55,17 @@ function hookupEventHandlers() {
 }
 
 function observeInputTags() {
-  $(':text,textarea').on(`input.${pluginNamespace}`, function(event) {
+  $(':text,textarea').on(`input.${pluginNamespace}`, function (event) {
     capitaliseText(event.target);
   });
 }
 
 function processResponse(item) {
   sitesToExclude = item.sites_to_ignore;
   utils.setShouldCapitaliseI(item.should_capitalise_i);
+  utils.setShouldCapitaliseNames(item.should_capitalise_names);
+  utils.setConstantsKeyVal(item.constants_key_val);
+  utils.setNamesKeyVal(item.names_key_val);
 
   if (item && sitesToExclude) {
     //https://stackoverflow.com/questions/406192/get-current-url-with-jquery
@@ -54,7 +74,7 @@ function processResponse(item) {
     try {
       var shouldEnableCapitalisingOnCurrentSite = true;
 
-      $.each(sitesToExclude, function(_i, siteToExclude) {
+      $.each(sitesToExclude, function (_i, siteToExclude) {
         if (currentUrlDomain.includes(siteToExclude)) {
           shouldEnableCapitalisingOnCurrentSite = false;
         }
@@ -83,8 +103,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
@@ -96,30 +116,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);
                 });
               });