Skip to content
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.

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

Update the docs/developer-guide/architecture page #9337

Closed
VictorHom opened this issue Sep 21, 2017 · 2 comments
Closed

Update the docs/developer-guide/architecture page #9337

VictorHom opened this issue Sep 21, 2017 · 2 comments
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion core Relates to ESLint's core APIs and features documentation Relates to ESLint's documentation

Comments

@VictorHom
Copy link
Member

Page link - https://eslint.org/docs/developer-guide/architecture

I believe the architecture has changed over time and it makes sense to update this page so new contributors can acclimate more quickly to what/which file does what (at least a high level overview)

Most of the page is still accurate, but one part didn't seem up-to-date (since the file doesn't exist anymore):

lib/eslint.js - this is the core eslint object that does code verifying based on configuration options. This file does no file I/O and does not interact with the console at all. For other Node.js programs that have JavaScript text to verify, they would be able to use this interface directly.

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Sep 21, 2017
@VictorHom
Copy link
Member Author

if the issue makes sense, I can look into and help with updating the documentation :)

@platinumazure
Copy link
Member

platinumazure commented Sep 21, 2017

Hi @VictorHom, thanks for the issue!

Yes, we absolutely should update this document! lib/eslint.js has basically been replaced by lib/linter.js (exports class Linter), but there has also been a lot of decomposition of some of the functionality previously in lib/eslint.js into ancillary files.

We could probably start by replacing lib/eslint.js with lib/linter.js in the docs.

@platinumazure platinumazure added accepted There is consensus among the team that this change meets the criteria for inclusion core Relates to ESLint's core APIs and features documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Sep 22, 2017
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Mar 28, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 28, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion core Relates to ESLint's core APIs and features documentation Relates to ESLint's documentation
Projects
None yet
Development

No branches or pull requests

3 participants