Generate typings for code in app-util #121

ehrencrona · 2020-11-04T09:01:33Z

This PR builds on #116 and adds typings for the code in app-utils (#116 only exported the manually defined types; code such as the render method was still not typed to consumers outside the package).

The buildTypes script defined in package.json builds the types which are put alongside the compiled code (e.g. /renderer or /files). I couldn't get tsc to build directly to the right location so it builds to build/types and then copies the result over.

The manually defined typings that were previously in src/types.d.ts would have looked weird if they were copied to the root so I moved those into src/types/index.d.ts. This doesn't affect imports and the "built" location becomes types/index.d.ts which is in line with the compiled code (though still somewhat confusing).

I didn't actually make the types build as part of the build step out of concern for build times. The build will work even without them, but building types manually risks creating confusion if you have out-of-date typings (which can fail the build). It runs in 5.5 seconds seconds on my Macbook Air 2019. Should we add it to the build?

ehrencrona · 2020-11-04T09:03:24Z

packages/kit/src/api/dev/index.ts

@@ -166,11 +167,11 @@ class Watcher extends EventEmitter {
 						entry: 'main/runtime/navigation.js',
 						deps: {}
 					},
-					files: 'build',


i can't find any reference to this option in app-util and the types for opts do not allow it.

antony · 2020-11-04T15:40:44Z

packages/app-utils/cpr.js

+
+// recursive copy file to make scripts in package.json cross-platform
+
+function copyRecursiveSync(src, dest) {


this code actually exists inside app-utils itself

you mean in src/files? I didn't know that, but that's inside a .ts file so I can't easily call it. I could import it from the compiled code, but then the build needs to have run before (the tsc here only outputs typings; it doesn't build). do you think that's better? I put the file in the root in analogy to rimraf which is also used in a package.json script.

packages/app-utils/package.json

packages/app-utils/src/types/index.d.ts

benmccann · 2020-11-09T17:27:02Z

@ehrencrona looks like this one will need to be rebased

benmccann · 2020-11-09T17:38:59Z

We already have @rollup/plugin-typescript. It seems like it'd be slower to call tsc separately because we'd be invoking the TypeScript compiler twice then. Can we set declaration: true in the tsconfig.json and use @rollup/plugin-typescript to generate the types? I think in that case we might be able to do it automatically when building with less of a speed penalty

ehrencrona · 2020-11-11T10:24:30Z

We already have @rollup/plugin-typescript.

@benmccann I am setting declaration: true in tsconfig.json but the typescript plugin doesn't seem to do anything with it. Just running build does not generate any typings. I suppose the plugin doesn't do that.

ehrencrona · 2020-11-11T10:27:50Z

rebased

benmccann · 2020-11-11T16:44:20Z

It does look like it's supported. However, the Rollup TypeScript plugin has lots of weird usage quirks and in this case it looks like you also need to set output.dir for declaration to have any effect: rollup/plugins#61 (comment)

benmccann · 2020-11-12T20:18:21Z

@ehrencrona I merged #134 so you can rebase this one

ehrencrona · 2020-11-14T09:55:38Z

@benmccann I've rebased. ~~However, I still can't get Rollup to produce the types. I added outDir and declaration: true in the tsconfig.json but no luck. Anything else I need to do?~~

Update: adding { useTsconfigDeclarationDir: true } back in creates the types. Is that fine?

I added the type generation and copying the types to the rollup build now. This way it will also work when running run dev and the performance hit seems negligible.

benmccann · 2020-11-15T23:31:41Z

{ useTsconfigDeclarationDir: true } makes it output the types into the types directory specified in the tsconfig.json. For me, it wasn't working when the types were in the types directory, but did work when I just left that out so that it just output the types in the default location alongside the code. When I say it wasn't working, I mean that the projects wouldn't all compile. I was either running pnpm install or pnpm -r build in the root directory to build all the projects and one of the projects that depended on app-util wouldn't work.

benmccann · 2020-11-15T23:32:00Z

packages/app-utils/.gitignore

@@ -6,3 +6,4 @@ node_modules
 /http
 /renderer
 /types


do we need this if we're outputting to /build/types?

benmccann · 2020-11-15T23:36:26Z

packages/app-utils/.gitignore

@@ -6,3 +6,4 @@ node_modules
 /http
 /renderer
 /types
+/build


I think I saw one of the packages was outputting to /dist at one point? Should we standardize on that?

Also, I wonder about the fact that this is outputting the types to /build/types but the other files to /common, /files, etc. Should those also be under /build or /dist? I think that'd be a lot easier to manage. I was having a hard time with the way it's setup now with output going all over the place. It's hard to tell what's output and what's not. E.g. we generate some .d.ts files but there are other ones that are checked in and I can't easily tell which is which

The tsconfig builds the types to build/types (which contains e.g. files/index.d.ts etc) and then copies the to the root (whereby build/types/files/index.d.ts becomes files/index.d.ts and therefore winds up next to index.mjs as it should).

I couldn't get it working building straight to .; it doesn't seem to like the output directory to be a parent directory of the src directory (No inputs were found [...] Specified 'include' paths were '["src/**/*"]' and 'exclude' paths were '["."]'.). Maybe there's a way to fix that?

I agree that having all the outputs in the root is confusing and it would be nice to move them (to dist), but that feels like a different issue from generating typings. I suppose they could be moved with the exports tag in package.json but that would require everyone to use a modern npm. Otherwise I don't know of any way of doing it without changing the exported module names.

As long the complete build isn't to dist I think build is a better name for intermediary build artefacts than can be wiped.

When I say it wasn't working, I mean that the projects wouldn't all compile.

Oh, I notice now there are compiler errors due to the types in other projects. Sorry, I hadn't noticed before (though I think some are fixed by other PRs). Fixing them.

benmccann

looks good to me other than needing to be rebased. thanks for being patient with this one

ehrencrona · 2020-11-17T07:24:52Z

rebased. no worries, as long as there's feedback coming in it's a good process :)

benmccann · 2020-11-17T16:26:38Z

@ehrencrona it looks like this one will need to be rebased again since your other PR was merged

ehrencrona · 2020-11-19T09:21:39Z

and rebased

ehrencrona commented Nov 4, 2020

View reviewed changes

antony reviewed Nov 4, 2020

View reviewed changes

benmccann reviewed Nov 4, 2020

View reviewed changes

packages/app-utils/package.json Outdated Show resolved Hide resolved

benmccann reviewed Nov 4, 2020

View reviewed changes

packages/app-utils/src/types/index.d.ts Outdated Show resolved Hide resolved

ehrencrona mentioned this pull request Nov 6, 2020

Allowing app-utils to export types #116

Merged

benmccann mentioned this pull request Nov 9, 2020

[WIP] make a start on error layouts #105

Closed

ehrencrona force-pushed the app-util-generate-types branch from aab5112 to e4dd700 Compare November 11, 2020 10:27

benmccann mentioned this pull request Nov 11, 2020

Generate TypeScript declarations #134

Merged

ehrencrona force-pushed the app-util-generate-types branch from e4dd700 to 7c425f2 Compare November 14, 2020 09:14

benmccann reviewed Nov 15, 2020

View reviewed changes

ehrencrona force-pushed the app-util-generate-types branch from 2223042 to 7e711d5 Compare November 16, 2020 08:49

benmccann approved these changes Nov 16, 2020

View reviewed changes

ehrencrona force-pushed the app-util-generate-types branch from 7e711d5 to f620a67 Compare November 17, 2020 07:23

ehrencrona mentioned this pull request Nov 17, 2020

Convert more adapter files to TypeScript #138

Merged

ehrencrona added 5 commits November 19, 2020 11:19

build app util types with tsc

2a838f6

fixing errors and added types to clean

4a106b4

switching interface to type

d85ac09

types to interfaces

ce0d66b

building types as part of rollup build

3342312

ehrencrona added 5 commits November 19, 2020 11:21

made comment less ambiguous

e11c1e8

fixing compiler errors

8587392

unused parameters

1596487

made tsconfig extend root

d7af3ae

explicitly setting declarations true in app-utils

408a048

ehrencrona force-pushed the app-util-generate-types branch from 3377990 to 408a048 Compare November 19, 2020 09:21

ehrencrona merged commit c91d879 into master Nov 19, 2020

ehrencrona deleted the app-util-generate-types branch November 19, 2020 12:40

benmccann mentioned this pull request Nov 19, 2020

Fix compilation errors #147

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate typings for code in app-util #121

Generate typings for code in app-util #121

ehrencrona commented Nov 4, 2020

ehrencrona Nov 4, 2020

antony Nov 4, 2020

ehrencrona Nov 5, 2020 •

edited

Loading

benmccann commented Nov 9, 2020

benmccann commented Nov 9, 2020

ehrencrona commented Nov 11, 2020

ehrencrona commented Nov 11, 2020

benmccann commented Nov 11, 2020

benmccann commented Nov 12, 2020

ehrencrona commented Nov 14, 2020 •

edited

Loading

benmccann commented Nov 15, 2020

benmccann Nov 15, 2020

benmccann Nov 15, 2020

ehrencrona Nov 16, 2020 •

edited

Loading

ehrencrona Nov 16, 2020

benmccann left a comment •

edited

Loading

ehrencrona commented Nov 17, 2020

benmccann commented Nov 17, 2020

ehrencrona commented Nov 19, 2020


		// recursive copy file to make scripts in package.json cross-platform

		function copyRecursiveSync(src, dest) {

Generate typings for code in app-util #121

Generate typings for code in app-util #121

Conversation

ehrencrona commented Nov 4, 2020

ehrencrona Nov 4, 2020

Choose a reason for hiding this comment

antony Nov 4, 2020

Choose a reason for hiding this comment

ehrencrona Nov 5, 2020 • edited Loading

Choose a reason for hiding this comment

benmccann commented Nov 9, 2020

benmccann commented Nov 9, 2020

ehrencrona commented Nov 11, 2020

ehrencrona commented Nov 11, 2020

benmccann commented Nov 11, 2020

benmccann commented Nov 12, 2020

ehrencrona commented Nov 14, 2020 • edited Loading

benmccann commented Nov 15, 2020

benmccann Nov 15, 2020

Choose a reason for hiding this comment

benmccann Nov 15, 2020

Choose a reason for hiding this comment

ehrencrona Nov 16, 2020 • edited Loading

Choose a reason for hiding this comment

ehrencrona Nov 16, 2020

Choose a reason for hiding this comment

benmccann left a comment • edited Loading

Choose a reason for hiding this comment

ehrencrona commented Nov 17, 2020

benmccann commented Nov 17, 2020

ehrencrona commented Nov 19, 2020

ehrencrona Nov 5, 2020 •

edited

Loading

ehrencrona commented Nov 14, 2020 •

edited

Loading

ehrencrona Nov 16, 2020 •

edited

Loading

benmccann left a comment •

edited

Loading