adopt TypeScript .ts syntax

turadg commented 1 year ago

I don't think this is going to happen but I wanted a place to collect the benefits and blockers.

What is the Problem Being Solved?

We rely on TypeScript for Intellisense, refactoring support, and fast feedback on what will fail in tests. We use the JSDoc syntax in .js and not .ts syntax.

Kinks

No way to opt out of typedef exports (https://github.com/microsoft/TypeScript/issues/46011)
Inline casts require wrapping the casted value in () which build tools remove as superfluous (example)
No way to deprecate types (the @deprecated tag works only in .ts + jsdoc and not with plain JS.

Challenges

Transpilation affects auditability
Build step complicates execution

Description of the Design

Probably some form of Node module loader hook, such as https://github.com/esbuild-kit/esm-loader

Or a Node wrapping runtime: https://github.com/privatenumber/ts-runtime-comparison

There will be transpilation but audits should be of built bundles, which aren't minified.

Security Considerations

Test Plan

turadg commented 9 months ago

Progress in,

dckc commented 1 week ago

conversion to .cjs module format is problematic

case in point: https://github.com/Agoric/agoric-sdk/issues/9408#issuecomment-2183611504

here's hoping for a .ts compiler / build tool that erases the types and does nothing else; especially no conversion to .cjs. I gather esbuild is close.

Agoric / agoric-sdk