Skip to content

Docs: Document website-eslint  #6799

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updatinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions