| OLD | NEW |
| 1 Adblock Plus for Chrome, Opera, Microsoft Edge and Firefox | 1 Adblock Plus for Chrome, Opera, Microsoft Edge and Firefox |
| 2 ========================================================== | 2 ========================================================== |
| 3 | 3 |
| 4 This repository contains the platform-specific Adblock Plus source code for | 4 This repository contains the platform-specific Adblock Plus source code for |
| 5 Chrome, Opera, Microsoft Edge and Firefox. It can be used to build | 5 Chrome, Opera, Microsoft Edge and Firefox. It can be used to build |
| 6 Adblock Plus for these platforms, generic Adblock Plus code will be extracted | 6 Adblock Plus for these platforms, generic Adblock Plus code will be extracted |
| 7 from other repositories automatically (see _dependencies_ file). | 7 from other repositories automatically (see _dependencies_ file). |
| 8 | 8 |
| 9 Note that the Firefox extension built from this repository is the new | 9 Note that the Firefox extension built from this repository is the new |
| 10 [WebExtension](https://developer.mozilla.org/en-US/Add-ons/WebExtensions). | 10 [WebExtension](https://developer.mozilla.org/en-US/Add-ons/WebExtensions). |
| (...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 60 under _about:debugging_ in Firefox or in _Extensions_ menu in Microsoft Edge, | 60 under _about:debugging_ in Firefox or in _Extensions_ menu in Microsoft Edge, |
| 61 after enabling extension development features in _about:flags_. | 61 after enabling extension development features in _about:flags_. |
| 62 After making changes to the source code re-run the command to update the | 62 After making changes to the source code re-run the command to update the |
| 63 development environment. In Chrome and Firefox the extension should reload | 63 development environment. In Chrome and Firefox the extension should reload |
| 64 automatically after a few seconds. | 64 automatically after a few seconds. |
| 65 | 65 |
| 66 Builds for Microsoft Edge do not automatically detect changes, so after | 66 Builds for Microsoft Edge do not automatically detect changes, so after |
| 67 rebuilding the extension you should manually force reloading it in Edge by | 67 rebuilding the extension you should manually force reloading it in Edge by |
| 68 hitting the _Reload Extension_ button. | 68 hitting the _Reload Extension_ button. |
| 69 | 69 |
| 70 #### Skip dependencies check | 70 The build script calls the ensure_dependencies script automatically to manage |
| 71 | 71 the dependencies (see _dependencies_ file). Dependencies with local |
| 72 If you are modifying `adblockpluscore` or `adblockplusui` and you would like | 72 modifications won't be updated. Otherwise during development specifying a |
| 73 to build the dev extension, you can specify `SKIP_DEPENDENCY_UPDATES=true` | 73 feature-branch's name for a dependency's revision is sometimes useful. |
| 74 as environment variable so that build tools will not ensure the release commit. | 74 Alternatively dependency management can be disabled completely by setting the |
| 75 _SKIP_DEPENDENCY_UPDATES_ environment variable, for example: |
| 75 | 76 |
| 76 SKIP_DEPENDENCY_UPDATES=true ./build.py devenv -t chrome | 77 SKIP_DEPENDENCY_UPDATES=true ./build.py devenv -t chrome |
| 77 | 78 |
| 78 Running the unit tests | 79 Running the unit tests |
| 79 ---------------------- | 80 ---------------------- |
| 80 | 81 |
| 81 To verify your changes you can use the unit test suite located in the _qunit_ | 82 To verify your changes you can use the unit test suite located in the _qunit_ |
| 82 directory of the repository. In order to run the unit tests go to the | 83 directory of the repository. In order to run the unit tests go to the |
| 83 extension's Options page, open the JavaScript Console and type in: | 84 extension's Options page, open the JavaScript Console and type in: |
| 84 | 85 |
| 85 location.href = "qunit/index.html"; | 86 location.href = "qunit/index.html"; |
| 86 | 87 |
| 87 The unit tests will run automatically once the page loads. | 88 The unit tests will run automatically once the page loads. |
| 88 | 89 |
| 89 Linting | 90 Linting |
| 90 ------- | 91 ------- |
| 91 | 92 |
| 92 You can lint the code using [ESLint](http://eslint.org). | 93 You can lint the code using [ESLint](http://eslint.org). |
| 93 | 94 |
| 94 eslint *.js lib/ qunit/ ext/ chrome/ | 95 eslint *.js lib/ qunit/ ext/ chrome/ |
| 95 | 96 |
| 96 You will need to set up ESLint and our configuration first, see | 97 You will need to set up ESLint and our configuration first, see |
| 97 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-conf
ig-eyeo) | 98 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-conf
ig-eyeo) |
| 98 for more information. | 99 for more information. |
| OLD | NEW |