@govbr-ds/markdownlint-config 3.2.0 → 3.3.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/package.json +3 -3
- package/markdownlint.yml +0 -47
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@ Compartilhar os padrões de criação markdown entre os projetos do [GovBR-DS](h
|
|
|
9
9
|
1. Instale os seguintes pacotes:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
|
|
12
|
+
npm install -D @govbr-ds/markdownlint-config husky
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Como configurar
|
|
@@ -34,7 +34,7 @@ Configurações para o [Markdownlint](https://github.com/DavidAnson/markdownlint
|
|
|
34
34
|
1. Conforme a documentação do [Husky](https://github.com/typicode/husky) inclua o hook `pre-commit` com o código abaixo:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
|
|
37
|
+
npx --no -- lint-staged
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
E configure o `package.json` com o seguinte script:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@govbr-ds/markdownlint-config",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.3.0-alpha.1",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Configuração compartilhada do markdownlint para projetos do GovBR-DS",
|
|
6
6
|
"keywords": [
|
|
@@ -17,9 +17,9 @@
|
|
|
17
17
|
},
|
|
18
18
|
"license": "MIT",
|
|
19
19
|
"author": "SERPRO (http://serpro.gov.br/)",
|
|
20
|
-
"main": "markdownlint.
|
|
20
|
+
"main": "markdownlint.jsonc",
|
|
21
21
|
"files": [
|
|
22
|
-
"markdownlint.
|
|
22
|
+
"markdownlint.jsonc"
|
|
23
23
|
],
|
|
24
24
|
"scripts": {
|
|
25
25
|
"commit": "git-cz",
|
package/markdownlint.yml
DELETED
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# Default state for all rules
|
|
2
|
-
default: true
|
|
3
|
-
|
|
4
|
-
# MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md003.md
|
|
5
|
-
MD003:
|
|
6
|
-
style: atx
|
|
7
|
-
# MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md004.md
|
|
8
|
-
MD004:
|
|
9
|
-
style: dash
|
|
10
|
-
|
|
11
|
-
# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
|
|
12
|
-
MD013: false
|
|
13
|
-
|
|
14
|
-
MD024:
|
|
15
|
-
siblings_only: true
|
|
16
|
-
|
|
17
|
-
# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
|
|
18
|
-
MD033: false
|
|
19
|
-
|
|
20
|
-
# MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md035.md
|
|
21
|
-
MD035:
|
|
22
|
-
style: ---
|
|
23
|
-
|
|
24
|
-
# MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/main/doc/md044.md
|
|
25
|
-
MD044:
|
|
26
|
-
code_blocks: false
|
|
27
|
-
html_elements: false
|
|
28
|
-
names:
|
|
29
|
-
- Design System
|
|
30
|
-
- Web Components
|
|
31
|
-
- Padrão Digital de Governo
|
|
32
|
-
|
|
33
|
-
# MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md046.md
|
|
34
|
-
MD046:
|
|
35
|
-
style: fenced
|
|
36
|
-
|
|
37
|
-
# MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md048.md
|
|
38
|
-
MD048:
|
|
39
|
-
style: backtick
|
|
40
|
-
|
|
41
|
-
# MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md049.md
|
|
42
|
-
MD049:
|
|
43
|
-
style: asterisk
|
|
44
|
-
|
|
45
|
-
# MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/main/doc/md050.md
|
|
46
|
-
MD050:
|
|
47
|
-
style: asterisk
|