Skip to content

Commit fd52276

Browse files
committed
Add markdownlint configuration and README adjustments
- Added `.markdownlint.json` for consistent Markdown formatting. - Updated `README.md` with improved badge URLs and new rel attributes. - Adjusted code formatting and disabled specific markdownlint rules where applicable.
1 parent aba228b commit fd52276

2 files changed

Lines changed: 31 additions & 17 deletions

File tree

.markdownlint.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"default": true,
3+
"MD003": { "style": "setext_with_atx" },
4+
"MD007": { "indent": 2 },
5+
"MD013": { "line_length": 120 }
6+
}

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,74 @@
1+
<!-- markdownlint-disable MD013 MD033 MD041 -->
12
<p align="center">
23
<img src="dmorph_logo.svg" width="40%" alt="Logo"><br>
34
<a href="https://github.com/AlphaOne1/dmorph/actions/workflows/test.yml"
4-
rel="external"
5+
rel="external noopener noreferrer"
56
target="_blank">
67
<img src="https://github.com/AlphaOne1/dmorph/actions/workflows/test.yml/badge.svg"
78
alt="Test Pipeline Result">
89
</a>
910
<a href="https://github.com/AlphaOne1/dmorph/actions/workflows/codeql.yml"
10-
rel="external"
11+
rel="external noopener noreferrer"
1112
target="_blank">
1213
<img src="https://github.com/AlphaOne1/dmorph/actions/workflows/codeql.yml/badge.svg"
1314
alt="CodeQL Pipeline Result">
1415
</a>
1516
<a href="https://github.com/AlphaOne1/dmorph/actions/workflows/security.yml"
16-
rel="external"
17+
rel="external noopener noreferrer"
1718
target="_blank">
1819
<img src="https://github.com/AlphaOne1/dmorph/actions/workflows/security.yml/badge.svg"
1920
alt="Security Pipeline Result">
2021
</a>
2122
<a href="https://goreportcard.com/report/github.com/AlphaOne1/dmorph"
22-
rel="external"
23+
rel="external noopener noreferrer"
2324
target="_blank">
2425
<img src="https://goreportcard.com/badge/github.com/AlphaOne1/dmorph"
2526
alt="Go Report Card">
2627
</a>
27-
<a href="https://codecov.io/github/AlphaOne1/dmorph"
28-
rel="external"
28+
<a href="https://app.codecov.io/gh/AlphaOne1/dmorph"
29+
rel="external noopener noreferrer"
2930
target="_blank">
30-
<img src="https://codecov.io/github/AlphaOne1/dmorph/graph/badge.svg?token=Q5PURQH5ZM"
31+
<img src="https://codecov.io/gh/AlphaOne1/dmorph/graph/badge.svg"
3132
alt="Code Coverage">
3233
</a>
34+
<a href="https://coderabbit.ai"
35+
rel="external noopener noreferrer"
36+
target="_blank">
37+
<img src="https://img.shields.io/coderabbit/prs/github/AlphaOne1/dmorph"
38+
alt="CodeRabbit Reviews">
39+
</a>
3340
<!--<a href="https://www.bestpractices.dev/projects/0000"
34-
rel="external"
41+
rel="external noopener noreferrer"
3542
target="_blank">
3643
<img src="https://www.bestpractices.dev/projects/0000/badge"
3744
alt="OpenSSF Best Practises">
3845
</a>-->
3946
<a href="https://scorecard.dev/viewer/?uri=github.com/AlphaOne1/dmorph"
40-
rel="external"
47+
rel="external noopener noreferrer"
4148
target="_blank">
4249
<img src="https://api.scorecard.dev/projects/github.com/AlphaOne1/dmorph/badge"
4350
alt="OpenSSF Scorecard">
4451
</a>
4552
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2FAlphaOne1%2Fdmorph?ref=badge_shield&issueType=license"
46-
rel="external"
53+
rel="external noopener noreferrer"
4754
target="_blank">
4855
<img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2FAlphaOne1%2Fdmorph.svg?type=shield&issueType=license"
4956
alt="FOSSA Status">
5057
</a>
5158
<a href="https://app.fossa.com/projects/git%2Bgithub.com%2FAlphaOne1%2Fdmorph?ref=badge_shield&issueType=security"
52-
rel="external"
59+
rel="external noopener noreferrer"
5360
target="_blank">
5461
<img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2FAlphaOne1%2Fdmorph.svg?type=shield&issueType=security"
5562
alt="FOSSA Status">
5663
</a>
57-
<a href="https://godoc.org/github.com/AlphaOne1/dmorph"
58-
rel="external"
64+
<a href="https://pkg.go.dev/github.com/AlphaOne1/dmorph"
65+
rel="external noopener noreferrer"
5966
target="_blank">
60-
<img src="https://godoc.org/github.com/AlphaOne1/dmorph?status.svg"
67+
<img src="https://pkg.go.dev/badge/github.com/AlphaOne1/dmorph.svg"
6168
alt="GoDoc Reference">
6269
</a>
6370
</p>
71+
<!-- markdownlint-enable MD013 MD033 MD041 -->
6472

6573
DMorph
6674
======
@@ -174,12 +182,12 @@ import (
174182
var migrationFS embed.FS
175183

176184
func migrate(db *sql.DB) error {
177-
sub, subErr := fs.Sub(migrationFS, "testData")
178-
185+
sub, subErr := fs.Sub(migrationFS, "testData")
186+
179187
if subErr != nil {
180188
return subErr
181189
}
182-
190+
183191
return dmorph.Run(db,
184192
dmorph.WithDialect(dmorph.DialectSQLite()),
185193
dmorph.WithMigrationsFromFS(sub.(fs.ReadDirFS)))

0 commit comments

Comments
 (0)