File tree Expand file tree Collapse file tree 2 files changed +20
-1
lines changed Expand file tree Collapse file tree 2 files changed +20
-1
lines changed Original file line number Diff line number Diff line change 1+ # ` website-eslint `
2+
3+ A bundled version of ESLint plus ` typescript-eslint ` , made to work in a browser.
4+ This is exclusively used for the playground in the [ ` website ` package] ( ../website/README.md ) .
5+
6+ ## Building
7+
8+ ` yarn build ` runs ` build.ts ` , which uses ESBuild to create a CommonJS bundle including:
9+
10+ - ESLint's [ ` Linter ` class] ( https://eslint.org/docs/latest/integrate/nodejs-api#linter ) and built-in rules
11+ - A wrapper that causes TypeScript's ` typescript ` and ` typescript/lib/tsserverlibrary ` module entry points to be downloaded on the fly
12+ - This uses the same source as the [ TypeScript playground] ( https://typescriptlang.org/play ) , giving us a "Monaco web" compatible bundle
13+ - typescript-eslint packages, including:
14+ - ` @typescript-eslint/eslint-plugin ` and all its configs and rules
15+ - ` @typescript-eslint/parser ` and ` @typescript-eslint/typescript-estree `
16+
17+ The build files intentionally use deep ` /use-at-your-own-risk ` imports into our packages.
18+ This is so that esbuild can properly tree-shake and only include the necessary code.
19+ This saves us having to mock unnecessary things and reduces our website bundle size.
Original file line number Diff line number Diff line change 22
33[ ![ Netlify Status] ( https://api.netlify.com/api/v1/badges/128d21c7-b2fe-45ad-b141-9878fcf5de3a/deploy-status )] ( https://app.netlify.com/sites/typescript-eslint/deploys )
44
5- This website is built using [ Docusaurus 2 ] ( https://v2. docusaurus.io/ ) , a modern static website generator.
5+ This website is built using [ Docusaurus] ( https://docusaurus.io/ ) , a modern static website generator.
66
77## Installation
88
You can’t perform that action at this time.
0 commit comments