Skip to content

Commit 37609c5

Browse files
nzakasamareshsm
andauthored
docs: Update README (#61)
Co-authored-by: Amaresh S M <[email protected]>
1 parent 975b1b6 commit 37609c5

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
1-
# eslint-code-explorer
1+
# ESLint Code Explorer
22

3-
This repository contains a tool designed to help developers explore and understand the scope and structure of their JavaScript and TypeScript codebases. It leverages ESLint's scope analysis capabilities to provide a detailed view of variables, references, and scopes within the code.
3+
## Overview
44

5-
Key features of this repository include:
5+
This repository contains the source code for the ESLint [Code Explorer](https://explorer.eslint.org). 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.
66

7-
- Visualization of scopes, variables, and references using an interactive UI.
8-
- Components such as `ScopeItem` and `TreeEntry` to render detailed information about each scope and its contents.
9-
- Integration with ESLint's scope analysis to accurately represent the code structure.
10-
- A user-friendly interface with expandable and collapsible sections for better navigation.
11-
12-
This tool is particularly useful for developers looking to gain insights into their code's structure, identify potential issues, and improve code quality through better understanding of scope and variable usage.
7+
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.
138

149
## Installation
1510

@@ -38,3 +33,12 @@ Open [http://localhost:5173](http://localhost:5173) with your browser to see the
3833

3934
- The app is configured to use ESLint for linting JavaScript code, with its configuration stored in the `eslint.config.mjs` file.
4035
- The app is also configured to use Prettier for code formatting, with its configuration stored in the `.prettierrc` file.
36+
37+
## License
38+
39+
Apache 2.0
40+
41+
## Credits
42+
43+
- [AST Explorer](https://astexplorer.net) - the original AST visualization tool. We took great inspiration from AST explorer when creating this tool.
44+
- [escope Demo](http://mazurov.github.io/escope-demo/) - the original demo of the [escope](https://github.com/estools/escope) utility that [`eslint-scope`](https://github.com/eslint/js/tree/main/packages/eslint-scope) utility is based on.

0 commit comments

Comments
 (0)