'};n.configure=function(h){var b,g;for(b in h)g=h[b],g!==void 0&&h.hasOwnProperty(b)&&(r[b]=g);return this},n.status=null,n.set=function(h){var b=n.isStarted();h=o(h,r.minimum,1),n.status=h===1?null:h;var g=n.render(!b),v=g.querySelector(r.barSelector),w=r.speed,A=r.easing;return g.offsetWidth,l(function(R){r.positionUsing===""&&(r.positionUsing=n.getPositioningCSS()),a(v,i(h,w,A)),h===1?(a(g,{transition:"none",opacity:1}),g.offsetWidth,setTimeout(function(){a(g,{transition:"all "+w+"ms linear",opacity:0}),setTimeout(function(){n.remove(),R()},w)},w)):setTimeout(R,w)}),this},n.isStarted=function(){return typeof n.status=="number"},n.start=function(){n.status||n.set(0);var h=function(){setTimeout(function(){!n.status||(n.trickle(),h())},r.trickleSpeed)};return r.trickle&&h(),this},n.done=function(h){return!h&&!n.status?this:n.inc(.3+.5*Math.random()).set(1)},n.inc=function(h){var b=n.status;return b?(typeof h!="number"&&(h=(1-b)*o(Math.random()*b,.1,.95)),b=o(b+h,0,.994),n.set(b)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},function(){var h=0,b=0;n.promise=function(g){return!g||g.state()==="resolved"?this:(b===0&&n.start(),h++,b++,g.always(function(){b--,b===0?(h=0,n.done()):n.set((h-b)/h)}),this)}}(),n.render=function(h){if(n.isRendered())return document.getElementById("nprogress");f(document.documentElement,"nprogress-busy");var b=document.createElement("div");b.id="nprogress",b.innerHTML=r.template;var g=b.querySelector(r.barSelector),v=h?"-100":s(n.status||0),w=document.querySelector(r.parent),A;return a(g,{transition:"all 0 linear",transform:"translate3d("+v+"%,0,0)"}),r.showSpinner||(A=b.querySelector(r.spinnerSelector),A&&_(A)),w!=document.body&&f(w,"nprogress-custom-parent"),w.appendChild(b),b},n.remove=function(){m(document.documentElement,"nprogress-busy"),m(document.querySelector(r.parent),"nprogress-custom-parent");var h=document.getElementById("nprogress");h&&_(h)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var h=document.body.style,b="WebkitTransform"in h?"Webkit":"MozTransform"in h?"Moz":"msTransform"in h?"ms":"OTransform"in h?"O":"";return b+"Perspective"in h?"translate3d":b+"Transform"in h?"translate":"margin"};function o(h,b,g){return h
Automate installation for other contributors
Husky.Net brings the dev-dependency concept to the .NET ecosystem.
You can attach husky to your project without adding extra dependencies! This way the other contributors will use your pre-configured tasks automatically.
Attach Husky to your project
To attach Husky to your project, you can use the following command:
dotnet husky attach <path-to-project-file>
+1
This will add the required configuration to your project file.
check out the Manual Attach section for more details.
Disable husky in CI/CD pipelines
You can set the HUSKY environment variable to 0 in order to disable husky in CI/CD pipelines.
Manual Attach
To manually attach husky to your project, add the below code to one of your projects (.csproj/.vbproj).
<Target Name="husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0">
+ <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High"/>
+ <Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High"
+ WorkingDirectory="../../" /> <!--Update this to the relative path to your project root dir -->
+</Target>
+TIP
Make sure to update the working directory depending on your folder structure it should be a relative path to your project root dir
WARNING
Adding the above code to a multiple targeted project will cause husky to run multiple times. e.g <TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
to avoid this, you can add the $(IsCrossTargetingBuild)' == 'true' condition to the target. e.g
<Target Name="husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0 and '$(IsCrossTargetingBuild)' == 'true'">
+...
+package.json alternative
If you are using the npm, add the below code to your package.json file will automatically install husky after the npm install
"scripts": {
+ "prepare": "dotnet tool restore && dotnet husky install"
+ }
+1
2
3
2
3
Using C# code in your git hooks
You can use task runner exec command to execute a C# script.
e.g
dotnet husky exec <csx-file-path>
+# e.g
+# dotnet husky exec .husky/csx/hello.csx
+1
2
3
2
3
Also, you can use your csx scripts in your tasks.
{
+ "command": "dotnet",
+ "args": ["husky", "exec", ".husky/csx/hello.csx"]
+}
+1
2
3
4
2
3
4
Examples
Simple commit message linter
This repo is using a csharp script to lint the commit messages, you can check it here:
`,9),k={href:"https://github.com/alirezanet/Husky.Net/blob/master/.husky/csx/commit-lint.csx",target:"_blank",rel:"noopener noreferrer"},m=t("commit-lint.csx"),b=n(`using System.Text.RegularExpressions;
+
+private var pattern = @"^(?=.{1,90}$)(?:build|feat|ci|chore|docs|fix|perf|refactor|revert|style|test)(?:\\(.+\\))*(?::).{4,}(?:#\\d+)*(?<![\\.\\s])$";
+private var msg = File.ReadAllLines(Args[0])[0];
+
+if (Regex.IsMatch(msg, pattern))
+ return 0;
+
+Console.ForegroundColor = ConsoleColor.Red;
+Console.WriteLine("Invalid commit message");
+Console.ResetColor();
+Console.WriteLine("e.g: 'feat(scope): subject' or 'fix: subject'");
+Console.ForegroundColor = ConsoleColor.Gray;
+Console.WriteLine("more info: https://www.conventionalcommits.org/en/v1.0.0/");
+
+return 1;
+1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+dotnet husky run --name "commit-message-linter" --args "$1"
+echo
+echo Great work! \u{1F942}
+echo
+1
2
3
4
5
6
7
2
3
4
5
6
7
],
+ "tasks": [
+ {
+ "name": "commit-message-linter",
+ "command": "dotnet",
+ "args": ["husky", "exec", ".husky/csx/commit-lint.csx", "--args", "\${args}"]
+1
2
3
4
5
6
2
3
4
5
6
Setup husky for your project
cd <Your project root directory>
+dotnet husky install
+TIP
With the global installation, you don't need to add the dotnet prefix to the commands.
Add your first hook
dotnet husky add pre-commit -c "echo 'Husky.Net is awesome!'"
+git add .husky/pre-commit
+Make a commit
git commit -m "Keep calm and commit"
+# \`echo 'Husky.Net is awesome!'\` will run every time you commit
+Contribute to the project
Any kind of contribution is welcome.
start contributing to the project by submitting pull requests
Todos
- \u26A1 Improve the documentation
- \u26A1 Add unit-tests
Documentation
Husky.Net documentation is powered by vuePress, All the markdown source files are placed in docs directory.
by running the following commands, you can run the documentation site locally:
',8),m=e("div",{class:"language-cmd ext-cmd line-numbers-mode"},[e("pre",{class:"language-cmd"},[e("code",null,`yarn install +yarn dev +`)]),e("div",{class:"line-numbers"},[e("span",{class:"line-number"},"1"),e("br"),e("span",{class:"line-number"},"2"),e("br")])],-1),b=e("div",{class:"language-cmd ext-cmd line-numbers-mode"},[e("pre",{class:"language-cmd"},[e("code",null,`npm install +npm run dev +`)]),e("div",{class:"line-numbers"},[e("span",{class:"line-number"},"1"),e("br"),e("span",{class:"line-number"},"2"),e("br")])],-1),f=e("h2",{id:"how-to-contribute",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-to-contribute","aria-hidden":"true"},"#"),o(" How to contribute")],-1),g=o("check out the "),x={href:"https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project",target:"_blank",rel:"noopener noreferrer"},k=o("github contributing guide"),y=e("h2",{id:"contributors",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#contributors","aria-hidden":"true"},"#"),o(" Contributors")],-1),v={href:"https://github.com/alirezanet",target:"_blank",rel:"noopener noreferrer"},j=o("AliReZa Sabouri"),w={href:"https://github.com/SajjadHosseinPour",target:"_blank",rel:"noopener noreferrer"},C=o("Sajjad Hossein Pour"),A={href:"https://github.com/atifaziz",target:"_blank",rel:"noopener noreferrer"},z=o("Atif Aziz"),G={href:"https://github.com/acesyde",target:"_blank",rel:"noopener noreferrer"},H=o("Pierre Mercier"),I=e("li",null,"Add your name",-1);function N(P,S){const s=r("CodeGroupItem"),i=r("CodeGroup"),n=r("ExternalLinkIcon");return c(),l(d,null,[p,t(i,null,{default:a(()=>[t(s,{title:"yarn"},{default:a(()=>[m]),_:1}),t(s,{title:"npm"},{default:a(()=>[b]),_:1})]),_:1}),f,e("p",null,[g,e("a",x,[k,t(n)])]),y,e("ul",null,[e("li",null,[e("a",v,[j,t(n)])]),e("li",null,[e("a",w,[C,t(n)])]),e("li",null,[e("a",A,[z,t(n)])]),e("li",null,[e("a",G,[H,t(n)])]),I])],64)}var E=h(_,[["render",N]]);export{E as default}; diff --git a/assets/index.html.504c7800.js b/assets/index.html.504c7800.js new file mode 100644 index 0000000..8fe03b2 --- /dev/null +++ b/assets/index.html.504c7800.js @@ -0,0 +1 @@ +import{_ as e}from"./plugin-vue_export-helper.21dcd24c.js";const r={};function _(c,n){return null}var o=e(r,[["render",_]]);export{o as default}; diff --git a/assets/index.html.56e1725b.js b/assets/index.html.56e1725b.js new file mode 100644 index 0000000..5c56b23 --- /dev/null +++ b/assets/index.html.56e1725b.js @@ -0,0 +1 @@ +import{r as n,o as r,c as a,b as e,a as s,F as i,e as o}from"./app.22727b9e.js";import{_ as l}from"./plugin-vue_export-helper.21dcd24c.js";var d="/Husky.Net/assets/workflow.290a20c9.jpg";const c={},h=e("h1",{id:"introduction",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#introduction","aria-hidden":"true"},"#"),o(" Introduction")],-1),u=e("p",null,[e("img",{src:d,alt:"Husky.Net WorkFlow"})],-1),_=e("blockquote",null,[e("p",null,"Husky improves your commits and more \u{1F436} woof!"),e("p",null,"Run linters against staged git files and don't let \u{1F4A9} slip into your code base!")],-1),m=o("These two quotes from "),p={href:"https://github.com/typicode/husky",target:"_blank",rel:"noopener noreferrer"},f=o("husky"),y=o(" and "),k={href:"https://github.com/okonet/lint-staged",target:"_blank",rel:"noopener noreferrer"},g=o("lint-staged"),b=o(" JS tools inspired me to create Husky.Net for dotnet developers. it provides a simple native way to do both also has a lot of other cool features, You can use it to lint your commit messages, run tests, lint/format code, etc... when you commit or push. \u{1F680}\u{1F680}"),w=e("h2",{id:"features",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#features","aria-hidden":"true"},"#"),o(" Features")],-1),v=e("li",null,[o("\u{1F525} It brings the "),e("strong",null,"dev-dependency"),o(" concept to the .NET world!")],-1),x=e("li",null,"\u{1F525} Supports all Git & gitflow hooks",-1),N=e("li",null,"\u{1F525} Internal task runner!",-1),S=e("li",null,"Multiple file states (staged, last-commit, git-files, etc...)",-1),H=e("li",null,"CSharp scripts (csx)",-1),I=e("li",null,"Supports macOS, Linux and Windows",-1),C=e("li",null,"Powered by modern new Git feature (core.hooksPath)",-1),T=e("li",null,"User-define variables",-1),G=o("Compatible with "),j={href:"https://github.com/dotnet/format",target:"_blank",rel:"noopener noreferrer"},L=o("dotnet-format"),W=o(", "),E={href:"https://csharpier.com/",target:"_blank",rel:"noopener noreferrer"},F=o("CSharpier"),A=o(", "),B={href:"https://www.jetbrains.com/help/resharper/ReSharper_Command_Line_Tools.html",target:"_blank",rel:"noopener noreferrer"},R=o("ReSharper command line tools"),U=o(" and other formatting tools"),V=e("li",null,"User-friendly messages",-1),q=e("li",null,"Git GUIs",-1),D=e("li",null,"Custom directories",-1),M=e("li",null,"Monorepo",-1),O=e("p",null,[o("-"),e("em",null,"A lot of features are coming soon, stay tuned! \u{1F441}\uFE0F\u200D\u{1F5E8}\uFE0F\u{1F440}")],-1),P=e("h2",{id:"why-use-hooks-and-husky-net",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#why-use-hooks-and-husky-net","aria-hidden":"true"},"#"),o(" Why use Hooks and Husky.Net?")],-1),Y=e("p",null,"We, as developers, love platforms like GitHub, GitLab, Atlassian, Azure DevOps etc., as our managed git system and collaboration platform. We also love clean code and keep inventing new linters and rules to enforce it. In my opinion, every commit should allow the codebase to deploy to production. There is nothing worse than commits like \u201Cfixed style errors\u201D or \u201Cfixed build\u201D. These are often small mistakes you want to know as early as possible in your development cycle. You don\u2019t want to break the build for the next developer because he pulled your \u2018mistake\u2019 or waste precious build minutes of your CI server. Say you have asked your teammate to review your code; in the meantime, the build server rejects your code. That means you have to go back and fix this, and your teammate has to come back and possibly review again after the changes (i.e., approvals reset on new commit). Doing so would waste a lot of time and effort.",-1),z=e("p",null,"Husky.Net offers a very simple way to start using git hooks or running certain tasks, write and run custom scripts and more ...",-1);function J(K,Q){const t=n("ExternalLinkIcon");return r(),a(i,null,[h,u,_,e("p",null,[m,e("a",p,[f,s(t)]),y,e("a",k,[g,s(t)]),b]),w,e("ul",null,[v,x,N,S,H,I,C,T,e("li",null,[G,e("a",j,[L,s(t)]),W,e("a",E,[F,s(t)]),A,e("a",B,[R,s(t)]),U]),V,q,D,M]),O,P,Y,z],64)}var $=l(c,[["render",J]]);export{$ as default}; diff --git a/assets/index.html.710bbd8d.js b/assets/index.html.710bbd8d.js new file mode 100644 index 0000000..01595a2 --- /dev/null +++ b/assets/index.html.710bbd8d.js @@ -0,0 +1 @@ +const t={key:"v-42d847c6",path:"/contribution/",title:"Contribute to the project",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Todos",slug:"todos",children:[]},{level:2,title:"Documentation",slug:"documentation",children:[]},{level:2,title:"How to contribute",slug:"how-to-contribute",children:[]},{level:2,title:"Contributors",slug:"contributors",children:[]}],git:{updatedTime:1673097895e3},filePathRelative:"contribution/README.md"};export{t as data}; diff --git a/assets/index.html.80ef201c.js b/assets/index.html.80ef201c.js new file mode 100644 index 0000000..e1f945e --- /dev/null +++ b/assets/index.html.80ef201c.js @@ -0,0 +1 @@ +const t={key:"v-8daa1a0e",path:"/",title:"Welcome",lang:"en-US",frontmatter:{home:!0,title:"Welcome",tagline:"It brings the dev-dependency concept to the .NET world!",actions:[{text:"Get Started",link:"/guide/getting-started.md",type:"primary"},{text:"Introduction",link:"/guide/",type:"secondary"}],features:[{title:"Easy To Use",details:"Just with a few commands you can start using the git hooks to keep your code clean and organized."},{title:"Git hooks",details:"Supports all git and git-flow hooks, powered by modern git features."},{title:"Task Runner",details:"Has a powerful task runner that you can use to manage and run linters, tests, scripts, and more."},{title:"Automate for everyone",details:"You can configure it to automatically run your tasks when other contributors work with your repository."},{title:"Multiple File States",details:"Supports multiple file states like staged, last-commit, git-files, etc, and user-defined states."},{title:"CSharp Script",details:"Supports C# scripting for more complex tasks."}],footer:"MIT Licensed | Copyright \xA9 2022-present AliReZa Sabouri"},excerpt:"",headers:[],git:{updatedTime:1642251873e3},filePathRelative:"README.md"};export{t as data}; diff --git a/assets/index.html.c4b28ab0.js b/assets/index.html.c4b28ab0.js new file mode 100644 index 0000000..4c8d3fe --- /dev/null +++ b/assets/index.html.c4b28ab0.js @@ -0,0 +1 @@ +const e={key:"v-fffb8e28",path:"/guide/",title:"Introduction",lang:"en-US",frontmatter:{},excerpt:"",headers:[{level:2,title:"Features",slug:"features",children:[]},{level:2,title:"Why use Hooks and Husky.Net?",slug:"why-use-hooks-and-husky-net",children:[]}],git:{updatedTime:1680598084e3},filePathRelative:"guide/README.md"};export{e as data}; diff --git a/assets/plugin-vue_export-helper.21dcd24c.js b/assets/plugin-vue_export-helper.21dcd24c.js new file mode 100644 index 0000000..aae20ad --- /dev/null +++ b/assets/plugin-vue_export-helper.21dcd24c.js @@ -0,0 +1 @@ +var a=(t,o)=>{const r=t.__vccOpts||t;for(const[e,_]of o)r[e]=_;return r};export{a as _}; diff --git a/assets/search.0782d0d1.svg b/assets/search.0782d0d1.svg new file mode 100644 index 0000000..03d8391 --- /dev/null +++ b/assets/search.0782d0d1.svg @@ -0,0 +1 @@ + diff --git a/assets/style.217a916a.css b/assets/style.217a916a.css new file mode 100644 index 0000000..fbc4595 --- /dev/null +++ b/assets/style.217a916a.css @@ -0,0 +1 @@ +:root{--external-link-icon-color:#aaa}.external-link-icon{position:relative;display:inline-block;color:var(--external-link-icon-color);vertical-align:middle;top:-1px}:root{--medium-zoom-z-index:100;--medium-zoom-bg-color:#ffffff;--medium-zoom-opacity:1}.medium-zoom-overlay{background-color:var(--medium-zoom-bg-color)!important;z-index:var(--medium-zoom-z-index)}.medium-zoom-overlay~img{z-index:calc(var(--medium-zoom-z-index) + 1)}.medium-zoom--opened .medium-zoom-overlay{opacity:var(--medium-zoom-opacity)}:root{--c-brand:#3eaf7c;--c-brand-light:#4abf8a;--c-bg:#ffffff;--c-bg-light:#f3f4f5;--c-bg-lighter:#eeeeee;--c-bg-navbar:var(--c-bg);--c-bg-sidebar:var(--c-bg);--c-bg-arrow:#cccccc;--c-text:#2c3e50;--c-text-accent:var(--c-brand);--c-text-light:#3a5169;--c-text-lighter:#4e6e8e;--c-text-lightest:#6a8bad;--c-text-quote:#999999;--c-border:#eaecef;--c-border-dark:#dfe2e5;--c-tip:#42b983;--c-tip-bg:var(--c-bg-light);--c-tip-title:var(--c-text);--c-tip-text:var(--c-text);--c-tip-text-accent:var(--c-text-accent);--c-warning:#e7c000;--c-warning-bg:#fffae3;--c-warning-title:#ad9000;--c-warning-text:#746000;--c-warning-text-accent:var(--c-text);--c-danger:#cc0000;--c-danger-bg:#ffe0e0;--c-danger-title:#990000;--c-danger-text:#660000;--c-danger-text-accent:var(--c-text);--c-details-bg:#eeeeee;--c-badge-tip:var(--c-tip);--c-badge-warning:var(--c-warning);--c-badge-danger:var(--c-danger);--t-color:.3s ease;--t-transform:.3s ease;--code-bg-color:#282c34;--code-hl-bg-color:rgba(0, 0, 0, .66);--code-ln-color:#9e9e9e;--code-ln-wrapper-width:3.5rem;--font-family:-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;--font-family-code:Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;--navbar-height:3.6rem;--navbar-padding-v:.7rem;--navbar-padding-h:1.5rem;--sidebar-width:20rem;--sidebar-width-mobile:calc(var(--sidebar-width) * .82);--content-width:740px;--homepage-width:960px}.back-to-top{--back-to-top-color:var(--c-brand);--back-to-top-color-hover:var(--c-brand-light)}.DocSearch{--docsearch-primary-color:var(--c-brand);--docsearch-text-color:var(--c-text);--docsearch-highlight-color:var(--c-brand);--docsearch-muted-color:var(--c-text-quote);--docsearch-container-background:rgba(9, 10, 17, .8);--docsearch-modal-background:var(--c-bg-light);--docsearch-searchbox-background:var(--c-bg-lighter);--docsearch-searchbox-focus-background:var(--c-bg);--docsearch-searchbox-shadow:inset 0 0 0 2px var(--c-brand);--docsearch-hit-color:var(--c-text-light);--docsearch-hit-active-color:var(--c-bg);--docsearch-hit-background:var(--c-bg);--docsearch-hit-shadow:0 1px 3px 0 var(--c-border-dark);--docsearch-footer-background:var(--c-bg)}.external-link-icon{--external-link-icon-color:var(--c-text-quote)}.medium-zoom-overlay{--medium-zoom-bg-color:var(--c-bg)}#nprogress{--nprogress-color:var(--c-brand)}.pwa-popup{--pwa-popup-text-color:var(--c-text);--pwa-popup-bg-color:var(--c-bg);--pwa-popup-border-color:var(--c-brand);--pwa-popup-shadow:0 4px 16px var(--c-brand);--pwa-popup-btn-text-color:var(--c-bg);--pwa-popup-btn-bg-color:var(--c-brand);--pwa-popup-btn-hover-bg-color:var(--c-brand-light)}.search-box{--search-bg-color:var(--c-bg);--search-accent-color:var(--c-brand);--search-text-color:var(--c-text);--search-border-color:var(--c-border);--search-item-text-color:var(--c-text-lighter);--search-item-focus-bg-color:var(--c-bg-light)}html.dark{--c-brand:#3aa675;--c-brand-light:#349469;--c-bg:#22272e;--c-bg-light:#2b313a;--c-bg-lighter:#262c34;--c-text:#adbac7;--c-text-light:#96a7b7;--c-text-lighter:#8b9eb0;--c-text-lightest:#8094a8;--c-border:#3e4c5a;--c-border-dark:#34404c;--c-tip:#318a62;--c-warning:#ceab00;--c-warning-bg:#7e755b;--c-warning-title:#ceac03;--c-warning-text:#362e00;--c-danger:#940000;--c-danger-bg:#806161;--c-danger-title:#610000;--c-danger-text:#3a0000;--c-details-bg:#323843;--code-hl-bg-color:#363b46;color-scheme:dark}html.dark .DocSearch{--docsearch-logo-color:var(--c-text);--docsearch-modal-shadow:inset 1px 1px 0 0 #2c2e40, 0 3px 8px 0 #000309;--docsearch-key-shadow:inset 0 -2px 0 0 #282d55, inset 0 0 1px 1px #51577d, 0 2px 2px 0 rgba(3, 4, 9, .3);--docsearch-key-gradient:linear-gradient(-225deg, #444950, #1c1e21);--docsearch-footer-shadow:inset 0 1px 0 0 rgba(73, 76, 106, .5), 0 -4px 8px 0 rgba(0, 0, 0, .2)}body,html{padding:0;margin:0;background-color:var(--c-bg);transition:background-color var(--t-color)}body{font-family:var(--font-family);-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;font-size:16px}a,p a code{color:var(--c-text-accent)}a{font-weight:500;text-decoration:none;overflow-wrap:break-word}p a code{font-weight:400}code,kbd{font-family:var(--font-family-code)}body,kbd{color:var(--c-text)}kbd{background:var(--c-bg-lighter);border:solid .15rem var(--c-border-dark);border-bottom:solid .25rem var(--c-border-dark);border-radius:.15rem;padding:0 .15em}code{color:var(--c-text-lighter);padding:.25rem .5rem;font-size:.85em;background-color:var(--c-bg-light);border-radius:3px;overflow-wrap:break-word;transition:background-color var(--t-color),color var(--t-color)}blockquote{font-size:1rem;color:var(--c-text-quote);border-left:.2rem solid var(--c-border-dark);margin:1rem 0;padding:.25rem 0 .25rem 1rem}blockquote>p,code{margin:0}ol,ul{padding-left:1.2em}strong{font-weight:600}h1,h2,h3,h4,h5,h6{font-weight:600;line-height:1.25}h1:focus-visible,h2:focus-visible,h3:focus-visible,h4:focus-visible,h5:focus-visible,h6:focus-visible{outline:0}h1:hover .header-anchor,h2:hover .header-anchor,h3:hover .header-anchor,h4:hover .header-anchor,h5:hover .header-anchor,h6:hover .header-anchor{opacity:1}h1{font-size:2.2rem}h2{font-size:1.65rem;padding-bottom:.3rem;border-bottom:1px solid var(--c-border);transition:border-color var(--t-color)}h3{font-size:1.35rem}h4{font-size:1.15rem}h5{font-size:1.05rem}h6{font-size:1rem}a.header-anchor{font-size:.85em;float:left;margin-left:-.87em;padding-right:.23em;margin-top:.125em;opacity:0}a.header-anchor:hover{text-decoration:none}a.header-anchor:focus-visible{opacity:1}ol,p,ul{line-height:1.7}hr{border:0;border-top:1px solid var(--c-border)}table{border-collapse:collapse;margin:1rem 0;display:block;overflow-x:auto}tr{border-top:1px solid var(--c-border-dark)}tr:nth-child(2n){background-color:var(--c-bg-light)}td,th{border:1px solid var(--c-border-dark);padding:.6em 1em}.arrow,.badge{display:inline-block}.arrow{width:0;height:0}.arrow.down,.arrow.up{border-left:4px solid transparent;border-right:4px solid transparent}.arrow.up{border-bottom:6px solid var(--c-bg-arrow)}.arrow.down{border-top:6px solid var(--c-bg-arrow)}.arrow.left,.arrow.right{border-top:4px solid transparent;border-bottom:4px solid transparent}.arrow.right{border-left:6px solid var(--c-bg-arrow)}.arrow.left{border-right:6px solid var(--c-bg-arrow)}.badge{font-size:14px;height:18px;line-height:18px;border-radius:3px;padding:0 6px;color:var(--c-bg);vertical-align:top;transition:color var(--t-color),background-color var(--t-color)}.badge.tip{background-color:var(--c-badge-tip)}.badge.warning{background-color:var(--c-badge-warning)}.badge.danger{background-color:var(--c-badge-danger)}.badge+.badge{margin-left:5px}code[class*=language-],pre[class*=language-]{color:#ccc;background:0 0;font-family:var(--font-family-code);font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#2d2d2d}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}.token.block-comment,.token.cdata,.token.comment,.token.doctype,.token.prolog{color:#999}.token.punctuation{color:#ccc}.token.attr-name,.token.deleted,.token.namespace,.token.tag{color:#ec5975}.token.function-name{color:#6196cc}.token.boolean,.token.function,.token.number{color:#f08d49}.token.class-name,.token.constant,.token.property,.token.symbol{color:#f8c555}.token.atrule,.token.builtin,.token.important,.token.keyword,.token.selector{color:#cc99cd}.token.attr-value,.token.char,.token.regex,.token.string,.token.variable{color:#7ec699}.token.entity,.token.operator,.token.url{color:#67cdcc}.token.bold,.token.important{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:#3eaf7c}.theme-default-content pre,.theme-default-content pre[class*=language-]{line-height:1.4;padding:1.3rem 1.5rem;margin:.85rem 0;border-radius:6px;overflow:auto}.theme-default-content pre code,.theme-default-content pre[class*=language-] code{color:#fff;padding:0;background-color:transparent;border-radius:0;overflow-wrap:unset;-webkit-font-smoothing:auto;-moz-osx-font-smoothing:auto}.theme-default-content .line-number{font-family:var(--font-family-code)}div[class*=language-]{position:relative;background-color:var(--code-bg-color);border-radius:6px}div[class*=language-]:before{position:absolute;z-index:3;top:.8em;right:1em;font-size:.75rem;color:var(--code-ln-color)}div[class*=language-] pre,div[class*=language-] pre[class*=language-]{background:0 0!important;position:relative;z-index:1}div[class*=language-] .highlight-lines{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;padding-top:1.3rem;position:absolute;top:0;left:0;width:100%;line-height:1.4}div[class*=language-] .highlight-lines .highlight-line{background-color:var(--code-hl-bg-color)}div[class*=language-]:not(.line-numbers-mode) .line-numbers{display:none}div[class*=language-].line-numbers-mode .highlight-lines .highlight-line{position:relative}div[class*=language-].line-numbers-mode .highlight-lines .highlight-line:before{content:" ";position:absolute;z-index:2;left:0;top:0;display:block;width:var(--code-ln-wrapper-width);height:100%}div[class*=language-].line-numbers-mode pre{margin-left:var(--code-ln-wrapper-width);padding-left:1rem;vertical-align:middle}div[class*=language-].line-numbers-mode .line-numbers{position:absolute;top:0;width:var(--code-ln-wrapper-width);text-align:center;color:var(--code-ln-color);padding-top:1.25rem;line-height:1.4}div[class*=language-].line-numbers-mode .line-numbers .line-number,div[class*=language-].line-numbers-mode .line-numbers br{-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}div[class*=language-].line-numbers-mode .line-numbers .line-number{position:relative;z-index:3;font-size:.85em;line-height:0}div[class*=language-].line-numbers-mode:after{content:"";position:absolute;top:0;left:0;width:var(--code-ln-wrapper-width);height:100%;border-radius:6px 0 0 6px;border-right:1px solid var(--code-hl-bg-color)}div[class*=language-].ext-c:before{content:"c"}div[class*=language-].ext-cpp:before{content:"cpp"}div[class*=language-].ext-cs:before{content:"cs"}div[class*=language-].ext-css:before{content:"css"}div[class*=language-].ext-dart:before{content:"dart"}div[class*=language-].ext-docker:before{content:"docker"}div[class*=language-].ext-fs:before{content:"fs"}div[class*=language-].ext-go:before{content:"go"}div[class*=language-].ext-html:before{content:"html"}div[class*=language-].ext-java:before{content:"java"}div[class*=language-].ext-js:before{content:"js"}div[class*=language-].ext-json:before{content:"json"}div[class*=language-].ext-kt:before{content:"kt"}div[class*=language-].ext-less:before{content:"less"}div[class*=language-].ext-makefile:before{content:"makefile"}div[class*=language-].ext-md:before{content:"md"}div[class*=language-].ext-php:before{content:"php"}div[class*=language-].ext-py:before{content:"py"}div[class*=language-].ext-rb:before{content:"rb"}div[class*=language-].ext-rs:before{content:"rs"}div[class*=language-].ext-sass:before{content:"sass"}div[class*=language-].ext-scss:before{content:"scss"}div[class*=language-].ext-sh:before{content:"sh"}div[class*=language-].ext-styl:before{content:"styl"}div[class*=language-].ext-ts:before{content:"ts"}div[class*=language-].ext-toml:before{content:"toml"}div[class*=language-].ext-vue:before{content:"vue"}div[class*=language-].ext-yml:before{content:"yml"}@media (max-width:419px){.theme-default-content div[class*=language-]{margin:.85rem -1.5rem;border-radius:0}}.code-group__nav{margin-top:.85rem;margin-bottom:calc(-1.7rem - 6px);padding-bottom:calc(1.7rem - 6px);padding-left:10px;padding-top:10px;border-top-left-radius:6px;border-top-right-radius:6px;background-color:var(--code-bg-color)}.code-group__ul{margin:auto 0;padding-left:0;display:inline-flex;list-style:none}.code-group__nav-tab{border:0;padding:5px;cursor:pointer;background-color:transparent;font-size:.85em;line-height:1.4;color:#ffffffe6;font-weight:600}.code-group__nav-tab:focus{outline:0}.code-group__nav-tab:focus-visible{outline:1px solid rgba(255,255,255,.9)}.code-group__nav-tab-active{border-bottom:var(--c-brand) 1px solid}@media (max-width:419px){.code-group__nav{margin-left:-1.5rem;margin-right:-1.5rem;border-radius:0}}.code-group-item,.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>a.router-link-active:after{display:none}.code-group-item__active{display:block}.code-group-item>pre{background-color:orange}.custom-container{transition:color var(--t-color),border-color var(--t-color),background-color var(--t-color)}.custom-container .custom-container-title{font-weight:600;margin-bottom:-.4rem}.custom-container.danger,.custom-container.tip,.custom-container.warning{padding:.1rem 1.5rem;border-left-width:.5rem;border-left-style:solid;margin:1rem 0}.custom-container.tip{border-color:var(--c-tip);background-color:var(--c-tip-bg);color:var(--c-tip-text)}.custom-container.tip .custom-container-title{color:var(--c-tip-title)}.custom-container.tip a{color:var(--c-tip-text-accent)}.custom-container.warning{border-color:var(--c-warning);background-color:var(--c-warning-bg);color:var(--c-warning-text)}.custom-container.warning .custom-container-title{color:var(--c-warning-title)}.custom-container.warning a{color:var(--c-warning-text-accent)}.custom-container.danger{border-color:var(--c-danger);background-color:var(--c-danger-bg);color:var(--c-danger-text)}.custom-container.danger .custom-container-title{color:var(--c-danger-title)}.custom-container.danger a{color:var(--c-danger-text-accent)}.custom-container.details{display:block;position:relative;border-radius:2px;margin:1.6em 0;padding:1.6em;background-color:var(--c-details-bg)}.custom-container.details h4{margin-top:0}.custom-container.details figure:last-child,.custom-container.details p:last-child{margin-bottom:0;padding-bottom:0}.custom-container.details summary{outline:0;cursor:pointer}.home{padding:var(--navbar-height) 2rem 0;max-width:var(--homepage-width);margin:0 auto;display:block}.home .hero{text-align:center}.home .hero img{max-width:100%;max-height:280px;display:block;margin:3rem auto 1.5rem}.home .hero h1{font-size:3rem}.home .hero .actions,.home .hero .description,.home .hero h1{margin:1.8rem auto}.home .hero .actions{display:flex;flex-wrap:wrap;gap:1rem;justify-content:center}.home .hero .description{max-width:35rem;font-size:1.6rem;line-height:1.3;color:var(--c-text-lightest)}.home .hero .action-button{display:inline-block;font-size:1.2rem;padding:.8rem 1.6rem;border-width:2px;border-style:solid;border-radius:4px;transition:background-color var(--t-color);box-sizing:border-box}.home .hero .action-button.primary{color:var(--c-bg);background-color:var(--c-brand);border-color:var(--c-brand)}.home .hero .action-button.primary:hover{background-color:var(--c-brand-light)}.home .hero .action-button.secondary{color:var(--c-brand);background-color:var(--c-bg);border-color:var(--c-brand)}.home .hero .action-button.secondary:hover{color:var(--c-bg);background-color:var(--c-brand-light)}.home .features{border-top:1px solid var(--c-border);transition:border-color var(--t-color);padding:1.2rem 0;margin-top:2.5rem;display:flex;flex-wrap:wrap;align-items:flex-start;align-content:stretch;justify-content:space-between}.home .feature{flex-grow:1;flex-basis:30%;max-width:30%}.home .feature h2{font-size:1.4rem;font-weight:500;border-bottom:none;padding-bottom:0;color:var(--c-text-light)}.home .feature p,.home .footer{color:var(--c-text-lighter)}.home .footer{padding:2.5rem;border-top:1px solid var(--c-border);text-align:center;transition:border-color var(--t-color)}@media (max-width:719px){.home .features{flex-direction:column}.home .feature{max-width:100%;padding:0 2.5rem}}@media (max-width:419px){.home{padding-left:1.5rem;padding-right:1.5rem}.home .hero img{max-height:210px;margin:2rem auto 1.2rem}.home .hero h1{font-size:2rem}.home .hero .actions,.home .hero .description,.home .hero h1{margin:1.2rem auto}.home .hero .description{font-size:1.2rem}.home .hero .action-button{font-size:1rem;padding:.6rem 1.2rem}.home .feature h2{font-size:1.25rem}}.page{padding-top:var(--navbar-height);padding-left:var(--sidebar-width)}.navbar,.sidebar{position:fixed;left:0;box-sizing:border-box}.navbar{z-index:20;top:0;right:0;height:var(--navbar-height);border-bottom:1px solid var(--c-border);background-color:var(--c-bg-navbar);transition:background-color var(--t-color),border-color var(--t-color)}.sidebar{font-size:16px;width:var(--sidebar-width);z-index:10;margin:0;top:var(--navbar-height);bottom:0;border-right:1px solid var(--c-border);overflow-y:auto;scrollbar-width:thin;scrollbar-color:var(--c-brand) var(--c-border);background-color:var(--c-bg-sidebar);transition:transform var(--t-transform),background-color var(--t-color),border-color var(--t-color)}.sidebar::-webkit-scrollbar{width:7px}.sidebar::-webkit-scrollbar-track{background-color:var(--c-border)}.sidebar::-webkit-scrollbar-thumb{background-color:var(--c-brand)}.sidebar-mask{position:fixed;z-index:9;top:0;left:0;width:100vw;height:100vh;display:none}.theme-container.sidebar-open .sidebar-mask{display:block}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(1){transform:rotate(45deg) translate(5.5px,5.5px)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(2){transform:scaleX(0)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(3){transform:rotate(-45deg) translate(6px,-6px)}.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(1),.theme-container.sidebar-open .navbar>.toggle-sidebar-button .icon span:nth-child(3){transform-origin:center}.theme-container.no-navbar .theme-default-content:not(.custom)>h1,.theme-container.no-navbar h2,.theme-container.no-navbar h3,.theme-container.no-navbar h4,.theme-container.no-navbar h5,.theme-container.no-navbar h6{margin-top:1.5rem;padding-top:0}.theme-container.no-navbar .page{padding-top:0}.theme-container.no-navbar .sidebar{top:0}@media (min-width:720px){.theme-container.no-sidebar .sidebar{display:none}.theme-container.no-sidebar .page{padding-left:0}}.theme-default-content:not(.custom)>h1,.theme-default-content:not(.custom)>h2,.theme-default-content:not(.custom)>h3,.theme-default-content:not(.custom)>h4,.theme-default-content:not(.custom)>h5,.theme-default-content:not(.custom)>h6{margin-top:calc(.5rem - var(--navbar-height));padding-top:calc(1rem + var(--navbar-height));margin-bottom:0}.theme-default-content:not(.custom)>h1:first-child,.theme-default-content:not(.custom)>h2:first-child,.theme-default-content:not(.custom)>h3:first-child,.theme-default-content:not(.custom)>h4:first-child,.theme-default-content:not(.custom)>h5:first-child,.theme-default-content:not(.custom)>h6:first-child{margin-bottom:1rem}.theme-default-content:not(.custom)>h1:first-child+.custom-container,.theme-default-content:not(.custom)>h1:first-child+p,.theme-default-content:not(.custom)>h1:first-child+pre,.theme-default-content:not(.custom)>h2:first-child+.custom-container,.theme-default-content:not(.custom)>h2:first-child+p,.theme-default-content:not(.custom)>h2:first-child+pre,.theme-default-content:not(.custom)>h3:first-child+.custom-container,.theme-default-content:not(.custom)>h3:first-child+p,.theme-default-content:not(.custom)>h3:first-child+pre,.theme-default-content:not(.custom)>h4:first-child+.custom-container,.theme-default-content:not(.custom)>h4:first-child+p,.theme-default-content:not(.custom)>h4:first-child+pre,.theme-default-content:not(.custom)>h5:first-child+.custom-container,.theme-default-content:not(.custom)>h5:first-child+p,.theme-default-content:not(.custom)>h5:first-child+pre,.theme-default-content:not(.custom)>h6:first-child+.custom-container,.theme-default-content:not(.custom)>h6:first-child+p,.theme-default-content:not(.custom)>h6:first-child+pre{margin-top:2rem}.theme-default-content:not(.custom){max-width:var(--content-width);margin:0 auto;padding:2rem 2.5rem;padding-top:0}@media (max-width:959px){.theme-default-content:not(.custom){padding:2rem}}@media (max-width:419px){.theme-default-content:not(.custom){padding:1.5rem}}.theme-default-content:not(.custom) a:hover{text-decoration:underline}.theme-default-content:not(.custom) img{max-width:100%}.theme-default-content.custom{padding:0;margin:0}.theme-default-content.custom img{max-width:100%}@media (max-width:959px){.sidebar{font-size:15px;width:var(--sidebar-width-mobile)}.page{padding-left:var(--sidebar-width-mobile)}}@media (max-width:719px){.sidebar{top:0;padding-top:var(--navbar-height);transform:translate(-100%)}.page{padding-left:0}.theme-container.sidebar-open .sidebar{transform:translate(0)}.theme-container.no-navbar .sidebar{padding-top:0}}@media (max-width:419px){h1{font-size:1.9rem}}.navbar{--navbar-line-height:calc( var(--navbar-height) - 2 * var(--navbar-padding-v) );padding:var(--navbar-padding-v) var(--navbar-padding-h);line-height:var(--navbar-line-height)}.navbar .logo{height:var(--navbar-line-height);margin-right:var(--navbar-padding-v);vertical-align:top}.navbar .site-name{font-size:1.3rem;font-weight:600;color:var(--c-text);position:relative}.navbar .navbar-items-wrapper{display:flex;position:absolute;box-sizing:border-box;top:var(--navbar-padding-v);right:var(--navbar-padding-h);height:var(--navbar-line-height);padding-left:var(--navbar-padding-h);white-space:nowrap;font-size:.9rem}.navbar .navbar-items-wrapper .search-box{flex:0 0 auto;vertical-align:top}@media (max-width:719px){.navbar{padding-left:4rem}.navbar .can-hide{display:none}.navbar .site-name{width:calc(100vw - 9.4rem);overflow:hidden;white-space:nowrap;text-overflow:ellipsis}}.navbar-items,.navbar-items a{display:inline-block}.navbar-items a{line-height:1.4rem;color:inherit}.navbar-items a.router-link-active,.navbar-items a:hover{color:var(--c-text-accent)}.navbar-items .navbar-item{position:relative;display:inline-block;margin-left:1.5rem;line-height:var(--navbar-line-height)}.navbar-items .navbar-item:first-child{margin-left:0}@media (max-width:719px){.navbar-items .navbar-item{margin-left:0}}@media (min-width:719px){.navbar-items a.router-link-active,.navbar-items a:hover{color:var(--c-text)}.navbar-item>a.router-link-active,.navbar-item>a:hover{margin-bottom:-2px;border-bottom:2px solid var(--c-text-accent)}}.toggle-sidebar-button{position:absolute;top:.6rem;left:1rem;display:none;padding:.6rem;cursor:pointer}.toggle-sidebar-button .icon{display:flex;flex-direction:column;justify-content:center;align-items:center;width:1.25rem;height:1.25rem;cursor:inherit}.toggle-sidebar-button .icon span{display:inline-block;width:100%;height:2px;border-radius:2px;background-color:var(--c-text);transition:transform var(--t-transform)}.toggle-sidebar-button .icon span:nth-child(2){margin:6px 0}@media screen and (max-width:719px){.toggle-sidebar-button{display:block}}.toggle-dark-button{display:flex;margin:auto;margin-left:1rem;border:0;background:0 0;color:var(--c-text);opacity:.8;cursor:pointer}.toggle-dark-button:hover{opacity:1}.toggle-dark-button .icon{width:1.25rem;height:1.25rem}.navbar-dropdown-wrapper{cursor:pointer}.navbar-dropdown-wrapper .navbar-dropdown-title,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:block;font-size:.9rem;font-family:inherit;cursor:inherit;padding:inherit;line-height:1.4rem;background:0 0;border:0;font-weight:500;color:var(--c-text)}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:none;font-weight:600;font-size:inherit}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile:hover,.navbar-dropdown-wrapper .navbar-dropdown-title:hover{border-color:transparent}.navbar-dropdown-wrapper .navbar-dropdown-title .arrow,.navbar-dropdown-wrapper .navbar-dropdown-title-mobile .arrow{vertical-align:middle;margin-top:-1px;margin-left:.4rem}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile:hover{color:var(--c-text-accent)}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item{color:inherit;line-height:1.7rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle{margin:.45rem 0 0;border-top:1px solid var(--c-border);padding:1rem 0 .45rem;font-size:.9rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>span{padding:0 1.5rem 0 1.25rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle>a{font-weight:inherit}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem-wrapper{padding:0;list-style:none}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem-wrapper .navbar-dropdown-subitem{font-size:.9em}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a{display:block;line-height:1.7rem;position:relative;border-bottom:none;font-weight:400;margin-bottom:0;padding:0 1.5rem 0 1.25rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active,.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a:hover{color:var(--c-text-accent)}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active:after{content:"";width:0;height:0;border-left:5px solid var(--c-text-accent);border-top:3px solid transparent;border-bottom:3px solid transparent;position:absolute;top:calc(50% - 2px);left:9px}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item:first-child .navbar-dropdown-subtitle{margin-top:0;padding-top:0;border-top:0}@media (max-width:719px){.navbar-dropdown-wrapper.open .navbar-dropdown-title,.navbar-dropdown-wrapper.open .navbar-dropdown-title-mobile{margin-bottom:.5rem}.navbar-dropdown-wrapper .navbar-dropdown-title{display:none}.navbar-dropdown-wrapper .navbar-dropdown-title-mobile{display:block}.navbar-dropdown-wrapper .navbar-dropdown{transition:height .1s ease-out;overflow:hidden}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subtitle{border-top:0;margin-top:0;padding-top:0;padding-bottom:0;font-size:15px;line-height:2rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item>a{font-size:15px;line-height:2rem}.navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item .navbar-dropdown-subitem{font-size:14px;padding-left:1rem}}@media (min-width:720px){.navbar-dropdown-wrapper{height:1.8rem}.navbar-dropdown-wrapper.open .navbar-dropdown,.navbar-dropdown-wrapper:hover .navbar-dropdown{display:block!important}.navbar-dropdown-wrapper.open:blur{display:none}.navbar-dropdown-wrapper .navbar-dropdown{display:none;height:auto!important;box-sizing:border-box;max-height:calc(100vh - 2.7rem);overflow-y:auto;position:absolute;top:100%;right:0;background-color:var(--c-bg-navbar);padding:.6rem 0;border:1px solid var(--c-border);border-bottom-color:var(--c-border-dark);text-align:left;border-radius:.25rem;white-space:nowrap;margin:0}}.page{padding-bottom:2rem;display:block}.page-meta{max-width:var(--content-width);margin:0 auto;padding:1rem 2.5rem;overflow:auto}@media (max-width:959px){.page-meta{padding:2rem}}@media (max-width:419px){.page-meta{padding:1.5rem}}.page-meta .meta-item{cursor:default;margin-top:.8rem}.page-meta .meta-item .meta-item-label{font-weight:500;color:var(--c-text-lighter)}.page-meta .meta-item .meta-item-info{font-weight:400;color:var(--c-text-quote)}.page-meta .edit-link{display:inline-block;margin-right:.25rem}.page-meta .last-updated{float:right}@media (max-width:719px){.page-meta .last-updated{font-size:.8em;float:none}.page-meta .contributors{font-size:.8em}}.page-nav{max-width:var(--content-width);margin:0 auto;padding:1rem 2.5rem 2rem;padding-bottom:0}@media (max-width:959px){.page-nav{padding:2rem}}@media (max-width:419px){.page-nav{padding:1.5rem}}.page-nav .inner{min-height:2rem;margin-top:0;border-top:1px solid var(--c-border);transition:border-color var(--t-color);padding-top:1rem;overflow:auto}.page-nav .prev a:before{content:"\2190"}.page-nav .next{float:right}.page-nav .next a:after{content:"\2192"}.sidebar ul{padding:0;margin:0;list-style-type:none}.sidebar a{display:inline-block}.sidebar .navbar-items{display:none;border-bottom:1px solid var(--c-border);transition:border-color var(--t-color);padding:.5rem 0 .75rem}.sidebar .navbar-items a{font-weight:600}.sidebar .navbar-items .navbar-item{display:block;line-height:1.25rem;font-size:1.1em;padding:.5rem 0 .5rem 1.5rem}.sidebar .sidebar-items{padding:1.5rem 0}@media (max-width:719px){.sidebar .navbar-items{display:block}.sidebar .navbar-items .navbar-dropdown-wrapper .navbar-dropdown .navbar-dropdown-item a.router-link-active:after{top:calc(1rem - 2px)}.sidebar .sidebar-items{padding:1rem 0}}.sidebar-item{cursor:default}.sidebar-item.sidebar-heading{color:var(--c-text);transition:color .15s ease;font-size:1.1em;font-weight:700;padding:.35rem 1.5rem .35rem 1.25rem;width:100%;box-sizing:border-box;margin:0;border-left:.25rem solid transparent}.sidebar-item.sidebar-heading.collapsible,a.sidebar-item{cursor:pointer}.sidebar-item.sidebar-heading.collapsible+.sidebar-item-children{transition:height .1s ease-out;overflow:hidden;margin-bottom:.75rem}.sidebar-item.sidebar-heading .arrow{position:relative;top:-.12em;left:.5em}.sidebar-item:not(.sidebar-heading){font-size:1em;font-weight:400;display:inline-block;color:var(--c-text);border-left:.25rem solid transparent;margin:0;padding:.35rem 1rem .35rem 2rem;line-height:1.4;width:100%;box-sizing:border-box}.sidebar-item:not(.sidebar-heading).active{font-weight:600;color:var(--c-text-accent);border-left-color:var(--c-text-accent)}.sidebar-item:not(.sidebar-heading)+.sidebar-item-children{padding-left:1rem;font-size:.95em}.sidebar-item-children .sidebar-item-children .sidebar-item:not(.sidebar-heading){padding:.25rem 1rem .25rem 1.75rem}.sidebar-item-children .sidebar-item-children .sidebar-item:not(.sidebar-heading).active{font-weight:500;border-left-color:transparent}a.sidebar-item:hover{color:var(--c-text-accent)}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);white-space:nowrap;border-width:0;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.table-of-contents .badge{vertical-align:middle}.dropdown-enter-from,.dropdown-leave-to{height:0!important}.fade-slide-y-enter-active{transition:all .3s ease}.fade-slide-y-leave-active{transition:all .3s cubic-bezier(1,.5,.8,1)}.fade-slide-y-enter-from,.fade-slide-y-leave-to{transform:translateY(10px);opacity:0}:root{scroll-behavior:smooth}:root{--search-bg-color:#ffffff;--search-accent-color:#3eaf7c;--search-text-color:#2c3e50;--search-border-color:#eaecef;--search-item-text-color:#5d81a5;--search-item-focus-bg-color:#f3f4f5;--search-input-width:8rem;--search-result-width:20rem}.search-box{display:inline-block;position:relative;margin-left:1rem}.search-box input{cursor:text;width:var(--search-input-width);height:2rem;color:var(--search-text-color);display:inline-block;border:1px solid var(--search-border-color);border-radius:2rem;font-size:.9rem;line-height:2rem;padding:0 .5rem 0 2rem;outline:0;transition:all ease .3s;background:var(--search-bg-color) url(/Husky.Net/assets/search.0782d0d1.svg) .6rem .5rem no-repeat;background-size:1rem}.search-box input:focus{cursor:auto;border-color:var(--search-accent-color)}.search-box .suggestions{background:var(--search-bg-color);width:var(--search-result-width);position:absolute;top:2rem;right:0;border:1px solid var(--search-border-color);border-radius:6px;padding:.4rem;list-style-type:none}.search-box .suggestion{line-height:1.4;padding:.4rem .6rem;border-radius:4px;cursor:pointer}.search-box .suggestion.focus{background-color:var(--search-item-focus-bg-color)}.search-box .suggestion.focus a{color:var(--search-accent-color)}.search-box .suggestion a{white-space:normal;color:var(--search-item-text-color)}.search-box .suggestion .page-title{font-weight:600}.search-box .suggestion .page-header{font-size:.9em;margin-left:.25em}@media (max-width:720px){.search-box input{cursor:pointer;width:0;border-color:transparent;position:relative}.search-box input:focus{cursor:text;left:0;width:10rem}}@media (max-width:420px){.search-box input:focus{width:8rem}.search-box .suggestions{width:calc(100vw - 4rem);right:-.5rem}}:root{--back-to-top-z-index:5;--back-to-top-color:#3eaf7c;--back-to-top-color-hover:#71cda3}.back-to-top{cursor:pointer;position:fixed;bottom:2rem;right:2.5rem;width:2rem;height:1.2rem;background-color:var(--back-to-top-color);-webkit-mask:url(/Husky.Net/assets/back-to-top.8efcbe56.svg) no-repeat;mask:url(/Husky.Net/assets/back-to-top.8efcbe56.svg) no-repeat;z-index:var(--back-to-top-z-index)}.back-to-top:hover{background-color:var(--back-to-top-color-hover)}@media (max-width:959px){.back-to-top{display:none}}.back-to-top-enter-active,.back-to-top-leave-active{transition:opacity .3s}.back-to-top-enter-from,.back-to-top-leave-to{opacity:0}:root{--nprogress-color:#29d;--nprogress-z-index:1031}#nprogress{pointer-events:none}#nprogress .bar{background:var(--nprogress-color);position:fixed;z-index:var(--nprogress-z-index);top:0;left:0;width:100%;height:2px}#nprogress .peg{display:block;position:absolute;right:0;width:100px;height:100%;box-shadow:0 0 10px var(--nprogress-color),0 0 5px var(--nprogress-color);opacity:1;transform:rotate(3deg) translateY(-4px)} diff --git a/assets/submodules.html.2b2978a2.js b/assets/submodules.html.2b2978a2.js new file mode 100644 index 0000000..9158b36 --- /dev/null +++ b/assets/submodules.html.2b2978a2.js @@ -0,0 +1,8 @@ +import{r as u,o as l,c as p,b as a,a as s,w as e,F as c,e as t,d as o}from"./app.22727b9e.js";import{_ as i}from"./plugin-vue_export-helper.21dcd24c.js";const d={},r=a("h1",{id:"git-submodules",tabindex:"-1"},[a("a",{class:"header-anchor",href:"#git-submodules","aria-hidden":"true"},"#"),t(" Git submodules")],-1),h=a("p",null,"Husky handles git submodules in two ways:",-1),k=a("li",null,"The project hooks and husky steps are completely ignored when the project is a git submodule.",-1),g=t("The hooks are installed in the submodule's git directory. This is the default mode following the step in "),m=t("Installation"),_=t(" and "),y=t("Attach Husky to your project"),b=t(" should get you up and running."),q=o(`Installing husky
When running dotnet husky install Husky will alert you when it detects a submodule and tell you where it will attach the hooks:
Submodule detected, attaching .../Repository/Project/mySubmodule/.husky hooks to .../Repository/Project/.git/modules/mySubmodule
+WARNING
The submodule hooks will only be executed when you're issuing git commands from inside the submodule folder.
Ignoring submodule install
For Husky to ignore installing when in a submodule, call dotnet husky install --ignore-submodule. This will make the install step a no-op. No git configurations will be applied and your hooks won't be attached.
A message will alert you when this is happening:
Submodule detected and [--ignore-when-submodule] is set, skipping install target
+Attaching husky
`,9),v=t("The "),f=a("code",null,"attach",-1),w=t(" command offers a "),x=a("code",null,"--ignore-submodule",-1),I=t(" options that generates an MsBuild target you can skip by setting the "),S=a("code",null,"IgnoreSubmodule",-1),T=t(" variable to "),j=a("code",null,"0",-1),C=t(" similar to the "),H=a("code",null,"Husky",-1),N=t(" variable, see "),R=t("Disable husky in CI/CD pipelines"),B=o(`The generated block will look something like this, If you're attaching husky manually copy the target to your .csproj and adjust WorkingDirectory accordingly.
<Target Name="husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(HUSKY)' != 0 and '$(IgnoreSubmodule)' != 0">
+ <Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High"/>
+ <Exec Command="dotnet husky install --ignore-submodule" StandardOutputImportance="Low" StandardErrorImportance="High"
+ WorkingDirectory="../../" /> <!--Update this to the relative path to your project root dir -->
+</Target>
+TIP
If you want your submodule hooks ignored but still want the MsBuild target to run, remove the and '$(IgnoreSubmodule)' != 0 condition. dotnet husky install --ignore-submodule is enough to prevent the installation of the hooks.
Configuration
Each task in task-runner.json is a JSON object with the following properties:
| name | optional | type | default | description |
|---|---|---|---|---|
| command | false | string | - | path to the executable file or script or executable name |
| args | true | [string array] | - | command arguments |
| include | true | [array of glob] | **/* | glob pattern to select files |
| name | true | string | command | name of the task (recommended) |
| group | true | string | - | group of the task (usually it should be the hook name) |
| branch | true | string (regex) | - | run task on specific branches only |
| pathMode | true | [absolute, relative] | relative | file path style (relative or absolute) |
| cwd | true | string | project root directory | current working directory for the command, can be relative or absolute |
| output | true | [always, verbose, never] | always | output log level |
| exclude | true | [array of glob] | - | glob pattern to exclude files |
| filteringRule | true | [variable, staged] | variable | match include/exclude against the used variables or git staged files |
| windows | true | object | - | overrides all the above settings for windows |
Glob patterns
Husky.Net supports the standard dotnet FileSystemGlobbing patterns for include or exclude task configurations. The patterns that are specified in the include and exclude can use the following formats to match multiple files or directories.
- Exact directory or file name
- some-file.txt
- path/to/file.txt
- Wildcards * in file and directory names that represent zero to many characters not including separator characters.
| Value | Description |
|---|---|
| *.txt | All files with .txt file extension. |
| . | All files with an extension. |
| * | All files in top-level directory. |
| .* | File names beginning with '.'. |
| word | All files with 'word' in the filename. |
| readme.* | All files named 'readme' with any file extension. |
| styles/*.css | All files with extension '.css' in the directory 'styles/'. |
| scripts// | All files in 'scripts/' or one level of subdirectory under 'scripts/'. |
| images*/* | All files in a folder with name that is or begins with 'images'. |
- Arbitrary directory depth (/**/).
| Value | Description |
|---|---|
| */ | All files in any subdirectory. |
| dir/**/* | All files in any subdirectory under 'dir/'. |
- Relative paths.
To match all files in a directory named "shared" at the sibling level to the base directory use ../shared/*.
Variables
There are some variables that you can use in your task arguments (args).
- \${staged}
- returns the list of currently staged files
- \${last-commit}
- returns last commit changed files
- \${git-files}
- returns the output of (git ls-files)
- \${all-files}
- returns the list of matched files using include/exclude, be careful with this variable, it will return all the files if you don't specify include or exclude
- \${args}
- returns the arguments passed directly to the
husky runcommand using--argsoption
- returns the arguments passed directly to the
e.g.
"args": [ "\${staged}" ]
+Custom variables
You can define your own variables by adding a task to the variables section in task-runner.json.
e.g.
defining custom \${root-dir-files} variable to access root directory files
{
+ "variables": [
+ {
+ "name": "root-dir-files",
+ "command": "cmd",
+ "args": ["/c", "dir", "/b"]
+ }
+ ],
+ "tasks": [
+ {
+ "command": "cmd",
+ "args": ["/c", "echo", "\${root-dir-files}"]
+ }
+ ]
+}
+1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Task Runner
Why task runner?
Linting makes more sense when run before committing your code. By doing so you can ensure no errors go into the repository and enforce code style. But running a lint process on a whole project is slow, and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.
task-runner.json
After installation, you must have a task-runner.json file in your .husky directory that you can use to define your tasks.
you can run and test your tasks with dotnet husky run command. Once you are sure that your tasks are working properly, you can add it to the hook.
e.g
dotnet husky add pre-commit -c "dotnet husky run --group pre-commit"
+A real-world example.
{
+ "$schema": "https://alirezanet.github.io/Husky.Net/schema.json",
+ "tasks": [
+ {
+ "name": "dotnet-format",
+ "group": "pre-commit",
+ "command": "dotnet",
+ "args": ["dotnet-format", "--include", "\${staged}"],
+ "include": ["**/*.cs", "**/*.vb"]
+ },
+ {
+ "name": "commit-message-linter",
+ "command": "dotnet",
+ "args": [
+ "husky",
+ "exec",
+ ".husky/csx/commit-lint.csx",
+ "--args",
+ "\${args}"
+ ]
+ },
+ {
+ "name": "warning-check",
+ "command": "dotnet",
+ "group": "pre-push",
+ "args": ["build", "/warnaserror"],
+ "include": ["**/*.cs", "**/*.vb"]
+ },
+ {
+ "name": "eslint",
+ "group": "pre-commit",
+ "pathMode": "absolute",
+ "cwd": "Client",
+ "command": "npm",
+ "args": ["run", "lint", "\${staged}"],
+ "include": ["**/*.ts", "**/*.vue", "**/*.js"]
+ },
+ {
+ "name": "prettier",
+ "group": "pre-commit",
+ "pathMode": "absolute",
+ "cwd": "Client",
+ "command": "npx",
+ "args": ["prettier", "--write", "\${staged}"],
+ "include": [
+ "**/*.ts",
+ "**/*.vue",
+ "**/*.js",
+ "**/*.json",
+ "**/*.yml",
+ "**/*.css",
+ "**/*.scss"
+ ]
+ },
+ {
+ "name": "Welcome",
+ "output": "always",
+ "command": "bash",
+ "args": ["-c", "echo Nice work! \u{1F942}"],
+ "windows": {
+ "command": "cmd",
+ "args": ["/c", "echo Nice work! \u{1F942}"]
+ }
+ },
+ {
+ "name": "Run JB Clean Up Code",
+ "command": "cmd",
+ "pathMode": "relative",
+ "args": [
+ "/c",
+ "dotnet",
+ "jb",
+ "cleanupcode",
+ "proj.sln",
+ "--profile=Team: Full Cleanup",
+ "--include=\${args}"
+ ],
+ "group": "pre-commit"
+ }
+ ]
+}
+1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
| Before | After |
|---|---|
Disabling Emojis
If none of the above solutions worked, you can disable husky unicode characters by setting the HUSKY_NOUNICODE environment variable to true or use the no-unicode or -u option after husky run command.