From dca4e67b3585429709781976a6739858ed03b683 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 15:53:22 +0200 Subject: [PATCH 1/7] Separing frontend and backend code in different folders. --- package.json | 20 +++++++++++--------- main.js => server/main.js | 0 webpack.config.js | 4 ++-- 3 files changed, 13 insertions(+), 11 deletions(-) rename main.js => server/main.js (100%) diff --git a/package.json b/package.json index 7e5a1257..ea1e4e5c 100644 --- a/package.json +++ b/package.json @@ -6,13 +6,13 @@ "bugs": "https://github.com/JohnXLivingston/peertube-plugin-livechat/issues", "clientScripts": [ { - "script": "dist/videowatch-client-plugin.js", + "script": "dist/client/videowatch-client-plugin.js", "scopes": [ "video-watch" ] }, { - "script": "dist/common-client-plugin.js", + "script": "dist/client/common-client-plugin.js", "scopes": [ "common" ] @@ -43,20 +43,22 @@ "peertube", "plugin" ], - "library": "./main.js", + "library": "./dist/server/main.js", "scripts": { "clean": "rm -rf dist/*", "prepare": "npm run build", - "build:converse": "mkdir -p dist/conversejs && cp -r node_modules/converse.js/dist/* dist/conversejs/", - "build:images": "mkdir -p dist/images && npx svgo -f public/images/ -o dist/images/", + "build:converse": "mkdir -p dist/client/conversejs && cp -r node_modules/converse.js/dist/* dist/client/conversejs/", + "build:images": "mkdir -p dist/client/images && npx svgo -f public/images/ -o dist/client/images/", "build:webpack": "webpack --mode=production", - "build": "npm-run-all -s clean -p build:converse build:images build:webpack", + "build:server": "mkdir -p dist/server && cp ./server/main.js dist/server/", + "build:serverconverse": "mkdir -p dist/server/conversejs && cp conversejs/index.html dist/server/conversejs/", + "build": "npm-run-all -s clean -p build:converse build:images build:webpack build:server build:serverconverse", "lint": "npx eslint --ext .js ." }, "staticDirs": { - "static": "dist/static", - "conversejs": "dist/conversejs/", - "images": "dist/images/" + "static": "dist/client/static", + "conversejs": "dist/client/conversejs/", + "images": "dist/client/images/" }, "translations": { "fr-FR": "./languages/fr.json" diff --git a/main.js b/server/main.js similarity index 100% rename from main.js rename to server/main.js diff --git a/webpack.config.js b/webpack.config.js index db1d51f2..e370961b 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -10,7 +10,7 @@ const clientFiles = [ let config = clientFiles.map(f => ({ entry: "./client/" + f, output: { - path: path.resolve(__dirname, "./dist"), + path: path.resolve(__dirname, "./dist/client"), filename: "./" + f, library: "script", libraryTarget: "var" @@ -21,7 +21,7 @@ let config = clientFiles.map(f => ({ config.push({ entry: "./conversejs/builtin.js", output: { - path: path.resolve(__dirname, "./dist/static"), + path: path.resolve(__dirname, "./dist/client/static"), filename: "./builtin.js" } }) From 8b11c10e32c496424cb0bd615ede06f8ef01f557 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 16:52:38 +0200 Subject: [PATCH 2/7] Server code in typescript. --- package-lock.json | 88 +++++++++++++++++++++++++++++++++++++ package.json | 6 ++- server/{main.js => main.ts} | 32 ++++++++++---- server/tsconfig.json | 27 ++++++++++++ 4 files changed, 143 insertions(+), 10 deletions(-) rename server/{main.js => main.ts} (91%) create mode 100644 server/tsconfig.json diff --git a/package-lock.json b/package-lock.json index 678e31b5..fcdfa1cc 100644 --- a/package-lock.json +++ b/package-lock.json @@ -98,12 +98,94 @@ "integrity": "sha512-Z6DoceYb/1xSg5+e+ZlPZ9v0N16ZvZ+wYMraFue4HYrE4ttONKtsvruIRf6t9TBR0YvSOfi1hUU0fJfBLCDYow==", "dev": true }, + "@tsconfig/node12": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.7.tgz", + "integrity": "sha512-dgasobK/Y0wVMswcipr3k0HpevxFJLijN03A8mYfEPvWvOs14v0ZlYTR4kIgMx8g4+fTyTFv8/jLCIfRqLDJ4A==", + "dev": true + }, + "@types/body-parser": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.0.tgz", + "integrity": "sha512-W98JrE0j2K78swW4ukqMleo8R7h/pFETjM2DQ90MF6XK2i4LO4W3gQ71Lt4w3bfm2EvVSyWHplECvB5sK22yFQ==", + "dev": true, + "requires": { + "@types/connect": "*", + "@types/node": "*" + } + }, + "@types/connect": { + "version": "3.4.34", + "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.34.tgz", + "integrity": "sha512-ePPA/JuI+X0vb+gSWlPKOY0NdNAie/rPUqX2GUPpbZwiKTkSPhjXWuee47E4MtE54QVzGCQMQkAL6JhV2E1+cQ==", + "dev": true, + "requires": { + "@types/node": "*" + } + }, + "@types/express": { + "version": "4.17.11", + "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.11.tgz", + "integrity": "sha512-no+R6rW60JEc59977wIxreQVsIEOAYwgCqldrA/vkpCnbD7MqTefO97lmoBe4WE0F156bC4uLSP1XHDOySnChg==", + "dev": true, + "requires": { + "@types/body-parser": "*", + "@types/express-serve-static-core": "^4.17.18", + "@types/qs": "*", + "@types/serve-static": "*" + } + }, + "@types/express-serve-static-core": { + "version": "4.17.19", + "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.19.tgz", + "integrity": "sha512-DJOSHzX7pCiSElWaGR8kCprwibCB/3yW6vcT8VG3P0SJjnv19gnWG/AZMfM60Xj/YJIp/YCaDHyvzsFVeniARA==", + "dev": true, + "requires": { + "@types/node": "*", + "@types/qs": "*", + "@types/range-parser": "*" + } + }, "@types/json5": { "version": "0.0.29", "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", "integrity": "sha1-7ihweulOEdK4J7y+UnC86n8+ce4=", "dev": true }, + "@types/mime": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.2.tgz", + "integrity": "sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw==", + "dev": true + }, + "@types/node": { + "version": "14.14.37", + "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.37.tgz", + "integrity": "sha512-XYmBiy+ohOR4Lh5jE379fV2IU+6Jn4g5qASinhitfyO71b/sCo6MKsMLF5tc7Zf2CE8hViVQyYSobJNke8OvUw==", + "dev": true + }, + "@types/qs": { + "version": "6.9.6", + "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.6.tgz", + "integrity": "sha512-0/HnwIfW4ki2D8L8c9GVcG5I72s9jP5GSLVF0VIXDW00kmIpA6O33G7a8n59Tmh7Nz0WUC3rSb7PTY/sdW2JzA==", + "dev": true + }, + "@types/range-parser": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.3.tgz", + "integrity": "sha512-ewFXqrQHlFsgc09MK5jP5iR7vumV/BYayNC6PgJO2LPe8vrnNFyjQjSppfEngITi0qvfKtzFvgKymGheFM9UOA==", + "dev": true + }, + "@types/serve-static": { + "version": "1.13.9", + "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.13.9.tgz", + "integrity": "sha512-ZFqF6qa48XsPdjXV5Gsz0Zqmux2PerNd3a/ktL45mHpa19cuMi/cL8tcxdAx497yRh+QtYPuofjT9oWw9P7nkA==", + "dev": true, + "requires": { + "@types/mime": "^1", + "@types/node": "*" + } + }, "@webassemblyjs/ast": { "version": "1.8.5", "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.8.5.tgz", @@ -4843,6 +4925,12 @@ "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", "dev": true }, + "typescript": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.2.3.tgz", + "integrity": "sha512-qOcYwxaByStAWrBf4x0fibwZvMRG+r4cQoTjbPtUlrWjBHbmCAww1i448U0GJ+3cNNEtebDteo/cHOR3xJ4wEw==", + "dev": true + }, "union-value": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/union-value/-/union-value-1.0.1.tgz", diff --git a/package.json b/package.json index ea1e4e5c..f2bd3313 100644 --- a/package.json +++ b/package.json @@ -24,6 +24,9 @@ "dependencies": {}, "devDependencies": { "@purtuga/esm-webpack-plugin": "^1.1.1", + "@tsconfig/node12": "^1.0.7", + "@types/express": "^4.17.11", + "@types/node": "^14.14.37", "converse.js": "^7.0.5", "eslint": "^7.20.0", "eslint-config-standard": "^16.0.2", @@ -32,6 +35,7 @@ "eslint-plugin-promise": "^4.3.1", "npm-run-all": "^4.1.5", "svgo": "^2.2.1", + "typescript": "^4.2.3", "webpack": "^4.41.2", "webpack-cli": "^3.3.10" }, @@ -50,7 +54,7 @@ "build:converse": "mkdir -p dist/client/conversejs && cp -r node_modules/converse.js/dist/* dist/client/conversejs/", "build:images": "mkdir -p dist/client/images && npx svgo -f public/images/ -o dist/client/images/", "build:webpack": "webpack --mode=production", - "build:server": "mkdir -p dist/server && cp ./server/main.js dist/server/", + "build:server": "npx tsc --build server/tsconfig.json", "build:serverconverse": "mkdir -p dist/server/conversejs && cp conversejs/index.html dist/server/conversejs/", "build": "npm-run-all -s clean -p build:converse build:images build:webpack build:server build:serverconverse", "lint": "npx eslint --ext .js ." diff --git a/server/main.js b/server/main.ts similarity index 91% rename from server/main.js rename to server/main.ts index be6fea39..d99e44ae 100644 --- a/server/main.js +++ b/server/main.ts @@ -1,17 +1,31 @@ +import type { NextFunction, Request, Response } from 'express' + const path = require('path') const fs = require('fs').promises +type RegisterServerOptions = { + registerHook: any, + registerSetting: any, + settingsManager: any, + storageManager: any, + videoCategoryManager: any, + videoLicenceManager: any, + videoLanguageManager: any, + getRouter: any, + peertubeHelpers: any +} + async function register ({ - _registerHook, + registerHook, registerSetting, settingsManager, - _storageManager, - _videoCategoryManager, - _videoLicenceManager, - _videoLanguageManager, + storageManager, + videoCategoryManager, + videoLicenceManager, + videoLanguageManager, getRouter, peertubeHelpers -}) { +}: RegisterServerOptions): Promise { registerSetting({ name: 'chat-auto-display', label: 'Automatically open the chat', @@ -142,8 +156,8 @@ async function register ({ const converseJSIndex = await fs.readFile(path.resolve(__dirname, './conversejs/index.html')) const router = getRouter() - router.get('/ping', (req, res) => res.json({ message: 'pong' })) - router.get('/webchat', async (req, res, next) => { + router.get('/ping', (req: Request, res: Response) => res.json({ message: 'pong' })) + router.get('/webchat', async (req: Request, res: Response, next: NextFunction) => { try { const settings = await settingsManager.getSettings([ 'chat-use-builtin', 'chat-room', 'chat-server', @@ -168,7 +182,7 @@ async function register ({ // be /webchat/:videoId // const id = req.param('videoId') // const video = await peertubeHelpers.videos.loadByIdOrUUID(id) - let url = req.query.url + let url: string = req.query.url as string || '' if (!url) { throw new Error('Missing url parameter)') } diff --git a/server/tsconfig.json b/server/tsconfig.json new file mode 100644 index 00000000..2639a901 --- /dev/null +++ b/server/tsconfig.json @@ -0,0 +1,27 @@ +{ + "extends": "@tsconfig/node12/tsconfig.json", + "compilerOptions": { + "moduleResolution": "node", // Tell tsc to look in node_modules for modules + "strict": true, // That implies alwaysStrict, noImplicitAny, noImplicitThis + + "alwaysStrict": true, // should already be true because of strict:true + "noImplicitAny": true, // should already be true because of strict:true + "noImplicitThis": true, // should already be true because of strict:true + "noImplicitReturns": true, + "strictBindCallApply": true, // should already be true because of strict:true + "noUnusedLocals": true, + + "removeComments": true, + "sourceMap": true, + + // "composite": true, + // "declaration": true, + // "tsBuildInfoFile": "./dist/server/main.tsbuildinfo", + // "rootDir": "server", + "outDir": "../dist/server", + // "baseUrl": "./server/", + "paths": {}, + }, + "include": ["./**/*"], + "exclude": [] +} From 3dd87187443eb7aedbf773ff644fe53ba8eea0ef Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 17:20:28 +0200 Subject: [PATCH 3/7] Eslint: configure for standard-typescript (backend), and separate configurations depending on folders. --- .eslintrc.json | 20 +- client/.eslintrc.json | 23 +++ conversejs/.eslintrc.json | 23 +++ package-lock.json | 417 +++++++++++++++++++++++++++++++++++++- package.json | 6 +- server/.eslintrc.json | 44 ++++ server/main.ts | 27 +-- 7 files changed, 524 insertions(+), 36 deletions(-) create mode 100644 client/.eslintrc.json create mode 100644 conversejs/.eslintrc.json create mode 100644 server/.eslintrc.json diff --git a/.eslintrc.json b/.eslintrc.json index 38def648..b3555b29 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -1,23 +1,9 @@ { "root": true, - "env": { - "browser": true, - "es6": true - }, - "extends": [ - "standard" - ], + "env": {}, + "extends": [], "globals": {}, "plugins": [], "ignorePatterns": ["node_modules/", "dist/", "webpack.config.js"], - "rules": { - "max-len": [ - "error", - { - "code": 120, - "comments": 120 - } - ], - "no-unused-vars": [2, {"argsIgnorePattern": "^_"}] - } + "rules": {} } diff --git a/client/.eslintrc.json b/client/.eslintrc.json new file mode 100644 index 00000000..4ad2d1a6 --- /dev/null +++ b/client/.eslintrc.json @@ -0,0 +1,23 @@ +{ + "root": true, + "env": { + "browser": true, + "es6": true + }, + "extends": [ + "standard" + ], + "globals": {}, + "plugins": [], + "ignorePatterns": [], + "rules": { + "max-len": [ + "error", + { + "code": 120, + "comments": 120 + } + ], + "no-unused-vars": [2, {"argsIgnorePattern": "^_"}] + } +} diff --git a/conversejs/.eslintrc.json b/conversejs/.eslintrc.json new file mode 100644 index 00000000..4ad2d1a6 --- /dev/null +++ b/conversejs/.eslintrc.json @@ -0,0 +1,23 @@ +{ + "root": true, + "env": { + "browser": true, + "es6": true + }, + "extends": [ + "standard" + ], + "globals": {}, + "plugins": [], + "ignorePatterns": [], + "rules": { + "max-len": [ + "error", + { + "code": 120, + "comments": 120 + } + ], + "no-unused-vars": [2, {"argsIgnorePattern": "^_"}] + } +} diff --git a/package-lock.json b/package-lock.json index fcdfa1cc..a04ef4c6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -83,6 +83,32 @@ } } }, + "@nodelib/fs.scandir": { + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.4.tgz", + "integrity": "sha512-33g3pMJk3bg5nXbL/+CY6I2eJDzZAni49PfJnL5fghPTggPvBd/pFNSgJsdAgWptuFu7qq/ERvOYFlhvsLTCKA==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "2.0.4", + "run-parallel": "^1.1.9" + } + }, + "@nodelib/fs.stat": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.4.tgz", + "integrity": "sha512-IYlHJA0clt2+Vg7bccq+TzRdJvv19c2INqBSsoOLp1je7xjtr7J26+WXR72MCdvU9q1qTzIWDfhMf+DRvQJK4Q==", + "dev": true + }, + "@nodelib/fs.walk": { + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.6.tgz", + "integrity": "sha512-8Broas6vTtW4GIXTAHDoE32hnN2M5ykgCpWGbuXHQ15vEMqr23pB76e/GZcYsZCHALv50ktd24qhEyKr6wBtow==", + "dev": true, + "requires": { + "@nodelib/fs.scandir": "2.1.4", + "fastq": "^1.6.0" + } + }, "@purtuga/esm-webpack-plugin": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/@purtuga/esm-webpack-plugin/-/esm-webpack-plugin-1.1.1.tgz", @@ -146,6 +172,12 @@ "@types/range-parser": "*" } }, + "@types/json-schema": { + "version": "7.0.7", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.7.tgz", + "integrity": "sha512-cxWFQVseBm6O9Gbw1IWb8r6OS4OhSt3hPZLkFApLjM8TEXROBuQGLAH2i2gZpcXdLBIrpXuTDhH7Vbm1iXmNGA==", + "dev": true + }, "@types/json5": { "version": "0.0.29", "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz", @@ -186,6 +218,217 @@ "@types/node": "*" } }, + "@typescript-eslint/eslint-plugin": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.21.0.tgz", + "integrity": "sha512-FPUyCPKZbVGexmbCFI3EQHzCZdy2/5f+jv6k2EDljGdXSRc0cKvbndd2nHZkSLqCNOPk0jB6lGzwIkglXcYVsQ==", + "dev": true, + "requires": { + "@typescript-eslint/experimental-utils": "4.21.0", + "@typescript-eslint/scope-manager": "4.21.0", + "debug": "^4.1.1", + "functional-red-black-tree": "^1.0.1", + "lodash": "^4.17.15", + "regexpp": "^3.0.0", + "semver": "^7.3.2", + "tsutils": "^3.17.1" + }, + "dependencies": { + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, + "@typescript-eslint/experimental-utils": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.21.0.tgz", + "integrity": "sha512-cEbgosW/tUFvKmkg3cU7LBoZhvUs+ZPVM9alb25XvR0dal4qHL3SiUqHNrzoWSxaXA9gsifrYrS1xdDV6w/gIA==", + "dev": true, + "requires": { + "@types/json-schema": "^7.0.3", + "@typescript-eslint/scope-manager": "4.21.0", + "@typescript-eslint/types": "4.21.0", + "@typescript-eslint/typescript-estree": "4.21.0", + "eslint-scope": "^5.0.0", + "eslint-utils": "^2.0.0" + }, + "dependencies": { + "eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "requires": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + } + }, + "esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "requires": { + "estraverse": "^5.2.0" + }, + "dependencies": { + "estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true + } + } + } + } + }, + "@typescript-eslint/parser": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.21.0.tgz", + "integrity": "sha512-eyNf7QmE5O/l1smaQgN0Lj2M/1jOuNg2NrBm1dqqQN0sVngTLyw8tdCbih96ixlhbF1oINoN8fDCyEH9SjLeIA==", + "dev": true, + "requires": { + "@typescript-eslint/scope-manager": "4.21.0", + "@typescript-eslint/types": "4.21.0", + "@typescript-eslint/typescript-estree": "4.21.0", + "debug": "^4.1.1" + }, + "dependencies": { + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + } + } + }, + "@typescript-eslint/scope-manager": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.21.0.tgz", + "integrity": "sha512-kfOjF0w1Ix7+a5T1knOw00f7uAP9Gx44+OEsNQi0PvvTPLYeXJlsCJ4tYnDj5PQEYfpcgOH5yBlw7K+UEI9Agw==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.21.0", + "@typescript-eslint/visitor-keys": "4.21.0" + } + }, + "@typescript-eslint/types": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.21.0.tgz", + "integrity": "sha512-+OQaupjGVVc8iXbt6M1oZMwyKQNehAfLYJJ3SdvnofK2qcjfor9pEM62rVjBknhowTkh+2HF+/KdRAc/wGBN2w==", + "dev": true + }, + "@typescript-eslint/typescript-estree": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.21.0.tgz", + "integrity": "sha512-ZD3M7yLaVGVYLw4nkkoGKumb7Rog7QID9YOWobFDMQKNl+vPxqVIW/uDk+MDeGc+OHcoG2nJ2HphwiPNajKw3w==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.21.0", + "@typescript-eslint/visitor-keys": "4.21.0", + "debug": "^4.1.1", + "globby": "^11.0.1", + "is-glob": "^4.0.1", + "semver": "^7.3.2", + "tsutils": "^3.17.1" + }, + "dependencies": { + "debug": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", + "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", + "dev": true, + "requires": { + "ms": "2.1.2" + } + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, + "@typescript-eslint/visitor-keys": { + "version": "4.21.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.21.0.tgz", + "integrity": "sha512-dH22dROWGi5Z6p+Igc8bLVLmwy7vEe8r+8c+raPQU0LxgogPUrRAtRGtvBWmlr9waTu3n+QLt/qrS/hWzk1x5w==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.21.0", + "eslint-visitor-keys": "^2.0.0" + } + }, "@webassemblyjs/ast": { "version": "1.8.5", "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.8.5.tgz", @@ -488,6 +731,12 @@ "is-string": "^1.0.5" } }, + "array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true + }, "array-unique": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", @@ -1338,6 +1587,23 @@ "randombytes": "^2.0.0" } }, + "dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, + "requires": { + "path-type": "^4.0.0" + }, + "dependencies": { + "path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true + } + } + }, "doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -1765,6 +2031,16 @@ "integrity": "sha512-fx3f1rJDsl9bY7qzyX8SAtP8GBSk6MfXFaTfaGgk12aAYW4gJSyRm7dM790L6cbXv63fvjY4XeSzXnb4WM+SKw==", "dev": true }, + "eslint-config-standard-with-typescript": { + "version": "20.0.0", + "resolved": "https://registry.npmjs.org/eslint-config-standard-with-typescript/-/eslint-config-standard-with-typescript-20.0.0.tgz", + "integrity": "sha512-IoySf3r0a2+P3Z6GMjv8p1HuOQ6GWQbMpdt9G8uEbkGpnNWAGBXpgaiutbZHbaQAvG5pkVtYepCfHUxYbVDLCA==", + "dev": true, + "requires": { + "@typescript-eslint/parser": "^4.0.0", + "eslint-config-standard": "^16.0.0" + } + }, "eslint-import-resolver-node": { "version": "0.3.4", "resolved": "https://registry.npmjs.org/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.4.tgz", @@ -1916,6 +2192,12 @@ "integrity": "sha512-bY2sGqyptzFBDLh/GMbAxfdJC+b0f23ME63FOE4+Jao0oZ3E1LEwFtWJX/1pGMJLiTtrSSern2CRM/g+dfc0eQ==", "dev": true }, + "eslint-plugin-standard": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-standard/-/eslint-plugin-standard-5.0.0.tgz", + "integrity": "sha512-eSIXPc9wBM4BrniMzJRBm2uoVuXz2EPa+NXPk2+itrVt+r5SbKFERx/IgrK/HmfjddyKVz2f+j+7gBRvu19xLg==", + "dev": true + }, "eslint-scope": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-4.0.3.tgz", @@ -2185,6 +2467,65 @@ "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=", "dev": true }, + "fast-glob": { + "version": "3.2.5", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.5.tgz", + "integrity": "sha512-2DtFcgT68wiTTiwZ2hNdJfcHNke9XOfnwmBRWXhmeKM8rF0TGwmC/Qto3S7RoZKp5cilZbxzO5iTNTQsJ+EeDg==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.0", + "merge2": "^1.3.0", + "micromatch": "^4.0.2", + "picomatch": "^2.2.1" + }, + "dependencies": { + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.0.5" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + } + } + }, "fast-json-stable-stringify": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz", @@ -2197,6 +2538,15 @@ "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", "dev": true }, + "fastq": { + "version": "1.11.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.11.0.tgz", + "integrity": "sha512-7Eczs8gIPDrVzT+EksYBcupqMyxSHXXrHOLRRxU2/DicV8789MRBRR8+Hc2uWzUupOs4YS4JzBmBxjjCVBxD/g==", + "dev": true, + "requires": { + "reusify": "^1.0.4" + } + }, "figgy-pudding": { "version": "3.5.2", "resolved": "https://registry.npmjs.org/figgy-pudding/-/figgy-pudding-3.5.2.tgz", @@ -2465,6 +2815,28 @@ "type-fest": "^0.8.1" } }, + "globby": { + "version": "11.0.3", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", + "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==", + "dev": true, + "requires": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.1.1", + "ignore": "^5.1.4", + "merge2": "^1.3.0", + "slash": "^3.0.0" + }, + "dependencies": { + "ignore": { + "version": "5.1.8", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", + "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", + "dev": true + } + } + }, "graceful-fs": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.3.tgz", @@ -3107,6 +3479,12 @@ "integrity": "sha1-htcJCzDORV1j+64S3aUaR93K+bI=", "dev": true }, + "merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true + }, "micromatch": { "version": "3.1.10", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-3.1.10.tgz", @@ -3724,8 +4102,7 @@ "version": "2.2.2", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.2.2.tgz", "integrity": "sha512-q0M/9eZHzmr0AulXyPwNfZjtwZ/RBZlbN3K3CErVrk50T2ASYI7Bye0EvekFY3IP1Nt2DHu0re+V2ZHIpMkuWg==", - "dev": true, - "optional": true + "dev": true }, "pidtree": { "version": "0.3.1", @@ -3855,6 +4232,12 @@ "integrity": "sha1-nsYfeQSYdXB9aUFFlv2Qek1xHnM=", "dev": true }, + "queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true + }, "randombytes": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", @@ -4078,6 +4461,12 @@ "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", "dev": true }, + "reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true + }, "rimraf": { "version": "2.7.1", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.7.1.tgz", @@ -4097,6 +4486,15 @@ "inherits": "^2.0.1" } }, + "run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "requires": { + "queue-microtask": "^1.2.2" + } + }, "run-queue": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/run-queue/-/run-queue-1.0.3.tgz", @@ -4219,6 +4617,12 @@ "integrity": "sha1-tf3AjxKH6hF4Yo5BXiUTK3NkbG0=", "dev": true }, + "slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true + }, "slice-ansi": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", @@ -4898,6 +5302,15 @@ "integrity": "sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==", "dev": true }, + "tsutils": { + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", + "dev": true, + "requires": { + "tslib": "^1.8.1" + } + }, "tty-browserify": { "version": "0.0.0", "resolved": "https://registry.npmjs.org/tty-browserify/-/tty-browserify-0.0.0.tgz", diff --git a/package.json b/package.json index f2bd3313..546970f8 100644 --- a/package.json +++ b/package.json @@ -27,12 +27,16 @@ "@tsconfig/node12": "^1.0.7", "@types/express": "^4.17.11", "@types/node": "^14.14.37", + "@typescript-eslint/eslint-plugin": "^4.21.0", + "@typescript-eslint/parser": "^4.21.0", "converse.js": "^7.0.5", "eslint": "^7.20.0", "eslint-config-standard": "^16.0.2", + "eslint-config-standard-with-typescript": "^20.0.0", "eslint-plugin-import": "^2.22.1", "eslint-plugin-node": "^11.1.0", "eslint-plugin-promise": "^4.3.1", + "eslint-plugin-standard": "^5.0.0", "npm-run-all": "^4.1.5", "svgo": "^2.2.1", "typescript": "^4.2.3", @@ -57,7 +61,7 @@ "build:server": "npx tsc --build server/tsconfig.json", "build:serverconverse": "mkdir -p dist/server/conversejs && cp conversejs/index.html dist/server/conversejs/", "build": "npm-run-all -s clean -p build:converse build:images build:webpack build:server build:serverconverse", - "lint": "npx eslint --ext .js ." + "lint": "npx eslint --ext .js --ext .ts ." }, "staticDirs": { "static": "dist/client/static", diff --git a/server/.eslintrc.json b/server/.eslintrc.json new file mode 100644 index 00000000..aeec0a18 --- /dev/null +++ b/server/.eslintrc.json @@ -0,0 +1,44 @@ +{ + "root": true, + "env": { + "browser": false, + "es6": true + }, + "extends": [ + "standard-with-typescript" + ], + "globals": { + "Atomics": "readonly", + "SharedArrayBuffer": "readonly", + "BUILD": true + }, + "parser": "@typescript-eslint/parser", + "parserOptions": { + "ecmaVersion": 2018, + "project": [ + "./server/tsconfig.json" + ] + }, + "plugins": [ + "@typescript-eslint" + ], + "ignorePatterns": [], + "rules": { + "@typescript-eslint/no-unused-vars": [2, {"argsIgnorePattern": "^_"}], + "@typescript-eslint/no-floating-promises": "error", + "@typescript-eslint/no-misused-promises": "error", + "@typescript-eslint/no-var-requires": "off", + "@typescript-eslint/strict-boolean-expressions": "off", + "@typescript-eslint/return-await": [2, "in-try-catch"], // FIXME: correct? + "@typescript-eslint/no-invalid-void-type": "off", + "@typescript-eslint/triple-slash-reference": "off", + "max-len": [ + "error", + { + "code": 120, + "comments": 120 + } + ], + "no-unused-vars": "off" + } +} diff --git a/server/main.ts b/server/main.ts index d99e44ae..ac55b32c 100644 --- a/server/main.ts +++ b/server/main.ts @@ -3,26 +3,21 @@ import type { NextFunction, Request, Response } from 'express' const path = require('path') const fs = require('fs').promises -type RegisterServerOptions = { - registerHook: any, - registerSetting: any, - settingsManager: any, - storageManager: any, - videoCategoryManager: any, - videoLicenceManager: any, - videoLanguageManager: any, - getRouter: any, +interface RegisterServerOptions { + registerHook: any + registerSetting: any + settingsManager: any + storageManager: any + videoCategoryManager: any + videoLicenceManager: any + videoLanguageManager: any + getRouter: any peertubeHelpers: any } async function register ({ - registerHook, registerSetting, settingsManager, - storageManager, - videoCategoryManager, - videoLicenceManager, - videoLanguageManager, getRouter, peertubeHelpers }: RegisterServerOptions): Promise { @@ -197,7 +192,7 @@ async function register ({ throw new Error('Video not found') } - let page = '' + converseJSIndex + let page = '' + (converseJSIndex as string) // FIXME: Peertube should provide the static folder path. For now: const staticRelative = '../static' page = page.replace(/{{BASE_STATIC_URL}}/g, staticRelative) @@ -216,7 +211,7 @@ async function register ({ }) } -async function unregister () { +async function unregister (): Promise { } module.exports = { From 89a03032ff03282e4912ecf9af75ad834e2b1d30 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 17:26:30 +0200 Subject: [PATCH 4/7] Clean tsconfig file. --- server/tsconfig.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/server/tsconfig.json b/server/tsconfig.json index 2639a901..5955d391 100644 --- a/server/tsconfig.json +++ b/server/tsconfig.json @@ -14,12 +14,7 @@ "removeComments": true, "sourceMap": true, - // "composite": true, - // "declaration": true, - // "tsBuildInfoFile": "./dist/server/main.tsbuildinfo", - // "rootDir": "server", "outDir": "../dist/server", - // "baseUrl": "./server/", "paths": {}, }, "include": ["./**/*"], From 3e46552ec0ba20d89f7c6d3c93b15266276c4bbe Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 18:14:58 +0200 Subject: [PATCH 5/7] Typescript for frontend code. --- client/.eslintrc.json | 39 +++-- ...ient-plugin.js => common-client-plugin.ts} | 2 +- client/peertube.d.ts | 11 ++ client/tsconfig.json | 20 +++ ...-plugin.js => videowatch-client-plugin.ts} | 134 ++++++++------- package-lock.json | 157 ++++++++++++++++++ package.json | 1 + webpack.config.js | 16 +- 8 files changed, 302 insertions(+), 78 deletions(-) rename client/{common-client-plugin.js => common-client-plugin.ts} (81%) create mode 100644 client/peertube.d.ts create mode 100644 client/tsconfig.json rename client/{videowatch-client-plugin.js => videowatch-client-plugin.ts} (67%) diff --git a/client/.eslintrc.json b/client/.eslintrc.json index 4ad2d1a6..7132d963 100644 --- a/client/.eslintrc.json +++ b/client/.eslintrc.json @@ -5,19 +5,36 @@ "es6": true }, "extends": [ - "standard" + "standard-with-typescript" ], "globals": {}, - "plugins": [], + "parser": "@typescript-eslint/parser", + "parserOptions": { + "ecmaVersion": 2018, + "project": [ + "./client/tsconfig.json" + ] + }, + "plugins": [ + "@typescript-eslint" + ], "ignorePatterns": [], "rules": { - "max-len": [ - "error", - { - "code": 120, - "comments": 120 - } - ], - "no-unused-vars": [2, {"argsIgnorePattern": "^_"}] - } + "@typescript-eslint/no-unused-vars": [2, {"argsIgnorePattern": "^_"}], + "@typescript-eslint/no-floating-promises": "error", + "@typescript-eslint/no-misused-promises": "error", + "@typescript-eslint/no-var-requires": "off", + "@typescript-eslint/strict-boolean-expressions": "off", + "@typescript-eslint/return-await": [2, "in-try-catch"], // FIXME: correct? + "@typescript-eslint/no-invalid-void-type": "off", + "@typescript-eslint/triple-slash-reference": "off", + "max-len": [ + "error", + { + "code": 120, + "comments": 120 + } + ], + "no-unused-vars": "off" + } } diff --git a/client/common-client-plugin.js b/client/common-client-plugin.ts similarity index 81% rename from client/common-client-plugin.js rename to client/common-client-plugin.ts index 3e233faf..6babffee 100644 --- a/client/common-client-plugin.js +++ b/client/common-client-plugin.ts @@ -1,7 +1,7 @@ 'use strict' -function register ({ registerHook, _peertubeHelpers }) { +function register ({ registerHook }: RegisterOptions): void { registerHook({ target: 'action:router.navigation-end', handler: () => { diff --git a/client/peertube.d.ts b/client/peertube.d.ts new file mode 100644 index 00000000..683e3a37 --- /dev/null +++ b/client/peertube.d.ts @@ -0,0 +1,11 @@ +interface RegisterOptions { + registerHook: any + peertubeHelpers: any +} + +interface Video { + isLive: boolean + isLocal: boolean + originInstanceUrl: string + uuid: string +} diff --git a/client/tsconfig.json b/client/tsconfig.json new file mode 100644 index 00000000..89e45dbc --- /dev/null +++ b/client/tsconfig.json @@ -0,0 +1,20 @@ +{ + "compilerOptions": { + "module": "es6", + "target": "es5", + "allowJs": true, + "sourceMap": true, + "forceConsistentCasingInFileNames": true, + "strict": true, + "alwaysStrict": true, // should already be true because of strict:true + "noImplicitAny": true, // should already be true because of strict:true + "noImplicitThis": true, // should already be true because of strict:true + "noImplicitReturns": true, + "strictBindCallApply": true, // should already be true because of strict:true + "noUnusedLocals": true, + "outDir": "../dist/client", + "paths": {} + }, + "include": ["./**/*"], + "exclude": [] +} diff --git a/client/videowatch-client-plugin.js b/client/videowatch-client-plugin.ts similarity index 67% rename from client/videowatch-client-plugin.js rename to client/videowatch-client-plugin.ts index d58611bc..5b6ffa98 100644 --- a/client/videowatch-client-plugin.js +++ b/client/videowatch-client-plugin.ts @@ -1,18 +1,20 @@ 'use strict' -function register ({ registerHook, peertubeHelpers }) { +interface VideoCache {[key: string]: Video} + +function register ({ registerHook, peertubeHelpers }: RegisterOptions): void { const logger = { - log: (s) => console.log('[peertube-plugin-livechat] ' + s), - info: (s) => console.info('[peertube-plugin-livechat] ' + s), - error: (s) => console.error('[peertube-plugin-livechat] ' + s), - warn: (s) => console.warn('[peertube-plugin-livechat] ' + s) + log: (s: string) => console.log('[peertube-plugin-livechat] ' + s), + info: (s: string) => console.info('[peertube-plugin-livechat] ' + s), + error: (s: string) => console.error('[peertube-plugin-livechat] ' + s), + warn: (s: string) => console.warn('[peertube-plugin-livechat] ' + s) } - const videoCache = {} - let lastUUID = null - let settings = {} + const videoCache: VideoCache = {} + let lastUUID: string | null = null + let settings: any = {} - function parseUUIDs (s) { + function parseUUIDs (s: string): string[] { if (!s) { return [] } @@ -25,7 +27,7 @@ function register ({ registerHook, peertubeHelpers }) { return a.filter(line => line !== '') } - function getBaseRoute () { + function getBaseRoute (): string { // FIXME: should be provided by PeertubeHelpers (does not exists for now) // We are guessing the route with the correct plugin version with this trick: const staticBase = peertubeHelpers.getBaseStaticRoute() @@ -33,7 +35,7 @@ function register ({ registerHook, peertubeHelpers }) { return staticBase.replace(/\/static.*$/, '/router') } - function getIframeUri (uuid) { + function getIframeUri (uuid: string): string | null { if (!settings) { logger.error('Settings are not initialized, too soon to compute the iframeUri') return null @@ -52,7 +54,7 @@ function register ({ registerHook, peertubeHelpers }) { // we need to pass the complete url. const video = videoCache[uuid] if (video) { - const url = video.originInstanceUrl + '/videos/watch/' + uuid + const url: string = video.originInstanceUrl + '/videos/watch/' + uuid iframeUri = getBaseRoute() + '/webchat?url=' + encodeURIComponent(url) } } @@ -63,7 +65,13 @@ function register ({ registerHook, peertubeHelpers }) { return iframeUri } - function displayButton (buttonContainer, name, label, callback, icon) { + function displayButton ( + buttonContainer: HTMLElement, + name: string, + label: string, + callback: () => void | boolean, + icon: string | null + ): void { const button = document.createElement('button') button.classList.add( 'peertube-plugin-livechat-button', @@ -71,7 +79,8 @@ function register ({ registerHook, peertubeHelpers }) { ) button.onclick = callback if (icon) { - const iconUrl = peertubeHelpers.getBaseStaticRoute() + '/images/' + icon + // FIXME: remove «as string» when peertube types will be available + const iconUrl = (peertubeHelpers.getBaseStaticRoute() as string) + '/images/' + icon const iconEl = document.createElement('span') iconEl.classList.add('peertube-plugin-livechat-button-icon') iconEl.setAttribute('style', @@ -85,9 +94,10 @@ function register ({ registerHook, peertubeHelpers }) { buttonContainer.append(button) } - function insertChatDom (container, peertubeHelpers, uuid, showOpenBlank) { + async function insertChatDom (container: HTMLElement, uuid: string, showOpenBlank: boolean): Promise { logger.log('Adding livechat in the DOM...') - const p = new Promise((resolve, reject) => { + const p = new Promise((resolve, reject) => { + // eslint-disable-next-line @typescript-eslint/no-floating-promises Promise.all([ peertubeHelpers.translate('Open chat'), peertubeHelpers.translate('Open chat in a new window'), @@ -121,51 +131,46 @@ function register ({ registerHook, peertubeHelpers }) { return p } - function openChat () { - const p = new Promise((resolve, reject) => { - const uuid = lastUUID - if (!uuid) { - logger.log('No current uuid.') - return reject(new Error('No current uuid.')) - } + function openChat (): void | boolean { + const uuid = lastUUID + if (!uuid) { + logger.log('No current uuid.') + return false + } - logger.info('Trying to load the chat for video ' + uuid + '.') - const iframeUri = getIframeUri(uuid) - if (!iframeUri) { - logger.error('Incorrect iframe uri') - return reject(new Error('Incorrect iframe uri')) - } - const additionalStyles = settings['chat-style'] || '' + logger.info('Trying to load the chat for video ' + uuid + '.') + const iframeUri = getIframeUri(uuid) + if (!iframeUri) { + logger.error('Incorrect iframe uri') + return false + } + const additionalStyles = settings['chat-style'] || '' - logger.info('Opening the chat...') - const container = document.getElementById('peertube-plugin-livechat-container') - if (!container) { - logger.error('Cant found the livechat container.') - return reject(new Error('Cant found the livechat container')) - } + logger.info('Opening the chat...') + const container = document.getElementById('peertube-plugin-livechat-container') + if (!container) { + logger.error('Cant found the livechat container.') + return false + } - if (container.querySelector('iframe')) { - logger.error('Seems that there is already an iframe in the container.') - return reject(new Error('Seems that there is already an iframe in the container.')) - } + if (container.querySelector('iframe')) { + logger.error('Seems that there is already an iframe in the container.') + return false + } - // Creating the iframe... - const iframe = document.createElement('iframe') - iframe.setAttribute('src', iframeUri) - iframe.setAttribute('sandbox', 'allow-same-origin allow-scripts allow-popups allow-forms') - iframe.setAttribute('frameborder', '0') - if (additionalStyles) { - iframe.setAttribute('style', additionalStyles) - } - container.append(iframe) - container.setAttribute('peertube-plugin-livechat-state', 'open') - - resolve() - }) - return p + // Creating the iframe... + const iframe = document.createElement('iframe') + iframe.setAttribute('src', iframeUri) + iframe.setAttribute('sandbox', 'allow-same-origin allow-scripts allow-popups allow-forms') + iframe.setAttribute('frameborder', '0') + if (additionalStyles) { + iframe.setAttribute('style', additionalStyles) + } + container.append(iframe) + container.setAttribute('peertube-plugin-livechat-state', 'open') } - function closeChat () { + function closeChat (): void { const container = document.getElementById('peertube-plugin-livechat-container') if (!container) { logger.error('Cant close livechat, container not found.') @@ -177,7 +182,7 @@ function register ({ registerHook, peertubeHelpers }) { container.setAttribute('peertube-plugin-livechat-state', 'closed') } - function initChat () { + function initChat (): void { const videoWrapper = document.querySelector('#video-wrapper') if (!videoWrapper) { logger.error('The required div is not present in the DOM.') @@ -193,7 +198,7 @@ function register ({ registerHook, peertubeHelpers }) { container.setAttribute('peertube-plugin-livechat-state', 'initializing') videoWrapper.append(container) - peertubeHelpers.getSettings().then(s => { + peertubeHelpers.getSettings().then((s: any) => { settings = s const liveOn = !!settings['chat-all-lives'] const nonLiveOn = !!settings['chat-all-non-lives'] @@ -205,17 +210,21 @@ function register ({ registerHook, peertubeHelpers }) { logger.log('Checking if this video should have a chat...') const uuid = lastUUID + if (!uuid) { + logger.error('There is no lastUUID.') + return + } const video = videoCache[uuid] if (!video) { logger.error('Can\'t find the video ' + uuid + ' in the videoCache') return } - if (settings['chat-only-locals' && !video.isLocal]) { + if (settings['chat-only-locals'] && !video.isLocal) { logger.log('This video is not local, and we dont want chats on non local videos.') return } - if (uuids.indexOf(uuid) >= 0) { + if (uuids.includes(uuid)) { logger.log('This video is in the list for chats.') } else if (video.isLive && liveOn) { logger.log('This video is live and we want all lives.') @@ -226,10 +235,11 @@ function register ({ registerHook, peertubeHelpers }) { return } - insertChatDom(container, peertubeHelpers, uuid, !!settings['chat-open-blank']).then(() => { + // eslint-disable-next-line @typescript-eslint/no-floating-promises + insertChatDom(container as HTMLElement, uuid, !!settings['chat-open-blank']).then(() => { if (settings['chat-auto-display']) { openChat() - } else { + } else if (container) { container.setAttribute('peertube-plugin-livechat-state', 'closed') } }) @@ -238,7 +248,7 @@ function register ({ registerHook, peertubeHelpers }) { registerHook({ target: 'filter:api.video-watch.video.get.result', - handler: (video) => { + handler: (video: Video) => { // For now, hooks for action:video-watch... did not receive the video object // So we store video objects in videoCache videoCache[video.uuid] = video diff --git a/package-lock.json b/package-lock.json index a04ef4c6..96b88385 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5284,6 +5284,163 @@ "repeat-string": "^1.6.1" } }, + "ts-loader": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-8.1.0.tgz", + "integrity": "sha512-YiQipGGAFj2zBfqLhp28yUvPP9jUGqHxRzrGYuc82Z2wM27YIHbElXiaZDc93c3x0mz4zvBmS6q/DgExpdj37A==", + "dev": true, + "requires": { + "chalk": "^4.1.0", + "enhanced-resolve": "^4.0.0", + "loader-utils": "^2.0.0", + "micromatch": "^4.0.0", + "semver": "^7.3.4" + }, + "dependencies": { + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "chalk": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", + "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "emojis-list": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/emojis-list/-/emojis-list-3.0.0.tgz", + "integrity": "sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==", + "dev": true + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "json5": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.0.tgz", + "integrity": "sha512-f+8cldu7X/y7RAJurMEJmdoKXGB/X550w2Nr3tTbezL6RwEE/iMcm+tZnXeoZtKuOq6ft8+CqzEkrIgx1fPoQA==", + "dev": true, + "requires": { + "minimist": "^1.2.5" + } + }, + "loader-utils": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/loader-utils/-/loader-utils-2.0.0.tgz", + "integrity": "sha512-rP4F0h2RaWSvPEkD7BLDFQnvSf+nK+wr3ESUjNTyAGobqrijmW92zc+SO6d4p4B1wh7+B/Jg1mkQe5NYUEHtHQ==", + "dev": true, + "requires": { + "big.js": "^5.2.2", + "emojis-list": "^3.0.0", + "json5": "^2.1.2" + } + }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dev": true, + "requires": { + "yallist": "^4.0.0" + } + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.0.5" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", + "dev": true + } + } + }, "tsconfig-paths": { "version": "3.9.0", "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.9.0.tgz", diff --git a/package.json b/package.json index 546970f8..af7193ee 100644 --- a/package.json +++ b/package.json @@ -39,6 +39,7 @@ "eslint-plugin-standard": "^5.0.0", "npm-run-all": "^4.1.5", "svgo": "^2.2.1", + "ts-loader": "^8.1.0", "typescript": "^4.2.3", "webpack": "^4.41.2", "webpack-cli": "^3.3.10" diff --git a/webpack.config.js b/webpack.config.js index e370961b..b2b82040 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -3,15 +3,23 @@ const path = require("path") const EsmWebpackPlugin = require("@purtuga/esm-webpack-plugin") const clientFiles = [ - 'common-client-plugin.js', - 'videowatch-client-plugin.js' + 'common-client-plugin', + 'videowatch-client-plugin' ] let config = clientFiles.map(f => ({ - entry: "./client/" + f, + entry: "./client/" + f + ".ts", + module: { + rules: [ + { + test: /\.tsx?$/, + use: 'ts-loader' + } + ] + }, output: { path: path.resolve(__dirname, "./dist/client"), - filename: "./" + f, + filename: "./" + f + ".js", library: "script", libraryTarget: "var" }, From dbd6dc2375a54fe138110ad3ba915f2a8483c518 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 18:26:17 +0200 Subject: [PATCH 6/7] Changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e35e9b57..b70210df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## ??? + +* Code is now in Typescript + ## v1.0.8 * Fix: typo that can prevent settings chat-only-locals to work From 254fa6e3c5d53a024994411ce40362d16d33f387 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Wed, 7 Apr 2021 18:29:17 +0200 Subject: [PATCH 7/7] Fix unused options. --- server/.eslintrc.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/server/.eslintrc.json b/server/.eslintrc.json index aeec0a18..e0f785c7 100644 --- a/server/.eslintrc.json +++ b/server/.eslintrc.json @@ -7,11 +7,7 @@ "extends": [ "standard-with-typescript" ], - "globals": { - "Atomics": "readonly", - "SharedArrayBuffer": "readonly", - "BUILD": true - }, + "globals": {}, "parser": "@typescript-eslint/parser", "parserOptions": { "ecmaVersion": 2018,