Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michelmix/functions


https://github.com/michelmix/functions

Last synced: about 6 hours ago
JSON representation

Awesome Lists containing this project

README 

        
# Boas-vindas ao repositório do exercício de Funções



Para realizar o exercício, atente-se a cada passo descrito a seguir e, se tiver qualquer dúvida, nos envie por _Slack_! #vqv 🚀



Aqui você vai encontrar os detalhes de como estruturar o desenvolvimento do seu exercício a partir deste repositório, utilizando uma branch específica e um _Pull Request_ (PR) para colocar seus códigos.



## Termos e acordos



Ao iniciar este exercício, você concorda com as diretrizes do Código de Conduta e do Manual da Pessoa Estudante da Trybe.



## Entregáveis



  🤷🏽‍♀️ Como entregar



Para entregar o seu exercício você deverá criar um _Pull Request_ neste repositório.



Lembre-se que você pode consultar nosso conteúdo sobre [Git & GitHub](https://app.betrybe.com/learn/course/5e938f69-6e32-43b3-9685-c936530fd326/module/fc998c60-386e-46bc-83ca-4269beb17e17/section/fe827a71-3222-4b4d-a66f-ed98e09961af/day/1a530297-e176-4c79-8ed9-291ae2950540/lesson/2b2edce7-9c49-4907-92a2-aa571f823b79) e nosso [Blog - Git & GitHub](https://blog.betrybe.com/tecnologia/git-e-github/) sempre que precisar!



  👨‍💻 O que deverá ser desenvolvido



Vamos fazer um exercício que vai deixar nítido como funções com responsabilidades bem definidas deixam o código mais bem escrito. Para isso, vamos criar uma série de funções com respostas já definidas e exercitar nossa lógica de programação.



  📝 Habilidades



Neste exercício, verificamos se você é capaz de:



- Criar funções em JavaScript;



- Criar loops para percorrer e manipular arrays;



- Utilizar estruturas condicionais;



- Utilizar lógica de programação para estruturar e resolver problemas.



## Orientações



  ‼️ Antes de começar a desenvolver



1. Clone o repositório e entre nele



2. Instale as dependências



   - `npm install`.



3. Crie uma branch a partir da branch `main`



   - Verifique que você está na branch `main`

     - Exemplo: `git branch`

   - Se não estiver, mude para a branch `main`

     - Exemplo: `git checkout main`

   - Agora crie uma branch à qual você vai submeter os `commits` do seu exercício

     - Você deve criar uma branch no seguinte formato: `nome-de-usuario-nome-do-exercicio`

     - Exemplo: `git checkout -b joaozinho-exercise-functions`



4. Adicione as mudanças ao _stage_ do Git e faça um `commit`



   - Verifique que as mudanças ainda não estão no _stage_

     - Exemplo: `git status` (deve aparecer listada a pasta _joaozinho_ em vermelho)

   - Adicione o novo arquivo ao _stage_ do Git

     - Exemplo:

       - `git add .` (adicionando todas as mudanças - _que estavam em vermelho_ - ao stage do Git)

       - `git status` (deve aparecer listado o arquivo _joaozinho/README.md_ em verde)

   - Faça o `commit` inicial

     - Exemplo:

       - `git commit -m 'iniciando o exercício x'` (fazendo o primeiro commit)

       - `git status` (deve aparecer uma mensagem tipo _nothing to commit_ )



5. Adicione a sua branch com o novo `commit` ao repositório remoto



   - Usando o exemplo anterior: `git push -u origin joaozinho-exercise-functions`



6. Crie um novo `Pull Request` _(PR)_



   - Vá até a página de _Pull Requests_ do [repositório no GitHub](https://github.com/tryber/sd-027-a-exercise-functions/pulls)

   - Clique no botão verde _"New pull request"_

   - Clique na caixa de seleção _"Compare"_ e escolha a sua branch **com atenção**

   - Coloque um título para a sua _Pull Request_

     - Exemplo: _"Cria tela de busca"_

   - Clique no botão verde _"Create pull request"_

   - Adicione uma descrição para o _Pull Request_ e clique no botão verde _"Create pull request"_

   - **Não se preocupe em preencher mais nada por enquanto!**

   - Volte até a [página de _Pull Requests_ do repositório](https://github.com/tryber/sd-027-a-exercise-functions/pulls) e confira que o seu _Pull Request_ está criado



  ⌨️ Durante o desenvolvimento



- Faça `commits` das alterações que você fizer no código regularmente



- Lembre-se de sempre após um (ou alguns) `commits` atualizar o repositório remoto



- Os comandos que você utilizará com mais frequência são:

  1. `git status` _(para verificar o que está em vermelho - fora do stage - e o que está em verde - no stage)_

  2. `git add` _(para adicionar arquivos ao stage do Git)_

  3. `git commit` _(para criar um commit com os arquivos que estão no stage do Git)_

  4. `git push -u origin nome-da-branch` _(para enviar o commit para o repositório remoto na primeira vez que fizer o `push` de uma nova branch)_

  5. `git push` _(para enviar o commit para o repositório remoto após o passo anterior)_



  

🏗 Como estruturar seu projeto

   



O seu Pull Request deverá conter o arquivo `src/functions.js` com suas funções implementadas.



- Crie as funções no arquivo `functions.js` que está no diretório `src`, usando os mesmos nomes especificados nos comentários. Você pode criar outras funções de auxílio, entretanto, **você deve criar e utilizar as funções com os nomes que estão nos comentários, pois estas que serão avaliadas.**



> **De olho na dica 👀**: Utilize `console.log()` para testar as funções localmente, mas remova antes de fazer o `push` 😉.



  🤝 Depois de terminar o desenvolvimento (opcional)



Para sinalizar que o seu exercício está pronto para o _"Code Review"_, faça o seguinte:



- Vá até a página **DO SEU** _Pull Request_, adicione a label de _"code-review"_ e marque seus colegas:



  - No menu à direita, clique no _link_ **"Labels"** e escolha a _label_ **code-review**;



  - No menu à direita, clique no _link_ **"Assignees"** e escolha **o seu usuário**;



  - No menu à direita, clique no _link_ **"Reviewers"** e digite `students`, selecione o time `tryber/students-sd-027-a`.



Caso tenha alguma dúvida, [aqui tem um video explicativo](https://vimeo.com/362189205).



  🕵🏿 Revisando um pull request



Use o conteúdo sobre [Code Review](https://app.betrybe.com/learn/course/5e938f69-6e32-43b3-9685-c936530fd326/module/f04cdb21-382e-4588-8950-3b1a29afd2dd/section/b3af2f05-08e5-4b4a-9667-6f5f729c351d/lesson/36268865-fc46-40c7-92bf-cbded9af9006) para te ajudar a revisar os _Pull Requests_.



  🎛 Linter



Para garantir a qualidade do código, vamos utilizar neste exercício os linters `ESLint` e `StyleLint`.

Assim o código estará alinhado com as boas práticas de desenvolvimento, sendo mais legível

e de fácil manutenção! Para rodá-los localmente, execute os comandos abaixo:



```bash

  npm run lint

  npm run lint:styles

```



Em caso de dúvidas, confira o material do course sobre [ESLint e Stylelint](https://app.betrybe.com/learn/course/5e938f69-6e32-43b3-9685-c936530fd326/module/f04cdb21-382e-4588-8950-3b1a29afd2dd/section/3b1546b5-f7bc-40f7-a674-77b16c408756/lesson/0c9e8c0e-24c3-4526-ba6b-60d95913e022).



:warning: **NESTE EXERCÍCIO O ESLINT NÃO SERÁ AVALIADO. VOCÊ PODE RODAR O TESTE LOCALMENTE E FAZER AS CORREÇÕES SE DESEJAR!** :warning:



  🛠 Testes



⚠️**AVISO**: Muito cuidado com os nomes especificados nos requisitos! O conteúdo deve ser **exatamente igual** ao texto descrito no requisito.



Para verificar a solução proposta, você pode efetuar todos os testes localmente, basta executar:



```bash

npm test

```



**_ou_**



Para executar um arquivo de teste específico, utilize `npm test nomeDoArquivoDeTeste`:



```bash

npm test verifyPalindrome

```



⚠️ Atenção: **O avaliador automático não necessariamente avalia seu exercício na ordem em que os requisitos aparecem no readme. Isso acontece para deixar o processo de avaliação mais rápido. Então, não se assuste se isso acontecer, ok?**



  🗂 Compartilhe seu portfólio!



Você sabia que o LinkedIn é a principal rede social profissional e compartilhar o seu aprendizado lá é muito importante para quem deseja construir uma carreira de sucesso? Compartilhe esse exercício no seu LinkedIn, marque o perfil da Trybe (@trybe) e mostre para a sua rede toda a sua evolução.



# Requisitos



## 1 - Crie uma função que verifica palíndromos



  Implemente a função verifyPalindrome que confere se uma palavra é um palíndromo ou não 



- A função `verifyPalindrome` recebe como parâmetro uma `string` e deve retornar `true` se essa `string` for um palíndromo ou `false` se não for.

- Um palíndromo é uma palavra, frase ou sequência de caracteres que pode ser lida da mesma forma, seja da esquerda para a direita ou da direita para a esquerda, mantendo a mesma sequência de caracteres. Caso queira aprofundar, [veja a definição aqui](https://pt.wikipedia.org/wiki/Pal%C3%ADndromo).



> **Para refletir 💭**: como você faria para verificar se uma palavra é igual a inversão dela mesma?



> **De olho na dica 👀**: com do loop `for`, você pode percorrer a string de trás para frente, começando do último caractere e indo até o primeiro.



  O que será testado 



- A função `verifyPalindrome` deve retornar `true` quando receber a string `'arara'`;



- A função `verifyPalindrome` deve retornar `false` quando receber a string `'desenvolvimento'`.



## 2 - Crie uma função que retorne o índice do maior valor



  Implemente a função getHighestIndex que retornará o índice do maior número em um array 



- A função `getHighestIndex` recebe como parâmetro um `array` de inteiros, não repetidos, e deve retornar o índice do array, em formato de número, onde se encontra o maior valor desse `array`.



> **Atenção ⚠️:** o requisito pede o **index**, não o número.



  O que será testado 



- A função `getHighestIndex` deve retornar `4` quando receber o array `[2, 3, 6, 7, 10, 1]`;



- A função `getHighestIndex` deve retornar `0` quando receber o array `[9, 1, 3, 5, 7]`;



- A função `getHighestIndex` deve retornar `1` quando receber o array `[-9, -1, -3, -5, -7]`.



## 3 - Crie uma função que retorne o índice do menor valor



  Implemente a função getSmallestIndex que retornará o índice do menor número em um array 



- A função `getSmallestIndex` recebe como parâmetro um `array` de inteiros, não repetidos, e deve retornar o índice do array, em formato de número, onde se encontra o menor valor desse `array`.



> **Atenção ⚠️:** o requisito pede o **index**, não o número.



  O que será testado 



- A função `getSmallestIndex` deve retornar `5` quando receber o array `[2, 3, 6, 7, 10, 1]`;



- A função `getSmallestIndex` deve retornar `6` quando receber o array `[2, 4, 6, 7, 10, 0, -3]`.



## 4 - Crie uma função que retorna a maior palavra



  Implemente a função getLongestWord que retornará a maior palavra em um array 



- A função `getLongestWord` recebe como parâmetro um `array` de `strings`, não repetidas, e deve retornar a palavra com a maior quantidade de caracteres.



  O que será testado 



- A função `getLongestWord` deve retornar `Fernanda` quando receber o array `['José', 'Lucas', 'Nádia', 'Fernanda', 'Cairo', 'Joana']`;



- A função `getLongestWord` deve retornar `JavaScript` quando receber o array `['JavaScript', 'HTML', 'CSS', 'GitHub', 'Unix']`;



## 5 - Crie uma função que calcula o número de repetições do maior número



  

Implemente a função countHighestNumberMaxOccurrences que deverá retornar a quantidade de vezes que o maior número se repete ao receber um array de números. 



A função `countHighestNumberMaxOccurrences` deve retornar a quantidade de vezes que o **maior** número se repete dentro do array. Por exemplo:



Caso o parâmetro seja um array com valores `[9, 1, 2, 3, 9, 5, 7]`, a função deverá retornar `2`, que é a quantidade de vezes que o número `9`  — maior número do array — se repete.



  O que será testado 



- A função `countHighestNumberMaxOccurrences` deve retornar `2` quando receber o parâmetro `[9, 1, 2, 3, 9, 5, 7]`;



- A função `countHighestNumberMaxOccurrences` deve retornar `1` quando receber o parâmetro `[0, 4, 4, 4, 9, 2, 1]`;



- A função `countHighestNumberMaxOccurrences` deve retornar `3` quando receber o parâmetro `[0, 0, 0]`.