Merge pull request #46 from CMU-17313Q/jshintintegration

Integrating JShint into our Workflow
CMU-17313Q · Oct 30, 2024 · 4c2ff42 · 4c2ff42
2 parents 064ef56 + dc3d914
commit 4c2ff42
Show file tree

Hide file tree

Showing 27 changed files with 116 additions and 35 deletions.
diff --git a/.github/workflows/jshint.yaml b/.github/workflows/jshint.yaml
@@ -0,0 +1,47 @@
+name: JSHint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+defaults:
+  run:
+    shell: bash
+
+permissions:
+  contents: read
+
+jobs:
+  jshint:
+    permissions:
+      checks: write
+      contents: read
+    name: JSHint
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        node: [16]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: cp install/package.json package.json
+
+      - name: Install Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: NPM Install
+        uses: bahmutov/npm-install@v1
+        with:
+          useLockFile: false
+
+      - name: Run JSHint
+        run: npm run jshint
diff --git a/.jshintignore b/.jshintignore
@@ -0,0 +1,11 @@
+node_modules/
+/build
+public/
+test/user.js
+src/topics/unread.js
+src/privileges/helpers.js
+src/meta/css.js
+src/database/mongo/sorted/intersect.js
+src/controllers/helpers.js
+src/constants.js
+src/cli/user.js
diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,22 @@
+{
+    "esversion": 11,
+    "node": true,
+    "mocha": true,
+    "browser": true,
+    "globals": {
+      "jQuery": false,  
+      "$": true,       
+      "ajaxify": false,
+      "config": false,
+      "socket": true,
+      "app": true,
+      "overrides": true,
+      "utils": true,
+      "define": true,
+      "bootbox": true,
+      "escape": true,
+      "alert": true,
+      "self": true,
+      "AbortSignal": true
+    }
+  }
diff --git a/install/docker/mongodb-user-init.js b/install/docker/mongodb-user-init.js
diff --git a/install/package.json b/install/package.json
@@ -14,7 +14,8 @@
         "lint": "eslint --cache ./nodebb .",
         "test": "nyc --reporter=html --reporter=text-summary mocha",
         "coverage": "nyc report --reporter=text-lcov > ./coverage/lcov.info",
-        "coveralls": "nyc report --reporter=text-lcov | coveralls && rm -r coverage"
+        "coveralls": "nyc report --reporter=text-lcov | coveralls && rm -r coverage",
+        "jshint": "jshint ."
     },
     "nyc": {
         "exclude": [

diff --git a/src/api/users.js b/src/api/users.js
@@ -704,7 +704,7 @@ usersAPI.generateExport = async (caller, { uid, type }) => {
 	if (!validTypes.includes(type)) {
 		throw new Error('[[error:invalid-data]]');
 	}
-	if (!utils.isNumber(uid) || !(parseInt(uid, 10) > 0)) {
+	if (!utils.isNumber(uid) || (parseInt(uid, 10) <= 0)) {
 		throw new Error('[[error:invalid-uid]]');
 	}
 	const count = await db.incrObjectField('locks', `export:${uid}${type}`);

diff --git a/src/categories/watch.js b/src/categories/watch.js
@@ -12,15 +12,15 @@ module.exports = function (Categories) {
 	};
 
 	Categories.isIgnored = async function (cids, uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return cids.map(() => false);
 		}
 		const states = await Categories.getWatchState(cids, uid);
 		return states.map(state => state === Categories.watchStates.ignoring);
 	};
 
 	Categories.getWatchState = async function (cids, uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return cids.map(() => Categories.watchStates.notwatching);
 		}
 		if (!Array.isArray(cids) || !cids.length) {

diff --git a/src/controllers/accounts/chats.js b/src/controllers/accounts/chats.js
@@ -101,7 +101,7 @@ chatsController.redirectToMessage = async function (req, res, next) {
 		return next();
 	}
 	const index = await db.sortedSetRank(`chat:room:${roomId}:mids`, mid);
-	if (!(parseInt(index, 10) >= 0)) {
+	if (parseInt(index, 10) < 0) {
 		return next();
 	}
 

diff --git a/src/database/redis/connection.js b/src/database/redis/connection.js
@@ -39,7 +39,7 @@ connection.connect = async function (options) {
 		}
 
 		const dbIdx = parseInt(options.database, 10);
-		if (!(dbIdx >= 0)) {
+		if (dbIdx < 0) {
 			throw new Error('[[error:no-database-selected]]');
 		}
 

diff --git a/src/flags.js b/src/flags.js
@@ -867,7 +867,7 @@ Flags.appendNote = async function (flagId, uid, note, datetime) {
 			await Flags.deleteNote(flagId, datetime);
 		} catch (e) {
 			// Do not throw if note doesn't exist
-			if (!e.message === '[[error:invalid-data]]') {
+			if (e.message !== '[[error:invalid-data]]') {
 				throw e;
 			}
 		}

diff --git a/src/groups/ownership.js b/src/groups/ownership.js
@@ -7,7 +7,7 @@ module.exports = function (Groups) {
 	Groups.ownership = {};
 
 	Groups.ownership.isOwner = async function (uid, groupName) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return false;
 		}
 		return await db.isSetMember(`group:${groupName}:owners`, uid);

diff --git a/src/messaging/rooms.js b/src/messaging/rooms.js
@@ -233,7 +233,7 @@ module.exports = function (Messaging) {
 	};
 
 	Messaging.toggleOwner = async (uid, roomId, state = null) => {
-		if (!(parseInt(uid, 10) > 0) || !roomId) {
+		if (parseInt(uid, 10) <= 0 || !roomId) {
 			throw new Error('[[error:invalid-data]]');
 		}
 

diff --git a/src/messaging/unread.js b/src/messaging/unread.js
@@ -5,7 +5,7 @@ const io = require('../socket.io');
 
 module.exports = function (Messaging) {
 	Messaging.getUnreadCount = async (uid) => {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return 0;
 		}
 

diff --git a/src/meta/configs.js b/src/meta/configs.js
@@ -188,7 +188,7 @@ async function processConfig(data) {
 function ensureInteger(data, field, min) {
 	if (data.hasOwnProperty(field)) {
 		data[field] = parseInt(data[field], 10);
-		if (!(data[field] >= min)) {
+		if (data[field] < min) {
 			throw new Error('[[error:invalid-data]]');
 		}
 	}

diff --git a/src/notifications.js b/src/notifications.js
@@ -329,7 +329,7 @@ Notifications.markRead = async function (nid, uid) {
 };
 
 Notifications.markUnread = async function (nid, uid) {
-	if (!(parseInt(uid, 10) > 0) || !nid) {
+	if ((parseInt(uid, 10) <= 0) || !nid) {
 		return;
 	}
 	const notification = await db.getObject(`notifications:${nid}`);
@@ -346,7 +346,7 @@ Notifications.markUnread = async function (nid, uid) {
 
 Notifications.markReadMultiple = async function (nids, uid) {
 	nids = nids.filter(Boolean);
-	if (!Array.isArray(nids) || !nids.length || !(parseInt(uid, 10) > 0)) {
+	if (!Array.isArray(nids) || !nids.length || (parseInt(uid, 10) <= 0)) {
 		return;
 	}
 

diff --git a/src/socket.io/categories.js b/src/socket.io/categories.js
@@ -142,7 +142,7 @@ SocketCategories.isModerator = async function (socket, cid) {
 SocketCategories.loadMoreSubCategories = async function (socket, data) {
 	sockets.warnDeprecated(socket, `GET /api/v3/categories/:cid/children`);
 
-	if (!data || !data.cid || !(parseInt(data.start, 10) >= 0)) {
+	if (!data || !data.cid || parseInt(data.start, 10) < 0) {
 		throw new Error('[[error:invalid-data]]');
 	}
 

diff --git a/src/socket.io/modules.js b/src/socket.io/modules.js
@@ -112,7 +112,7 @@ SocketModules.chats.leavePublic = async function (socket, roomIds) {
 };
 
 async function joinLeave(socket, roomIds, method, prefix = 'chat_room') {
-	if (!(socket.uid > 0)) {
+	if (socket.uid <= 0) {
 		throw new Error('[[error:not-allowed]]');
 	}
 	if (!Array.isArray(roomIds)) {

diff --git a/src/topics/follow.js b/src/topics/follow.js
@@ -35,7 +35,7 @@ module.exports = function (Topics) {
 	};
 
 	async function setWatching(method1, method2, hook, tid, uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			throw new Error('[[error:not-logged-in]]');
 		}
 		const exists = await Topics.exists(tid);

diff --git a/src/topics/tags.js b/src/topics/tags.js
@@ -570,7 +570,7 @@ module.exports = function (Topics) {
 	};
 
 	Topics.followTag = async (tag, uid) => {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			throw new Error('[[error:not-logged-in]]');
 		}
 		const now = Date.now();
@@ -582,7 +582,7 @@ module.exports = function (Topics) {
 	};
 
 	Topics.unfollowTag = async (tag, uid) => {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			throw new Error('[[error:not-logged-in]]');
 		}
 		await db.sortedSetRemoveBulk([

diff --git a/src/topics/unread.js b/src/topics/unread.js
@@ -202,7 +202,7 @@ module.exports = function (Topics) {
 	}
 
 	async function getWatchedTrackedCids(uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return [];
 		}
 		const cids = await user.getCategoriesByStates(uid, [
@@ -349,7 +349,7 @@ module.exports = function (Topics) {
 	};
 
 	Topics.hasReadTopics = async function (tids, uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return tids.map(() => false);
 		}
 		const [topicScores, userScores, tids_unread, blockedUids] = await Promise.all([

diff --git a/src/user/admin.js b/src/user/admin.js
@@ -14,7 +14,7 @@ const batch = require('../batch');
 
 module.exports = function (User) {
 	User.logIP = async function (uid, ip) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 		const now = Date.now();

diff --git a/src/user/auth.js b/src/user/auth.js
@@ -12,7 +12,7 @@ module.exports = function (User) {
 	User.auth = {};
 
 	User.auth.logAttempt = async function (uid, ip) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 		const exists = await db.exists(`lockout:${uid}`);
@@ -38,7 +38,7 @@ module.exports = function (User) {
 	};
 
 	User.auth.getFeedToken = async function (uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 		const _token = await db.getObjectField(`user:${uid}`, 'rss_token');
@@ -100,7 +100,7 @@ module.exports = function (User) {
 	}
 
 	User.auth.addSession = async function (uid, sessionId) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 

diff --git a/src/user/categories.js b/src/user/categories.js
@@ -8,7 +8,7 @@ const plugins = require('../plugins');
 
 module.exports = function (User) {
 	User.setCategoryWatchState = async function (uid, cids, state) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 		const isStateValid = Object.values(categories.watchStates).includes(parseInt(state, 10));
@@ -24,7 +24,7 @@ module.exports = function (User) {
 	};
 
 	User.getCategoryWatchState = async function (uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return {};
 		}
 
@@ -34,7 +34,7 @@ module.exports = function (User) {
 	};
 
 	User.getIgnoredCategories = async function (uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return [];
 		}
 		const cids = await User.getCategoriesByStates(uid, [categories.watchStates.ignoring]);
@@ -46,7 +46,7 @@ module.exports = function (User) {
 	};
 
 	User.getWatchedCategories = async function (uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return [];
 		}
 		let cids = await User.getCategoriesByStates(uid, [categories.watchStates.watching]);
@@ -61,7 +61,7 @@ module.exports = function (User) {
 
 	User.getCategoriesByStates = async function (uid, states) {
 		const cids = await categories.getAllCidsFromSet('categories:cid');
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return cids;
 		}
 		const userState = await categories.getWatchState(cids, uid);

diff --git a/src/user/email.js b/src/user/email.js
@@ -215,7 +215,7 @@ UserEmail.confirmByCode = async function (code, sessionId) {
 
 // confirm uid's email via ACP
 UserEmail.confirmByUid = async function (uid, callerUid = 0) {
-	if (!(parseInt(uid, 10) > 0)) {
+	if (parseInt(uid, 10) <= 0) {
 		throw new Error('[[error:invalid-uid]]');
 	}
 	callerUid = callerUid || uid;

diff --git a/src/user/index.js b/src/user/index.js
@@ -170,7 +170,7 @@ User.getPrivileges = async function (uid) {
 };
 
 User.isPrivileged = async function (uid) {
-	if (!(parseInt(uid, 10) > 0)) {
+	if (parseInt(uid, 10) <= 0) {
 		return false;
 	}
 	const results = await User.getPrivileges(uid);

diff --git a/src/user/online.js b/src/user/online.js
@@ -7,7 +7,7 @@ const meta = require('../meta');
 
 module.exports = function (User) {
 	User.updateLastOnlineTime = async function (uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 		const userData = await db.getObjectFields(`user:${uid}`, ['userslug', 'status', 'lastonline']);
@@ -19,7 +19,7 @@ module.exports = function (User) {
 	};
 
 	User.updateOnlineUsers = async function (uid) {
-		if (!(parseInt(uid, 10) > 0)) {
+		if (parseInt(uid, 10) <= 0) {
 			return;
 		}
 		const [exists, userOnlineTime] = await Promise.all([

diff --git a/src/user/posts.js b/src/user/posts.js
@@ -130,7 +130,7 @@ module.exports = function (User) {
 
 	async function incrementUserFieldAndSetBy(uid, field, set, value) {
 		value = parseInt(value, 10);
-		if (!value || !field || !(parseInt(uid, 10) > 0)) {
+		if (!value || !field || (parseInt(uid, 10) <= 0)) {
 			return;
 		}
 		const exists = await User.exists(uid);