add doc to Get Started on how to create bundled source files

This commit is contained in:
Leon Bubova committed 2021-12-15 10:14:19 +01:00
1 parent 7b9c1781b4
commit 64fb3595d2
9 files changed
+79 -53

No files matched your search

+29
View File
@@ -4,6 +4,35 @@ Thank you for investing your time in contributing to our project! All your chang
## Getting Started
Please use Prettier with default settings for formatting.
#### Prerequisites
You need to have node and npm installed to create the bundled version of the source.
Versions used when setting up:
- node: 12.18.4
- npm: 6.14.6
To create the `bundled-content-script.js` that contains most of the business logic of this extension you have to install all dependencies first.
1. Go to the root of the repo and run:
```
npm install
```
2. Run the following command to create `bundled-content-script.js` which is used in `manifest.json`
```
npm run bundle
```
This will also start a watcher that re-bundles automatically once you save a file inside the source.
Congratulations, You are now ready to develop!
### Issues
#### Opening a new issue
If you have any issues with the extension, please search to make sure the issue isn't already reported. If it isn't, open an issue, using the issue form is highly recommended but not mandatory.
View File
Whitespace-only changes.
+7 -22
View File
@@ -2,41 +2,26 @@
"name": "Return YouTube Dislike",
"description": "Returns ability to see dislikes",
"version": "2.0.0.2",
"manifest_version": 3,
"manifest_version": 2,
"background": {
"service_worker": "ryd.background.js"
"scripts": ["ryd.background.js"]
},
"icons": {
"48": "icons/icon48.png",
"128": "icons/icon128.png"
"128": "icons/icon128.png"
},
"host_permissions": ["*://*.youtube.com/*"],
"permissions": [
"storage"
],
"action": {
"permissions": ["activeTab", "*://*.youtube.com/*", "storage"],
"browser_action": {
"default_popup": "popup.html"
},
"content_scripts": [
{
"matches": [
"*://youtube.com/*",
"*://www.youtube.com/*",
"*://m.youtube.com/*"
],
"matches": ["*://*.youtube.com/*"],
"exclude_matches": ["*://*.music.youtube.com/*"],
"run_at": "document_idle",
"css": ["content-style.css"],
"js": ["bundled-content-script.js"]
}
],
"externally_connectable": {
"matches": ["*://*.youtube.com/*"]
},
"web_accessible_resources": [
{
"resources": ["ryd.script.js"],
"matches": ["*://*.youtube.com/*"]
}
]
}
-27
View File
@@ -1,27 +0,0 @@
{
"name": "Return YouTube Dislike",
"description": "Returns ability to see dislikes",
"version": "2.0.0.2",
"manifest_version": 2,
"background": {
"scripts": ["ryd.background.js"]
},
"icons": {
"48": "icons/icon48.png",
"128": "icons/icon128.png"
},
"permissions": ["activeTab", "*://*.youtube.com/*", "storage"],
"browser_action": {
"default_popup": "popup.html"
},
"content_scripts": [
{
"matches": ["*://*.youtube.com/*"],
"exclude_matches": ["*://*.music.youtube.com/*"],
"run_at": "document_idle",
"css": ["content-style.css"],
"js": ["bundled-content-script.js"]
}
]
}
+41
View File
@@ -0,0 +1,41 @@
{
"name": "Return YouTube Dislike",
"description": "Returns ability to see dislikes",
"version": "2.0.0.2",
"manifest_version": 3,
"background": {
"service_worker": "ryd.background.js"
},
"icons": {
"48": "icons/icon48.png",
"128": "icons/icon128.png"
},
"host_permissions": ["*://*.youtube.com/*"],
"permissions": [
"storage"
],
"action": {
"default_popup": "popup.html"
},
"content_scripts": [
{
"matches": [
"*://youtube.com/*",
"*://www.youtube.com/*",
"*://m.youtube.com/*"
],
"exclude_matches": ["*://*.music.youtube.com/*"],
"js": ["bundled-content-script.js"],
"css": ["content-style.css"]
}
],
"externally_connectable": {
"matches": ["*://*.youtube.com/*"]
},
"web_accessible_resources": [
{
"resources": ["ryd.script.js"],
"matches": ["*://*.youtube.com/*"]
}
]
}
+1 -1
View File
@@ -392,4 +392,4 @@ RYDTools.getBrowser = function () {
}
};
RYD.getInstance().init();
RYD.getInstance().init();
-2
View File
@@ -1,2 +0,0 @@
-1
View File
@@ -1 +0,0 @@
console.log(path.resolve(__dirname, "Extensions/combined"))
+1
View File
@@ -10,4 +10,5 @@ module.exports = {
ramda: "R",
},
module: {},
watch: true
};