Add snapshot tests for plugins

[paul-sachs]

Update CI to check for untracked files (as suggested by @smaye81). First PR part of #160.

Few minor adjustments

• fixed a missing (optional) semi-colon in js generation
• added prettier formatting for root level files

[timostamm]

Good call 👍

Since we're generating both ts and dts - which one will be compiled though? 🤔

[paul-sachs]

This is really only useful for eslint so it can compile those files. It's a little weird and more finicky than I'd like.

[paul-sachs]

This is actually also just for the IDE + test + lint, whereas tsconfig.build.json is used for the build itself.

[timostamm]

Gotcha. What I mean is that there is ambiguity in general when you have x.js, x.ts, and x.d.ts all in the same directory, for any tool that processes the files.

I just checked with npm exec eslint -- snapshots/gen/connectrpc/eliza/v1 --debug, and see that eslint does lint each file individually.

It would not have caught #166 though.

That's fine for now - the "snapshots" will make changes reviewable, which is a big improvement.

Cut connectrpc/connect-es#824, because we don't do better there either.

[paul-sachs]

Sorry, got confused by github and replied down below. This change should catch any TS leaking into the javascript, but we probably need a more dedicated way to test these kinds of things (because we don't know which will be imported, as you mentioned).

[timostamm]

Gotcha. What I mean is that there is ambiguity in general when you have x.js, x.ts, and x.d.ts all in the same directory, for any tool that processes the files.

I just checked with npm exec eslint -- snapshots/gen/connectrpc/eliza/v1 --debug, and see that eslint does lint each file individually.

It would not have caught #166 though.

That's fine for now - the "snapshots" will make changes reviewable, which is a big improvement.

Cut connectrpc/connect-es#824, because we don't do better there either.

[paul-sachs]

It would not have caught #166 though.

Aww man, I actually had triggered an error and caught the as const thing for a bit, something must've changed in my linting. I still want to make sure our lint step can catch that kind of thing. Will investigate why it's not catching it.

[paul-sachs]

@timostamm Ah ok, my testing was just flawed (changing the wrong plugin). The linter does catch #166:

@connectrpc/protoc-gen-connect-query:format: snapshots/gen/connectrpc/eliza/v1/eliza-ElizaService_connectquery.d.ts 33ms
@connectrpc/protoc-gen-connect-query:format: [error] snapshots/gen/connectrpc/eliza/v1/eliza-ElizaService_connectquery.js: SyntaxError: Missing semicolon. (76:2)
@connectrpc/protoc-gen-connect-query:format: [error]   74 |     },
@connectrpc/protoc-gen-connect-query:format: [error]   75 |   }
@connectrpc/protoc-gen-connect-query:format: [error] > 76 | } as const
@connectrpc/protoc-gen-connect-query:format: [error]      |  ^
@connectrpc/protoc-gen-connect-query:format: [error]   77 |
@connectrpc/protoc-gen-connect-query:format: [error]   78 | /**
@connectrpc/protoc-gen-connect-query:format: [error]   79 |  * Say is a unary RPC. Eliza responds to the prompt with a single sentence.

[timostamm]

@timostamm Ah ok, my testing was just flawed (changing the wrong plugin).

And I ran pnpm exec eslint -- . to verify, which doesn't catch it for whatever reason...