Fileparser2

[barisccolak]

#18 rule defined, #20 rule defined,
#14 rule formatting completed,
#22 rule class is defined,
#17 documentation is started.
Ruff check and Black check completed.

[gitguardian]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	Secret	Commit	Filename
-	OpenSSH Private Key	3b46c30	testmodule/��	View secret
-	OpenSSH Private Key	55a4717	testmodule/��	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

<sup>🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!</sup>

[CagtayFabry]

General changes:

• add type hints for all function arguments and return values. You already list the argument types in the function docstrings which is great! In the latest Python versions it is usually recommended to define them as type hints which should be enough, you can remove them from the docstrings.
• remove the example files in the files directory but keep a select few (maybe 5 files) that you think are interesting

[CagtayFabry]

if you have implemented that user can pass a folder as argument, why not use that command instead of the complex bash syntax?

[CagtayFabry]

Installation should list how to install the python package, e.g. pip install .

[CagtayFabry]

The user guide section should answer the following question:

1. How to I check the rules for a single .JBI file?
2. How do I check the rules for all files in a folder?