Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hack4impact/jetbrains-plugin
JetBrains Plugin that provides recommended templates for quality project development
https://github.com/hack4impact/jetbrains-plugin
editorconfig eslint formatters hack4impact intellij intellij-plugin jetbrains jetbrains-plugin linters markdownlint prettier
Last synced: 1 day ago
JSON representation
JetBrains Plugin that provides recommended templates for quality project development
- Host: GitHub
- URL: https://github.com/hack4impact/jetbrains-plugin
- Owner: hack4impact
- License: mit
- Created: 2021-02-28T03:18:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T01:23:32.000Z (over 1 year ago)
- Last Synced: 2024-05-28T16:35:30.886Z (6 months ago)
- Topics: editorconfig, eslint, formatters, hack4impact, intellij, intellij-plugin, jetbrains, jetbrains-plugin, linters, markdownlint, prettier
- Language: Kotlin
- Homepage: https://tinyurl.com/h4i-jetbrains-plugin
- Size: 676 KB
- Stars: 3
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
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
README
Hack4Impact's JetBrains Recommendations
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](https://github.com/hack4impact/vscode-extension).
## Contents
- [Installation](#installation)
- [Actions](#actions)
- [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)
- [Contributors](#contributors)
## Installation
- Using IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "Hack4Impact's
Recommendations" >
Install Plugin
- Manually:
Download the [latest release](https://github.com/hack4impact/jetbrains-plugin/releases/latest) 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](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!