Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Helper functions for slug processing

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript
Ambito
api, backend

Direzione di ricerca

Inizia leggendo l’issue correlata #151 per comprendere il contesto di elaborazione degli slug richiesto. Poi definisci i contratti degli helper elencati e i relativi comportamenti di validazione, ricerca, normalizzazione e trasferimento descritti in questa issue. Il lavoro è completato quando tutti gli helper specificati supportano i casi documentati di successo ed errore, incluso il rollback del trasferimento degli slug.

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

Descrizione

enhancement

In support of #151, the following transforming library for slugs should be added:

  1. getSlugFromMetadata(__rerum:Object) -> validSlug:String
    • extract "this-slug" from DB record property {__rerum: { slug : "this-slug" } }
    • throw invalid argument if not __rerum metadata
    • return empty "" if slug property empty or missing
  2. assignSlug(slug:String, document:Object) -> document:Object
    • insert or overwrite "this-slug" to __rerum property for traditional save
    • empty/remove slug with empty ""
  3. findBySlug(slug:String) async -> document:Object
    • RERUM lookup for slug match
    • 404 on a miss, 400 on a bad slug
  4. transferSlug(toDocument:Object, fromDocument?:Object) async -> 200 <location>
    • RERUM upsert toDocument with "this-slug" and RERUM patch fromDocument with { __rerum.slug: "" }
    • A single transaction, revert on a failure
  5. slugExists(slug:String) async -> Boolean
    • *findBySlug(slug) is not 40x
  6. slugIsValid(slug:String) -> Boolean
    • slug and normalizeSlug(slug) match
  7. normalizeSlug(userSlug:String) -> validSlug:String
    • "This, That & the Other! Various Outré Considerations" -> "this-that-the-other-various-outre-considerations"
  8. buildSluggedId(validSlug:String) -> atIdUrl:Url

Only "normalizeSlug" takes user input.

Lingua principale
JavaScript
Stelle
3
Fork
6
Merge medio
4g 9h
PR unite (30g)
5

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 CenterForDigitalHumanities/rerum_server_nodejs

Tutte le issue di CenterForDigitalHumanities/rerum_server_nodejs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.