onivim/oni

Error Handling: Startup

Open

#1.383 geöffnet am 28. Jan. 2018

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (11.389 Stars) (336 Forks)batch import
enhancementhelp wantedinsider

Beschreibung

This is tracking adding some better error-handling in startup, to give the user feedback when there is an issue on startup. Coming from @Akin909 's comments in #1381:

A solution to this is that the changeDir function should always check that the directory it is passed is valid before attempting to switch to it. A more general issue is that I think every function or rather main startup process should have a try/catch or some form of error handling so that oni doesn't end up hanging without any feedback given back to the user

We should do the following:

  • Wrap our 'start' call in a try/catch so that we can get errors
  • Have some UI affordance for showing an error UI (perhaps in Shell?). This could show any errors logged, as well as give the option for opening up a debug window. We could also potentially show an error notification once #1358 is in.

Contributor Guide

Tech Stack
typescriptreactelectron
Domain
frontenddesktop
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
TypeScript basicsOni startup codeReact/UI components
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
Start by reviewing comments in issue #1381 for context on the changeDir function and error handling gaps. Look at the current 'start' function in the main process (likely in src/index.ts or similar). Examine the Shell component for potential error UI integration. Consider implementing a try/catch around the start call and displaying errors via a notification system similar to #1358.