Reddit Enhancement Suite

Reddit Enhancement Suite (RES) is a suite of modules that enhances your Reddit browsing experience.

For general documentation, visit the Reddit Enhancement Suite Wiki.

Introduction

Hi there! Thanks for checking out RES on GitHub. A few important notes:

RES is licensed under GPLv3, which means you're technically free to do whatever you wish in terms of redistribution as long as you maintain GPLv3 licensing. However, I ask out of courtesy that should you choose to release your own, separate distribution of RES, you please name it something else entirely. Unfortunately, I have run into problems in the past with people redistributing under the same name, and causing me tech support headaches.
I ask that you please do not distribute your own binaries of RES (e.g. with bugfixes, etc). The version numbers in RES are important references for tech support so that we can replicate bugs that users report using the same version they are, and when you distribute your own - you run the risk of polluting/confusing that. In addition, if a user overwrites his/her extension with your distributed copy, it may not properly retain their RES settings/data depending on the developer ID used, etc.

I can't stop you from doing any of this. I'm just asking out of courtesy because I already spend a great deal of time providing tech support and chasing down bugs, and it's much harder when people think I'm the support guy for a separate branch of code.

Thanks!

Steve Sobel [email protected]

Contributor guidelines

Thinking about contributing to RES? Awesome! We just ask that you follow a few simple guidelines:

RES has grown quite large, so we do have to pick and choose what features we should add. Code bloat is always a concern, and RES is already rather hefty. If you're unsure if your feature would appeal to a wide audience, please post about it on /r/Enhancement or contact @honestbleeps directly to ask.
There are a few features we have made a conscious choice not to add to RES, so make sure whatever you'd like to contribute isn't on that list.
It would be greatly appreciated if you could stick to a few style guidelines:

please use tabs for indentation
please use spaces in your if statements, e.g. if (foo === bar), not if(foo===bar)
please use single quotes ' and not double quotes " for strings
please comment your code!
please consider using the gulp travis command (see below) to verify your code style

If you decide to add support for another media hosting site to RES, check out lib/modules/hosts/example.js. Please be sure that they support CORS so the sites do not need to be added as additional permissions, which has caused headaches in the past.
If you decide to add a new module, check out lib/modules/example.js. To add the module to the browser manifests, use gulp add-module --file module.js (replace module.js with your filename).

Project structure

Top level files & folders

README.md – YOU ARE HERE, unless you're browsing on GitHub
changelog.txt – self-explanatory
gulpfile.js - build script
package.json – package info, dependencies
lib/ – all RES code
lib/core/ – core RES code
lib/modules/ – RES modules
lib/vendor/ – RES vendor libraries
Chrome/ – Chrome-specific RES files
Firefox/ – Firefox-specific RES files
Safari/ – Safari-specific RES files
dist/ - build output
tests/ – RES tests, currently unused

Chrome files

background.js – the "background page" for RES, necessary for Chrome extensions
manifest.json – the project manifest
icon.png, icon48.png, icon128.png – icons!

Firefox files

index.js – this is Firefox's sort of "background page" for RES, like what Chrome has, but just a JS file
package.json – the project manifest for the Firefox add-on

Safari files

background-safari.html – the "background page" for RES, necessary for Safari extensions
Info.plist – the project manifest
icon.png, icon48.png, icon128.png – icons!

Building development versions of the extension

RES is built with gulp.

First time installation:

Install node.js (version 4+).
Install Python 2 (not version 3).
Run npm install -g gulp.
Navigate to your RES folder.
Run npm install.

Once done, you can build the extension by running gulp. This will also start a watch task that will rebuild RES when you make changes (see Advanced Usage for more details). If you're having issues with building the extension, try uninstalling global gulp (npm uninstall -g gulp) and reinstalling it.

To load the extension into your browser, see the sections below.

Details and Advanced Usage

JavaScript files in lib/ (except lib/vendor/) will be compiled with Babel.

Sass (.scss) files in lib/ will be compiled with Sass and post-processed with Autoprefixer.

gulp will run gulp clean and gulp watch in sequence.

gulp clean will delete the build output subdirectories of the dist/ directory.

gulp build will build RES, copying the resultant files into the dist/ directory. It is recommended to run gulp clean first.

gulp watch will run gulp build, then re-run it when anything changes. Only changed files will be rebuilt.

gulp add-module --file module.js will add module.js, a new module, to the manifest for each browser.

gulp add-host --file hostname.js will add hostname.js, a new media host, to the manifest for each browser.

gulp zip --zipdir /path/to/zip/directory will compress the build folders in dist/ into .zip files. If no --zipdir is specified, the .zip files will be placed in dist/zip/. It is recommended to run gulp build first.

gulp <tasks> -b chrome -b firefox can be used with any of the above commands to specify individual browsers (chrome, firefox, safari), instead of performing the task(s) for all of them.

gulp travis will verify the code style (and point out any errors) of all .js files in lib/ (except lib/vendor/) using ESLint, as well as all .scss files with scss-lint. It will also run QUnit tests (in tests/qunit). We recommend that you run this before opening a pull request. (This is used by Travis CI to automatically test pull requests.)

Note: You will need to install Ruby and run gem install scss_lint before using gulp travis.

Building in Chrome

Go to Menu->Tools->Extensions and tick the Developer Mode checkbox
Choose Load unpacked extension and point it to the dist/chrome folder. Make sure you only have one RES version running at a time.
Any time you make changes to the script, you must go back to the Menu->Tools->Extensions page and Reload the extension.

Building in Firefox

Install jpm using npm: npm install -g jpm
Navigate to dist/firefox and run the command jpm run, which should launch a new Firefox browser using a temporary profile with only RES installed.

Building in Safari (assumes Mac)

Open the Preferences by going to Safari->Preferences or pressing ⌘,, then go to Advanced and check the checkbox for Show Develop menu in menu bar.
Navigate to Develop->Show Extension Builder to open the extensions builder. Add a new extension by pressing the + in the bottom left and choosing Add Extension.
Navigate to the dist/RES.safariextension folder for RES and select it.
If you are using Safari 9+, you should be able to install the extension without enrolling in the Apple Developer Program; however, the extension will be auto-uninstalled when you quit Safari.

If you use an older version of Safari or find the auto-uninstall annoying, you need to purchase a proper certificate by signing up for the Apple Developer Program (currently $99/yr).

Accessing nightly builds

In addition to building your own version of RES, you can download older (or current) builds of RES for testing purposes.

(Almost) every commit to master is quickly archived away at http://allthefoxes.me; if you would like access to this database, please contact /u/allthefoxes on reddit or email [email protected].

All that is asked is that you have at least one previous contribution to RES.

Adding new files

Modules

Create a new .js file in lib/modules. Use gulp add-module to add the file to the browsers' manifests.

Inline image viewer hosts

See lib/modules/hosts/example.js for an example.

Create a new .js file in lib/modules/hosts. Use gulp add-host to add the file to the browsers' manifests.

Stylesheets

Create a new Sass partial under lib/css/ (with a leading underscore, e.g. _myPartial.scss). Import the file in lib/css/res.scss (i.e. @import 'modules/myPartial'; - do not include the underscore or file extension). You do not need to add it to any browser manifests.

Body classes will be automatically added for boolean and enum options with the property bodyClass: true, in the form .res-moduleId-optionKey for boolean options (only when they're enabled), and .res-moduleId-optionKey-optionValue for enums. This is the preferred way to create optional CSS, do not use addCSS() unless absolutely necessary (i.e. variable color, size, etc.).

ljcl / reddit-enhancement-suite Goto Github PK