Refactor: Replace console.log/alert with toast/alert dispatcher

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
30/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
frontend

Direzione di ricerca

Inizia esaminando i file UI elencati, in particolare manage/projectsHighlight.js, components/roles-handler/index.js e la directory classroom; quindi traccia l’uso esistente di eventDispatcher per tpen-toast e tpen-alert. Fai un inventario delle chiamate rimanenti a console e alert e determina quali sono rivolte agli utenti e quali servono per il debugging. Il lavoro è completo quando le chiamate interessate seguono un approccio concordato e uniforme alle notifiche o al logging nei file elencati, senza lasciare notifiche di produzione prive di spiegazione.

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

Descrizione

core functionality enhancement

Description

Multiple UI components currently use console.log(), console.debug(), and alert() for user notifications and debugging. This creates inconsistent UX and noisy console output.

Current State

Found 40+ instances across the codebase:

  • console.log() in various components (line-history, projects, classroom, etc.)
  • alert() calls in roles-handler, projects, legacy-annotator, etc.

Proposed Solution

  1. Route user-facing messages through the existing toast/alert dispatcher system:

    • Use eventDispatcher.dispatch('tpen-toast', { status, message }) for notifications
    • Use eventDispatcher.dispatch('tpen-alert', { message, buttonText }) for confirmations

  2. For debug logging, consider:

    • Remove debug logs entirely from production code
    • Use a debug flag/wrapper that respects environment (dev vs prod)
    • Leverage browser dev tools instead of inline logs

Files Affected

  • manage/projectsHighlight.js
  • components/roles-handler/index.js
  • components/projects/project-list-write.js
  • components/line-history/index.js
  • components/legacy-annotator/plain.js
  • components/annotorious-annotator/plain.js
  • components/classroom/ (multiple files)
  • api/Project.js

Benefits

  • Consistent user experience
  • Cleaner console output in production
  • Better error tracking and user feedback
  • Easier to test notification flows
Lingua principale
JavaScript
Stelle
2
Fork
3
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 CenterForDigitalHumanities/TPEN-interfaces

Tutte le issue di CenterForDigitalHumanities/TPEN-interfaces

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.