mirror of
https://github.com/go-task/task.git
synced 2026-07-08 06:28:44 +00:00
1 line
11 KiB
JavaScript
1 line
11 KiB
JavaScript
"use strict";(self.webpackChunktaskfile_dev=self.webpackChunktaskfile_dev||[]).push([[31],{3905:function(e,n,t){t.d(n,{Zo:function(){return u},kt:function(){return k}});var a=t(7294);function r(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function l(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);n&&(a=a.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,a)}return t}function o(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?l(Object(t),!0).forEach((function(n){r(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):l(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function i(e,n){if(null==e)return{};var t,a,r=function(e,n){if(null==e)return{};var t,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)t=l[a],n.indexOf(t)>=0||(r[t]=e[t]);return r}(e,n);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)t=l[a],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(r[t]=e[t])}return r}var s=a.createContext({}),c=function(e){var n=a.useContext(s),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=c(e.components);return a.createElement(s.Provider,{value:n},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var n=e.children;return a.createElement(a.Fragment,{},n)}},m=a.forwardRef((function(e,n){var t=e.components,r=e.mdxType,l=e.originalType,s=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),d=c(t),m=r,k=d["".concat(s,".").concat(m)]||d[m]||p[m]||l;return t?a.createElement(k,o(o({ref:n},u),{},{components:t})):a.createElement(k,o({ref:n},u))}));function k(e,n){var t=arguments,r=n&&n.mdxType;if("string"==typeof e||r){var l=t.length,o=new Array(l);o[0]=m;var i={};for(var s in n)hasOwnProperty.call(n,s)&&(i[s]=n[s]);i.originalType=e,i[d]="string"==typeof e?e:r,o[1]=i;for(var c=2;c<l;c++)o[c]=t[c];return a.createElement.apply(null,o)}return a.createElement.apply(null,t)}m.displayName="MDXCreateElement"},2114:function(e,n,t){t.r(n),t.d(n,{assets:function(){return s},contentTitle:function(){return o},default:function(){return d},frontMatter:function(){return l},metadata:function(){return i},toc:function(){return c}});var a=t(3117),r=(t(7294),t(3905));const l={slug:"/styleguide/",sidebar_position:7},o="\u98ce\u683c\u6307\u5357",i={unversionedId:"styleguide",id:"styleguide",title:"\u98ce\u683c\u6307\u5357",description:"\u8fd9\u662f\u5bf9 Taskfile.yml \u6587\u4ef6\u7684\u5b98\u65b9\u98ce\u683c\u6307\u5357\u3002 \u672c\u6307\u5357\u5305\u542b\u4e00\u4e9b\u57fa\u672c\u8bf4\u660e\uff0c\u53ef\u8ba9\u60a8\u7684\u4efb\u52a1\u6587\u4ef6\u4fdd\u6301\u7b80\u6d01\u6613\u7528\u3002",source:"@site/i18n/zh-Hans/docusaurus-plugin-content-docs/current/styleguide.md",sourceDirName:".",slug:"/styleguide/",permalink:"/zh-Hans/styleguide/",draft:!1,tags:[],version:"current",sidebarPosition:7,frontMatter:{slug:"/styleguide/",sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"\u5e38\u89c1\u95ee\u9898",permalink:"/zh-Hans/faq/"},next:{title:"\u66f4\u65b0\u65e5\u5fd7",permalink:"/zh-Hans/changelog/"}},s={},c=[{value:"\u4f7f\u7528 <code>Taskfile.yml</code> \u800c\u4e0d\u662f <code>taskfile.yml</code>",id:"\u4f7f\u7528-taskfileyml-\u800c\u4e0d\u662f-taskfileyml",level:2},{value:"\u4f7f\u7528\u6b63\u786e\u7684\u5173\u952e\u5b57\u987a\u5e8f",id:"\u4f7f\u7528\u6b63\u786e\u7684\u5173\u952e\u5b57\u987a\u5e8f",level:2},{value:"\u4f7f\u75282 \u4e2a\u7a7a\u683c\u7f29\u8fdb",id:"\u4f7f\u75282-\u4e2a\u7a7a\u683c\u7f29\u8fdb",level:2},{value:"\u7528\u7a7a\u884c\u5206\u9694\u4e3b\u8981\u90e8\u5206",id:"\u7528\u7a7a\u884c\u5206\u9694\u4e3b\u8981\u90e8\u5206",level:2},{value:"\u7528\u7a7a\u884c\u5206\u9694 task",id:"\u7528\u7a7a\u884c\u5206\u9694-task",level:2},{value:"\u4f7f\u7528\u5927\u5199\u53d8\u91cf\u540d\u79f0",id:"\u4f7f\u7528\u5927\u5199\u53d8\u91cf\u540d\u79f0",level:2},{value:"\u6a21\u677f\u4e2d\u4e0d\u8981\u7528\u7a7a\u683c\u5305\u4f4f\u53d8\u91cf",id:"\u6a21\u677f\u4e2d\u4e0d\u8981\u7528\u7a7a\u683c\u5305\u4f4f\u53d8\u91cf",level:2},{value:"\u7528\u7834\u6298\u53f7\u5206\u9694\u4efb\u52a1\u540d\u79f0\u5355\u8bcd",id:"\u7528\u7834\u6298\u53f7\u5206\u9694\u4efb\u52a1\u540d\u79f0\u5355\u8bcd",level:2},{value:"\u4f7f\u7528\u5192\u53f7\u4f5c\u4e3a\u4efb\u52a1\u547d\u540d\u7a7a\u95f4",id:"\u4f7f\u7528\u5192\u53f7\u4f5c\u4e3a\u4efb\u52a1\u547d\u540d\u7a7a\u95f4",level:2}],u={toc:c};function d(e){let{components:n,...t}=e;return(0,r.kt)("wrapper",(0,a.Z)({},u,t,{components:n,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"\u98ce\u683c\u6307\u5357"},"\u98ce\u683c\u6307\u5357"),(0,r.kt)("p",null,"\u8fd9\u662f\u5bf9 ",(0,r.kt)("inlineCode",{parentName:"p"},"Taskfile.yml")," \u6587\u4ef6\u7684\u5b98\u65b9\u98ce\u683c\u6307\u5357\u3002 \u672c\u6307\u5357\u5305\u542b\u4e00\u4e9b\u57fa\u672c\u8bf4\u660e\uff0c\u53ef\u8ba9\u60a8\u7684\u4efb\u52a1\u6587\u4ef6\u4fdd\u6301\u7b80\u6d01\u6613\u7528\u3002"),(0,r.kt)("p",null,"\u8fd9\u5305\u542b\u4e00\u822c\u51c6\u5219\uff0c\u4f46\u4e0d\u4e00\u5b9a\u9700\u8981\u4e25\u683c\u9075\u5b88\u3002 \u5982\u679c\u4f60\u9700\u8981\u6216\u60f3\u8981\uff0c\u8bf7\u968f\u65f6\u63d0\u51fa\u4e0d\u540c\u610f\u89c1\uff0c\u5e76\u5728\u67d0\u4e9b\u65f6\u5019\u4ee5\u4e0d\u540c\u65b9\u5f0f\u8fdb\u884c\u3002 \u6b64\u5916\uff0c\u8bf7\u968f\u65f6\u6253\u5f00 Issue \u6216 PR\uff0c\u5bf9\u672c\u6307\u5357\u8fdb\u884c\u6539\u8fdb\u3002"),(0,r.kt)("h2",{id:"\u4f7f\u7528-taskfileyml-\u800c\u4e0d\u662f-taskfileyml"},"\u4f7f\u7528 ",(0,r.kt)("inlineCode",{parentName:"h2"},"Taskfile.yml")," \u800c\u4e0d\u662f ",(0,r.kt)("inlineCode",{parentName:"h2"},"taskfile.yml")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\ntaskfile.yml\n\n\n# good\nTaskfile.yml\n")),(0,r.kt)("p",null,"\u8fd9\u5bf9\u4e8e Linux \u7528\u6237\u5c24\u5176\u91cd\u8981\u3002 Windows \u548c macOS \u7684\u6587\u4ef6\u7cfb\u7edf\u4e0d\u533a\u5206\u5927\u5c0f\u5199\uff0c\u56e0\u6b64 ",(0,r.kt)("inlineCode",{parentName:"p"},"taskfile.yml")," \u6700\u7ec8\u4f1a\u6b63\u5e38\u5de5\u4f5c\uff0c\u5373\u4f7f\u5b83\u4e0d\u53d7\u5b98\u65b9\u652f\u6301\u3002 \u4e0d\u8fc7\uff0c\u5728 Linux \u4e0a\uff0c\u53ea\u6709 ",(0,r.kt)("inlineCode",{parentName:"p"},"Taskfile.yml")," \u53ef\u4ee5\u5de5\u4f5c\u3002"),(0,r.kt)("h2",{id:"\u4f7f\u7528\u6b63\u786e\u7684\u5173\u952e\u5b57\u987a\u5e8f"},"\u4f7f\u7528\u6b63\u786e\u7684\u5173\u952e\u5b57\u987a\u5e8f"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"version:")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"includes:")),(0,r.kt)("li",{parentName:"ul"},"\u53ef\u9009\u914d\u7f6e\u547d\u4ee4\uff0c\u6bd4\u5982 ",(0,r.kt)("inlineCode",{parentName:"li"},"output:"),"\u3001",(0,r.kt)("inlineCode",{parentName:"li"},"silent:"),"\u3001",(0,r.kt)("inlineCode",{parentName:"li"},"method:")," \u548c ",(0,r.kt)("inlineCode",{parentName:"li"},"run:")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"vars:")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"env:"),"\u3001",(0,r.kt)("inlineCode",{parentName:"li"},"dotenv:")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"tasks:"))),(0,r.kt)("h2",{id:"\u4f7f\u75282-\u4e2a\u7a7a\u683c\u7f29\u8fdb"},"\u4f7f\u75282 \u4e2a\u7a7a\u683c\u7f29\u8fdb"),(0,r.kt)("p",null,"\u8fd9\u662f YAML \u6587\u4ef6\u6700\u5e38\u89c1\u7684\u7ea6\u5b9a\uff0cTask \u540c\u6837\u4e5f\u9075\u5faa\u5b83\u3002"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\ntasks:\n foo:\n cmds:\n - echo 'foo'\n\n\n# good\ntasks:\n foo:\n cmds:\n - echo 'foo'\n")),(0,r.kt)("h2",{id:"\u7528\u7a7a\u884c\u5206\u9694\u4e3b\u8981\u90e8\u5206"},"\u7528\u7a7a\u884c\u5206\u9694\u4e3b\u8981\u90e8\u5206"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\nversion: '3'\nincludes:\n docker: ./docker/Taskfile.yml\noutput: prefixed\nvars:\n FOO: bar\nenv:\n BAR: baz\ntasks:\n # ...\n\n\n# good\nversion: '3'\n\nincludes:\n docker: ./docker/Taskfile.yml\n\noutput: prefixed\n\nvars:\n FOO: bar\n\nenv:\n BAR: baz\n\ntasks:\n # ...\n")),(0,r.kt)("h2",{id:"\u7528\u7a7a\u884c\u5206\u9694-task"},"\u7528\u7a7a\u884c\u5206\u9694 task"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\nversion: '3'\n\ntasks:\n foo:\n cmds:\n - echo 'foo'\n bar:\n cmds:\n - echo 'bar'\n baz:\n cmds:\n - echo 'baz'\n\n\n# good\nversion: '3'\n\ntasks:\n foo:\n cmds:\n - echo 'foo'\n\n bar:\n cmds:\n - echo 'bar'\n\n baz:\n cmds:\n - echo 'baz'\n")),(0,r.kt)("h2",{id:"\u4f7f\u7528\u5927\u5199\u53d8\u91cf\u540d\u79f0"},"\u4f7f\u7528\u5927\u5199\u53d8\u91cf\u540d\u79f0"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\nversion: '3'\n\nvars:\n binary_name: myapp\n\ntasks:\n build:\n cmds:\n - go build -o {{.binary_name}} .\n\n\n# good\nversion: '3'\n\nvars:\n BINARY_NAME: myapp\n\ntasks:\n build:\n cmds:\n - go build -o {{.BINARY_NAME}} .\n")),(0,r.kt)("h2",{id:"\u6a21\u677f\u4e2d\u4e0d\u8981\u7528\u7a7a\u683c\u5305\u4f4f\u53d8\u91cf"},"\u6a21\u677f\u4e2d\u4e0d\u8981\u7528\u7a7a\u683c\u5305\u4f4f\u53d8\u91cf"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\nversion: '3'\n\ntasks:\n greet:\n cmds:\n - echo '{{ .MESSAGE }}'\n\n\n# good\nversion: '3'\n\ntasks:\n greet:\n cmds:\n - echo '{{.MESSAGE}}'\n")),(0,r.kt)("p",null,"\u8fd9\u4e2a\u7ea6\u5b9a\u4e5f\u88ab\u5927\u591a\u6570\u4eba\u7528\u4e8e Go \u6a21\u677f\u3002"),(0,r.kt)("h2",{id:"\u7528\u7834\u6298\u53f7\u5206\u9694\u4efb\u52a1\u540d\u79f0\u5355\u8bcd"},"\u7528\u7834\u6298\u53f7\u5206\u9694\u4efb\u52a1\u540d\u79f0\u5355\u8bcd"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# bad\nversion: '3'\n\ntasks:\n do_something_fancy:\n cmds:\n - echo 'Do something'\n\n\n# good\nversion: '3'\n\ntasks:\n do-something-fancy:\n cmds:\n - echo 'Do something'\n")),(0,r.kt)("h2",{id:"\u4f7f\u7528\u5192\u53f7\u4f5c\u4e3a\u4efb\u52a1\u547d\u540d\u7a7a\u95f4"},"\u4f7f\u7528\u5192\u53f7\u4f5c\u4e3a\u4efb\u52a1\u547d\u540d\u7a7a\u95f4"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-yaml"},"# good\nversion: '3'\n\ntasks:\n docker:build:\n cmds:\n - docker ...\n\n docker:run:\n cmds:\n - docker-compose ...\n")),(0,r.kt)("p",null,"\u8fd9\u5728\u4f7f\u7528\u5305\u542b\u7684\u4efb\u52a1\u6587\u4ef6\u65f6\u4e5f\u4f1a\u81ea\u52a8\u5b8c\u6210\u3002"))}d.isMDXComponent=!0}}]); |