Changes after manual QA

Author: Meldiron

composer.lock

@@ -79,8 +79,8 @@ function CleanUp {
 function InstallCompleted {
     Write-Host "[4/4] Finishing Installation ... "
     cleanup
-    Write-Host "🤘 May the force be with you."
     Write-Host "To get started with {{ spec.title | caseUcfirst }} CLI, please visit {{ sdk.url }}/docs/command-line"
+    Write-Host "As first step, you can login to your {{ spec.title | caseUcfirst }} account using 'appwrite login'"
 }
 
 

templates/cli/install.ps1.twig

@@ -139,8 +139,8 @@ cleanup() {
 installCompleted() {
     echo "[4/4] Wrapping up installation ... "
     cleanup
-    printf "🤘 May the force be with you. \n"
     echo "🚀 To get started with {{ spec.title | caseUcfirst }} CLI, please visit {{ sdk.url }}/docs/command-line"
+    echo "As first step, you can login to your {{ spec.title | caseUcfirst }} account using 'appwrite login'"
 }
 
 # Installation Starts here 

templates/cli/install.sh.twig

@@ -89,6 +89,7 @@ const loginCommand = async ({ email, password, endpoint, mfa, code }) => {
     }
 
     success("Signed in as user with ID: " + account.$id);
+    info("Next you can create or link to your project using 'appwrite init project'");
 };
 
 const whoami = new Command("whoami")

templates/cli/lib/commands/generic.js.twig

@@ -17,12 +17,31 @@ const {
     questionsCreateBucket,
     questionsCreateMessagingTopic,
     questionsCreateCollection,
-    questionsInitProject
+    questionsInitProject,
+    questionsInitResources,
+    questionsCreateTeam
 } = require("../questions");
-const { success, log, error, actionRunner } = require("../parser");
+const { success, log, error, actionRunner, commandDescriptions } = require("../parser");
 const { accountGet } = require("./account");
 const { sdkForConsole } = require("../sdks");
 
+const initResources = async () => {
+    const actions = {
+        function: initFunction,
+        collection: initCollection,
+        bucket: initBucket,
+        team: initTeam,
+        message: initTopic
+    }
+
+    const answers = await inquirer.prompt(questionsInitResources[0]);
+
+    const action = actions[answers.resource];
+    if (action !== undefined) {
+        await action({ returnOnZero: true });
+    }
+};
+
 const initProject = async ({ organizationId, projectId, projectName } = {}) => {
     let response = {};
 
@@ -83,7 +102,13 @@ const initProject = async ({ organizationId, projectId, projectName } = {}) => {
         localConfig.setProject(answers.project);
     }
 
-    success();
+    success(`Project successfully ${answers.start === 'existing' ? 'linked' : 'created'}. Details are now stored in appwrite.json file.`);
+
+    log("Next you can use 'appwrite init' to create resources in your project, or use 'appwrite pull' and 'appwite push' to synchronize your project.")
+
+    if(answers.start === 'existing') {
+        log("Since you connected to an existing project, we highly recommend to run 'appwrite pull all' to synchronize all of your existing resources.");
+    }
 }
 
 const initBucket = async () => {
@@ -96,23 +121,36 @@ const initBucket = async () => {
         enabled: true,
     });
     success();
+    log("Next you can use 'appwrite push bucket' to deploy the changes.");
+};
+
+const initTeam = async () => {
+    const answers = await inquirer.prompt(questionsCreateTeam)
+
+    localConfig.addTeam({
+        $id: answers.id === 'unique()' ? ID.unique() : answers.id,
+        name: answers.bucket,
+    });
+
+    success();
+    log("Next you can use 'appwrite push team' to deploy the changes.");
 };
 
 const initCollection = async () => {
     const answers = await inquirer.prompt(questionsCreateCollection)
     const newDatabase = (answers.method ?? '').toLowerCase() !== 'existing';
 
     if (!newDatabase) {
-        answers.databaseId = answers.database.$id;
-        answers.databaseName = answers.database.name;
+        answers.databaseId = answers.database;
+        answers.databaseName = localConfig.getDatabase(answers.database).name;
     }
 
-    const databaseId = answers.database_id === 'unique()' ? ID.unique() : answers.database_id;
+    const databaseId = answers.databaseId === 'unique()' ? ID.unique() : answers.databaseId;
 
-    if (newDatabase || !localConfig.getDatabase(answers.database_id).$id) {
+    if (newDatabase || !localConfig.getDatabase(answers.databaseId)) {
         localConfig.addDatabase({
             $id: databaseId,
-            name: answers.database_name,
+            name: answers.databaseName,
             enabled: true
         });
     }
@@ -128,6 +166,7 @@ const initCollection = async () => {
     });
 
     success();
+    log("Next you can use 'appwrite push collection' to deploy the changes.");
 };
 
 const initTopic = async () => {
@@ -140,6 +179,7 @@ const initTopic = async () => {
     });
 
     success();
+    log("Next you can use 'appwrite push topic' to deploy the changes.");
 };
 
 const initFunction = async () => {
@@ -175,7 +215,7 @@ const initFunction = async () => {
     fs.mkdirSync(templatesDir, "777");
     const repo = "https://github.com/{{ sdk.gitUserName }}/templates";
     const api = `https://api.github.com/repos/{{ sdk.gitUserName }}/templates/contents/${answers.runtime.name}`
-    const templates = ['Starter'];
+    const templates = ['starter'];
     let selected = undefined;
 
     try {
@@ -188,13 +228,12 @@ const initFunction = async () => {
         log('Loading templates...');
     }
 
-    const sparse = selected ? `${answers.runtime.name}/${selected.template}` : answers.runtime.name;
+    const sparse = (selected ? `${answers.runtime.name}/${selected.template}` : answers.runtime.name).toLowerCase();
 
     let gitInitCommands = `git clone --single-branch --depth 1 --sparse ${repo} .`; // depth prevents fetching older commits reducing the amount fetched
 
     let gitPullCommands = `git sparse-checkout add ${sparse}`;
 
-
     /* Force use CMD as powershell does not support && */
     if (process.platform === 'win32') {
         gitInitCommands = 'cmd /c "' + gitInitCommands + '"';
@@ -273,36 +312,48 @@ const initFunction = async () => {
 
     localConfig.addFunction(data);
     success();
-    log(`* Use 'appwrite dev function' for local development\n${' '.repeat(7)}* Use 'appwrite push functions' to push the function to your {{ spec.title|caseUcfirst }} instance`)
+    log("Next you can use 'appwrite run function' to develop a function locally. To deploy the function, use 'appwrite push function'");
 }
 
 const init = new Command("init")
-    .description('Init an {{ spec.title|caseUcfirst }} project')
-    .configureHelp({
-        helpWidth: process.stdout.columns || 80
-    })
+    .description(commandDescriptions['init'])
+    .action(actionRunner(initResources));
+
+init
+    .command("project")
+    .description("Init a new {{ spec.title|caseUcfirst }} project")
     .option("--organizationId <organizationId>", "{{ spec.title|caseUcfirst }} organization ID")
     .option("--projectId <projectId>", "{{ spec.title|caseUcfirst }} project ID")
     .option("--projectName <projectName>", "{{ spec.title|caseUcfirst }} project ID")
     .action(actionRunner(initProject));
 
 init
     .command("function")
+    .alias("functions")
     .description("Init a new {{ spec.title|caseUcfirst }} function")
     .action(actionRunner(initFunction));
 
 init
     .command("bucket")
+    .alias("buckets")
     .description("Init a new {{ spec.title|caseUcfirst }} bucket")
     .action(actionRunner(initBucket));
 
+init
+    .command("team")
+    .alias("teams")
+    .description("Init a new {{ spec.title|caseUcfirst }} team")
+    .action(actionRunner(initTeam));
+
 init
     .command("collection")
+    .alias("collections")
     .description("Init a new {{ spec.title|caseUcfirst }} collection")
     .action(actionRunner(initCollection));
 
 init
     .command("topic")
+    .alias("topics")
     .description("Init a new {{ spec.title|caseUcfirst }} topic")
     .action(actionRunner(initTopic));
 

templates/cli/lib/commands/init.js.twig

@@ -30,11 +30,9 @@ const pullResources = async () => {
     } else {
         const answers = await inquirer.prompt(questionsPullResources[0]);
 
-        for (let resource of answers.resources) {
-            const action = actions[resource];
-            if (action !== undefined) {
-                await action();
-            }
+        const action = actions[answers.resource];
+        if (action !== undefined) {
+            await action({ returnOnZero: true });
         }
     }
 };
@@ -183,15 +181,15 @@ const pullMessagingTopic = async () => {
 
 const pull = new Command("pull")
     .description(commandDescriptions['pull'])
-    .configureHelp({
-        helpWidth: process.stdout.columns || 80
-    });
+    .action(actionRunner(pullResources));
 
 pull
     .command("all")
     .description("Pull all resource.")
-    .action(actionRunner(pullResources));
-
+    .action(actionRunner(() => {
+        cliConfig.all = true;
+        return pullResources();
+    }));
 
 pull
     .command("project")

templates/cli/lib/commands/pull.js.twig

@@ -580,11 +580,9 @@ const pushResources = async () => {
     } else {
         const answers = await inquirer.prompt(questionsPushResources[0]);
 
-        for (let resource of answers.resources) {
-            const action = actions[resource];
-            if (action !== undefined) {
-                await action({ returnOnZero: true });
-            }
+        const action = actions[answers.resource];
+        if (action !== undefined) {
+            await action({ returnOnZero: true });
         }
     }
 };
@@ -593,9 +591,9 @@ const pushProject = async () => {
     try {
         const projectId = localConfig.getProject().projectId;
         const projectName = localConfig.getProject().projectName;
-        const settings = localConfig.getProject().projectSettings;
+        const settings = localConfig.getProject().projectSettings ?? {};
 
-        log(`Updating project ${projectName} ( ${projectId} )`);
+        log(`Updating project ${projectId}`);
 
         if (projectName) {
             await projectsUpdate({
@@ -605,7 +603,6 @@ const pushProject = async () => {
             });
         }
 
-
         if (settings.services) {
             log('Updating service statuses');
             for (let [service, status] of Object.entries(settings.services)) {
@@ -643,7 +640,7 @@ const pushProject = async () => {
             }
         }
 
-        success();
+        success("Project configuration updated.");
     } catch (e) {
         throw e;
     }
@@ -664,7 +661,7 @@ const pushFunction = async ({ functionId, async, returnOnZero } = { returnOnZero
                 log('No functions found, skipping');
                 return;
             }
-            throw new Error("No functions found in the current directory.");
+            throw new Error("No functions found in the current directory. Use 'appwrite pull functions' to synchronize existing one, or use 'appwrite init function' to create a new one.");
         }
         functionIds.push(...functions.map((func) => {
             return func.$id;
@@ -970,7 +967,7 @@ const pushCollection = async ({ returnOnZero } = { returnOnZero: false }) => {
                 return;
             }
 
-            throw new Error("No collections found in the current directory. Run `{{ language.params.executableName }} pull collection` to fetch all your collections.");
+            throw new Error("No collections found in the current directory. Use 'appwrite pull collections' to synchronize existing one, or use 'appwrite init collection' to create a new one.");
         }
         collections.push(...localConfig.getCollections());
     } else {
@@ -1102,7 +1099,7 @@ const pushBucket = async ({ returnOnZero } = { returnOnZero: false }) => {
                 log('No buckets found, skipping');
                 return;
             }
-            throw new Error("No buckets found in the current directory. Run `appwrite pull bucket` to fetch all your buckets.");
+            throw new Error("No buckets found in the current directory. Use 'appwrite pull buckets' to synchronize existing one, or use 'appwrite init bucket' to create a new one.");
         }
         bucketIds.push(...configBuckets.map((b) => b.$id));
     }
@@ -1127,15 +1124,6 @@ const pushBucket = async ({ returnOnZero } = { returnOnZero: false }) => {
                 bucketId: bucket['$id'],
                 parseOutput: false,
             })
-            log(`Bucket ${bucket.name} ( ${bucket['$id']} ) already exists.`);
-
-            if (!cliConfig.force) {
-                const answers = await inquirer.prompt(questionsPushBuckets[1])
-                if (answers.override.toLowerCase() !== "yes") {
-                    log(`Received "${answers.override}". Skipping ${bucket.name} ( ${bucket['$id']} )`);
-                    continue;
-                }
-            }
 
             log(`Updating bucket ...`)
 
@@ -1193,7 +1181,7 @@ const pushTeam = async ({ returnOnZero } = { returnOnZero: false }) => {
                 log('No teams found, skipping');
                 return;
             }
-            throw new Error("No teams found in the current directory. Run `appwrite pull team` to fetch all your teams.");
+            throw new Error("No teams found in the current directory. Use 'appwrite pull teams' to synchronize existing one, or use 'appwrite init team' to create a new one.");
         }
         teamIds.push(...configTeams.map((t) => t.$id));
     }
@@ -1218,15 +1206,6 @@ const pushTeam = async ({ returnOnZero } = { returnOnZero: false }) => {
                 teamId: team['$id'],
                 parseOutput: false,
             })
-            log(`Team ${team.name} ( ${team['$id']} ) already exists.`);
-
-            if (!cliConfig.force) {
-                const answers = await inquirer.prompt(questionsPushTeams[1])
-                if (answers.override.toLowerCase() !== "yes") {
-                    log(`Received "${answers.override}". Skipping ${team.name} ( ${team['$id']} )`);
-                    continue;
-                }
-            }
 
             log(`Updating team ...`)
 
@@ -1269,7 +1248,7 @@ const pushMessagingTopic = async ({ returnOnZero } = { returnOnZero: false }) =>
                 log('No topics found, skipping');
                 return;
             }
-            throw new Error("No topics found in the current directory. Run `appwrite pull topics` to pull all your messaging topics.");
+            throw new Error("No topics found in the current directory. Use 'appwrite pull topics' to synchronize existing one, or use 'appwrite init topic' to create a new one.");
         }
         topicsIds.push(...configTopics.map((b) => b.$id));
     }
@@ -1338,14 +1317,16 @@ const pushMessagingTopic = async ({ returnOnZero } = { returnOnZero: false }) =>
 }
 
 const push = new Command("push")
-    .alias('deploy')
     .description(commandDescriptions['push'])
     .action(actionRunner(pushResources));
 
 push
     .command("all")
     .description("Push all resource.")
-    .action(actionRunner(pushResources));
+    .action(actionRunner(() => {
+        cliConfig.all = true;
+        return pushResources();
+    }));
 
 push
     .command("project")