Skip to content

Commit

Permalink
Added Remark.yml and .remarkrc
Browse files Browse the repository at this point in the history
Addresses Rust-GCC#487
Remark.yml contains the workflow and .remarkrc is the linter's config file.
Signed-off-by: M V V S Manoj Kumar <[email protected]>
  • Loading branch information
mvvsmk committed Nov 6, 2021
1 parent 57c3131 commit 9c4e3db
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/Remark.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Remark

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
remark:
runs-on: ubuntu-latest

steps:
# Setup
- name: Checkout
uses: actions/[email protected]

- name: Setup Node.js
uses: actions/[email protected]
with:
node-version: '12.x'

- name: Install remark
run: npm install remark-cli remark-lint remark-lint-maximum-line-length remark-preset-lint-recommended remark-gfm

# Run
- name: Check *.md files
run: git ls-files -z *.md | xargs -0 -n 1 npx remark -u lint -f > /dev/null

14 changes: 14 additions & 0 deletions .remarkrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"plugins": [
"remark-preset-lint-recommended",
"remark-gfm",
["remark-lint-maximum-line-length", 120],
["remark-lint-list-item-indent", false],
["remark-lint-no-literal-urls", false],
["remark-lint-no-shortcut-reference-link", false]
],
"settings": {
"commonmark": true
}
}

0 comments on commit 9c4e3db

Please sign in to comment.