nodecfdi
@nodecfdi/prettier-config
La libreria
@nodecfdi/prettier-configexporta la configuración base para Prettier usada en los proyectos de NodeCfdi.
:us: The documentation of this project is in spanish as this is the natural language for intended audience.
:mexico: La documentación del proyecto está en español porque ese es el lenguaje principal de los usuarios.
Instalación
NPM
npm i -D prettier @nodecfdi/prettier-configYarn
yarn add -D prettier @nodecfdi/prettier-configPNPM
pnpm add -D prettier @nodecfdi/prettier-configUso básico
Para habilitar estás reglas, puedes simplemente agregar la propiedad prettier en tu package.json y referenciar está configuración compartida como se muestra a continuación:
Para la configuración base:
{
///...
"prettier": "@nodecfdi/prettier-config"
}Ó bien, la configuracion para librerias:
{
///...
"prettier": "@nodecfdi/prettier-config/pkg"
}Si deseas ajustar algúna regla o habilitar alguna no incluida, puedes extender de está configuración pero no puedes hacerlo en el package.json en su lugar crea un archivo JS. Y exporta las modificaciones por ejemplo:
// prettier.config.js, .prettierrc.js, prettier.config.mjs, or .prettierrc.mjs
import nodecfdiPrettierConfig from '@nodecfdi/prettier-config';
export default {
...nodecfdiPrettierConfig,
printWidth: 120,
};Soporte
Puedes obtener soporte abriendo un ticket en Github.
Adicionalmente, esta librería pertenece a la comunidad OcelotlStudio, así que puedes usar los mismos canales de comunicación para obtener ayuda de algún miembro de la comunidad.
Compatibilidad
Esta librería se mantendrá compatible con al menos la versión con soporte activo de Node más reciente y soporte activo de Typescript más reciente.
También utilizamos Versionado Semántico 2.0.0 por lo que puedes usar esta librería sin temor a romper tu aplicación.
Contribuciones
Las contribuciones con bienvenidas. Por favor lee CONTRIBUTING para más detalles y recuerda revisar el archivo CHANGELOG.
Copyright and License
The @nodecfdi/prettier-config library is copyright © NodeCfdi - OcelotlStudio and licensed for use under the MIT License (MIT). Please see LICENSE for more information.