Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Helper functions for slug processing

未关闭
  • 哪里不对？
#152 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
javascript
领域
api, backend

调研方向

首先阅读相关 issue #151，以了解本 issue 所请求的 slug 处理上下文。然后根据本 issue 定义所列 helper 的契约，以及它们的验证、查找、规范化和传输行为。当所有指定的 helper 都支持文档中规定的成功和错误情况（包括 slug 传输回滚）时，工作即完成。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
JavaScript
星标
3
派生
6
平均合并
4 天 9 小时
30 天内合并 PR
5

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

CenterForDigitalHumanities/rerum_server_nodejs 的其他 Issue

查看 CenterForDigitalHumanities/rerum_server_nodejs 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。