Skip to content

docs: add website-eslint README.md #9873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 30, 2024
Merged

docs: add website-eslint README.md #9873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
90920aa
docs(website-eslint): add README.md
JoshuaKGoldberg Aug 23, 2024
8a3ec8b
On-the-fly typescript
JoshuaKGoldberg Aug 23, 2024
9a1c49f
Update packages/website/README.md
JoshuaKGoldberg Aug 24, 2024
8aa6339
wrong url
JoshuaKGoldberg Aug 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions packages/website-eslint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# `website-eslint`

A bundled version of ESLint plus `typescript-eslint`, made to work in a browser.
This is exclusively used for the playground in the [`website` package](../website/README.md).

## Building

`yarn build` runs `build.ts`, which uses ESBuild to create a CommonJS bundle including:

- ESLint's [`Linter` class](https://eslint.org/docs/latest/integrate/nodejs-api#linter) and built-in rules
- A wrapper that causes TypeScript's `typescript` and `typescript/lib/tsserverlibrary` module entry points to be downloaded on the fly
- This uses the same source as the [TypeScript playground](https://typescriptlang.org/play), giving us a "Monaco web" compatible bundle
- typescript-eslint packages, including:
- `@typescript-eslint/eslint-plugin` and all its configs and rules
- `@typescript-eslint/parser` and `@typescript-eslint/typescript-estree`

The build files intentionally use deep `/use-at-your-own-risk` imports into our packages.
This is so that esbuild can properly tree-shake and only include the necessary code.
This saves us having to mock unnecessary things and reduces our website bundle size.
2 changes: 1 addition & 1 deletion packages/website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Netlify Status](https://api.netlify.com/api/v1/badges/128d21c7-b2fe-45ad-b141-9878fcf5de3a/deploy-status)](https://app.netlify.com/sites/typescript-eslint/deploys)

This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

Expand Down
Loading