Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Mottie committed Oct 7, 2017
0 parents commit f7109bc
Show file tree
Hide file tree
Showing 30 changed files with 1,880 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
root = true

[*]
indent_style = tab
indent_size = 2
trim_trailing_whitespace = true
end_of_line = lf
charset = utf-8
insert_final_newline = true
max_line_length = 80
179 changes: 179 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
# https://github.com/eslint/eslint/blob/master/docs/rules/README.md

globals:
chrome: true

env:
es6: true
browser: true

rules:
accessor-pairs: [2]
array-bracket-spacing: [2, never]
array-callback-return: [0]
arrow-body-style: [2, as-needed]
arrow-parens: [2, as-needed]
arrow-spacing: [2, {before: true, after: true}]
block-scoped-var: [2]
brace-style: [2, 1tbs, {allowSingleLine: true}]
camelcase: [2, {properties: never}]
comma-dangle: [0]
comma-spacing: [2, {before: false, after: true}]
comma-style: [2, last]
complexity: [0]
computed-property-spacing: [2, never]
consistent-return: [0]
constructor-super: [2]
curly: [0]
default-case: [0]
dot-location: [2, property]
dot-notation: [0]
eol-last: [2]
eqeqeq: [2]
generator-star-spacing: [2, before]
global-require: [0]
guard-for-in: [2]
handle-callback-err: [2, ^(err|error)$]
id-blacklist: [0]
indent: [0, 2]
jsx-quotes: [0]
key-spacing: [0]
keyword-spacing: [2]
linebreak-style: [2, unix]
lines-around-comment: [0]
max-nested-callbacks: [0]
new-cap: [0]
new-parens: [2]
newline-per-chained-call: [0]
no-alert: [0]
no-array-constructor: [0]
no-bitwise: [0]
no-caller: [2]
no-case-declarations: [2]
no-class-assign: [2]
no-cond-assign: [2, except-parens]
no-confusing-arrow: [2]
no-const-assign: [2]
no-constant-condition: [0]
no-control-regex: [2]
no-debugger: [2]
no-delete-var: [2]
no-div-regex: [0]
no-dupe-args: [2]
no-dupe-class-members: [2]
no-dupe-keys: [2]
no-duplicate-case: [2]
no-else-return: [0]
no-empty-character-class: [2]
no-empty-function: [0]
no-empty-pattern: [2]
no-empty: [0]
no-eq-null: [2]
no-eval: [2]
no-ex-assign: [2]
no-extend-native: [2]
no-extra-bind: [2]
no-extra-boolean-cast: [2]
no-extra-label: [0]
no-extra-parens: [0]
no-extra-semi: [2]
no-fallthrough: [2]
no-floating-decimal: [0]
no-func-assign: [2]
no-implicit-coercion: [0]
no-implicit-globals: [0]
no-implied-eval: [2]
no-inline-comments: [0]
no-inner-declarations: [2]
no-invalid-regexp: [2]
no-invalid-this: [0]
no-irregular-whitespace: [2]
no-iterator: [2]
no-label-var: [2]
no-labels: [2]
no-lone-blocks: [2]
no-lonely-if: [0]
no-loop-func: [0]
no-magic-numbers: [0]
no-mixed-requires: [0]
no-mixed-spaces-and-tabs: [2]
no-multi-spaces: [0]
no-multi-str: [2]
no-multiple-empty-lines: [2, {max: 1}]
no-native-reassign: [2]
no-negated-condition: [0]
no-negated-in-lhs: [2]
no-nested-ternary: [0]
no-new-func: [2]
no-new-object: [2]
no-new-require: [2]
no-new-symbol: [2]
no-new-wrappers: [2]
no-new: [0]
no-obj-calls: [2]
no-octal-escape: [2]
no-octal: [2]
no-path-concat: [2]
no-process-exit: [0]
no-proto: [2]
no-redeclare: [2]
no-regex-spaces: [2]
no-restricted-imports: [0]
no-restricted-modules: [2, domain, freelist, smalloc, sys]
no-restricted-syntax: [2, WithStatement]
no-return-assign: [2, except-parens]
no-script-url: [2]
no-self-assign: [2]
no-self-compare: [2]
no-sequences: [2]
no-shadow-restricted-names: [2]
no-shadow: [0]
no-spaced-func: [2]
no-sparse-arrays: [2]
no-this-before-super: [2]
no-throw-literal: [2]
no-trailing-spaces: [2]
no-undef-init: [2]
no-undef: [2]
no-undefined: [0]
no-underscore-dangle: [0]
no-unexpected-multiline: [2]
no-unmodified-loop-condition: [2]
no-unneeded-ternary: [2]
no-unreachable: [2]
no-unused-expressions: [2]
no-unused-labels: [0]
no-unused-vars: [2, {args: all, argsIgnorePattern: ^_}]
no-use-before-define: [2, nofunc]
no-useless-call: [2]
no-useless-concat: [2]
no-useless-constructor: [2]
no-warning-comments: [0]
no-whitespace-before-property: [2]
no-with: [2]
object-curly-spacing: [2, never]
one-var-declaration-per-line: [0]
one-var: [0]
operator-assignment: [2, always]
operator-linebreak: [2, after]
padded-blocks: [2, never]
prefer-rest-params: [0]
quote-props: [0]
quotes: [2, double]
radix: [2, always]
semi-spacing: [2, {before: false, after: true}]
semi: [2, always]
sort-imports: [0]
space-before-blocks: [2, always]
space-before-function-paren: [2, never]
space-in-parens: [2, never]
space-infix-ops: [2]
space-unary-ops: [2]
spaced-comment: [2, always, {markers: ["!"]}]
strict: [0]
template-curly-spacing: [2, never]
use-isnan: [2]
valid-typeof: [2]
wrap-iife: [2, inside]
yield-star-spacing: [2, {before: true, after: false}]
yoda: [2, never]
23 changes: 23 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Auto detect text files and perform LF normalization
* text=auto

# Custom for Visual Studio
*.cs diff=csharp
*.sln merge=union
*.csproj merge=union
*.vbproj merge=union
*.fsproj merge=union
*.dbproj merge=union

# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
*.md diss=astextplain
74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at wowmotty@gmail.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
56 changes: 56 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing

1. [Getting Involved](#getting-involved)
3. [Getting Started](#getting-started)
4. [Build & Test](#build--test)

## Getting Involved

There are a number of ways to get involved with the development of this Web Extension. Even if you've never contributed to an Open Source project before, we're always looking for help identifying spelling mistakes, grammar corrections or any other kind of help.

**This project is bound by a [Code of Conduct](CODE_OF_CONDUCT.md)**.

## Getting Started

Here is a quick summary:

* Download, fork or clone this repository to your computer.
* Make sure [node.js](http://nodejs.org/) is installed.
* Run `npm install` to get the build scripts working.
* Create and switch to a branch before making any corrections or enhancements to the files.
* Run `npm test` to check the linting of both the JavaScript and CSS files.
* Commit and push the changes to your fork.
* Submit a pull request with a description of the changes you made.

For more details, check out this [contributing guide](https://github.com/Roshanjossey/first-contributions#readme).

## Build & test

* To test this script, make sure to run `npm install` to install the required node modules.
* Note that at the time of this writing, you will see some warnings while attempting to load the unpacked extension into Chrome:
* The warnings are related to the [`node-jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken/issues/411) module.
* It is safe to ignore these warnings as they will not impede this extension from running.
* Currently there are no unit tests associated with this web extension, so running `npm test` will only check for linting errors.
* You can test your changes by loading the extension into your browser

### Webkit (Chrome)

* Go to the Menu > More tools > Extensions.
* Check the "Developer mode" checkbox.
* Click on "Load unpacked extension...".
* Find the folder for this extension on your computer.
* Click on the "background page" link next to "Inspect views" to check for errors on the background page.
* Open the options, then right click and "Inspect" to open the Development tools to check for errors.

### Firefox

* First, you'll need to create the compressed `.xpi` file:
* Make sure to run `npm install` first, if you haven't done it already.
* Now use `npm run build` to create the `darker-medium.xpi` file in the root directory.
* Open Firefox
* Navigate to `about:debugging#addons`.
* Click "Load Temporary Add-on".
* *Make sure* to select the `darker-medium.xpi` file.
* Click "Debug", then "OK" when the pop up asks to permit a remote debugging connection; This is the browser communicating with the debug window, it has nothing to do with this web extension.
* Check for errors in this debugging window.
* Please be aware that not all the errors shown in the debug window are related to this web extension.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Thank you for reporting an issue! Please make sure that your extension is
up-to-date and that you searched through the existing issues to make sure
that the problem wasn't recently addressed.
To report an issue, please help identify the cause by providing these details
(You'll find more information in the main README under "Reporting a problem"):
-->

* **Browser**:
* **Operating System**:
* **URL of the problem page**:

<!-- Include HTML and CSS, screenshots, or report any javascript error
as needed -->
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# lockfiles
package-lock.json
yarn.lock

# temp stuff
tmp/
*.tmp
*.bak

# Build
node_modules/

# Built Web Extension files
*.xpi
*.zip

# Windows crap
Thumbs.db
Desktop.ini

# Mac crap
.DS_Store
Loading

0 comments on commit f7109bc

Please sign in to comment.