Merge pull request #642 from Aktanusa/dev

Version 2.031.5 to master

.eslintignore

@@ -1,2 +1,6 @@
 CookieMonster.js
 CookieMonster.user.js
+src/*.js
+!src/CookieMonster.js
+!src/*/*
+dist/*

.eslintrc.js

@@ -4,15 +4,11 @@ module.exports = {
 		es2021: true,
 	},
 	globals: {
-		module: 'readonly',
 		Game: 'writable',
 		l: 'readonly',
 		b64_to_utf8: 'readonly',
 		utf8_to_b64: 'readonly',
-		Beautify: 'writable',
 		realAudio: 'readonly',
-		JSColor: 'readonly',
-		jscolor: 'readonly',
 		BeautifyAll: 'readonly',
 		CM: 'writable',
 		unsafeWindow: 'readonly',
@@ -23,28 +19,22 @@ module.exports = {
 	},
 	rules: {
 		indent: ['error', 'tab'],
+		'import/no-named-default': 'off',
+		'import/no-mutable-exports': 'off',
 		'no-tabs': 'off',
 		'max-len': 'off',
 		'no-param-reassign': 'off',
 		'no-plusplus': 'off',
 		'no-new-func': 'off',
-		'no-eval': 'off',
-		'no-restricted-properties': 'off',
 		'no-restricted-syntax': 'off',
 		'no-mixed-operators': 'off',
 		'prefer-destructuring': 'off',
 		'func-names': 'off',
-		'no-use-before-define': 'off',
 		'no-console': 'off',
 		'no-nested-ternary': 'off',
-		'object-shorthand': 'off',
-		'no-else-return': 'off',
 		'prefer-arrow-callback': 'off',
 		'no-new': 'off',
 		'no-alert': 'off',
-		'new-cap': 'off',
 		'no-restricted-globals': 'off',
-		'no-template-curly-in-string': 'off',
-		radix: 'off',
 	},
 };

.github/workflows/CI.yml

@@ -1,5 +1,5 @@
 name: CI
-on: [push, pull_request]
+on: pull_request
 jobs:
   Check_ESLint:
     runs-on: ubuntu-latest
@@ -16,8 +16,8 @@ jobs:
     - name: Check if CookieMonster.js is built correctly 
       run: |
         npm install
-        npx terser ./src/Header.js ./src/Cache.js ./src/Config.js ./src/Data.js ./src/Disp.js ./src/Main.js ./src/Sim.js ./src/Footer.js -o CookieMonsterTest.js
-        if cmp CookieMonster.js CookieMonsterTest.js; then
+        npx webpack -o ./test --env production
+        if cmp <(head -n 2 dist/CookieMonster.js) <(head -n 2 test/CookieMonster.js); then
             echo '### SUCCESS: CookieMonster is correctly built! ###'
         else
             echo '### WARNING: CookieMonster.js does not seem to be correct. Make sure to run "npm run build" after saving all your changes! ###'

README.md

@@ -2,11 +2,10 @@
 ## Cookie Monster
 
 **Cookie Monster** is an addon you can load into Cookie Clicker, that offers a wide range of tools and statistics to enhance the game. **It is not a cheat interface** – although it does offer helpers for golden cookies and such, everything can be toggled off at will to only leave how much information you want.
-
-This is a helper, and it is here to help you at *whichever* degree you want, if you only need some help shortening long numbers, it does that. If you need to be accompanied by hand to pick the best buildings to buy, it does that, but **everything is an option**.
+The mod helps you to *whichever* degree you want, if you only need some help shortening long numbers, it does that. If you need to be accompanied by hand to pick the best buildings to buy, it does that, but **everything is an option**.
 
 ### Current version
-You can see the current version, and a full history of all versions and what they changed by consulting the [releases page](https://github.com/Aktanusa/CookieMonster/releases).
+The `gh-pages` branch hosts the latest version intended for general users. All development and pull requests should target the `dev` branch.
 
 ### What it does
 
@@ -29,12 +28,6 @@ This index is computed for buildings and upgrades. If the relevant option is ena
 
 Note: For this index, **lower is better**, meaning a building with a PP of 1 is more interesting than one with a PP of 3.
 
-### What it doesn't do
-
-Some upgrades do not give a direct bonus to your income and will display as gray. These are mainly Golden Cookie upgrades and season upgrades.
-
-Do note though that, although these upgrades have no direct value, if buying them earns you an achievement of some sort which in return gives you milk and income, Cookie Monster **will** display that value.
-
 ## Using
 
 ### Bookmarklet
@@ -53,21 +46,21 @@ If (for some reason) the above doesn't work, trying pasting everything after the
 
 If you'd rather use the addon as a [userscript](https://en.wikipedia.org/wiki/Userscript) to automatically load _Cookie Monster_ every time the original game loads, install the `CookieMonster.user.js` file. You can do this by clicking on the file in the file-list and clicking "raw".
 
+**Note that to avoid conflicts Cookie Monster should ideally be loaded after any other content mods have been loaded**
+
 ## Bugs and suggestions
 
 Any bug or suggestion should be **opened as an issue** [in the repository](https://github.com/Aktanusa/CookieMonster/issues) for easier tracking. This allows us to close issues once they're fixed.
 
-Before submitting a bug, make sure to give a shot at the latest version of the addon on the <code>dev</code> branch. This version can be tested by copying the `CookieMonster.js` file of the dev branch into your console.
-
-If the bug is still here, you can submit an issue for it. Please do so by using the bug report template.
+Before submitting a bug, make sure to give a shot at the latest version of the addon on the `dev` branch. This version can be tested by copying the `CookieMonster.js` file of the dev branch into your console. If the bug is still here, you can submit an issue for it. Please do so by using the bug report template.
 
 All suggestions are welcome, even the smallest ones.
 
 ## Contributing
 
 To contribute you can fork and clone the repository and run `npm install`.
 
-Please also remember to run `npm run build` after saving all your changes to build the final `CookieMonster.js` file. 
+Please also remember to run `npm run build` after saving all your changes to build the final `CookieMonster.js` file.
 
 ## Contributors
 

dist/CookieMonster.js.LICENSE.txt

@@ -0,0 +1,10 @@
+/**
+ * jscolor - JavaScript Color Picker
+ *
+ * @link    http://jscolor.com
+ * @license For open source use: GPLv3
+ *          For commercial use: JSColor Commercial License
+ * @author  Jan Odvarko - East Desire
+ *
+ * See usage examples at http://jscolor.com/examples/
+ */