Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 3.46 KB

README.md

File metadata and controls

96 lines (58 loc) · 3.46 KB
Raw

Table of Contents

Format/Lint on save with VSCode

vue-chess

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Cypress

npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing

Lint with ESLint

npm run lint

Format/Lint on save with VSCode

To make sure the code adheres to the format of the repository, you can edit the settings in VSCode to use the eslint configuration for formatting the linting the code.

Step 1: Install the ESLint Extension for VSCode

ESLint by Microsoft

ESLint will use the configuration specified in the .eslintrc file in the root of this project to understand the type of formatting standard and linting rules it should use.

Step 2: Edit VSCode Workspace settings.

The ESLint extension adds variables to the settings for VSCode, which can be used to tell VSCode how to lint the project.

Update the "Workspace" settings with the following options:

{
    "eslint.format.enable": true,
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true,
    }
}

eslint.format.enable: enables ESLint as a formatter for validated files. Although you can also use the formatter on save using the setting editor.formatOnSave it is recommended to use the editor.codeActionsOnSave feature since it allows for better configurability. - ESLint GitHub Repo, "Settings Options"

Need help finding your VSCode settings, or understanding the difference between the User and Workspace settings? Check out the documentation on User and Workspace Settings.