Skip to content

Commit 0cf0d0c

Browse files
author
ADMSK\AVROGAL1
committed
docs: updates on workflows
Added information on documentation
1 parent 5260b8d commit 0cf0d0c

File tree

4 files changed

+58
-39
lines changed

4 files changed

+58
-39
lines changed

.deepsource.toml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
version = 1
2+
3+
test_patterns = ["*/tests/**"]
4+
5+
exclude_patterns = [
6+
"scripts/**,",
7+
"dist/**"
8+
]
9+
10+
[[analyzers]]
11+
name = "javascript"
12+
enabled = true
13+
14+
[analyzers.meta]
15+
dialect = "typescript"
16+
ecma_version = 2020
17+
style_guide = "airbnb"
18+
environment = [
19+
"nodejs",
20+
"browser",
21+
"jest"
22+
]

.husky/pre-commit

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ git add -f dist/esprima.js
1616
git add -f dist/index.js
1717
git add -f dist/module.js
1818

19+
git add README.md
1920
git add CHANGELOG.md
2021
git add package-lock.json

README.md

Lines changed: 30 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
1111
[![Chat](https://img.shields.io/badge/chat-discussions-success.svg)](https://github.com/AlexRogalskiy/github-action-json-fields/discussions)
1212

13-
[![DeepScan grade](https://deepscan.io/api/teams/11946/projects/16314/branches/347248/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=11946&pid=16314&bid=347248)
13+
[![DeepSource](https://deepsource.io/gh/AlexRogalskiy/github-action-json-fields.svg/?label=active+issues\&show_trend=true)](https://deepsource.io/gh/AlexRogalskiy/github-action-json-fields/?ref=repository-badge)
14+
[![DeepScan grade](https://deepscan.io/api/teams/11946/projects/16314/branches/347248/badge/grade.svg)](https://deepscan.io/dashboard#view=project\&tid=11946\&pid=16314\&bid=347248)
1415
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/AlexRogalskiy/github-action-json-fields)
1516
![GitHub Release Date](https://img.shields.io/github/release-date/AlexRogalskiy/github-action-json-fields)
1617
![Lines of code](https://tokei.rs/b1/github/AlexRogalskiy/github-action-json-fields?category=lines)
@@ -26,6 +27,8 @@
2627
[![Dependabot](https://img.shields.io/badge/dependabot-enabled-1f8ceb.svg?style=flat-square)](https://dependabot.com/)
2728
[![NewReleases](https://newreleases.io/badge.svg)](https://newreleases.io/github/AlexRogalskiy/github-action-json-fields)
2829
[![Hits-of-Code](https://hitsofcode.com/github/alexrogalskiy/github-action-json-fields?branch=master)](https://hitsofcode.com/github/alexrogalskiy/github-action-json-fields?branch=master/view?branch=master)
30+
[![dependencies Status](https://status.david-dm.org/gh/AlexRogalskiy/github-action-json-fields.svg)](https://david-dm.org/AlexRogalskiy/github-action-json-fields)
31+
[![dependencies Status](https://status.david-dm.org/gh/AlexRogalskiy/github-action-json-fields.svg)](https://david-dm.org/AlexRogalskiy/github-action-json-fields?type=dev)
2932

3033
[![codecov](https://codecov.io/gh/AlexRogalskiy/github-action-json-fields/branch/master/graph/badge.svg?token=MuiGSj3HFi)](https://codecov.io/gh/AlexRogalskiy/github-action-json-fields)
3134
[![CI](https://github.com/AlexRogalskiy/github-action-json-fields/workflows/CI/badge.svg)](https://github.com/AlexRogalskiy/github-action-json-fields/actions/workflows/build.yml)
@@ -42,36 +45,26 @@
4245

4346
## *Table of contents*
4447

45-
<!--ts-->
46-
* [<em>Json fields</em>](#json-fields)
47-
* [<em>Table of contents</em>](#table-of-contents)
48-
* [<em>Description</em>](#description)
49-
* [<em>Inputs</em>](#inputs)
50-
* [sourceData](#sourcedata)
51-
* [Complete parameters](#complete-parameters)
52-
* [Basic parameters](#basic-parameters)
53-
* [mode](#mode)
54-
* [unique](#unique)
55-
* [duplicate](#duplicate)
56-
* [jsonPath](#jsonpath)
57-
* [jsonFields](#jsonfields)
58-
* [sourceFile](#sourcefile)
59-
* [targetPath](#targetpath)
60-
* [targetFile](#targetfile)
61-
* [<em>Outputs</em>](#outputs)
62-
* [changed](#changed)
63-
* [true](#true)
64-
* [false](#false)
65-
* [<em>Examples</em>](#examples)
66-
* [<em>Visitor stats</em>](#visitor-stats)
67-
* [<em>Licensing</em>](#licensing)
68-
* [<em>Authors</em>](#authors)
69-
* [<em>Versioning</em>](#versioning)
70-
* [<em>Contribution</em>](#contribution)
71-
* [<em>Acknowledgement</em>](#acknowledgement)
72-
* [<em>Forks</em>](#forks)
73-
* [<em>Development Support</em>](#development-support)
74-
<!--te-->
48+
- [*Description*](#description)
49+
- [*Inputs*](#inputs)
50+
- [`sourceData`](#sourcedata)
51+
- [`mode`](#mode)
52+
- [`jsonPath`](#jsonpath)
53+
- [`jsonFields`](#jsonfields)
54+
- [`sourceFile`](#sourcefile)
55+
- [`targetPath`](#targetpath)
56+
- [`targetFile`](#targetfile)
57+
- [*Outputs*](#outputs)
58+
- [`changed`](#changed)
59+
- [*Examples*](#examples)
60+
- [*Visitor stats*](#visitor-stats)
61+
- [*Licensing*](#licensing)
62+
- [*Authors*](#authors)
63+
- [*Versioning*](#versioning)
64+
- [*Contribution*](#contribution)
65+
- [*Acknowledgement*](#acknowledgement)
66+
- [*Forks*](#forks)
67+
- [*Development Support*](#development-support)
7568

7669
## *Description*
7770

@@ -218,7 +211,7 @@ Running locally:
218211

219212
## *Visitor stats*
220213

221-
[![GitHub page hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAlexRogalskiy%2Fgithub-action-json-fields&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true)](https://hits.seeyoufarm.com)
214+
[![GitHub page hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FAlexRogalskiy%2Fgithub-action-json-fields\&count_bg=%2379C83D\&title_bg=%23555555\&icon=\&icon_color=%23E7E7E7\&title=hits\&edge_flat=true)](https://hits.seeyoufarm.com)
222215

223216
![GitHub stars](https://img.shields.io/github/stars/AlexRogalskiy/github-action-json-fields?style=social)
224217
![GitHub forks](https://img.shields.io/github/forks/AlexRogalskiy/github-action-json-fields?style=social)
@@ -247,7 +240,7 @@ this repository][tags].
247240

248241
## *Contribution*
249242

250-
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/github-action-json-fields?size=50&padding=5&bots=true)](https://badges.pufler.dev)
243+
[![Contributors Display](https://badges.pufler.dev/contributors/AlexRogalskiy/github-action-json-fields?size=50\&padding=5\&bots=true)](https://badges.pufler.dev)
251244

252245
Please read
253246
[CONTRIBUTING.md](https://github.com/AlexRogalskiy/github-action-json-fields/blob/master/.github/CONTRIBUTING.md)
@@ -274,15 +267,15 @@ See also the list of [contributors][contributors] who participated in this proje
274267

275268
Like ***Json Fields*** ? Consider buying me a coffee :)
276269

277-
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square&logo=patreon&color=e64413)](https://www.patreon.com/alexrogalskiy)
270+
[![Become a Patron](https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?style=flat-square\&logo=patreon\&color=e64413)](https://www.patreon.com/alexrogalskiy)
278271
[![Buy Me A Coffee](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=buy%20me%20a%20coffee)](https://www.buymeacoffee.com/AlexRogalskiy)
279272
[![KoFi](https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi)](https://ko-fi.com/alexrogalskiy)
280273

281274
***
282275

283-
[![forthebadge](https://img.shields.io/badge/made%20with-%20typescript-C1282D.svg?logo=typescript&style=for-the-badge)](https://www.typescriptlang.org/)
284-
[![forthebadge](https://img.shields.io/badge/powered%20by-%20github-7116FB.svg?logo=github&style=for-the-badge)](https://github.com/)
285-
[![forthebadge](https://img.shields.io/badge/build%20with-%20%E2%9D%A4-B6FF9B.svg?logo=heart&style=for-the-badge)](https://forthebadge.com/)
276+
[![forthebadge](https://img.shields.io/badge/made%20with-%20typescript-C1282D.svg?logo=typescript\&style=for-the-badge)](https://www.typescriptlang.org/)
277+
[![forthebadge](https://img.shields.io/badge/powered%20by-%20github-7116FB.svg?logo=github\&style=for-the-badge)](https://github.com/)
278+
[![forthebadge](https://img.shields.io/badge/build%20with-%20%E2%9D%A4-B6FF9B.svg?logo=heart\&style=for-the-badge)](https://forthebadge.com/)
286279

287280
[repo]: https://github.com/AlexRogalskiy/github-action-json-fields
288281

package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"test:watch": "env-cmd --silent -e test jest --watch",
4242
"test:license": "license-checker --production --summary --unknown --onlyAllow=\"Apache-2.0;BSD;ISC;MIT;UNLICENSED;\"",
4343
"lint:all": "npm run lint:clean && npm run lint && npm run lint:md && npm run lint:json",
44-
"format:all": "npm run format",
44+
"format:all": "npm run format && npm run format:md",
4545
"check:all": "npm run format:check",
4646
"test:all": "npm run test && npm run test:folio && npm run test:license",
4747
"all": "npm run format:all && npm run lint:all && npm run pretty && npm run build"
@@ -174,5 +174,8 @@
174174
"commitizen": {
175175
"path": "./node_modules/cz-conventional-changelog"
176176
}
177-
}
177+
},
178+
"files": [
179+
"dist/**"
180+
]
178181
}

0 commit comments

Comments
 (0)