fix(app-vite&app-webpack): improve pnpm monorepo support for capacitor (#18218)

* feat(app-vite): improve pnpm monorepo support for capacitor

* feat(app-webpack): improve pnpm monorepo support for capacitor

* refactor(app-vite): utilize jsdoc types in more places

* refactor(app-webpack): utilize jsdoc types in more places

* chore: add electron-winstaller to pnpm onlyBuiltDependencies list

* refactor(app-vite): further clarify pnpm support regarding workspaces

* refactor(app-webpack): further clarify pnpm support regarding workspaces

Author: yusufkandemir

app-vite/lib/cache/create-cache-proxy.js

@@ -1,3 +1,8 @@
+/**
+ * @param {import('../../types/configuration/context').InternalQuasarContext} ctx
+ *
+ * @returns {import('../../types/configuration/context').CacheProxy}
+ */
 export function createCacheProxy (ctx) {
   const runtimeCache = {}
   const moduleCache = {}

app-vite/lib/modes/bex/bex-installation.js

@@ -3,6 +3,12 @@ import fse from 'fs-extra'
 import { log, warn } from '../../utils/logger.js'
 import { isModeInstalled } from '../modes-utils.js'
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ *   silent: boolean
+ * }} options
+ */
 export async function addMode ({
   ctx: { appPaths, cacheProxy },
   silent
@@ -26,6 +32,11 @@ export async function addMode ({
   log('Browser Extension support was added')
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ * }} options
+ */
 export function removeMode ({
   ctx: { appPaths }
 }) {

app-vite/lib/modes/capacitor/capacitor-installation.js

@@ -9,6 +9,13 @@ import { spawnSync } from '../../utils/spawn.js'
 import { ensureDeps, ensureConsistency } from './ensure-consistency.js'
 import { isModeInstalled } from '../modes-utils.js'
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ *   silent: boolean,
+ *   target: 'android' | 'ios' | undefined
+ * }} options
+ */
 export async function addMode ({
   ctx: { appPaths, cacheProxy, pkg: { appPkg } },
   silent,
@@ -60,6 +67,10 @@ export async function addMode ({
   globSync([ '**/*' ], {
     cwd: appPaths.resolve.cli('templates/capacitor')
   }).forEach(filePath => {
+    if (filePath.endsWith('pnpm-workspace.yaml') && nodePackager.name !== 'pnpm') {
+      return
+    }
+
     const dest = appPaths.resolve.capacitor(filePath)
     const content = fse.readFileSync(appPaths.resolve.cli('templates/capacitor/' + filePath))
     fse.ensureFileSync(dest)
@@ -94,6 +105,11 @@ export async function addMode ({
   await addPlatform(target, appPaths, cacheProxy)
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ * }} options
+ */
 export function removeMode ({
   ctx: { appPaths }
 }) {

app-vite/lib/modes/capacitor/ensure-consistency.js

@@ -21,6 +21,9 @@ export async function ensureDeps ({ appPaths, cacheProxy }) {
   nodePackager.install({
     cwd: appPaths.capacitorDir,
     // See https://github.com/orgs/pnpm/discussions/4735
+    // We also started creating an empty pnpm-workspace.yaml file in src-capacitor as of app-vite v2.4.1
+    // which addresses all cases without requiring explicit ignore-workspace flag all the time.
+    // However, we are keeping this for backward compatibility of the scaffolded projects and just in case.
     params: nodePackager.name === 'pnpm' ? [ 'i', '--ignore-workspace' ] : undefined,
     displayName: 'Capacitor'
   })

app-vite/lib/modes/cordova/cordova-installation.js

@@ -6,6 +6,13 @@ import { spawnSync } from '../../utils/spawn.js'
 import { ensureWWW, ensureConsistency } from './ensure-consistency.js'
 import { isModeInstalled } from '../modes-utils.js'
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ *   silent: boolean,
+ *   target: 'android' | 'ios' | undefined
+ * }} options
+ */
 export async function addMode ({
   ctx: { appPaths, pkg: { appPkg } },
   silent,
@@ -76,6 +83,11 @@ export async function addMode ({
   addPlatform(appPaths, target)
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ * }} options
+ */
 export function removeMode ({
   ctx: { appPaths }
 }) {

app-vite/lib/modes/electron/electron-installation.js

@@ -7,6 +7,12 @@ const electronDeps = {
   electron: 'latest'
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ *   silent: boolean
+ * }} options
+ */
 export async function addMode ({
   ctx: { appPaths, cacheProxy },
   silent
@@ -41,6 +47,11 @@ export async function addMode ({
   log('Electron support was added')
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ * }} options
+ */
 export async function removeMode ({
   ctx: { appPaths, cacheProxy }
 }) {

app-vite/lib/modes/pwa/pwa-installation.js

@@ -19,6 +19,12 @@ const pwaDeps = {
   'register-service-worker': '^1.7.2'
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ *   silent: boolean
+ * }} options
+ */
 export async function addMode ({
   ctx: { appPaths, cacheProxy },
   silent
@@ -63,6 +69,11 @@ export async function addMode ({
   log('PWA support was added')
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ * }} options
+ */
 export async function removeMode ({
   ctx: { appPaths, cacheProxy }
 }) {

app-vite/lib/modes/ssr/ssr-installation.js

@@ -3,6 +3,12 @@ import fse from 'fs-extra'
 import { log, warn } from '../../utils/logger.js'
 import { isModeInstalled } from '../modes-utils.js'
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ *   silent: boolean
+ * }} options
+ */
 export async function addMode ({
   ctx: { appPaths, cacheProxy },
   silent
@@ -25,6 +31,11 @@ export async function addMode ({
   log('SSR support was added')
 }
 
+/**
+ * @param {{
+ *   ctx: import('../../../types/configuration/context').InternalQuasarContext,
+ * }} options
+ */
 export function removeMode ({
   ctx: { appPaths }
 }) {

app-vite/lib/utils/get-ctx.js

@@ -13,7 +13,7 @@ function defineHiddenProp (target, propName, value) {
 }
 
 /**
- * @returns {import('../../types/configuration/context').QuasarContext}
+ * @returns {import('../../types/configuration/context').InternalQuasarContext}
  */
 export function getCtx (opts = {}) {
   const ctx = {

app-vite/lib/utils/get-pkg.js

@@ -4,6 +4,11 @@ import { parseJSON } from 'confbox'
 import { warning } from './logger.js'
 import { getPackageJson } from '../utils/get-package-json.js'
 
+/**
+ * @param {import('../../types/app-paths').QuasarAppPaths} appPaths
+ *
+ * @returns {import('../../types/configuration/context').InternalQuasarContext['pkg']}
+ */
 export function getPkg (appPaths) {
   const { appDir, cliDir } = appPaths
   const appPkgPath = appPaths.resolve.app('package.json')