Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Configure options of jsonschema docs, formatting output #2270

Merged
merged 3 commits into from
Jan 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions .automation/build_schemas_doc.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,13 @@
# Generate HTML documentation from JSON schemas, using json-schema-for-humans :)

generate-schema-doc ../megalinter/descriptors/schemas/megalinter-descriptor.jsonschema.json \
../docs/json-schemas/descriptor.html
../docs/json-schemas/descriptor.html \
--config minify=false \
--config expand_buttons=false \
--config link_to_reused_ref=false

generate-schema-doc ../megalinter/descriptors/schemas/megalinter-configuration.jsonschema.json \
../docs/json-schemas/configuration.html
../docs/json-schemas/configuration.html \
--config minify=false \
--config expand_buttons=false \
--config link_to_reused_ref=false
3 changes: 2 additions & 1 deletion .github/linters/.cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,7 @@
"dupl",
"dustilock",
"dzhu",
"echoix",
"ecrc",
"editorconfig",
"ehlo",
Expand Down Expand Up @@ -1361,4 +1362,4 @@
"\u0636clojure",
"\u077bcbad"
]
}
}
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l
- Change name of config file for powershell formatter to avoid collision with powershell linter config
- Enhance find SARIF json in stdout output

- Documentation
- Configure jsonschema documentation formatting (see [Descriptor schema](https://megalinter.io/latest/json-schemas/descriptor.html), [Configuration schema](https://megalinter.io/latest/json-schemas/configuration.html)), by @echoix in [#2270](https://github.com/oxsecurity/megalinter/pull/2270)

- Linter versions upgrades
- [prettier](https://prettier.io/) from 2.8.1 to **2.8.2** on 2023-01-07
- [dotnet-format](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-format) from 000 to **6.0.404** on 2023-01-07
Expand Down
121,026 changes: 119,417 additions & 1,609 deletions docs/json-schemas/configuration.html

Large diffs are not rendered by default.

Loading