added linters and fixed the issues (#169)

* added the rules

* fixed QuickCollapse

* fixed readingtime

* fixed stickyfeeds

* fix const/var quick_collapse_vars

I do not understand why const does not work

* update version number

---------

Co-authored-by: math-gh <>

.eslintrc.json

@@ -0,0 +1,29 @@
+{
+	"env": {
+		"browser": true
+	},
+	"extends": [
+		"eslint:recommended",
+		"standard"
+	],
+	"rules": {
+		"camelcase": "off",
+		"comma-dangle": ["warn", {
+			"arrays": "always-multiline",
+			"objects": "always-multiline"
+		}],
+		"eqeqeq": "off",
+		"indent": ["warn", "tab", { "SwitchCase": 1 }],
+		"linebreak-style": ["error", "unix"],
+		"max-len": ["warn", 165],
+		"no-tabs": "off",
+		"semi": ["warn", "always"],
+		"space-before-function-paren": ["warn", {
+			"anonymous": "always",
+			"named": "never",
+			"asyncArrow": "always"
+		}],
+		"yoda": "off"
+	},
+	"root": true
+}

.gitignore

@@ -1 +1,3 @@
 tmp
+/node_modules/
+.vscode/

.jshintignore

@@ -0,0 +1,3 @@
+.git/
+node_modules/
+

.jshintrc

@@ -0,0 +1,9 @@
+{
+	"esversion" : 8,
+	"browser" : true,
+	"globals": {
+		"confirm": true,
+		"console": true
+	},
+	"strict": "global"
+}

.stylelintignore

@@ -0,0 +1,2 @@
+.git/
+node_modules/

.stylelintrc.json

@@ -0,0 +1,72 @@
+{
+  "extends": "stylelint-config-recommended-scss",
+  "plugins": [
+    "stylelint-order",
+    "stylelint-scss"
+  ],
+  "rules": {
+    "at-rule-empty-line-before": [
+      "always", {
+        "ignoreAtRules": [ "after-comment", "else" ]
+      }
+    ],
+    "at-rule-name-space-after": [
+      "always", {
+        "ignoreAtRules": [ "after-comment" ]
+      }
+    ],
+    "block-closing-brace-newline-after": [
+      "always", {
+        "ignoreAtRules": [ "if", "else" ]
+      }
+    ],
+    "block-closing-brace-newline-before": "always-multi-line",
+    "block-opening-brace-newline-after": "always-multi-line",
+    "block-opening-brace-space-before": "always",
+    "color-hex-case": "lower",
+    "color-hex-length": "short",
+    "color-no-invalid-hex": true,
+    "declaration-colon-space-after": "always",
+    "declaration-colon-space-before": "never",
+    "indentation": "tab",
+    "no-descending-specificity": null,
+    "no-eol-whitespace": true,
+    "property-no-vendor-prefix": true,
+    "rule-empty-line-before": [
+      "always", {
+        "except": ["after-single-line-comment","first-nested"]
+      }
+    ],
+    "order/properties-order": [
+      "margin",
+      "padding",
+      "background",
+      "display",
+      "float",
+      "max-width",
+      "width",
+      "max-height",
+      "height",
+      "color",
+      "font",
+      "font-family",
+      "font-size",
+      "border",
+      "border-top",
+      "border-top-color",
+      "border-right",
+      "border-right-color",
+      "border-bottom",
+      "border-bottom-color",
+      "border-left",
+      "border-left-color",
+      "border-radius",
+      "box-shadow"
+    ],
+    "scss/at-else-closing-brace-newline-after": "always-last-in-chain",
+    "scss/at-else-closing-brace-space-after": "always-intermediate",
+    "scss/at-else-empty-line-before": "never",
+    "scss/at-if-closing-brace-newline-after": "always-last-in-chain",
+    "scss/at-if-closing-brace-space-after": "always-intermediate"
+  }
+}

package.json

@@ -0,0 +1,43 @@
+{
+  "name": "freshrss extensions",
+  "description": "Extensions for FreshRSS",
+  "homepage": "https://freshrss.org/",
+  "readmeFilename": "README.md",
+  "bugs": {
+    "url": "https://github.com/FreshRSS/Extensions/issues"
+  },
+  "keywords": [
+    "freshrss",
+    "extensions"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FreshRSS/Extensions.git"
+  },
+  "license": "see each extension",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "eslint": "eslint --ext .js .",
+    "eslint_fix": "eslint --fix --ext .js .",
+    "markdownlint": "markdownlint '**/*.md'",
+    "markdownlint_fix": "markdownlint --fix '**/*.md'",
+    "stylelint": "stylelint '**/*.css' && stylelint --custom-syntax postcss-scss '**/*.scss'",
+    "stylelint_fix": "stylelint --fix '**/*.css' && stylelint --fix --custom-syntax postcss-scss '**/*.scss'",
+    "test": "npm run eslint && npm run stylelint && npm run markdownlint",
+    "fix": "npm run rtlcss && npm run stylelint_fix && npm run eslint_fix && npm run markdownlint_fix"
+  },
+  "devDependencies": {
+    "eslint": "^8.45.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "markdownlint-cli": "^0.35.0",
+    "sass": "^1.63.6",
+    "stylelint": "^15.10.2",
+    "stylelint-config-recommended-scss": "^12.0.0",
+    "stylelint-order": "^6.0.3"
+  }
+}

xExtension-QuickCollapse/metadata.json

@@ -2,7 +2,7 @@
 	"name": "Quick Collapse",
 	"author": "romibi and Marien Fressinaud",
 	"description": "Quickly change from folded to unfolded articles",
-	"version": 0.1,
+	"version": 0.1.1,
 	"entrypoint": "QuickCollapse",
 	"type": "user"
 }

xExtension-QuickCollapse/static/script.js

@@ -1,3 +1,5 @@
+/* globals context, quick_collapse_vars */
+
 (function () {
 	function toggleCollapse() {
 		const streamElem = document.getElementById('stream');

xExtension-QuickCollapse/views/quickCollapse/vars.js

@@ -1,7 +1,10 @@
+/* exported quick_collapse_vars */
+
+// eslint-disable-next-line no-unused-vars
 var quick_collapse_vars = {
-    icon_url_in: "<?= $this->icon_url_in ?>",
+	icon_url_in: '<?= $this->icon_url_in ?>',
-    icon_url_out: "<?= $this->icon_url_out ?>",
+	icon_url_out: '<?= $this->icon_url_out ?>',
 	i18n: {
-        toggle_collapse: "<?= $this->i18n_toggle_collapse ?>",
+		toggle_collapse: '<?= $this->i18n_toggle_collapse ?>',
 	},
 };

xExtension-ReadingTime/metadata.json

@@ -2,7 +2,7 @@
 	"name": "ReadingTime",
 	"author": "Lapineige",
 	"description": "Add a reading time estimation next to each article",
-	"version": 1.3,
+	"version": 1.3.1,
 	"entrypoint": "ReadingTime",
 	"type": "user"
 }

xExtension-ReadingTime/static/readingtime.js

@@ -1,9 +1,7 @@
-/* globals $ */
-
 (function reading_time() {
 	'use strict';
 
-    var reading_time = {
+	const reading_time = {
 		flux_list: null,
 		flux: null,
 		textContent: null,
@@ -11,51 +9,55 @@
 		read_time: null,
 		reading_time: null,
 
- init: function() {
+		init: function () {
-     var flux_list = document.querySelectorAll('[id^="flux_"]');
+			const flux_list = document.querySelectorAll('[id^="flux_"]');
 
-     for (var i = 0; i < flux_list.length; i++) {
+			for (let i = 0; i < flux_list.length; i++) {
-
+				if ('readingTime' in flux_list[i].dataset) {
-         if ("readingTime" in flux_list[i].dataset) {
 					continue;
 				}
 
 				reading_time.flux = flux_list[i];
 
 				reading_time.words_count = reading_time.flux_words_count(flux_list[i]); // count the words
-         reading_time.reading_time = reading_time.calc_read_time(reading_time.words_count, 300); // change this number (in words) to your prefered reading speed
+				// change this number (in words) to your prefered reading speed:
+				reading_time.reading_time = reading_time.calc_read_time(reading_time.words_count, 300);
 
 				flux_list[i].dataset.readingTime = reading_time.reading_time;
 
-         const li = document.createElement("li");
+				const li = document.createElement('li');
-         li.setAttribute("class", "item date");
+				li.setAttribute('class', 'item date');
-         li.style.width = "min-content";
+				li.style.width = 'min-content';
-         li.style.minWidth = "40px";
+				li.style.minWidth = '40px';
-         li.style.overflow = "hidden";
+				li.style.overflow = 'hidden';
-         li.style.textAlign = "right";
+				li.style.textAlign = 'right';
-         li.style.display = "table-cell";
+				li.style.display = 'table-cell';
 				li.textContent = reading_time.reading_time + '\u2009m';
 
-         const ul = document.querySelector("#" + reading_time.flux.id + " ul.horizontal-list");
+				const ul = document.querySelector('#' + reading_time.flux.id + ' ul.horizontal-list');
 				ul.insertBefore(li, ul.children[ul.children.length - 1]);
 			}
 		},
 
 		flux_words_count: function flux_words_count(flux) {
-
+			// get textContent, from the article itself (not the header, not the bottom line):
-     reading_time.textContent = flux.querySelector('.flux_content .content').textContent; // get textContent, from the article itself (not the header, not the bottom line).
+			reading_time.textContent = flux.querySelector('.flux_content .content').textContent;
 
 			// split the text to count the words correctly (source: http://www.mediacollege.com/internet/javascript/text/count-words.html)
-     reading_time.textContent = reading_time.textContent.replace(/(^\s*)|(\s*$)/gi,"");//exclude  start and end white-space
+			reading_time.textContent = reading_time.textContent.replace(/(^\s*)|(\s*$)/gi, ''); // exclude  start and end white-space
-     reading_time.textContent = reading_time.textContent.replace(/[ ]{2,}/gi," ");//2 or more space to 1
+			reading_time.textContent = reading_time.textContent.replace(/[ ]{2,}/gi, ' '); // 2 or more space to 1
-     reading_time.textContent = reading_time.textContent.replace(/\n /,"\n"); // exclude newline with a start spacing
+			reading_time.textContent = reading_time.textContent.replace(/\n /, '\n'); // exclude newline with a start spacing
 
 			return reading_time.textContent.split(' ').length;
 		},
 
- calc_read_time : function calc_read_time(wd_count, speed) {
+		calc_read_time: function calc_read_time(wd_count, speed) {
-     reading_time.read_time = Math.round(wd_count/speed);
+			reading_time.read_time = Math.round(wd_count / speed);
-     if (reading_time.read_time === 0) { reading_time.read_time = '<1'; }
+
+			if (reading_time.read_time === 0) {
+				reading_time.read_time = '<1';
+			}
+
 			return reading_time.read_time;
 		},
 	};
@@ -72,5 +74,4 @@
 	} else if (document.addEventListener) {
 		document.addEventListener('DOMContentLoaded', add_load_more_listener, false);
 	}
-
 }());

xExtension-StickyFeeds/metadata.json

@@ -2,7 +2,7 @@
 	"name": "Sticky Feeds",
 	"author": "Marien Fressinaud",
 	"description": "Set the feed aside in the main stream following the window scroll.",
-	"version": 0.1,
+	"version": 0.1.1,
 	"entrypoint": "StickyFeeds",
 	"type": "user"
 }

xExtension-StickyFeeds/static/script.js

@@ -1,12 +1,13 @@
-"use strict";
+/* globals $ */
+'use strict';
 
-var sticky_feeds = {
+const sticky_feeds = {
 	aside: null,
 	tree: null,
 	window: null,
 
-	init: function() {
+	init: function () {
-		if (window.matchMedia("(max-width: 840px)").matches) {
+		if (window.matchMedia('(max-width: 840px)').matches) {
 			return;
 		}
 
@@ -34,14 +35,14 @@ var sticky_feeds = {
 		}
 	},
 
-	scroller: function() {
+	scroller: function () {
-		var pos_top_window = sticky_feeds.window.scrollTop();
+		const pos_top_window = sticky_feeds.window.scrollTop();
 
 		if (pos_top_window < sticky_feeds.aside.initial_pos.top + sticky_feeds.tree.initial_pos.top) {
 			// scroll top has not reached the top of the sticky tree yet so it
 			// stays in place but its height must adapted:
 			// window height - sticky tree pos top + actual scroll top
-			var real_tree_pos_top = sticky_feeds.aside.initial_pos.top + sticky_feeds.tree.initial_pos.top;
+			const real_tree_pos_top = sticky_feeds.aside.initial_pos.top + sticky_feeds.tree.initial_pos.top;
 			sticky_feeds.tree.css('top', sticky_feeds.tree.initial_pos.top);
 			sticky_feeds.tree.css('height', sticky_feeds.window.height - real_tree_pos_top + pos_top_window);
 		} else {
@@ -55,5 +56,4 @@ var sticky_feeds = {
 	},
 };
 
-
 window.onload = sticky_feeds.init;