Move the utils functions to separate packages

.gitignore

@@ -11,11 +11,9 @@ temp-*
 *.tsbuildinfo
 
 # Build directories
-./dist/
-!./dist/setup_cpp.js
-!./dist/setup_cpp.js.map
+packages/*/dist/
 .parcel-cache
 exe/
 *.log
 *.exe
-.cache/
+.cache/

cspell.config.yaml

@@ -14,13 +14,12 @@ words:
   - applellvm
   - bazel
   - bazelisk
-  - copr
-  - vbatts
   - buildtools
   - caxa
   - ccache
   - choco
   - cmake
+  - copr
   - CPATH
   - Cppcheck
   - CPPFLAGS
@@ -38,6 +37,7 @@ words:
   - ghes
   - Graphviz
   - isci
+  - isroot
   - kcov
   - LDFLAGS
   - lefticus
@@ -68,6 +68,7 @@ words:
   - tsbuildinfo
   - ucrt
   - untildify
+  - vbatts
   - vcpkg
   - vcvarsall
   - visualc

dev/readme/template.md

@@ -0,0 +1,61 @@
+<h1 align="center"><%= projectName %></h1>
+<p>
+<% if (isProjectOnNpm) { -%>
+  <a href="https://www.npmjs.com/package/<%= projectName %>" target="_blank">
+    <img alt="Version" src="https://img.shields.io/npm/v/<%= projectName %>.svg">
+  </a>
+<% } -%>
+<% if (projectVersion && !isProjectOnNpm) { -%>
+  <img alt="Version" src="https://img.shields.io/badge/version-<%= projectVersion %>-blue.svg?cacheSeconds=2592000" />
+<% } -%>
+<% if (projectPrerequisites) { -%>
+<% projectPrerequisites.map(({ name, value }) => { -%>
+  <img src="https://img.shields.io/badge/<%= name %>-<%= encodeURIComponent(value) %>-blue.svg" />
+<% }) -%>
+<% } -%>
+<% if (projectDocumentationUrl) { -%>
+  <a href="<%= projectDocumentationUrl %>" target="_blank">
+    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
+  </a>
+<% } -%>
+<% if (isGithubRepos) { -%>
+  <a href="<%= repositoryUrl %>/graphs/commit-activity" target="_blank">
+    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
+  </a>
+<% } -%>
+<% if (licenseName) { -%>
+  <a href="<%= licenseUrl ? licenseUrl : '#' %>" target="_blank">
+    <img alt="License: <%= licenseName %>" src="https://img.shields.io/<%= isGithubRepos ? `github/license/${authorGithubUsername}/${projectName}` : `badge/License-${licenseName}-yellow.svg` %>" />
+  </a>
+<% } -%>
+<% if (authorTwitterUsername) { -%>
+  <a href="https://twitter.com/<%= authorTwitterUsername %>" target="_blank">
+    <img alt="Twitter: <%= authorTwitterUsername %>" src="https://img.shields.io/twitter/follow/<%= authorTwitterUsername %>.svg?style=social" />
+  </a>
+<% } -%>
+</p>
+<% if (projectDescription) { -%>
+
+> <%= projectDescription %>
+> <% } -%>
+
+## Install
+
+```sh
+npm install --save <%= projectName %>
+```
+
+## Usage
+
+<!-- INSERT GENERATED DOCS START -->
+
+<!-- INSERT GENERATED DOCS END -->
+
+## 🤝 Contributing
+
+You can sponsor my work here:
+
+https://github.com/sponsors/aminya
+
+Pull requests, issues and feature requests are welcome.
+See the [Contributing guide](https://github.com/aminya/setup-cpp/blob/master/CONTRIBUTING.md).

package.json

@@ -27,14 +27,15 @@
     "clean": "shx rm -rf .parcel-cache dist exe",
     "copy.matchers": "shx cp ./src/gcc/gcc_matcher.json ./dist/ && shx cp ./src/msvc/msvc_matcher.json ./dist && shx cp ./src/python/python_matcher.json ./dist/ && shx cp ./src/llvm/llvm_matcher.json ./dist/ ",
     "dev": "cross-env NODE_ENV=development parcel watch",
+    "docs": "shx rm -rf packages/*/README.md && pnpm -r exec readme --path ../../dev/readme/template.md -y && pnpm -r exec ts-readme",
     "format": "run-s lint.prettier",
     "lint": "run-p --aggregate-output --continue-on-error lint.cspell lint.eslint lint.prettier lint.tsc",
     "lint.cspell": "cspell lint --no-progress --show-suggestions",
     "lint.eslint": "eslint **/*.{ts,tsx,js,jsx,cjs,mjs,json,yaml} --no-error-on-unmatched-pattern --cache --cache-location ./.cache/eslint/ --fix",
     "lint.prettier": "prettier --write .",
     "lint.tsc": "tsc --noEmit | loose-ts-check",
     "pack.exe": "shx rm -rf ./dist/tsconfig.tsbuildinfo && node ./dev/scripts/pack-exe.js",
-    "prepare": "npm run build",
+    "prepare": "pnpm run -r build && pnpm run -w build",
     "start.docker": "docker run -t setup_cpp .",
     "start.docker.arch": "docker run -t setup_cpp:arch .",
     "start.docker.fedora": "docker run -t setup_cpp:fedora .",
@@ -54,16 +55,22 @@
     "@actions/exec": "^1.1.1",
     "@actions/io": "^1.1.2",
     "@actions/tool-cache": "^2.0.1",
-    "escape-path-with-spaces": "^1.0.0",
+    "@npmcli/ci-detect": "github:aminya/ci-detect#37fe40075bebec96794ba0a7c4a6d5c70cbea00d",
+    "escape-path-with-spaces": "github:aminya/escape-path-with-spaces#d9f81ee649203ddc55783a2f96ada59df06118e3",
+    "exec-powershell": "workspace:*",
     "execa": "^5.1.1",
+    "extension-tools": "workspace:*",
+    "get-works": "workspace:*",
     "mri": "^1.2.0",
     "msvc-dev-cmd": "github:aminya/msvc-dev-cmd#9f672c1",
     "numerous": "1.0.3",
+    "root-tools": "workspace:*",
     "semver": "7.3.7",
     "setup-python": "github:actions/setup-python#c474c82340438924daab9282d07300bfe7e3692d",
     "time-delta": "github:aminya/time-delta#69d91a41cef28e569be9a2991129f5f7d1f0d00e",
     "ubuntu-version": "^2.0.0",
-    "untildify": "^4.0.0",
+    "untildify-user": "workspace:*",
+    "user-access": "workspace:*",
     "which": "^2.0.2"
   },
   "devDependencies": {
@@ -79,16 +86,19 @@
     "cspell": "^6.5.0",
     "eslint": "^8.21.0",
     "eslint-config-atomic": "^1.18.1",
+    "gen-readme": "^1.6.0",
     "jest": "^28.1.3",
     "loose-ts-check": "^1.2.0",
     "npm-check-updates": "^16.0.5",
     "npm-run-all2": "^6.0.1",
     "parcel": "2.6.2",
     "prettier": "2.7.1",
     "prettier-config-atomic": "^3.0.10",
+    "readme-md-generator": "^1.0.0",
     "shx": "0.3.4",
     "terser-config-atomic": "^0.1.1",
     "ts-jest": "^28.0.7",
+    "ts-readme": "^1.1.3",
     "typescript": "^4.7.4"
   },
   "engines": {
@@ -113,6 +123,9 @@
     "ninja",
     "meson"
   ],
+  "alias": {
+    "electron": false
+  },
   "pnpm": {
     "overrides": {
       "semver": "7.3.7",

packages/exec-powershell/README.md

@@ -0,0 +1,60 @@
+<h1 align="center">exec-powershell</h1>
+<p>
+  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
+  <a href="#" target="_blank">
+    <img alt="License: Apache--2.0" src="https://img.shields.io/badge/License-Apache--2.0-yellow.svg" />
+  </a>
+</p>
+
+> Run a powershell command.
+
+## Install
+
+```sh
+npm install --save exec-powershell
+```
+
+## Usage
+
+<!-- INSERT GENERATED DOCS START -->
+
+### `execPowershell` (function)
+
+Asynchronously execute a powershell command.
+
+**Parameters:**
+
+- command (`string`) - The powershell command to execute
+- startupFlags (`string[]`) - The optional startup flags to be passed to powershell. Defaults to `["-NoProfile", "-NoLogo", "-NonInteractive"]`. This means that the Powershell profile is not sourced first.
+- execOptions (`execa.Options`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
+
+**returns:** execa.ExecaChildProcess<string>
+
+### `execPowershellSync` (function)
+
+Execute a powershell command.
+
+**Parameters:**
+
+- command (`string`) - The powershell command to execute
+- startupFlags (`string[]`) - The optional startup flags to be passed to powershell. Defaults to `["-NoProfile", "-NoLogo", "-NonInteractive"]`. This means that the Powershell profile is not sourced first.
+- execOptions (`execa.SyncOptions`) - The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
+
+**returns:** execa.ExecaSyncReturnValue<string>
+
+### `getPowerShell` (function)
+
+Get the path to the powershell executable.
+
+**returns:** string
+
+<!-- INSERT GENERATED DOCS END -->
+
+## 🤝 Contributing
+
+You can sponsor my work here:
+
+https://github.com/sponsors/aminya
+
+Pull requests, issues and feature requests are welcome.
+See the [Contributing guide](https://github.com/aminya/setup-cpp/blob/master/CONTRIBUTING.md).

packages/exec-powershell/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "exec-powershell",
+  "version": "1.0.0",
+  "description": "Run a powershell command.",
+  "homepage": "https://github.com/aminya/setup-cpp",
+  "license": "Apache-2.0",
+  "author": "Amin Yahyaabadi",
+  "main": "./dist/index.js",
+  "source": "./src/index.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "execa": "^5.1.1",
+    "which": "^2.0.2"
+  },
+  "devDependencies": {
+    "@types/which": "^2.0.1"
+  },
+  "keywords": [
+    "powershell",
+    "pwsh",
+    "exec",
+    "execa",
+    "spawn",
+    "system",
+    "github-actions",
+    "github",
+    "actions",
+    "gitlab",
+    "ci"
+  ]
+}

packages/exec-powershell/src/index.ts

@@ -0,0 +1,64 @@
+import execa from "execa"
+import which from "which"
+
+/** The cached powershell path */
+let powershell: string | undefined
+
+/**
+ * Asynchronously execute a powershell command.
+ *
+ * @param command The powershell command to execute
+ * @param startupFlags The optional startup flags to be passed to powershell. Defaults to `["-NoProfile", "-NoLogo",
+ *   "-NonInteractive"]`. This means that the Powershell profile is not sourced first.
+ * @param execOptions The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
+ * @returns A promise to the execution result
+ * @note It prefers `pwsh` over `powershell`
+ */
+export function execPowershell(
+  command: string,
+  startupFlags: string[] = ["-NoProfile", "-NoLogo", "-NonInteractive"],
+  execOptions: execa.Options = { stdio: "inherit" }
+): execa.ExecaChildProcess<string> {
+  return execa(getPowerShell(), [...startupFlags, "-c", command], execOptions)
+}
+
+/**
+ * Execute a powershell command.
+ *
+ * @param command The powershell command to execute
+ * @param startupFlags The optional startup flags to be passed to powershell. Defaults to `["-NoProfile", "-NoLogo",
+ *   "-NonInteractive"]`. This means that the Powershell profile is not sourced first.
+ * @param execOptions The options passed to `execa`. Defaults to `{ stdio: "inherit" }`
+ * @returns The execution result
+ * @note It prefers `pwsh` over `powershell`
+ */
+export function execPowershellSync(
+  command: string,
+  startupFlags: string[] = ["-NoProfile", "-NoLogo", "-NonInteractive"],
+  execOptions: execa.SyncOptions = { stdio: "inherit" }
+): execa.ExecaSyncReturnValue<string> {
+  return execa.sync(getPowerShell(), [...startupFlags, "-c", command], execOptions)
+}
+
+/**
+ * Get the path to the powershell executable.
+ *
+ * @note It prefers `pwsh` over `powershell`
+ * @note It caches the path for the subsequent calls to this function
+ */
+export function getPowerShell() {
+  if (powershell === undefined) {
+    const maybePwsh = which.sync("pwsh", { nothrow: true })
+    if (maybePwsh !== null) {
+      powershell = maybePwsh
+    }
+    const maybePowerShell = which.sync("powershell", { nothrow: true })
+    if (maybePowerShell !== null) {
+      powershell = maybePowerShell
+    }
+  }
+  if (powershell === undefined) {
+    throw new Error("Could not find powershell")
+  }
+  return powershell
+}

packages/exec-powershell/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["./src"]
+}