{"id":3370,"date":"2024-11-10T10:32:58","date_gmt":"2024-11-10T02:32:58","guid":{"rendered":"https:\/\/fwq.ai\/blog\/3370\/"},"modified":"2024-11-10T10:32:58","modified_gmt":"2024-11-10T02:32:58","slug":"%e6%a0%bc%e5%bc%8f%e5%8c%96%e5%92%8c-linting-%e4%bb%a5%e4%bf%9d%e6%8c%81%e4%b8%80%e8%87%b4%e6%80%a7","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/3370\/","title":{"rendered":"\u683c\u5f0f\u5316\u548c Linting \u4ee5\u4fdd\u6301\u4e00\u81f4\u6027"},"content":{"rendered":"

\u6b64\u6d3b\u52a8\u6d89\u53ca\u5728\u6211\u7684\u5f00\u6e90\u9879\u76ee genereadme \u4e2d\u5b9e\u65bd\u7edf\u8ba1\u5206\u6790\u5de5\u5177\uff0c\u4ee5\u63d0\u9ad8\u4ee3\u7801\u8d28\u91cf\u548c\u4e00\u81f4\u6027\u3002<\/p>\n

\"\u683c\u5f0f\u5316\u548c \u514b\u83b1\u5e03\u6069\u7279\u62c9 \/ \u57fa\u56e0\u81ea\u8ff0\u6587\u4ef6 <\/h2>\n

genereadme \u662f\u4e00\u4e2a\u547d\u4ee4\u884c\u5de5\u5177\uff0c\u5b83\u63a5\u6536\u6e90\u4ee3\u7801\u6587\u4ef6\u5e76\u751f\u6210 readme.md \u6587\u4ef6\uff0c\u8be5\u6587\u4ef6\u5229\u7528 llm \u89e3\u91ca\u6587\u4ef6\u4e2d\u7684\u4ee3\u7801\u3002 <\/h3>\n

\u8d21\u732e <\/h1>\n

\u6b22\u8fce\u4e3a genereadme \u505a\u51fa\u8d21\u732e\uff01\u8bf7\u67e5\u770b contributing.md \u4ee5\u83b7\u53d6\u6709\u5173\u8bbe\u7f6e\u73af\u5883\u3001\u5982\u4f55\u8fd0\u884c\u548c\u6d4b\u8bd5\u8be5\u5de5\u5177\u4ee5\u53ca\u63d0\u4ea4\u66f4\u6539\u7684\u6307\u5357\u3002<\/p>\n

genereadme <\/h1>\n

genereadme \u662f\u4e00\u4e2a\u547d\u4ee4\u884c\u5de5\u5177\uff0c\u5b83\u63a5\u6536\u6587\u4ef6\u3001\u5904\u7406\u5b83\u5e76\u751f\u6210\u4e00\u4e2a readme \u6587\u4ef6\uff0c\u5176\u4e2d\u5305\u542b\u6587\u4ef6\u5185\u5bb9\u7684\u89e3\u91ca\u6216\u6587\u6863\u3002\u8be5\u5de5\u5177\u5229\u7528 open \u804a\u5929\u5b8c\u6210\u6765\u5206\u6790\u6587\u4ef6\u5e76\u751f\u6210\u5185\u5bb9\u3002<\/p>\n

\"\u683c\u5f0f\u5316\u548c<\/p>\n

\u7528\u6cd5<\/h3>\n

\u8be5\u5de5\u5177\u76ee\u524d\u652f\u6301 groq \u548c openrouter\uff0c\u9ed8\u8ba4\u4f7f\u7528 groq\u3002\u5fc5\u987b\u63d0\u4f9b\u76f8\u5e94\u63d0\u4f9b\u5546\u7684\u6709\u6548 api \u5bc6\u94a5\u3002<\/p>\n

\u901a\u8fc7\u521b\u5efa .env \u6587\u4ef6\u6216\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u65f6\u901a\u8fc7 -a \u6216 –api-key \u6807\u5fd7\u6765\u63d0\u4f9b\u6709\u6548\u7684 api \u5bc6\u94a5\uff1a<\/p>\n

api_key=api_key\n\nor\n\ngenereadme <files> -a api_key\ngenereadme <files> --api-key api_key\n<\/files><\/files><\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u5b89\u88c5\u4f9d\u8d56\u9879\uff1a<\/p>\n
npm install -g\n<\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 <\/p>\n
\u4f7f\u7528\u73b0\u6709\u793a\u4f8b\u6587\u4ef6\u8fd0\u884c\u8be5\u5de5\u5177\u6216\u5f00\u59cb\u4f7f\u7528\u60a8\u81ea\u5df1\u7684\uff1a<\/p>\n
genereadme <files genereadme examples>\u2026<\/files><\/pre>\n
 \u767b\u5f55\u540e\u590d\u5236 \u5728 hub \u4e0a\u67e5\u770b <\/p>\n
 \u683c\u5f0f\u5316\u7a0b\u5e8f <\/h2>\n
\u5bf9\u4e8e\u6211\u7684\u683c\u5f0f\u5316\u7a0b\u5e8f\uff0c\u6211\u9009\u62e9\u4f7f\u7528 prettier\u3002\u539f\u56e0\u5f88\u7b80\u5355\uff0c\u6211\u9009\u62e9\u8fd9\u4e2a\u662f\u56e0\u4e3a\u6211\u4e4b\u524d\u53ea\u662f\u4f7f\u7528\u8fc7\u5b83\u7684\u57fa\u672c\u529f\u80fd\uff0c\u5e76\u4e14\u6211\u6253\u7b97\u8fdb\u4e00\u6b65\u4e86\u89e3\u5b83\u3002<\/p>\n
\u4ece\u6280\u672f\u4e0a\u8bb2\uff0c\u6211\u5df2\u7ecf\u5c06 ide \u8bbe\u7f6e\u4e3a\u9ed8\u8ba4\u4f7f\u7528 prettier\uff0c\u56e0\u6b64\u6211\u4ece\u4e00\u5f00\u59cb\u5c31\u5df2\u7ecf\u62e5\u6709\u4e86\u683c\u5f0f\u5316\u7a0b\u5e8f\u3002\u7136\u800c\uff0c\u73b0\u5728\u9879\u76ee\u672c\u8eab\u6709\u4e86\u66f4\u6f02\u4eae\u7684\u8bbe\u7f6e\uff0c\u8fd9\u5c06\u5141\u8bb8\u8d21\u732e\u8005\u4e5f\u4f7f\u7528\u683c\u5f0f\u5316\u7a0b\u5e8f\uff0c\u4f7f\u9879\u76ee\u7684\u4ee3\u7801\u5728\u683c\u5f0f\u65b9\u9762\u4fdd\u6301\u4e00\u81f4\u3002<\/p>\n
\u6211\u53ea\u662f\u5728 .prettierrc \u6587\u4ef6\u4e2d\u6dfb\u52a0\u4e86\u5173\u4e8e\u5982\u4f55\u683c\u5f0f\u5316\u4ee3\u7801\u7684\u89c4\u5219\uff0c\u4ee5\u53ca .\/ \u4e0b\u7684 settings.json \u4e2d\u7684\u4e00\u4e9b\u8bbe\u7f6e\uff0c\u7528\u4e8e\u4fdd\u5b58\u683c\u5f0f\u7b49\u9009\u9879\u3002<\/p>\n
 \u77ed\u7ed2 <\/h2>\n
\u5bf9\u4e8e\u6211\u7684 linter\uff0c\u6211\u9009\u62e9\u4f7f\u7528 eslint\u3002\u7531\u4e8e\u6211\u4f7f\u7528\u7684\u662f javascript\uff0c\u6240\u4ee5\u6211\u4f7f\u7528\u4e86\u4e00\u79cd\u6d41\u884c\u7684 linter\uff0c\u6211\u4ee5\u524d\u4e5f\u6709\u8fc7\u4f7f\u7528\u5b83\u7684\u7ecf\u9a8c\uff0c\u4f46\u6211\u81ea\u5df1\u5e76\u6ca1\u6709\u771f\u6b63\u8bbe\u7f6e\u8fc7\u3002\u56e0\u6b64\uff0c\u6211\u9009\u62e9\u4e86 eslinter\u3002<\/p>\n
\u8bbe\u7f6e eslinter \u5e76\u4e0d\u590d\u6742\u3002\u5728 eslint.config.js \u4e2d\u8fdb\u884c\u7b80\u5355\u7684\u5b89\u88c5\u548c\u8bbe\u7f6e\u89c4\u5219\u5c31\u8db3\u4ee5\u8ba9 linter \u6b63\u5e38\u5de5\u4f5c\u3002\u4f46\u662f\uff0c\u7531\u4e8e\u6211\u540c\u65f6\u4f7f\u7528\u683c\u5f0f\u5316\u7a0b\u5e8f\u548c linter\uff0c\u56e0\u6b64\u6211\u5fc5\u987b\u786e\u4fdd\u5b83\u4eec\u90fd\u80fd\u6b63\u5e38\u5de5\u4f5c\u3002\u5176\u4e2d\u57fa\u672c\u4e0a\u5305\u62ec\u9644\u52a0\u89c4\u5219\uff0c\u4ee5\u786e\u4fdd\u4e0d\u4f1a\u4e0e linter \u548c\u683c\u5f0f\u5316\u7a0b\u5e8f\u53d1\u751f\u4efb\u4f55\u51b2\u7a81\u3002<\/p>\n
 \u5982\u4f55\u4f7f\u7528\u5de5\u5177 <\/h2>\n
\u8fd9\u4e9b\u5de5\u5177\u5728\u9879\u76ee\u4e2d\u7684\u4f7f\u7528\u65b9\u5f0f\u6709\u5f88\u591a\u79cd\uff0c\u6211\u4e2a\u4eba\u66f4\u559c\u6b22\u8fd9\u4e9b\u7279\u5b9a\u7684\u914d\u7f6e\uff1aformat on save for prettier \u548c run on type for eslint\u3002\u8fd9\u6837\uff0clinter \u5c06\u59cb\u7ec8\u5728\u5f00\u53d1\u4eba\u5458\u952e\u5165\u65f6\u68c0\u67e5 linting \u95ee\u9898\uff0c\u7136\u540e\u683c\u5f0f\u5316\u7a0b\u5e8f\u5c06\u5728\u89e6\u53d1\u4fdd\u5b58\u65f6\u81ea\u52a8\u683c\u5f0f\u5316\u66f4\u6539\u3002<\/p>\n
\u7136\u800c\uff0c\u5bf9\u4e8e\u672c\u5468\u7684\u4efb\u52a1\uff0c\u6211\u8fd8\u6dfb\u52a0\u4e86\u811a\u672c\u4ee5\u5141\u8bb8\u7528\u6237\u901a\u8fc7 cli \u624b\u52a8\u8fd0\u884c\u683c\u5f0f\u5316\u7a0b\u5e8f\u548c linter\u3002\u8fd8\u5b9e\u73b0\u4e86\u9884\u63d0\u4ea4\u6302\u94a9\uff0c\u4ee5\u786e\u4fdd\u63d0\u4ea4\u5230\u5b58\u50a8\u5e93\u7684\u4efb\u4f55\u4ee3\u7801\u90fd\u7b26\u5408\u9879\u76ee\u7684\u683c\u5f0f\u548c linting \u6807\u51c6\u3002\u901a\u8fc7\u6dfb\u52a0\u8fd9\u4e2a\u94a9\u5b50\uff0c\u6211\u53ef\u4ee5\u5728\u6bcf\u6b21\u63d0\u4ea4\u4e4b\u524d\u81ea\u52a8\u8fd0\u884c prettier \u548c eslint\uff0c\u5c3d\u65e9\u53d1\u73b0\u4efb\u4f55\u95ee\u9898\u5e76\u4fdd\u6301\u8d21\u732e\u4e4b\u95f4\u7684\u4ee3\u7801\u4e00\u81f4\u6027\u3002\u6b64\u8bbe\u7f6e\u6709\u52a9\u4e8e\u51cf\u5c11\u51fa\u73b0\u5c0f\u683c\u5f0f\u95ee\u9898\u7684\u53ef\u80fd\u6027\uff0c\u5e76\u63d0\u9ad8\u53c2\u4e0e\u8be5\u9879\u76ee\u7684\u4efb\u4f55\u4eba\u7684\u3002<\/p>\n
\u4ee5\u4e0a\u5c31\u662f\u683c\u5f0f\u5316\u548c Linting \u4ee5\u4fdd\u6301\u4e00\u81f4\u6027\u7684\u8be6\u7ec6\u5185\u5bb9\uff0c\u66f4\u591a\u8bf7\u5173\u6ce8\u7c73\u4e91\u5176\u5b83\u76f8\u5173\u6587\u7ae0\uff01<\/p>\n","protected":false},"excerpt":{"rendered":"
\u6b64\u6d3b\u52a8\u6d89\u53ca\u5728\u6211\u7684\u5f00\u6e90\u9879\u76ee genereadme \u4e2d\u5b9e\u65bd\u7edf\u8ba1\u5206\u6790\u5de5\u5177\uff0c\u4ee5\u63d0\u9ad8\u4ee3\u7801\u8d28\u91cf\u548c\u4e00\u81f4\u6027\u3002 \u514b\u83b1\u5e03\u6069\u7279\u62c9 \/ \u57fa\u56e0\u81ea\u8ff0\u6587\u4ef6 genereadme \u662f\u4e00\u4e2a\u547d\u4ee4\u884c\u5de5\u5177\uff0c\u5b83\u63a5\u6536\u6e90\u4ee3\u7801\u6587\u4ef6\u5e76\u751f\u6210 readme.md \u6587\u4ef6\uff0c\u8be5\u6587\u4ef6\u5229\u7528 llm \u89e3\u91ca\u6587\u4ef6\u4e2d\u7684\u4ee3\u7801\u3002 \u8d21\u732e \u6b22\u8fce\u4e3a genereadme \u505a\u51fa\u8d21\u732e\uff01\u8bf7\u67e5\u770b contributing.md \u4ee5\u83b7\u53d6\u6709\u5173\u8bbe\u7f6e\u73af\u5883\u3001\u5982\u4f55\u8fd0\u884c\u548c\u6d4b\u8bd5\u8be5\u5de5\u5177\u4ee5\u53ca\u63d0\u4ea4\u66f4\u6539\u7684\u6307\u5357\u3002 genereadme genereadme \u662f\u4e00\u4e2a\u547d\u4ee4\u884c\u5de5\u5177\uff0c\u5b83\u63a5\u6536\u6587\u4ef6\u3001\u5904\u7406\u5b83\u5e76\u751f\u6210\u4e00\u4e2a readme \u6587\u4ef6\uff0c\u5176\u4e2d\u5305\u542b\u6587\u4ef6\u5185\u5bb9\u7684\u89e3\u91ca\u6216\u6587\u6863\u3002\u8be5\u5de5\u5177\u5229\u7528 open \u804a\u5929\u5b8c\u6210\u6765\u5206\u6790\u6587\u4ef6\u5e76\u751f\u6210\u5185\u5bb9\u3002 \u7528\u6cd5 \u8be5\u5de5\u5177\u76ee\u524d\u652f\u6301 groq \u548c openrouter\uff0c\u9ed8\u8ba4\u4f7f\u7528 groq\u3002\u5fc5\u987b\u63d0\u4f9b\u76f8\u5e94\u63d0\u4f9b\u5546\u7684\u6709\u6548 api \u5bc6\u94a5\u3002 \u901a\u8fc7\u521b\u5efa .env \u6587\u4ef6\u6216\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u65f6\u901a\u8fc7 -a \u6216 –api-key \u6807\u5fd7\u6765\u63d0\u4f9b\u6709\u6548\u7684 api \u5bc6\u94a5\uff1a api_key=api_key or genereadme <files> -a api_key genereadme <files> –api-key api_key <\/files><\/files> \u767b\u5f55\u540e\u590d\u5236 \u5b89\u88c5\u4f9d\u8d56\u9879\uff1a […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[16],"tags":[],"class_list":["post-3370","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/3370","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/comments?post=3370"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/3370\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=3370"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=3370"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=3370"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}