Diferencia Cidades pela sigla do Estado (detalhes em Cidade-Estado.txt)

Cidade-Estado.txt

@@ -0,0 +1,40 @@
+------------------------------------------------
+Utiliza sigla do Estado para diferenciar cidades
+------------------------------------------------
+
+Problema:
+--------
+
+Originalmente, quando executamos:       '$ clima são paulo'
+
+A cidade localizada é:                  Morro de São Paulo - SP
+
+Provavelmente, a API da Climatempo retorna a primeira cidade que possui
+o nome na sua lista.
+
+
+Solução:
+-------
+
+Esta alteração permite incluir a sigla do Estado após o nome da cidade
+para especificá-la.
+
+Desta forma, quando executamos:         '$ clima são paulo - sp'
+
+A cidade localizada é:                  'São Paulo - SP'
+
+
+Implementação:
+-------------
+
+Foi acrescentado um código no arquivo "cli.js" que altera o "cityName" antes do "getForecast", 
+caso ele possua um elemento "-".
+
+Assim, se o "cityName" for:     [ "são", "paulo", "-", "sp"]
+
+Será modificado para:           [ "são", "paulo&state=sp"]
+
+e pode ser enviado para o "getForecast".
+
+
+O exemplo de uso também foi alterado para incluir a nova utilização.

src/cli.js

@@ -1,30 +1,41 @@
-import program from 'commander'
+import program from 'commander' // estrutura a aplicação CLI
 
-import { version } from '../package.json'
+import { version } from '../package.json' // informa a versão da CLI
 
-import getForecast from './main'
-import { saveApiToken } from './utils/apiToken'
+import getForecast from './main' // função que busca informação da cidade
+import { saveApiToken } from './utils/apiToken' // função que salva o token pra não pedir toda a hora
 
 export function init(args) {
 
-    program
-        .version(version, '-v, --version', 'Mostra a versão da ferramenta')
-        .option('-t --token [token]', 'Advisor ClimaTempo API token')
-        .arguments('<cityName...>')
-        .description('Mostra o clima de uma cidade em tempo real')
-        .action(async (cityName) => {
-            if (program.token) {
-                await saveApiToken(program.token)
+    program // instância do commander
+        .version(version, '-v, --version', 'Mostra a versão da ferramenta') // mostra a versão da CLI
+        .option('-t --token [token]', 'Advisor ClimaTempo API token') // opção de passar o token
+        .arguments('<cityName...>') // único argumento é o nome da cidade    "<>" indica que é obrigatório  "..." inclui demais argumentos
+        .description('Mostra o clima de uma cidade em tempo real') // descrição do comando
+        .action(async (cityName) => { // ação realizada
+            if (program.token) { // se passou o token: 
+                await saveApiToken(program.token) // salva token
             }
 
-            getForecast(cityName.join(' '))
+            //  altera cityName, caso o estado seja especificado no padrão adotado 
+            if (cityName.includes("-")) {                   // se cityName contém "-":
+                const state = "&state=" + cityName.pop();       // retira informação de estado do cityName e guarda formatado   
+                cityName.pop();                                 // retira "-" do cityName
+                cityName[cityName.length - 1] = cityName[cityName.length - 1] + state;
+            }                                                   // concatena último elemento do cityName com estado formatado
+
+            getForecast(cityName.join(' ')) // junta todas as partes do argumento e passa para a API
         })
-        .on('--help', () => {
+        .on('--help', () => { // passa exemplo de uso
             console.log()
             console.log('Exemplos:')
             console.log('$ clima porto alegre')
+            console.log('  -> retorna dados de Porto Alegre - RS')
             console.log('$ clima são paulo')
+            console.log('  -> retorna dados de Morro de São Paulo - BA')  // mostra a necessidade de passar estado
+            console.log('$ clima são paulo - sp')                         // quando há cidades com nomes ou 
+            console.log(  '-> retorna dados de São Paulo - SP')           // parte do nomes iguais
         })
 
-    program.parse(args)
+    program.parse(args) // retorna resposta da API
 }