update dependencies by kontrollanten · Pull Request #1 · JohnXLivingston/peertube-plugin-quickstart-typescript

kontrollanten · 2024-12-22T09:08:29Z

Update dependencies

JohnXLivingston

Thanks for your PR.
Updating ESLint and typescript is more than welcome.

But i have some concerns about some changes you made.

JohnXLivingston · 2024-12-23T10:10:17Z

.stylelintrc.json

Why do you change the stylelintrc filetype ? Is there a good reason?
Using a JS file allows comment (if needed). That could help if the configuration become more complexe one day.

I agree. I tried to solve an issue with eslint that I couldn't solve in a better way. I switch back since this file isn't linted anymore.

JohnXLivingston · 2024-12-23T10:13:52Z

package.json

-    "build:server": "npx tsc --build server/tsconfig.json",
-    "build:client": "node ./scripts/build.js",
+    "build:server": "npx tsc --build tsconfig.json",
+    "build:client": "node ./scripts/build.mjs",


Why have you changed the file type to a mjs?

This is a script, not a module. Is there a good reason that i missed?

It's to enable the use of ES import in the file.

JohnXLivingston · 2024-12-23T10:20:13Z

package.json

    "build:styles": "npx sass --no-source-map assets:dist/assets",
    "build": "npm-run-all -s clean check:client:tsc -p build:server build:client build:styles",
-    "lint:script": "npx eslint --ext .ts --ext .js .",
+    "lint:script": "eslint",


Why do you removed the npx call?
Using npx ensure that it is using the eslint version in the node_modules directory, and not any globally installed eslint (which could cause some issue if the version is not matching).

I wasn't aware of that, I'll change back

JohnXLivingston · 2024-12-23T10:22:22Z

package.json

-    "esbuild": "^0.14.36",
-    "eslint": "^8.21.0",
-    "eslint-config-standard-with-typescript": "^22.0.0",
+    "@peertube/peertube-types": "^7.0.0",


There was a good reason to let "@peertube/peertube-types": "^4.2.2",: in the engine section, I mention that this plugin is compatible with "peertube": ">=4.2.0".
So we must use the Peertube 4.2.x types, to be sure to not use features that are not avaible.
This is explained in the README.

Okay, personally I prefer to always target the latest version since I can't really see any reason an instance keep using an old version. But I'll switch back to PT 4.2 support.

JohnXLivingston · 2024-12-23T10:23:41Z

package.json

-    "eslint": "^8.21.0",
-    "eslint-config-standard-with-typescript": "^22.0.0",
+    "@peertube/peertube-types": "^7.0.0",
+    "@tsconfig/node18": "^18.2.4",


The tsconfig/nodexx dependency should match the node version supported by the supported Peertube version.
This template is meant for Peertube >= 4.2.0, so it should be Node16.

I've reverted this.

JohnXLivingston · 2024-12-23T10:24:19Z

server/main.ts

 import type { RegisterServerOptions } from '@peertube/peertube-types'

 async function register ({ peertubeHelpers }: RegisterServerOptions): Promise<void> {
+  await Promise.resolve()


Due to rules/no-empty-function.

JohnXLivingston · 2024-12-23T10:24:27Z

server/main.ts


-async function unregister (): Promise<void> {}
+async function unregister (): Promise<void> {
+  await Promise.resolve()


Due to rules/no-empty-function.

JohnXLivingston · 2024-12-23T10:24:48Z

tsconfig.json

@@ -1,7 +1,7 @@
 {
-  "extends": "@tsconfig/node16/tsconfig.json",
+  "extends": "@tsconfig/node18/tsconfig.json",


See previous comment. Should be related to the supported Peertube version.

JohnXLivingston · 2024-12-23T10:24:57Z

tsconfig.json

+  "extends": "@tsconfig/node18/tsconfig.json",
  "compilerOptions": {
-		"moduleResolution": "node", // Tell tsc to look in node_modules for modules
+		"moduleResolution": "node16", // Tell tsc to look in node_modules for modules


see previous comment.

This is necessary due to the following error

server/tsconfig.json:4:23 - error TS5109: Option 'moduleResolution' must be set to 'Node16' (or left unspecified) when option 'module' is set to 'Node16'.

JohnXLivingston · 2024-12-23T10:25:48Z

tsconfig.json

+		"outDir": "./dist/",
+		"paths": {},
+		"allowJs": true
 	},
 	"include": [
-		"./**/*"
+		"./server/**/*",
+		"**/*.mjs"
 	],
-	"exclude": []
+	"exclude": [
+		"./client"
+	]


Why to you moved the server tsconfig file?
Server and Client configuration were separate. Moving the server tsconfig in the root directory adds confusion (IMHO).

It was because I was trying to include the js/mjs files in the eslint as well, but that's better ways to handle that. I've moved back the file.

JohnXLivingston · 2025-01-06T17:00:30Z

Thanks for your modification @kontrollanten .
I have a very busy week. I'll take a look next week.

kontrollanten · 2025-01-06T20:30:43Z

Thanks for your modification @kontrollanten . I have a very busy week. I'll take a look next week.

Sounds great! No hurry and feel free to change anything. Thanks for this repo!

update dependencies

66e49b8

kontrollanten force-pushed the update-deps branch from 52c7c19 to 66e49b8 Compare December 22, 2024 10:27

JohnXLivingston requested changes Dec 23, 2024

View reviewed changes

updates after code review

9710dbc

kontrollanten force-pushed the update-deps branch from c86511f to 9710dbc Compare January 4, 2025 04:07

Conversation

kontrollanten commented Dec 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JohnXLivingston left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JohnXLivingston commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kontrollanten commented Jan 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kontrollanten commented Dec 22, 2024 •

edited

Loading

JohnXLivingston commented Jan 6, 2025 •

edited

Loading