@capacitor/create-plugin 0.20.2 → 0.21.0

package/README.md

@@ -30,4 +30,5 @@ As of the `0.8.0` release, example apps for testing are included when initializi
 --author <author> ......... Author name and email (e.g. "Name <name@example.com>")
 --license <id> ............ SPDX License ID (e.g. "MIT")
 --description <text> ...... Short description of plugin features
+--android-lang <text> ..... Language for Android plugin development (either "kotlin" or "java")
 ```

package/dist/help.js

@@ -13,6 +13,7 @@ const help = `
     --author <author> ......... Author name and email (e.g. "Name <name@example.com>")
     --license <id> ............ SPDX License ID (e.g. "MIT")
     --description <text> ...... Short description of plugin features
+    --android-lang ............ Language for Android plugin development (either "kotlin" or "java")
 
     -h, --help ................ Print help, then quit
     --verbose ................. Print verbose output to stderr

package/dist/index.js

@@ -13,6 +13,15 @@ const prompt_1 = require("./prompt");
 const subprocess_1 = require("./subprocess");
 const template_1 = require("./template");
 const debug = (0, debug_1.default)('@capacitor/create-plugin');
+const isInsideGitRepo = async (cwd) => {
+    try {
+        await (0, subprocess_1.runSilent)('git', ['rev-parse', '--is-inside-work-tree'], { cwd, stdio: 'ignore' });
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+};
 process.on('unhandledRejection', (error) => {
     process.stderr.write(`ERR: ${error}\n`);
     process.exit(1);
@@ -99,15 +108,21 @@ const run = async () => {
     catch (e) {
         process.stderr.write(`WARN: Could not create test application: ${(_f = (_e = e.message) !== null && _e !== void 0 ? _e : e.stack) !== null && _f !== void 0 ? _f : e}\n`);
     }
-    process.stdout.write('Initializing git...\n');
-    try {
-        await (0, subprocess_1.run)('git', ['init'], opts);
-        await (0, subprocess_1.run)('git', ['checkout', '-b', 'main'], opts);
-        await (0, subprocess_1.run)('git', ['add', '-A'], opts);
-        await (0, subprocess_1.run)('git', ['commit', '-m', 'Initial commit', '--no-gpg-sign'], opts);
+    const isInGitRepo = await isInsideGitRepo(details.dir);
+    if (isInGitRepo) {
+        process.stdout.write('Skipping git initialization (already inside a git repository)...\n');
     }
-    catch (e) {
-        process.stderr.write(`WARN: Could not initialize git: ${(_h = (_g = e.message) !== null && _g !== void 0 ? _g : e.stack) !== null && _h !== void 0 ? _h : e}\n`);
+    else {
+        process.stdout.write('Initializing git...\n');
+        try {
+            await (0, subprocess_1.run)('git', ['init'], opts);
+            await (0, subprocess_1.run)('git', ['checkout', '-b', 'main'], opts);
+            await (0, subprocess_1.run)('git', ['add', '-A'], opts);
+            await (0, subprocess_1.run)('git', ['commit', '-m', 'Initial commit', '--no-gpg-sign'], opts);
+        }
+        catch (e) {
+            process.stderr.write(`WARN: Could not initialize git: ${(_h = (_g = e.message) !== null && _g !== void 0 ? _g : e.stack) !== null && _h !== void 0 ? _h : e}\n`);
+        }
     }
     const tada = (0, cli_1.emoji)('🎉', '*');
     process.stdout.write(`

package/dist/options.js

@@ -6,7 +6,16 @@ const debug_1 = tslib_1.__importDefault(require("debug"));
 const cli_1 = require("./cli");
 const debug = (0, debug_1.default)('@capacitor/create-plugin:options');
 const CLI_ARGS = ['dir'];
-const CLI_OPTIONS = ['name', 'package-id', 'class-name', 'repo', 'author', 'license', 'description'];
+const CLI_OPTIONS = [
+    'name',
+    'package-id',
+    'class-name',
+    'repo',
+    'author',
+    'license',
+    'description',
+    'android-lang',
+];
 exports.VALIDATORS = {
     name: (value) => typeof value !== 'string' || value.trim().length === 0
         ? `Must provide a plugin name, e.g. "capacitor-plugin-example"`
@@ -31,6 +40,9 @@ exports.VALIDATORS = {
     author: () => true,
     license: (value) => typeof value !== 'string' || value.trim().length === 0 ? `Must provide a valid license, e.g. "MIT"` : true,
     description: (value) => typeof value !== 'string' || value.trim().length === 0 ? `Must provide a description` : true,
+    'android-lang': (value) => typeof value === 'string' && value.trim().length > 0 && /^(kotlin|kt|java)$/i.test(value)
+        ? true
+        : `Must be either "kotlin" or "java"`,
     dir: (value) => typeof value !== 'string' || value.trim().length === 0
         ? `Must provide a directory, e.g. "my-plugin"`
         : /^-/.test(value)

package/dist/prompt.js

@@ -76,6 +76,15 @@ const gatherDetails = (initialOptions) => {
             message: `Enter a SPDX license identifier for your plugin.\n`,
             validate: options_1.VALIDATORS.license,
         },
+        {
+            type: 'select',
+            name: 'android-lang',
+            message: `What language would you like to use for your Android plugin?\n`,
+            choices: [
+                { title: 'Kotlin', value: 'kotlin' },
+                { title: 'Java', value: 'java' },
+            ],
+        },
         {
             type: 'text',
             name: 'description',

package/dist/subprocess.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wait = exports.run = exports.spawn = void 0;
+exports.wait = exports.runSilent = exports.run = exports.spawn = void 0;
 const tslib_1 = require("tslib");
 const cp = tslib_1.__importStar(require("child_process"));
 const kleur_1 = tslib_1.__importDefault(require("kleur"));
@@ -10,6 +10,10 @@ const run = async (cmd, args, options) => {
     await (0, exports.wait)((0, exports.spawn)(cmd, args, options));
 };
 exports.run = run;
+const runSilent = async (cmd, args, options) => {
+    await (0, exports.wait)((0, exports.spawn)(cmd, args, options));
+};
+exports.runSilent = runSilent;
 const wait = async (p) => {
     return new Promise((resolve, reject) => {
         p.on('error', reject);

package/dist/template.js

@@ -19,6 +19,7 @@ exports.readPackageJson = readPackageJson;
 const extractTemplate = async (dir, details, type) => {
     const templateFiles = [];
     const templateFolders = [];
+    const androidLang = details['android-lang'].toLowerCase();
     await (0, promises_1.mkdir)(dir, { recursive: true });
     await (0, tar_1.extract)({
         file: type === 'PLUGIN_TEMPLATE' ? TEMPLATE_PATH : WWW_TEMPLATE_PATH,
@@ -34,11 +35,39 @@ const extractTemplate = async (dir, details, type) => {
         },
     });
     await Promise.all(templateFiles.map((p) => (0, path_1.resolve)(dir, p)).map((p) => (0, exports.applyTemplate)(p, details)));
-    await Promise.all(templateFolders.map((p) => (0, path_1.resolve)(dir, p)).map((p) => (0, promises_1.rmdir)(p)));
+    await deleteUnnecessaryFolders(dir, androidLang);
+    await Promise.all(templateFolders.map((p) => (0, path_1.resolve)(dir, p)).map((p) => (0, promises_1.rm)(p, { recursive: true })));
 };
 exports.extractTemplate = extractTemplate;
-const applyTemplate = async (p, { name, 'package-id': packageId, 'class-name': className, repo, author, license, description }) => {
+const deleteUnnecessaryFolders = async (dir, androidLang) => {
+    const androidSrcDir = (0, path_1.join)(dir, 'android', 'src');
+    const sourceSets = ['main', 'test', 'androidTest'];
+    for (const sourceSet of sourceSets) {
+        const sourceFolder = (0, path_1.join)(androidSrcDir, sourceSet);
+        const javaFolder = (0, path_1.join)(sourceFolder, 'java');
+        const kotlinFolder = (0, path_1.join)(sourceFolder, 'kotlin');
+        if (androidLang === 'kotlin' && (await folderExists(javaFolder))) {
+            await (0, promises_1.rm)(javaFolder, { recursive: true });
+        }
+        if (androidLang === 'java' && (await folderExists(kotlinFolder))) {
+            await (0, promises_1.rm)(kotlinFolder, { recursive: true });
+        }
+    }
+};
+const folderExists = async (folderPath) => {
+    try {
+        const files = await (0, promises_1.readdir)(folderPath);
+        return files != null;
+    }
+    catch (err) {
+        return false;
+    }
+};
+const applyTemplate = async (p, { name, 'package-id': packageId, 'class-name': className, repo, author, license, description, 'android-lang': androidLang, }) => {
     const template = await (0, promises_1.readFile)(p, { encoding: 'utf8' });
+    const conditionalView = {
+        KOTLIN: androidLang.toLowerCase() !== 'java',
+    };
     const view = {
         CAPACITOR_VERSION: exports.CAPACITOR_VERSION,
         PACKAGE_NAME: name,
@@ -50,12 +79,16 @@ const applyTemplate = async (p, { name, 'package-id': packageId, 'class-name': c
         AUTHOR: author,
         LICENSE: license,
         DESCRIPTION: description,
+        ANDROID_LANG: androidLang,
     };
-    const contents = mustache_1.default.render(template, view);
-    const filePath = Object.entries(view).reduce((acc, [key, value]) => (value ? acc.replaceAll(`__${key}__`, value) : acc), p.substring(0, p.length - MUSTACHE_EXTENSION.length));
+    const combinedView = { ...view, ...conditionalView };
+    const intermediateContents = mustache_1.default.render(template, combinedView);
+    const finalContents = mustache_1.default.render(intermediateContents, view);
+    let filePath = p.substring(0, p.length - MUSTACHE_EXTENSION.length);
+    filePath = Object.entries(view).reduce((acc, [key, value]) => (value ? acc.replaceAll(`__${key}__`, value.toString()) : acc), filePath);
     await (0, promises_1.mkdir)((0, path_1.dirname)(filePath), { recursive: true });
     // take off the .mustache extension and write the file, then remove the template
-    await (0, promises_1.writeFile)(filePath, contents, { encoding: 'utf8' });
+    await (0, promises_1.writeFile)(filePath, finalContents, { encoding: 'utf8' });
     await (0, promises_1.unlink)(p);
 };
 exports.applyTemplate = applyTemplate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/create-plugin",
-  "version": "0.20.2",
+  "version": "0.21.0",
   "description": "Generate a new Capacitor plugin",
   "author": "Ionic Team <hi@ionicframework.com>",
   "homepage": "https://capacitorjs.com",