modified #264
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--- | |
name: spell and grammer check | |
on: | |
push: | |
branches: | |
- "**" | |
pull_request: | |
paths: | |
- '.github/checking.txt' | |
types: [opened, edited, updated] | |
env: | |
SPELL_CHECK_DISABLED: false | |
GRAMMAR_CHECK_DISABLED: false | |
jobs: | |
check-spelling-and-grammar: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python 3.8 | |
uses: actions/setup-python@v2 | |
with: | |
python-version: 3.8 | |
# Install the dependencies for grammer check and spell check. | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip setuptools | |
python -m pip install pyspelling | |
sudo apt-get install hunspell hunspell-en-us aspell aspell-en | |
pip install --user --upgrade language_tool_python | |
- uses: actions/checkout@v2 | |
- name: Spellcheck | |
if: ${{ env.SPELL_CHECK_DISABLED == 'false' }} | |
uses: rojopolis/[email protected] | |
with: | |
config_path: .github/.spellcheck.yaml | |
source_files: ".github/checking.txt" # name of the file to check spell | |
task_name: Markdown | |
# To check the grammatical mistakes of the given files and folders. | |
- name: Run grammar check | |
if: ${{ env.GRAMMAR_CHECK_DISABLED == 'false' }} | |
run: | | |
python - <<EOF | |
import language_tool_python | |
import os | |
def identify_grammar_errors(text): | |
tool = language_tool_python.LanguageTool('en-US') | |
matches = tool.check(text) | |
return matches | |
def print_errors(matches, filename): | |
if not matches: | |
print(f"No grammar errors found in {filename}.") | |
else: | |
for match in matches: | |
if hasattr(match, 'fromy') and hasattr(match, 'toy'): | |
line_range = f"Lines {match.fromy}-{match.toy}" | |
else: | |
line_range = "Unknown lines" | |
print(f"Error in {filename} at line {match.from_line}, column {match.from_col}: {match.message}") | |
file_path = '.github/checking.txt' | |
# Check grammar for the content of the specified file | |
with open(file_path, 'r', encoding='utf-8') as file: | |
document = file.read() | |
errors = identify_grammar_errors(document) | |
print_errors(errors, file_path) | |
EOF | |
# # Initialize LanguageTool | |
# tool = language_tool_python.LanguageTool('en-US') # You can specify the language you want to check. | |
# # Specify the directory path | |
# directory_path = 'docs' | |
# # Read the text from your file | |
# file_path = '.github/checking.txt' # Update the path accordingly | |
# with open(file_path, 'r', encoding='utf-8') as file: | |
# text = file.read() | |
# # Check for grammar errors | |
# matches = tool.check(text) | |
# # Print grammar errors with line numbers | |
# if matches: | |
# for match in matches: | |
# if hasattr(match, 'fromy') and hasattr(match, 'toy'): | |
# line_range = f"Lines {match.fromy}-{match.toy}" | |
# else: | |
# line_range = "Unknown lines" | |
# print(f"Grammar error at {line_range} - {match.message}") | |
# # Exit with a non-zero code to indicate failure | |
# exit(1) | |
# else: | |
# # No grammar errors found, print a success message | |
# print("No grammar errors found.") | |
# exit(0) | |
# EOF |