| #!/bin/bash |
| # |
| # Copyright (c) 2023, The OpenThread Authors. |
| # All rights reserved. |
| # |
| # Redistribution and use in source and binary forms, with or without |
| # modification, are permitted provided that the following conditions are met: |
| # 1. Redistributions of source code must retain the above copyright |
| # notice, this list of conditions and the following disclaimer. |
| # 2. Redistributions in binary form must reproduce the above copyright |
| # notice, this list of conditions and the following disclaimer in the |
| # documentation and/or other materials provided with the distribution. |
| # 3. Neither the name of the copyright holder nor the |
| # names of its contributors may be used to endorse or promote products |
| # derived from this software without specific prior written permission. |
| # |
| # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| # POSSIBILITY OF SUCH DAMAGE. |
| # |
| |
| # |
| # The script to correct or check the code spell of OpenThread. |
| # |
| # Correct wrong spelling: |
| # script/code-spell |
| # |
| # Check only: |
| # |
| # script/code-spell check |
| |
| set -euxo pipefail |
| |
| OT_SPELL_CHECK_IGNORE_CONFIG_FILE='.code-spell-ignore' |
| readonly OT_SPELL_CHECK_IGNORE_CONFIG_FILE |
| |
| OT_SPELL_CHECK_DIRS=( |
| 'doc' |
| 'etc' |
| 'examples' |
| 'include' |
| 'script' |
| 'src' |
| 'tests' |
| 'tools' |
| ) |
| readonly OT_SPELL_CHECK_DIRS |
| |
| main() |
| { |
| if [ $# == 0 ]; then |
| codespell "${OT_SPELL_CHECK_DIRS[@]}" -w --ignore-words="${OT_SPELL_CHECK_IGNORE_CONFIG_FILE}" |
| elif [ "$1" == 'check' ]; then |
| codespell "${OT_SPELL_CHECK_DIRS[@]}" --ignore-words="${OT_SPELL_CHECK_IGNORE_CONFIG_FILE}" |
| else |
| echo >&2 "Unsupported option: $1. Supported: check" |
| # 128 for Invalid arguments |
| exit 128 |
| fi |
| } |
| |
| main "$@" |