Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hack4impact/vscode-extension

VS Code Extension that provides recommended extensions and templates for quality project development
https://github.com/hack4impact/vscode-extension

codeowners configuration editorconfig eslint extension-pack formatters hack4impact linters markdownlint prettier templates vscode vscode-extension

Last synced: 2 months ago
JSON representation

VS Code Extension that provides recommended extensions and templates for quality project development

Host: GitHub
URL: https://github.com/hack4impact/vscode-extension
Owner: hack4impact
License: mit
Created: 2021-02-21T01:38:13.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2023-01-07T05:36:58.000Z (about 2 years ago)
Last Synced: 2024-08-13T07:18:00.628Z (5 months ago)
Topics: codeowners, configuration, editorconfig, eslint, extension-pack, formatters, hack4impact, linters, markdownlint, prettier, templates, vscode, vscode-extension
Language: TypeScript
Homepage: https://tinyurl.com/h4i-vscode-extension
Size: 39.5 MB
Stars: 4
Watchers: 3
Forks: 6
Open Issues: 19
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

jimsghstars - hack4impact/vscode-extension - VS Code Extension that provides recommended extensions and templates for quality project development (TypeScript)

README

        


  


    

  


  Hack4Impact's VS Code Recommendations

























VS Code Extension that provides recommended extensions and templates for quality project development.

If you use JetBrains instead, install the [JetBrains plugin](https://github.com/hack4impact/jetbrains-plugin).

## Contents 

- [Installation](#installation)

- [Included Extensions](#included-extensions)

- [Commands](#commands)

  - [Create Template Files](#create-template-files)

  - [Create ESLint Configuration Template](#create-eslint-configuration-template)

  - [Create Prettier Configuration Template](#create-prettier-configuration-template)

  - [Create MarkdownLint Configuration Template](#create-markdownlint-configuration-template)

  - [Create EditorConfig Configuration Template](#create-editorconfig-configuration-template)

  - [Create GitIgnore Template](#create-gitignore-template)

  - [Create Changelog Template](#create-changelog-template)

  - [Create License Template](#create-license-template)

  - [Create CodeOwners Template](#create-codeowners-template)

- [Configuration](#configuration)

  - [Keybindings](#keybindings)

- [Language Support](#language-support)

- [Contributors](#contributors)

## Installation

1. Open [Hack4Impact's Recommendations - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=hack4impact.h4i-recommendations)

2. Click "Install"

**OR**

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

2. Open the Extensions View -> (`Shift+Cmd+P` or `F1` and type "Extensions: Install Extensions") or (`Shift+Cmd+X`)

3. Type "Hack4Impact's Recommendations"

4. Click "Install"

**OR**

1. Open a command-line prompt

2. Run `code --install-extension hack4impact.h4i-recommendations`

## Included Extensions

| Name             | Icon                                                                                                                                                   | Links                                                       |

| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- |

| **ESLint**       |              | [ESLint - Marketplace]
[ESLint - Repository]             |

| **Prettier**     |          | [Prettier - Marketplace]
[Prettier - Repository]         |

| **MarkdownLint** |  | [MarkdownLint - Marketplace]
[MarkdownLint - Repository] |

| **EditorConfig** |  | [EditorConfig - Marketplace]
[EditorConfig - Repository] |

## Commands

### Create Template Files

#### Command Id

`hack4impact.templates.create`

#### Description

- Opens a [Quick Pick] to choose the templates that should be created

- Shows a [File Picker] Dialog to pick the folder where the templates should be created

- Creates the templates with Hack4Impact's recommended configuration

#### Demo

Create Template Files Demo



#### Keybinding

- **Mac**: `cmd+h t`

- **Windows/Linux**: `ctrl+h t`

---

### Create ESLint Configuration Template

#### Command Id

`hack4impact.templates.create.ESLintConfig`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `.eslintrc.json` file should be created

- Creates a `.eslintrc.json` file with Hack4Impact's recommended configuration

#### Demo

Create ESLint Configuration Template Demo



#### Keybinding

- **Mac**: `cmd+h e`

- **Windows/Linux**: `ctrl+h e`

---

### Create Prettier Configuration Template

#### Command Id

`hack4impact.templates.create.PrettierConfig`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `.prettierrc.json` file should be created

- Creates a `.prettierrc.json` file with Hack4Impact's recommended configuration

#### Demo

Create Prettier Configuration Template Demo



#### Keybinding

- **Mac**: `cmd+h p`

- **Windows/Linux**: `ctrl+h p`

---

### Create MarkdownLint Configuration Template

#### Command Id

`hack4impact.templates.create.MarkdownLintConfig`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `.markdownlint.json` file should be created

- Creates a `.markdownlint.json` file with Hack4Impact's recommended configuration

#### Demo

Create MarkdownLint Configuration Template Demo



#### Keybinding

- **Mac**: `cmd+h m`

- **Windows/Linux**: `ctrl+h m`

---

### Create EditorConfig Configuration Template

#### Command Id

`hack4impact.templates.create.EditorConfigConfig`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `.editorconfig` file should be created

- Creates a `.editorconfig` file with Hack4Impact's recommended configuration

#### Demo

Create EditorConfig Configuration Template Demo



#### Keybinding

- **Mac**: `cmd+h d`

- **Windows/Linux**: `ctrl+h d`

---

### Create GitIgnore Template

#### Command Id

`hack4impact.templates.create.GitIgnore`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `.gitignore` file should be created

- Creates a boilerplate `.gitignore` file

#### Demo

Create GitIgnore Template Demo



#### Keybinding

- **Mac**: `cmd+h g`

- **Windows/Linux**: `ctrl+h g`

---

### Create Changelog Template

#### Command Id

`hack4impact.templates.create.Changelog`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `CHANGELOG.md` file should be created

- Creates a boilerplate `CHANGELOG.md` file

#### Demo

Create Changelog Template Demo



#### Keybinding

- **Mac**: `cmd+h c`

- **Windows/Linux**: `ctrl+h c`

---

### Create License Template

#### Command Id

`hack4impact.templates.create.License`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `LICENSE.md` file should be created

- Creates a boilerplate `LICENSE.md` file

#### Demo

Create License Template Demo



#### Keybinding

- **Mac**: `cmd+h l`

- **Windows/Linux**: `ctrl+h l`

---

### Create CodeOwners Template

#### Command Id

`hack4impact.templates.create.CodeOwners`

#### Description

- Shows a [File Picker] Dialog to pick the folder where a `CODEOWNERS` file should be created

- Creates a boilerplate `CODEOWNERS` file

#### Demo

Create CodeOwners Template Demo



#### Keybinding

- **Mac**: `cmd+h o`

- **Windows/Linux**: `ctrl+h o`

## Configuration

### Keybindings

#### Disable All

- **Description**: Controls whether all keybindings are disabled

- **Key**: `hack4impact.recommendations.keybindings.disableAll`

- **Type**: `boolean`

- **Default**: `false`

## Language Support

This extension provides language support and syntax highlighting for the following:

| Language/File | Docs                                                                                                           | Sample                                                                                                   | Source                                                                  |

| ------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |

| `CODEOWNERS`  | [GitHub Docs](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners) | [Sample `CODEOWNERS` file](https://github.com/python/cpython/blob/master/.github/CODEOWNERS)             | [Jason Nutter's Repo](https://github.com/jasonnutter/vscode-codeowners) |

| `robots.txt`  | [Google Search Central](https://developers.google.com/search/docs/advanced/robots/intro)                       | [Sample `robots.txt` file](https://github.com/gitlabhq/gitlabhq/blob/master/public/robots.txt)           | [Nixinova's Repo](https://github.com/Nixinova/tmLanguage)               |

| `_redirects`  | [Netlify Docs](https://docs.netlify.com/routing/redirects/)                                                    | [Sample `_redirects` file](https://github.com/netlify/netlify-cms/blob/master/website/static/_redirects) | [Nixinova's Repo](https://github.com/Nixinova/tmLanguage)               |

## Contributors

Project Contributors ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Yash Totale}
💻 🤔 📖

    
_{Benjamin Holmes}
🧑‍🏫 🤔 📆

    
_{Eric Newcomer}
🧑‍🏫 📆

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

[prettier - marketplace]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

[prettier - repository]: https://github.com/prettier/prettier-vscode

[eslint - marketplace]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint

[eslint - repository]: https://github.com/Microsoft/vscode-eslint

[markdownlint - marketplace]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

[markdownlint - repository]: https://github.com/DavidAnson/vscode-markdownlint

[editorconfig - marketplace]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

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

[quick pick]: https://code.visualstudio.com/api/extension-capabilities/common-capabilities#quick-pick

[file picker]: https://code.visualstudio.com/api/extension-capabilities/common-capabilities#file-picker