From e7cf875bc0e2289299943664f2352eadf2d8777f Mon Sep 17 00:00:00 2001 From: Emmanuel Nwafor Date: Sat, 18 Nov 2023 20:56:03 +0100 Subject: [PATCH] chore: little fixes --- README.md | 8 +++++--- alxcheck/utils/helpers.py | 4 ++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6bf5408..7e14361 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,9 @@ ALX test Suite. Shell Utility that checks for ALX Project Requirements ### JavaScript - Javascript file is executable - > Note: enabled with `-js` or `--nodejs-project` commandline switch. See [Usage](#usage) below + > 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` commandline switch. See [Usage](#usage) below + > 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. @@ -62,12 +62,14 @@ After installation, to use this package, just run it as a shell command. This st alxcheck ``` -If the project is a JavaScript project with node.js scripts, a commandline switch can be used to enable the first two checks [listed above](#javascript). +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 ``` diff --git a/alxcheck/utils/helpers.py b/alxcheck/utils/helpers.py index 81e1bc0..0ae68fc 100644 --- a/alxcheck/utils/helpers.py +++ b/alxcheck/utils/helpers.py @@ -7,8 +7,8 @@ def is_python_virtual_env_folder(folder_path): def is_nodejs_project(): - """Checks for node.js commandline switches""" - switches = ('-js', '--nodejs-checks') + """Checks for node.js command line switches""" + switches = ("-js", "--nodejs-checks") for switch in switches: if switch in sys.argv: return True