🦕 Deno compatibility

[gr2m]

Deno v1.0.0 is planned to be released tomorrow:
https://deno.land/

I have experimentend with early versions of Deno and run into lots of trouble. I'll give it another try, with the hope to make as many Octokit libraries compatible with Deno as possible, as fast as possible. I'll keep you all posted in this thread

[gr2m]

Currently fighting with problems when importing @octokit/types:
https://mobile.twitter.com/gr2m/status/1260304096134717441

[gr2m]

That has been resolved 👍

[gr2m]

Now experiencing an import problem with @octokit/graphql

GITHUB_TOKEN=[REDACTED] deno run --allow-env https://gr2m.github.io/deno-playground/octokit-graphql.ts
error: Uncaught TypeError: Cannot read property 'request' of null
const graphql$1 = withDefaults(request.request, {
                                       ^
    at https://cdn.pika.dev/-/@octokit/[email protected]/dist=es2019/graphql.js:80:40
    at createCommonjsModule (https://cdn.pika.dev/-/@octokit/[email protected]/dist=es2019/graphql.js:9:35)
    at https://cdn.pika.dev/-/@octokit/[email protected]/dist=es2019/graphql.js:12:16

request is imported from https://cdn.pika.dev/-/@octokit/[email protected]/dist=es2017/request.js via

import { request } from '/-/@octokit/[email protected]/dist=es2017/request.js';

I don't get why request.request is null when run with Deno. The import of @octokit/endpoint into @octokit/request is working the same way but there is no complaint there 🤔

[kevinkassimo]

From https://cdn.pika.dev/-/@octokit/[email protected]/dist=es2017/request.js :

export { request };
export default null;  // <-- Seems graphql.js is trying to import default instead of import { request }

[gr2m]

Yes, but it seems that all the builds do the same thing, here is @octokit/endpoint: https://cdn.pika.dev/-/@octokit/[email protected]/dist=es2017/endpoint.js

const endpoint = withDefaults(null, DEFAULTS);
export { endpoint };
export default null;

And yet, running a script importing @octokit/request works without a problem:
deno run --allow-net https://gr2m.github.io/deno-playground/octokit-request.ts

I couldn't find a difference between the two builds ...

[kevinkassimo]

@octokit/request seems to do export * from ... for forwarding named exports, so import { request } from ... definitely work. import request from ... for default exports should still be null though.

[gr2m]

Looks like it just works when using cdn.skypack.dev instead of cdn.pika.dev 🎉

// index.ts
import { Octokit } from "https://cdn.skypack.dev/@octokit/rest";

console.log(`Octokit.VERSION: ${Octokit.VERSION}`);

const octokit = new Octokit({
  auth: "[personall access token here]",
});

octokit.users.getAuthenticated().then(console.log, console.error);

Then run

deno run --allow-net index.ts

[wangkexiong]

error: TS2339 [ERROR]: Property 'user' does not exist on type 'OctokitWithDefaults'.

[gr2m]

it's users, not user

[MKruschke]

@gr2m your example doesn't seem to work anymore. It seems that the types were missing or not correct when I try it right now.

This is what get as output from the cmd-line

And so it looks in code

Would love to use that awesome lib also on deno side so maybe you can help out.

[gr2m]

Thank you Orta, appreciate your help!

[gr2m]

I fixed a few problems that likely affected both deno and the TypeScript playground.

I got the following working now with deno

import { Octokit } from "https://cdn.skypack.dev/@octokit/core?dts";
import { restEndpointMethods } from "https://cdn.skypack.dev/@octokit/plugin-rest-endpoint-methods?dts";

const MyOctokit = Octokit.plugin(restEndpointMethods);

const octokit = new MyOctokit({
  auth: Deno.env.get("GITHUB_TOKEN"),
});

const { data } = await octokit.repos.get({
  owner: "gr2m",
  repo: "sandbox",
});

console.log(data);

I get full IntelliSense support in VS Code with the deno extension 🎉

However, when trying to use @octokit/rest I get an error

import { Octokit } from "https://cdn.skypack.dev/@octokit/rest?dts";

const octokit = new Octokit({
  auth: Deno.env.get("GITHUB_TOKEN"),
});

const { data } = await octokit.repos.get({
  owner: "gr2m",
  repo: "sandbox",
});

console.log(data);

error: TS2694 [ERROR]: Namespace '__' has no exported member 'RestEndpointMethods'.
   at https://cdn.skypack.dev/-/@octokit/[email protected]/dist=es2020,mode=types/dist-types/index.d.ts:12:147

I don't understand what the '__' namespace is, I don't see it in the source code.

@orta It's not quite working in the TypeScript playground yet (playground link)

[gr2m]

It also looks like using @octokit/core works, but not @octokit/rest.

you can do the following to get the same as importing @octokit/rest

import { Octokit as Core } from "https://cdn.skypack.dev/@octokit/core?dts";
import { requestLog } from "https://cdn.skypack.dev/@octokit/plugin-request-log?dts";
import { paginateRest } from "https://cdn.skypack.dev/@octokit/plugin-paginate-rest?dts";
import { restEndpointMethods } from "https://cdn.skypack.dev/@octokit/plugin-rest-endpoint-methods?dts";

const Octokit = Core.plugin(
  requestLog,
  restEndpointMethods,
  paginateRest
)

And that works without a problem 🤷🏼

[orta]

The playground issues are fixed upstream in the playground microsoft/TypeScript-Website@ac2c165 and should get deployed this week ( that example octokit playground on twitter was because this idea had been nagging me for a few months )

[gr2m]

The playground issues are fixed upstream in the playground microsoft/TypeScript-Website@ac2c165 and should get deployed this week

Yay! It seems to work now! 🎉 playground

Thanks @orta

[oscard0m]

More news from Deno 🦕 : https://deno.com/blog/changes

Let's see how it works with npm:@octokit/core in the upcoming months 🍿