Skip to content

Commit cd05d8b

Browse files
committed
chore: readme + ci
1 parent 532ae88 commit cd05d8b

File tree

2 files changed

+67
-8
lines changed

2 files changed

+67
-8
lines changed

.github/workflows/test.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Tests
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v4
13+
14+
- name: Set up Java
15+
uses: actions/setup-java@v4
16+
with:
17+
distribution: temurin
18+
java-version: 21
19+
20+
- name: Setup Gradle
21+
uses: gradle/actions/setup-gradle@v4
22+
23+
- name: Run tests
24+
run: ./gradlew test

README.md

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,54 @@
11
# HTML Attribute Folder
22

3-
## IntelliJ Plugin
3+
> Fold away verbose HTML attributes for a cleaner editor view
44
5-
Annoyed with some html attributes and their length?
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
6+
[![Tests](https://github.com/Flyrell/html-attribute-folder/actions/workflows/test.yml/badge.svg)](https://github.com/Flyrell/html-attribute-folder/actions/workflows/test.yml)
7+
[![Version](https://img.shields.io/jetbrains/plugin/v/19715-html-attribute-folder.svg)](https://plugins.jetbrains.com/plugin/19715-html-attribute-folder)
8+
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-support-yellow.svg?logo=buy-me-a-coffee)](https://buymeacoffee.com/dawidzbinski)
69

7-
This simple and lightweight plugin will help you fold them, so you don't need to see them anymore. Any template written in RHTML (Ruby HTML), ERB (Embedded
8-
Ruby), JSX, XML, HTML, XHTML and DTD is supported by the plugin. The plugin will not edit your real code in any way, and you can choose whether
9-
to fold the items by default, placeholder for folded items, and how the folding looks like.
10+
## About
1011

11-
You can find the plugin on [IntelliJ marketplace](https://plugins.jetbrains.com/plugin/19715-html-attribute-folder).
12+
HTML Attribute Folder is a lightweight JetBrains plugin that folds HTML attributes directly in the editor, letting you focus on element structure without the noise of lengthy attribute lists. It's completely non-destructive — your code is never modified. Supports HTML, XHTML, XML, JSX, TSX, DTD, and RHTML/ERB templates.
13+
14+
## Features
15+
16+
- Fold HTML attributes to reduce visual clutter
17+
- Non-destructive — your code is never modified
18+
- Configurable placeholder, folding method, and collapse-by-default behavior
19+
- Toggle folding with a keyboard shortcut (`Ctrl+Alt+E`)
20+
- Supports: HTML, XHTML, XML, JSX, TSX, DTD, RHTML/ERB
21+
22+
## Installation
23+
24+
1. Open your JetBrains IDE
25+
2. Go to **Settings → Plugins → Marketplace**
26+
3. Search for **"HTML Attribute Folder"**
27+
4. Click **Install** and restart the IDE
28+
29+
Or install directly from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/19715-html-attribute-folder).
30+
31+
## Configuration
32+
33+
Access settings via **Tools → HTML Attribute Folder Settings**.
34+
35+
| Option | Default | Description |
36+
|---------------------|---------|------------------------------------------------|
37+
| Folding Method || How attributes are folded |
38+
| Placeholder | `...` | Text shown in place of folded attributes |
39+
| Collapse by Default | `true` | Automatically fold attributes when a file opens|
40+
| Attributes | (empty) | Specific attributes to fold |
1241

1342
## Compatibility
1443

15-
Manually verified with IntelliJ IDEA Unified distribution 2025.3+
44+
- IntelliJ IDEA 2025.3+ (build 251+)
45+
- Requires Java 21
46+
- Works with IntelliJ IDEA Ultimate/Community and other JetBrains IDEs with XML/JS support
1647

17-
## ❤️🙏 Love & Thanks
48+
## Acknowledgements
1849

1950
- [tscharke](https://github.com/tscharke) for contributing
51+
52+
## License
53+
54+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)