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

fixed spelling issue, refactor cspell make target #1207

Merged
merged 1 commit into from
Jan 2, 2025
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
2 changes: 1 addition & 1 deletion api/operator/v1beta1/vmextra_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1411,7 +1411,7 @@ type StatusMetadata struct {
// UpdateStatus defines a status for update rollout
//
UpdateStatus UpdateStatus `json:"updateStatus,omitempty"`
// Reason defines human readadble error reason
// Reason defines human readable error reason
//
Reason string `json:"reason,omitempty"`
// ObservedGeneration defines current generation picked by operator for the
Expand Down
32 changes: 16 additions & 16 deletions config/crd/overlay/crd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1025,7 +1025,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
replicas:
description: deprecated and will be removed at v0.52.0
Expand Down Expand Up @@ -5671,7 +5671,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
replicas:
description: ReplicaCount Total number of pods targeted by this VMAgent
Expand Down Expand Up @@ -9672,7 +9672,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -12111,7 +12111,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -14039,7 +14039,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
replicas:
description: Deprecated
Expand Down Expand Up @@ -15700,7 +15700,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -19887,7 +19887,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateFailCount:
description: Deprecated.
Expand Down Expand Up @@ -20958,7 +20958,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -22105,7 +22105,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -23313,7 +23313,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -23603,7 +23603,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -27636,7 +27636,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -28796,7 +28796,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -30573,7 +30573,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
replicas:
description: deprecated and will be removed at v0.52.0
Expand Down Expand Up @@ -31641,7 +31641,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down Expand Up @@ -32276,7 +32276,7 @@ spec:
format: int64
type: integer
reason:
description: Reason defines human readadble error reason
description: Reason defines human readable error reason
type: string
updateStatus:
description: UpdateStatus defines a status for update rollout
Expand Down
15 changes: 5 additions & 10 deletions cspell/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
FROM node:lts-alpine3.20

ENV PATH="/home/node/node_modules/.bin:$PATH"

WORKDIR /home/node

COPY package.json .
COPY package-lock.json .

RUN npm ci

WORKDIR /victoriametrics
WORKDIR /opt/node
COPY yarn.lock package.json .
RUN yarn install
WORKDIR /vm
ENTRYPOINT ["/opt/node/node_modules/.bin/cspell"]
24 changes: 14 additions & 10 deletions cspell/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,27 @@

# Builds cspell image.
cspell-install:
@ (docker inspect cspell > /dev/null) || (docker build cspell --tag cspell)
@docker build cspell -t cspell

# Checks for spelling errors.
cspell-check: cspell-install
@CMD="cspell --no-progress || true" $(MAKE) cspell-run-command
cspell-check: CMD="--no-progress -r /vm"
cspell-check: cspell-install cspell-run

# Runs spelling error check.
# A user facing alias to cspell-check command.
spellcheck: cspell-check

# Runs cspell container commands.
cspell-run-command:
@cp cspell/cspell.json cspell.json
cspell-run:
@-docker run \
--entrypoint /bin/sh \
--mount type=bind,src=".",dst=/victoriametrics \
--mount type=bind,src="$(PWD)",dst=/vm \
--rm \
--tty \
cspell -c "$(CMD)"
@rm cspell.json
cspell -c cspell/cspell.json "$(CMD)"

cspell-update-deps: cspell-install
@-docker run \
--mount type=bind,src="$(PWD)",dst=/vm \
--entrypoint=/bin/sh \
--workdir=/vm/cspell \
--rm \
cspell -c "yarn install && yarn upgrade && rm -rf ./node_modules"
26 changes: 13 additions & 13 deletions cspell/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{
"addWords": true,
"name": "custom-dict",
"path": "cspell/custom-dict.txt"
"path": "custom-dict.txt"
}
],
"dictionaries": [
Expand Down Expand Up @@ -50,18 +50,18 @@
"/vm[a-zA-Z0-9-_]+/i"
],
"import": [
"/home/node/node_modules/@cspell/dict-aws/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-companies/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-data-science/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-en_us/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-fullstack/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-golang/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-k8s/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-people-names/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-ru_ru/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-software-terms/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-uk-ua/cspell-ext.json",
"/home/node/node_modules/@cspell/dict-win32/cspell-ext.json"
"@cspell/dict-aws/cspell-ext.json",
"@cspell/dict-companies/cspell-ext.json",
"@cspell/dict-data-science/cspell-ext.json",
"@cspell/dict-en_us/cspell-ext.json",
"@cspell/dict-fullstack/cspell-ext.json",
"@cspell/dict-golang/cspell-ext.json",
"@cspell/dict-k8s/cspell-ext.json",
"@cspell/dict-people-names/cspell-ext.json",
"@cspell/dict-ru_ru/cspell-ext.json",
"@cspell/dict-software-terms/cspell-ext.json",
"@cspell/dict-uk-ua/cspell-ext.json",
"@cspell/dict-win32/cspell-ext.json"
],
"useGitignore": true
}
Loading
Loading