mirror of
https://github.com/podman-desktop/podman-desktop
synced 2026-05-24 10:18:53 +00:00
chore: added Vale configuration to validate style guide consistency (#1107)
This commit is contained in:
parent
5cd54dba82
commit
505f8527fc
6 changed files with 62 additions and 0 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -5,3 +5,4 @@ dist
|
|||
*.cdix
|
||||
.parcel-cache
|
||||
.idea
|
||||
.vale/styles/RedHat
|
||||
|
|
|
|||
24
.vale.ini
Normal file
24
.vale.ini
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
; .vale.ini
|
||||
; Vale configuration file. See https://vale.sh
|
||||
;
|
||||
; Copyright (C) 2023 Red Hat, Inc.
|
||||
;
|
||||
; Licensed under the Apache License, Version 2.0 (the "License");
|
||||
; you may not use this file except in compliance with the License.
|
||||
; You may obtain a copy of the License at
|
||||
; http://www.apache.org/licenses/LICENSE-2.0
|
||||
;
|
||||
; Unless required by applicable law or agreed to in writing, software
|
||||
; distributed under the License is distributed on an "AS IS" BASIS,
|
||||
; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
; See the License for the specific language governing permissions and
|
||||
; limitations under the License.
|
||||
;
|
||||
; SPDX-License-Identifier: Apache-2.0
|
||||
;
|
||||
MinAlertLevel = suggestion
|
||||
Packages = RedHat
|
||||
StylesPath = .vale/styles
|
||||
|
||||
[*.md]
|
||||
BasedOnStyles = RedHat,PodmanDesktop
|
||||
23
.vale/fixtures/PodmanDesktop/ProductNames/.vale.ini
Normal file
23
.vale/fixtures/PodmanDesktop/ProductNames/.vale.ini
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
; .vale.ini
|
||||
; Vale configuration file. See https://vale.sh
|
||||
;
|
||||
; Copyright (C) 2023 Red Hat, Inc.
|
||||
;
|
||||
; Licensed under the Apache License, Version 2.0 (the "License");
|
||||
; you may not use this file except in compliance with the License.
|
||||
; You may obtain a copy of the License at
|
||||
; http://www.apache.org/licenses/LICENSE-2.0
|
||||
;
|
||||
; Unless required by applicable law or agreed to in writing, software
|
||||
; distributed under the License is distributed on an "AS IS" BASIS,
|
||||
; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
; See the License for the specific language governing permissions and
|
||||
; limitations under the License.
|
||||
;
|
||||
; SPDX-License-Identifier: Apache-2.0
|
||||
;
|
||||
MinAlertLevel = suggestion
|
||||
StylesPath = ../../../styles
|
||||
|
||||
[*.md]
|
||||
PodmanDesktop.ProductNames = YES
|
||||
2
.vale/fixtures/PodmanDesktop/ProductNames/testinvalid.md
Normal file
2
.vale/fixtures/PodmanDesktop/ProductNames/testinvalid.md
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
Podman desktop
|
||||
podman
|
||||
3
.vale/fixtures/PodmanDesktop/ProductNames/testvalid.md
Normal file
3
.vale/fixtures/PodmanDesktop/ProductNames/testvalid.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
Podman Desktop
|
||||
`podman`
|
||||
Podman
|
||||
9
.vale/styles/PodmanDesktop/ProductNames.yml
Normal file
9
.vale/styles/PodmanDesktop/ProductNames.yml
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
extends: substitution
|
||||
message: "Consider using: %s, rather than: %s"
|
||||
level: warning
|
||||
ignorecase: false
|
||||
# swap map tokens in the form of bad: good
|
||||
swap:
|
||||
Podman desktop: Podman Desktop
|
||||
podman: '`podman` or Podman'
|
||||
Loading…
Reference in a new issue