Skip to content

Commit 3dd5518

Browse files
apskhemstevenj
andauthored
fix: remove local spellcheck targets (#123)
Co-authored-by: Steven Johnson <stevenj@users.noreply.github.com>
1 parent 71ee076 commit 3dd5518

File tree

4 files changed

+2
-65
lines changed

4 files changed

+2
-65
lines changed

.github/workflows/spell-check.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

Earthfile

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ markdown-check-fix:
1414

1515
DO ./earthly/mdlint+MDLINT_LOCALLY --src=$(echo ${PWD}) --fix=--fix
1616

17-
# spell-check Check spelling in this repo locally.
18-
spell-check:
19-
LOCALLY
20-
21-
DO ./earthly/cspell+CSPELL_LOCALLY --src=$(echo ${PWD})
22-
2317
# check-spelling Check spelling in this repo inside a container.
2418
check-spelling:
2519
DO ./earthly/cspell+CHECK

docs/src/guides/spellcheck.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,11 @@ In an Earthfile in your repo, add the following:
1919

2020
```earthfile
2121
check-spelling:
22-
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:<tag>+check-spelling
22+
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:<tag>+CHECK
2323
```
2424

2525
Executing `earthly +check-spelling` will automatically run the spell checking to all files in the repository.
2626

27-
### Run locally
28-
29-
```earthfile
30-
spellcheck-lint:
31-
# Check spelling in this repo.
32-
LOCALLY
33-
34-
DO github.com/input-output-hk/catalyst-ci/earthly/cspell:t1.2.0+CSPELL_LOCALLY --src=$(echo ${PWD})
35-
```
36-
37-
In this use case, the UDC is run Locally, so that the src in the repo can be directly checked.
38-
3927
## Configuration
4028

4129
Each repo will need a [`cspell.json`](https://cspell.org/configuration/) file in the root of the repo.

earthly/cspell/Earthfile

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
11
# cspell UDCs and Containers.
22
VERSION 0.7
33

4-
CSPELL_LOCALLY:
5-
# DO NOT RUN THIS UDC INSIDE CONTAINER BUILDS.
6-
# IT IS NOT FOR CONTAINER BUILDS.
7-
# See: https://github.com/earthly/earthly/issues/580
8-
9-
# Spell checking all docs and code is done with cspell
10-
# See: cspell.org
11-
COMMAND
12-
13-
# Where we want to run the `lint` from.
14-
ARG --required src
15-
16-
# Unlikely to need to change this.
17-
ARG cfg_file=cspell.json
18-
19-
RUN echo Spell Checking Recursively from: $src
20-
21-
RUN docker run \
22-
--rm \
23-
-v $src:/workdir \
24-
ghcr.io/streetsidesoftware/cspell:8.0.0 \
25-
lint . --dot
26-
274
CHECK:
285
# Spell checking all docs and code is done with cspell
296
# See: cspell.org
@@ -44,8 +21,6 @@ CHECK:
4421

4522
# A Test and example invocation of the above UDC.
4623
cspell-test:
47-
# As notes above, this check must only be run locally.
48-
LOCALLY
4924
# Run with `earthly -P +cspell-test`
50-
DO +CSPELL_LOCALLY --src=$(echo ${PWD}/../../)
25+
DO +CHECK --src=$(echo ${PWD}/../../)
5126

0 commit comments

Comments
 (0)