[Feature]: augment code for adding to WORDLIST

[k-doering-NOAA]

Is your feature request related to a problem? Please describe.

I wasn't able to successfully use the code mentioned in the spelling github action to add to the wordlist. It currently reads:

# Following R code can be used to add words to the WORDLIST file:
wordlist_path <- file.path('inst', 'WORDLIST')
all_words <- c(word_list, spell_check_results$word)
sorted_words <- sort(unique(all_words))
writeLines(sorted_words, wordlist_path)

Describe the solution you would like.

I think 2 additions are needed to make this code straightforward to use, here is a mix of code and pseudo code:

# Following R code can be used to add words to the WORDLIST file:
wordlist_path <- file.path('inst', 'WORDLIST')
word_list <- readLines(wordlist_path)
# need code here to get spell_check_results$word - not sure the best way to do this
all_words <- c(word_list, spell_check_results$word)
sorted_words <- sort(unique(all_words))
writeLines(sorted_words, wordlist_path)

Describe alternatives you have considered

write a function in ghactions4r to add new words when they are discovered in spell_check_files().

Additional context

No response

[Bai-Li-NOAA]

Good catch, @k-doering-NOAA. I was assuming users would copy the code block into the console to generate word_list and spell_check_results before ignoring the words. I should probably include the full code snippet below in the instructions:

files <- list.files(
              ".",
              recursive = TRUE,
              full.names = TRUE,
              pattern = "\\.(cpp|hpp|md|qmd|R|Rmd|txt|yml)$",
              ignore.case = TRUE,
              all.files = TRUE
            )
word_list <- spelling::get_wordlist(".")
spell_check_results <- spelling::spell_check_files(
  files,
  ignore = word_list
)
wordlist_path <- file.path('inst', 'WORDLIST')
all_words <- c(word_list, spell_check_results$word)
sorted_words <- sort(unique(all_words))
writeLines(sorted_words, wordlist_path)

[k-doering-NOAA]

Ah, that makes sense! I think including the entire code block within the action console output would be helpful and for me would have gotten me to where I was hoping to go!