🔳 👩🏼‍💻 👴🏾 Pacotes populares de npm. Volume 1 ↔️ 🧑🏾 🧑🏽‍🤝‍🧑🏼

Bom dia amigos!

Apresento a sua atenção uma seleção de dez pacotes npm populares com exemplos de seu uso e soluções alternativas.

Presume-se que você esteja familiarizado com JavaScript e, em particular, com o Node.js.

Esta parte apresenta os seguintes pacotes:

giz

Downloads semanais: 58 milhões

Objetivo: formatar mensagens exibidas no terminal.

Exemplo de uso.

Instale o pacote: fio adicionar giz ou npm i giz.

Crie o arquivo giz.js:

const chalk = require("chalk");
const log = console.log;

log(
	chalk.red("  \n") +
	chalk.green("  \n") +
	chalk.blue("  ")
);

//  
const os = require("os");

log(`
	Total memory: ${chalk.blue(os.totalmem())} bytes
	Free memory: ${chalk.green(os.freemem())} bytes
	Memory used: ${chalk.red(os.totalmem() - os.freemem())} bytes
`);

//   
const v8 = require("v8");

const {
	total_heap_size: total,
	used_heap_size: used,
	heap_size_limit: limit,
} = v8.getHeapStatistics();

log(chalk`
	Heap Size Limit: {rgb(0, 0, 255) ${limit}}
	Total Heap Size: {hex('#008000') ${total}}
	Used Heap Size: {red ${used}}
`);

Execute o script: node giz.js.

Alternativa: sequências de escape:

console.log(
	"[31m%s[0m[32m%s[0m[34m%s[0m",
	"  \n",
	"  \n",
	"  "
);

progresso

Downloads semanais: 13 milhões

Objetivo: Indicador de progresso do "terminal" (caracteres ASCII).

Exemplo de uso.

Instale o pacote: yarn add progress.

Crie o arquivo progress.js:

const ProgressBar = require("progress");

const bar = new ProgressBar(":bar", { total: 10 });
const timer = setInterval(() => {
	bar.tick();
	if (bar.complete) {
		console.log("\n");
		clearInterval(timer);
	}
}, 200);

Execute o script: node progress.js

Mais um exemplo:

const ProgressBar = require("progress");
const https = require("https");

const req = https.request({
	host: "example.com",
	port: 443,
	path: "/filename.ext",
});

req.on("response", (res) => {
	const len = parseInt(res.headers["content-length"], 10);

	console.log();

	const bar = new ProgressBar(
		"   [:bar] :rate/bps :percent :etas",
		{
			complete: "=",
			incomplete: " ",
			width: 20,
			total: len,
		}
	);

	res.on("data", (chunk) => {
		bar.tick(chunk.length);
	});

	res.on("end", () => {
		console.log("\n");
	});
});

req.end();

minimista

Downloads semanais: 35 milhões

Objetivo: analisar os argumentos passados pelo terminal.

Exemplo de uso.

Instale o pacote: yarn add minimist.

Crie o arquivo minimist.js:

const args = require("minimist")(process.argv.slice(2));
console.log(args);
console.log(args._);
console.log(args.a);

Execute o script: node script.js foo bar baz -x 1 -y2 --z = 3 -a

fs-extra

Downloads semanais: 32 milhões

Objetivo: métodos adicionais para trabalhar com o sistema de arquivos (extensão fs).

Métodos básicos:

copiar - copiar arquivos
emptyDir - limpa o diretório. Se o diretório não existir, ele será criado
garantirFile - determinar se um arquivo existe. Se for feita uma solicitação para criar um arquivo em diretórios que não existem, eles serão criados
assegureDir é o mesmo para um diretório. Aliases - mkdirs, mkdirp
mover - mover um arquivo ou diretório
outputFile - semelhante a fs.writeFile, exceto que, se ausente, um diretório pai é criado
outputJson - semelhante a fs.writeJson, exceto que, se ausente, um diretório pai é criado
readJson - lê um arquivo JSON e converte-o em um objeto
remove - remove um arquivo ou diretório
writeJson - escrever um objeto em um arquivo JSON

Os métodos fornecidos são assíncronos, existem suas contrapartes síncronas (com o prefixo "Sync").

Os métodos podem ser usados com retornos de chamada, promessas e async / await. Vou usar promessas.

const fs = require("fs-extra");

// copy
fs.copy("/old-file", "/dir/new-file")
	.then(() => {
		console.log("!");
	})
	.catch((err) => {
		console.error(err);
	});

// emptyDir
fs.emptyDir("/some/empty/dir")
	.then(() => {
		console.log("!");
	})
	.catch((err) => {
		console.error(err);
	});

// ensureFile
const file = "/this/path/does/not/exist/file.txt";

fs.ensureFile(file)
	.then(() => {
		console.log("!");
	})
	.catch((err) => {
		console.error(err);
	});

// move
const src = "/dir/file.txt";
const dest = "/dir/this/path/does/not/exist/file.txt";

fs.move(src, dest)
	.then(() => {
		console.log("!");
	})
	.catch((err) => {
		console.error(err);
	});

// outputFile
const file = "/this/path/does/not/exist/file.txt";
fs.outputFile(file, "!")
	.then(() => fs.readFile(file, "utf8"))
	.then((data) => {
		console.log(data); // => !
	})
	.catch((err) => {
		console.error(err);
	});

// readJson
fs.readJson("/data.json")
	.then((obj) => {
		console.log(obj.someKey); // => some value
	})
	.catch((err) => {
		console.error(err);
	});

// remove
fs.remove("/dir/file")
	.then(() => {
		console.log("!");
	})
	.catch((err) => {
		console.error(err);
	});

// writeJson
fs.writeJson("/data.json", { someKey: "some value" })
	.then(() => {
		console.log("!");
	})
	.catch((err) => {
		console.error(err);
	});

uuid

Downloads semanais: 36 milhões.

Objetivo: Gerar um identificador exclusivo.

Exemplo de uso.

Vamos criar um servidor usando express que retorna um ID quando solicitado pelo cliente.

Instale uuid, express e cors: yarn add uuid express cors.

Crie um arquivo uuid.js:

const express = require("express");
const cors = require("cors");

const { v4: uuidv4 } = require("uuid");

const app = express();
app.use(cors());

app.use("/getId", (_, res) => {
	//  
	const id = uuidv4();
	//   
	res.json(id);
});

app.listen(process.env.PORT || 3000, () => console.log("server ready"));

Iniciamos o servidor: node uuid.js.

Crie o arquivo index.html:

<body>
	<input type="text" />
	<button>add</button>
	<ul></ul>

	<script>
		const button = document.querySelector("button");
		const input = document.querySelector("input");
		const list = document.querySelector("ul");

		button.addEventListener("click", async () => {
			//  
			const res = await fetch("http://localhost:3000/getId");
			const id = await res.json();

			const value = input.value;

			if (value.trim() !== "") {
				list.insertAdjacentHTML(
					"beforeend",
					//  
					`<li data-id=${id}>${value}</li>`
				);
			}
		});

		input.value = ", , ...";
		button.click();
	</script>
</body>

Abra index.html em um navegador.

Como alternativa, em aplicativos simples, você pode usar o método Date.now (), que retorna o número de milissegundos desde 1º de janeiro de 1970:

const id1 = Date.now();
console.log(id1); // 1601905165758
console.log(typeof id1); // number

const id2 = Date.now().toString().slice(-4);
console.log(id2); // 5758

momento

Downloads semanais: 14 milhões

Finalidade: Formatação de data e hora.

Exemplo de uso.

const moment = require("moment");

console.log(
	`
		${moment().format()}
		${moment().format("DD.MM.YYYY H:m")}
	`
);
/*
	2020-10-05T19:16:38+05:00
	05.10.2020 19:16
*/

moment.locale("ru");

console.log(moment().format("dddd, Do MMMM Y"));
// , 5-  2020

Alternativa: Construtores Date e Intl.DateTimeFormat.

const date = new Date();

const options = {
	day: "numeric",
	month: "long",
	year: "numeric",
};

console.log(date.toLocaleString("ru", options));
// 5  2020 .

options.weekday = "long";
options.hour = "numeric";
options.minute = "numeric";

console.log(
	new Intl.DateTimeFormat("ru", options).format(date)
); // , 5  2020 ., 19:42

Moment está atualmente descontinuado.

axios

Downloads semanais: 12 milhões

Objetivo: Envio de solicitações HTTP. Funciona em Node.js e navegador.

Exemplo de uso.

Instale o pacote: yarn add axios.

Crie o arquivo axios.js:

// GET
const axios = require("axios");

(async () => {
	try {
		const res = await axios.get(
			"https://jsonplaceholder.typicode.com/users"
		);
		console.table(res.data);
	} catch (er) {
		console.error(er);
	}
})();

Execute o arquivo: node axios.js.

// POST
axios
	.post("/user", {
		firstName: "Harry",
		lastName: "Heman",
	})
	.then((res) => {
		console.log(res);
	})
	.catch((er) => {
		console.error(er);
	});

Implementação de uma solicitação GET em Node.js "puro":

const https = require("https");

https
	.get("https://jsonplaceholder.typicode.com/users", (res) => {
		let data = "";

		res.on("data", (chunk) => {
			data += chunk;
		});

		res.on("end", () => {
			console.table(JSON.parse(data));
		});
	})
	.on("error", (er) => {
		console.error(er.message);
	});

No navegador, você pode usar a API Fetch:

;(async () => {
	await fetch("http://example.com/user", {
		method: "POST",
		mode: "no-cors",
		body: JSON.stringify({
			firstName: "Harry",
			lastName: "Heman",
		}),
	});
})();

Na web, você pode encontrar uma menção a outro pacote para enviar solicitações HTTP - solicitação, mas ele está atualmente obsoleto.

assíncrono

Downloads semanais: 31 milhões

Objetivo: utilitário para trabalhar com código assíncrono. Funciona em Node.js e navegador.

Exemplo de uso.

Instale o pacote: yarn add async.

Crie 3 arquivos (nome -> conteúdo): arquivo1.txt -> foo, arquivo2.txt -> bar, arquivo3.txt -> baz qux.

Crie o arquivo async.js:

const async = require("async");
const fs = require("fs");

const ext = "txt";
const file = (name) => `${__dirname}/${name}.${ext}`;

//   
async.map(
	[file("file1"), file("file2"), file("file3")],
	fs.stat,
	(er, results) => {
		if (er) console.error(er);

		console.log(results.map((item) => item.size));
	}
); // [ 3, 3, 7 ]

//   
async.map(
	[file("file1"), file("file2"), file("file3")],
	fs.readFile,
	(er, results) => {
		if (er) console.error(er);

		console.log(results.map((item) => item.toString()));
	}
); // [ 'foo', 'bar', 'baz qux' ]

//    
const timer1 = () => setTimeout(() => console.log("foo"), 300);
const timer2 = () => setTimeout(() => console.log("bar"), 100);
const timer3 = () => setTimeout(() => console.log("baz"), 200);
const asyncFuntions = [timer1, timer2, timer3];

async.parallel(asyncFuntions, (er, res) => {
	console.log(res);
}); // bar baz foo

//    
async.series(asyncFuntions, (_, res) => console.log(res));
// foo

//    
const add1 = (n, cb) => setTimeout(() => cb(null, n + 1), 100);
const sub2 = (n, cb) => setTimeout(() => cb(null, n - 2), 200);
const mult3 = (n, cb) => setTimeout(() => cb(null, n * 3), 300);

const composed = async.compose(add1, sub2, mult3);
// mult3 -> sub2 -> add1
composed(4, (_, res) => console.log(res)); // 11

dotenv

Downloads semanais:

12M Objetivo: Carregar variáveis de ambiente do arquivo ".env" para process.env.

Exemplo de uso.

Vamos simular uma conexão com o MongoDB Cloud.

Instale o pacote: yarn add dotenv.

Crie um arquivo ".env":

// <usename>, <password>  <dbname>  
MONGODB=mongodb+srv://<username>:<password>@cluster0.p7jbn.mongodb.net/<dbname>?retryWrites=true&w=majority

Crie um arquivo "dotenv.js":

//  dotenv
require("dotenv/config");

//  mongoose
const mongoose = require("mongoose");

// process.env.MONGODB -   "MONGODB"   ".env"
mongoose.connect(process.env.MONGODB, {
	useNewUrlParser: true,
	useUnifiedTopology: true,
});

Alternativamente, você pode usar config .

Instale o pacote: yarn add config.

Crie o arquivo config.json:

{
	"mongoDB": "mongodb+srv://<username>:<password>@cluster0.p7jbn.mongodb.net/<dbname>?retryWrites=true&w=majority"
}

Crie o arquivo config.js:

//  config
const config = require("config");

//  mongoose
const mongoose = require("mongoose");

// config.get("mongoDB") -    "mongoDB"  "config"   "config.json"
mongoose.connect(config.get("mongoDB"), {
	useNewUrlParser: true,
	useUnifiedTopology: true,
}, () => console.log("Connected to database"));

validador

Downloads semanais: 4 milhões

Objetivo: uma biblioteca para validação e neutralização de dados transmitidos em strings.

Exemplo de uso.

Vamos implementar o envio do formulário e a validação de dados no servidor.

Instale o pacote: yarn add validator.

Crie o arquivo index.html:

<head>
	<title>Form Validation</title>
	<style>
		label,
		span {
			display: block;
			margin: .5rem;
		}
	</style>
</head>
<body>
	<form>
		<label>Name: <input type="text" value="Igor" data-name="name" /></label>
		<label>Age: <input type="number" value="30" data-name="age" /></label>
		<label
			>Email:
			<input type="email" value="myemail.example.com" data-name="email"
		/></label>
		<label
			>Site: <input type="url" value="myblog.org" data-name="url"
		/></label>
		<label
			>Card: <input type="text" value="1111222233334444" data-name="card"
		/></label>
		<button>Send</button>
		<p></p>
	</form>

	<script>
		const form = document.querySelector("form");
		//    
		const btn = form.querySelector("button");
		//    
		const log = form.querySelector("p");

		//       
		const getValue = (name) =>
			form.querySelector(`[data-name=${name}]`).value;

		btn.addEventListener("click", (e) => {
			e.preventDefault();

			//    
			const data = {
				name: getValue("name"),
				age: getValue("age"),
				email: getValue("email"),
				url: getValue("url"),
				card: getValue("card"),
			};

			//   
			const sendData = async (url) => {
				const req = await fetch(url, {
					method: "POST",
					headers: {
						"Content-Type": "application/json",
					},
					body: JSON.stringify(data),
				});

				//      
				const res = await req.json();

				console.log(res);

				//    
				if (res.length !== 0) {
					let html = "";
					for (const msg of res) {
						html += `<span>${msg}</span>`;
						log.innerHTML = html;
					}
				} else {
						log.textContent = 'Success'
					}
			};

			sendData("http://localhost:3000/users");
		});
	</script>

Crie o arquivo validator.js:

const express = require("express");
const cors = require("cors");

//  ,   
// escape -   
const {
	isAlpha,
	isNumeric,
	isEmail,
	isURL,
	isCreditCard,
	escape,
} = require("validator");

//    
const validators = [isAlpha, isNumeric, isEmail, isURL, isCreditCard];

const app = express();
app.use(cors());
app.use(express.json());

//   
app.use("/users", (req, res) => {
	//   
	const data = ({ name, age, email, url, card } = req.body);

	console.log(data);

	//   
	const errors = [];

	//  
	for (let i = 0; i < validators.length; i++) {
		//  
		escape(Object.values(data)[i]);

		//     
		//       
		if (!validators[i](Object.values(data)[i])) {
			errors.push(`Wrong ${Object.keys(data)[i]}`);
		}
	}

	console.log(errors);

	//   
	res.json(errors);
});

app.listen(process.env.PORT || 3000, () => console.log("Server ready"));

Iniciamos o servidor: node validator.js.

Abra index.html e envie os dados.

Recebemos uma mensagem informando que o endereço de e-mail e o número do cartão de crédito são inválidos.

Vamos alterar os valores de e-mail e cartão para myemail@example.com e 2222111111111111, respectivamente.

Clique em "Enviar".

Recebemos uma mensagem sobre a validação de dados bem-sucedida.

Isso é tudo por hoje. Espero que você tenha encontrado algo útil. Obrigado pela atenção.

Pacotes populares de npm. Volume 1

More articles: