ESLint Code Explorer

Overview

This repository contains the source code for the ESLint Code Explorer. Code Explorer is designed to help developers explore and understand source code to aid in the creation of custom ESLint rules. Each language supported by Code Explorer exposes the same information that ESLint rules have access to.

At a minimum, each language displays the AST for any code that is entered into the editor. You can toggle different parser settings for each language to see how that affects the AST. For JavaScript, you also get to see scope and code path information.

Installation

To install and set up the project, follow these steps:

Ensure you have Node.js v20 installed. You can download it from the official Node.js website.
Clone the repository to your local machine.
Install the project dependencies using npm - npm install.
Setup Docker to run E2E tests via Playwright (Docker Desktop or Docker Engine).

This will install all the necessary packages and dependencies required to run the project.

Once the installation is complete, you can proceed to the next section to get started with running the development server.

Usage

Run the development server with npm run start.

Open http://localhost:5173 with your browser to see the result.

Scripts

npm run start: Starts the development server.
npm run build: Builds the app for production.
npm run test:e2e:update: Runs all End-to-End tests and updates the screenshots/snapshots.

Configuration

The app is configured to use ESLint for linting JavaScript code, with its configuration stored in the eslint.config.mjs file.
The app is also configured to use Prettier for code formatting, with its configuration stored in the .prettierrc file.

License

Apache 2.0

Credits

AST Explorer - the original AST visualization tool. We took great inspiration from AST explorer when creating this tool.
escope Demo - the original demo of the escope utility that eslint-scope utility is based on.

Sponsors

The following companies, organizations, and individuals support ESLint's ongoing maintenance and development. Become a Sponsor to get your logo on our READMEs and website.

Platinum Sponsors

Gold Sponsors

Silver Sponsors

Bronze Sponsors

Technology Sponsors

Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.

License

pkerschbaum/eslint-code-explorer

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages