Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 3.21 KB

1_iniciando.md

File metadata and controls

90 lines (59 loc) · 3.21 KB

Iniciando:

Vamos iniciar com um novo projeto criando uma pasta e usando o comando npm init

mkdir muda-texto # cria a pasta do nosso modulo
cd muda-texto # entra na pasta
npm init -y # cria o arquivo package.json

Imagem exibindo o passo a passo de criar uma pasta e depois criar um arquivo package.json usando o comando npm init

Os comandos são registrados na configuração "bin" do arquivo package.json do modulo.

Vamos criar um comando simples que vai exibir o texto "Walter White" no terminal usando o comando say-my-name

1- Primeiro precisamos registrar o arquivo que vai conter o código do nosso comando no package.json na configuração bin
{
  "name": "teste",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",

  "bin": {
    "say-my-name": "bin/say-my-name.js"
  }
}
2- Para ficar mais coerente vamos usar a pasta bin com o nome do arquivo say-my-name.js:

Crie a pasta bin e um novo arquivo com nome say-my-name.js na pasta atual do projeto.

O conteúdo do arquivo bin/say-my-name.js vai ser:

#! /usr/bin/env node

console.log('Walter White');

A primeira linha indica que esse arquivo será executável com o node.js

3- Deixando o comando disponível em todos os terminais / consoles

Para deixa o comando disponível em todos os terminais ele precisa estar instalado ou linkado no contexto global.

Já que estamos desenvolvendo nossa aplicação vamos linkar ela no contexto global com o comando npm link rodado na pasta do modulo (mesma pasta do package.json):

npm link 

OBS_1: Pode ser nescessário o uso de sudo dependendo da sua configuração do node.js OBS_2: Uma outra forma é instalar o modulo como um global usando o argumento -g no comando npm install -g mas recomendo só usar esse recurso com modulos desenvolvidos.

4- Rodando

Agora o comando say-my-name vai estar disponível no seu terminal. Exemplo:

Imagem mostrando o uso do comando say-my-name

+informação

  • Você pode ver os dados relacionados ao comando em execução com o console.log(process)
  • Os argumentos do comando executado ficam disponíveis na variável process.argv (vamos usar um modulo para trata-los no curso)
  • O console.log envia textos para o terminal e aceita formatações ex: \n para pular linha ou \t para identação (tab)

Próximo conteúdo do curso:

Link: Criando um comando para alterar textos

Links e referências:

Próximo conteúdo

https://github.com/albertosouza/mini-cursos/blob/master/cli/2_1_comando_alterar_texto.md