Add @types/deno #70492

dsherret · 2024-09-09T23:33:23Z

Adds @types/deno. This was previously done in #60557, but closed because at the time we didn't believe there was much use for it. Nowadays with Deno 2.0, it will be possible to use Deno without the Deno language server when only using npm packages via a package.json and so it might be useful to have types for deno available at @types/deno.

The types here are code generated by denoland/deno#25545

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Add or edit tests to reflect the change.
Follow the advice from the readme.
Avoid common mistakes.
Run pnpm test <package to test>.

Select one of these and delete the others:

If adding a new definition:

The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
Create it with dts-gen --dt, not by basing it on an existing project.
Represents shape of module/library correctly
tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

typescript-bot · 2024-09-09T23:34:00Z

@dsherret Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

deno (new!) — on npm, on unpkg
- 2 added owners: ✎@dsherret, @bartlomieju
- Config files to check:
  - deno/.eslintrc.json: edited
  - deno/tsconfig.json: not the expected form (check: compilerOptions.lib.0)

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

You can test the changes of this PR in the Playground.

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
🕐 Only a DT maintainer can approve changes when there are new packages added

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 9 days.

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 70492,
  "author": "dsherret",
  "headCommitOid": "53c816747eaefba0c565d10858587aed59ebbac1",
  "mergeBaseOid": "5f56dc762773f1213fda4248e37a261637527c33",
  "lastPushDate": "2024-09-09T23:33:23.000Z",
  "lastActivityDate": "2024-09-16T20:15:53.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": true,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "deno",
      "kind": "add",
      "files": [
        {
          "path": "types/deno/.eslintrc.json",
          "kind": "package-meta",
          "suspect": "edited"
        },
        {
          "path": "types/deno/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/deno/deno-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/deno/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/deno/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/deno/tsconfig.json",
          "kind": "package-meta",
          "suspect": "not [the expected form](https://github.com/DefinitelyTyped/DefinitelyTyped#user-content-tsconfigjson) (check: `compilerOptions.lib.0`)"
        }
      ],
      "owners": [],
      "addedOwners": [
        "dsherret",
        "bartlomieju"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "stale",
      "reviewer": "jakebailey",
      "date": "2024-09-14T17:29:46.000Z",
      "abbrOid": "53a9958"
    },
    {
      "type": "stale",
      "reviewer": "lucacasonato",
      "date": "2024-09-12T17:07:21.000Z",
      "abbrOid": "53a9958"
    }
  ],
  "mainBotCommentID": 2339330236,
  "ciResult": "pass"
}

typescript-bot · 2024-09-09T23:34:02Z

🔔 @dsherret — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

jakebailey · 2024-09-10T03:57:32Z

Any reason to put all of the types here versus publishing a package which is referenced here? It seems like this is all ambient. Up to you.

dsherret · 2024-09-10T04:11:15Z

@jakebailey what's the advantage of doing that?

jakebailey · 2024-09-10T04:27:20Z

It's just so that you can avoid having to push code here all the time; @types/bun is that way, though you still have to bump here to bump versions, so it's a little moot (and having the code/tests here means we'll actually be able to track them and check for compat, keep them tidy).

types/deno/.eslintrc.json

typescript-bot · 2024-09-10T12:30:24Z

@jakebailey Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

…nt rules

dsherret · 2024-09-10T12:41:46Z

It's just so that you can avoid having to push code here all the time; @types/bun is that way, though you still have to bump here to bump versions, so it's a little moot (and having the code/tests here means we'll actually be able to track them and check for compat, keep them tidy).

Yeah, I feel like that creates a bit of indirection and as you said this already requires a review. It is nice to get the tooling here. We do have https://www.npmjs.com/package/@deno/types that we published to once for a single user and I was planning on deprecating it after this.

Side note: I'm actually surprised @types/* allows dependencies outside of that scope. Seems less safe... I always thought of the @types/ scope being hard to get a vulnerability into because of all the linting/reviews here.

jakebailey · 2024-09-10T14:47:33Z

Dependencies are manually reviewed and put in a list on dt-tools, so it's not just anything.

types/deno/package.json

jakebailey

Marking as needs review for the version thing; the suffix will definitely not behave the way you'd think and it's a bug that the tests don't complain.

typescript-bot · 2024-09-10T14:53:20Z

@dsherret One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

typescript-bot · 2024-09-10T20:08:59Z

@jakebailey Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

dsherret · 2024-09-12T14:48:27Z

Dependencies are manually reviewed and put in a list on dt-tools, so it's not just anything.

Personally it still seems concerning to me because there are dependencies of packages in @types using ~ version constraints. I kind of feel like it shouldn't be allowed.

jakebailey · 2024-09-12T16:23:58Z

Personally it still seems concerning to me because there are dependencies of packages in @types using ~ version constraints. I kind of feel like it shouldn't be allowed.

The key factor is that we really only add deps which are also deps of the packages being typed, such that some sort of transitive compromise is no worse than if you hadn't installed the types at all.

types/deno/.eslintrc.json

jakebailey · 2024-09-12T16:27:01Z

types/deno/index.d.ts

+         * was not found.
+         *
+         * @category Errors */
+        export class NotFound extends Error {}


All of these error types are empty classes so are treated as the same type as Error (same structure, same type, not nominal); is there some private prop/identifier that can be added to these to distinguish them, or is this intentional?

instanceof Deno.errors.NotFound

Er, right, they're just compatible in other ways: https://www.typescriptlang.org/play/?#code/MYGwhgzhAECyCeBRATsg9sgjNApgDwBccA7AExhXWWgG8BfAWAChRIYFKMAmXQk86J2r1mzUjlbIc0AGYBXYsAIBLNMWhyIOIZgAUOAFxwkqDJgCURgG5plpANyimm7aay7iOAO7GhXXebmQA

jakebailey · 2024-09-12T16:28:14Z

types/deno/index.d.ts

+         *
+         * @default {false}
+         */
+        env?: "inherit" | boolean | string[];


In general I would double check that you don't want env?: "inherit" | boolean | string[] | undefined, for people using exactOptionalPropertyTypes, especially on options bags.

I think maybe adding it would add some confusion around what env: undefined means. Generally people would just provide the properties they want to change here.

jakebailey · 2024-09-12T16:30:48Z

types/deno/index.d.ts

@@ -0,0 +1,9756 @@
+// Copyright 2018-2024 the Deno authors. MIT license.
+
+/// <reference lib="dom" />


What from the DOM is needed here? Usually requiring this isn't a good idea, rather, we can design packages to work with or without these and then have the DT infra test with multiple configurations (new to DT)

I think Request, Response, and URL - but probably we shouldn't do this here I agree.

Yeah, I shouldn't have added it. Tests seem to pass now without it though. Edit: Follow up here: #70492 (comment) (it's because of the tsconfig)

jakebailey · 2024-09-12T16:32:04Z

types/deno/index.d.ts

+        | "SIGXCPU"
+        | "SIGXFSZ";


One day I'll find the time to get dprint to write:

| "foo" | "bar" ;

typescript-bot · 2024-09-14T11:41:12Z

@lucacasonato, @jakebailey Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

dsherret · 2024-09-14T12:20:26Z

types/deno/tsconfig.json

+        "strictFunctionTypes": true,
+        "types": [],
+        "lib": [
+            "DOM",


Ah, because I had it here. I'll look into removing this.

Actually, removing this requires a pretty significant change. Might be better to just require people to use "DOM" for now, then we can look into creating all the conditional types later so it works well with or without dom types.

typescript-bot · 2024-09-14T17:30:20Z

@jakebailey, @lucacasonato Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

jakebailey · 2024-09-16T20:14:01Z

Are you expecting to have this out before Deno v2, or should this be waiting until then?

dsherret · 2024-09-16T20:15:53Z

It would be nice to land this before and then we can iterate on it. It's a brand new distribution form so probably not a bad thing to release it early.

dsherret added 2 commits September 9, 2024 18:15

Add @types/deno

dcafa6b

make the tests pass

2278f1b

typescript-bot added New Definition This PR creates a new definition package. Check Config Changes a module config files Huge Change labels Sep 9, 2024

dsherret added 2 commits September 9, 2024 19:35

fix issues pointed out by bot

a47a5a8

format

c648f22

jakebailey reviewed Sep 10, 2024

View reviewed changes

types/deno/.eslintrc.json Show resolved Hide resolved

fix some types that weren't exported

e659bbe

Ensure code generation formats file and add explanation on ignored li…

7b0dcee

…nt rules

jakebailey reviewed Sep 10, 2024

View reviewed changes

types/deno/package.json Outdated Show resolved Hide resolved

jakebailey requested changes Sep 10, 2024

View reviewed changes

typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Sep 10, 2024

update version

53a9958

typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Sep 10, 2024

dsherret requested a review from jakebailey September 11, 2024 06:56

jakebailey reviewed Sep 12, 2024

View reviewed changes

types/deno/.eslintrc.json Show resolved Hide resolved

jakebailey reviewed Sep 12, 2024

View reviewed changes

dsherret added 2 commits September 14, 2024 12:36

review and latest deno 2 updates

b698ba4

add test with URL

fedd62e

dsherret requested a review from jakebailey September 14, 2024 11:41

dsherret mentioned this pull request Sep 14, 2024

chore: add code generation for @types/deno denoland/deno#25545

Open

dsherret commented Sep 14, 2024

View reviewed changes

Revert accidentally added back prerelease

53c8167

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add @types/deno #70492

Add @types/deno #70492

dsherret commented Sep 9, 2024 •

edited

Loading

typescript-bot commented Sep 9, 2024 •

edited

Loading

typescript-bot commented Sep 9, 2024

jakebailey commented Sep 10, 2024

dsherret commented Sep 10, 2024

jakebailey commented Sep 10, 2024

typescript-bot commented Sep 10, 2024

dsherret commented Sep 10, 2024

jakebailey commented Sep 10, 2024

jakebailey left a comment

typescript-bot commented Sep 10, 2024

typescript-bot commented Sep 10, 2024

dsherret commented Sep 12, 2024 •

edited

Loading

jakebailey commented Sep 12, 2024

jakebailey Sep 12, 2024

dsherret Sep 14, 2024

jakebailey Sep 14, 2024

jakebailey Sep 12, 2024

dsherret Sep 14, 2024

jakebailey Sep 12, 2024

lucacasonato Sep 12, 2024

dsherret Sep 14, 2024 •

edited

Loading

jakebailey Sep 12, 2024

typescript-bot commented Sep 14, 2024

dsherret Sep 14, 2024

dsherret Sep 14, 2024

typescript-bot commented Sep 14, 2024

jakebailey commented Sep 16, 2024

dsherret commented Sep 16, 2024

		@@ -0,0 +1,9756 @@
		// Copyright 2018-2024 the Deno authors. MIT license.

		/// <reference lib="dom" />

Add @types/deno #70492

Are you sure you want to change the base?

Add @types/deno #70492

Conversation

dsherret commented Sep 9, 2024 • edited Loading

typescript-bot commented Sep 9, 2024 • edited Loading

1 package in this PR

Code Reviews

Status

Inactive

typescript-bot commented Sep 9, 2024

jakebailey commented Sep 10, 2024

dsherret commented Sep 10, 2024

jakebailey commented Sep 10, 2024

typescript-bot commented Sep 10, 2024

dsherret commented Sep 10, 2024

jakebailey commented Sep 10, 2024

jakebailey left a comment

Choose a reason for hiding this comment

typescript-bot commented Sep 10, 2024

typescript-bot commented Sep 10, 2024

dsherret commented Sep 12, 2024 • edited Loading

jakebailey commented Sep 12, 2024

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

dsherret Sep 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Sep 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typescript-bot commented Sep 14, 2024

jakebailey commented Sep 16, 2024

dsherret commented Sep 16, 2024

dsherret commented Sep 9, 2024 •

edited

Loading

typescript-bot commented Sep 9, 2024 •

edited

Loading

dsherret commented Sep 12, 2024 •

edited

Loading

dsherret Sep 14, 2024 •

edited

Loading