Преглед на файлове

Merge pull request #372 from Frontesque/main

Fix warnings during compile
Dmitrii Selivanov преди 3 години
родител
ревизия
78527ad47a
променени са 5 файла, в които са добавени 31 реда и са изтрити 4 реда
  1. 6 1
      .gitignore
  2. 16 0
      Extensions/combined/readme.md
  3. 6 0
      Extensions/combined/ryd.content-script.js
  4. 0 1
      package-lock.json
  5. 3 2
      package.json

+ 6 - 1
.gitignore

@@ -1,6 +1,7 @@
 *cert
 *Backend
 .DS_Store
+package-lock.json
 
 # Website node modules and build output
 Website/package-lock.json
@@ -31,4 +32,8 @@ yarn-error.log*
 node_modules
 
 # Build files
-Extensions/combined/bundled-content-script.js
+Extensions/combined/bundled-content-script.js
+
+# Dist Files
+Extensions/combined/dist/*
+package-lock.json

+ 16 - 0
Extensions/combined/readme.md

@@ -0,0 +1,16 @@
+# Extension Source
+## Guide to Compiling
+
+## Compiling to Development (Testing)
+<ol>
+    <li>Go to the root directory of the project</li>
+    <li>Run <code>npm i</code> to install all project dependancies (if not done so already)</li>
+    <li>run <code>npm run dev</code> to compile the extension to the <code>~/Extensions/combined/dist/</code> folder.</li>
+</ol>
+
+## Compiling to Production (Final Release)
+<ol>
+    <li>Go to the root directory of the project</li>
+    <li>Run <code>npm i</code> to install all project dependancies (if not done so already)</li>
+    <li>run <code>npm run build</code> to compile the extension to the <code>~/Extensions/combined/dist/</code> folder.</li>
+</ol>

+ 6 - 0
Extensions/combined/ryd.content-script.js

@@ -1,9 +1,12 @@
+//---   Import Button Functions   ---//
 import {
   getButtons,
   getLikeButton,
   getDislikeButton,
   checkForSignInButton,
 } from "./src/buttons";
+
+//---   Import State Functions   ---//
 import {
   isMobile,
   isVideoDisliked,
@@ -19,10 +22,13 @@ import {
   NEUTRAL_STATE,
   initExtConfig,
 } from "./src/state";
+
+//---   Import Video & Browser Functions   ---//
 import { numberFormat, getBrowser, getVideoId, isVideoLoaded, cLog } from "./src/utils";
 import { createRateBar } from "./src/bar";
 import { sendVideoIds, sendVote, likeClicked, dislikeClicked, addLikeDislikeEventListener, storageChangeHandler  } from "./src/events"
 
+
 initExtConfig()
 
 let jsInitChecktimer = null;

+ 0 - 1
package-lock.json

@@ -5,7 +5,6 @@
   "requires": true,
   "packages": {
     "": {
-      "name": "return-youtube-dislike",
       "version": "2.0.0",
       "devDependencies": {
         "@babel/core": "^7.16.5",

+ 3 - 2
package.json

@@ -4,8 +4,9 @@
   "description": "Chrome extension to return youtube dislikes",
   "main": "ryd.content-script.js",
   "scripts": {
-    "start": "webpack \"./Extensions/combined/ryd.content-script.js\" -o \"./Extensions/combined/dist/\" --watch",
-    "build": "webpack \"./Extensions/combined/ryd.content-script.js\" -o \"./Extensions/combined\"",
+	"start": "echo To build for development, please use \"npm run dev\". To build for production, please use \"npm run build\".",
+    "dev": "webpack --mode=development \"./Extensions/combined/ryd.content-script.js\" -o \"./Extensions/combined/dist/\" --watch",
+    "build": "webpack --mode=production \"./Extensions/combined/ryd.content-script.js\" -o \"./Extensions/combined\"",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {