curl/.github/scripts/spellcheck.yaml

# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
#
# SPDX-License-Identifier: curl
#
# Docs: https://github.com/UnicornGlobal/spellcheck-github-actions
matrix:
  - name: Markdown
    expect_match: false
    apsell:
      mode: en
    dictionary:
      wordlists:
        - wordlist.txt
      output: wordlist.dic
      encoding: utf-8
    pipeline:
      - pyspelling.filters.markdown:
          markdown_extensions:
            - markdown.extensions.extra:
      - pyspelling.filters.html:
          comments: true
          attributes:
            - title
            - alt
          ignores:
            - ':matches(code, pre)'
            - 'code'
            - 'pre'
            - 'strong'
            - 'em'
    sources:
      - '**/*.md|!docs/BINDINGS.md|!docs/DISTROS.md'
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
GHA: spellcheck This spellchecker checks markdown files. For this reason this job converts all man pages in the repository to markdown with pandoc before the check runs. The perl script 'cleanspell' filters out details from the man page in the process, to avoid the spellchecker trying to spellcheck things it can't. Like curl specific symbols and the SYNOPSIS and EXAMPLE sections of libcurl man pages. The spell checker does not check words in sections that are within pre, strong and em tags. 'spellcheck.words' is a custom word list with additional accepted words. Closes #9523 2022-09-21 05:30:02 +08:00			`#`
			`# SPDX-License-Identifier: curl`
			`#`
			`# Docs: https://github.com/UnicornGlobal/spellcheck-github-actions`
			`matrix:`
tidy-up: fix yamllint whitespace issues Closes #12466 2023-12-06 18:05:20 +08:00			`- name: Markdown`
			`expect_match: false`
			`apsell:`
			`mode: en`
			`dictionary:`
			`wordlists:`
			`- wordlist.txt`
			`output: wordlist.dic`
			`encoding: utf-8`
			`pipeline:`
			`- pyspelling.filters.markdown:`
			`markdown_extensions:`
			`- markdown.extensions.extra:`
			`- pyspelling.filters.html:`
			`comments: true`
			`attributes:`
			`- title`
			`- alt`
			`ignores:`
			`- ':matches(code, pre)'`
			`- 'code'`
			`- 'pre'`
			`- 'strong'`
			`- 'em'`
			`sources:`
DISTROS: add document with distro pointers Lots of organizations distribute curl packages to end users. This is a collection of pointers to where to learn more about curl on and with each distro. Assisted-by: Alan Coopersmith Assisted-by: Andrew Kaster Assisted-by: Andy Fiddaman Assisted-by: Arjan van de Ven Assisted-by: Brian Clemens Assisted-by: chrysos349 on github Assisted-by: Dan Fandrich Assisted-by: Dan McDonald Assisted-by: Gaelan Steele Assisted-by: graywolf on github Assisted-by: Jan Macku Assisted-by: John Marshall Assisted-by: Jonathan Perkin Assisted-by: Kevin Daudt Assisted-by: Marcus Müller Assisted-by: Michał Górny Assisted-by: Outvi V Assisted-by: Ross Burton Assisted-by: Sean Molenaar Assisted-by: Till Wegmüller Assisted-by: Viktor Szakats Assisted-by: Winni Neessen Closes #13178 2024-03-23 21:43:35 +08:00			`- '*/.md\|!docs/BINDINGS.md\|!docs/DISTROS.md'`