Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
plugins",id:"plugins",children:[],level:3},{value:"tasks",id:"tasks",children:[],level:3}],level:2}],p=function(e){return function(n){return console.warn("Component "+e+" was not imported, exported, or provided by MDXProvider as global scope"),(0,a.kt)("div",n)}},d=p("Tabs"),f=p("TabItem"),h={toc:s};function m(e){var n=e.components,t=(0,o.Z)(e,i);return(0,a.kt)("wrapper",(0,r.Z)({},h,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("p",null,"Checkup uses a ",(0,a.kt)("inlineCode",{parentName:"p"},".checkuprc")," file to configure the behaviour of the tool. The file is located in the root of the project."),(0,a.kt)("h2",{id:"configuration-file"},"Configuration file"),(0,a.kt)("p",null,"You can create a configuration file by running the following command:"),(0,a.kt)(d,{groupId:"package-manager-flavor",defaultValue:"npx",values:[{label:"npx",value:"npx"},{label:"Yarn",value:"yarn"}],mdxType:"Tabs"},(0,a.kt)(f,{value:"npx",mdxType:"TabItem"},(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"npx checkup generate config\n"))),(0,a.kt)(f,{value:"yarn",mdxType:"TabItem"},(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"yarn checkup generate config\n")))),(0,a.kt)("p",null,"This will generate a .checkuprc file in the current directory, with the following contents:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json",metastring:'title=".checkuprc"',title:'".checkuprc"'},'{\n "$schema": "https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json",\n "excludePaths": [],\n "plugins": [],\n "tasks": {}\n}\n')),(0,a.kt)("h3",{id:"excludepaths"},(0,a.kt)("inlineCode",{parentName:"h3"},"excludePaths")),(0,a.kt)("p",null,"You can exclude paths from the analysis by adding them to the ",(0,a.kt)("inlineCode",{parentName:"p"},"excludePaths")," array, which is a comma separated list of paths."),(0,a.kt)("h3",{id:"plugins"},(0,a.kt)("inlineCode",{parentName:"h3"},"plugins")),(0,a.kt)("p",null,"Plugins can be configured by adding them to the ",(0,a.kt)("inlineCode",{parentName:"p"},"plugins")," array. Each plugin is a string that represents the name of the plugin."),(0,a.kt)("h3",{id:"tasks"},(0,a.kt)("inlineCode",{parentName:"h3"},"tasks")),(0,a.kt)("p",null,"Tasks can be individually configured by adding them to the ",(0,a.kt)("inlineCode",{parentName:"p"},"tasks")," object. The key is the name of the task, and the value is either a string or a tuple:"),(0,a.kt)("p",null,"Example:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json"},'{\n "$schema": "https://raw.githubusercontent.com/checkupjs/checkup/master/packages/core/src/schemas/config-schema.json",\n "excludePaths": [],\n "plugins": [],\n "tasks": {\n "plugin-name/my-task": "off",\n "plugin-name/my-other-task": [\n "on",\n {\n "some-option": "some-value"\n }\n ]\n }\n}\n')))}m.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/30a24c52.004e0b6a.js b/assets/js/30a24c52.004e0b6a.js
new file mode 100644
index 0000000..38f9210
--- /dev/null
+++ b/assets/js/30a24c52.004e0b6a.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkcheckup_website=self.webpackChunkcheckup_website||[]).push([[453],{8605:function(e){e.exports=JSON.parse('{"allTagsPath":"/blog/tags","slug":"/blog/tags/hello","name":"hello","count":2,"permalink":"/blog/tags/hello"}')}}]);
\ No newline at end of file
diff --git a/assets/js/32b6a1b1.ee33e732.js b/assets/js/32b6a1b1.ee33e732.js
new file mode 100644
index 0000000..9f76f48
--- /dev/null
+++ b/assets/js/32b6a1b1.ee33e732.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkcheckup_website=self.webpackChunkcheckup_website||[]).push([[6902],{3905:function(e,t,n){n.d(t,{Zo:function(){return c},kt:function(){return d}});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function u(e){for(var t=1;tboolean",id:"checkuptaskrunnerhastaskfilter--boolean",children:[],level:3},{value:"checkupTaskRunner.getAvailableTasks() \u21d2",id:"checkuptaskrunnergetavailabletasks-",children:[],level:3}],level:2}],o={toc:c};function s(e){var t=e.components,n=(0,a.Z)(e,u);return(0,l.kt)("wrapper",(0,r.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("a",{name:"CheckupTaskRunner"}),(0,l.kt)("h2",{id:"checkuptaskrunner"},"CheckupTaskRunner"),(0,l.kt)("p",null,"Class that is able to run a list of checkup tasks."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": global class"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#CheckupTaskRunner"},"CheckupTaskRunner"),(0,l.kt)("ul",{parentName:"li"},(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#new_CheckupTaskRunner_new"},"new CheckupTaskRunner(options)")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#CheckupTaskRunner+taskErrorKind"},".taskErrorKind")," \u21d2 ",(0,l.kt)("code",null,"ErrorKind")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#CheckupTaskRunner+hasTaskFilter"},".hasTaskFilter")," \u21d2 ",(0,l.kt)("code",null,"boolean")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#CheckupTaskRunner+getAvailableTasks"},".getAvailableTasks()")," \u21d2")))),(0,l.kt)("a",{name:"new_CheckupTaskRunner_new"}),(0,l.kt)("h3",{id:"new-checkuptaskrunneroptions"},"new CheckupTaskRunner(options)"),(0,l.kt)("p",null,"Create a CheckupTaskRunner."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Param"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"RunOptions")),(0,l.kt)("td",{parentName:"tr",align:null},"run options that may specify the following items:")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.cwd"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"string")),(0,l.kt)("td",{parentName:"tr",align:null},"The path referring to the root directory that Checkup will run in")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.config?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"CheckupConfig")),(0,l.kt)("td",{parentName:"tr",align:null},"Use this configuration, overriding .checkuprc if present.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.configPath?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"string")),(0,l.kt)("td",{parentName:"tr",align:null},"Use the configuration found at this path, overriding .checkuprc if present.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.categories?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"Array.","<","string",">")),(0,l.kt)("td",{parentName:"tr",align:null},"Runs specific tasks specified by category. Can be used multiple times.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.excludePaths?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"Array.","<","string",">")),(0,l.kt)("td",{parentName:"tr",align:null},"Paths to exclude from checkup. If paths are provided via command line and via checkup config, command line paths will be used.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.groups?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"Array.","<","string",">")),(0,l.kt)("td",{parentName:"tr",align:null},"Runs specific tasks specified by group. Can be used multiple times.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.listTasks?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"boolean")),(0,l.kt)("td",{parentName:"tr",align:null},"If true, list all available tasks to run.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.tasks?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"Array.","<","string",">")),(0,l.kt)("td",{parentName:"tr",align:null},"Runs specific tasks specified by the fully qualified task name in the format pluginName/taskName. Can be used multiple times.")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options.pluginBaseDir?"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"string")),(0,l.kt)("td",{parentName:"tr",align:null},"The base directory where Checkup will load the plugins from. Defaults to cwd.")))),(0,l.kt)("a",{name:"CheckupTaskRunner+taskErrorKind"}),(0,l.kt)("h3",{id:"checkuptaskrunnertaskerrorkind--errorkind"},"checkupTaskRunner.taskErrorKind \u21d2 ",(0,l.kt)("code",null,"ErrorKind")),(0,l.kt)("p",null,"Get the task's error kind"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": instance property of ",(0,l.kt)("a",{parentName:"p",href:"#CheckupTaskRunner"},(0,l.kt)("code",null,"CheckupTaskRunner"))," "),(0,l.kt)("a",{name:"CheckupTaskRunner+hasTaskFilter"}),(0,l.kt)("h3",{id:"checkuptaskrunnerhastaskfilter--boolean"},"checkupTaskRunner.hasTaskFilter \u21d2 ",(0,l.kt)("code",null,"boolean")),(0,l.kt)("p",null,"Check if user provides task filter by using task, category or group"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": instance property of ",(0,l.kt)("a",{parentName:"p",href:"#CheckupTaskRunner"},(0,l.kt)("code",null,"CheckupTaskRunner"))," "),(0,l.kt)("a",{name:"CheckupTaskRunner+getAvailableTasks"}),(0,l.kt)("h3",{id:"checkuptaskrunnergetavailabletasks-"},"checkupTaskRunner.getAvailableTasks() \u21d2"),(0,l.kt)("p",null,"Get a list of task names that are able to run."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": instance method of ",(0,l.kt)("a",{parentName:"p",href:"#CheckupTaskRunner"},(0,l.kt)("code",null,"CheckupTaskRunner")),(0,l.kt)("br",{parentName:"p"}),"\n",(0,l.kt)("strong",{parentName:"p"},"Returns"),": - a list of fully qualified task names."))}s.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/3570154c.72785a24.js b/assets/js/3570154c.72785a24.js
new file mode 100644
index 0000000..f58a5b3
--- /dev/null
+++ b/assets/js/3570154c.72785a24.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkcheckup_website=self.webpackChunkcheckup_website||[]).push([[3707],{3905:function(e,t,r){r.d(t,{Zo:function(){return s},kt:function(){return m}});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function u(e){for(var t=1;tstring",id:"getshorthandnamefullname--string",children:[],level:2}],u={toc:p};function k(e){var a=e.components,t=(0,r.Z)(e,o);return(0,l.kt)("wrapper",(0,n.Z)({},u,t,{components:a,mdxType:"MDXLayout"}),(0,l.kt)("h2",{id:"functions"},"Functions"),(0,l.kt)("dl",null,(0,l.kt)("dt",null,(0,l.kt)("a",{href:"#normalizePackageName"},"normalizePackageName(name)")," \u21d2 ",(0,l.kt)("code",null,"string")),(0,l.kt)("dd",null,(0,l.kt)("p",null,"Brings package name to correct format based on prefix")),(0,l.kt)("dt",null,(0,l.kt)("a",{href:"#getShorthandName"},"getShorthandName(fullName)")," \u21d2 ",(0,l.kt)("code",null,"string")),(0,l.kt)("dd",null,(0,l.kt)("p",null,"Removes the prefix from a fullName."))),(0,l.kt)("a",{name:"normalizePackageName"}),(0,l.kt)("h2",{id:"normalizepackagenamename--string"},"normalizePackageName(name) \u21d2 ",(0,l.kt)("code",null,"string")),(0,l.kt)("p",null,"Brings package name to correct format based on prefix"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": global function",(0,l.kt)("br",{parentName:"p"}),"\n",(0,l.kt)("strong",{parentName:"p"},"Returns"),": ",(0,l.kt)("code",null,"string")," - Normalized name of the package"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Param"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"string")),(0,l.kt)("td",{parentName:"tr",align:null},"The name of the package.")))),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#normalizePackageName"},"normalizePackageName(name)")," \u21d2 ",(0,l.kt)("code",null,"string"),(0,l.kt)("ul",{parentName:"li"},(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#normalizePackageName..normalizedName"},"~normalizedName")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("a",{parentName:"li",href:"#normalizePackageName..scopedPackageShortcutRegex"},"~scopedPackageShortcutRegex"))))),(0,l.kt)("a",{name:"normalizePackageName..normalizedName"}),(0,l.kt)("h3",{id:"normalizepackagenamenormalizedname"},"normalizePackageName~normalizedName"),(0,l.kt)("p",null,"for scoped packages, insert the prefix after the first / unless\nthe path is already @scope/eslint or @scope/eslint-xxx-yyy"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": inner property of ",(0,l.kt)("a",{parentName:"p",href:"#normalizePackageName"},(0,l.kt)("code",null,"normalizePackageName"))," "),(0,l.kt)("a",{name:"normalizePackageName..scopedPackageShortcutRegex"}),(0,l.kt)("h3",{id:"normalizepackagenamescopedpackageshortcutregex"},"normalizePackageName~scopedPackageShortcutRegex"),(0,l.kt)("p",null,"it's a scoped package\npackage name is the prefix, or just a username"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": inner constant of ",(0,l.kt)("a",{parentName:"p",href:"#normalizePackageName"},(0,l.kt)("code",null,"normalizePackageName"))," "),(0,l.kt)("a",{name:"getShorthandName"}),(0,l.kt)("h2",{id:"getshorthandnamefullname--string"},"getShorthandName(fullName) \u21d2 ",(0,l.kt)("code",null,"string")),(0,l.kt)("p",null,"Removes the prefix from a fullName."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Kind"),": global function",(0,l.kt)("br",{parentName:"p"}),"\n",(0,l.kt)("strong",{parentName:"p"},"Returns"),": ",(0,l.kt)("code",null,"string")," - The term without prefix."),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Param"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"fullName"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("code",null,"string")),(0,l.kt)("td",{parentName:"tr",align:null},"The term which may have the prefix.")))))}k.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/404c3bc7.4f37c157.js b/assets/js/404c3bc7.4f37c157.js
new file mode 100644
index 0000000..086db35
--- /dev/null
+++ b/assets/js/404c3bc7.4f37c157.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkcheckup_website=self.webpackChunkcheckup_website||[]).push([[1052],{3905:function(e,t,a){a.d(t,{Zo:function(){return k},kt:function(){return c}});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;tYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = '+e+" "+("/"===e?" (default value)":"")+'
\nWe suggest trying baseUrl =
\n\n'}(e)).replace(/=0||Object.prototype.hasOwnProperty.call(e,r)&&(n[r]=e[r]);return n},H=function(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t},V=function(e){var t=!(arguments.length>1&&void 0!==arguments[1])||arguments[1];return!1===t?String(e):String(e).replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")},W=function(e){var t=X(e,v.TITLE),n=X(e,F);if(n&&t)return n.replace(/%s/g,(function(){return Array.isArray(t)?t.join(""):t}));var r=X(e,L);return t||r||void 0},Z=function(e){return X(e,D)||function(){}},Y=function(e,t){return t.filter((function(t){return void 0!==t[e]})).map((function(t){return t[e]})).reduce((function(e,t){return G({},e,t)}),{})},K=function(e,t){return t.filter((function(e){return void 0!==e[v.BASE]})).map((function(e){return e[v.BASE]})).reverse().reduce((function(t,n){if(!t.length)for(var r=Object.keys(n),a=0;a