feat：添加url参数 #1
Closed
feat：添加url参数 #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📝 Walkthrough📝 WalkthroughWalkthrough此次更改主要集中在 Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
src/index.ts (1)
214-221: 冗余的参数检查代码在 Yargs 的
check方法中已对--input和--url参数进行了充分的验证，此处的检查可能多余。为了代码的简洁和避免重复，建议移除此处的冗余检查。
} else { throw new Error('必须提供 --input 或 --url 参数之一'); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (1)
src/index.ts(5 hunks)
🔇 Additional comments (3)
src/index.ts (3)
13-21: 新增函数 isValidUrl 实现正确
isValidUrl 函数正确地验证了 URL 字符串的有效性，实现符合预期。
199-202: 删除重复的 url 参数定义
url 参数已在之前定义，此处不需要再次定义，删除重复定义以避免冲突。
161-170: 参数验证逻辑完善
验证了只能提供 --input 或 --url 参数，但不能同时提供，两者至少提供一个，并对提供的 URL 格式进行验证，逻辑正确且完善。
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
src/index.ts (3)
13-38: 建议改进 URL 验证逻辑当前的 URL 验证实现有以下可以改进的地方：
标准协议的正则表达式可以更严格：
- 当前实现允许任何以协议开头的字符串
- 建议增加更严格的域名和路径验证
SSH URL 验证可以更完善：
- 当前实现仅检查格式，未验证域名部分
- 建议增加域名格式验证
建议按如下方式优化实现：
function isValidUrl(urlString: string): boolean { try { - if (urlString.match(/^(http|https|ftp|ssh|file):\/\//)) { + if (urlString.match(/^(http|https|ftp|ssh|file):\/\/[a-zA-Z0-9-_.]+\.[a-zA-Z]{2,}(:[0-9]+)?(\/[^?#]*)?(\?[^#]*)?(#.*)?$/)) { new URL(urlString); return true; } - if (urlString.match(/^git@[^:]+:/)) { + if (urlString.match(/^git@[a-zA-Z0-9-_.]+\.[a-zA-Z]{2,}:/)) { return true; }
236-243: 建议改进类型处理和错误消息当前实现中的类型处理和错误消息可以改进：
类型断言可以更安全：
- 使用
as string可能不够安全- 建议增加运行时类型检查
错误消息可以更具体：
- 当前错误消息较为简单
- 建议提供更详细的上下文信息
建议按如下方式改进：
let markdownContent: string; if (argv.url) { - markdownContent = await getContentFromUrl(argv.url as string); + if (typeof argv.url !== 'string') { + throw new Error('URL 参数类型错误：期望字符串类型'); + } + markdownContent = await getContentFromUrl(argv.url); } else if (argv.input) { - markdownContent = readMarkdownFile(argv.input as string); + if (typeof argv.input !== 'string') { + throw new Error('输入文件参数类型错误：期望字符串类型'); + } + markdownContent = readMarkdownFile(argv.input); } else { - throw new Error('必须提供 --input 或 --url 参数之一'); + throw new Error('缺少必要参数：请提供 --input（输入文件）或 --url（URL地址）参数之一'); }
Line range hint
271-280: 建议修复进程退出处理逻辑当前的错误处理存在一个问题：
finally块中总是使用process.exit(0)退出- 这会覆盖
catch块中的错误退出码建议修改为：
main() .catch((error) => { console.error('未处理的错误:', error); process.exit(1); - }) - .finally(() => { - process.exit(0); });
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
src/index.ts(5 hunks)
🔇 Additional comments (2)
src/index.ts (2)
221-224:
URL 参数在 Yargs 配置中重复定义
在代码中发现 url 参数被重复定义，这可能会导致参数解析出现问题。建议删除第二个重复的定义（221-224 行）。
111-166: 🛠️ Refactor suggestion
建议优化错误处理和超时配置
-
错误日志处理不一致：
- 第一次尝试使用
console.log - 建议统一使用
console.error
- 第一次尝试使用
-
超时配置可以提取为常量：
- 当前硬编码为 5000ms
- 建议提取为可配置项
建议进行如下修改：
+const URL_REQUEST_TIMEOUT = 5000; // 配置超时时间（毫秒）
+
async function getContentFromUrl(urlString: string): Promise<string> {
const tempDir = os.tmpdir();
const tempFile = path.join(tempDir, `md_${Date.now()}.md`);
try {
const response = await axios({
method: 'get',
url: urlString,
headers: {
'User-Agent': 'Mozilla/5.0',
Accept: 'text/markdown,text/plain,*/*',
},
responseType: 'arraybuffer',
- timeout: 5000,
+ timeout: URL_REQUEST_TIMEOUT,
});
return response.data.toString('utf-8');
} catch (firstError) {
- console.log('firstError', firstError);
+ console.error('第一次获取内容失败：', firstError);Likely invalid or redundant comment.
Comment on lines
+111
to
+166
| async function getContentFromUrl(urlString: string): Promise<string> { | ||
| const tempDir = os.tmpdir(); | ||
| const tempFile = path.join(tempDir, `md_${Date.now()}.md`); | ||
| try { | ||
| // 第一次尝试：直接获取内容 | ||
| const response = await axios({ | ||
| method: 'get', | ||
| url: urlString, | ||
| headers: { | ||
| 'User-Agent': 'Mozilla/5.0', | ||
| Accept: 'text/markdown,text/plain,*/*', | ||
| }, | ||
| responseType: 'arraybuffer', | ||
| timeout: 5000, // 5秒超时 | ||
| }); | ||
| return response.data.toString('utf-8'); | ||
| } catch (firstError) { | ||
| console.log('firstError', firstError); | ||
| try { | ||
| // 第二次尝试：作为文件下载 | ||
| const response = await axios({ | ||
| method: 'get', | ||
| url: urlString, | ||
| headers: { | ||
| 'User-Agent': 'Mozilla/5.0', | ||
| Accept: 'application/octet-stream', | ||
| }, | ||
| responseType: 'stream', | ||
| timeout: 5000, | ||
| }); | ||
|
|
||
| // 写入临时文件 | ||
| const writer = fs.createWriteStream(tempFile); | ||
| response.data.pipe(writer); | ||
|
|
||
| await new Promise((resolve, reject) => { | ||
| writer.on('finish', resolve); | ||
| writer.on('error', reject); | ||
| }); | ||
|
|
||
| // 读取临时文件内容 | ||
| const content = fs.readFileSync(tempFile, 'utf-8'); | ||
| // 删除临时文件 | ||
| fs.unlinkSync(tempFile); | ||
| return content; | ||
| } catch (secondError) { | ||
| // 简化错误信息 | ||
| throw new Error(`无法从 URL 获取内容: ${urlString}`); | ||
| } finally { | ||
| // 确保删除临时文件 | ||
| if (fs.existsSync(tempFile)) { | ||
| fs.unlinkSync(tempFile); | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
建议增加安全性检查
当前的 URL 内容获取实现存在潜在的安全风险：
-
缺少文件大小限制：
- 恶意 URL 可能返回超大文件
- 建议添加最大文件大小限制
-
缺少内容类型验证：
- 未验证下载内容是否为 Markdown
- 建议增加基本的内容格式验证
建议添加以下安全措施：
+const MAX_FILE_SIZE = 10 * 1024 * 1024; // 10MB 限制
+
async function getContentFromUrl(urlString: string): Promise<string> {
const tempDir = os.tmpdir();
const tempFile = path.join(tempDir, `md_${Date.now()}.md`);
try {
const response = await axios({
method: 'get',
url: urlString,
headers: {
'User-Agent': 'Mozilla/5.0',
Accept: 'text/markdown,text/plain,*/*',
},
responseType: 'arraybuffer',
timeout: 5000,
+ maxContentLength: MAX_FILE_SIZE,
});
+
+ // 验证内容类型
+ const contentType = response.headers['content-type'];
+ if (!contentType?.includes('text/markdown') && !contentType?.includes('text/plain')) {
+ throw new Error(`不支持的内容类型: ${contentType}`);
+ }
+
return response.data.toString('utf-8');Committable suggestion skipped: line range outside the PR's diff.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.