{"payload":{"allShortcutsEnabled":false,"path":"docs/getting-started","repo":{"id":327821898,"defaultBranch":"master","name":"typescript-eslint","ownerLogin":"jigfox","currentUserCanPush":false,"isFork":true,"isEmpty":false,"createdAt":"2021-01-08T06:49:10.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/110414?v=4","public":true,"private":false,"isOrgOwned":false},"currentUser":null,"refInfo":{"name":"master","listCacheKey":"v0:1614228486.029174","canEdit":false,"refType":"branch","currentOid":"5558f410007da58a3f4726bbf9501c924ef166a1"},"tree":{"items":[{"name":"linting","path":"docs/getting-started/linting","contentType":"directory"},{"name":"plugin-development","path":"docs/getting-started/plugin-development","contentType":"directory"},{"name":"README.md","path":"docs/getting-started/README.md","contentType":"file"}],"templateDirectorySuggestionUrl":null,"readme":{"displayName":"README.md","richText":"\u003carticle class=\"markdown-body entry-content container-lg\" itemprop=\"text\"\u003e\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch1 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003eGetting Started\u003c/h1\u003e\u003ca id=\"user-content-getting-started\" class=\"anchor\" aria-label=\"Permalink: Getting Started\" href=\"#getting-started\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cp dir=\"auto\"\u003eApproaching a monorepo project like this can be pretty daunting and hard to navigate for a new user.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eThe goal of these docs are to give you a quick overview of the project and all of its the pieces, as well as provide guides to help you get setup.\u003c/p\u003e\n\u003cp dir=\"auto\"\u003eThe docs are broken down into the following categories:\u003c/p\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003e\u003ca href=\"/jigfox/typescript-eslint/blob/master/docs/getting-started/linting/README.md\"\u003eI want to lint my TypeScript codebase.\u003c/a\u003e\u003c/h2\u003e\u003ca id=\"user-content-i-want-to-lint-my-typescript-codebase\" class=\"anchor\" aria-label=\"Permalink: I want to lint my TypeScript codebase.\" href=\"#i-want-to-lint-my-typescript-codebase\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003cdiv class=\"markdown-heading\" dir=\"auto\"\u003e\u003ch2 tabindex=\"-1\" class=\"heading-element\" dir=\"auto\"\u003e\u003ca href=\"/jigfox/typescript-eslint/blob/master/docs/getting-started/plugin-development/README.md\"\u003e(TODO) I want to write an ESLint plugin in TypeScript.\u003c/a\u003e\u003c/h2\u003e\u003ca id=\"user-content-todo-i-want-to-write-an-eslint-plugin-in-typescript\" class=\"anchor\" aria-label=\"Permalink: (TODO) I want to write an ESLint plugin in TypeScript.\" href=\"#todo-i-want-to-write-an-eslint-plugin-in-typescript\"\u003e\u003csvg class=\"octicon octicon-link\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"16\" height=\"16\" aria-hidden=\"true\"\u003e\u003cpath d=\"m7.775 3.275 1.25-1.25a3.5 3.5 0 1 1 4.95 4.95l-2.5 2.5a3.5 3.5 0 0 1-4.95 0 .751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018 1.998 1.998 0 0 0 2.83 0l2.5-2.5a2.002 2.002 0 0 0-2.83-2.83l-1.25 1.25a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042Zm-4.69 9.64a1.998 1.998 0 0 0 2.83 0l1.25-1.25a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042l-1.25 1.25a3.5 3.5 0 1 1-4.95-4.95l2.5-2.5a3.5 3.5 0 0 1 4.95 0 .751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018 1.998 1.998 0 0 0-2.83 0l-2.5 2.5a1.998 1.998 0 0 0 0 2.83Z\"\u003e\u003c/path\u003e\u003c/svg\u003e\u003c/a\u003e\u003c/div\u003e\n\u003c/article\u003e","errorMessage":null,"headerInfo":{"toc":[{"level":1,"text":"Getting Started","anchor":"getting-started","htmlText":"Getting Started"},{"level":2,"text":"I want to lint my TypeScript codebase.","anchor":"i-want-to-lint-my-typescript-codebase","htmlText":"I want to lint my TypeScript codebase."},{"level":2,"text":"(TODO) I want to write an ESLint plugin in TypeScript.","anchor":"todo-i-want-to-write-an-eslint-plugin-in-typescript","htmlText":"(TODO) I want to write an ESLint plugin in TypeScript."}],"siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fjigfox%2Ftypescript-eslint%2Ftree%2Fmaster%2Fdocs%2Fgetting-started"}},"totalCount":3,"showBranchInfobar":true},"fileTree":{"docs":{"items":[{"name":"getting-started","path":"docs/getting-started","contentType":"directory"}],"totalCount":1},"":{"items":[{"name":".github","path":".github","contentType":"directory"},{"name":".vscode","path":".vscode","contentType":"directory"},{"name":"docs","path":"docs","contentType":"directory"},{"name":"packages","path":"packages","contentType":"directory"},{"name":"tests","path":"tests","contentType":"directory"},{"name":"tools","path":"tools","contentType":"directory"},{"name":".all-contributorsrc","path":".all-contributorsrc","contentType":"file"},{"name":".codecov.yml","path":".codecov.yml","contentType":"file"},{"name":".cspell.json","path":".cspell.json","contentType":"file"},{"name":".editorconfig","path":".editorconfig","contentType":"file"},{"name":".eslintignore","path":".eslintignore","contentType":"file"},{"name":".eslintrc.js","path":".eslintrc.js","contentType":"file"},{"name":".gitattributes","path":".gitattributes","contentType":"file"},{"name":".gitignore","path":".gitignore","contentType":"file"},{"name":".huskyrc","path":".huskyrc","contentType":"file"},{"name":".lintstagedrc","path":".lintstagedrc","contentType":"file"},{"name":".markdownlint.json","path":".markdownlint.json","contentType":"file"},{"name":".markdownlintignore","path":".markdownlintignore","contentType":"file"},{"name":".npmrc","path":".npmrc","contentType":"file"},{"name":".prettierignore","path":".prettierignore","contentType":"file"},{"name":".prettierrc.json","path":".prettierrc.json","contentType":"file"},{"name":"CHANGELOG.md","path":"CHANGELOG.md","contentType":"file"},{"name":"CODE_OF_CONDUCT.md","path":"CODE_OF_CONDUCT.md","contentType":"file"},{"name":"CONTRIBUTING.md","path":"CONTRIBUTING.md","contentType":"file"},{"name":"CONTRIBUTORS.md","path":"CONTRIBUTORS.md","contentType":"file"},{"name":"LICENSE","path":"LICENSE","contentType":"file"},{"name":"README.md","path":"README.md","contentType":"file"},{"name":"lerna.json","path":"lerna.json","contentType":"file"},{"name":"package.json","path":"package.json","contentType":"file"},{"name":"tsconfig.base.json","path":"tsconfig.base.json","contentType":"file"},{"name":"tsconfig.eslint.json","path":"tsconfig.eslint.json","contentType":"file"},{"name":"yarn.lock","path":"yarn.lock","contentType":"file"}],"totalCount":32}},"fileTreeProcessingTime":15.580112,"foldersToFetch":[],"treeExpanded":true,"symbolsExpanded":false,"csrf_tokens":{"/jigfox/typescript-eslint/branches":{"post":"Bs5W79MBn4MSMgZBW0zDhmMf8_s26wJvdEjh6MpFFEjlA2Rqo-xlDUNh8-CyOR6AYdFqjtSVPW0BsTFRQoPQnw"},"/jigfox/typescript-eslint/branches/fetch_and_merge/master":{"post":"2V0pDJ7ubsF_vKfoStyTU3hCqQsCZTXPNZVkK3gOpXXEUtL2wGCjsgBV1qPuGIwmaFBcW4UJ4-VpF4odmrOAXg"},"/jigfox/typescript-eslint/branches/fetch_and_merge/master?discard_changes=true":{"post":"BotHj8ND6WYRvwi7jRIt2SFOCdJLdkCdIK1lq4sy95gbhLx1nc0kFW5WefAp1jKsMVz8gswalrd8L4udaY_Ssw"}}},"title":"typescript-eslint/docs/getting-started at master · jigfox/typescript-eslint","appPayload":{"helpUrl":"https://docs.github.com","findFileWorkerPath":"/assets-cdn/worker/find-file-worker-7d7eb7c71814.js","findInFileWorkerPath":"/assets-cdn/worker/find-in-file-worker-1ae9fa256942.js","githubDevUrl":null,"enabled_features":{"code_nav_ui_events":false,"react_blob_overlay":false,"accessible_code_button":true,"github_models_repo_integration":false}}}
You can’t perform that action at this time.