openpreserve / carrus

1 stars 4 forks source link

Naming of scriptArguments and scriptType properties #25

Closed bitsgalore closed 2 years ago

bitsgalore commented 3 years ago

Looking at config.json I see this for jpylyzer:

{
    "OS": "darwin",
    "scriptPath": "jpylyzer/jpylyzer/jpylyzer.py",
    "scriptType": "/usr/local/bin/python3",
    "scriptArguments": [
        "-m",
        "jpylyzer.jpylyzer"
    ],
    "workingDirectory": "jpylyzer"
}  

Here the script is jpylyzer.py, defined by "scriptPath" value jpylyzer/jpylyzer/jpylyzer.py. However, the "scriptArguments" property defines arguments of the interpreter (python), not the script (jpylyzer.py). Also, "scriptType" actually defines the path to the Python interpreter.

So why not:

  1. rename "scriptType" to "interpreterPath" (note that currently "scriptType" already defines a path for the Python tools under darwin).
  2. rename "scriptArguments" to "interpreterArguments".

This would make it all a bit more consistent and self-descriptive.