Skip to content

Commit 2bbfa72

Browse files
authored
Replace prettier with mdformat and yamlfmt (#211)
Committed via https://github.com/asottile/all-repos
1 parent 706f389 commit 2bbfa72

8 files changed

Lines changed: 46 additions & 58 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ body:
99
placeholder: PyCharm 2024.2
1010
validations:
1111
required: true
12-
1312
- type: dropdown
1413
id: os
1514
attributes:
@@ -18,23 +17,20 @@ body:
1817
- macOS
1918
- Linux
2019
- Windows
21-
2220
- type: input
2321
id: version
2422
attributes:
2523
label: PyVenv Plugin version
2624
placeholder: 2.0.0
2725
validations:
2826
required: true
29-
3027
- type: textarea
3128
id: issue
3229
attributes:
3330
label: What happened?
3431
description: A clear and concise description of what the bug is.
3532
validations:
3633
required: true
37-
3834
- type: textarea
3935
id: logs
4036
attributes:

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,18 @@ body:
99
description: A clear and concise description of what the need or problem is.
1010
validations:
1111
required: true
12-
1312
- type: textarea
1413
id: solution
1514
attributes:
1615
label: Proposed solution
1716
description: A clear and concise description of what you want to happen.
1817
validations:
1918
required: true
20-
2119
- type: textarea
2220
id: alternatives
2321
attributes:
2422
label: Alternatives you've considered
2523
description: What did you try so far to accomplish the goal?
26-
2724
- type: textarea
2825
id: context
2926
attributes:

.github/SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| Version | Supported |
66
| ------- | ------------------ |
77
| 2.x | :white_check_mark: |
8-
| <2 | :x: |
8+
| \<2 | :x: |
99

1010
## Reporting a Vulnerability
1111

.github/workflows/check.yaml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,11 @@ on:
33
push:
44
branches: [main]
55
pull_request:
6-
76
concurrency:
87
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
98
cancel-in-progress: true
10-
119
permissions:
1210
contents: read
13-
1411
jobs:
1512
build:
1613
name: 📦 Build
@@ -46,7 +43,6 @@ jobs:
4643
with:
4744
name: ${{ steps.artifact.outputs.filename }}
4845
path: ./build/distributions/content/*/*
49-
5046
verify:
5147
name: 🔍 Verify (${{ matrix.ide }})
5248
runs-on: ubuntu-latest
@@ -90,7 +86,6 @@ jobs:
9086
with:
9187
name: pluginVerifier-result-${{ matrix.ide }}
9288
path: ${{ github.workspace }}/build/reports/pluginVerifier
93-
9489
lint:
9590
name: 🧹 Lint
9691
runs-on: ubuntu-latest
@@ -113,7 +108,6 @@ jobs:
113108
uses: gradle/actions/setup-gradle@3f131e8634966bd73d06cc69884922b02e6faf92 # v6
114109
- name: 🔍 Run linter
115110
run: ./gradlew ktlintCheck
116-
117111
test:
118112
name: 🧪 Unit tests
119113
runs-on: ubuntu-latest
@@ -136,7 +130,6 @@ jobs:
136130
uses: gradle/actions/setup-gradle@3f131e8634966bd73d06cc69884922b02e6faf92 # v6
137131
- name: ✅ Run tests with coverage
138132
run: ./gradlew test koverVerify
139-
140133
ui-test:
141134
name: 🖥️ UI tests
142135
runs-on: ubuntu-latest

.github/workflows/release.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ name: Release
33
on:
44
release:
55
types: [released]
6-
76
jobs:
87
publish:
98
name: 🚀 Publish
@@ -60,7 +59,6 @@ jobs:
6059
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6160
GITHUB_EVENT_RELEASE_TAG_NAME: ${{ github.event.release.tag_name }}
6261
run: gh release upload ${GITHUB_EVENT_RELEASE_TAG_NAME} ./build/distributions/*
63-
6462
post-release:
6563
name: 📝 Post-release version bump
6664
needs: publish

.pre-commit-config.yaml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,20 @@ repos:
99
hooks:
1010
- id: check-github-workflows
1111
args: ["--verbose"]
12-
- repo: https://github.com/rbubley/mirrors-prettier
13-
rev: "v3.9.5"
12+
- repo: https://github.com/google/yamlfmt
13+
rev: "v0.21.0"
1414
hooks:
15-
- id: prettier
15+
- id: yamlfmt
16+
- repo: local
17+
hooks:
18+
- id: mdformat
19+
name: mdformat
20+
entry: mdformat --wrap 120
21+
language: python
22+
types: [markdown]
1623
additional_dependencies:
17-
- prettier@3.6.2
18-
- "@prettier/plugin-xml@3.4.2"
24+
- mdformat-gfm>=1
25+
- mdformat-ruff>=0.1.3
1926
- repo: https://github.com/zizmorcore/zizmor-pre-commit
2027
rev: v1.26.1
2128
hooks:

CHANGELOG.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -142,25 +142,24 @@ ${GITHUB_EVENT_RELEASE_BODY}
142142

143143
- Removed the usage of the deprecated PythonSdkType.getPythonExecutable API
144144

145-
[Unreleased]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.4.1...HEAD
146-
[2.4.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.3.0...2.4.1
147-
[2.3.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.7...2.3.0
148-
[2.2.7]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.6...2.2.7
149-
[2.2.6]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.5...2.2.6
150-
[2.2.5]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.4...2.2.5
151-
[2.2.4]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.3...2.2.4
152-
[2.2.3]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.2...2.2.3
153-
[2.2.2]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.1...2.2.2
154-
[2.2.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.0...2.2.1
155-
[2.2.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.1.2...2.2.0
156-
[2.1.2]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.1.0...2.1.2
157-
[2.1.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.0.1...2.1.0
158-
[2.0.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.0.0...2.0.1
159-
[2.0.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.4.0...2.0.0
160-
[1.4.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.4...1.4.0
161-
[1.3.4]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.3...1.3.4
162-
[1.3.3]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.2...1.3.3
163-
[1.3.2]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.1...1.3.2
164-
[1.3.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.0...1.3.1
165145
[1.3.0]: https://github.com/pyvenvmanage/PyVenvManage/commits/1.3.0
166-
[unreleased]: https://github.com/pyvenvmanage/PyVenvManage/compare/v2.2.7...HEAD
146+
[1.3.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.0...1.3.1
147+
[1.3.2]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.1...1.3.2
148+
[1.3.3]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.2...1.3.3
149+
[1.3.4]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.3...1.3.4
150+
[1.4.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.3.4...1.4.0
151+
[2.0.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/1.4.0...2.0.0
152+
[2.0.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.0.0...2.0.1
153+
[2.1.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.0.1...2.1.0
154+
[2.1.2]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.1.0...2.1.2
155+
[2.2.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.1.2...2.2.0
156+
[2.2.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.0...2.2.1
157+
[2.2.2]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.1...2.2.2
158+
[2.2.3]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.2...2.2.3
159+
[2.2.4]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.3...2.2.4
160+
[2.2.5]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.4...2.2.5
161+
[2.2.6]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.5...2.2.6
162+
[2.2.7]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.6...2.2.7
163+
[2.3.0]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.2.7...2.3.0
164+
[2.4.1]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.3.0...2.4.1
165+
[unreleased]: https://github.com/pyvenvmanage/PyVenvManage/compare/2.4.1...HEAD

CONTRIBUTING.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,23 @@ end-to-end UI tests that interact with a running IDE.
1515

1616
### Unit Tests
1717

18-
Unit tests cover business logic, action update logic, and error paths. They run quickly and don't require a running
19-
IDE:
18+
Unit tests cover business logic, action update logic, and error paths. They run quickly and don't require a running IDE:
2019

2120
```bash
2221
./gradlew test
2322
```
2423

2524
### UI Tests
2625

27-
UI tests validate full user workflows by interacting with a running PyCharm instance via RemoteRobot. Start the IDE
28-
with robot-server in one terminal:
26+
UI tests validate full user workflows by interacting with a running PyCharm instance via RemoteRobot. Start the IDE with
27+
robot-server in one terminal:
2928

3029
```bash
3130
./gradlew runIdeForUiTests
3231
```
3332

34-
Wait for the IDE to fully start and the robot-server to be ready at http://localhost:8082, then run the tests in
35-
another terminal:
33+
Wait for the IDE to fully start and the robot-server to be ready at http://localhost:8082, then run the tests in another
34+
terminal:
3635

3736
```bash
3837
./gradlew uiTest
@@ -63,8 +62,8 @@ Check code style with `./gradlew ktlintCheck` or auto-fix issues with `./gradlew
6362
## Continuous Integration
6463

6564
The CI pipeline in `.github/workflows/check.yaml` builds the plugin, runs linting, executes unit tests with coverage
66-
verification followed by UI tests, verifies the plugin against PyCharm Community and PyCharm Professional, and creates
67-
a release draft on the main branch.
65+
verification followed by UI tests, verifies the plugin against PyCharm Community and PyCharm Professional, and creates a
66+
release draft on the main branch.
6867

6968
The test job runs unit tests with `koverVerify`, then starts Xvfb and the IDE with robot-server, and finally runs UI
7069
tests for end-to-end validation.
@@ -75,8 +74,8 @@ Before committing, run `./gradlew ktlintFormat` to fix style issues, then `./gra
7574
pass with full coverage. If you modified action classes, run UI tests for end-to-end validation by starting
7675
`./gradlew runIdeForUiTests` in one terminal and `./gradlew uiTest` in another.
7776

78-
Follow conventional commit style: use `feat:` for new features, `fix:` for bug fixes, `refactor:` for code
79-
refactoring, `test:` for test changes, `docs:` for documentation, and `chore:` for maintenance tasks.
77+
Follow conventional commit style: use `feat:` for new features, `fix:` for bug fixes, `refactor:` for code refactoring,
78+
`test:` for test changes, `docs:` for documentation, and `chore:` for maintenance tasks.
8079

8180
## Troubleshooting
8281

@@ -90,15 +89,14 @@ code requires IntelliJ platform services that can't be mocked, add UI test cover
9089

9190
## Releasing
9291

93-
The plugin version is defined in `gradle.properties` as `pluginVersion`. To release, update the version in that file
94-
and merge your PR to main. The CI automatically creates a draft release on GitHub with the version from
95-
`gradle.properties`.
92+
The plugin version is defined in `gradle.properties` as `pluginVersion`. To release, update the version in that file and
93+
merge your PR to main. The CI automatically creates a draft release on GitHub with the version from `gradle.properties`.
9694

9795
Review the draft release on the [Releases page](https://github.com/pyvenvmanage/PyVenvManage/releases) and edit the
9896
release notes if needed. Click "Publish release" (not pre-release) to trigger the release workflow, which builds and
9997
signs the plugin, publishes to [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/20536-pyvenv-manage-2),
100-
uploads the plugin ZIP to the GitHub release, and creates a PR to update CHANGELOG.md. Merge that changelog PR after
101-
the release workflow completes.
98+
uploads the plugin ZIP to the GitHub release, and creates a PR to update CHANGELOG.md. Merge that changelog PR after the
99+
release workflow completes.
102100

103101
The release workflow requires repository secrets configured by maintainers: `PUBLISH_TOKEN` for JetBrains Marketplace
104102
upload, and `CERTIFICATE_CHAIN`, `PRIVATE_KEY`, and `PRIVATE_KEY_PASSWORD` for plugin signing.

0 commit comments

Comments
 (0)