Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emmo00/alxcheck
ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects
https://github.com/emmo00/alxcheck
alx alx-africa alxswe checker checks green-squares tests
Last synced: about 16 hours ago
JSON representation
ALX text suite. Shell Utility that checks files for ALX's Project Requirements. Including: General, C, JavaScript and Python projects
- Host: GitHub
- URL: https://github.com/emmo00/alxcheck
- Owner: Emmo00
- License: mit
- Created: 2023-11-14T19:28:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-29T12:14:15.000Z (12 months ago)
- Last Synced: 2025-01-08T20:45:15.484Z (4 days ago)
- Topics: alx, alx-africa, alxswe, checker, checks, green-squares, tests
- Language: Python
- Homepage: https://pypi.org/project/alxcheck/
- Size: 37.1 KB
- Stars: 19
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alxcheck
ALX test Suite. Shell Utility that checks for ALX Project Requirements
## Dependencies
- [`Python3`](https://www.python.org/downloads/)
- [`betty`](https://youtu.be/wDDKOOEPED0?ref=alxcheck)
- [`pycodestyle`](https://pycodestyle.pycqa.org/en/latest/)
- [`semistandard`](https://www.npmjs.com/package/semistandard)
## 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](https://youtu.be/wDDKOOEPED0?ref=alxcheck)
### 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)
- Parse and check for syntax error.
### JavaScript
- Javascript file is executable
> Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below
- *shebang* is present and at the top of the file (`#!/usr/bin/node` or `#!/usr/bin/env node`)
> Note: enabled with `-js` or `--nodejs-project` command line switch. See [Usage](#usage) below
- `semistandard` check
> Note: you would have to install semistandard `npm install semistandard -g`
- `var` is not used.
## Installation
```bash
pip install alxcheck
```
or
```bash
python3 -m pip install alxcheck
```
## Usage
After installation, to use this package, just run it as a shell command. This starts the checks with the current working directory as the root of the project.
```bash
alxcheck
```
If the project is a JavaScript project with node.js scripts, a command line switch can be used to enable the first two checks [listed above](#javascript).
```bash
alxcheck -js #shorthand version
```
or
```bash
alxcheck --nodejs-project #long version
```
## Contributing
Feel free to contribute to the project by opening [issues](https://github.com/Emmo00/alxcheck/issues) or submitting [pull requests](https://github.com/Emmo00/alxcheck/pulls). Your feedback is valuable!
## License
This project is licensed under the [MIT License](./LICENSE).