# vscode-defaults

> Generates opinionated Visual Studio Code workspace settings for JavaScript and React projects

Latest version **1.6.1** (published 2017-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install vscode-defaults
pnpm add vscode-defaults
yarn add vscode-defaults
bun add vscode-defaults
```

Provides the command `vscode-defaults`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.6.1 |
| Published | 2017-05-05 |
| First published | 2017-04-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 2 |
| Author | Christoph Werner |
| Maintainers | codepunkt |
| Keywords | vscode, defaults, settings, extensions, eslint, prettier, linting, linter, formatting, autoformatter, visual studio code, javascript, react, standard, standard style |

## Links

- npm: https://www.npmjs.com/package/vscode-defaults
- Repository: https://github.com/codepunkt/vscode-config-codepunkt
- Homepage: https://github.com/codepunkt/vscode-config-codepunkt#readme
- Issues: https://github.com/codepunkt/vscode-config-codepunkt/issues
- npm.io page: https://npm.io/package/vscode-defaults

## Dependencies (5)

- [yargs](https://npm.io/package/yargs.md) ^7.0.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^2.1.2
- [prettier](https://npm.io/package/prettier.md) ^1.3.0
- [prettier-eslint](https://npm.io/package/prettier-eslint.md) ^6.1.2
- [eslint-config-codepunkt](https://npm.io/package/eslint-config-codepunkt.md) ^1.0.3

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.6.1 (latest) — 2017-05-05
- 1.6.0 — 2017-05-03
- 1.5.1 — 2017-05-03
- 1.5.0 — 2017-04-23
- 1.4.1 — 2017-04-18
- 1.4.0 — 2017-04-04
- 1.1.0 — 2017-04-04
- 1.0.0 — 2017-04-03

## README

# vscode-defaults

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

- recommendations for [VSCode][1] extensions
- linting with [ESLint][2]
- autoformatting your code with [Prettier][3] and [ESLint][2]

Both linting and autoformatting are largely based on [JavaScript Standard Style][4]

## Installation

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

```
yarn add --dev eslint vscode-defaults
```

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

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][1] and install the recommended plugins. Reload [VSCode][1] 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

[1]: https://github.com/Microsoft/vscode
[2]: https://github.com/facebook/react
[3]: https://github.com/eslint/eslint
[4]: https://github.com/prettier/prettier
[5]: https://github.com/feross/standard
[6]: https://github.com/yarnpkg/yarn
[7]: https://yarnpkg.com/en/docs/install

---
_Source: https://npm.io/package/vscode-defaults · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._