Correct spelling of containername argument.

Spell the new mega-linter-runner argument container-name for consistency with the package name, mega-linter-runner, and to spare users from needing to add containername as a CSpell exception.
oxsecurity · Sep 22, 2022 · 3a9c9ef · 3a9c9ef
1 parent c7f7595
commit 3a9c9ef
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 7 deletions.
diff --git a/.github/linters/.cspell.json b/.github/linters/.cspell.json
@@ -481,7 +481,6 @@
         "conda",
         "configfile",
         "configfiles",
-        "containername",
         "contextlib",
         "contextmanager",
         "copypaste",

diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -5,7 +5,7 @@
   require_serial: true
   args:
     - mega-linter-runner
-    - --containername "megalinter-$(basename "$PWD")"
+    - --container-name "megalinter-$(basename "$PWD")"
     - --remove-container
     - --fix
     - --env
@@ -35,7 +35,7 @@
   require_serial: true
   args:
     - mega-linter-runner
-    - --containername "megalinter-all-$(basename "$PWD")"
+    - --container-name "megalinter-all-$(basename "$PWD")"
     - --remove-container
     - --fix
     - --env

diff --git a/mega-linter-runner/README.md b/mega-linter-runner/README.md
@@ -105,7 +105,7 @@ The options are only related to mega-linter-runner. For MegaLinter options, plea
 | `-h` <br/> `--help`    | Show mega-linter-runner help                                                                                       | <!-- -->          |
 | `-v` <br/> `--version` | Show mega-linter-runner version                                                                                    | <!-- -->          |
 | `-i` <br/> `--install` | Generate MegaLinter configuration files                                                                            | <!-- -->          |
-| `--containername`      | Specify MegaLinter container name                                                                                  | <!-- -->          |
+| `--container-name`     | Specify MegaLinter container name                                                                                  | <!-- -->          |
 | `--remove-container`   | Remove MegaLinter Docker container when done                                                                       | <!-- -->          |
 
 _You can also use `npx mega-linter-runner` if you do not want to install the package_

diff --git a/mega-linter-runner/lib/options.js b/mega-linter-runner/lib/options.js
@@ -122,7 +122,7 @@ module.exports = optionator({
       description: "Upgrade local repository MegaLinter configuration",
     },
     {
-      option: "containername",
+      option: "container-name",
       type: "String",
       description: "Specify MegaLinter container name",
     },

diff --git a/mega-linter-runner/lib/runner.js b/mega-linter-runner/lib/runner.js
@@ -124,8 +124,8 @@ ERROR: Docker engine has not been found on your system.
     if (options["remove-container"]) {
       commandArgs.push("--rm");
     }
-    if (options.containername) {
-      commandArgs.push(...["--name", options.containername]);
+    if (options["container-name"]) {
+      commandArgs.push(...["--name", options["container-name"]]);
     }
     commandArgs.push(...["-v", "/var/run/docker.sock:/var/run/docker.sock:rw"]);
     commandArgs.push(...["-v", `${lintPath}:/tmp/lint:rw`]);