Skip to content

Commit 5b8e17e

Browse files
anakinjanakinj
authored
qlty config and fixes (#680)
* qlty config * Remove custom md linter * Autoformat * qlty fixes
1 parent 76b77ef commit 5b8e17e

File tree

11 files changed

+127
-24
lines changed

11 files changed

+127
-24
lines changed

‎.github/workflows/deploy_docs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: GitHub Pages
44
on:
55
push:
66
branches:
7-
- "main"
7+
- main
88

99
jobs:
1010
deploy:

‎.github/workflows/test.yml‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,6 @@ jobs:
2121
bundler-cache: true
2222
- name: Run RuboCop
2323
run: bundle exec rubocop
24-
markdown:
25-
runs-on: ubuntu-latest
26-
steps:
27-
- name: Checkout repository
28-
uses: actions/checkout@v4
29-
- name: Lint Markdown
30-
uses: actionshub/markdownlint@v3.1.4
3124
test:
3225
name: ${{ matrix.os }} - Ruby ${{ matrix.ruby }} - ${{ matrix.gemfile }}
3326
runs-on: ${{ matrix.os }}
@@ -51,16 +44,16 @@ jobs:
5144
include:
5245
- os: ubuntu-latest
5346
ruby: "2.5"
54-
gemfile: "gemfiles/openssl.gemfile"
47+
gemfile: gemfiles/openssl.gemfile
5548
experimental: false
5649
# Disable temporarily due to `ArgumentError: circular causes` error
5750
# - os: ubuntu-latest
5851
# ruby: "truffleruby-head"
5952
# gemfile: "gemfiles/standalone.gemfile"
6053
# experimental: true
6154
- os: ubuntu-latest
62-
ruby: "head"
63-
gemfile: "gemfiles/standalone.gemfile"
55+
ruby: head
56+
gemfile: gemfiles/standalone.gemfile
6457
experimental: true
6558
continue-on-error: ${{ matrix.experimental }}
6659
env:

‎.markdownlint.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"MD013": false
3+
}

‎.mdlrc‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.qlty/.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
*
2+
!configs
3+
!configs/**
4+
!hooks
5+
!hooks/**
6+
!qlty.toml
7+
!.gitignore

‎.qlty/configs/.yamllint.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
rules:
2+
document-start: disable
3+
quoted-strings:
4+
required: only-when-needed
5+
extra-allowed: ["{|}"]
6+
key-duplicates: {}
7+
octal-values:
8+
forbid-implicit-octal: true

‎.qlty/qlty.toml‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# This file was automatically generated by `qlty init`.
2+
# You can modify it to suit your needs.
3+
# We recommend you to commit this file to your repository.
4+
#
5+
# This configuration is used by both Qlty CLI and Qlty Cloud.
6+
#
7+
# Qlty CLI -- Code quality toolkit for developers
8+
# Qlty Cloud -- Fully automated Code Health Platform
9+
#
10+
# Try Qlty Cloud: https://qlty.sh
11+
#
12+
# For a guide to configuration, visit https://qlty.sh/d/config
13+
# Or for a full reference, visit https://qlty.sh/d/qlty-toml
14+
config_version = "0"
15+
16+
exclude_patterns = [
17+
"*_min.*",
18+
"*-min.*",
19+
"*.min.*",
20+
"**/.yarn/**",
21+
"**/*.d.ts",
22+
"**/assets/**",
23+
"**/bower_components/**",
24+
"**/build/**",
25+
"**/cache/**",
26+
"**/config/**",
27+
"**/db/**",
28+
"**/deps/**",
29+
"**/dist/**",
30+
"**/extern/**",
31+
"**/external/**",
32+
"**/generated/**",
33+
"**/Godeps/**",
34+
"**/gradlew/**",
35+
"**/mvnw/**",
36+
"**/node_modules/**",
37+
"**/protos/**",
38+
"**/seed/**",
39+
"**/target/**",
40+
"**/templates/**",
41+
"**/testdata/**",
42+
"**/vendor/**",
43+
]
44+
45+
test_patterns = [
46+
"**/test/**",
47+
"**/spec/**",
48+
"**/*.test.*",
49+
"**/*.spec.*",
50+
"**/*_test.*",
51+
"**/*_spec.*",
52+
"**/test_*.*",
53+
"**/spec_*.*",
54+
]
55+
56+
[smells]
57+
mode = "comment"
58+
59+
[[source]]
60+
name = "default"
61+
default = true
62+
63+
64+
[[plugin]]
65+
name = "actionlint"
66+
67+
[[plugin]]
68+
name = "checkov"
69+
70+
[[plugin]]
71+
name = "markdownlint"
72+
mode = "comment"
73+
74+
[[plugin]]
75+
name = "prettier"
76+
77+
[[plugin]]
78+
name = "ripgrep"
79+
mode = "comment"
80+
81+
[[plugin]]
82+
name = "rubocop"
83+
version = "1.76.1"
84+
85+
[[plugin]]
86+
name = "trivy"
87+
drivers = [
88+
"config",
89+
]
90+
91+
[[plugin]]
92+
name = "trufflehog"
93+
94+
[[plugin]]
95+
name = "yamllint"

‎.rubocop.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ AllCops:
33
NewCops: enable
44
SuggestExtensions: false
55
Exclude:
6-
- "gemfiles/*.gemfile"
7-
- "vendor/**/*"
6+
- gemfiles/*.gemfile
7+
- vendor/**/*
88

99
Metrics/AbcSize:
1010
Max: 25

‎CODE_OF_CONDUCT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
3939

4040
## Enforcement
4141

42-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at antmanj@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
42+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <antmanj@gmail.com>. All complaints will be reviewed and investigated promptly and fairly.
4343

4444
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
4545

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Fork the project on GitHub and clone your own fork. Instuctions on forking can be found from the [GitHub Docs](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
66

7-
```
7+
```bash
88
git clone git@github.com:you/ruby-jwt.git
99
cd ruby-jwt
1010
git remote add upstream https://github.com/jwt/ruby-jwt
@@ -14,7 +14,7 @@ git remote add upstream https://github.com/jwt/ruby-jwt
1414

1515
Make sure you have the latest upstream main branch of the project.
1616

17-
```
17+
```bash
1818
git fetch --all
1919
git checkout main
2020
git rebase upstream/main
@@ -45,15 +45,15 @@ Add a short description of the change in either the `Features` or `Fixes` sectio
4545

4646
The form of the row (You need to return to the row when you know the pull request id)
4747

48-
```
48+
```markdown
4949
- Fix a little problem [#123](https://github.com/jwt/ruby-jwt/pull/123) - [@you](https://github.com/you).
5050
```
5151

5252
## Push your branch and create a pull request
5353

5454
Before pushing make sure the tests pass and RuboCop is happy.
5555

56-
```
56+
```bash
5757
bundle exec appraisal rake test
5858
bundle exec rubocop
5959
git push origin fix-a-little-problem
@@ -67,7 +67,7 @@ Update the [CHANGELOG](CHANGELOG.md) with the pull request id from the previous
6767

6868
You can amend the previous commit with the updated changelog change and force push your branch. The PR will get automatically updated.
6969

70-
```
70+
```bash
7171
git add CHANGELOG.md
7272
git commit --amend --no-edit
7373
git push origin fix-a-little-problem -f
@@ -81,7 +81,7 @@ A maintainer will review and probably merge you changes when time allows, be pat
8181

8282
It's recommended that you keep your branch up-to-date by rebasing to the upstream main.
8383

84-
```
84+
```bash
8585
git fetch upstream
8686
git checkout fix-a-little-problem
8787
git rebase upstream/main
@@ -96,5 +96,3 @@ Also update the [CHANGELOG](CHANGELOG.md) to reflect the upcoming version releas
9696
```bash
9797
rake release
9898
```
99-
100-
**If you want a release cut with your PR, please include a version bump according to **

0 commit comments

Comments
 (0)