Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add markdownlint config #62

Merged
merged 2 commits into from
May 22, 2024
Merged

chore: Add markdownlint config #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9f05b9
initial commit
nieomylnieja May 18, 2024
76edd32
update README
nieomylnieja May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .markdownlint.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
MD010:
code_blocks: false
spaces_per_tab: 1
MD013:
line_length: 80
heading_line_length: 80
code_block_line_length: 120
code_blocks: true
MD024:
siblings_only: true
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ check/trailing:
## Check markdown files for potential issues with markdownlint.
check/markdown:
$(call _print_step,Verifying Markdown files)
yarn --silent markdownlint '*.md' --disable MD010, MD034 # MD010 does not handle code blocks well.
yarn --silent markdownlint '**/*.md' --ignore node_modules

## Check for potential vulnerabilities across all Go dependencies.
check/vulns:
Expand Down
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,11 @@ Example:

### Module sources

| Source | Flag | Example |
|-------------|-----------|-----------------------------------------------------------------------|
| File path | _default_ | ~/my-project/go.mod |
| URL | `--url` | https://raw.githubusercontent.com/nieomylnieja/go-libyear/main/go.mod |
| Module path | `--pkg` | github.com/nieomylnieja/go-libyear@latest |
| Source | Flag | Example |
|-------------|-----------|-----------------------------------------------------------------------------------------------------------------|
| File path | _default_ | ~/my-project/go.mod |
| URL | `--url` | https://raw.githubusercontent.com/nieomylnieja/go-libyear/main/go.mod <!-- markdownlint-disable-line MD034 --> |
| Module path | `--pkg` | github.com/nieomylnieja/go-libyear@latest |

<!-- markdownlint-enable MD013 -->

Expand Down Expand Up @@ -219,7 +219,7 @@ it will drop the following error:
updates to go.sum needed, disabled by -mod=readonly
```

Due to that it is advised to use stick with default modules information
Due to that it is advised to stick with default modules information
provider.

## Development
Expand All @@ -234,8 +234,8 @@ CLI tests.

Inspired directly
by [SE Radio episode 587](https://www.se-radio.net/2023/10/se-radio-587-m-scott-ford-on-managing-dependency-freshness/).
Further reading through https://libyear.com/ and
mimicking https://github.com/jaredbeck/libyear-bundler capabilities.
Further reading through [libyear.com](https://libyear.com/) and
mimicking [libyear-bundler](https://github.com/jaredbeck/libyear-bundler) capabilities.

All the concepts and theory is based
on or directly quoted
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"type": "module",
"devDependencies": {
"cspell": "8.8.1",
"markdownlint-cli": "0.39.0",
"markdownlint-cli": "0.40.0",
"yaml": "2.4.2"
},
"scripts": {
Expand Down