https://github.com/editorconfig/editorconfig-vscode

EditorConfig extension for Visual Studio Code
https://github.com/editorconfig/editorconfig-vscode

editorconfig vscode-extension

Last synced: 3 months ago
JSON representation

EditorConfig extension for Visual Studio Code

• Host: GitHub
• URL: https://github.com/editorconfig/editorconfig-vscode
• Owner: editorconfig
• License: mit
• Fork: true (microsoft/vscode-editorconfig)
• Created: 2016-02-05T16:21:01.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-02-22T02:24:24.000Z (10 months ago)
• Last Synced: 2024-04-13T22:56:26.572Z (8 months ago)
• Topics: editorconfig, vscode-extension
• Language: TypeScript
• Homepage: http://editorconfig.org/
• Size: 828 KB
• Stars: 1,193
• Watchers: 23
• Forks: 115
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# [EditorConfig][] for [Visual Studio Code][]

[![GitHub Actions][actions-img]][actions] [![Gitter][chat-img]][chat]

[actions-img]: https://github.com/editorconfig/editorconfig-vscode/actions/workflows/test.yml/badge.svg

[actions]: https://github.com/editorconfig/editorconfig-vscode/actions

[chat-img]:

  https://img.shields.io/badge/Gitter-Join_the_EditorConfig_VSCode_chat-brightgreen.png?style=flat-square

[chat]: https://gitter.im/editorconfig/editorconfig-vscode

This plugin [attempts](#known-issues) to override user/workspace settings with

settings found in `.editorconfig` files. No additional or vscode-specific files

are required. As with any EditorConfig plugin, if `root=true` is not specified,

EditorConfig [will continue to look](https://editorconfig.org/#file-location)

for an `.editorconfig` file outside of the project.

### This repository is specific to the [EditorConfig Extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig). Internally, it uses the [`editorconfig` npm package](https://www.npmjs.com/package/editorconfig), which is one of a few [EditorConfig](https://editorconfig.org) cores available.

See also:

- [Visual Studio Code](https://code.visualstudio.com/)

- [EditorConfig Site](https://editorconfig.org)

- [EditorConfig Issue Tracker](https://github.com/editorconfig/editorconfig/issues)

- [EditorConfig Wiki](https://github.com/editorconfig/editorconfig/wiki)

Feel free to submit any issues you may have via the

[issue tracker](https://github.com/editorconfig/editorconfig-vscode/issues).

## Installation

When identifying an extension, provide the full name of the form

`publisher.extension`. For this extension, that's `editorconfig.editorconfig`.

See

[Extension Marketplace](https://code.visualstudio.com/docs/editor/extension-gallery)

for more information on the multiple ways of installing VSCode extensions.

## Supported Properties

- `indent_style`

- `indent_size`

- `tab_width`

- `end_of_line` (on save)

- `insert_final_newline` (on save)

- `trim_trailing_whitespace` (on save)

## On the backlog

- `charset`

## How it works

This extension is activated whenever you open a new text editor, switch tabs

into an existing one or focus into the editor you already have open. When

activated, it uses [`editorconfig`](https://www.npmjs.com/package/editorconfig)

to resolve the configuration for that particular file and applies any relevant

editor settings.

_Note: some settings can only be applied on file save, as indicated above._

A new `.editorconfig` file can be created via the Explorer sidebar's context

menu by right-clicking in the folder where you'd like it to be and selecting

`Generate .editorconfig`.

## Known Issues

- [`trim_trailing_whitespace = false` is not applied when user/workspace setting of `files.trimTrailingWhitespace` is set to `true`.](https://github.com/editorconfig/editorconfig-vscode/issues/153)

[visual studio code]: https://code.visualstudio.com/

[editorconfig]: https://editorconfig.org/