Shadcn CLI如何使用错误常量来提高代码可读性

在本文中,我们分析了如何在 shadcn/ui 代码库中使用名为 error.ts 的文件。

Shadcn CLI如何使用错误常量来提高代码可读性

utils/errors.ts

error.ts 包含 12 个变量:

export const missing_dir_or_empty_project = "1"export const existing_config = "2"export const missing_config = "3"export const failed_config_read = "4"export const tailwind_not_configured = "5"export const import_alias_missing = "6"export const unsupported_framework = "7"export const component_url_not_found = "8"export const component_url_unauthorized = "9"export const component_url_forbidden = "10"export const component_url_bad_request = "11"export const component_url_internal_server_error = "12"

登录后复制

这些是描述性的,解释了正在处理的错误类型,例如,missing_dir_or_empty_project 可能用于缺少目录或空项目的场景。

这些变量值有什么特殊含义吗?它们只是分配为字符串的数字。一旦我们了解了如何使用这些变量,它就更有意义了。

preflight-init.ts 中的用法:

如果你打开这个 preflight-init.ts,你会发现下面的代码片段。

// ensure target directory exists. // check for empty project. we assume if no package.json exists, the project is empty. if (   !fs.existssync(options.cwd) ||   !fs.existssync(path.resolve(options.cwd, "package.json")) ) {   errors[errors.missing_dir_or_empty_project] = true   return {     errors,     projectinfo: null,   } }

登录后复制

注意这个errors[errors.missing_dir_or_empty_project]=true,这里的errors是一个对象。 missing_dir_or_empty_project 的值是多少?如前所述,它是“1”。

这意味着错误对象如下所示:

{ "1": true}

登录后复制

这很好,但是这个错误对象是如何使用的以及在哪里使用?答案就在 init.ts 中。

init.ts 中的错误对象

在 init.ts 的第 91 行,你会发现下面的 if 块。

if (preflight.errors[ERRORS.MISSING_DIR_OR_EMPTY_PROJECT]) { const { projectPath } = await createProject(options) if (!projectPath) {   process.exit(1) }  options.cwd = projectPath options.isNewProject = true}

登录后复制

如果这个检查类似于 preflight.error[“1”],你的下一个想法就是这个神秘的值是什么。这意味着,error.ts 中的这些常量用于提高代码可读性

关于我们:

在 think throo,我们的使命是教授开源项目中使用的高级代码库架构概念。

通过在 next.js/react 中练习高级架构概念,将您的编码技能提高 10 倍,学习最佳实践并构建生产级项目。

我们是开源的 — https://github.com/thinkthroo/thinkthroo (请给我们一颗星!)

我们还提供网络开发和技术写作服务。请通过hello@thinkthroo.com联系我们了解更多信息!

参考文献:

https://github.com/shadcn-ui/ui/blob/main/packages/shadcn/src/preflights/preflight-init.ts#l22

https://github.com/shadcn-ui/ui/blob/main/packages/shadcn/src/utils/errors.ts

https://github.com/search?q=repo%3ashadcn-ui%2fui%20errors&type=code

https://github.com/shadcn-ui/ui/blob/1297abc8820480681ccec1bb026b29b30d9c858d/packages/shadcn/src/commands/init.ts#l91

以上就是Shadcn CLI如何使用错误常量来提高代码可读性的详细内容,更多请关注【创想鸟】其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至253000106@qq.com举报,一经查实,本站将立刻删除。

发布者:PHP中文网,转转请注明出处:https://www.chuangxiangniao.com/p/2664479.html

(0)
上一篇 2025年3月7日 11:39:11
下一篇 2025年3月7日 11:39:19

AD推荐 黄金广告位招租... 更多推荐

相关推荐

  • 清晰函数名称的力量:干净的代码必不可少

    在编程世界中,清晰才是王道。提高代码可读性和可维护性的最有效方法之一是使用清晰、描述性的函数名称。让我们深入探讨为什么这很重要,以及如何在代码中实现此实践。 模糊函数名称的问题 考虑这段代码: function addtodate(date…

    2025年3月7日
    200
  • 使用 Rollup 创建具有 CommonJS 和 ESM 支持的 NPM 包

    使用 rollup 创建具有 commonjs (cjs) 和 ecmascript 模块 (esm) 支持的 npm 包 在这篇文章中,我们将探索如何使用 rollup 创建支持 commonjs (cjs) 和 ecmascript 模…

    2025年3月7日
    200
  • 部署我的 nextjs 作品集网站是多么容易

    在过去的几天里,我很高兴推出我的个人作品集网站,以分享我的知识并建立强大的在线形象。经过研究,我发现 Namecheap 提供的域名价格非常实惠——第一年仅需 2.99 美元,还有折扣——所以我很快就获得了它。接下来,我讨论了是投资托管还是…

    2025年3月7日
    200
  • JavaScript 中 Go 风格的错误处理

    几乎每个每天使用 javascript 的人都知道 try-catch 处理起来很痛苦,尤其是当你有多个错误需要处理时。 大多数提出的解决方案都试图复制 golang 的方法 – 将所有内容作为返回值处理。除其他外,它是 go …

    2025年3月7日
    100
  • 请查看我的项目

    我使用Nextjs和tailwind独立完成了Frontend Mentor的Devjobs项目。有人可以查看项目和/或代码并给我任何反馈吗?我是一个学习者。 部署:https://nextjs-devjobs.vercel.app/ Gi…

    2025年3月7日
    200
  • 破解编码面试:快慢指针技术部分

    在深入研究下一个技术之前,如果您正在准备编码面试并想要全面的资源,请务必探索破解编码面试的十大必备书籍(从初级到高级排名)。对于任何决心在顶级科技公司找到工作的人来说,这都是一本必备的书。 快指针和慢指针技术概述 快慢指针技术(也称为弗洛伊…

    2025年3月7日
    200
  • JUnit 测试:综合指南

    junit 是 java 生态系统中广泛使用的测试框架,旨在帮助开发人员编写和运行可重复的测试。它在确保代码按预期运行方面发挥着至关重要的作用,使其成为维护软件质量的重要工具。凭借其广泛的功能和易用性,junit 已成为 java 单元测试…

    2025年3月7日
    200
  • 注重隐私的在线 PDF 编辑器

    照片来自 Markus Spiske privpdf.com 是 Neural Nirvana 的一个开源项目,旨在优先考虑 PDF 文档的隐私和安全。几乎我们每个人都使用过在线PDF编辑器服务来合并、拆分、编辑、水印PDF文件。但在线操作…

    2025年3月7日
    200
  • 使用 React 和本地存储创建 Notes 应用程序

    您是否希望使用 React 构建一个简单但功能强大的 Notes 应用程序?在本文中,我将引导您完成创建功能齐全的 Notes 应用程序的过程,该应用程序使用浏览器的本地存储功能在本地存储您的数据。 您将学习如何: 从头开始建立一个基本的 …

    2025年3月7日
    200
  • 使用 Nuxt v3 设置 Supabase Auth

    实现身份验证是您在大多数项目中都会做的事情,但由于您实际执行此操作的频率,您可能仍然不记得如何执行此操作。 以下是有关使用 nuxt v3 实施 supabase auth 的快速方法。在此示例中,我们将使用 otp,但它适用于所有情况。 …

    2025年3月7日
    200

发表回复

登录后才能评论