codepunkt/vscode-defaults

Generates opinionated vscode workspace settings for Javascript projects

vscode-defaults

Generates opinionated Visual Studio Code workspace settings for JavaScript and React projects. This sets up

• recommendations for VSCode extensions
• linting with ESLint
• autoformatting your code with Prettier and ESLint

Both linting and autoformatting are largely based on JavaScript Standard Style

Installation

ESLint is required as a peer dependency. To install this package, the Yarn command is

yarn add --dev eslint vscode-defaults

If you don't have Yarn yet, install it first.

On installation, this will copy a .vscode workspace settings folder, .gitignore, .editorconfig and .eslintrc files to your project. If any of these exist, the existing versions will be kept.

Open your project directory in VSCode and install the recommended plugins. Reload VSCode afterwards.

Dealing with changes

It is advised that you let this package manage your projects .vscode folder as well as the .editorconfig, .eslintrc and .gitignore files. If you want to do changes in any of them, create a pull request to this project with a description of your use case and changes.

Updating and overwriting files with new version

To upgrade your version of vscode-defaults run

yarn upgrade vscode-defaults

If you have upgraded your version of vscode-defaults and would like to have your previously generated files overwritten by the new version, you can use the --force option of the CLI

node_modules/.bin/vscode-defaults --force

Requirements

• Node.js ^6.9.4 or newer
• ESLint ^3.19.0 or newer