Skip to content

Commit

Permalink
feat: Inclui cheatsheet para npm
Browse files Browse the repository at this point in the history
  • Loading branch information
cleytonoliveira committed Jun 11, 2021
1 parent 836ccfb commit 1240a9d
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Repositório de *cheat sheets* para consultas rápidas.
- **Backend**
- **MongoDB**
- [MongoDB - Aggregration](backend/mongodb/mongodb_aggregation/README.md)
- **Node.js**
- [NPM - Comandos](backend/nodejs/npm/README.md)
- **Sequelize**
- [Sequelize - Setup](backend/sequelize/setup/README.md)
- [Sequelize - Queries](backend/sequelize/queries/README.md)
Expand Down
176 changes: 176 additions & 0 deletions backend/nodejs/npm/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
# NPM Comandos Cheat Sheet

# Sumário

- [Comandos `npm`](#comandos-npm)
- [Criar novo pacote Node.js](#criar-novo-pacote-nodejs)
- [Cria o arquivo `package.json` personalizado](#cria-o-arquivo-packagejson-personalizado)
- [Cria o arquivo `package.json` padrão](#cria-o-arquivo-packagejson-padrão)
- [Instalar pacotes no Node.js](#instalar-pacotes-no-nodejs)
- [Instala **todas** as depedências do arquivo `package.json`](#instala-todas-as-depedências-do-arquivo-packagejson)
- [Instala o **pacote desejado** nas depedências do arquivo `package.json`](#instala-o-pacote-desejado-nas-depedências-do-arquivo-packagejson)
- [Instala o **pacote desejado** nas depedências de **desenvolvimento** do arquivo `package.json`](#instala-o-pacote-desejado-nas-depedências-de-desenvolvimento-do-arquivo-packagejson)
- [Remover pacotes no Node.js](#remover-pacotes-no-nodejs)
- [Remove o **pacote desejado** das depedências do arquivo `package.json`](#remove-o-pacote-desejado-das-depedências-do-arquivo-packagejson)
- [Criar scripts no arquivo `package.json`](#criar-scripts-no-arquivo-packagejson)
- [Cria script para iniciar a **aplicação principal**](#cria-script-para-iniciar-a-aplicação-principal)
- [Cria **script personalizado** para o pacote desejado](#cria-script-personalizado-para-o-pacote-desejado)
- [Executar scripts do arquivo `package.json`](#executar-scripts-do-arquivo-packagejson)
- [Executa a **aplicação principal** do pacote que esta criando](#executa-a-aplicação-principal-do-pacote-que-esta-criando)
- [Executa o **script registrado** no arquivo `package.json`](#executa-o-script-registrado-no-arquivo-packagejson)

---

## Criar novo pacote Node.js

---

### Cria o arquivo `package.json` personalizado
```shell
$ npm init
```

### Cria o arquivo `package.json` padrão
```shell
$ npm init -y
```

[Voltar para Sumário](#sumário)

---

## Instalar pacotes no Node.js

---

### Instala **todas** as depedências do arquivo `package.json`
```shell
$ npm install
```

### Instala o **pacote desejado** nas depedências do arquivo `package.json`

**Template**
```shell
$ npm install <package_name>
```

**Exemplo**
```shell
$ npm install express
```

### Instala o **pacote desejado** nas depedências de **desenvolvimento** do arquivo `package.json`

**Template**
```shell
$ npm install <package-name> --save-dev
```
OU
```shell
$ npm install <package-name> -D
```

**Exemplo**
```shell
$ npm install jest --save-dev
```
OU
```shell
$ npm install jest -D
```

[Voltar para Sumário](#sumário)

---

## Remover pacotes no Node.js

---

### Remove o **pacote desejado** das depedências do arquivo `package.json`

**Template**
```shell
$ npm rm <package_name>
```

**Exemplo**
```shell
$ npm rm express
```

[Voltar para Sumário](#sumário)

---

## Criar scripts no arquivo `package.json`

---

### Cria script para iniciar a **aplicação principal**
**Template**
```json
{
"scripts": {
"start": "node nome_do_seu_arquivo.js"
}
}
```

**Exemplo**
```json
{
"scripts": {
"start": "node index.js"
}
}
```

### Cria **script personalizado** para o pacote desejado
**Template**
```json
{
"scripts": {
"nome_do_comando_do_script": "o_que_deseja_executar"
}
}
```
**Exemplo**
```json
{
"scripts": {
"lint": "eslint ."
}
}
```

[Voltar para Sumário](#sumário)

---

## Executar scripts do arquivo `package.json`

---

### Executa a **aplicação principal** do pacote que esta criando

```shell
$ npm start
```

### Executa o **script registrado** no arquivo `package.json`

**Template**
```shell
$ npm run <package-name>
```

**Exemplo**
```shell
$ npm run lint
```

[Voltar para Sumário](#sumário)

---

0 comments on commit 1240a9d

Please sign in to comment.