CLI SBF - Algortimo de busca

@eduardo/sbf-cli é uma linha de comando que busca em um plano definido as três lojas mais proximas de um cliente SBF.

Tecnologias

O CLI SBF utiliza as seguintes tecnologias:

• Jest - Utilizado para criação dos testes unitários
• Inquirer - Utilizado para gerenciar o uma boa interface CLI no node.js
• Arg - Utilizado para gerenciar o uma boa interface de argumentos CLI com alias e outras funcionalidades comuns a CLI's do mercado
• node.js - Runtime de JavaScript criado em cima da V8 com libs C++ escolhido para implementar o teste

Instalação

@eduardo/sbf-cli requer o Node.js v10+ para ser executado.

Para executar localmente

Clone o projeto via git

git clone https://github.com/Eduardo-Queiroz/sbf-cli

Instale as dependencias e as devDependencies.

npm i

ou

yarn add

Para instalar o pacote npm

npm i @eduardo/sbf-cli
ou
yarn add @eduardo/sbf-cli

Para instalar o pacote local

npm link

Uso

Para executar o CLI use os 3 argementos obrigatorios como exemplificado abaixo.

sbf start -p [100,100] -c [20,30] -s [[40,88],[99,2],[18,56],[18,90]]

Argumentos

--plan

Plano total onde será executada a busca interpretada pelos valores da latitude e longitude.

Para executar localmente utilize o comando

yarn start --plan [20,30]

Para executar a partir do CLI linkado ao contexto global do npm utilize o comando

sbf start --plan [20,30]

Você tambem poderá definir esse argumento pelo alias -p

--client

Esse argumento é a posição atual do cliente interpretada pelos valores da latitude e longitude.

Para executar localmente utilize o comando

yarn start --client [20,30]

Para executar a partir do CLI linkado ao contexto global do npm utilize o comando

sbf start --client [20,30]

Você tambem poderá definir esse argumento pelo alias -c

--store

Esse argumento são as posições das lojas dentro de um plano pré definido ele é interpretado por um array de valores de latitude e longitude.

Para executar localmente utilize o comando

yarn start --store [[40,88],[99,2],[18,56],[18,90]]

Para executar a partir do CLI linkado ao contexto global do npm utilize o comando

sbf start --store  [[40,88],[99,2],[18,56],[18,90]]

Você tambem poderá definir esse argumento pelo alias -s

Testes unitarios

Os teste unitarios só podem ser utilizados localmente pelo comando:

yarn run test

Lint

O lint pode ser executado pelo comando:

yarn run lint

License

MIT

Eduardo Queiroz ([email protected])