Skip to content

hack4impact/jetbrains-plugin

Repository files navigation


Hack4Impact Icon
Hack4Impact's JetBrains Recommendations

Version Rating Build

JetBrains Plugin that provides recommended templates for quality project development:

  • ESLint Configuration (.eslintrc.json)
  • Prettier Configuration (.prettierrc.json)
  • MarkdownLint Configuration (.markdownlint.json)
  • EditorConfig Configuration (.editorconfig)
  • GitIgnore (.gitignore)
  • Changelog (CHANGELOG.md)
  • License (LICENSE.md)
  • CodeOwners (CODEOWNERS)

If you use VS Code instead, install the VS Code Extension.

Contents

Installation

  • Using IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "Hack4Impact's Recommendations" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Settings/Preferences > Plugins > βš™οΈ > Install plugin from disk...

Actions

All Actions can be found on the menu bar: Tools > Hack4Impact

Create Template Files

Action ID

hack4impact.templates.create

Description

  • Opens a Dialog 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

Create ESLint Configuration Template

Action 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

Create Prettier Configuration Template

Action 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

Create MarkdownLint Configuration Template

Action 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

Create EditorConfig Configuration Template

Action 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

Create GitIgnore Template

Action 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

Create Changelog Template

Action 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

Create License Template

Action 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

Create CodeOwners Template

Action 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

Contributors

Project Contributors (emoji key):


Yash Totale

πŸ’» πŸ€” πŸ“–

Benjamin Holmes

πŸ§‘β€πŸ« πŸ€” πŸ“†

Eric Newcomer

πŸ§‘β€πŸ« πŸ“†

This project follows the all-contributors specification. Contributions of any kind welcome!