Merge pull request #1164 from appwrite/fix-cli

Fix CLI

Author: abnegate

src/SDK/Language/CLI.php

@@ -163,7 +163,7 @@ public function getFiles(): array
             ],
             [
                 'scope'         => 'method',
-                'destination'   => 'docs/examples/{{service.name | caseLower}}/{{method.name | caseDash}}.md',
+                'destination'   => 'docs/examples/{{service.name | caseLower}}/{{method.name | caseKebab}}.md',
                 'template'      => 'cli/docs/example.md.twig',
             ],
             [
@@ -313,7 +313,7 @@ public function getFiles(): array
             ],
             [
                 'scope'         => 'service',
-                'destination'   => '/lib/commands/{{service.name | caseDash}}.js',
+                'destination'   => '/lib/commands/{{ service.name | caseKebab }}.js',
                 'template'      => 'cli/lib/commands/command.js.twig',
             ],
             [

templates/cli/docs/example.md.twig

@@ -1,8 +1,12 @@
-{{ language.params.executableName }} {{ service.name }} {{ method.name }}{% if method.parameters.all | length > 0 %} \{% endif %}
-
+{% set requiredParams = [] %}
 {% for parameter in method.parameters.all %}
 {% if parameter.required %}
-        --{{ parameter.name }} {{ parameter | paramExample }}{% if not loop.last %} \{% endif %}
+{% set requiredParams = requiredParams|merge([parameter]) %}
 {% endif %}
+{% endfor %}
+{{ language.params.executableName }} {{ service.name | caseKebab }} {{ method.name | caseKebab }}{% if requiredParams | length > 0 %} \{% endif %}
+
+{% for parameter in requiredParams %}
+    --{{ parameter.name | caseKebab }} {{ parameter | paramExample }}{% if not loop.last %} \{% endif %}
 
 {% endfor %}

templates/cli/index.js.twig

@@ -24,7 +24,7 @@ const { update } = require("./lib/commands/update");
 const { migrate } = require("./lib/commands/generic");
 {% endif %}
 {% for service in spec.services %}
-const { {{ service.name | caseLower }} } = require("./lib/commands/{{ service.name | caseLower }}");
+const { {{ service.name }} } = require("./lib/commands/{{ service.name | caseKebab }}");
 {% endfor %}
 
 inquirer.registerPrompt('search-list', require('inquirer-search-list'));

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

@@ -35,11 +35,22 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower }}").description(commandDescriptions['{{ service.name | caseLower }}'] ?? '').configureHelp({
+const {{ service.name }} = new Command("{{ service.name | caseKebab }}").description(commandDescriptions['{{ service.name | caseKebab }}'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
 {% for method in service.methods %}
+{% set commandNameLower = (method.name | caseKebab | lower) %}
+{# Check if this method should be skipped (is deprecated and has a non-deprecated duplicate) #}
+{% set shouldSkip = false %}
+{% if method.deprecated %}
+{% for otherMethod in service.methods %}
+{% if not otherMethod.deprecated and (otherMethod.name | caseKebab | lower) == commandNameLower %}
+{% set shouldSkip = true %}
+{% endif %}
+{% endfor %}
+{% endif %}
+{% if not shouldSkip %}
 /**
  * @typedef {Object} {{ service.name | caseUcfirst }}{{ method.name | caseUcfirst }}RequestParams
 {% for parameter in method.parameters.all %}
@@ -60,7 +71,7 @@ const {{ service.name | caseLower }} = new Command("{{ service.name | caseLower
  * @param {{ "{" }}{{ service.name | caseUcfirst }}{{ method.name | caseUcfirst }}RequestParams{{ "}" }} params
  */
 {% block declaration %}
-const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
+const {{ service.name }}{{ method.name | caseUcfirst }} = async ({
         {%- for parameter in method.parameters.all -%}
             {{ parameter.name | caseCamel | escapeKeyword }},
         {%- endfor -%}
@@ -82,10 +93,24 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
 {% endif %}
 }
 {% endblock declaration %}
-
+{% endif %}
 {% endfor %}
+{% set processedCommands = [] %}
 {% for method in service.methods %}
-{{service.name | caseLower }}
+{% set commandName = method.name | caseKebab %}
+{% set commandNameLower = commandName | lower %}
+{# Check if this command name (in lowercase) has already been processed by a non-deprecated method #}
+{% set shouldSkip = false %}
+{% if method.deprecated %}
+{% for otherMethod in service.methods %}
+{% if not otherMethod.deprecated and (otherMethod.name | caseKebab | lower) == commandNameLower %}
+{% set shouldSkip = true %}
+{% endif %}
+{% endfor %}
+{% endif %}
+{% if not shouldSkip %}
+{% set processedCommands = processedCommands|merge([commandNameLower]) %}
+{{ service.name }}
     .command(`{{ method.name | caseKebab }}`)
 {% autoescape false %}
     .description(`{% if method.deprecated %}[**DEPRECATED** - This command is deprecated.{% if method.replaceWith %} Please use '{{ method.replaceWith | replace({'.': ' '}) | caseKebab }}' instead{% endif %}] {% endif %}{{ method.description | replace({'`':'\''}) | replace({'\n':' '}) | replace({'\n \n':' '}) }}`)
@@ -99,13 +124,28 @@ const {{ service.name | caseLower }}{{ method.name | caseUcfirst }} = async ({
     .option(`--console`, `Get the resource console url`)
 {% endif %}
 {% endautoescape %}
-    .action(actionRunner({{ service.name | caseLower }}{{ method.name | caseUcfirst }}))
+    .action(actionRunner({{ service.name }}{{ method.name | caseUcfirst }}))
 
+{% endif %}
 {% endfor %}
 module.exports = {
-    {{ service.name | caseLower }},
+    {{ service.name }},
+{% set exportedMethods = [] %}
 {% for method in service.methods %}
-    {{ service.name | caseLower }}{{ method.name | caseUcfirst }}{% if not loop.last %},{% endif %}
+{% set commandNameLower = (method.name | caseKebab | lower) %}
+{# Check if this method should be skipped (is deprecated and has a non-deprecated duplicate) #}
+{% set shouldSkip = false %}
+{% if method.deprecated %}
+{% for otherMethod in service.methods %}
+{% if not otherMethod.deprecated and (otherMethod.name | caseKebab | lower) == commandNameLower %}
+{% set shouldSkip = true %}
+{% endif %}
+{% endfor %}
+{% endif %}
+{% if not shouldSkip %}
+{% set exportedMethods = exportedMethods|merge([service.name ~ method.name | caseUcfirst]) %}
+    {{ service.name }}{{ method.name | caseUcfirst }}{% if not loop.last %},{% endif %}
 
+{% endif %}
 {% endfor %}
 };

templates/cli/lib/parser.js.twig

@@ -230,7 +230,7 @@ const commandDescriptions = {
     "main": chalk.redBright(`${logo}${description}`),
 {% if sdk.test == "true" %}
 {% for service in spec.services %}
-    "{{ service.name | caseLower }}": `The {{ service.name }} command allows you to manage your {{ service.name }} service.`,
+    "{{ service.name | caseKebab }}": `The {{ service.name | caseKebab }} command allows you to manage your {{ service.name }} service.`,
 {% endfor %}
 {% endif %}
 }