[{"data":1,"prerenderedAt":1005},["ShallowReactive",2],{"series-\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fgetting-started-with-monorepo-linter-and-formatter":3,"series-context-\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library":778},{"id":4,"title":5,"body":6,"contentId":765,"date":766,"description":767,"extension":768,"github":769,"meetTheInstructor":769,"meta":770,"navigation":452,"part":84,"path":771,"rawbody":772,"robots":769,"schemaOrg":769,"seo":773,"seriesSlug":774,"sitemap":775,"stem":776,"subtitle":769,"topics":769,"__hash__":777},"series\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fgetting-started-with-monorepo-linter-and-formatter.md","Bien démarrer avec un monorepo, un linter et un formatter",{"type":7,"value":8,"toc":760},"minimark",[9,26,34,39,54,67,70,114,121,191,210,219,225,245,252,262,266,274,284,303,322,325,352,357,362,410,427,499,502,517,520,534,538,547,550,623,637,664,671,688,694,717,720,726,729,741,744,753,756],[10,11,12,13,17,18,21,22,25],"p",{},"Dans cette série, nous commencerons depuis zéro. C'est la meilleure façon de comprendre et d'apprendre. Nous allons mettre en place un ",[14,15,16],"strong",{},"monorepo",", configurer un ",[14,19,20],{},"linter"," et un ",[14,23,24],{},"formatter",".",[27,28,31],"callout",{"color":29,"icon":30},"info","i-ph-info-duotone",[10,32,33],{},"Le processus est polyvalent et peut être appliqué à n'importe quel projet, pas seulement à une bibliothèque de composants.",[35,36,38],"h2",{"id":37},"mise-en-place-du-projet","Mise en place du projet",[10,40,41,42,44,45,49,50,53],{},"Un ",[14,43,16],{}," est un dépôt qui abrite plusieurs projets. Dans notre cas, nous aurons le package ",[46,47,48],"code",{},"@barbapapazes\u002Fhuchet-vue",", deux playgrounds et un storybook. L'utilisation d'un monorepo permet de gérer tous ces projets au sein d'un seul dépôt, facilite le partage de code et permet une installation unique des dépendances, maintenant tout synchronisé et compatible. Nous pourrions facilement envisager d'ajouter d'autres packages à l'avenir, comme une configuration personnalisée de ",[14,51,52],{},"Tailwind CSS"," ou une bibliothèque utilitaire partagée.",[10,55,56,57,66],{},"Pour créer un monorepo, nous allons utiliser ",[58,59,63],"a",{"href":60,"rel":61},"https:\u002F\u002Fpnpm.io\u002Fworkspaces",[62],"nofollow",[14,64,65],{},"pnpm workspaces",", une fonctionnalité du gestionnaire de paquets pnpm qui installe les dépendances de manière intelligente, en utilisant des liens durs et des liens symboliques pour économiser de l'espace disque et du temps.",[10,68,69],{},"Tout d'abord, créez un nouveau répertoire et initialisez un nouveau dépôt git :",[71,72,78],"pre",{"className":73,"code":74,"filename":75,"language":76,"meta":77,"style":77},"language-bash shiki shiki-themes github-light github-light github-dark","mkdir huchet-vue && cd huchet-vue && npm init -y\n","terminal","bash","",[46,79,80],{"__ignoreMap":77},[81,82,85,89,93,97,101,103,105,108,111],"span",{"class":83,"line":84},"line",1,[81,86,88],{"class":87},"snPdu","mkdir",[81,90,92],{"class":91},"sIIMD"," huchet-vue",[81,94,96],{"class":95},"sxrX7"," && ",[81,98,100],{"class":99},"sBjJW","cd",[81,102,92],{"class":91},[81,104,96],{"class":95},[81,106,107],{"class":87},"npm",[81,109,110],{"class":91}," init",[81,112,113],{"class":99}," -y\n",[10,115,116,117,120],{},"Ouvrez ce dossier dans votre éditeur de code et modifiez le fichier ",[46,118,119],{},"package.json"," :",[71,122,126],{"className":123,"code":124,"filename":119,"language":125,"meta":77,"style":77},"language-json shiki shiki-themes github-light github-light github-dark","{\n  \"name\": \"huchet-vue\",\n  \"version\": \"0.0.0\",\n  \"type\": \"module\",\n  \"private\": true\n}\n","json",[46,127,128,133,148,161,174,185],{"__ignoreMap":77},[81,129,130],{"class":83,"line":84},[81,131,132],{"class":95},"{\n",[81,134,136,139,142,145],{"class":83,"line":135},2,[81,137,138],{"class":99},"  \"name\"",[81,140,141],{"class":95},": ",[81,143,144],{"class":91},"\"huchet-vue\"",[81,146,147],{"class":95},",\n",[81,149,151,154,156,159],{"class":83,"line":150},3,[81,152,153],{"class":99},"  \"version\"",[81,155,141],{"class":95},[81,157,158],{"class":91},"\"0.0.0\"",[81,160,147],{"class":95},[81,162,164,167,169,172],{"class":83,"line":163},4,[81,165,166],{"class":99},"  \"type\"",[81,168,141],{"class":95},[81,170,171],{"class":91},"\"module\"",[81,173,147],{"class":95},[81,175,177,180,182],{"class":83,"line":176},5,[81,178,179],{"class":99},"  \"private\"",[81,181,141],{"class":95},[81,183,184],{"class":99},"true\n",[81,186,188],{"class":83,"line":187},6,[81,189,190],{"class":95},"}\n",[27,192,193],{"color":29,"icon":30},[10,194,195,196,199,200,203,204,206,207,209],{},"Définir le champ ",[46,197,198],{},"private"," à ",[46,201,202],{},"true"," dans un fichier ",[46,205,119],{}," empêche toute publication accidentelle dans le registre npm. Notre ",[46,208,119],{}," racine est destiné à la gestion du monorepo et non à la publication d'un package.",[10,211,212,213,215,216,218],{},"Ce ",[46,214,119],{}," est le fichier principal pour notre monorepo. Les packages futurs auront chacun leur propre ",[46,217,119],{},". Le fichier principal n'inclura que les dépendances et les scripts ayant un impact sur l'ensemble du monorepo, pas ceux partagés entre les packages.",[10,220,221,222,120],{},"Avant de continuer, ajustez un paramètre de pnpm en créant un fichier ",[46,223,224],{},".npmrc",[71,226,228],{"className":73,"code":227,"filename":119,"language":76,"meta":77,"style":77},"echo \"shamefully-hoist=true\" > .npmrc\n",[46,229,230],{"__ignoreMap":77},[81,231,232,235,238,242],{"class":83,"line":84},[81,233,234],{"class":99},"echo",[81,236,237],{"class":91}," \"shamefully-hoist=true\"",[81,239,241],{"class":240},"s8jYJ"," >",[81,243,244],{"class":91}," .npmrc\n",[10,246,247,248,251],{},"Ce paramètre permet à pnpm de hisser les dépendances vers le dossier ",[46,249,250],{},"node_modules"," racine. Bien que ce ne soit pas par défaut ou recommandé, cela est nécessaire dans notre cas.",[27,253,254],{"color":29,"icon":30},[10,255,256,257,259,260,25],{},"Par défaut, pnpm crée un ",[46,258,250],{}," semi-strict, permettant l'accès aux dépendances non déclarées uniquement depuis ",[46,261,250],{},[35,263,265],{"id":264},"linter-et-formatter","Linter et formatter",[10,267,268,269,21,271,273],{},"Ajouter un ",[14,270,20],{},[14,272,24],{}," garantit que notre code reste propre et cohérent, une exigence fondamentale pour tout projet, surtout une bibliothèque de composants utilisée par d'autres développeurs.",[27,275,276],{"color":29,"icon":30},[10,277,41,278,280,281,283],{},[14,279,24],{}," formate automatiquement votre code selon des règles définies, tandis qu'un ",[14,282,20],{}," analyse le code statiquement pour détecter d'éventuelles erreurs.",[10,285,286,287,294,295,302],{},"Couramment, on utilise ",[58,288,291],{"href":289,"rel":290},"https:\u002F\u002Fprettier.io\u002F",[62],[14,292,293],{},"Prettier"," comme formatter et ",[58,296,299],{"href":297,"rel":298},"https:\u002F\u002Feslint.org\u002F",[62],[14,300,301],{},"ESLint"," comme linter. Les deux ont d'amples plugins et configurations, mais leur intégration peut être complexe. Comme je ne suis pas partisan d'un style de code spécifique, tendre vers le moins de configuration est préférable.",[10,304,305,306,311,312,314,315,25],{},"Pour ce projet, comme pour tous mes projets, nous allons utiliser la configuration ESLint de ",[58,307,310],{"href":308,"rel":309},"https:\u002F\u002Fantfu.me\u002F",[62],"Anthony Fu",". C'est une configuration très affirmée utilisant ",[14,313,301],{}," et ",[58,316,319],{"href":317,"rel":318},"https:\u002F\u002Feslint.style\u002F",[62],[14,320,321],{},"Stylistic",[10,323,324],{},"Installez-le avec une simple commande :",[71,326,328],{"className":73,"code":327,"filename":75,"language":76,"meta":77,"style":77},"npx @antfu\u002Feslint-config@latest && pnpm add -D typescript\n",[46,329,330],{"__ignoreMap":77},[81,331,332,335,338,340,343,346,349],{"class":83,"line":84},[81,333,334],{"class":87},"npx",[81,336,337],{"class":91}," @antfu\u002Feslint-config@latest",[81,339,96],{"class":95},[81,341,342],{"class":87},"pnpm",[81,344,345],{"class":91}," add",[81,347,348],{"class":99}," -D",[81,350,351],{"class":91}," typescript\n",[27,353,354],{"color":29,"icon":30},[10,355,356],{},"Ceux-ci sont installés à la racine du monorepo pour maintenir une source unique de vérité pour le linting et le formatting, une pratique courante dans les monorepos.",[10,358,359,360,120],{},"Ajoutez deux scripts à votre fichier ",[46,361,119],{},[71,363,365],{"className":123,"code":364,"filename":119,"language":125,"meta":77,"style":77},"{\n  \"scripts\": {\n    \"lint\": \"eslint .\",\n    \"lint:fix\": \"eslint --fix .\"\n  }\n}\n",[46,366,367,371,379,391,401,406],{"__ignoreMap":77},[81,368,369],{"class":83,"line":84},[81,370,132],{"class":95},[81,372,373,376],{"class":83,"line":135},[81,374,375],{"class":99},"  \"scripts\"",[81,377,378],{"class":95},": {\n",[81,380,381,384,386,389],{"class":83,"line":150},[81,382,383],{"class":99},"    \"lint\"",[81,385,141],{"class":95},[81,387,388],{"class":91},"\"eslint .\"",[81,390,147],{"class":95},[81,392,393,396,398],{"class":83,"line":163},[81,394,395],{"class":99},"    \"lint:fix\"",[81,397,141],{"class":95},[81,399,400],{"class":91},"\"eslint --fix .\"\n",[81,402,403],{"class":83,"line":176},[81,404,405],{"class":95},"  }\n",[81,407,408],{"class":83,"line":187},[81,409,190],{"class":95},[10,411,412,413,416,417,420,421,424,425,120],{},"Mettez à jour le fichier ",[46,414,415],{},"eslint.config.ts"," pour prendre en charge ",[14,418,419],{},"Vue",", ",[14,422,423],{},"TypeScript",", et ",[14,426,321],{},[71,428,432],{"className":429,"code":430,"filename":415,"language":431,"meta":77,"style":77},"language-typescript shiki shiki-themes github-light github-light github-dark","import antfu from '@antfu\u002Feslint-config'\n\nexport default antfu({\n  stylistic: true,\n  vue: true,\n  typescript: true\n})\n","typescript",[46,433,434,448,454,468,477,486,493],{"__ignoreMap":77},[81,435,436,439,442,445],{"class":83,"line":84},[81,437,438],{"class":240},"import",[81,440,441],{"class":95}," antfu ",[81,443,444],{"class":240},"from",[81,446,447],{"class":91}," '@antfu\u002Feslint-config'\n",[81,449,450],{"class":83,"line":135},[81,451,453],{"emptyLinePlaceholder":452},true,"\n",[81,455,456,459,462,465],{"class":83,"line":150},[81,457,458],{"class":240},"export",[81,460,461],{"class":240}," default",[81,463,464],{"class":87}," antfu",[81,466,467],{"class":95},"({\n",[81,469,470,473,475],{"class":83,"line":163},[81,471,472],{"class":95},"  stylistic: ",[81,474,202],{"class":99},[81,476,147],{"class":95},[81,478,479,482,484],{"class":83,"line":176},[81,480,481],{"class":95},"  vue: ",[81,483,202],{"class":99},[81,485,147],{"class":95},[81,487,488,491],{"class":83,"line":187},[81,489,490],{"class":95},"  typescript: ",[81,492,184],{"class":99},[81,494,496],{"class":83,"line":495},7,[81,497,498],{"class":95},"})\n",[10,500,501],{},"Vous pouvez maintenant linter votre code :",[71,503,505],{"className":73,"code":504,"filename":75,"language":76,"meta":77,"style":77},"pnpm run lint\n",[46,506,507],{"__ignoreMap":77},[81,508,509,511,514],{"class":83,"line":84},[81,510,342],{"class":87},[81,512,513],{"class":91}," run",[81,515,516],{"class":91}," lint\n",[10,518,519],{},"Et corriger automatiquement les problèmes :",[71,521,523],{"className":73,"code":522,"filename":75,"language":76,"meta":77,"style":77},"pnpm run lint:fix\n",[46,524,525],{"__ignoreMap":77},[81,526,527,529,531],{"class":83,"line":84},[81,528,342],{"class":87},[81,530,513],{"class":91},[81,532,533],{"class":91}," lint:fix\n",[35,535,537],{"id":536},"définir-notre-monorepo","Définir notre monorepo",[10,539,540,541,543,544,546],{},"Avec le ",[14,542,20],{}," et le ",[14,545,24],{}," configurés, nous pouvons commencer à définir notre monorepo.",[10,548,549],{},"Nous aurons la structure suivante :",[71,551,556],{"className":552,"code":553,"filename":554,"language":555,"meta":77,"style":77},"language-txt shiki shiki-themes github-light github-light github-dark",".\n├── .histoire\n│   └── package.json\n├── package.json\n├── packages\n│   └── huchet-vue\n│       └── package.json\n└── playground\n    ├── nuxt\n    │   └── package.json\n    └── vue\n        └── package.json\n","Exemple","txt",[46,557,558,563,568,573,578,583,588,593,599,605,611,617],{"__ignoreMap":77},[81,559,560],{"class":83,"line":84},[81,561,562],{},".\n",[81,564,565],{"class":83,"line":135},[81,566,567],{},"├── .histoire\n",[81,569,570],{"class":83,"line":150},[81,571,572],{},"│   └── package.json\n",[81,574,575],{"class":83,"line":163},[81,576,577],{},"├── package.json\n",[81,579,580],{"class":83,"line":176},[81,581,582],{},"├── packages\n",[81,584,585],{"class":83,"line":187},[81,586,587],{},"│   └── huchet-vue\n",[81,589,590],{"class":83,"line":495},[81,591,592],{},"│       └── package.json\n",[81,594,596],{"class":83,"line":595},8,[81,597,598],{},"└── playground\n",[81,600,602],{"class":83,"line":601},9,[81,603,604],{},"    ├── nuxt\n",[81,606,608],{"class":83,"line":607},10,[81,609,610],{},"    │   └── package.json\n",[81,612,614],{"class":83,"line":613},11,[81,615,616],{},"    └── vue\n",[81,618,620],{"class":83,"line":619},12,[81,621,622],{},"        └── package.json\n",[10,624,625,626,629,630,633,634,636],{},"Pour l'instant, créez le dossier ",[46,627,628],{},"packages"," et le package ",[46,631,632],{},"huchet-vue"," avec son fichier ",[46,635,119],{},". D'autres packages seront ajoutés dans les prochains articles de cette série.",[71,638,640],{"className":73,"code":639,"filename":119,"language":76,"meta":77,"style":77},"mkdir -p packages\u002Fhuchet-vue\necho '{\\n\"name\": \"@barbapapazes\u002Fhuchet-vue\",\\n\"type\": \"module\",\\n\"version\": \"0.0.0\"\\n}' > packages\u002Fhuchet-vue\u002Fpackage.json\n",[46,641,642,652],{"__ignoreMap":77},[81,643,644,646,649],{"class":83,"line":84},[81,645,88],{"class":87},[81,647,648],{"class":99}," -p",[81,650,651],{"class":91}," packages\u002Fhuchet-vue\n",[81,653,654,656,659,661],{"class":83,"line":135},[81,655,234],{"class":99},[81,657,658],{"class":91}," '{\\n\"name\": \"@barbapapazes\u002Fhuchet-vue\",\\n\"type\": \"module\",\\n\"version\": \"0.0.0\"\\n}'",[81,660,241],{"class":240},[81,662,663],{"class":91}," packages\u002Fhuchet-vue\u002Fpackage.json\n",[10,665,666,667,670],{},"Avoir deux packages nous permet de les définir dans un fichier ",[46,668,669],{},"pnpm-workspace.yaml"," à la racine de notre monorepo :",[71,672,674],{"className":73,"code":673,"filename":669,"language":76,"meta":77,"style":77},"echo 'packages:\\n  - packages\u002F*' > pnpm-workspace.yaml\n",[46,675,676],{"__ignoreMap":77},[81,677,678,680,683,685],{"class":83,"line":84},[81,679,234],{"class":99},[81,681,682],{"class":91}," 'packages:\\n  - packages\u002F*'",[81,684,241],{"class":240},[81,686,687],{"class":91}," pnpm-workspace.yaml\n",[10,689,690,691,693],{},"Assurez-vous que le fichier ",[46,692,669],{}," ressemble à :",[71,695,699],{"className":696,"code":697,"filename":669,"language":698,"meta":77,"style":77},"language-yaml shiki shiki-themes github-light github-light github-dark","packages:\n  - packages\u002F*\n","yaml",[46,700,701,709],{"__ignoreMap":77},[81,702,703,706],{"class":83,"line":84},[81,704,628],{"class":705},"sovSZ",[81,707,708],{"class":95},":\n",[81,710,711,714],{"class":83,"line":135},[81,712,713],{"class":95},"  - ",[81,715,716],{"class":91},"packages\u002F*\n",[10,718,719],{},"Ce fichier indique à pnpm où trouver les packages dans notre monorepo. Il lie les packages ensemble, évite la duplication, partage les dépendances et facilite l'installation avec une seule commande.",[10,721,722,723,725],{},"Même avec un monorepo, chaque package doit être traité comme un projet autonome, ayant son propre ",[46,724,119],{},", ses dépendances et ses scripts.",[10,727,728],{},"Installez les dépendances depuis la racine du projet :",[71,730,732],{"className":73,"code":731,"filename":119,"language":76,"meta":77,"style":77},"pnpm install\n",[46,733,734],{"__ignoreMap":77},[81,735,736,738],{"class":83,"line":84},[81,737,342],{"class":87},[81,739,740],{"class":91}," install\n",[10,742,743],{},"Vous constaterez que pnpm reconnaît 2 packages :",[71,745,747],{"className":552,"code":746,"filename":554,"language":555,"meta":77,"style":77},"Scope: all 2 workspace projects\n",[46,748,749],{"__ignoreMap":77},[81,750,751],{"class":83,"line":84},[81,752,746],{},[10,754,755],{},"Dans le prochain article, nous créerons notre premier composant dans notre monorepo nouvellement établi.",[757,758,759],"style",{},"html pre.shiki code .snPdu, html code.shiki .snPdu{--shiki-light:#6F42C1;--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sIIMD, html code.shiki .sIIMD{--shiki-light:#032F62;--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sxrX7, html code.shiki .sxrX7{--shiki-light:#24292E;--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sBjJW, html code.shiki .sBjJW{--shiki-light:#005CC5;--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s8jYJ, html code.shiki .s8jYJ{--shiki-light:#D73A49;--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sovSZ, html code.shiki .sovSZ{--shiki-light:#22863A;--shiki-default:#22863A;--shiki-dark:#85E89D}",{"title":77,"searchDepth":135,"depth":135,"links":761},[762,763,764],{"id":37,"depth":135,"text":38},{"id":264,"depth":135,"text":265},{"id":536,"depth":135,"text":537},"bd5d11e9-876b-4ed0-b27b-ba400670de76","2024-11-24","Commencez votre aventure avec le monorepo ! Apprenez à configurer un linter et un formatter pour un codage rationalisé et l'organisation de votre projet.","md",null,{},"\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fgetting-started-with-monorepo-linter-and-formatter","---\ncontentId: bd5d11e9-876b-4ed0-b27b-ba400670de76\npart: 1\ntitle: Bien démarrer avec un monorepo, un linter et un formatter\ndescription: Commencez votre aventure avec le monorepo ! Apprenez à configurer un linter et un formatter pour un codage rationalisé et l'organisation de votre projet.\ndate: 2024-11-24\nseriesSlug: the-complete-guide-to-building-a-vue-js-component-library\n---\n\nDans cette série, nous commencerons depuis zéro. C'est la meilleure façon de comprendre et d'apprendre. Nous allons mettre en place un **monorepo**, configurer un **linter** et un **formatter**.\n\n::callout{icon=\"i-ph-info-duotone\" color=\"info\"}\nLe processus est polyvalent et peut être appliqué à n'importe quel projet, pas seulement à une bibliothèque de composants.\n::\n\n## Mise en place du projet\n\nUn **monorepo** est un dépôt qui abrite plusieurs projets. Dans notre cas, nous aurons le package `@barbapapazes\u002Fhuchet-vue`, deux playgrounds et un storybook. L'utilisation d'un monorepo permet de gérer tous ces projets au sein d'un seul dépôt, facilite le partage de code et permet une installation unique des dépendances, maintenant tout synchronisé et compatible. Nous pourrions facilement envisager d'ajouter d'autres packages à l'avenir, comme une configuration personnalisée de **Tailwind CSS** ou une bibliothèque utilitaire partagée.\n\nPour créer un monorepo, nous allons utiliser [**pnpm workspaces**](https:\u002F\u002Fpnpm.io\u002Fworkspaces), une fonctionnalité du gestionnaire de paquets pnpm qui installe les dépendances de manière intelligente, en utilisant des liens durs et des liens symboliques pour économiser de l'espace disque et du temps.\n\nTout d'abord, créez un nouveau répertoire et initialisez un nouveau dépôt git :\n\n```bash [terminal]\nmkdir huchet-vue && cd huchet-vue && npm init -y\n```\n\nOuvrez ce dossier dans votre éditeur de code et modifiez le fichier `package.json` :\n\n```json [package.json]\n{\n  \"name\": \"huchet-vue\",\n  \"version\": \"0.0.0\",\n  \"type\": \"module\",\n  \"private\": true\n}\n```\n\n::callout{icon=\"i-ph-info-duotone\" color=\"info\"}\nDéfinir le champ `private` à `true` dans un fichier `package.json` empêche toute publication accidentelle dans le registre npm. Notre `package.json` racine est destiné à la gestion du monorepo et non à la publication d'un package.\n::\n\nCe `package.json` est le fichier principal pour notre monorepo. Les packages futurs auront chacun leur propre `package.json`. Le fichier principal n'inclura que les dépendances et les scripts ayant un impact sur l'ensemble du monorepo, pas ceux partagés entre les packages.\n\nAvant de continuer, ajustez un paramètre de pnpm en créant un fichier `.npmrc` :\n\n```bash [package.json]\necho \"shamefully-hoist=true\" > .npmrc\n```\n\nCe paramètre permet à pnpm de hisser les dépendances vers le dossier `node_modules` racine. Bien que ce ne soit pas par défaut ou recommandé, cela est nécessaire dans notre cas.\n\n::callout{icon=\"i-ph-info-duotone\" color=\"info\"}\nPar défaut, pnpm crée un `node_modules` semi-strict, permettant l'accès aux dépendances non déclarées uniquement depuis `node_modules`.\n::\n\n## Linter et formatter\n\nAjouter un **linter** et un **formatter** garantit que notre code reste propre et cohérent, une exigence fondamentale pour tout projet, surtout une bibliothèque de composants utilisée par d'autres développeurs.\n\n::callout{icon=\"i-ph-info-duotone\" color=\"info\"}\nUn **formatter** formate automatiquement votre code selon des règles définies, tandis qu'un **linter** analyse le code statiquement pour détecter d'éventuelles erreurs.\n::\n\nCouramment, on utilise [**Prettier**](https:\u002F\u002Fprettier.io\u002F) comme formatter et [**ESLint**](https:\u002F\u002Feslint.org\u002F) comme linter. Les deux ont d'amples plugins et configurations, mais leur intégration peut être complexe. Comme je ne suis pas partisan d'un style de code spécifique, tendre vers le moins de configuration est préférable.\n\nPour ce projet, comme pour tous mes projets, nous allons utiliser la configuration ESLint de [Anthony Fu](https:\u002F\u002Fantfu.me\u002F). C'est une configuration très affirmée utilisant **ESLint** et [**Stylistic**](https:\u002F\u002Feslint.style\u002F).\n\nInstallez-le avec une simple commande :\n\n```bash [terminal]\nnpx @antfu\u002Feslint-config@latest && pnpm add -D typescript\n```\n\n::callout{icon=\"i-ph-info-duotone\" color=\"info\"}\nCeux-ci sont installés à la racine du monorepo pour maintenir une source unique de vérité pour le linting et le formatting, une pratique courante dans les monorepos.\n::\n\nAjoutez deux scripts à votre fichier `package.json` :\n\n```json [package.json]\n{\n  \"scripts\": {\n    \"lint\": \"eslint .\",\n    \"lint:fix\": \"eslint --fix .\"\n  }\n}\n```\n\nMettez à jour le fichier `eslint.config.ts` pour prendre en charge **Vue**, **TypeScript**, et **Stylistic** :\n\n```typescript [eslint.config.ts]\nimport antfu from '@antfu\u002Feslint-config'\n\nexport default antfu({\n  stylistic: true,\n  vue: true,\n  typescript: true\n})\n```\n\nVous pouvez maintenant linter votre code :\n\n```bash [terminal]\npnpm run lint\n```\n\nEt corriger automatiquement les problèmes :\n\n```bash [terminal]\npnpm run lint:fix\n```\n\n## Définir notre monorepo\n\nAvec le **linter** et le **formatter** configurés, nous pouvons commencer à définir notre monorepo.\n\nNous aurons la structure suivante :\n\n```txt [Exemple]\n.\n├── .histoire\n│   └── package.json\n├── package.json\n├── packages\n│   └── huchet-vue\n│       └── package.json\n└── playground\n    ├── nuxt\n    │   └── package.json\n    └── vue\n        └── package.json\n```\n\nPour l'instant, créez le dossier `packages` et le package `huchet-vue` avec son fichier `package.json`. D'autres packages seront ajoutés dans les prochains articles de cette série.\n\n```bash [package.json]\nmkdir -p packages\u002Fhuchet-vue\necho '{\\n\"name\": \"@barbapapazes\u002Fhuchet-vue\",\\n\"type\": \"module\",\\n\"version\": \"0.0.0\"\\n}' > packages\u002Fhuchet-vue\u002Fpackage.json\n```\n\nAvoir deux packages nous permet de les définir dans un fichier `pnpm-workspace.yaml` à la racine de notre monorepo :\n\n```bash [pnpm-workspace.yaml]\necho 'packages:\\n  - packages\u002F*' > pnpm-workspace.yaml\n```\n\nAssurez-vous que le fichier `pnpm-workspace.yaml` ressemble à :\n\n```yaml [pnpm-workspace.yaml]\npackages:\n  - packages\u002F*\n```\n\nCe fichier indique à pnpm où trouver les packages dans notre monorepo. Il lie les packages ensemble, évite la duplication, partage les dépendances et facilite l'installation avec une seule commande.\n\nMême avec un monorepo, chaque package doit être traité comme un projet autonome, ayant son propre `package.json`, ses dépendances et ses scripts.\n\nInstallez les dépendances depuis la racine du projet :\n\n```bash [package.json]\npnpm install\n```\n\nVous constaterez que pnpm reconnaît 2 packages :\n\n```txt [Exemple]\nScope: all 2 workspace projects\n```\n\nDans le prochain article, nous créerons notre premier composant dans notre monorepo nouvellement établi.\n",{"title":5,"description":767},"the-complete-guide-to-building-a-vue-js-component-library",{"loc":771},"fr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fgetting-started-with-monorepo-linter-and-formatter","B8ZxiKpo02WR3QmG24bW5Xa2rwa2OTOBuDBT0g3dNgk",{"overview":779,"chapters":973},{"id":780,"title":781,"body":782,"contentId":956,"date":766,"description":957,"extension":768,"github":958,"meetTheInstructor":960,"meta":961,"navigation":452,"part":769,"path":962,"rawbody":963,"robots":769,"schemaOrg":769,"seo":964,"seriesSlug":774,"sitemap":965,"stem":966,"subtitle":967,"topics":968,"__hash__":972},"series\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library.md","Guide pour construire une bibliothèque de composants Vue.js",{"type":7,"value":783,"toc":953},[784,787,790,802,806,809,823,826,940,943,947],[10,785,786],{},"Bienvenue ! 👋",[10,788,789],{},"Au départ, cette série était censée être un seul article, mais il est rapidement devenu évident qu'elle serait trop longue. Même GitHub ne voulait pas l'afficher dans l'onglet des fichiers des pull requests. Par conséquent, j'ai décidé de la diviser en plusieurs articles pour la rendre plus digeste et pour me concentrer sur chaque partie individuellement.",[10,791,792,793,797,798],{},"Cette série est en quelque sorte une suite de l'article ",[58,794,796],{"href":795},"\u002Ffr\u002Fposts\u002Fthe-simplest-method-to-create-a-vue-js-component-library","La Méthode la Plus Simple pour Créer une Bibliothèque de Composants Vue.js",", mais elle adopte une approche plus professionnelle. ",[799,800,801],"em",{},"Vous apprendrez comment les bibliothèques de composants les plus populaires sont construites dans les coulisses et comment créer la vôtre.",[803,804],"callout-read-more",{"id":805},"75df6bff-de40-4056-af23-fae2401cd21a",[10,807,808],{},"Bien que ce soit toujours ma méthode préférée lorsque je suis certain de ce que je veux réaliser, j'ai également reçu des retours de lecteurs cherchant un comportement plus personnalisé et nécessitant des fonctionnalités plus complexes.",[10,810,811,812,817,818,25],{},"C'est compréhensible. Bien que ",[58,813,816],{"href":814,"rel":815},"https:\u002F\u002Fgithub.com\u002Funjs\u002Funbuild",[62],"unbuild"," soit un outil puissant, il ne peut égaler la flexibilité, l'écosystème de plugins et l'adoption de ",[58,819,822],{"href":820,"rel":821},"https:\u002F\u002Fvite.dev\u002F",[62],"Vite",[10,824,825],{},"Tout au long de cette série, nous aborderons les sujets suivants :",[827,828,829,840,871,888,905,911,923],"ol",{},[830,831,832,835,836,839],"li",{},[14,833,834],{},"Prise en Main avec Monorepo, Linter et Formatter"," : Nous mettrons en place un monorepo pour gérer notre bibliothèque de composants et tous les outils nécessaires pour garantir une bonne expérience de développement. Nous configurerons également ",[58,837,301],{"href":297,"rel":838},[62]," pour assurer la cohérence du code.",[830,841,842,845,846,420,851,314,855,860,861,314,866,25],{},[14,843,844],{},"Création d'un Premier Composant avec Vue.js et Tailwind CSS"," : Nous créerons notre premier composant avec ",[58,847,850],{"href":848,"rel":849},"https:\u002F\u002Fvuejs.org\u002F",[62],"Vue.js",[58,852,52],{"href":853,"rel":854},"https:\u002F\u002Ftailwindcss.com\u002F",[62],[58,856,859],{"href":857,"rel":858},"https:\u002F\u002Fwww.tailwind-variants.org\u002F",[62],"Tailwind Variants"," en utilisant les techniques les plus avancées et puissantes employées dans des bibliothèques de composants populaires comme ",[58,862,865],{"href":863,"rel":864},"https:\u002F\u002Fwww.radix-vue.com\u002F",[62],"Radix Vue",[58,867,870],{"href":868,"rel":869},"https:\u002F\u002Fui.nuxt.com\u002F",[62],"Nuxt UI",[830,872,873,876,877,881,882,887],{},[14,874,875],{},"Une Meilleure Expérience de Développement avec TypeScript et TSConfig"," : Nous améliorerons notre expérience de développement en ajoutant ",[58,878,423],{"href":879,"rel":880},"https:\u002F\u002Fwww.typescriptlang.org\u002F",[62]," à notre bibliothèque de composants et en configurant ",[58,883,886],{"href":884,"rel":885},"https:\u002F\u002Fwww.typescriptlang.org\u002Ftsconfig",[62],"TSConfig"," pour nous assurer que nos composants sont correctement typés et que nous pouvons tirer pleinement parti des fonctionnalités de TypeScript.",[830,889,890,893,894,314,899,904],{},[14,891,892],{},"Tests Automatiques des Composants avec Vitest et Testing Library"," : Nous écrirons des tests pour nos composants en utilisant ",[58,895,898],{"href":896,"rel":897},"https:\u002F\u002Fvitest.dev\u002Fguide\u002F",[62],"Vitest",[58,900,903],{"href":901,"rel":902},"https:\u002F\u002Ftesting-library.com\u002F",[62],"Testing Library"," pour garantir que nos composants fonctionnent comme prévu. Cela est crucial pour une bibliothèque de composants professionnelle qui reste fiable dans le temps.",[830,906,907,910],{},[14,908,909],{},"Livraison Continue et Confiance dans les Composants"," : Nous établirons un processus d'intégration continue pour garantir que nos composants sont toujours livrés avec confiance. Pour chaque commit de chaque branche, nous exécuterons nos tests pour vérifier que tout fonctionne correctement. Nous établirons également un processus de publication pour publier nos composants sur npm.",[830,912,913,916,917,922],{},[14,914,915],{},"Création d'un Playground et d'un Storybook pour les Composants"," : Nous créerons un playground pour tester nos composants dans un environnement réel et un storybook avec ",[58,918,921],{"href":919,"rel":920},"https:\u002F\u002Fhistoire.dev\u002F",[62],"Histoire"," pour les documenter. Cela nous permettra de partager nos composants avec d'autres développeurs et de les tester dans divers scénarios, tant en isolation qu'en combinaison.",[830,924,925,928,929,21,934,939],{},[14,926,927],{},"Amélioration de l'Intégration avec Unplugin et le Module Nuxt"," : Nous améliorerons l'intégration de notre bibliothèque de composants avec l'écosystème en créant un plugin Vite avec ",[58,930,933],{"href":931,"rel":932},"https:\u002F\u002Fgithub.com\u002Funplugin\u002Funplugin-vue-components",[62],"Unplugin Vue Components",[58,935,938],{"href":936,"rel":937},"https:\u002F\u002Fnuxt.com\u002Fdocs\u002Fguide\u002Fgoing-further\u002Fmodules",[62],"module Nuxt"," pour utiliser nos composants dans une application Nuxt.",[10,941,942],{},"À la fin de cette série, vous aurez une bibliothèque de composants Vue.js complète que vous pourrez utiliser dans vos projets ou partager avec la communauté, comme un développeur professionnel. N'est-ce pas excitant ? 😎",[35,944,946],{"id":945},"chapitres","Chapitres",[948,949],"series-chapters-list",{"className":950},[951,952],"mx-auto","max-w-5xl",{"title":77,"searchDepth":135,"depth":135,"links":954},[955],{"id":945,"depth":135,"text":946},"1fafed86-05bb-4de4-b7d0-bb0bd6abc9d2","Découvrez comment construire une bibliothèque de composants Vue.js en utilisant Vite avec un guide couvrant des techniques de développement web professionnel.",{"name":632,"repository":959},"barbapapazes\u002Fhuchet-vue","J'ai créé cette série parce que j'aime \u003Cstrong>Vue.js\u003C\u002Fstrong> et que, depuis des années, je n'ai pas réussi à trouver un guide complet, à jour et \u003Cstrong>professionnel\u003C\u002Fstrong> sur la façon de construire une bibliothèque de composants Vue.js et que je veux que plus de développeurs de logiciels se sentent capables de créer leur propre bibliothèque.",{},"\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library","---\ncontentId: 1fafed86-05bb-4de4-b7d0-bb0bd6abc9d2\ntitle: Guide pour construire une bibliothèque de composants Vue.js\nsubtitle: Le cours le plus avancé et le plus professionnel pour créer une bibliothèque de composants Vue.js avec Vite.\ndescription: Découvrez comment construire une bibliothèque de composants Vue.js en utilisant Vite avec un guide couvrant des techniques de développement web professionnel.\ndate: 2024-11-24\ntopics:\n  - vue\n  - vite\n  - bibliothèque de composants\ngithub:\n  name: huchet-vue\n  repository: barbapapazes\u002Fhuchet-vue\nmeetTheInstructor: J'ai créé cette série parce que j'aime \u003Cstrong>Vue.js\u003C\u002Fstrong> et que, depuis des années, je n'ai pas réussi à trouver un guide complet, à jour et \u003Cstrong>professionnel\u003C\u002Fstrong> sur la façon de construire une bibliothèque de composants Vue.js et que je veux que plus de développeurs de logiciels se sentent capables de créer leur propre bibliothèque.\nseriesSlug: the-complete-guide-to-building-a-vue-js-component-library\n---\n\nBienvenue ! 👋\n\nAu départ, cette série était censée être un seul article, mais il est rapidement devenu évident qu'elle serait trop longue. Même GitHub ne voulait pas l'afficher dans l'onglet des fichiers des pull requests. Par conséquent, j'ai décidé de la diviser en plusieurs articles pour la rendre plus digeste et pour me concentrer sur chaque partie individuellement.\n\nCette série est en quelque sorte une suite de l'article [La Méthode la Plus Simple pour Créer une Bibliothèque de Composants Vue.js](\u002Ffr\u002Fposts\u002Fthe-simplest-method-to-create-a-vue-js-component-library), mais elle adopte une approche plus professionnelle. _Vous apprendrez comment les bibliothèques de composants les plus populaires sont construites dans les coulisses et comment créer la vôtre._\n\n\u003CCalloutReadMore id=\"75df6bff-de40-4056-af23-fae2401cd21a\" \u002F>\n\nBien que ce soit toujours ma méthode préférée lorsque je suis certain de ce que je veux réaliser, j'ai également reçu des retours de lecteurs cherchant un comportement plus personnalisé et nécessitant des fonctionnalités plus complexes.\n\nC'est compréhensible. Bien que [unbuild](https:\u002F\u002Fgithub.com\u002Funjs\u002Funbuild) soit un outil puissant, il ne peut égaler la flexibilité, l'écosystème de plugins et l'adoption de [Vite](https:\u002F\u002Fvite.dev\u002F).\n\nTout au long de cette série, nous aborderons les sujets suivants :\n\n1. **Prise en Main avec Monorepo, Linter et Formatter** : Nous mettrons en place un monorepo pour gérer notre bibliothèque de composants et tous les outils nécessaires pour garantir une bonne expérience de développement. Nous configurerons également [ESLint](https:\u002F\u002Feslint.org\u002F) pour assurer la cohérence du code.\n2. **Création d'un Premier Composant avec Vue.js et Tailwind CSS** : Nous créerons notre premier composant avec [Vue.js](https:\u002F\u002Fvuejs.org\u002F), [Tailwind CSS](https:\u002F\u002Ftailwindcss.com\u002F) et [Tailwind Variants](https:\u002F\u002Fwww.tailwind-variants.org\u002F) en utilisant les techniques les plus avancées et puissantes employées dans des bibliothèques de composants populaires comme [Radix Vue](https:\u002F\u002Fwww.radix-vue.com\u002F) et [Nuxt UI](https:\u002F\u002Fui.nuxt.com\u002F).\n3. **Une Meilleure Expérience de Développement avec TypeScript et TSConfig** : Nous améliorerons notre expérience de développement en ajoutant [TypeScript](https:\u002F\u002Fwww.typescriptlang.org\u002F) à notre bibliothèque de composants et en configurant [TSConfig](https:\u002F\u002Fwww.typescriptlang.org\u002Ftsconfig) pour nous assurer que nos composants sont correctement typés et que nous pouvons tirer pleinement parti des fonctionnalités de TypeScript.\n4. **Tests Automatiques des Composants avec Vitest et Testing Library** : Nous écrirons des tests pour nos composants en utilisant [Vitest](https:\u002F\u002Fvitest.dev\u002Fguide\u002F) et [Testing Library](https:\u002F\u002Ftesting-library.com\u002F) pour garantir que nos composants fonctionnent comme prévu. Cela est crucial pour une bibliothèque de composants professionnelle qui reste fiable dans le temps.\n5. **Livraison Continue et Confiance dans les Composants** : Nous établirons un processus d'intégration continue pour garantir que nos composants sont toujours livrés avec confiance. Pour chaque commit de chaque branche, nous exécuterons nos tests pour vérifier que tout fonctionne correctement. Nous établirons également un processus de publication pour publier nos composants sur npm.\n6. **Création d'un Playground et d'un Storybook pour les Composants** : Nous créerons un playground pour tester nos composants dans un environnement réel et un storybook avec [Histoire](https:\u002F\u002Fhistoire.dev\u002F) pour les documenter. Cela nous permettra de partager nos composants avec d'autres développeurs et de les tester dans divers scénarios, tant en isolation qu'en combinaison.\n7. **Amélioration de l'Intégration avec Unplugin et le Module Nuxt** : Nous améliorerons l'intégration de notre bibliothèque de composants avec l'écosystème en créant un plugin Vite avec [Unplugin Vue Components](https:\u002F\u002Fgithub.com\u002Funplugin\u002Funplugin-vue-components) et un [module Nuxt](https:\u002F\u002Fnuxt.com\u002Fdocs\u002Fguide\u002Fgoing-further\u002Fmodules) pour utiliser nos composants dans une application Nuxt.\n\nÀ la fin de cette série, vous aurez une bibliothèque de composants Vue.js complète que vous pourrez utiliser dans vos projets ou partager avec la communauté, comme un développeur professionnel. N'est-ce pas excitant ? 😎\n\n## Chapitres\n\n::series-chapters-list\n---\nclass: mx-auto max-w-5xl\n---\n::\n",{"title":781,"description":957},{"loc":962},"fr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library","Le cours le plus avancé et le plus professionnel pour créer une bibliothèque de composants Vue.js avec Vite.",[969,970,971],"vue","vite","bibliothèque de composants","uPZbK53-TcUyWNHiN_UucohLqZHXH1ZV1Tpgk8hOc5c",[974,975,980,985,990,995,1000],{"contentId":765,"title":5,"description":767,"path":771,"part":84,"github":769,"topics":769},{"contentId":976,"title":977,"description":978,"path":979,"part":135,"github":769,"topics":769},"24847f3a-2219-4e78-829b-0f5a08fa9baa","Construire un premier composant avec Vue.js et Tailwind CSS","Création d'un composant avec Vue.js en utilisant Tailwind CSS pour le style et les variantes, ainsi qu'une configuration du build avec Vite.","\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fbuilding-a-first-component-with-vuejs-and-tailwind-css",{"contentId":981,"title":982,"description":983,"path":984,"part":150,"github":769,"topics":769},"09cf0b6c-6e56-4718-85d2-784fc0337ebd","Une meilleure expérience avec TypeScript et TSConfig","Apprenez à configurer TypeScript avec plusieurs contextes et à générer des types pour une bibliothèque afin d'exposer des types aux développeurs.","\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fa-better-development-experience-with-typescript-and-tsconfig",{"contentId":986,"title":987,"description":988,"path":989,"part":163,"github":769,"topics":769},"ebf9971d-0101-4d55-815b-87be77651be6","Test de composants automatisé avec Vitest et Testing Library","Apprenez à automatiser les tests pour les composants Vue.js en utilisant Vitest et Testing Library pour des tests efficaces et centrés sur l'utilisateur.","\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fautomatic-component-testing-with-vitest-and-testing-library",{"contentId":991,"title":992,"description":993,"path":994,"part":176,"github":769,"topics":769},"e3477b60-7fca-49d3-a944-2bde3f39a3c1","Intégration continue et livraison simplifiée des composants","Implémentez un pipeline d'intégration continue avec GitHub Actions et automatisez le processus de publication sur npm","\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fdelivering-components-continuously-and-with-confidence",{"contentId":996,"title":997,"description":998,"path":999,"part":187,"github":769,"topics":769},"0d31ab1a-2cc6-44d0-bdf5-31a5ecacd755","Créer un Playground et un Storybook pour les Composants","Découvrez comment créer un playground et utiliser Histoire pour visualiser et documenter vos composants dans des scénarios isolés et combinés.","\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fcreating-a-playground-and-a-storybook-for-components",{"contentId":1001,"title":1002,"description":1003,"path":1004,"part":495,"github":769,"topics":769},"aa563897-2826-4726-bdaf-4441199328d8","Améliorer l'intégration avec Unplugin et Nuxt Module","Découvrez comment intégrer sans effort une bibliothèque de composants Vue.js en utilisant Unplugin Vue Components et Nuxt Module.","\u002Ffr\u002Fseries\u002Fthe-complete-guide-to-building-a-vue-js-component-library\u002Fenhancing-integration-with-unplugin-and-nuxt-module",1795016703155]