- Overview
- Download & Install
- Install Extensions
- Debugging
- Developing Inside a Container
- Configuration
LJAS supports Visual Studio Code (VS Code), but it is not required. We highly recommend it as all of the documentation will explain things from a Visual Studio Code user's perspective, but none of the tools it uses are specific to VS Code so there should always be a way to set things up for a different editor.
If you decide against using VS Code, we highly recommend that you figure out how to get ESLint and Prettier (and type checking if you're using TypeScript) operating in your editor. Catching warnings and errors in real-time as you code is extremely valuable!
Although LJAS no longer supports Sublime Text, you can still refer to the v0.1.1 Sublime Text document and figure out how to set that up yourself if that is your editor of choice.
If for whatever reason your editor does not work with these tools, you can resort to using package.json scripts like npm run lint, npm run format, and npm run check-types to check for problems manually in a terminal. We cover these in the "Developing" section of the docs.
The remainder of this document will go over how to setup and work with VS Code.
Download and install Visual Studio Code here.
Open the root directory of a project with VS Code and then open the extensions view by clicking on its icon in the activity bar on the side of the editor. The icon looks like this:
Type in @recommended into the search box to view the recommended extensions for the project and install all of them. All projects will recommend the ESLint extension and Prettier extension, but there may be some variance in others depending on the type of project being used. For example, frontend-related projects will also recommend the Stylelint extension.
If you want to learn how to debug with VS Code, read the "Debugging" document.
If you're using the Docker dev environment, you can develop inside a container with VS Code which sets up all recommended extensions for you out-of-the-box along with a few other benefits. Read the "Developing Inside a Container with Visual Studio Code" section in the "Docker Environments" document to learn how to do that.
Read the Visual Studio Code configuration document to learn how VS Code is configured and how to customize it yourself.