use jsr modules where possible and upgrade fresh version #684

ycmjason · 2024-09-08T13:20:12Z

Hello there,

Decided to do some migration of packages to JSR modules and upgrading fresh versions.

Do let me know if there's any modifications I should make. I am not sure how the blog plugin should be typed.. as i can't find any references to location and projectLocation in the official API.

p.s. I am quite new to the deno community so I am not sure with a lot of conventions / best practices. Please feel free to guide me through this. 🙏

.vscode/settings.json

deno.json

ycmjason · 2024-09-08T13:25:04Z

plugins/blog/mod.ts


-export function blog(): Plugin {
+export function blog(): Plugin & { location: string; projectLocation: string } {


might need some help on this. I couldn't seem to find any documentation about the location and projectLocation options. So I am not sure what to do here.

iuioiua

Thank you for your contribution! Glad to see this done. Few suggestions.

.vscode/settings.json

iuioiua · 2024-09-09T00:48:34Z

e2e_test.ts

-import { isRedirectStatus, STATUS_CODE } from "$std/http/status.ts";
-import { resolvesNext, returnsNext, stub } from "$std/testing/mock.ts";
+} from "@std/assert";
+import { isRedirectStatus, STATUS_CODE } from "@std/http";


Using the most-specific module ensures that only the code we use is downloaded, keeping imports trim.

Suggested change

import { isRedirectStatus, STATUS_CODE } from "@std/http";

import { isRedirectStatus, STATUS_CODE } from "@std/http/status";

wouldn't tree shaking handle this?

iuioiua · 2024-09-09T00:48:56Z

e2e_test.ts

@@ -1,4 +1,5 @@
 // Copyright 2023-2024 the Deno authors. All rights reserved. MIT license.
+/// <reference lib="deno.unstable" />


This shouldn't be needed.

Suggested change

/// <reference lib="deno.unstable" />

ya removing this line seem to make test to fail. would love more guidance on how to fix this. thanks!

iuioiua · 2024-09-09T00:52:23Z

deno.json

-    "tailwindcss/plugin": "npm:/[email protected]/plugin.js",
-    "$std/": "https://deno.land/[email protected]/",
-    "stripe": "npm:/[email protected]",
+    "@std/assert": "jsr:@std/assert@^1.0.4",


@std follows SemVer. For packages with version >= 1, we should set versions like this to continue to get fixes but not introduce breaks. Ditto for other imports like this.

Suggested change

"@std/assert": "jsr:@std/assert@^1.0.4",

"@std/assert": "jsr:@std/assert@^1.0",

iuioiua · 2024-09-09T00:54:40Z

deno.json

-    "$std/": "https://deno.land/[email protected]/",
-    "stripe": "npm:/[email protected]",
+    "@std/assert": "jsr:@std/assert@^1.0.4",
+    "@std/datetime": "jsr:@std/datetime@^0.225.2",


Suggested change

"@std/datetime": "jsr:@std/datetime@^0.225.2",

"@std/datetime": "jsr:@std/datetime@^0.225",

iuioiua · 2024-09-09T01:05:32Z

utils/github_test.ts

-import { assertEquals } from "$std/assert/assert_equals.ts";
-import { STATUS_CODE } from "$std/http/status.ts";
+import { returnsNext, stub } from "@std/testing/mock";
+import { assertEquals } from "@std/assert";


Suggested change

import { assertEquals } from "@std/assert";

import { assertEquals } from "@std/assert/equals";

iuioiua · 2024-09-09T01:05:40Z

utils/github_test.ts

-import { STATUS_CODE } from "$std/http/status.ts";
+import { returnsNext, stub } from "@std/testing/mock";
+import { assertEquals } from "@std/assert";
+import { STATUS_CODE } from "@std/http";


Suggested change

import { STATUS_CODE } from "@std/http";

import { STATUS_CODE } from "@std/http/status";

iuioiua · 2024-09-09T01:05:51Z

utils/http.ts

@@ -1,5 +1,5 @@
 // Copyright 2023-2024 the Deno authors. All rights reserved. MIT license.
-import { RedirectStatus, STATUS_CODE } from "$std/http/status.ts";
+import { RedirectStatus, STATUS_CODE } from "@std/http";


Suggested change

import { RedirectStatus, STATUS_CODE } from "@std/http";

import { RedirectStatus, STATUS_CODE } from "@std/http/status";

iuioiua · 2024-09-09T01:06:05Z

utils/http_test.ts

-import { assert, assertEquals, assertRejects } from "$std/assert/mod.ts";
-import { STATUS_CODE } from "$std/http/status.ts";
+import { assert, assertEquals, assertRejects } from "@std/assert";
+import { STATUS_CODE } from "@std/http";


Suggested change

import { STATUS_CODE } from "@std/http";

import { STATUS_CODE } from "@std/http/status";

iuioiua · 2024-09-09T01:06:34Z

utils/stripe.ts

@@ -1,6 +1,6 @@
 // Copyright 2023-2024 the Deno authors. All rights reserved. MIT license.
 import Stripe from "stripe";
-import { AssertionError } from "$std/assert/assertion_error.ts";
+import { AssertionError } from "@std/assert";


Suggested change

import { AssertionError } from "@std/assert";

import { AssertionError } from "@std/assert/assertion-error";

ycmjason · 2024-09-09T08:45:23Z

deno.json

    "kv_oauth/": "https://deno.land/x/[email protected]/",
+    "preact": "https://esm.sh/[email protected]",
+    "preact/": "https://esm.sh/[email protected]/",
+    "stripe": "npm:/[email protected]",
    "tabler_icons_tsx/": "https://deno.land/x/[email protected]/tsx/",


also a note on this, we can switch this to:

"@tabler/icons-preact": "npm:@tabler/icons-preact@^3.14.0",

The module we are using is deprecated: https://github.com/hashrock/tabler-icons-tsx?tab=readme-ov-file#deprecated

happy to do this in this PR or a seperate one

Let's do that in a separate PR 🙂

iuioiua

Great! Thank you for your contribution! 🙂

iuioiua · 2024-09-10T10:14:39Z

deno.json

    "kv_oauth/": "https://deno.land/x/[email protected]/",
+    "preact": "https://esm.sh/[email protected]",
+    "preact/": "https://esm.sh/[email protected]/",
+    "stripe": "npm:/[email protected]",
    "tabler_icons_tsx/": "https://deno.land/x/[email protected]/tsx/",


Let's do that in a separate PR 🙂

iuioiua · 2024-09-10T10:17:08Z

e2e_test.ts

To clarify my previous statement, importing from root modules (i.e. @std/assert) for test code is fine. It's usually production code that we want to keep trim. It's no big deal, either way.

iuioiua · 2024-09-10T10:40:40Z

Please allow me to look into these CI failures once I get a chance.

ycmjason · 2024-09-10T10:46:16Z

@iuioiua I am curious to understand about specifying modules. I understand that we want to keep things trim, but wouldn't tree shaking handle that for us?

iuioiua · 2024-09-11T08:14:27Z

That's a fair assumption. However, Deno currently doesn't do this. You can test by having the following.

// deps.ts
export { STATUS_CODE } from "jsr:@std/http";

Run deno info deps.ts. You'll see all modules within @std/http are pulled in. Then, change the script to the following.

// deps.ts
export { STATUS_CODE } from "jsr:@std/http/status";

Now, running deno info deps.ts again, notice that only jsr:@std/http/status is pulled in. This fact remains even when we use an import map.

If you think this is worth having, please open an issue in the runtime repo with the suggestion.

ycmjason added 2 commits September 8, 2024 13:54

use jsr @deno/gfm

035aa6d

migrate to using jsr @std

4c68838

ycmjason commented Sep 8, 2024

View reviewed changes

.vscode/settings.json Outdated Show resolved Hide resolved

ycmjason commented Sep 8, 2024

View reviewed changes

deno.json Outdated Show resolved Hide resolved

ycmjason commented Sep 8, 2024

View reviewed changes

deno.json Outdated Show resolved Hide resolved

use latest fresh

3084939

ycmjason force-pushed the housekeeping branch from 3ef6bd0 to 3084939 Compare September 8, 2024 13:23

ycmjason commented Sep 8, 2024

View reviewed changes

iuioiua requested changes Sep 9, 2024

View reviewed changes

review changes

bb702f0

ycmjason commented Sep 9, 2024

View reviewed changes

ycmjason requested a review from iuioiua September 9, 2024 08:47

iuioiua approved these changes Sep 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use jsr modules where possible and upgrade fresh version #684

use jsr modules where possible and upgrade fresh version #684

ycmjason commented Sep 8, 2024 •

edited

Loading

ycmjason Sep 8, 2024

iuioiua left a comment

iuioiua Sep 9, 2024

ycmjason Sep 9, 2024

iuioiua Sep 9, 2024

ycmjason Sep 9, 2024

iuioiua Sep 9, 2024

iuioiua Sep 9, 2024

iuioiua Sep 9, 2024

iuioiua Sep 9, 2024

iuioiua Sep 9, 2024

iuioiua Sep 9, 2024

iuioiua Sep 9, 2024

ycmjason Sep 9, 2024

ycmjason Sep 9, 2024

iuioiua Sep 10, 2024

iuioiua left a comment

iuioiua Sep 10, 2024

iuioiua Sep 10, 2024

iuioiua commented Sep 10, 2024

ycmjason commented Sep 10, 2024

iuioiua commented Sep 11, 2024


		export function blog(): Plugin {
		export function blog(): Plugin & { location: string; projectLocation: string } {

	import { isRedirectStatus, STATUS_CODE } from "@std/http";
	import { isRedirectStatus, STATUS_CODE } from "@std/http/status";

		@@ -1,4 +1,5 @@
		// Copyright 2023-2024 the Deno authors. All rights reserved. MIT license.
		/// <reference lib="deno.unstable" />

	"@std/assert": "jsr:@std/assert@^1.0.4",
	"@std/assert": "jsr:@std/assert@^1.0",

	"@std/datetime": "jsr:@std/datetime@^0.225.2",
	"@std/datetime": "jsr:@std/datetime@^0.225",

	import { assertEquals } from "@std/assert";
	import { assertEquals } from "@std/assert/equals";

	import { STATUS_CODE } from "@std/http";
	import { STATUS_CODE } from "@std/http/status";

	import { RedirectStatus, STATUS_CODE } from "@std/http";
	import { RedirectStatus, STATUS_CODE } from "@std/http/status";

	import { AssertionError } from "@std/assert";
	import { AssertionError } from "@std/assert/assertion-error";

use jsr modules where possible and upgrade fresh version #684

Are you sure you want to change the base?

use jsr modules where possible and upgrade fresh version #684

Conversation

ycmjason commented Sep 8, 2024 • edited Loading

Choose a reason for hiding this comment

iuioiua left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iuioiua left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iuioiua commented Sep 10, 2024

ycmjason commented Sep 10, 2024

iuioiua commented Sep 11, 2024

ycmjason commented Sep 8, 2024 •

edited

Loading