Issue 27 -- Command runner prefixes and deduce install command from build backend (#28)

* Deduce install command for PDM

* Command prefix support for PDM and POE.

* Build

* Remove no longer applicable comment

* Build

Author: BrandonLWhite

README.md

@@ -37,6 +37,7 @@ These are the fields for `project` objects in the output:
 - **pythonVersion**: Value of `[project.requires-python]` or `[tool.poetry.dependencies.python]` from `pyproject.toml`
 
 - **installCommand**: The shell command to run to create and install dependencies into the virtual environment.
+                      This can either be specified explicitly in `[tool.tasks.install]` or deduced from the `[build-system.build-backend]`
 
 - **testCommand**: The shell command to run to execute the tests for the project.
 

__snapshots__/find-python-projects.test.js.snap

@@ -18,6 +18,8 @@ exports[`find-python-projects finds projects 1`] = `
     "test-fixtures/multi-project/project-1/pyproject.toml",
     "test-fixtures/multi-project/project-2/pyproject.toml",
     "test-fixtures/multi-project/project-4/pyproject.toml",
+    "test-fixtures/multi-project/project-5/pyproject.toml",
+    "test-fixtures/multi-project/project-6/pyproject.toml",
   ],
   "projects": [
     {
@@ -42,12 +44,33 @@ exports[`find-python-projects finds projects 1`] = `
     },
     {
       "directory": "test-fixtures/multi-project/project-4",
+      "installCommand": null,
       "name": "sub-project-4",
       "packageCommand": null,
       "path": "test-fixtures/multi-project/project-4/pyproject.toml",
       "pythonVersion": "^3.9",
       "testCommand": null,
     },
+    {
+      "buildBackend": "pdm.backend",
+      "directory": "test-fixtures/multi-project/project-5",
+      "installCommand": "pdm install",
+      "name": "project-5",
+      "packageCommand": null,
+      "path": "test-fixtures/multi-project/project-5/pyproject.toml",
+      "pythonVersion": "==3.12.*",
+      "testCommand": "pdm run test",
+    },
+    {
+      "buildBackend": "poetry.core.masonry.api",
+      "directory": "test-fixtures/multi-project/project-6",
+      "installCommand": "poetry install",
+      "name": "sub-project-1",
+      "packageCommand": null,
+      "path": "test-fixtures/multi-project/project-6/pyproject.toml",
+      "pythonVersion": "^3.9",
+      "testCommand": "poe run test",
+    },
   ],
   "testable-projects": [
     {
@@ -60,6 +83,26 @@ exports[`find-python-projects finds projects 1`] = `
       "pythonVersion": "^3.9",
       "testCommand": "poetry run pytest",
     },
+    {
+      "buildBackend": "pdm.backend",
+      "directory": "test-fixtures/multi-project/project-5",
+      "installCommand": "pdm install",
+      "name": "project-5",
+      "packageCommand": null,
+      "path": "test-fixtures/multi-project/project-5/pyproject.toml",
+      "pythonVersion": "==3.12.*",
+      "testCommand": "pdm run test",
+    },
+    {
+      "buildBackend": "poetry.core.masonry.api",
+      "directory": "test-fixtures/multi-project/project-6",
+      "installCommand": "poetry install",
+      "name": "sub-project-1",
+      "packageCommand": null,
+      "path": "test-fixtures/multi-project/project-6/pyproject.toml",
+      "pythonVersion": "^3.9",
+      "testCommand": "poe run test",
+    },
   ],
 }
 `;

dist/index.js

@@ -50,19 +50,10 @@ async function findPythonProjects(rootDir) {
         const pythonVersion = get_best_config(projectTomlParsed, PYTHON_VERSION_PATHS);
 
         const buildBackend = projectTomlParsed?.['build-system']?.['build-backend'];
-        const usePoetry = (buildBackend || '').startsWith('poetry');
+        const installCommand = determine_install_command(projectTomlParsed, buildBackend)
 
-        // TODO: Figure out the best way to deal with this.  The issue is that some tools, like Poetry, need a separate
-        // `poetry install` before subsequent `poetry run ...` operations can take place.
-        // Best bet is to experiment with PDM to see how it behaves (eg does it automatically do an install when
-        // necessary as part of executing a task/script)
-        const installCommand = buildBackend && (usePoetry ? 'poetry install' : 'pip install');
-
-        // TODO : Need to make this more adaptive in how it resolves the final shell command.  For instance,
-        // if it is a POE command, the returned shell command should be `poe run test`.  Similarly for other
-        // task runners, including PDM (I think).
-        const testCommand = get_best_config(projectTomlParsed, TEST_COMMAND_PATHS);
-        const packageCommand = get_best_config(projectTomlParsed, PACKAGE_COMMAND_PATHS);
+        const testCommand = get_best_command(projectTomlParsed, TEST_COMMAND_PATHS);
+        const packageCommand = get_best_command(projectTomlParsed, PACKAGE_COMMAND_PATHS);
 
         projects.push({
             name: projectName,
@@ -92,6 +83,45 @@ function get_best_config(configRoot, knownPaths, defaultValue = null) {
     return defaultValue;
 }
 
+function get_best_command(configRoot, knownPaths) {
+    for (const knownPath of knownPaths) {
+        const commandPath = knownPath.tomlPath
+        const value = _get(configRoot, commandPath)
+        if (value) {
+            const runnerPrefix = knownPath?.context?.runnerPrefix
+            if(runnerPrefix) {
+                const commandPathParts = commandPath.split('.')
+                const commandName = commandPathParts[commandPathParts.length - 1]
+                return [runnerPrefix, commandName].join(' ')
+            }
+            else
+                return value
+        }
+    }
+    return null;
+}
+
+function determine_install_command(projectTomlParsed, buildBackend) {
+    // First check explicit task command
+    const explicitInstallCommand = get_best_config(projectTomlParsed, [
+        'tool.tasks.install'
+    ])
+    if (explicitInstallCommand) return explicitInstallCommand
+
+    // Otherwise deduce from the build backend.
+
+    if (!buildBackend) return null
+
+    const buildBackendPackage = buildBackend.split('.')[0]
+
+    return INSTALL_COMMANDS_BY_BUILD_BACKEND_PACKAGE[buildBackendPackage] ?? null
+}
+
+const INSTALL_COMMANDS_BY_BUILD_BACKEND_PACKAGE = {
+    poetry: 'poetry install',
+    pdm: 'pdm install'
+}
+
 const PROJECT_NAME_PATHS = [
     'project.name', // PEP-621
     'tool.poetry.name'
@@ -102,14 +132,17 @@ const PYTHON_VERSION_PATHS = [
     'tool.poetry.dependencies.python'
 ];
 
+const POE_RUN_PREFIX = 'poe run'
+const PDM_RUN_PREFIX = 'pdm run'
+
 const TEST_COMMAND_PATHS = [
-    'tool.tasks.test',
-    'tool.pdm.scripts.test',
-    'tool.poe.tasks.test'
+    {tomlPath: 'tool.tasks.test'},
+    {tomlPath: 'tool.pdm.scripts.test', context: {runnerPrefix: PDM_RUN_PREFIX}},
+    {tomlPath: 'tool.poe.tasks.test', context: {runnerPrefix: POE_RUN_PREFIX}}
 ];
 
 const PACKAGE_COMMAND_PATHS = [
-    'tool.tasks.package',
-    'tool.pdm.scripts.package',
-    'tool.poe.tasks.package'
+    {tomlPath: 'tool.tasks.package'},
+    {tomlPath: 'tool.pdm.scripts.package', context: {runnerPrefix: PDM_RUN_PREFIX}},
+    {tomlPath: 'tool.poe.tasks.package',  context: {runnerPrefix: POE_RUN_PREFIX}}
 ];

dist/index.js.map

@@ -0,0 +1,26 @@
+[project]
+name = "project-5"
+version = "0.1.0"
+description = "Default template for PDM package"
+authors = [
+    {name = "BrandonLWhite", email = "brandonlwhite@gmail.com"},
+]
+dependencies = []
+requires-python = "==3.12.*"
+readme = "README.md"
+license = {text = "MIT"}
+
+[build-system]
+requires = ["pdm-backend"]
+build-backend = "pdm.backend"
+
+[tool.pdm]
+distribution = false
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "pytest>=8.0.0",
+]
+
+[tool.pdm.scripts]
+test = "pytest"

find-python-projects.js

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "sub-project-1"
+version = "0.1.0"
+description = ""
+authors = ["Your Name <you@example.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poe.tasks]
+test = "pytest -vv"