feat: easy config #468
feat: easy config #468
Conversation
elrrrrrrr
added
documentation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| interface EggAppConfig { | ||
| cnpmcore: typeof cnpmcoreConfig; | ||
| } | ||
| } |
There was a problem hiding this comment.
这段代码通过添加导入语句，扩展了AuthClient接口，并在EggAppConfig中添加了cnpmcore属性。我们无法进行完整的审核因为缺少上下文信息，但是根据这个补丁本身，这里有几点建议：
- 检查config.ts文件或其他相关的文件，确保cnpmcoreConfig被正确地实现和使用。
- 这个补丁中添加了一些注释屏蔽了TS2310错误，如果可能的话，最好避免在代码中使用这样的注释。
- 确认这个补丁是否对代码库中其他部分造成了影响。
There was a problem hiding this comment.
会触发循环引用 bug，用 ts-ignore 可以避免编译直接输出到 d.ts 😈
如果去除的话，需要手动在应用集成时手动赋值。
config.cnpmcore = {
...cnpmcoreConfig,
} as typeof cnpmcoreConfig;
| @@ -0,0 +1 @@ | |||
| export { cnpmcoreConfig } from '../../config/config.default'; | |||
There was a problem hiding this comment.
这段代码补丁很简单，主要是将一个名为“cnpmcoreConfig”的导出对象从默认配置文件中导出。在没有更多上下文的情况下，很难评估此代码是否存在任何错误风险或改进建议。但是，如果你能提供更多信息，那么我就可以更好地帮助你进行代码审查。
| @@ -27,7 +27,7 @@ type LegacyInfo = { | |||
|
|
|||
| type SiteEnvInfo = { | |||
| sync_model: string; | |||
| sync_binary: string; | |||
| sync_binary: boolean; | |||
| instance_start_time: Date; | |||
| node_version: string; | |||
| app_version: string; | |||
There was a problem hiding this comment.
这个代码提供了一个类型别名 LegacyInfo 和一个类型别名 SiteEnvInfo，其中 SiteEnvInfo 包括了一个名为 sync_binary 的字段，类型是由字符串改为了布尔值。代码的更改似乎没有引入任何风险。
有一个改进建议：命名约定中规定应该在布尔值变量名前添加动词 is 或者 has，这样做可以让代码更易读懂，比如 has_sync_binary 或者 is_sync_enabled。
Codecov Report
@@ Coverage Diff @@
## master #468 +/- ##
==========================================
- Coverage 97.53% 97.48% -0.05%
==========================================
Files 166 167 +1
Lines 15437 15519 +82
Branches 2002 1999 -3
==========================================
+ Hits 15056 15129 +73
- Misses 381 390 +9
|
| interface EggAppConfig { | ||
| cnpmcore: typeof cnpmcoreConfig; | ||
| } | ||
| } |
There was a problem hiding this comment.
这段代码加入了对cnpmcoreConfig的导入，并且定义了一个EggAppConfig的接口，
将cnpmcoreConfig设置为Egg应用程序配置的一部分。没有看到与原始代码的比较，难以确定是否存在风险或其它建议。
| @@ -0,0 +1 @@ | |||
| export { cnpmcoreConfig } from '../../config/config.default'; | |||
There was a problem hiding this comment.
代码补丁的作用是将cnpmcoreConfig从文件config/config.default中导出。根据这段代码本身来看，没有发现明显的风险或错误。如果需要更全面的代码审查，请提供更多相关代码信息。至于改进建议，需要更多背景知识才能给出具体的意见。
| @@ -27,7 +27,7 @@ type LegacyInfo = { | |||
|
|
|||
| type SiteEnvInfo = { | |||
| sync_model: string; | |||
| sync_binary: string; | |||
| sync_binary: boolean; | |||
| instance_start_time: Date; | |||
| node_version: string; | |||
| app_version: string; | |||
There was a problem hiding this comment.
这段代码改动较小，主要是将 sync_binary 的类型从字符串改为布尔值。没有明显的风险和潜在的错误。
不过，可以考虑以下几点改进：
- 建议使用更加明确的命名，例如
is_sync_binary_enabled或者has_sync_binary等，增强可读性和易用性。 - 由于
sync_model和sync_binary是相关联的，建议在代码中增加一些注释，来表达两者之间的关系和含义。
| export default () => { | ||
| const config = {}; | ||
| config.cnpmcore = { | ||
| ...cnpmcoreConfig, |
There was a problem hiding this comment.
集成时应当手动对 cnpmcore 进行赋值，目前 mergeConfig 时不会进行deepMerge。如果 cnpmcoreConfig 内新增了默认配置，而应用没有修改，会丢失配置。
|
|
| */ | ||
| redirectNotFound: true, | ||
| /** | ||
| * enable unpkg features, https://github.com/cnpm/cnpmcore/issues/452 |
[skip ci] ## [3.21.0](v3.20.3...v3.21.0) (2023-05-21) ### Features * easy config ([#468](#468)) ([9208392](9208392))
|
🎉 This PR is included in version 3.21.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
cnpmcoreConfig, which needs to be explicitly declared for app config.