Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix encoding error while reading from UTF-8 file + add .gitignore + run linter #3

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
202 changes: 202 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
# folders
scripts/*

# test files
test_file_*

# extentions
*.csv
*.txt

# IDE
.vscode/*

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# LaTeX auxiliary files
*.aux
*.bak
*.bbl
*-blx.bib
*.blg
*.lof
*.log
*.lot
*.out
*.run.xml
*.synctex.gz
*.tdo
*.toc
*~txs0
*.bib
*.bcf
*.glo
*.alg
*.acn
*.acr
*.glg
*.gls
*.ist
*.nlo


# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
34 changes: 34 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: check-added-large-files
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-json
- id: check-yaml
- id: debug-statements

- repo: https://github.com/pre-commit/pre-commit
rev: v3.8.0
hooks:
- id: validate_manifest

- repo: https://github.com/psf/black
rev: 24.8.0
hooks:
- id: black

- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
args: ["--profile", "black", "--filter-files"]

- repo: https://github.com/gitleaks/gitleaks
rev: v8.19.3
hooks:
- id: gitleaks
48 changes: 40 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,44 @@
# LaTeX Paper Linter

This script checks for common mistakes in LaTeX source files of scientific papers.
This script checks for common mistakes in LaTeX source files of scientific papers.

## Usage
## Installation

python3 paperlint.py <file.tex/path> [-i/x <include/exclude switch>] [--error]
Install directly from this repository:

Provide either a single .tex file to check or a path to recursively check all .tex files in that directory!
```bash
pip install paperlinter@git+https://github.com/misc0110/Paper-Linter
```

## Usage: CLI

```
paperlinter <file.tex/path> [-i/x <include/exclude switch>] [--error]
```

<details>

<summary>Usage: Script Mode</summary>

* Clone repository:
```bash
git clone https://github.com/misc0110/Paper-Linter
```
* Navigate to the `Paper-Linter/scr` and run:
```
python -m paperlint <file.tex/path> [-i/x <include/exclude switch>] [--error]
```

</details>

## Usage: Explanation

Provide either a single .tex file to check or a path to recursively check all `.tex` files in that directory!
By default, all rules are used for checking the document.
The switches can be configured with the `-x` and `-i` parameters to exclude and include entire categories of rules or single rules.
The include/exclude switches are evaluated in the order they are specified.
For example, `-i typography` only activates the typography rules, whereas `-i all -x typography -i cite-space` enables all rules without the typography rules, but enables the `cite-space` rule from the typography category.
The switches can be configured with the `-x` and `-i` parameters to exclude and include entire categories of rules or single rules.
The include/exclude switches are evaluated in the order they are specified.

For example, `-i typography` only activates the typography rules, whereas `-i all -x typography -i cite-space` enables all rules without the typography rules, but enables the `cite-space` rule from the typography category.

If `--error` is provided, the tool exits with error code 1 if there are warnings.

Expand Down Expand Up @@ -211,7 +239,7 @@ This category includes warning of things that are discouraged or wrong for the s
* **Description**: Warns if multiple `\cite` commands are used instead of having multiple citation keys inside one `\cite`
* **Switch**: `multiple-cites`

#### Sentence starting with a Conjunction
#### Sentence starting with a Conjunction
* **Description**: Warns if a sentence starts with a conjunction ("And", "But", "Or")
* **Switch**: `conjunction-start`

Expand Down Expand Up @@ -262,3 +290,7 @@ This category includes warnings for everything related to (cross-)references (sw
#### Duplicate Keys in Citations
* **Description**: Warns if a `cite` command has duplicate entries
* **Switch**: `cite-duplicate`

## License

This project is licensed under the MIT License. See the LICENSE file for details.
5 changes: 5 additions & 0 deletions paperlinter/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
"""Top-level package."""

__license__ = "MIT"

from .paperlint import main, run_linter_once
8 changes: 8 additions & 0 deletions paperlinter/__main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
"""Top-level package."""

__license__ = "MIT"

from .paperlint import main

if __name__ == "__main__":
main()
Loading