Left: | ||
Right: |
OLD | NEW |
---|---|
1 Shared Adblock Plus UI code | 1 Shared Adblock Plus UI code |
2 =========================== | 2 =========================== |
3 | 3 |
4 The user interface elements defined in this repository will be used by various | 4 The user interface elements defined in this repository will be used by various |
5 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be | 5 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be |
6 tested within this repository, even though they might not work exactly the same | 6 tested within this repository, even though they might not work exactly the same |
7 as they will do in the final product. | 7 as they will do in the final product. |
8 | 8 |
9 Installing dependencies | 9 Installing dependencies |
10 ----------------------- | 10 ----------------------- |
11 | 11 |
12 Both [python 2](https://www.python.org/downloads/) and [node](https://nodejs.org /en/), as well as [npm](https://www.npmjs.com), are required to contribute to th is repository. | 12 Both [python 2](https://www.python.org/downloads/) and [node](https://nodejs.org /en/), as well as [npm](https://www.npmjs.com), are required to contribute to th is repository. |
13 | 13 |
14 If you are installing `node` in ArchLinux, please remember to install `npm` too. | 14 If you are installing `node` in ArchLinux, please remember to install `npm` too. |
15 | 15 |
16 After cloning this repository, enter into its folder and run: `npm install`. | 16 After cloning this repository, enter into its folder and run: `npm install`. |
17 | 17 |
18 This should create and populate, both `./node_modules` folder and the `./buildto ols` one. | 18 This should create and populate, both `./node_modules` folder and the `./buildto ols` one. |
19 | 19 |
20 **Note:** [devDependencies](https://docs.npmjs.com/files/package.json#devdepende ncies) are not preinstalled during extension build, use [dependencies](https://d ocs.npmjs.com/files/package.json#dependencies) instead. | |
saroyanm
2018/03/15 20:57:37
Giving another thought, I'm not sure if it's an un
a.giammarchi
2018/03/15 22:36:52
devDependencies are *never* shipped to production.
| |
21 | |
20 Directory structure | 22 Directory structure |
21 ------------------- | 23 ------------------- |
22 | 24 |
23 * Top-level files: | 25 * Top-level files: |
24 * `firstRun.html` and `firstRun.js`: First-run page, see below | 26 * `firstRun.html` and `firstRun.js`: First-run page, see below |
25 * `i18n.js`: Localization functions, should be included by all pages. | 27 * `i18n.js`: Localization functions, should be included by all pages. |
26 * `messageResponder.js`: Script to be used on the background page to respond | 28 * `messageResponder.js`: Script to be used on the background page to respond |
27 to messages sent by UI code. | 29 to messages sent by UI code. |
28 * `background.html`, `background.js`: Test implementation of the background | 30 * `background.html`, `background.js`: Test implementation of the background |
29 page, should *not be imported*. | 31 page, should *not be imported*. |
(...skipping 174 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
204 errors when adding new filters on the options page | 206 errors when adding new filters on the options page |
205 * `blockedURLs`: a comma-separated list of URLs that should be considered | 207 * `blockedURLs`: a comma-separated list of URLs that should be considered |
206 blocked (necessary to test the check for blocked scripts in sharing buttons). | 208 blocked (necessary to test the check for blocked scripts in sharing buttons). |
207 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used | 209 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used |
208 to trigger various filter list download errors | 210 to trigger various filter list download errors |
209 * `platform=chromium`: shows the opt-out for the developer tools panel | 211 * `platform=chromium`: shows the opt-out for the developer tools panel |
210 * `showNotificationUI=true`: simulates user having opted-out of notifications | 212 * `showNotificationUI=true`: simulates user having opted-out of notifications |
211 | 213 |
212 | 214 |
213 [crowdin]: https://crowdin.com | 215 [crowdin]: https://crowdin.com |
OLD | NEW |