https://typescript-eslint.io/assets/js/8afe7a36.4ff823d6.js

1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["3039"],{17069(e,t,s){s.r(t),s.d(t,{metadata:()=>i,default:()=>h,frontMatter:()=>l,contentTitle:()=>d,toc:()=>a,assets:()=>o});var i=JSON.parse('{"id":"packages/tsconfig-utils","title":"@typescript-eslint/tsconfig-utils","description":"Utilities for collecting TSConfigs for linting scenarios \u2728","source":"@site/../../docs/packages/TSConfig_Utils.mdx","sourceDirName":"packages","slug":"/packages/tsconfig-utils","permalink":"/packages/tsconfig-utils","draft":false,"unlisted":false,"editUrl":"https://github.com/typescript-eslint/typescript-eslint/edit/main/packages/website/../../docs/packages/TSConfig_Utils.mdx","tags":[],"version":"current","frontMatter":{"id":"tsconfig-utils","sidebar_label":"tsconfig-utils","toc_max_heading_level":3,"image":"/img/og/docs/packages/TSConfig_Utils.png"},"sidebar":"docs","previous":{"title":"scope-manager","permalink":"/packages/scope-manager"},"next":{"title":"type-utils","permalink":"/packages/type-utils"}}'),n=s(65723),c=s(7143),r=s(28019);let l={id:"tsconfig-utils",sidebar_label:"tsconfig-utils",toc_max_heading_level:3,image:"/img/og/docs/packages/TSConfig_Utils.png"},d="@typescript-eslint/tsconfig-utils",o={},a=[...r.toc];function p(e){let t={blockquote:"blockquote",code:"code",h1:"h1",header:"header",meta:"meta",p:"p",...(0,c.R)(),...e.components},{Head:s,PackageLink:i}=t;return s||g("Head",!0),i||g("PackageLink",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.header,{children:(0,n.jsx)(t.h1,{id:"typescript-eslinttsconfig-utils",children:(0,n.jsx)(t.code,{children:"@typescript-eslint/tsconfig-utils"})})}),"\n",(0,n.jsx)(i,{packageName:"tsconfig-utils",scope:"@typescript-eslint"}),"\n",(0,n.jsxs)(t.blockquote,{children:["\n",(0,n.jsx)(t.p,{children:"Utilities for collecting TSConfigs for linting scenarios \u2728"}),"\n"]}),"\n",(0,n.jsx)(t.p,{children:"The following documentation is auto-generated from source code."}),"\n",(0,n.jsx)(r.default,{}),"\n",(0,n.jsx)(s,{children:(0,n.jsx)(t.meta,{content:"@typescript-eslint/tsconfig-utils: Utilities for collecting TSConfigs for linting scenarios \u2728",name:"twitter:image:alt"})})]})}function h(e={}){let{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}function g(e,t){throw Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},28019(e,t,s){s.r(t),s.d(t,{metadata:()=>i,default:()=>p,frontMatter:()=>r,contentTitle:()=>l,toc:()=>o,assets:()=>d});var i=JSON.parse('{"id":"packages/tsconfig-utils/generated/index","title":"index","description":"Functions","source":"@site/../../docs/packages/tsconfig-utils/generated/index.md","sourceDirName":"packages/tsconfig-utils/generated","slug":"/packages/tsconfig-utils/generated/","permalink":"/packages/tsconfig-utils/generated/","draft":false,"unlisted":false,"editUrl":"https://github.com/typescript-eslint/typescript-eslint/edit/main/packages/website/../../docs/packages/tsconfig-utils/generated/index.md","tags":[],"version":"current","frontMatter":{}}'),n=s(65723),c=s(7143);let r={},l,d={},o=[{value:"Functions",id:"functions",level:2},{value:"getParsedConfigFile()",id:"getparsedconfigfile",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Variables",id:"variables",level:2},{value:"CORE_COMPILER_OPTIONS",id:"core_compiler_options",level:3},{value:"Type Declaration",id:"type-declaration",level:4}];function a(e){let t={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,n.jsx)(t.h3,{id:"getparsedconfigfile",children:"getParsedConfigFile()"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"function getParsedConfigFile(\n   tsserver, \n   configFile, \n   projectDirectory?): ParsedCommandLine;\n"})}),"\n",(0,n.jsxs)(t.p,{children:["Defined in: ",(0,n.jsx)(t.a,{href:"https://github.com/typescript-eslint/typescript-eslint/blob/23d38ceeb8fb1237f55cb62fc2b54419e1fa1ed7/packages/tsconfig-utils/src/getParsedConfigFile.ts#L14",children:"getParsedConfigFile.ts:14"})]}),"\n",(0,n.jsx)(t.p,{children:"Parses a TSConfig file using the same logic as tsserver."}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Parameter"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Description"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"tsserver"})}),(0,n.jsxs)(t.td,{children:[(0,n.jsx)(t.em,{children:"typeof"})," ",(0,n.jsx)(t.code,{children:"ts"})]}),(0,n.jsx)(t.td,{children:"-"})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"configFile"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsxs)(t.td,{children:["the path to the tsconfig.json file, relative to ",(0,n.jsx)(t.code,{children:"projectDirectory"})]})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"projectDirectory?"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"string"})}),(0,n.jsxs)(t.td,{children:["the project directory to use as the CWD, defaults to ",(0,n.jsx)(t.code,{children:"process.cwd()"})]})]})]})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"ParsedCommandLine"})}),"\n",(0,n.jsx)(t.h2,{id:"variables",children:"Variables"}),"\n",(0,n.jsx)(t.h3,{id:"core_compiler_options",children:"CORE_COMPILER_OPTIONS"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"const CORE_COMPILER_OPTIONS: object;\n"})}),"\n",(0,n.jsxs)(t.p,{children:["Defined in: ",(0,n.jsx)(t.a,{href:"https://github.com/typescript-eslint/typescript-eslint/blob/23d38ceeb8fb1237f55cb62fc2b54419e1fa1ed7/packages/tsconfig-utils/src/compilerOptions.ts#L6",children:"compilerOptions.ts:6"})]}),"\n",(0,n.jsx)(t.p,{children:"Compiler options required to avoid critical functionality issues"}),"\n",(0,n.jsx)(t.h4,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{children:"Name"}),(0,n.jsx)(t.th,{children:"Type"}),(0,n.jsx)(t.th,{children:"Default value"}),(0,n.jsx)(t.th,{children:"Defined in"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)("a",{id:"property-noemit"})," ",(0,n.jsx)(t.code,{children:"noEmit"})]}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"https://github.com/typescript-eslint/typescript-eslint/blob/23d38ceeb8fb1237f55cb62fc2b54419e1fa1ed7/packages/tsconfig-utils/src/compilerOptions.ts#L8",children:"compilerOptions.ts:8"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)("a",{id:"property-nounusedlocals"})," ",(0,n.jsx)(t.code,{children:"noUnusedLocals"})]}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"https://github.com/typescript-eslint/typescript-eslint/blob/23d38ceeb8fb1237f55cb62fc2b54419e1fa1ed7/packages/tsconfig-utils/src/compilerOptions.ts#L11",children:"compilerOptions.ts:11"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsxs)(t.td,{children:[(0,n.jsx)("a",{id:"property-nounusedparameters"})," ",(0,n.jsx)(t.code,{children:"noUnusedParameters"})]}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.code,{children:"true"})}),(0,n.jsx)(t.td,{children:(0,n.jsx)(t.a,{href:"https://github.com/typescript-eslint/typescript-eslint/blob/23d38ceeb8fb1237f55cb62fc2b54419e1fa1ed7/packages/tsconfig-utils/src/compilerOptions.ts#L12",children:"compilerOptions.ts:12"})})]})]})]})]})}function p(e={}){let{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}}

1,7143(e,t,s){s.d(t,{R:()=>r,x:()=>l});var i=s(22155);let n={},c=i.createContext(n);function r(e){let t=i.useContext(c);return i.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),i.createElement(c.Provider,{value:t},e.children)}}}]);