Enhancement: Add TypeScript definitions (IntelliSense) to Node.js starter

Aperta
  • Qualcosa non va?
#344 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@Ram3ez ci sta già lavorando.

Dal 15/12/2025.

  • #345 di @Ram3ez — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
javascript, node.js, typescript
Ambito
developer-experience

Direzione di ricerca

Inizia esaminando l’index.js dello starter Node.js e la definizione types.d.ts proposta. Verifica che il riferimento JSDoc e le definizioni coprano req, res, log ed error, quindi apri lo starter in VS Code per verificare che IntelliSense funzioni senza un passaggio di build o tsconfig.json.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

🔖 Enhancement description

Currently, the Node.js starter function template lacks autocomplete support. I propose adding a types.d.ts file to the starter template and a reference in index.js. This will provide users with immediate IntelliSense for req, res, log, and error out of the box without requiring a build step or a full TypeScript configuration.

🎤 Pitch

The Problem: Developers working with the current Node.js starter often have to switch between their editor and the documentation to recall specific properties of the context object (e.g., distinguishing between req.bodyJson, req.bodyText, or remembering res.json() signatures). This creates friction for new users and increases the chance of minor syntax errors during the "Hello World" phase.

The Solution: By including a lightweight types.d.ts definition file and adding a JSDoc reference (/// ) to the top of index.js, we can leverage VS Code's native ability to provide IntelliSense for JavaScript files.

Key Benefits:

Improved DX: Users get self-documenting code with autocomplete for request headers, response methods, and environment variables.

Zero Config: This works natively in Node.js without needing tsconfig.json, compilation steps, or additional dependencies.

Non-Breaking: This change is purely additive and does not alter the runtime behavior of the function.

I have the types.d.ts definition file ready and tested locally. I would be happy to open a PR for this if assigned.

👀 Have you spent some time to check if this issue has been raised before?
  • I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
Lingua principale
HTML
Stelle
174
Fork
129
Merge medio
1g 15h
PR unite (30g)
11

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di appwrite/templates

Tutte le issue di appwrite/templates

Issue simili

Altre issue su DevTools

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.