Skip to content

Commit

Permalink
docs: lint
Browse files Browse the repository at this point in the history
  • Loading branch information
lpm0073 committed Nov 19, 2023
1 parent 0acc840 commit 110123d
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,13 @@ Linters and formatters are tools used in programming to analyze and improve the
### Code Analysis

- [ESLint](https://eslint.org/): an open source project that helps you find and fix problems with your JavaScript and JSX code.
- [Flake8](https://flake8.pycqa.org/en/latest/): overlaps somewhat with Black, but it is highly configurable and also provides syntax checking, Naming style enforcement, code style enforcement including for example, ensuring that comments not only exist where they should but are complete and are consistently formatted and styled. Flake8 also analyzes code [Cyclomatic Complexity](https://en.wikipedia.org/wiki/
- [Flake8](https://flake8.pycqa.org/en/latest/): overlaps somewhat with Black, but it is highly configurable and also provides syntax checking, Naming style enforcement, code style enforcement including for example, ensuring that comments not only exist where they should but are complete and are consistently formatted and styled. Flake8 also analyzes code [Cyclomatic Complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity).
- [pylint](https://pypi.org/project/pylint/): a static code analyser for Python. It analyses your code without actually running it. It checks for errors, enforces a coding standard, looks for code smells, and can make suggestions about how the code could be refactored.
- [bandit](https://github.com/PyCQA/bandit): a tool designed to find common security issues in Python code.

### Pre-commit hooks

- [pre-commit Hooks](https://pre-commit.com/hooks.html): scripts that run automatically before each commit is made to a repository, checking your code for embedded passwords, errors, issues, and any of a multitude of configurable policies that you can optionally enforce. (See above.) They're part of the git hooks system, which allows you to trigger actions at certain points in git's execution. This project uses many Hooks. See [pre-commit-config.yaml](https://github.com/FullStackWithLawrence/aws-openai/blob/main/.pre-commit-config.yaml#L45).
Cyclomatic_complexity).
- [pre-commit Hooks](https://pre-commit.com/hooks.html): scripts that run automatically before each commit is made to a repository, checking your code for embedded passwords, errors, issues, and any of a multitude of configurable policies that you can optionally enforce. They're part of the git hooks system, which allows you to trigger actions at certain points in git's execution. This project uses many Hooks. See [pre-commit-config.yaml](https://github.com/FullStackWithLawrence/aws-openai/blob/main/.pre-commit-config.yaml#L45).
- [codespell](https://github.com/codespell-project/codespell): fixes common misspellings in text files. It's designed primarily for checking misspelled words in source code, but it can be used with other files as well.

## Support
Expand Down

0 comments on commit 110123d

Please sign in to comment.