Skip to content

Commit 4ad6e99

Browse files
committed
feat: Added markdown linting
1 parent e485b13 commit 4ad6e99

File tree

3 files changed

+705
-30
lines changed

3 files changed

+705
-30
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@
1515
[![Build Status](https://travis-ci.com/BlueBaseJS/plugin-react-native-paper.svg?branch=master)](https://travis-ci.com/BlueBaseJS/plugin-react-native-paper)
1616
[![codecov](https://codecov.io/gh/BlueBaseJS/plugin-react-native-paper/branch/master/graph/badge.svg)](https://codecov.io/gh/BlueBaseJS/plugin-react-native-paper)
1717
[![Greenkeeper badge](https://badges.greenkeeper.io/BlueBaseJS/plugin-react-native-paper.svg)](https://greenkeeper.io/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BlueBaseJS/plugin-react-native-paper/blob/master/CONTRIBUTING.md)
18-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3c79162871414b6aa7c15d1a423adeca)](https://www.codacy.com/app/BlueBaseJS/plugin-react-native-paper?utm_source=github.com&utm_medium=referral&utm_content=BlueBaseJS/plugin-react-native-paper&utm_campaign=Badge_Grade)
18+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3c79162871414b6aa7c15d1a423adeca)](https://www.codacy.com/app/BlueBaseJS/plugin-react-native-paper?utm_source=github.com&utm_medium=referral&utm_content=BlueBaseJS/plugin-react-native-paper&utm_campaign=Badge_Grade)
1919
[![Known Vulnerabilities](https://snyk.io/test/github/BlueBaseJS/plugin-react-native-paper/badge.svg)](https://snyk.io/test/github/BlueBaseJS/plugin-react-native-paper)
2020
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
2121

2222
## 🤝 Compatibility
2323

2424
| 🌏 Web | 🖥 Electron | 📱 React Native |
25-
| :---: | :--------: | :------------: |
26-
||||
25+
| :----: | :---------: | :-------------: |
26+
||||
2727

2828
## Docs
2929

30-
- [Storybook](https://BlueBaseJS.github.io/plugin-react-native-paper/storybook/)
31-
- [API Docs](https://BlueBaseJS.github.io/plugin-react-native-paper/)
30+
- [Storybook](https://BlueBaseJS.github.io/plugin-react-native-paper/storybook/)
31+
- [API Docs](https://BlueBaseJS.github.io/plugin-react-native-paper/)
3232

3333
## Installation
3434

@@ -66,6 +66,6 @@ export default {
6666

6767
This plugin registers following plugins in BlueBase:
6868

69-
- [x] Button
70-
- [x] Divider
71-
- [x] TextInput
69+
- [x] Button
70+
- [x] Divider
71+
- [x] TextInput

package.json

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@
1919
"outputFile": "bluebase/storybook-native/storybook/storyLoader.js"
2020
}
2121
},
22+
"remarkConfig": {
23+
"plugins": [
24+
"remark-preset-lint-recommended"
25+
]
26+
},
2227
"scripts": {
2328
"storybook-native:start": "bluebase storybook-native:start",
2429
"start": "yarn run storybook",
@@ -29,11 +34,13 @@
2934
"build:main": "tsc -p tsconfig.json && babel ./src --out-dir dist --ignore \"**/__tests__\",\"**/__stories__\" --extensions \".ts,.tsx,.js,.jsx\"",
3035
"fix": "run-s fix:*",
3136
"fix:prettier": "prettier \"src/**/*.ts\" --write",
37+
"fix:md": "remark . -o",
3238
"fix:lint": "eslint src bluebase --ext=ts,tsx --fix .",
3339
"test:lint": "eslint src bluebase --ext=ts,tsx",
3440
"test": "run-s build test:*",
3541
"test:only": "jest --coverage",
3642
"test:prettier": "prettier \"src/**/*.ts\" --list-different",
43+
"test:md": "remark . -f",
3744
"report-coverage": "codecov && cat ./coverage/lcov.info | codacy-coverage",
3845
"doc": "run-s doc:html && run-s doc:build-storybook",
3946
"doc:html": "typedoc src/ --target ES6 --mode file --out docs && cp -r assets docs",
@@ -50,18 +57,6 @@
5057
"web:start": "bluebase web:start",
5158
"expo:start": "bluebase expo:start"
5259
},
53-
"scripts-info": {
54-
"info": "Display information about the package scripts",
55-
"build": "Clean and rebuild the project",
56-
"fix": "Try to automatically fix any linting problems",
57-
"test": "Lint and unit test the project",
58-
"watch": "Watch and rebuild the project on save",
59-
"cov": "Rebuild, run tests, then create and open the coverage report",
60-
"doc": "Generate HTML API documentation and open it in a browser",
61-
"doc:json": "Generate API documentation in typedoc JSON format",
62-
"version": "Bump package.json version, update CHANGELOG.md, tag release",
63-
"reset": "Delete all untracked files and reset the repo to the last commit"
64-
},
6560
"engines": {
6661
"node": ">=8.9"
6762
},
@@ -126,6 +121,8 @@
126121
"react-native-storybook-loader": "^1.8.0",
127122
"react-native-typescript-transformer": "1.2.13",
128123
"react-test-renderer": "16.13.1",
124+
"remark-cli": "^6.0.1",
125+
"remark-preset-lint-recommended": "^3.0.2",
129126
"schedule": "0.5.0",
130127
"ts-jest": "^26.1.4",
131128
"typedoc": "0.17.8",

0 commit comments

Comments
 (0)