Capacitor (#198)

* chore: update error message if non-Monaca project

* chore: change message for monaca init

* feat: skip checking config.xml when creating capacitor project

* MN-4689: Support Commands for Capacitor Projects (#200)

* MN-4689: display message for not-supported commands

* MN-4689: show/hide command info on project-level

* filter command by task name instead of task set

* support yarn (#201)

* update Changelog

* pinn monaca-lib

doc/tasks/remote.json

@@ -4,6 +4,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": false,
       "react-native": true
     },
     "description": "build a project on Monaca Cloud",
@@ -82,6 +83,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": false,
       "react-native": true
     },
     "description": "open the project configuration on Monaca Cloud",

doc/tasks/serve.json

@@ -4,6 +4,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": true,
       "react-native": false
     },
     "description": "run a local web server for preview (execute `npm run monaca:preview` defined in package.json)",

doc/tasks/signing.json

@@ -4,6 +4,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": false,
       "react-native": true
     },
     "description": "manage signing configurations",

doc/tasks/sync.json

@@ -42,6 +42,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": true,
       "react-native": false
     },
     "description": "upload a project to Monaca Cloud",
@@ -84,6 +85,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": true,
       "react-native": false
     },
     "description": "download a project from Monaca Cloud",
@@ -121,6 +123,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": true,
       "react-native": false
     },
     "description": "run app on device using Monaca Debugger (execute `npm run monaca:debug` defined in package.json)",

doc/tasks/transpile.json

@@ -4,6 +4,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": true,
       "react-native": false
     },
     "description": "transpile project source code (execute `npm run monaca:transpile` defined in package.json)",

doc/tasks/upgrade.json

@@ -4,6 +4,7 @@
     "category": "project",
     "frameworkSupport": {
       "cordova": true,
+      "capacitor": false,
       "react-native": false
     },
     "description": "update old projects to Monaca CLI 3.x structure",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "monaca",
-  "version": "4.2.11",
+  "version": "5.0.0",
   "description": "Monaca Command Line Tool",
   "bin": {
     "monaca": "bin/monaca"
@@ -36,7 +36,7 @@
     "ip": "^1.1.5",
     "minimist": "^1.2.8",
     "monaca-inquirer": "^1.0.4",
-    "monaca-lib": "^4.1.10",
+    "monaca-lib": "^5.0.0",
     "opn": "^5.3.0",
     "portfinder": "^1.0.7",
     "q": "^1.1.2",

src/capacitor.js

@@ -0,0 +1,36 @@
+(function() {
+  'use strict';
+  let Capacitor = {};
+
+  /**
+   * Not-supported command names.
+   */
+  Capacitor.notSupportedTask = [
+    'remote config',
+    'remote build',
+    'signing',
+    'init',
+    'upgrade',
+    'update',
+    'debug',
+    'plugin',
+    'platform',
+    'prepare',
+    'compile',
+    'run',
+    'build',
+    'emulate',
+  ];
+
+  /**
+   * Is not supported for Capacitor.
+   *
+   * @param {string} taskName
+   * @return {boolean}
+   */
+  Capacitor.isNotSupportedTask = function (taskName) {
+    return Capacitor.notSupportedTask.includes(taskName);
+  };
+
+  module.exports = Capacitor;
+}());

src/create.js

@@ -12,6 +12,7 @@ var fs = require('fs'),
   serializer = new XMLSerializer(),
   Monaca = require('monaca-lib').Monaca,
   util = require(path.join(__dirname, 'util')),
+  lib = require(path.join(__dirname, 'lib')),
   sync = require(path.join(__dirname, 'sync'));
 
 var isWindowsPlatform = process.platform === 'win32';
@@ -62,12 +63,17 @@ CreateTask.run = function(taskName, info) {
 };
 
 CreateTask.createApp = function(template) {
-  var error = 'Error occurred while creating project: ';
+  let error = 'Error occurred while creating project: ';
   report.arg1 = template.name;
 
   monaca.downloadTemplate(template.resource, path.resolve(dirName))
     .then(
       function() {
+        // if it is capacitor project, skip checking config.xml
+        if (lib.isCapacitorProject(dirName)) {
+          return Promise.resolve();
+        }
+
         // Extract the project name if nested path is given before project name.
         // E.g. if command is 'create project Apps/Finance/myFinanceApp', then myFinanceApp will be taken as project name.
         error = 'An error occurred while injecting project name in config.xml: ';
@@ -81,7 +87,7 @@ CreateTask.createApp = function(template) {
     .then(
       function() {
         util.success('\nProject is created successfully.')
-        var message = [
+        let message = [
             '',
             'Type "cd ' + dirName + '" and run monaca command again.',
             '  > ' + 'monaca preview'.info + '      => Run app in the browser',

src/init.js

@@ -12,7 +12,7 @@ let printInitInfo = (commands) => {
   // www folder
   util.print(`A. Change the output folder to ${'www'.commands}.`);
   // config.xml
-  util.print(`B. In case of not having a ${'config.xml'.commands} file, a new one has been created with Monaca's default settings.`); 
+  util.print(`B. For Cordova project, a new ${'config.xml'.commands} file has been created with Monaca's default settings.`); 
   // monaca commands
   util.print(`C. Some new commands have been added:\n`
     + `\t${'monaca:preview'.commands}: ${commands.serve.commands}\n`
@@ -31,7 +31,7 @@ let printInitInfo = (commands) => {
     + `\t<!--Load selected CSS libraries-->\n`
     + `\t<link rel="stylesheet" href="components/loader.css”>`);
   // plugins
-  util.print(`F. Cordova plugins are managed by ${'package.json'.commands} file. If your plugin information is defined in ${'config.xml'.commands} file, you will need to import them again into Monaca.`);
+  util.print(`F. Cordova/Capacitor plugins are managed by ${'package.json'.commands} file. If your plugin information is defined in ${'config.xml'.commands} file, you will need to import them again into Monaca.`);
   // monaca documentation url
   util.print(`G. For more details about the changes, please refer to ${CLI_MIGRATION_DOC_URL.url}`);
 }

src/lib.js

@@ -13,26 +13,47 @@ var VERSION = require(path.join(__dirname, '..', 'package.json')).version;
 
 var findProjectDir = function(cwd, monaca) {
   return monaca.isMonacaProject(cwd).then(
-    (type) => {
+    () => {
       return Q.resolve(cwd);
     },
-    (error) => {
-      const errMessage = `Directory is not a Monaca project: 'config.xml' file, 'www' folder or '.monaca' folder may be missing.\nPlease visit https://en.docs.monaca.io/products_guide/monaca_cli/troubleshooting#incomplete-files-and-folder-structure.\n\nPlease execute 'monaca init' to initialize your project in case of having been created using another CLI tool.`;
+    () => {
+
+      const errMessage = `\n\nThis does not appear to be a Monaca project.
+      \nPlease visit https://en.docs.monaca.io/products_guide/monaca_cli/troubleshooting#incomplete-files-and-folder-structure for more information on incomplete files and folder structure.
+      \nTo initialize your project with Monaca, please execute 'monaca init'. Monaca currently supports Cordova and Capacitor projects`;
       let newPath = path.join(cwd, '..');
       return newPath === cwd ? Q.reject(errMessage) : findProjectDir(newPath, monaca);
     }
   );
 };
 
+const isCapacitorProject = (cwd = null) => {
+  if (!cwd) {
+    cwd = process.cwd();
+  }
+  let projectConfig;
+
+  try {
+    projectConfig = require(path.resolve(cwd, 'package.json'));
+    if (projectConfig?.dependencies && projectConfig.dependencies['@capacitor/core']) {
+      return true;
+    }
+  } catch (err) {}
+
+  return false;
+};
+
 var softlyAssureMonacaProject = function(cwd) {
   var projectConfig;
 
   try {
      projectConfig = require(path.resolve(cwd, 'package.json'));
   } catch (err) {}
 
-  if (projectConfig && projectConfig.dependencies && projectConfig.dependencies['react-native']) {
+  if (projectConfig?.dependencies && projectConfig.dependencies['react-native']) {
     return 'react-native';
+  } else if (isCapacitorProject(cwd)) {
+    return 'capacitor';
   } else if (fs.existsSync(path.resolve(cwd, 'www')) && fs.existsSync(path.join(cwd, 'config.xml'))) {
     return 'cordova';
   } else {
@@ -467,6 +488,7 @@ const DEBUGGER_TROUBLESHOOTING_DOC_URL = 'https://en.docs.monaca.io/products_gui
 const DEBUGGER_USAGE_DOC_URL = 'https://en.docs.monaca.io/products_guide/debugger/debug/#monaca-debugger-with-monaca-local-development-tools';
 
 module.exports = {
+  isCapacitorProject: isCapacitorProject,
   findProjectDir: findProjectDir,
   assureMonacaProject: assureMonacaProject,
   confirmOverwrite: confirmOverwrite,

src/monaca.js

@@ -7,6 +7,7 @@ var argv = require('minimist')(process.argv.slice(2)),
   path = require('path'),
   https = require('https'),
   lib = require(path.join(__dirname, 'lib')),
+  capacitor = require(path.join(__dirname, 'capacitor')),
   util = require(path.join(__dirname, 'util')),
   terminal = require(path.join(__dirname, 'terminal'));
 
@@ -110,6 +111,11 @@ var Monaca = {
       process.exit(0);
     }
 
+    // Check command not-supported for Capacitor project
+    if (lib.isCapacitorProject() && capacitor.isNotSupportedTask(task.name)) {
+      util.fail('This command is not supported yet for Capacitor project. Please use Monaca Cloud IDE to perform the task.');
+    }
+
     if (argv.help || argv.h
       || (task.name === 'create' && argv._.length < 2 && !argv['template-list'])
       || (task.name === 'docs' && argv._.length < 2)

src/serve.js

@@ -20,11 +20,15 @@ ServeTask.run = function (taskName, info) {
     .then( dir => {
       lib.needToUpgrade(dir, monaca);
       try {
+        let command = 'npm';
+        if (util.isUsingYarn(dir)) {
+          command = 'yarn';
+        }
         if (process.platform !== 'win32') {
-          spawn('npm', ['run', 'monaca:preview'], {stdio: 'inherit'});
+          spawn(command, ['run', 'monaca:preview'], {stdio: 'inherit'});
         } else {
           console.log('Running "monaca preview" on a separate terminal console. To exit this main process, please close the opened terminal windows.');
-          const childProcess = spawn('npm.cmd', ['run', 'monaca:preview'], {stdio: 'ignore', detached: true});
+          const childProcess = spawn(command + '.cmd', ['run', 'monaca:preview'], {stdio: 'ignore', detached: true});
           childProcess.on('close', (data) => {
             console.log('\n\nExiting Program...');
             process.exit(data);

src/util.js

@@ -3,6 +3,7 @@
 
 var Q = require('q'),
   fs = require('fs'),
+  path = require('path'),
   colors  =require('colors');
 
 var UPDATE_INTERVAL = 21600; //6 hours
@@ -248,6 +249,23 @@ var getFormatExpirationDate = (timestamp) => {
   }
 }
 
+/**
+ * Checks if a project is using Yarn as its package manager.
+ *
+ * @param {string} projectDir - The directory path of the project.
+ * @returns {boolean} - Returns true if the project uses Yarn, false otherwise.
+ */
+const isUsingYarn = (projectDir) => {
+  try {
+    const projectConfig = require(path.join(projectDir, 'package.json'));
+    const monacaPreviewScript = projectConfig.scripts && projectConfig.scripts['monaca:preview'];
+    if (monacaPreviewScript && monacaPreviewScript.indexOf('yarn') >= 0) {
+      return true;
+    }
+  } catch (err) {}
+  return false;
+};
+
 module.exports = {
   print: println,
   info: printinfo,
@@ -268,5 +286,6 @@ module.exports = {
   validateCountryCode: validateCountryCode,
   validateRequireField: validateRequireField,
   getFormatExpirationDate: getFormatExpirationDate,
+  isUsingYarn: isUsingYarn,
 };
 })();