diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 284bef1..77752df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,14 @@ ## How to build the addon from source -* Clone this repository: `git clone git@bitbucket.org:pabuisson/in-my-pocket.git` +* Clone this repository: `git clone git@github.com:pabuisson/in-my-pocket.git` * `cd` to the directory where you cloned the repository, -* `$ npm install`: install the tools needed to build the addon from the source files. You'll need to have `npm` installed on your computer. For more information about this, see [npmjs.com - Get npm](https://www.npmjs.com/get-npm), -* `$ npm run build`: launch webpack and store all the final files into `./build`. In there, you'll find a `firefox/` directory which can be loaded in Firefox through the `about:debugging` page for development purpose, and a `chrome/` directory, which can be loaded into chrome through the `chrome://extensions` page, -* `$ npm run watch`: launch webpack in watch mode, building the concatenated files into `./build ` and updating the build directory everytime you modify the source files. See above for details about the generated `build/` directory, -* `$ npm run package` : compiles the source files and build the addon "zip" files, ready for submission to the browser stores :) This task triggers two different subtasks, `$ npm run package-ff` and `$ npm run package-chrome` that rely on different `manifest.json` files, +* `$ npm install`: install the dependencies needed to build the addon from the source files. You'll need to have `npm` installed on your computer. For more information about this, see [npmjs.com - Get npm](https://www.npmjs.com/get-npm), +* `$ npm run build`: launch esbuild and store all the final files into `./build`. In there, you'll find a `esbuild/` directory which can be loaded in Firefox through the `about:debugging` page for development purpose, +* `$ npm run watch`: launch esbuild in watch mode, building the concatenated files into `./build ` and updating the build everytime you modify the source files. See above for details about the generated `build/` directory, +* `$ npm run package` : compiles the source files and build the addon "zip" files, ready for submission to the browser stores :) This task triggers a different subtask, `$ npm run package-firefox` * `$ npm run test`: runs the tests associated to this project. +* `$ npm run test-watch`: runs the tests associated to this project, and re-run the relevant test files when code is modified. ## Linter @@ -20,19 +21,18 @@ If you want to, `eslint` is configured and can help you in the development proce ## Workflow -Before submitting a pull request, please always make sure that it starts from the latest `origin/master` available (if you've fetched the project long ago, you might not have the latest version). If it's not the case, please do not forget to rebase your branch on `origin/master` first (you'll need to merge `origin/master` in your own `master` branch). +Before submitting a pull request, please always make sure that it starts from the latest `origin/master` available (if you fetched the project long ago, you might not have the latest version). If it's not the case, please do not forget to rebase your branch on `origin/master` first (you'll need to merge `origin/master` in your own `master` branch). ------ +## Thanks 🙏 -## Thanks +Thanks for everyone who contributed to this project in one way or another, be that by sending financial contributions to encourage the development, by submitting pull requests or code suggestions, helping me with debug, offering suggestions and ideas, taking time to write a review on addons.mozilla.org, or simply by using the addon. As a fellow Pocket user, I'm glad that this addon is useful to the community, and I thank you all for your contributions to this project :) -Thanks for everyone who contributed to this project in one way or another, be that by sending financial contributions to encourage the development, submitting pull requests or code suggestions, helping with debug, offering suggestions and ideas, taking time to write a review on addons.mozilla.org, or simply by using the addon. As a fellow Pocket user, I'm glad that this addon is useful to the community, and I thank you all for your contributions to this project :) +Special thanks to the people who helped me and contributed to the project: -Special thanks to the developers who helped me and contributed to the project: - -* [adambro](https://bitbucket.org/adambro/) -* [eight04](https://bitbucket.org/eight04/) -* [bobi32](https://bitbucket.org/bobi32/) +* [adambro](https://github.com/adambro) +* [eight04](https://github.com/eight04) +* [bobi32](https://github.com/bobi32) * [kEINnAMER](https://bitbucket.org/kEINnAMER/) -* [JJ](https://bitbucket.org/jjzakius/) +* [JJ](https://github.com/zakius) * [danielrozenberg](https://github.com/danielrozenberg) +* [herrherrmann](https://github.com/herrherrmann) diff --git a/esbuild.mjs b/esbuild.mjs index b76a5f2..757b824 100644 --- a/esbuild.mjs +++ b/esbuild.mjs @@ -32,7 +32,7 @@ const config = { ".json": "copy", }, bundle: true, - outdir: "build/esbuild/", + outdir: "build/", target: ["firefox57"], logLevel: "debug", } diff --git a/package.json b/package.json index c9f42a2..2b00248 100644 --- a/package.json +++ b/package.json @@ -30,14 +30,14 @@ "build": "npm run clean && node esbuild.mjs", "watch": "npm run clean && node esbuild.mjs --watch", "package": "npm run build && npm run package-firefox && npm run zip-source", - "package-firefox": "cd ./build/esbuild && zip -r -FS ../../web-ext-artifacts/in_my_pocket-firefox-esbuild.zip * -x .DS_Store -x *.map", + "package-firefox": "cd ./build && zip -r -FS ../../web-ext-artifacts/in_my_pocket-firefox.zip * -x .DS_Store -x *.map", "zip-source": "zip -r -FS web-ext-artifacts/source.zip CHANGELOG.md README.md LICENSE package.json esbuild.mjs tsconfig.json src/ -x .DS_Store -x *.map", "test": "jest", "test-watch": "jest --watch" }, "repository": { "type": "git", - "url": "git+ssh://git@bitbucket.org/pabuisson/in-my-pocket.git" + "url": "git+ssh://git@github.com:pabuisson/in-my-pocket.git" }, "keywords": [ "firefox", @@ -45,7 +45,7 @@ ], "author": "Pierre-Adrien Buisson", "license": "MPL-2.0", - "homepage": "https://bitbucket.org/pabuisson/in-my-pocket#readme", + "homepage": "https://inmypocketaddon.com", "dependencies": { "@sentry/browser": "^6.19.0", "@sentry/tracing": "^6.19.0" diff --git a/src/manifest_chrome.json b/src/manifest_chrome.json index 417ece3..e47f8c3 100644 --- a/src/manifest_chrome.json +++ b/src/manifest_chrome.json @@ -4,7 +4,7 @@ "version": "0.12.26", "description": "For all people who are missing the old Firefox Pocket addon, here is an unofficial client for the Pocket service. My goal is to provide a useful, but still lightweight means to access your Pocket account from your browser. Enjoy!", - "homepage_url": "https://bitbucket.org/pabuisson/in-my-pocket", + "homepage_url": "https://inmypocketaddon.com", "icons": { "48": "assets/icons/icon-48.png", "96": "assets/icons/icon-96.png" diff --git a/src/manifest_firefox.json b/src/manifest_firefox.json index 5f7122b..9f44bd0 100644 --- a/src/manifest_firefox.json +++ b/src/manifest_firefox.json @@ -4,7 +4,7 @@ "version": "0.12.26", "description": "For all people who are missing the old Firefox Pocket addon, here is an unofficial client for the Pocket service. My goal is to provide a useful, but still lightweight means to access your Pocket account from your browser. Enjoy!", - "homepage_url": "https://bitbucket.org/pabuisson/in-my-pocket", + "homepage_url": "https://inmypocketaddon.com", "icons": { "48": "assets/icons/icon-48.png", "96": "assets/icons/icon-96.png"