Support for Bitbucket (#36)

Author: mschlicht-tt

.prettierignore

@@ -1,2 +1,3 @@
 dist
-node_modules
+node_modules
+README.md

README.md

@@ -29,6 +29,7 @@ Supported SCM platforms:
 
 - GitHub
 - GitLab
+- Bitbucket Cloud
 
 Supported entry points
 
@@ -81,7 +82,7 @@ You are good to go! You can also pin the extension to the toolbar for easy acces
 
 - Open a commit or merge request on your SCM platform. Open the extension popup dialog
 - Select the correct platform type and add the host
-- Go to the options e.g., via click on the cog-wheel icon
+- You will be redirected to the options page, where the configuration dialog opens up
 - Now enter your API token
 
   - ⚠️Don\'t give the token all permissions, use fine-grained personal access tokens (if possible) ⚠️
@@ -100,22 +101,38 @@ You are good to go! You can also pin the extension to the toolbar for easy acces
         3. Select `Personal access tokens` - `Fine-grained tokens`
         4. Select `Generate new token`
         5. Set `Repository access` as desired. If you give access to non-public repositories, make sure to grant `Repository permissions` for `Content` (read-only) and `Pull requests` (read-only)
-      - GitLab 1. Go to `Settings` - `Access tokens` in the relevant group or repository 2. Select `Add new token` 3. Set **Scope** to `read_api`, select a **Role** that is allowed to access code and changes
+      - GitLab 
+        1. Go to `Settings` - `Access tokens` in the relevant group or repository 
+        2. Select `Add new token` 
+        3. Set **Scope** to `read_api`, select a **Role** that is allowed to access code and changes
+      - Bitbucket Cloud
+        - Personal access tokens
+          1. Log in to https://id.atlassian.com/manage-profile/security/api-tokens.
+          2. Select **Create API token with scopes**.
+          3. Select **`read:repository:bitbucket`** and **`read:pullrequest:bitbucket`** scopes.
+          >*When using a Bitbucket personal access token, you must also provide the email address that belongs to the token in the extension’s configuration dialog.*
+        - Workspace/Project/Repository access tokens
+          1. At https://bitbucket.org, navigate to the workspace, project or repository that you want the token to have access to.
+          2. Open the corresponding **workspace**, **project** or **repository settings**.
+          3. On the sidebar, under **Security**, select **Access tokens**.
+          4. Select **Create access tokens**.
+          5. Select **`repository`** and **`pullrequest`** permissions.
     </details>
-    <img style="display: block; alight: left" src="./docs/images/firefox/configuration.png" alt="Configuration" width="800"/>
+    <img style="display: block; alight: left" src="./docs/images/chrome/add_host_dialog.png" alt="Add host dialog" width="600"/>
+    <img style="display: block; alight: left" src="./docs/images/chrome/configuration.png" alt="Configuration" width="600"/>
 
 - Save the settings
 - Go back to the commit page and open the popup again
 - The supported files of the changes will be listed
 - Files that cannot be diffed with the ecu.test Diff-Viewer can still be opened individually for both the old and new versions
 - Click on a file and click on "Show new" or "Show old"
 
-  <img style="display: block; alight: left" src="./docs/images/firefox/dialog_download.png" alt="Configuration Download" width="600"/>
+  <img style="display: block; alight: left" src="./docs/images/chrome/dialog_download.png" alt="Configuration Download" width="600"/>
 
 - Files supported by the ecu.test Diff-Viewer will open directly in the viewer
 - Click on a file and click on "Show diff"
 
-  <img style="display: block; alight: left" src="./docs/images/firefox/dialog.png" alt="Configuration" width="600"/>
+  <img style="display: block; alight: left" src="./docs/images/chrome/dialog.png" alt="Configuration" width="600"/>
 
 - ecu.test Diff-Viewer will be opened
 

docs/DeveloperGuide.md

@@ -51,7 +51,7 @@ Open the ecu.test diff project in your IDE of choice and run the following termi
 
 If you want to build the ecu.test diff extension locally for development purposes or for production use, you have access to different scripts:
 
-**<u>Note:</u>** All of these scripts can be found and modified within the './package.json' of the project.
+**<u>Note:</u>** All of these scripts can be found and modified within the `./package.json` of the project.
 
 **Firefox:**
 
@@ -72,22 +72,11 @@ Your compiled files are available inside the `./dist` folder after the build pro
 
 ## Integration
 
-For integration and testing into your browser, you have to note some differences:
+You can integrate and test the local extension in your browsers:
 
-In **Chrome/Edge** you can select the `./dist` folder inside you browser windows for importing the extension.
-
-In **Firefox**, you can test the extension only in debug-mode.
-You have to klick on 'debug add-ons' and can afterward select a .zip file for the import.
-You can create the .zip file on your own or use the tool web-ext (from mozilla).
-
-```
-npm install web-ext
-cd ./dist
-web-ext build
-```
-
-This tooling also provides help in the [signing process](https://extensionworkshop.com/documentation/develop/extensions-and-the-add-on-id/)
-which is required for the use of add-ons without a debug-mode in firefox.
+- To load the local extension you need required rights (probably managed by your IT department). The browser will probably inform you if you are not allowed to contents apart from the official stores.
+- In **Chrome/Edge** you can load the extension on the [extensions page](chrome://extensions/). The slider `Developer mode` on the upper right has to be activated. Then, you can click on the button `Load unpacked` and select the `./dist` folder.
+- In **Firefox**, you can load the extension on the [debugging page](about:debugging#/runtime/this-firefox) (follow this link or click on 'debug add-ons' when managing addons). Click on the button `Load Temporary Add-on` and select a typical file in `./dist` folder, e.g. `./dist/manifest.json`.
 
 ## Testing / Linting / Code formatting
 
@@ -100,7 +89,7 @@ Select the files you want to format and run the following command:
 
 ```bash
 # check all files
-npm prettier:check
+npm run prettier:check
 
 # fix findings for all files
 npm run prettier:write .
@@ -192,6 +181,17 @@ See the following store-specific information, to handle release specification in
 - a mozilla developer account is required
 - any secrets that are necessary for the publication process are set as `Actions secret`
 - any additional information, see [Submitting an add-on](https://extensionworkshop.com/documentation/publish/submitting-an-add-on/)
+  - _Note_:
+    - The tool `web-ext` (from mozilla) will help you in the [signing process](https://extensionworkshop.com/documentation/develop/extensions-and-the-add-on-id/) which is required for the use of add-ons without a debug-mode in firefox.
+
+      For example, install it globally.
+
+      ```
+      npm install web-ext -g
+      cd ./dist
+      web-ext build
+      ```
+
 - after publishing the application, a review is usually pending and will be published afterward
   - _Note_:
     - the add-on may be subject to additional review.