8000 Docs: Document website-eslint · Issue #6799 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

Docs: Document website-eslint #6799

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

Jump to bottom
Closed
2 tasks done
JoshuaKGoldberg opened this issue Mar 30, 2023 · 2 comments · Fixed by #9873
Closed
2 tasks done

Docs: Document website-eslint #6799

JoshuaKGoldberg opened this issue Mar 30, 2023 · 2 comments · Fixed by #9873
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

I'm on @Jutanium's Twitch stream. Dan is working on a browser app that includes a CodeMirror editor that we'd sure love to have ESLint run on... except, getting ESLint to run in the browser is a nontrivial task (eslint/eslint#8348). We've managed to do it though!

It'd be good to document how the website-eslint package works architecturally, similar to how we document typescript-estree on https://typescript-eslint.io/architecture/typescript-estree.

At the very least, adding a README.md to the package would be nice.

Affected URL(s)

https://typescript-eslint.io/architecture/website-eslint, maybe?
@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for team members to take a look documentation Documentation ("docs") that needs adding/updating labels Mar 30, 2023
@bradzacher
Copy link
Member
bradzacher commented Mar 31, 2023 •
edited
Loading

@armano2 knows the most - but the TLDR is that you only need/want the Linterclass - which is designed to solely operate on strings and takes object definitions for rules and parsers.

You can tree shake everything else from the package after that.

The harder part is making TS web safe and integrating that into our tooling - which required some fiddling iirc

@armano2 armano2 self-assigned this Mar 31, 2023
@armano2
Copy link
Collaborator
armano2 commented Mar 31, 2023 •
edited
Loading

making eslint work in browser is actually not that hard, as making ts-eslint work, this package is intentionally private as this is a "hack" build to work with monaco,

I will try to prepare some documentation for it after I finish "splitting" #6656, but this is low prio for me (at least for now)

this package on main is kinda a mess and i simplified it in v6
https://github.com/typescript-eslint/typescript-eslint/blob/v6/packages/website-eslint/build.ts

if you want to just load eslint for web without typescript you can look at what @mysticatea and @ota-meshi did in

Our initial versions of playground where inspired by great job done by mysticatea for vue playground

sorry for pinging

@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels Apr 8, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Aug 23, 2024
Merged
3 tasks
@github-actions github-actions bot added the locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. label Sep 7, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: add website-eslint README.md JoshuaKGoldberg/typescript-eslint
3 participants
@armano2 @JoshuaKGoldberg @bradzacher
0