setup-php 2.13.0 → 2.17.0

package/src/configs/tools_schema.json

@@ -1,115 +1,126 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/shivammathur/setup-php/develop/src/configs/tools_schema.json",
-  "type": "object",
-  "title": "Tools",
-  "default": {},
-  "examples": [
-    {
-      "tool": {
-        "alias": "tool_alias",
-        "domain": "https://example.com",
-        "extension": ".ext",
-        "fetch_latest": "true",
-        "function": "function_name",
-        "repository": "user/tool",
-        "type": "phar, composer, custom-package or custom-function",
-        "version_parameter": "--version",
-        "version_prefix": "v"
-      }
-    }
-  ],
-  "items": {
-    "properties": {
-      "alias": {
-        "$id": "#/items/properties/alias",
-        "type": "string",
-        "title": "The alias schema",
-        "description": "Alias for a tool.",
-        "examples": [
-          "tool_alias"
-        ]
-      },
-      "domain": {
-        "$id": "#/items/properties/domain",
-        "type": "string",
-        "title": "The domain schema",
-        "description": "Domain URL of the tool.",
-        "examples": [
-          "https://example.com"
-        ]
-      },
-      "extension": {
-        "$id": "#/items/properties/extension",
-        "type": "string",
-        "title": "The extension schema",
-        "description": "File extension of the tool.",
-        "examples": [
-          ".ext"
-        ]
-      },
-      "fetch_latest": {
-        "$id": "#/items/properties/fetch_latest",
-        "type": "string",
-        "title": "The fetch_latest schema",
-        "description": "Fetch the latest version from GitHub releases.",
-        "enum": [
-          "true",
-          "false"
-        ]
-      },
-      "function": {
-        "$id": "#/items/properties/function",
-        "type": "string",
-        "title": "The function schema",
-        "description": "Function name in tools.ts which returns the script to setup the tool.",
-        "examples": [
-          "function_name"
-        ]
-      },
-      "repository": {
-        "$id": "#/items/properties/repository",
-        "type": "string",
-        "title": "The repository schema",
-        "description": "GitHub repository of the tool.",
-        "examples": [
-          "user/tool"
-        ]
-      },
-      "type": {
-        "$id": "#/items/properties/type",
-        "type": "string",
-        "title": "The type schema",
-        "description": "Type of tool: phar, composer, custom-package or custom-function.",
-        "enum": [
-          "phar",
-          "composer",
-          "custom-package",
-          "custom-function"
-        ]
-      },
-      "version_parameter": {
-        "$id": "#/items/properties/version_parameter",
-        "type": "string",
-        "title": "The version_parameter schema",
-        "description": "Parameter to get the tool version.",
-        "examples": [
-          "--version"
-        ]
-      },
-      "version_prefix": {
-        "$id": "#/items/properties/version_prefix",
-        "type": "string",
-        "title": "The version_prefix schema",
-        "description": "Prefix of the version in the download URL.",
-        "examples": [
-          "v"
-        ]
-      }
-    },
-    "required": [
-      "type"
-    ],
-    "additionalProperties": true
-  }
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/shivammathur/setup-php/develop/src/configs/tools_schema.json",
+  "type": "object",
+  "title": "Tools",
+  "default": {},
+  "examples": [
+    {
+      "tool": {
+        "alias": "tool_alias",
+        "domain": "https://example.com",
+        "extension": ".ext",
+        "fetch_latest": "true",
+        "function": "function_name",
+        "repository": "user/tool",
+        "scope": "global, scoped",
+        "type": "phar, composer, custom-package or custom-function",
+        "version_parameter": "--version",
+        "version_prefix": "v"
+      }
+    }
+  ],
+  "items": {
+    "properties": {
+      "alias": {
+        "$id": "#/items/properties/alias",
+        "type": "string",
+        "title": "The alias schema",
+        "description": "Alias for a tool.",
+        "examples": [
+          "tool_alias"
+        ]
+      },
+      "domain": {
+        "$id": "#/items/properties/domain",
+        "type": "string",
+        "title": "The domain schema",
+        "description": "Domain URL of the tool.",
+        "examples": [
+          "https://example.com"
+        ]
+      },
+      "extension": {
+        "$id": "#/items/properties/extension",
+        "type": "string",
+        "title": "The extension schema",
+        "description": "File extension of the tool.",
+        "examples": [
+          ".ext"
+        ]
+      },
+      "fetch_latest": {
+        "$id": "#/items/properties/fetch_latest",
+        "type": "string",
+        "title": "The fetch_latest schema",
+        "description": "Fetch the latest version from GitHub releases.",
+        "enum": [
+          "true",
+          "false"
+        ]
+      },
+      "function": {
+        "$id": "#/items/properties/function",
+        "type": "string",
+        "title": "The function schema",
+        "description": "Function name in tools.ts which returns the script to setup the tool.",
+        "examples": [
+          "function_name"
+        ]
+      },
+      "repository": {
+        "$id": "#/items/properties/repository",
+        "type": "string",
+        "title": "The repository schema",
+        "description": "GitHub repository of the tool.",
+        "examples": [
+          "user/tool"
+        ]
+      },
+      "scope": {
+        "$id": "#/items/properties/scope",
+        "type": "string",
+        "title": "The scope schema",
+        "description": "Scope of tool installation: global or scoped",
+        "enum": [
+          "global",
+          "scoped"
+        ]
+      },
+      "type": {
+        "$id": "#/items/properties/type",
+        "type": "string",
+        "title": "The type schema",
+        "description": "Type of tool: phar, composer, custom-package or custom-function.",
+        "enum": [
+          "phar",
+          "composer",
+          "custom-package",
+          "custom-function"
+        ]
+      },
+      "version_parameter": {
+        "$id": "#/items/properties/version_parameter",
+        "type": "string",
+        "title": "The version_parameter schema",
+        "description": "Parameter to get the tool version.",
+        "examples": [
+          "--version"
+        ]
+      },
+      "version_prefix": {
+        "$id": "#/items/properties/version_prefix",
+        "type": "string",
+        "title": "The version_prefix schema",
+        "description": "Prefix of the version in the download URL.",
+        "examples": [
+          "v"
+        ]
+      }
+    },
+    "required": [
+      "type"
+    ],
+    "additionalProperties": true
+  }
 }

package/src/coverage.ts

@@ -1,142 +1,144 @@
-import * as utils from './utils';
-import * as extensions from './extensions';
-import * as config from './config';
-
-/**
- * Function to setup Xdebug
- *
- * @param extension
- * @param version
- * @param os_version
- * @param pipe
- */
-export async function addCoverageXdebug(
-  extension: string,
-  version: string,
-  os_version: string,
-  pipe: string
-): Promise<string> {
-  let script = '\n';
-  script +=
-    (await extensions.addExtension(':pcov', version, os_version, true)) + pipe;
-  script +=
-    (await extensions.addExtension(extension, version, os_version, true)) +
-    pipe;
-  script += await utils.addLog(
-    '$tick',
-    extension,
-    'Xdebug enabled as coverage driver',
-    os_version
-  );
-  return script;
-}
-
-/**
- * Function to setup PCOV
- *
- * @param version
- * @param os_version
- * @param pipe
- */
-export async function addCoveragePCOV(
-  version: string,
-  os_version: string,
-  pipe: string
-): Promise<string> {
-  let script = '\n';
-  switch (true) {
-    default:
-      script +=
-        (await extensions.addExtension(':xdebug', version, os_version, true)) +
-        pipe;
-      script +=
-        (await extensions.addExtension('pcov', version, os_version, true)) +
-        pipe;
-      script +=
-        (await config.addINIValues('pcov.enabled=1', os_version, true)) + '\n';
-
-      // success
-      script += await utils.addLog(
-        '$tick',
-        'coverage: pcov',
-        'PCOV enabled as coverage driver',
-        os_version
-      );
-      // version is not supported
-      break;
-
-    case /5\.[3-6]|7\.0/.test(version):
-      script += await utils.addLog(
-        '$cross',
-        'pcov',
-        'PHP 7.1 or newer is required',
-        os_version
-      );
-      break;
-  }
-
-  return script;
-}
-
-/**
- * Function to disable Xdebug and PCOV
- *
- * @param version
- * @param os_version
- * @param pipe
- */
-export async function disableCoverage(
-  version: string,
-  os_version: string,
-  pipe: string
-): Promise<string> {
-  let script = '\n';
-  script +=
-    (await extensions.addExtension(':pcov', version, os_version, true)) + pipe;
-  script +=
-    (await extensions.addExtension(':xdebug', version, os_version, true)) +
-    pipe;
-  script += await utils.addLog(
-    '$tick',
-    'none',
-    'Disabled Xdebug and PCOV',
-    os_version
-  );
-
-  return script;
-}
-
-/**
- * Function to set coverage driver
- *
- * @param coverage_driver
- * @param version
- * @param os_version
- */
-export async function addCoverage(
-  coverage_driver: string,
-  version: string,
-  os_version: string
-): Promise<string> {
-  coverage_driver = coverage_driver.toLowerCase();
-  const script: string =
-    '\n' + (await utils.stepLog('Setup Coverage', os_version));
-  const pipe: string = (await utils.suppressOutput(os_version)) + '\n';
-  switch (coverage_driver) {
-    case 'pcov':
-      return script + (await addCoveragePCOV(version, os_version, pipe));
-    case 'xdebug':
-    case 'xdebug3':
-      return (
-        script + (await addCoverageXdebug('xdebug', version, os_version, pipe))
-      );
-    case 'xdebug2':
-      return (
-        script + (await addCoverageXdebug('xdebug2', version, os_version, pipe))
-      );
-    case 'none':
-      return script + (await disableCoverage(version, os_version, pipe));
-    default:
-      return '';
-  }
-}
+import * as utils from './utils';
+import * as extensions from './extensions';
+import * as config from './config';
+
+export async function checkXdebugError(
+  extension: string,
+  version: string
+): Promise<string> {
+  if (
+    (/^5\.[3-6]$|^7\.[0-1]$/.test(version) && extension == 'xdebug3') ||
+    (/^8\.[0-9]$/.test(version) && extension == 'xdebug2')
+  ) {
+    return extension + ' is not supported on PHP ' + version;
+  }
+  return '';
+}
+
+/**
+ * Function to setup Xdebug
+ *
+ * @param extension
+ * @param version
+ * @param os
+ * @param pipe
+ */
+export async function addCoverageXdebug(
+  extension: string,
+  version: string,
+  os: string,
+  pipe: string
+): Promise<string> {
+  let script = '\n';
+  let message: string = await checkXdebugError(extension, version);
+  let status = '$cross';
+  if (!message) {
+    script +=
+      (await extensions.addExtension(':pcov:false', version, os, true)) + pipe;
+    extension = extension == 'xdebug3' ? 'xdebug' : extension;
+    script +=
+      (await extensions.addExtension(extension, version, os, true)) + pipe;
+    message = 'Xdebug enabled as coverage driver';
+    status = '$tick';
+  }
+  script += await utils.addLog(status, extension, message, os);
+  return script;
+}
+
+/**
+ * Function to setup PCOV
+ *
+ * @param version
+ * @param os
+ * @param pipe
+ */
+export async function addCoveragePCOV(
+  version: string,
+  os: string,
+  pipe: string
+): Promise<string> {
+  let script = '\n';
+  switch (true) {
+    default:
+      script +=
+        (await extensions.addExtension(':xdebug:false', version, os, true)) +
+        pipe;
+      script +=
+        (await extensions.addExtension('pcov', version, os, true)) + pipe;
+      script += (await config.addINIValues('pcov.enabled=1', os, true)) + '\n';
+
+      // success
+      script += await utils.addLog(
+        '$tick',
+        'coverage: pcov',
+        'PCOV enabled as coverage driver',
+        os
+      );
+      // version is not supported
+      break;
+
+    case /5\.[3-6]|7\.0/.test(version):
+      script += await utils.addLog(
+        '$cross',
+        'pcov',
+        'PHP 7.1 or newer is required',
+        os
+      );
+      break;
+  }
+
+  return script;
+}
+
+/**
+ * Function to disable Xdebug and PCOV
+ *
+ * @param version
+ * @param os
+ * @param pipe
+ */
+export async function disableCoverage(
+  version: string,
+  os: string,
+  pipe: string
+): Promise<string> {
+  let script = '\n';
+  script +=
+    (await extensions.addExtension(':pcov:false', version, os, true)) + pipe;
+  script +=
+    (await extensions.addExtension(':xdebug:false', version, os, true)) + pipe;
+  script += await utils.addLog('$tick', 'none', 'Disabled Xdebug and PCOV', os);
+
+  return script;
+}
+
+/**
+ * Function to set coverage driver
+ *
+ * @param coverage_driver
+ * @param version
+ * @param os
+ */
+export async function addCoverage(
+  coverage_driver: string,
+  version: string,
+  os: string
+): Promise<string> {
+  coverage_driver = coverage_driver.toLowerCase();
+  const script: string = '\n' + (await utils.stepLog('Setup Coverage', os));
+  const pipe: string = (await utils.suppressOutput(os)) + '\n';
+  switch (coverage_driver) {
+    case 'pcov':
+      return script + (await addCoveragePCOV(version, os, pipe));
+    case 'xdebug':
+    case 'xdebug2':
+    case 'xdebug3':
+      return (
+        script + (await addCoverageXdebug(coverage_driver, version, os, pipe))
+      );
+    case 'none':
+      return script + (await disableCoverage(version, os, pipe));
+    default:
+      return '';
+  }
+}