Merge pull request #305 from richardfrost/cleanup

Code Cleanup

Author: richardfrost

.gitattributes

@@ -9,4 +9,3 @@ text eol=lf
 /src/static/w3-color-flat.css linguist-vendored
 /store/* linguist-vendored
 /test/* linguist-documentation
-

.gitignore

@@ -14,4 +14,4 @@
 /test/coverage/*
 
 # Built shared libs
-/src/script/lib/*.js
+/src/script/lib/*.js

.travis.yml

@@ -9,4 +9,4 @@ before_script:
   - npm run package
 
 script:
-  - npm run test:all
+  - npm run test:all

_config.yml

@@ -1 +1 @@
-theme: jekyll-theme-minimal
+theme: jekyll-theme-minimal

src/script/lib/globals.d.ts

@@ -1,51 +1,51 @@
 interface AudioRule {
-  _displayElement?: HTMLElement;     // Element to display/hide
-  _dynamic?: boolean;               // [Dynamic] Set to true on a dynamic rule
-  apfCaptions?: boolean;            // [Cue] Display an HTML version of the caption/subtitle text: Requires videoCueHideCues = true
-  apfCaptionsSelector?: string;     // [Cue] Selector for container that will hold the custom HTML captions
-  checkInterval?: number;           // [Watcher] Set a custom watch interval (in ms, Default: 20)
-  className?: string;               // [Element] node.className.includes()
-  containsSelector?: string;        // [Element] node.querySelector() [Not commonly used]
-  convertBreaks?: boolean;          // [Element,ElementChild] Convert <br> to '\n'
-  dataPropPresent?: string;         // [Element] node.dataset.hasOwnProperty()
-  disabled?: boolean;               // [All] Set automatically based on iframe status or missing a required property
-  displayHide?: string;             // [Element,ElementChild,Watcher] Display style for hiding captions (Default: 'none')
-  displaySelector?: string;         // [Element,ElementChild,Watcher] Alternate selector to hide/show captions
-  displayShow?: string;             // [Element,ElementChild,Watcher] Display style for showing captions (Default: '')
-  displayVisibility?: boolean;      // [Watcher*] Use visibility to show/hide caption container
-  dynamicClasslist?: string;        // [Dynamic] Set when a dynamicTextKey is found
-  dynamicTargetMode?: string;       // [Dynamic] Target mode for dynamic rule
-  dynamicTextKey?: string;          // [Dynamic] Key used to identify a dynamic caption node
-  externalSub?: boolean;            // [Cue] [BETA]: Convert external captions/subtitles obtained from remote source to VTTCues
-  externalSubFormatKey?: string;    // [Cue] [BETA]: Key name for caption/subtitle format (Default: 'format')
-  externalSubTrackLabel?: string;   // [Cue] [BETA]: Label used for processed TextTrack
+  _displayElement?: HTMLElement;                 // Element to display/hide
+  _dynamic?: boolean;                            // [Dynamic] Set to true on a dynamic rule
+  apfCaptions?: boolean;                         // [Cue] Display an HTML version of the caption/subtitle text: Requires videoCueHideCues = true
+  apfCaptionsSelector?: string;                  // [Cue] Selector for container that will hold the custom HTML captions
+  checkInterval?: number;                        // [Watcher] Set a custom watch interval (in ms, Default: 20)
+  className?: string;                            // [Element] node.className.includes()
+  containsSelector?: string;                     // [Element] node.querySelector() [Not commonly used]
+  convertBreaks?: boolean;                       // [Element,ElementChild] Convert <br> to '\n'
+  dataPropPresent?: string;                      // [Element] node.dataset.hasOwnProperty()
+  disabled?: boolean;                            // [All] Set automatically based on iframe status or missing a required property
+  displayHide?: string;                          // [Element,ElementChild,Watcher] Display style for hiding captions (Default: 'none')
+  displaySelector?: string;                      // [Element,ElementChild,Watcher] Alternate selector to hide/show captions
+  displayShow?: string;                          // [Element,ElementChild,Watcher] Display style for showing captions (Default: '')
+  displayVisibility?: boolean;                   // [Watcher*] Use visibility to show/hide caption container
+  dynamicClasslist?: string;                     // [Dynamic] Set when a dynamicTextKey is found
+  dynamicTargetMode?: string;                    // [Dynamic] Target mode for dynamic rule
+  dynamicTextKey?: string;                       // [Dynamic] Key used to identify a dynamic caption node
+  externalSub?: boolean;                         // [Cue] [BETA]: Convert external captions/subtitles obtained from remote source to VTTCues
+  externalSubFormatKey?: string;                 // [Cue] [BETA]: Key name for caption/subtitle format (Default: 'format')
+  externalSubTrackLabel?: string;                // [Cue] [BETA]: Label used for processed TextTrack
   externalSubTrackMode?: TextTrackMode;          // [Cue] [BETA]: TextTrack mode for new TextTrack
-  externalSubURLKey?: string;       // [Cue] [BETA]: Key name for caption/subtitle URL (Default: 'url')
-  externalSubVar?: string;          // [Cue] [BETA]: Global variable to find available caption/subtitle data
-  filterSubtitles?: boolean;        // [All] Filter subtitle text (Default: true)
-  hasChildrenElements?: boolean;    // [Element] node.childElementCount > 0 [Not commonly used]
-  iframe?: boolean | undefined;     // [All] Pages to run on (true: only iframes, false: no iframes, undefined: all)
-  ignoreMutations?: boolean;        // [Element,ElementChild,Text,Watcher] Ignore mutations when filtering captions/subtitles
-  mode: string;                     // [All*] 'cue', 'dynamic', 'element', 'elementChild', 'text', 'watcher'
-  muteMethod?: number;              // [All] Override global muteMthod (0: tab, 1: video)
-  note?: string;                    // [All] Note about the rule
-  parentSelector?: string;          // [ElementChild?,Text,Watcher] parent.contains(node)
-  parentSelectorAll?: string;       // [ElementChild?] Check if any parents contain the node: parent.contains(node)
-  preserveWhiteSpace?: boolean;     // [Element,ElementChild] Set whiteSpace = 'pre' on subtitle elements
-  removeSubtitleSpacing?: boolean;  // [Element] Remove subtitle padding/margin when hiding
-  rootNode?: boolean;               // [Element,ElementChild] Use getRootNode() or assume document (Default: false)
-  showSubtitles?: number;           // [All] Override global showSubtitles (0: all, 1: filtered, 2: unfiltered, 3: none)
-  simpleUnmute?: boolean;           // [Element,ElementChild,Text+,Watcher+] Simplify requirements for unmuting
-  subtitleSelector?: string;        // [Element,ElementChild,Watcher] *Used for Filtering*: node.querySelector()
-  tagName?: string;                 // [Element*,ElementChild*] node.nodeName
-  unmuteDelay?: number;             // [Element,ElementChild,Watcher] Positive number (in ms) to delay unmuting
-  videoCueHideCues?: boolean;       // [Cue] Remove/hide cues instead of setting textTrack.mode = 'hidden'
-  videoCueKind?: string;            // [Cue] Kind of video TextTrack ('captions', 'subtitles', etc.)
-  videoCueLabel?: string;           // [Cue] Label for video TextTrack
-  videoCueLanguage?: string;        // [Cue] Language for video TextTrack
-  videoCueRequireShowing?: boolean; // [Cue] Override global setting for muteCueRequireShowing
-  videoCueSync?: number;            // [Cue] Adjust subtitle sync +/- (in seconds)
-  videoSelector?: string;           // [Cue,Watcher] Selector for video, also used for volume muteMethod (Default: 'video')
+  externalSubURLKey?: string;                    // [Cue] [BETA]: Key name for caption/subtitle URL (Default: 'url')
+  externalSubVar?: string;                       // [Cue] [BETA]: Global variable to find available caption/subtitle data
+  filterSubtitles?: boolean;                     // [All] Filter subtitle text (Default: true)
+  hasChildrenElements?: boolean;                 // [Element] node.childElementCount > 0 [Not commonly used]
+  iframe?: boolean | undefined;                  // [All] Pages to run on (true: only iframes, false: no iframes, undefined: all)
+  ignoreMutations?: boolean;                     // [Element,ElementChild,Text,Watcher] Ignore mutations when filtering captions/subtitles
+  mode: string;                                  // [All*] 'cue', 'dynamic', 'element', 'elementChild', 'text', 'watcher'
+  muteMethod?: number;                           // [All] Override global muteMthod (0: tab, 1: video)
+  note?: string;                                 // [All] Note about the rule
+  parentSelector?: string;                       // [ElementChild?,Text,Watcher] parent.contains(node)
+  parentSelectorAll?: string;                    // [ElementChild?] Check if any parents contain the node: parent.contains(node)
+  preserveWhiteSpace?: boolean;                  // [Element,ElementChild] Set whiteSpace = 'pre' on subtitle elements
+  removeSubtitleSpacing?: boolean;               // [Element] Remove subtitle padding/margin when hiding
+  rootNode?: boolean;                            // [Element,ElementChild] Use getRootNode() or assume document (Default: false)
+  showSubtitles?: number;                        // [All] Override global showSubtitles (0: all, 1: filtered, 2: unfiltered, 3: none)
+  simpleUnmute?: boolean;                        // [Element,ElementChild,Text+,Watcher+] Simplify requirements for unmuting
+  subtitleSelector?: string;                     // [Element,ElementChild,Watcher] *Used for Filtering*: node.querySelector()
+  tagName?: string;                              // [Element*,ElementChild*] node.nodeName
+  unmuteDelay?: number;                          // [Element,ElementChild,Watcher] Positive number (in ms) to delay unmuting
+  videoCueHideCues?: boolean;                    // [Cue] Remove/hide cues instead of setting textTrack.mode = 'hidden'
+  videoCueKind?: string;                         // [Cue] Kind of video TextTrack ('captions', 'subtitles', etc.)
+  videoCueLabel?: string;                        // [Cue] Label for video TextTrack
+  videoCueLanguage?: string;                     // [Cue] Language for video TextTrack
+  videoCueRequireShowing?: boolean;              // [Cue] Override global setting for muteCueRequireShowing
+  videoCueSync?: number;                         // [Cue] Adjust subtitle sync +/- (in seconds)
+  videoSelector?: string;                        // [Cue,Watcher] Selector for video, also used for volume muteMethod (Default: 'video')
 }
 
 interface BackgroundData {

tsconfig.json

@@ -9,4 +9,4 @@
   "include": [
     "./src/script/**/*.ts"
   ]
-}
+}