emmo00 / alxcheck

ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects

Hi 👋, I'm Emmanuel Nwafor

Learning Python, PHP and Javascript/Typescript for Backend development and very passionate about the interesting world of computer programming

• 🔭 SWE graduate at ALX Africa • C11

• 💬 Ask me about Javascript, C, Python, PHP

• 📫 How to reach me [email protected]

- ⚡ Let's Go!!!

Connect with me:

alxcheck's Issues

Implement help option

Implement the help option. When -h or --help is passed as a command line argument, it should print out the help text/docs.

Check for new line

for some reason alxcheck does not correctly check for the presence of of a trailing new line in a file

betty check isn't working as expected on C files

I have some C file in the folder, and I ran the alxcheck on them, but no error message show, but after running betty at my end here, it displayed a lot of errors.

Find in the attachment below the description of the issue:

JavaScript shebang and executable tests should be for only node.js/executable JavaScript files

Only node.js/executable JavaScript files need a shebang. Scripts that would be loaded by HTML do not typically have one, nor are they executable as that could actually lead to issues.

alxcheck needs to find a way to detect this, or perhaps display these messages as warnings (orange/amber) as opposed to errors (red) and a notice to the user to only fix those if they are node.js executable scripts.

Implement fix option

When --fix is passed as a command-line, alxcheck should attempt to fix the errors

GitHub Actions

Setup GitHub actions to run tests on push.

and probably to publish package on release too

Ignore __init__.py file if it is empty

Python requires modules to have a __init__.py file, even if the file is left empty. alxcheck needs to skip checking this file if it is empty.

Description clarity

Interesting tool you have built :). But basically, it's only for the alx-system-engineering-DevOps
section If you can add this to the description it will be more clear to understand what the tool is exactly for 🙌.

Improve detection of python virtual environment folder

The logic for detecting Python virtual environment folders needs to be improved. Your implementation assumes that the folder would simply be named either venv or env, but that is not always the case. Python places no restrictions on the folder name, so most documentations/guides on the internet suggest using a custom name, which means that a Python virtual environment folder can actually be named anything at all, e.g. alxcheck_venv or _python_bin. I name mine .venv for instance, so that it stays at the top of the list in a directory listing, with the added advantage of being hidden and ignored by most apps in UNIX.

However, regardless of what the folder is named, it always has a ./pyvenv.cfg file in it (see attached screenshot), so perhaps have your script look for that file instead, or a similar artefact that applies to all virtual environment folders.

Source: official documentation