From f198a9ff0c082dda670768571b4d77df7fc51457 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20Beltr=C3=A1n?= Date: Tue, 8 Aug 2023 20:13:26 +0200 Subject: [PATCH] fix: update `lorem-ipsum` dependency (#19) * Update README.md * Update lorem-ipsum dependency * Update package.json --- README.md | 70 ++++++++++++++++---------------------------------- package.json | 6 ++--- pnpm-lock.yaml | 19 +++++++------- 3 files changed, 35 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 1872589..5dffe0c 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,51 @@ -# 🐘 Mastodonte JS +# 🐘 Mastodonte -Mastodonte JS es un generador de palabras para los mastodontes, cracks y figuras como tú. +`mastodonte` es un generador de palabras para los mastodontes, cracks y figuras como tú. -Esta librería es simplemente un lorem ipsum pero usando las palabras adecuadas para los máquinas, genios y artistas. De hecho, Mastodonte JS está construido sobre [lorem-ipsum.js](https://github.com/knicklabs/lorem-ipsum.js), así que puedes leer su documentación para saber más sobre las opciones disponibles. +Esta librería es simplemente un lorem ipsum pero usando las palabras adecuadas para los máquinas, genios y artistas. De hecho, `mastodonte` está construido sobre [lorem-ipsum.js](https://github.com/knicklabs/lorem-ipsum.js), así que puedes leer su documentación para saber más sobre las opciones disponibles. ## Instalación -**npm** +**pnpm** +```shell +pnpm add -D mastodonte ``` -npm install mastodonte + +**npm** + +```shell +npm install -D mastodonte ``` **yarn** -``` -yarn add mastodonte +```shell +yarn add -D mastodonte ``` ## Usando la clase Mastodonte (recomendada) -``` -import { Mastodonte } from "mastodonte"; -// const Mastodonte = require("mastodonte").Mastodonte; +```js +import { Mastodonte } from 'mastodonte' -const mastodonteIpsum = new Mastodonte(); +const mastodonteIpsum = new Mastodonte() -mastodonteIpsum.generateWords(1); -mastodonteIpsum.generateSentences(5); -mastodonteIpsum.generateParagraphs(7); +mastodonteIpsum.generateWords(1) +mastodonteIpsum.generateSentences(5) +mastodonteIpsum.generateParagraphs(7) ``` > Recuerda que puedes usar las mismas opciones disponibles en [lorem-ipsum](https://github.com/knicklabs/lorem-ipsum.js#using-the-class) ## Usando la función mastodonte -``` -import { mastodonte } from "mastodonte"; -// const mastodonte = require("mastodonte").mastodonte; +```js +import { mastodonte } from 'mastodonte' -mastodonte(); // genera una frase por defecto +mastodonte() // genera una frase por defecto ``` > Recuerda que puedes usar las mismas opciones disponibles en [lorem-ipsum](https://github.com/knicklabs/lorem-ipsum.js#using-the-function) - ---- - -## TSDX Bootstrap - -This project was bootstrapped with [TSDX](https://github.com/jaredpalmer/tsdx). - -## Local Development - -Below is a list of commands you will probably find useful. - -### `npm start` or `yarn start` - -Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab. - - - -Your library will be rebuilt if you make edits. - -### `npm run build` or `yarn build` - -Bundles the package to the `dist` folder. -The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module). - - - -### `npm test` or `yarn test` - -Runs the test watcher (Jest) in an interactive mode. -By default, runs tests related to files changed since the last commit. diff --git a/package.json b/package.json index 52b4617..c5a4824 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "mastodonte", "version": "0.0.0-semantically-released", - "description": "🐘 Mastodonte JS - un generador de palabras para los mastodontes, cracks y figuras como tú.", + "description": "🐘 mastodonte - un generador de palabras para los mastodontes, cracks y figuras como tú.", "type": "module", "scripts": { "build": "tsup", @@ -20,7 +20,7 @@ "semantic-release": "semantic-release" }, "dependencies": { - "lorem-ipsum": "^2.0.3" + "lorem-ipsum": "^2.0.8" }, "devDependencies": { "@swc/core": "^1.3.74", @@ -84,6 +84,6 @@ }, "homepage": "https://github.com/Belco90/mastodonte-js", "bugs": { - "url": "https://github.com/testing-library/eslint-plugin-testing-library/issues" + "url": "https://github.com/Belco90/mastodonte-js/issues" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 68c633f..c23e45c 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -6,8 +6,8 @@ settings: dependencies: lorem-ipsum: - specifier: ^2.0.3 - version: 2.0.3 + specifier: ^2.0.8 + version: 2.0.8 devDependencies: '@swc/core': @@ -2187,15 +2187,16 @@ packages: engines: {node: '>=14'} dev: true - /commander@2.20.3: - resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} - dev: false - /commander@4.1.1: resolution: {integrity: sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==} engines: {node: '>= 6'} dev: true + /commander@9.5.0: + resolution: {integrity: sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==} + engines: {node: ^12.20.0 || >=14} + dev: false + /compare-func@2.0.0: resolution: {integrity: sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==} dependencies: @@ -4316,12 +4317,12 @@ packages: wrap-ansi: 6.2.0 dev: true - /lorem-ipsum@2.0.3: - resolution: {integrity: sha512-CX2r84DMWjW/DWiuzicTI9aRaJPAw2cvAGMJYZh/nx12OkTGqloj8y8FU0S8ZkKwOdqhfxEA6Ly8CW2P6Yxjwg==} + /lorem-ipsum@2.0.8: + resolution: {integrity: sha512-5RIwHuCb979RASgCJH0VKERn9cQo/+NcAi2BMe9ddj+gp7hujl6BI+qdOG4nVsLDpwWEJwTVYXNKP6BGgbcoGA==} engines: {node: '>= 8.x', npm: '>= 5.x'} hasBin: true dependencies: - commander: 2.20.3 + commander: 9.5.0 dev: false /lru-cache@5.1.1: