ALX test Suite. Shell Utility that checks for some of ALX Software Engineering Project Requirements
Project description
alxcheck
ALX test Suite. Shell Utility that checks for ALX Project Requirements
Dependencies
Features
alxcheck
checks for the following:
General
README.md
file present.README.md
file is not empty.- All files in the current folder and sub-folders end with a new line.
C
- runs
betty
check.
Note: You would have to make sure betty is installed. Check out How To Install Betty
Python
- Python file is executable.
- shebang is present and at the top of the file (
#!/usr/bin/python3
or#!/usr/bin/env python3
) - Module documentation (docstrings)
- Function documentation (docstrings)
- Class documentation (docstrings)
JavaScript
- Javascript file is executable
- shebang is present and at the top of the file (
#!/usr/bin/node
or#!/usr/bin/env node
) semistandard
check
Note: you would have to install semistandard
npm install semistandard -g
var
is not used.
Installation
pip install alxcheck
or
python3 -m pip install alxcheck
Usage
After installation, to use this package, just run it as a shell command
alxcheck
This starts the checks with the current working directory as the root of the project.
Contributing
Feel free to contribute to the project by opening issues or submitting pull requests. Your feedback is valuable!
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.