Conversation

Notices

1. Aral Balkan (aral@mastodon.ar.al)'s status on Wednesday, 03-May-2023 18:07:11 JST Aral Balkan

   Want strong typing without a build process?

   (Hint: you don’t need to use TypeScript.)

   1. Use a modern editor like Helix Editor or VSCodium that supports the TypeScript Language Server (LSP).

   2. Add this to the top of your JavaScript file (without the backticks):

   ```
   // @ts-check
   ```

   3. Go read up on JSDoc ;)

   ¹ https://helix-editor.com
   ² https://jsdoc.app/about-getting-started.html

   #javaScript #typeSafety #JSDoc #lsp #HelixEditor #typeScript #web #dev

   • Aral Balkan (aral@mastodon.ar.al)'s status on Wednesday, 03-May-2023 18:23:05 JST Aral Balkan

     in reply to

     PS. Some #JSDoc #tips:

     You can refer to types in other modules.

     ```
     async createOrUpdate (/** @type import('stripe').Stripe */ stripe) {
     // …
     }
     ```

     You can cast (note the parenthesis surrounding the cast):

     ```
     state = /** @type RegistrationFormStateType */ (new RegistrationFormState())
     ```

     You can annotate parameters inline:

     ```
     function formattedMinimumPriceForCurrency (/** @type string */ currency) {
     // …
     }
     ```

     For more advanced uses, see Closure Type System: https://github.com/google/closure-compiler/wiki/Types-in-the-Closure-Type-System

   • Aral Balkan (aral@mastodon.ar.al)'s status on Wednesday, 03-May-2023 18:29:35 JST Aral Balkan

     in reply to

     (All examples taken from Domain – https://codeberg.org/domain/app – the work-in-progress free and open platform for Small Web hosts.)

     #SmallWeb #Domain #Kitten #decentralisation #web #dev

   • Jan D (simulo@hci.social)'s status on Wednesday, 03-May-2023 18:32:48 JST Jan D

     in reply to

     @aral I love JS Doc (also for the small doc comments that the editor will display when using it); What I find difficult is that interfaces/implements could be very useful, but importing these from another file is …awkward? Does not work? Is undocumented? …certainly a mess.

   • Aral Balkan (aral@mastodon.ar.al)'s status on Wednesday, 03-May-2023 18:33:23 JST Aral Balkan

     in reply to

     • Jan D

     @simulo See https://mastodon.ar.al/@aral/110304019591947072 ;)

     (I agree, there are things that could be better – the ability to use interfaces, etc., – but I’m finding my way towards a very workable – and legible/maintable – flow now.)

   • Aral Balkan (aral@mastodon.ar.al)'s status on Wednesday, 03-May-2023 18:36:03 JST Aral Balkan

     in reply to

     • Shini92 :ablobblewobble:

     @Shini92 Nice. One very similar use case for me is database schemas for JavaScript Database (JSDB)¹, which is part of Kitten² :)

     https://codeberg.org/domain/app/src/branch/main/app_modules/database/database.js

     ¹ https://codeberg.org/small-tech/jsdb
     ² https://codeberg.org/kitten/app

     #jsdb #kitten #SmallWeb #database #web #dev

   • Shini92 :ablobblewobble: (shini92@mas.to)'s status on Wednesday, 03-May-2023 18:36:04 JST Shini92 :ablobblewobble:

     in reply to

     @aral `// @ts-check` is really welcome and needed for files like eslint config or prettier config where you do not have other options like TS

     So for example in #faker we use it like this https://github.com/faker-js/faker/blob/ede6ffac383a853c12b7a47cebbb031ba80627aa/.eslintrc.js#LL1C1-L1C1 together with https://github.com/Shinigami92/eslint-define-config

   • ./orta therox (orta@m.webtoo.ls)'s status on Wednesday, 03-May-2023 23:30:42 JST ./orta therox

     in reply to

     @aral ( FWIW, I'd recommend recommending the TypeScript JSDoc reference (as that is what is powering all the JSDoc editor tooling! ) https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html )

   • Aral Balkan (aral@mastodon.ar.al)'s status on Wednesday, 03-May-2023 23:31:39 JST Aral Balkan

     in reply to

     • ./orta therox

     @orta Thanks :)

   • Aral Balkan (aral@mastodon.ar.al)'s status on Thursday, 04-May-2023 03:25:07 JST Aral Balkan

     in reply to

     • Lea Rosema

     @lea You’re very welcome; hope you enjoy it :) 💕

   • Lea Rosema (lea@lea.lgbt)'s status on Thursday, 04-May-2023 03:25:08 JST Lea Rosema

     in reply to

     @aral the helix editor looks like a nice editor to try, thank you 💜