Skip to content

Commit

Permalink
Chore(ci): Setup markdown linting
Browse files Browse the repository at this point in the history
refs #12
  • Loading branch information
literat committed Aug 7, 2024
1 parent ac3a55f commit 30f4d77
Show file tree
Hide file tree
Showing 5 changed files with 1,696 additions and 48 deletions.
3 changes: 3 additions & 0 deletions .remarkignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog is autogenerated
CHANGELOG.md
example-changelog.md
5 changes: 5 additions & 0 deletions .remarkrc.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import config from './packages/remark-config/index.js';

export default {
...config,
};
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Built with ❤️ at [Alma Career][alma-home]
This monorepo contains shareable configurations for various coding-style/best practices/lint tools to make the configurations consistent across projects and provide easy setup mechanism.
This monorepo contains shareable configurations for various coding-style/best practices/lint tools to make the configurations consistent across projects and provide an easy setup mechanism.

## Available Configurations

Expand All @@ -12,7 +12,7 @@ This monorepo contains shareable configurations for various coding-style/best pr
| Commitlint | [@lmc-eu/commitlint-config](packages/commitlint-config) | [![@lmc-eu/commitlint-config][clc-badge]][clc-npm] |
| Conventional Changelog | [@lmc-eu/conventional-changelog-lmc-bitbucket](packages/conventional-changelog-lmc-bitbucket) | [![@lmc-eu/conventional-changelog-lmc-bitbucket][cc-bb-badge]][cc-bb-npm] |
| Conventional Changelog | [@lmc-eu/conventional-changelog-lmc-github](packages/conventional-changelog-lmc-github) | [![@lmc-eu/conventional-changelog-lmc-github][cc-gh-badge]][cc-gh-npm] |
| ESLint | [@lmc-eu/eslint-config-base](packages/eslint-config-base) | [![@lmc-eu/eslint-config-base][slc-badge]][ec-base-npm] |
| ESLint | [@lmc-eu/eslint-config-base](packages/eslint-config-base) | [![@lmc-eu/eslint-config-base][ec-base-badge]][ec-base-npm] |
| ESLint | [@lmc-eu/eslint-config-graphql](packages/eslint-config-graphql) | [![@lmc-eu/eslint-config-graphql][ec-gql-badge]][ec-gql-npm] |
| ESLint | [@lmc-eu/eslint-config-react](packages/eslint-config-react) | [![@lmc-eu/eslint-config-react][ec-react-badge]][ec-react-npm] |
| ESLint | [@lmc-eu/eslint-config-jest](packages/eslint-config-jest) | [![@lmc-eu/eslint-config-jest][ec-jest-badge]][ec-jest-npm] |
Expand All @@ -28,7 +28,7 @@ See the [LICENSE](LICENSE) file for information.

## Credit

We got a lot of inspiration from similar project at [STRV][strv-github]. Thank you very much ❤️!
We got a lot of inspiration from the similar project at [STRV][strv-github]. Thank you very much ❤️!

[alma-home]: https://www.almacareer.com
[blc-npm]: https://npmjs.org/package/%40lmc-eu/browserslist-config
Expand Down
9 changes: 7 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@
"format:check": "prettier --check ./",
"format:fix": "prettier --write ./",
"format:fix:changelog": "prettier --write ./packages/**/CHANGELOG.md",
"lint": "npm-run-all --serial lint:es lint:text",
"lint": "npm-run-all --serial lint:es lint:text lint:md",
"lint:fix": "npm-run-all --serial lint:*:fix",
"lint:es": "eslint ./",
"lint:es:fix": "yarn lint:es --fix",
"lint:text": "textlint ./",
"lint:text:fix": "yarn lint:text --fix",
"lint:md": "remark ./ --quiet",
"version": "yarn format:fix:changelog"
},
"devDependencies": {
Expand All @@ -41,6 +42,10 @@
"lerna": "8.1.3",
"npm-run-all": "4.1.5",
"prettier": "2.8.8",
"pretty-quick": "3.3.1"
"pretty-quick": "3.3.1",
"remark-cli": "^12.0.0",
"remark-preset-lint-consistent": "^6",
"remark-preset-lint-markdown-style-guide": "^6",
"remark-preset-lint-recommended": "^7"
}
}
Loading

0 comments on commit 30f4d77

Please sign in to comment.