@govbr-ds/markdownlint-config 3.2.0

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 ADDED
@@ -0,0 +1,84 @@
1
+ # GovBR-DS - Config Tools
2
+
3
+ ## Objetivo
4
+
5
+ Compartilhar os padrões de criação markdown entre os projetos do [GovBR-DS](https://gitlab.com/govbr-ds 'GovBR-DS').
6
+
7
+ ## Como instalar
8
+
9
+ 1. Instale os seguintes pacotes:
10
+
11
+ ```bash
12
+ npm install -D @govbr-ds/markdownlint-config husky
13
+ ```
14
+
15
+ ## Como configurar
16
+
17
+ Configurações para o [Markdownlint](https://github.com/DavidAnson/markdownlint) e também usamos o [Markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli).
18
+
19
+ 1. Crie um arquivo `.markdownlint.yml` na raiz do seu projeto e extenda a configuração:
20
+
21
+ ```yml
22
+ extends: '@govbr-ds/markdownlint-config'
23
+ ```
24
+
25
+ 1. Crie um arquivo `.markdownlintignore` na raiz do seu projeto e inclua os arquivos e pastas que deseja ignorar da validação de markdown:
26
+
27
+ ```yml
28
+ CHANGELOG.MD
29
+ node_modules
30
+ ```
31
+
32
+ Quando o CHANGELOG.md é gerado automaticamente é recomendável o excluir da verificação.
33
+
34
+ 1. Conforme a documentação do [Husky](https://github.com/typicode/husky) inclua o hook `pre-commit` com o código abaixo:
35
+
36
+ ```bash
37
+ npx --no -- lint-staged
38
+ ```
39
+
40
+ E configure o `package.json` com o seguinte script:
41
+
42
+ ```json
43
+ "scripts": {
44
+ "lint:md": "markdownlint -d --fix **/*.md",
45
+ },
46
+ "lint-staged": {
47
+ "*.md": [
48
+ "prettier --write",
49
+ "markdownlint -d --fix"
50
+ ]
51
+ },
52
+ ```
53
+
54
+ ## Como contribuir?
55
+
56
+ Antes de abrir um Merge Request tenha em mente algumas informações:
57
+
58
+ - Esse é um projeto opensource e contribuições são bem-vindas.
59
+ - Para facilitar a aprovação da sua contribuição, escolha um título curto, simples e explicativo para o MR, e siga os padrões da nossa [wiki](https://gov.br/ds/wiki/ 'Wiki').
60
+ - Quer contribuir com o projeto? Confira o nosso guia [como contribuir](../../CONTRIBUTING.md 'Como contribuir?').
61
+
62
+ ## Reportar bugs/necessidades
63
+
64
+ Você pode usar as [issues](https://gitlab.com/govbr-ds/tools/govbr-ds-config-tools/-/issues/new) para nos informar os problemas que tem enfrentado ao usar nossa biblioteca ou mesmo o que gostaria que fizesse parte do projeto. Por favor use o modelo que mais se encaixa na sua necessidade e preencha com o máximo de detalhes possível.
65
+
66
+ Nos comprometemos a responder a todas as issues
67
+
68
+ ## Precisa de ajuda?
69
+
70
+ > Por favor **não** crie issues para fazer perguntas...
71
+
72
+ Use nossos canais abaixo para obter tirar suas dúvidas:
73
+
74
+ - Site do GovBR-DS [http://gov.br/ds](http://gov.br/ds)
75
+
76
+ - Usando nosso canal no discord [https://discord.gg/U5GwPfqhUP](https://discord.gg/U5GwPfqhUP)
77
+
78
+ ## Padrão de commits
79
+
80
+ Para mais informações sobre o padrão de commits consulte [a nossa Wiki](https://gov.br/ds/wiki/git-gitlab/guias/commit/ 'Padrão de commit').
81
+
82
+ ## Licença
83
+
84
+ Nesse projeto usamos a licença MIT.
@@ -0,0 +1,47 @@
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
package/package.json ADDED
@@ -0,0 +1,36 @@
1
+ {
2
+ "name": "@govbr-ds/markdownlint-config",
3
+ "version": "3.2.0",
4
+ "private": false,
5
+ "description": "Configuração compartilhada do markdownlint para projetos do GovBR-DS",
6
+ "keywords": [
7
+ "govbr-ds",
8
+ "markdownlint"
9
+ ],
10
+ "homepage": "https://gov.br/ds/",
11
+ "bugs": {
12
+ "url": "https://gitlab.com/govbr-ds/tools/govbr-ds-config-tools/issues"
13
+ },
14
+ "repository": {
15
+ "type": "git",
16
+ "url": "git@gitlab.com:govbr-ds/tools/govbr-ds-config-tools.git"
17
+ },
18
+ "license": "MIT",
19
+ "author": "SERPRO (http://serpro.gov.br/)",
20
+ "main": "markdownlint.yml",
21
+ "files": [
22
+ "markdownlint.yml"
23
+ ],
24
+ "scripts": {
25
+ "commit": "git-cz",
26
+ "lint:md": "markdownlint -d --fix **/*.md"
27
+ },
28
+ "config": {
29
+ "commitizen": {
30
+ "path": "@commitlint/cz-commitlint"
31
+ }
32
+ },
33
+ "dependencies": {
34
+ "markdownlint-cli": "0.39.0"
35
+ }
36
+ }