AIDE SUR LES NœUDS

Prettier - NPM (Comment ça marche pour les développeurs)

Publié octobre 24, 2024
Partager:

Dans le développement moderne de logiciels, le maintien d'un style de codage propre et cohérent est crucial pour la lisibilité et la collaboration, ainsi que pour la maintenabilité. Des outils commePlus joli les outils d'aide à la traduction, tels que les outils d'aide à l'écriture et les outils d'aide à la rédaction, avec une icône TypeScript indiquant les déclarations de type intégrées, sont devenus des aides indispensables dans cette quête, en automatisant la tâche souvent fastidieuse du formatage du code. Dans cet article, nous nous penchons sur les subtilités de Prettier, en explorant ses fonctionnalités, ses avantages, ses intégrations et ses meilleures pratiques. Nous nous pencherons également sur laIronPDFBibliothèque de génération de PDF pour générer des PDF à partir d'URL de sites web.

Introduction à Prettier

Prettier est un formateur de code qui ajuste automatiquement le style et le formatage de votre code en fonction de règles prédéfinies telles que la longueur maximale des lignes. Il prend en charge divers langages de programmation, notamment JavaScript, TypeScript, HTML, CSS, JSON et bien d'autres, ce qui le rend polyvalent pour les différentes piles technologiques et les différents types de projets. Développé à l'origine par James Long, Prettier a gagné une traction significative dans la communauté des développeurs pour ses capacités robustes et sa facilité d'utilisation.

Principales caractéristiques et avantages

  1. Style de code cohérent : Prettier applique un style de codage cohérent à l'ensemble de votre base de code, éliminant ainsi les débats sur les préférences de formatage et garantissant l'uniformité de l'apparence du code, ce qui permet d'accélérer le processus de révision du code.

  2. Formatage automatique : En s'intégrant à votre éditeur de code ou à votre processus de construction, Prettier formate automatiquement votre code, y compris le code d'habillage, etc., au fur et à mesure que vous le tapez ou avant les validations, ce qui permet aux développeurs d'économiser du temps et des efforts. Vous pouvez configurer ce formateur de code avec opinion pour qu'il s'exécute sur un code sauvegardé. La traduction doit être appliquée uniquement dans le même répertoire que le code source.
  3. Configurabilité : Bien que Prettier soit orienté opinion par défaut, il offre un certain degré de configurabilité permettant d'ajuster certaines règles de formatage pour répondre aux exigences spécifiques d'un projet. L'utilisateur peut configurer ses propres règles.

  4. Prise en charge des langues : Il prend en charge un large éventail de langages de programmation et de formats dès sa sortie de l'emballage, ce qui garantit sa compatibilité avec divers environnements de développement.5. Qualité du code : L'amélioration de la lisibilité du code permet une meilleure compréhension et réduit la probabilité d'erreurs de syntaxe ou de bogues causés par un formatage incohérent.

Premiers pas avec Prettier

Installation

Pour commencer à utiliser Prettier dans vos projets, vous pouvez l'installer via NPM ou yarn :

npm install prettier --save-dev
npm install prettier --save-dev
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'npm install prettier --save-dev
VB   C#

ou

yarn add --dev prettier // installs latest version
yarn add --dev prettier // installs latest version
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'yarn add --dev prettier ' installs latest version
VB   C#

Utilisation

  • Interface en ligne de commande(CLI)** : Prettier est un outil CLI qui permet de formater des fichiers manuellement ou de les intégrer dans des scripts pour des tâches de formatage automatisées.
  • Intégration des éditeurs : Des plugins sont disponibles pour les éditeurs les plus courants tels que Visual Studio Code, Sublime Text, Atom et d'autres, permettant un formatage en temps réel au fur et à mesure de la saisie.
  • Git Hooks : Configurez Prettier pour qu'il s'exécute avant les commits à l'aide des Git Hooks afin de garantir que toutes les modifications du code respectent les règles de formatage définies.

Intégrations et écosystème

Prettier s'intègre parfaitement à divers outils de développement et flux de travail, ce qui renforce son utilité et son adoption par les développeurs :

  • plugins IDE** : Ils s'intègrent aux IDE et aux éditeurs de texte pour formater le code à la volée, ce qui améliore la productivité des développeurs et permet de respecter les normes de codage.
  • Systèmes de construction : Incorporation dans les pipelines de construction et l'intégration continue(CI) la traduction doit rester professionnelle, en préservant la précision technique tout en expliquant les caractéristiques et les avantages de ces outils de développement.
  • Contrôle de version : Fonctionne harmonieusement avec les systèmes de contrôle de version tels que Git, garantissant que le code formaté est maintenu de manière cohérente tout au long de la collaboration.

Meilleures pratiques pour Prettier

Pour maximiser les avantages de Prettier et garantir une intégration harmonieuse dans votre flux de travail de développement, tenez compte des meilleures pratiques suivantes :

  • Utiliser les paramètres par défaut : Adoptez les paramètres par défaut de Prettier pour favoriser la cohérence de votre base de code sans personnalisation inutile.
  • Versioning : Mettez régulièrement Prettier à jour pour bénéficier de nouvelles fonctionnalités, de corrections de bugs et d'une meilleure prise en charge des langues.
  • Configuration : Affiner la configuration de Prettier pour s'aligner sur les conventions spécifiques au projet ou les préférences de l'équipe tout en maintenant la cohérence.
  • Éduquer et adopter : Encouragez les membres de l'équipe à adopter Prettier et informez-les de ses avantages afin de favoriser une approche unifiée de la mise en forme du code.

Introduction à IronPDF

Prettier - NPM(Comment ça marche pour les développeurs) : Figure 1 - IronPDF

IronPDF est une bibliothèque populaire de génération de PDF utilisée pour générer, éditer et convertir des documents PDF. Le package IronPDF NPM est spécifiquement conçu pour les applications Node.js. Voici quelques caractéristiques et détails clés concernant le paquetage NPM IronPDF :

Caractéristiques principales

Conversion de HTML en PDF

Convertissez sans effort du contenu HTML en documents PDF. Cette fonction est particulièrement utile pour générer des PDF dynamiques à partir de contenus web.

Conversion d'URL en PDF

Générez des PDF directement à partir d'URL, ce qui vous permet de capturer le contenu de pages web et de les enregistrer sous forme de fichiers PDF de manière programmatique.

Manipulation des PDF

Fusionnez, divisez et manipulez facilement des documents PDF existants. IronPDF offre des fonctionnalités telles que l'ajout de pages, la division de documents, etc.

Sécurité PDF

Sécurisez vos documents PDF en les chiffrant avec des mots de passe ou en appliquant des signatures numériques. IronPDF propose des options pour protéger vos documents sensibles contre les accès non autorisés.

Sortie de haute qualité

Produisez des documents PDF de haute qualité avec un rendu précis du texte, des images et de la mise en forme. IronPDF veille à ce que les PDF générés restent fidèles au contenu original.

Compatibilité multiplateforme

IronPDF est compatible avec diverses plateformes, notamment Windows, Linux et macOS, ce qui le rend adapté à un large éventail d'environnements de développement.

Intégration simple

Intégrez facilement IronPDF à vos applications Node.js à l'aide de son package npm. L'API est bien documentée, ce qui facilite l'intégration des capacités de génération de PDF dans vos projets.

Installation

Pour installer le paquetage NPM IronPDF, utilisez la commande suivante :

yarn add @ironsoftware/ironpdf @ironsoftware/ironpdf-engine-windows-x64
yarn add @ironsoftware/ironpdf @ironsoftware/ironpdf-engine-windows-x64
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

Générer un document PDF à l'aide d'IronPDF et utiliser le package NPM Prettier

Installer les dépendances : Tout d'abord, créez un nouveau projet Next.js(si vous ne l'avez pas encore fait) à l'aide de la commande suivante : Référerici.

npx create-next-app@latest prettier-pdf --use-npm --example "https://github.com/vercel/next-learn/tree/main/basics/learn-starter"
npx create-next-app@latest prettier-pdf --use-npm --example "https://github.com/vercel/next-learn/tree/main/basics/learn-starter"
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'npx create-@next-app@latest prettier-pdf --use-npm --example "https://github.com/vercel/next-learn/tree/main/basics/learn-starter"
VB   C#

Ensuite, accédez au répertoire de votre projet :

cd prettier-pdf
cd prettier-pdf
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'cd prettier-pdf
VB   C#

Installez les paquets nécessaires :

yarn add @ironsoftware/ironpdf @ironsoftware/ironpdf-engine-windows-x64
yarn add -D prettier
yarn add @ironsoftware/ironpdf @ironsoftware/ironpdf-engine-windows-x64
yarn add -D prettier
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'yarn add @ironsoftware/ironpdf @ironsoftware/ironpdf-engine-windows-x64 yarn add -D prettier
VB   C#

Créez un fichier de configuration vide pour indiquer aux éditeurs et autres outils que vous utilisez Prettier :

node --eval "fs.writeFileSync('.prettierrc','{}\n')"
node --eval "fs.writeFileSync('.prettierrc','{}\n')"
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'node --eval "fs.writeFileSync('.prettierrc','{}" + vbLf + "')"
VB   C#

Créer un.prettierignore fichier de formatage pour indiquer à l'interface de programmation Prettier et aux éditeurs quels sont les fichiers à ne pas formater. Voici un exemple ci-dessous :

# Ignore artifacts:
build
coverage
# Ignore all HTML files:
**/*.html
# Ignore artifacts:
build
coverage
# Ignore all HTML files:
**/*.html
#Ignore artifacts:
#Ignore all HTML files:
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'build coverage **/ *.html
VB   C#

Créer un PDF

Maintenant, créons un exemple simple de génération d'un PDF à l'aide d'IronPDF.

API de génération de PDF : La première étape consiste à créer une API pour générer le document PDF. Comme IronPDF ne fonctionne que côté serveur, nous devons créer une API à appeler lorsqu'un utilisateur souhaite générer un PDF. Créez un fichier dans le chemin pages/api/pdf.js et ajoutez le contenu ci-dessous.

IronPDF nécessite une clé de licence, vous pouvez l'obtenir à partir de la pagepage de licence et le placer dans le code ci-dessous.

// pages/api/pdf.js
import {IronPdfGlobalConfig, PdfDocument} from "@ironsoftware/ironpdf";
// Apply your IronPDF license key
IronPdfGlobalConfig.getConfig().licenseKey = "Your license key";
export default async function handler(req, res) {
    try {
        const url = req.query.url
        const pdf = await PdfDocument.fromUrl(url);
        const data = await pdf.saveAsBuffer();
        console.error('data PDF:', data);
        res.setHeader('Content-Type', 'application/pdf');
        res.setHeader('Content-Disposition', 'attachment; filename=awesomeIron.pdf');
        res.send(data);
    } catch (error) {
        console.error('Error generating PDF:', error);
        res.status(500).end();
    }
}
// pages/api/pdf.js
import {IronPdfGlobalConfig, PdfDocument} from "@ironsoftware/ironpdf";
// Apply your IronPDF license key
IronPdfGlobalConfig.getConfig().licenseKey = "Your license key";
export default async function handler(req, res) {
    try {
        const url = req.query.url
        const pdf = await PdfDocument.fromUrl(url);
        const data = await pdf.saveAsBuffer();
        console.error('data PDF:', data);
        res.setHeader('Content-Type', 'application/pdf');
        res.setHeader('Content-Disposition', 'attachment; filename=awesomeIron.pdf');
        res.send(data);
    } catch (error) {
        console.error('Error generating PDF:', error);
        res.status(500).end();
    }
}
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

Modifiez maintenant le code index.js comme ci-dessous pour utiliser Prettier et IronPDF.

import Head from 'next/head';
import styles from '../styles/Home.module.css';
import React, { useState } from 'react';
export default function PrettierDemo() {
    const [text, setText] = useState("");
    const generatePdf = async () => {
        try {
            const response = await fetch('/api/pdf?url='+text);
            const blob = await response.blob();
            const url = window.URL.createObjectURL(new Blob([blob]));
            const link = document.createElement('a');
            link.href = url;
            link.setAttribute('download', 'awesomeIron.pdf');
            document.body.appendChild(link);
            link.click();
            link.parentNode.removeChild(link);
        } catch (error) {
            console.error('Error generating PDF:', error);
        }
    };
    const handleChange = (event) => {
      setText(event.target.value);
    }
    return (
        <div className={styles.container}>
            <Head>
                <title>Generate PDF Using IronPDF</title>
                <link rel="icon" href="/favicon.ico"/>
            </Head>
            <main>
                <h1>Demo Prettier and Generate PDF Using IronPDF</h1>
                <p>
                    <span>Enter Url To Convert to PDF:</span>{" "}
                </p>
                <button style={{margin:20, padding:5}} onClick={generatePdf}>Generate PDF</button>
            </main>          
            <style jsx>{`
                main {
                    padding: 5rem 0;
                    flex: 1;
                    display: flex;
                    flex-direction: column;
                    justify-content: center;
                    align-items: center;
                }
                footer {
                    width: 100%;
                    height: 100px;
                    border-top: 1px solid #eaeaea;
                    display: flex;
                    justify-content: center;
                    align-items: center;
                }
                footer img {
                    margin-left: 0.5rem;
                }
                footer a {
                    display: flex;
                    justify-content: center;
                    align-items: center;
                    text-decoration: none;
                    color: inherit;
                }
                code {
                    background: #fafafa;
                    border-radius: 5px;
                    padding: 0.75rem;
                    font-size: 1.1rem;
                    font-family: Menlo,
                    Monaco,
                    Lucida Console,
                    Liberation Mono,
                    DejaVu Sans Mono,
                    Bitstream Vera Sans Mono,
                    Courier New,
                    monospace;
                }
            `}</style>
            <style jsx global>{`
                html,
                body {
                    padding: 0;
                    margin: 0;
                    font-family: -apple-system,
                    BlinkMacSystemFont,
                    Segoe UI,
                    Roboto,
                    Oxygen,
                    Ubuntu,
                    Cantarell,
                    Fira Sans,
                    Droid Sans,
                    Helvetica Neue,
                    sans-serif;
                }
                * {
                    box-sizing: border-box;
                }
            `}</style>
        </div>
    );
}
import Head from 'next/head';
import styles from '../styles/Home.module.css';
import React, { useState } from 'react';
export default function PrettierDemo() {
    const [text, setText] = useState("");
    const generatePdf = async () => {
        try {
            const response = await fetch('/api/pdf?url='+text);
            const blob = await response.blob();
            const url = window.URL.createObjectURL(new Blob([blob]));
            const link = document.createElement('a');
            link.href = url;
            link.setAttribute('download', 'awesomeIron.pdf');
            document.body.appendChild(link);
            link.click();
            link.parentNode.removeChild(link);
        } catch (error) {
            console.error('Error generating PDF:', error);
        }
    };
    const handleChange = (event) => {
      setText(event.target.value);
    }
    return (
        <div className={styles.container}>
            <Head>
                <title>Generate PDF Using IronPDF</title>
                <link rel="icon" href="/favicon.ico"/>
            </Head>
            <main>
                <h1>Demo Prettier and Generate PDF Using IronPDF</h1>
                <p>
                    <span>Enter Url To Convert to PDF:</span>{" "}
                </p>
                <button style={{margin:20, padding:5}} onClick={generatePdf}>Generate PDF</button>
            </main>          
            <style jsx>{`
                main {
                    padding: 5rem 0;
                    flex: 1;
                    display: flex;
                    flex-direction: column;
                    justify-content: center;
                    align-items: center;
                }
                footer {
                    width: 100%;
                    height: 100px;
                    border-top: 1px solid #eaeaea;
                    display: flex;
                    justify-content: center;
                    align-items: center;
                }
                footer img {
                    margin-left: 0.5rem;
                }
                footer a {
                    display: flex;
                    justify-content: center;
                    align-items: center;
                    text-decoration: none;
                    color: inherit;
                }
                code {
                    background: #fafafa;
                    border-radius: 5px;
                    padding: 0.75rem;
                    font-size: 1.1rem;
                    font-family: Menlo,
                    Monaco,
                    Lucida Console,
                    Liberation Mono,
                    DejaVu Sans Mono,
                    Bitstream Vera Sans Mono,
                    Courier New,
                    monospace;
                }
            `}</style>
            <style jsx global>{`
                html,
                body {
                    padding: 0;
                    margin: 0;
                    font-family: -apple-system,
                    BlinkMacSystemFont,
                    Segoe UI,
                    Roboto,
                    Oxygen,
                    Ubuntu,
                    Cantarell,
                    Fira Sans,
                    Droid Sans,
                    Helvetica Neue,
                    sans-serif;
                }
                * {
                    box-sizing: border-box;
                }
            `}</style>
        </div>
    );
}
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'import Head from '@next/head'; import styles from '../styles/Home.@module.css'; import React, { useState } from 'react'; export default @function PrettierDemo() { const [text, setText] = useState(""); const generatePdf = async() => { try { const response = await fetch('/api/System.Nullable<pdf>url='+text); const blob = await response.blob(); const url = window.URL.createObjectURL(New Blob([blob])); const link = document.createElement("a"c); link.href = url; link.setAttribute('download', 'awesomeIron.pdf'); document.body.appendChild(link); link.click(); link.parentNode.removeChild(link); } catch(@error) { console.@error('@Error generating PDF:', @error); } }; const handleChange = (event) => { setText(event.target.value); } Return(<div className={styles.container}> <Head> <title> Generate PDF @Using IronPDF</title> <link rel="icon" href="/favicon.ico"/> </Head> <main> <h1> Demo Prettier @and Generate PDF @Using IronPDF</h1> <p> <span> Enter Url @To Convert @to PDF:</span>{" "} </p> <button style={{margin:20, padding:5}} onClick={generatePdf}> Generate PDF</button> </main> <style jsx>{` main { padding: 5rem 0; flex: 1; display: flex; flex-direction: column; justify-content: center; align-items: center; } footer { width: 100%; height: 100px; border-top: 1px solid #eaeaea; display: flex; justify-content: center; align-items: center; } footer img { margin-left: 0.5rem; } footer a { display: flex; justify-content: center; align-items: center; text-decoration: none; color: inherit; } code { background: #fafafa; border-radius: 5px; padding: 0.75rem; font-size: 1.1rem; font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier @New, monospace; } `}</style> <style jsx global>{` html, body { padding: 0; margin: 0; font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif; } * { box-sizing: border-box; } `}</style> </div>); }
VB   C#

Formatez le code en utilisant yarn prettier.

yarn prettier . --write
yarn prettier . --write
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'yarn prettier. --write
VB   C#

Prettier - NPM(Comment ça marche pour les développeurs) : Figure 2 - Exécuter Prettier

Exécutez maintenant l'application en utilisant la commande :

yarn dev
yarn dev
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'yarn dev
VB   C#

Sortie

Prettier - NPM(Comment ça marche pour les développeurs) : Figure 3 - Prettier avec sortie IronPDF

PDF (EN ANGLAIS)

Prettier - NPM(Comment ça marche pour les développeurs) : Figure 4 - Sortie PDF

Licence d'IronPDF

IronPDF Le paquet npm s'exécute sur la clé de licence. IronPDF offre un service deessai gratuit afin de permettre aux utilisateurs de vérifier ses nombreuses fonctionnalités avant de l'acheter.

Placez la clé de licence ici :

import {IronPdfGlobalConfig, PdfDocument} from "@ironsoftware/ironpdf";
// Apply your IronPDF license key
IronPdfGlobalConfig.getConfig().licenseKey = "Add Your key here";
import {IronPdfGlobalConfig, PdfDocument} from "@ironsoftware/ironpdf";
// Apply your IronPDF license key
IronPdfGlobalConfig.getConfig().licenseKey = "Add Your key here";
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

Conclusion

Prettier est un outil essentiel du développement logiciel moderne, qui rationalise le formatage du code avec précision et efficacité. Sa capacité à appliquer des styles de codage cohérents dans différents langages et à s'intégrer de manière transparente dans les flux de travail existants le rend indispensable pour les équipes qui s'efforcent d'obtenir des bases de code propres et faciles à maintenir. En automatisant les tâches de formatage du code, Prettier permet aux développeurs de se concentrer davantage sur l'écriture d'un code de qualité et moins sur les détails stylistiques ou la révision du code, améliorant ainsi la productivité et la collaboration dans les projets logiciels. Adoptez Prettier pour améliorer la qualité du style de votre code et rationaliser votre processus de développement dès aujourd'hui.

IronPDF permet aux développeurs Node.js d'élever les capacités de traitement des PDF au sein de leurs applications, en offrant des fonctionnalités, une fiabilité et des performances inégalées. En tirant parti des fonctions avancées d'IronPDF pour la génération, la conversion et la manipulation de PDF, les développeurs peuvent rationaliser les flux de travail des documents, améliorer l'expérience des utilisateurs et répondre en toute confiance à diverses exigences commerciales. Adoptez IronPDF pour libérer tout le potentiel de la gestion des PDF dans vos projets Node.js et fournir des solutions documentaires de qualité professionnelle sans effort.

< PRÉCÉDENT
oauth2orize NPM (Comment ça marche pour les développeurs)
SUIVANT >
rxjs NPM (Comment ça marche pour les développeurs)

Prêt à commencer ? Version : 2024.11 vient de paraître

Installation gratuite de npm Voir les licences > ;