diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29c9fdf..4b1954d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,10 @@ __Requerimientos:__ - Node v16 o superior __[descargar node](https://nodejs.org/es/download/)__ -- __[Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)__ como gestor de paquetes. En el link conseguiras las intrucciones para instalar yarn. -- __[VSCode](https://code.visualstudio.com/download)__ (recomendado): Editor de codigo con plugins -- __[Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits&ssr=false#overview)__ (plugin-vscode) este plugin te ayudara a crear commit semantico. -- Se usara la rama __dev__ *(https://github.com/leifermendez/bot-whatsapp/tree/dev)* como rama principal hasta que se haga oficialmente el lanzamiento de la V2 +- __[Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)__ como gestor de paquetes. En el link conseguirás las intrucciones para instalar yarn. +- __[VSCode](https://code.visualstudio.com/download)__ (recomendado): Editor de código con plugins. +- __[Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits&ssr=false#overview)__ (plugin-vscode) este plugin te ayudará a crear commit semántico. +- Se usará la rama __dev__ *(https://github.com/leifermendez/bot-whatsapp/tree/dev)* como rama principal hasta que se haga oficialmente el lanzamiento de la V2. ### 🚀 Iniciando @@ -22,14 +22,14 @@ yarn install ``` __Compilar (build)__ -Para compilar la aplicación es necesario ejecutar, eso te genera dentro de packages del monorepo un directorio `lib` +Para compilar la aplicación es necesario ejecutar este comando, el cual genera un directorio `lib` dentro de los paquetes del monorepo. ``` yarn build ``` __Example-app__ -Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un app-bot de ejemplo +Se ejecuta el CLI (Command Line Interface) para ayudarte a crear un app-bot de ejemplo. ``` yarn run cli ``` @@ -42,15 +42,16 @@ npm run pre-copy npm start ``` -__Commit y Push__ -El proyecto tiene implementado __[husky](https://typicode.github.io/husky/#/)__ es una herramienta que dispara unas acciones al momento de hacer commit y hacer push +### __Commit y Push__ -__commit:__ Los commit son semanticos esto quiere decir que deben cumplir un standar al momento de escribirlos ejemplo ` feat(adapter): new adapter myqsl ` puede ver más info sobre esto __[aquí](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)__ +El proyecto tiene implementado __[husky](https://typicode.github.io/husky/#/)__, es una herramienta que dispara unas acciones al momento de hacer commit y hacer push. -__push:__ Cada push ejecutar `yarn run test` el cual ejecuta los test internos que tienen que cumplir con __95% de cobertura__. +__commit:__ Los commit son semánticos, esto quiere decir que deben cumplir un standar al momento de escribirlos ejemplo: ` feat(adapter): new adapter myqsl ` puede ver más info sobre esto __[aquí](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)__ + +__push:__ Cada push ejecutar `yarn run test` el cual realiza los test internos que tienen que cumplir con __95% de cobertura__. -> Documento en constaten actualización.... +> Documento en constante actualización.... ------ - [Discord](https://link.codigoencasa.com/DISCORD) diff --git a/packages/bot/core/core.class.js b/packages/bot/core/core.class.js index f7726c8..e04bd13 100644 --- a/packages/bot/core/core.class.js +++ b/packages/bot/core/core.class.js @@ -34,16 +34,16 @@ class CoreClass { listenerBusEvents = () => [ { event: 'preinit', - func: () => printer('Iniciando provider espere...'), + func: () => printer('Iniciando proveedor, espere...'), }, { event: 'require_action', - func: ({ instructions, title = '⚡⚡ ACCION REQUERIDA ⚡⚡' }) => + func: ({ instructions, title = '⚡⚡ ACCIÓN REQUERIDA ⚡⚡' }) => printer(instructions, title), }, { event: 'ready', - func: () => printer('Provider conectado y listo'), + func: () => printer('Proveedor conectado y listo'), }, { event: 'auth_failure', diff --git a/packages/cli/check/index.js b/packages/cli/check/index.js index ec4f235..73d5924 100644 --- a/packages/cli/check/index.js +++ b/packages/cli/check/index.js @@ -12,20 +12,20 @@ const checkNodeVersion = () => { ) process.exit(1) } - console.log(green(`Node.js combatible ${version}`)) + console.log(green(`Node.js compatible ${version}`)) console.log(``) } const checkOs = () => { - console.log(bgCyan('🙂 Revisando tu Sistema Operativo')) + console.log(bgCyan('🙂 Revisando tu sistema operativo')) const os = process.platform if (!os.includes('win32')) { const messages = [ `El sistema operativo actual (${os}) posiblemente requiera`, - `una confiuración adicional referente al puppeter`, + `una configuración adicional referente al puppeteer`, ``, `Recuerda pasar por el WIKI`, - `🔗 https://github.com/leifermendez/bot-whatsapp/wiki/Instalaci%C3%B3n`, + `🔗 https://github.com/leifermendez/bot-whatsapp/wiki/Instalación`, ``, ] diff --git a/packages/cli/install/tool.js b/packages/cli/install/tool.js index 6ec176c..8095cd0 100644 --- a/packages/cli/install/tool.js +++ b/packages/cli/install/tool.js @@ -14,7 +14,7 @@ const getPkgManage = async () => { } const installDeps = (pkgManager, packageList) => { - const errorMessage = `Ocurrio un error instalando ${packageList}` + const errorMessage = `Ocurrió un error instalando ${packageList}` let childProcess = [] const installSingle = (pkgInstall) => () => { diff --git a/packages/cli/interactive/index.js b/packages/cli/interactive/index.js index a251ea7..7bfb7bd 100644 --- a/packages/cli/interactive/index.js +++ b/packages/cli/interactive/index.js @@ -12,43 +12,43 @@ const startInteractive = async () => { type: 'text', name: 'exampeOpt', message: - 'Quieres crear una app de ejemplo "example-app-example"? (Y/n)', + '¿Quieres crear una app de ejemplo "example-app-example"? (Y/n)', }, // { // type: 'text', // name: 'dependencies', // message: - // 'Quieres actualizar las librerias "whatsapp-web.js"? (Y/n)', + // '¿Quieres actualizar las librerías "whatsapp-web.js"? (Y/n)', // }, { type: 'text', name: 'cleanTmp', - message: 'Quieres limpiar la session del bot? (Y/n)', + message: '¿Quieres limpiar la sesión del bot? (Y/n)', }, { type: 'multiselect', name: 'providerWs', - message: 'Proveedor de Whatsapp', + message: '¿Cuál proveedor de whatsapp quieres utilizar?', choices: [ { title: 'whatsapp-web.js', value: 'whatsapp-web.js' }, { title: 'API Oficial (Meta)', value: 'meta', disabled: true }, { title: 'Twilio', value: 'twilio', disabled: true }, ], max: 1, - hint: 'Espacio para selecionar', + hint: 'Espacio para seleccionar', instructions: '↑/↓', }, { type: 'multiselect', name: 'providerDb', - message: 'Cual base de datos quieres usar', + message: '¿Cuál base de datos quieres utilizar?', choices: [ { title: 'JSONFile', value: 'json' }, { title: 'MySQL', value: 'mysql', disabled: true }, { title: 'Mongo', value: 'mongo', disabled: true }, ], max: 1, - hint: 'Espacio para selecionar', + hint: 'Espacio para seleccionar', instructions: '↑/↓', }, ] @@ -57,7 +57,7 @@ const startInteractive = async () => { checkNodeVersion() checkOs() const onCancel = () => { - console.log('Proceso cancelado!') + console.log('¡Proceso cancelado!') return true } const response = await prompts(questions, { onCancel }) @@ -110,12 +110,12 @@ const startInteractive = async () => { if (!providerWs.length) { console.log( red( - `Debes de seleccionar una WS Provider. Tecla [Space] para seleccionar` + `Debes seleccionar un proveedor de whatsapp. Tecla [Space] para seleccionar` ) ) process.exit(1) } - console.log(yellow(`'Deberia crer una carpeta en root/provider'`)) + console.log(yellow(`'Debería crear una carpeta en root/provider'`)) return true } @@ -124,13 +124,13 @@ const startInteractive = async () => { if (!providerDb.length) { console.log( red( - `Debes de seleccionar una DB Provider. Tecla [Space] para seleccionar` + `Debes seleccionar un proveedor de base de datos. Tecla [Space] para seleccionar` ) ) process.exit(1) } if (answer === 'json') { - console.log('Deberia crer una carpeta en root/data') + console.log('Debería crear una carpeta en root/data') return 1 } } diff --git a/packages/create-bot-whatsapp/index.js b/packages/create-bot-whatsapp/index.js index 7df7d03..7eb2862 100644 --- a/packages/create-bot-whatsapp/index.js +++ b/packages/create-bot-whatsapp/index.js @@ -4,8 +4,8 @@ const main = () => { console.clear() console.log(``) - console.log(`[PostInstall]: Este es el main function.`) - console.log(`[PostInstall]: 👌 Aqui podrias instalar cosas`) + console.log(`[PostInstall]: Esta es la 'main function'.`) + console.log(`[PostInstall]: 👌 Aquí podrías instalar cosas`) console.log(``) } diff --git a/scripts/move.js b/scripts/move.js index 5a0d8b6..d92d233 100644 --- a/scripts/move.js +++ b/scripts/move.js @@ -15,4 +15,4 @@ Promise.all([ copyLibPkg('bot', appDir), copyLibPkg('database', appDir), copyLibPkg('provider', appDir), -]).then(() => console.log('Todas las lib copiadas')) +]).then(() => console.log('Todas las librerías copiadas'))