docs: add installation steps & snippet check step

+19

doc/.vitepress/config.ts

··· 1 1 import { defineConfig } from "vitepress"; 2 2 import pkg from "../package.json"; 3 3 import markdownItFootnote from "markdown-it-footnote"; 4 + import { 5 + groupIconMdPlugin, 6 + groupIconVitePlugin, 7 + localIconLoader, 8 + } from "vitepress-plugin-group-icons"; 4 9 5 10 // https://vitepress.dev/reference/site-config 6 11 export default defineConfig({ ··· 74 79 markdown: { 75 80 config: (md) => { 76 81 md.use(markdownItFootnote); 82 + md.use(groupIconMdPlugin); 77 83 }, 84 + }, 85 + vite: { 86 + plugins: [ 87 + groupIconVitePlugin({ 88 + customIcon: { 89 + nixos: "vscode-icons:file-type-nix", 90 + "configuration.nix": "vscode-icons:file-type-nix", 91 + "module.nix": "vscode-icons:file-type-nix", 92 + home: localIconLoader(import.meta.url, "../assets/homemanager.svg"), 93 + ".conf": "vscode-icons:file-type-config", 94 + }, 95 + }), 96 + ], 78 97 }, 79 98 });

+5

doc/.vitepress/theme/index.ts

··· 1 + // .vitepress/theme/index.ts 2 + import Theme from "vitepress/theme"; 3 + import "virtual:group-icons.css"; 4 + 5 + export default Theme;

+1

doc/assets/homemanager.svg

··· 1 + <svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 32 32"><path fill="#ffdd44" fill-rule="evenodd" d="M13 11.115L6.183 23.76L4.59 20.87l1.839-3.387l-3.651-.01L2 16.029l.8-1.477l5.2.018l1.868-3.447Zm.527 10.108h13.64l-1.541 2.922l-3.658-.011l1.817 3.389l-.779 1.449h-1.593l-2.584-4.825l-3.722-.008Zm7.94-5.541l-6.82-12.645l3.134-.032L19.6 6.4l1.834-3.379h1.557l.795 1.479l-2.612 4.807l1.854 3.455Z"/><path fill="#fcba35" fill-rule="evenodd" d="m10.542 16.324l6.821 12.645l-3.134.031l-1.821-3.4l-1.834 3.38H9.016l-.8-1.476l2.615-4.804l-1.855-3.457Zm7.922-5.573H4.823l1.542-2.922l3.658.011l-1.816-3.389L8.986 3h1.592l2.584 4.825l3.722.008ZM19 20.888l6.817-12.644l1.593 2.89l-1.839 3.386l3.651.01l.778 1.449l-.8 1.477l-5.2-.018l-1.868 3.447Z"/></svg>

+28 -2

doc/guide/getting-started.md

··· 1 - # Getting Started 1 + --- 2 + comment: true 3 + title: Getting Started 4 + description: Getting started with Wire Tool! 5 + --- 6 + 7 + # {{ $frontmatter.title }} 8 + 9 + ## Installation 10 + 11 + Wire can be heavy to compile. You should enable the substituter `wires.cachix.org`. 12 + 13 + ::: code-group 2 14 3 - golf2 15 + <<< @/snippets/getting-started/cache.nix [module.nix] 16 + <<< @/snippets/getting-started/nix.conf 17 + 18 + ::: 19 + 20 + ### NixOS / Home Manager 21 + 22 + ::: code-group 23 + 24 + <<< @/snippets/getting-started/nixos.flake.nix [flake.nix (NixOS)] 25 + <<< @/snippets/getting-started/hm.flake.nix [flake.nix (Home Manager)] 26 + <<< @/snippets/getting-started/configuration.nix 27 + <<< @/snippets/getting-started/home.nix 28 + 29 + :::

+2 -1

doc/package.json

··· 16 16 ] 17 17 }, 18 18 "dependencies": { 19 - "markdown-it-footnote": "^4.0.0" 19 + "markdown-it-footnote": "^4.0.0", 20 + "vitepress-plugin-group-icons": "^1.3.8" 20 21 } 21 22 }

+7 -1

doc/package.nix

··· 3 3 nixosOptionsDoc, 4 4 runCommand, 5 5 wire, 6 + nix, 6 7 nodejs, 7 8 pnpm, 8 9 stdenv, ··· 43 44 wire 44 45 nodejs 45 46 pnpm.configHook 47 + nix 46 48 ]; 47 49 src = ./.; 48 50 pnpmDeps = pnpm.fetchDeps { 49 51 inherit (finalAttrs) pname version src; 50 - hash = "sha256-7ThshGf9tkCwSaz4DMTXxmjhN+2g0dErgzpgzJ2gv8Y"; 52 + hash = "sha256-QSk2+o8gMNWfpBgjKeW5DBrso9zGcbP06Ga2hK8df5A="; 51 53 }; 52 54 patchPhase = '' 53 55 cat ${optionsDoc} >> ./reference/module.md ··· 55 57 ''; 56 58 buildPhase = "pnpm run build > build.log 2>&1"; 57 59 installPhase = "cp .vitepress/dist -r $out"; 60 + doCheck = true; 61 + checkPhase = '' 62 + nix-instantiate --eval --strict ./snippets > /dev/null 63 + ''; 58 64 DEBUG = "*"; 59 65 })

+173

doc/pnpm-lock.yaml

··· 11 11 markdown-it-footnote: 12 12 specifier: ^4.0.0 13 13 version: 4.0.0 14 + vitepress-plugin-group-icons: 15 + specifier: ^1.3.8 16 + version: 1.3.8 14 17 devDependencies: 15 18 vitepress: 16 19 specifier: ^1.6.3 ··· 89 92 '@algolia/requester-node-http@5.23.0': 90 93 resolution: {integrity: sha512-XXHbq2heOZc9EFCc4z+uyHS9YRBygZbYQVsWjWZWx8hdAz+tkBX/jLHM9Xg+3zO0/v8JN6pcZzqYEVsdrLeNLg==} 91 94 engines: {node: '>= 14.0.0'} 95 + 96 + '@antfu/install-pkg@1.0.0': 97 + resolution: {integrity: sha512-xvX6P/lo1B3ej0OsaErAjqgFYzYVcJpamjLAFLYh9vRJngBrMoUG7aVnrGTeqM7yxbyTD5p3F2+0/QUEh8Vzhw==} 98 + 99 + '@antfu/utils@8.1.1': 100 + resolution: {integrity: sha512-Mex9nXf9vR6AhcXmMrlz/HVgYYZpVGJ6YlPgwl7UnaFpnshXs6EK/oa5Gpf3CzENMjkvEx2tQtntGnb7UtSTOQ==} 92 101 93 102 '@babel/helper-string-parser@7.25.9': 94 103 resolution: {integrity: sha512-4A/SCr/2KLd5jrtOMFzaKjVtAei3+2r/NChoBNoZ3EyP/+GlhoaEGoWOZUmFmoITP7zOJyHIMm+DYRd8o3PvHA==} ··· 268 277 cpu: [x64] 269 278 os: [win32] 270 279 280 + '@iconify-json/logos@1.2.4': 281 + resolution: {integrity: sha512-XC4If5D/hbaZvUkTV8iaZuGlQCyG6CNOlaAaJaGa13V5QMYwYjgtKk3vPP8wz3wtTVNVEVk3LRx1fOJz+YnSMw==} 282 + 271 283 '@iconify-json/simple-icons@1.2.29': 272 284 resolution: {integrity: sha512-KYrxmxtRz6iOAulRiUsIBMUuXek+H+Evwf8UvYPIkbQ+KDoOqTegHx3q/w3GDDVC0qJYB+D3hXPMZcpm78qIuA==} 285 + 286 + '@iconify-json/vscode-icons@1.2.17': 287 + resolution: {integrity: sha512-7ge4lTxBMpxEE8SGZ3ytjsLOWEip35B+6HJIKPep8gnoqZHTTT5bYDNDkx3iSganyaTviOvBuarzz5Z7Rg62Iw==} 273 288 274 289 '@iconify/types@2.0.0': 275 290 resolution: {integrity: sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==} 291 + 292 + '@iconify/utils@2.3.0': 293 + resolution: {integrity: sha512-GmQ78prtwYW6EtzXRU1rY+KwOKfz32PD7iJh6Iyqw68GiKuoZ2A6pRtzWONz5VQJbp50mEjXh/7NkumtrAgRKA==} 276 294 277 295 '@jridgewell/sourcemap-codec@1.5.0': 278 296 resolution: {integrity: sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==} ··· 523 541 '@vueuse/shared@12.8.2': 524 542 resolution: {integrity: sha512-dznP38YzxZoNloI0qpEfpkms8knDtaoQ6Y/sfS0L7Yki4zh40LFHEhur0odJC6xTHG5dxWVPiUWBXn+wCG2s5w==} 525 543 544 + acorn@8.14.1: 545 + resolution: {integrity: sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==} 546 + engines: {node: '>=0.4.0'} 547 + hasBin: true 548 + 526 549 algoliasearch@5.23.0: 527 550 resolution: {integrity: sha512-7TCj+hLx6fZKppLL74lYGDEltSBNSu4vqRwgqeIKZ3VQ0q3aOrdEN0f1sDWcvU1b+psn2wnl7aHt9hWtYatUUA==} 528 551 engines: {node: '>= 14.0.0'} ··· 542 565 comma-separated-tokens@2.0.3: 543 566 resolution: {integrity: sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==} 544 567 568 + confbox@0.1.8: 569 + resolution: {integrity: sha512-RMtmw0iFkeR4YV+fUOSucriAQNb9g8zFR52MWCtl+cCZOFRNL6zeB395vPzFhEjjn4fMxXudmELnl/KF/WrK6w==} 570 + 571 + confbox@0.2.1: 572 + resolution: {integrity: sha512-hkT3yDPFbs95mNCy1+7qNKC6Pro+/ibzYxtM2iqEigpf0sVw+bg4Zh9/snjsBcf990vfIsg5+1U7VyiyBb3etg==} 573 + 545 574 copy-anything@3.0.5: 546 575 resolution: {integrity: sha512-yCEafptTtb4bk7GLEQoM8KVJpxAfdBJYaXyzQEgQQQgYrZiDp8SJmGKlYza6CYjEDNstAdNdKA3UuoULlEbS6w==} 547 576 engines: {node: '>=12.13'} ··· 549 578 csstype@3.1.3: 550 579 resolution: {integrity: sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==} 551 580 581 + debug@4.4.0: 582 + resolution: {integrity: sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==} 583 + engines: {node: '>=6.0'} 584 + peerDependencies: 585 + supports-color: '*' 586 + peerDependenciesMeta: 587 + supports-color: 588 + optional: true 589 + 552 590 dequal@2.0.3: 553 591 resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} 554 592 engines: {node: '>=6'} ··· 571 609 estree-walker@2.0.2: 572 610 resolution: {integrity: sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==} 573 611 612 + exsolve@1.0.4: 613 + resolution: {integrity: sha512-xsZH6PXaER4XoV+NiT7JHp1bJodJVT+cxeSH1G0f0tlT0lJqYuHUP3bUx2HtfTDvOagMINYp8rsqusxud3RXhw==} 614 + 574 615 focus-trap@7.6.4: 575 616 resolution: {integrity: sha512-xx560wGBk7seZ6y933idtjJQc1l+ck+pI3sKvhKozdBV1dRZoKhkW5xoCaFv9tQiX5RH1xfSxjuNu6g+lmN/gw==} 576 617 ··· 579 620 engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} 580 621 os: [darwin] 581 622 623 + globals@15.15.0: 624 + resolution: {integrity: sha512-7ACyT3wmyp3I61S4fG682L0VA2RGD9otkqGJIwNUMF1SWUombIIk+af1unuDYgMm082aHYwD+mzJvv9Iu8dsgg==} 625 + engines: {node: '>=18'} 626 + 582 627 hast-util-to-html@9.0.5: 583 628 resolution: {integrity: sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw==} 584 629 ··· 594 639 is-what@4.1.16: 595 640 resolution: {integrity: sha512-ZhMwEosbFJkA0YhFnNDgTM4ZxDRsS6HqTo7qsZM08fehyRYIYa0yHu5R6mgo1n/8MgaPBXiPimPD77baVFYg+A==} 596 641 engines: {node: '>=12.13'} 642 + 643 + kolorist@1.8.0: 644 + resolution: {integrity: sha512-Y+60/zizpJ3HRH8DCss+q95yr6145JXZo46OTpFvDZWLfRCE4qChOyk1b26nMaNpfHHgxagk9dXT5OP0Tfe+dQ==} 645 + 646 + local-pkg@1.1.1: 647 + resolution: {integrity: sha512-WunYko2W1NcdfAFpuLUoucsgULmgDBRkdxHxWQ7mK0cQqwPiy8E1enjuRBrhLtZkB5iScJ1XIPdhVEFK8aOLSg==} 648 + engines: {node: '>=14'} 597 649 598 650 magic-string@0.30.17: 599 651 resolution: {integrity: sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==} ··· 628 680 mitt@3.0.1: 629 681 resolution: {integrity: sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==} 630 682 683 + mlly@1.7.4: 684 + resolution: {integrity: sha512-qmdSIPC4bDJXgZTCR7XosJiNKySV7O215tsPtDN9iEO/7q/76b/ijtgRu/+epFXSJhijtTCCGp3DWS549P3xKw==} 685 + 686 + ms@2.1.3: 687 + resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} 688 + 631 689 nanoid@3.3.11: 632 690 resolution: {integrity: sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==} 633 691 engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} ··· 636 694 oniguruma-to-es@3.1.1: 637 695 resolution: {integrity: sha512-bUH8SDvPkH3ho3dvwJwfonjlQ4R80vjyvrU8YpxuROddv55vAEJrTuCuCVUhhsHbtlD9tGGbaNApGQckXhS8iQ==} 638 696 697 + package-manager-detector@0.2.11: 698 + resolution: {integrity: sha512-BEnLolu+yuz22S56CU1SUKq3XC3PkwD5wv4ikR4MfGvnRVcmzXR9DwSlW2fEamyTPyXHomBJRzgapeuBvRNzJQ==} 699 + 700 + pathe@2.0.3: 701 + resolution: {integrity: sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==} 702 + 639 703 perfect-debounce@1.0.0: 640 704 resolution: {integrity: sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==} 641 705 642 706 picocolors@1.1.1: 643 707 resolution: {integrity: sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==} 644 708 709 + pkg-types@1.3.1: 710 + resolution: {integrity: sha512-/Jm5M4RvtBFVkKWRu2BLUTNP8/M2a+UwuAX+ae4770q1qVGtfjG+WTCupoZixokjmHiry8uI+dlY8KXYV5HVVQ==} 711 + 712 + pkg-types@2.1.0: 713 + resolution: {integrity: sha512-wmJwA+8ihJixSoHKxZJRBQG1oY8Yr9pGLzRmSsNms0iNWyHHAlZCa7mmKiFR10YPZuz/2k169JiS/inOjBCZ2A==} 714 + 645 715 postcss@8.5.3: 646 716 resolution: {integrity: sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==} 647 717 engines: {node: ^10 || ^12 || >=14} ··· 651 721 652 722 property-information@7.0.0: 653 723 resolution: {integrity: sha512-7D/qOz/+Y4X/rzSB6jKxKUsQnphO046ei8qxG59mtM3RG3DHgTK81HrxrmoDVINJb8NKT5ZsRbwHvQ6B68Iyhg==} 724 + 725 + quansync@0.2.10: 726 + resolution: {integrity: sha512-t41VRkMYbkHyCYmOvx/6URnN80H7k4X0lLdBMGsz+maAwrJQYB1djpV6vHrQIBE0WBSGqhtEHrK9U3DWWH8v7A==} 654 727 655 728 regex-recursion@6.0.2: 656 729 resolution: {integrity: sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg==} ··· 696 769 tabbable@6.2.0: 697 770 resolution: {integrity: sha512-Cat63mxsVJlzYvN51JmVXIgNoUokrIaT2zLclCXjRd8boZ0004U4KCs/sToJ75C6sdlByWxpYnb5Boif1VSFew==} 698 771 772 + tinyexec@0.3.2: 773 + resolution: {integrity: sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==} 774 + 699 775 trim-lines@3.0.1: 700 776 resolution: {integrity: sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==} 777 + 778 + ufo@1.5.4: 779 + resolution: {integrity: sha512-UsUk3byDzKd04EyoZ7U4DOlxQaD14JUKQl6/P7wiX4FNvUfm3XL246n9W5AmqwW5RSFJ27NAuM0iLscAOYUiGQ==} 701 780 702 781 unist-util-is@6.0.0: 703 782 resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==} ··· 750 829 optional: true 751 830 terser: 752 831 optional: true 832 + 833 + vitepress-plugin-group-icons@1.3.8: 834 + resolution: {integrity: sha512-BIx1HgXEvbDeJX8NqVvthWHQqEW2slj1SkAWLMNoUR5IJq1dq6LmrURYCyznMJCB3/0g+YY89ifvQp3in1fX3g==} 753 835 754 836 vitepress@1.6.3: 755 837 resolution: {integrity: sha512-fCkfdOk8yRZT8GD9BFqusW3+GggWYZ/rYncOfmgcDtP3ualNHCAg+Robxp2/6xfH1WwPHtGpPwv7mbA3qomtBw==} ··· 881 963 dependencies: 882 964 '@algolia/client-common': 5.23.0 883 965 966 + '@antfu/install-pkg@1.0.0': 967 + dependencies: 968 + package-manager-detector: 0.2.11 969 + tinyexec: 0.3.2 970 + 971 + '@antfu/utils@8.1.1': {} 972 + 884 973 '@babel/helper-string-parser@7.25.9': {} 885 974 886 975 '@babel/helper-validator-identifier@7.25.9': {} ··· 987 1076 '@esbuild/win32-x64@0.21.5': 988 1077 optional: true 989 1078 1079 + '@iconify-json/logos@1.2.4': 1080 + dependencies: 1081 + '@iconify/types': 2.0.0 1082 + 990 1083 '@iconify-json/simple-icons@1.2.29': 991 1084 dependencies: 992 1085 '@iconify/types': 2.0.0 993 1086 1087 + '@iconify-json/vscode-icons@1.2.17': 1088 + dependencies: 1089 + '@iconify/types': 2.0.0 1090 + 994 1091 '@iconify/types@2.0.0': {} 995 1092 1093 + '@iconify/utils@2.3.0': 1094 + dependencies: 1095 + '@antfu/install-pkg': 1.0.0 1096 + '@antfu/utils': 8.1.1 1097 + '@iconify/types': 2.0.0 1098 + debug: 4.4.0 1099 + globals: 15.15.0 1100 + kolorist: 1.8.0 1101 + local-pkg: 1.1.1 1102 + mlly: 1.7.4 1103 + transitivePeerDependencies: 1104 + - supports-color 1105 + 996 1106 '@jridgewell/sourcemap-codec@1.5.0': {} 997 1107 998 1108 '@rollup/rollup-android-arm-eabi@4.37.0': ··· 1224 1334 transitivePeerDependencies: 1225 1335 - typescript 1226 1336 1337 + acorn@8.14.1: {} 1338 + 1227 1339 algoliasearch@5.23.0: 1228 1340 dependencies: 1229 1341 '@algolia/client-abtesting': 5.23.0 ··· 1250 1362 1251 1363 comma-separated-tokens@2.0.3: {} 1252 1364 1365 + confbox@0.1.8: {} 1366 + 1367 + confbox@0.2.1: {} 1368 + 1253 1369 copy-anything@3.0.5: 1254 1370 dependencies: 1255 1371 is-what: 4.1.16 1256 1372 1257 1373 csstype@3.1.3: {} 1374 + 1375 + debug@4.4.0: 1376 + dependencies: 1377 + ms: 2.1.3 1258 1378 1259 1379 dequal@2.0.3: {} 1260 1380 ··· 1294 1414 1295 1415 estree-walker@2.0.2: {} 1296 1416 1417 + exsolve@1.0.4: {} 1418 + 1297 1419 focus-trap@7.6.4: 1298 1420 dependencies: 1299 1421 tabbable: 6.2.0 1300 1422 1301 1423 fsevents@2.3.3: 1302 1424 optional: true 1425 + 1426 + globals@15.15.0: {} 1303 1427 1304 1428 hast-util-to-html@9.0.5: 1305 1429 dependencies: ··· 1325 1449 1326 1450 is-what@4.1.16: {} 1327 1451 1452 + kolorist@1.8.0: {} 1453 + 1454 + local-pkg@1.1.1: 1455 + dependencies: 1456 + mlly: 1.7.4 1457 + pkg-types: 2.1.0 1458 + quansync: 0.2.10 1459 + 1328 1460 magic-string@0.30.17: 1329 1461 dependencies: 1330 1462 '@jridgewell/sourcemap-codec': 1.5.0 ··· 1366 1498 1367 1499 mitt@3.0.1: {} 1368 1500 1501 + mlly@1.7.4: 1502 + dependencies: 1503 + acorn: 8.14.1 1504 + pathe: 2.0.3 1505 + pkg-types: 1.3.1 1506 + ufo: 1.5.4 1507 + 1508 + ms@2.1.3: {} 1509 + 1369 1510 nanoid@3.3.11: {} 1370 1511 1371 1512 oniguruma-to-es@3.1.1: ··· 1374 1515 regex: 6.0.1 1375 1516 regex-recursion: 6.0.2 1376 1517 1518 + package-manager-detector@0.2.11: 1519 + dependencies: 1520 + quansync: 0.2.10 1521 + 1522 + pathe@2.0.3: {} 1523 + 1377 1524 perfect-debounce@1.0.0: {} 1378 1525 1379 1526 picocolors@1.1.1: {} 1380 1527 1528 + pkg-types@1.3.1: 1529 + dependencies: 1530 + confbox: 0.1.8 1531 + mlly: 1.7.4 1532 + pathe: 2.0.3 1533 + 1534 + pkg-types@2.1.0: 1535 + dependencies: 1536 + confbox: 0.2.1 1537 + exsolve: 1.0.4 1538 + pathe: 2.0.3 1539 + 1381 1540 postcss@8.5.3: 1382 1541 dependencies: 1383 1542 nanoid: 3.3.11 ··· 1387 1546 preact@10.26.4: {} 1388 1547 1389 1548 property-information@7.0.0: {} 1549 + 1550 + quansync@0.2.10: {} 1390 1551 1391 1552 regex-recursion@6.0.2: 1392 1553 dependencies: ··· 1455 1616 copy-anything: 3.0.5 1456 1617 1457 1618 tabbable@6.2.0: {} 1619 + 1620 + tinyexec@0.3.2: {} 1458 1621 1459 1622 trim-lines@3.0.1: {} 1460 1623 1624 + ufo@1.5.4: {} 1625 + 1461 1626 unist-util-is@6.0.0: 1462 1627 dependencies: 1463 1628 '@types/unist': 3.0.3 ··· 1498 1663 rollup: 4.37.0 1499 1664 optionalDependencies: 1500 1665 fsevents: 2.3.3 1666 + 1667 + vitepress-plugin-group-icons@1.3.8: 1668 + dependencies: 1669 + '@iconify-json/logos': 1.2.4 1670 + '@iconify-json/vscode-icons': 1.2.17 1671 + '@iconify/utils': 2.3.0 1672 + transitivePeerDependencies: 1673 + - supports-color 1501 1674 1502 1675 vitepress@1.6.3(@algolia/client-search@5.23.0)(postcss@8.5.3)(search-insights@2.17.3): 1503 1676 dependencies:

+7

doc/snippets/default.nix

··· 1 + { 2 + getting-started-hm = import ./getting-started/home.nix; 3 + getting-started-hm-flake = import ./getting-started/hm.flake.nix; 4 + getting-started-nixos = import ./getting-started/configuration.nix; 5 + getting-started-nixos-flake = import ./getting-started/nixos.flake.nix; 6 + getting-started-cache = import ./getting-started/cache.nix; 7 + }

+12

doc/snippets/getting-started/cache.nix

··· 1 + { 2 + nix.settings = { 3 + substituters = [ 4 + "https://wires.cachix.org" 5 + # ... 6 + ]; 7 + trusted-public-keys = [ 8 + "wires.cachix.org-1:7XQoG91Bh+Aj01mAJi77Ui5AYyM1uEyV0h1wOomqjpk=" 9 + # ... 10 + ]; 11 + }; 12 + }

+11

doc/snippets/getting-started/configuration.nix

··· 1 + {system, ...}: let 2 + wire = import ( # [!code ++] 3 + builtins.fetchTarball "https://github.com/wires-org/wire/archive/refs/heads/main.tar.gz" # [!code ++] 4 + ); # [!code ++] 5 + in { 6 + environment.systemPackages = [ 7 + wire.packages.${system}.wire # [!code ++] 8 + ]; 9 + 10 + # ... 11 + }

+34

doc/snippets/getting-started/hm.flake.nix

··· 1 + { 2 + inputs = { 3 + # ... 4 + nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; 5 + home-manager = { 6 + url = "github:nix-community/home-manager"; 7 + inputs.nixpkgs.follows = "nixpkgs"; 8 + }; 9 + wire.url = "github:wires-org/wire"; # [!code ++] 10 + }; 11 + 12 + outputs = { 13 + # ... 14 + nixpkgs, 15 + home-manager, 16 + wire, # [!code ++] 17 + ... 18 + }: let 19 + system = "x86_64-linux"; 20 + pkgs = nixpkgs.legacyPackages.${system}; 21 + in { 22 + homeConfigurations.my-user = home-manager.lib.homeManagerConfiguration { 23 + inherit pkgs; 24 + modules = [ 25 + # ... 26 + { 27 + home.packages = [ 28 + wire.packages.${system}.wire # [!code ++] 29 + ]; 30 + } 31 + ]; 32 + }; 33 + }; 34 + }

+11

doc/snippets/getting-started/home.nix

··· 1 + {system, ...}: let 2 + wire = import ( # [!code ++] 3 + builtins.fetchTarball "https://github.com/wires-org/wire/archive/refs/heads/main.tar.gz" # [!code ++] 4 + ); # [!code ++] 5 + in { 6 + home.packages = [ 7 + wire.packages.${system}.wire # [!code ++] 8 + ]; 9 + 10 + # ... 11 + }

+2

doc/snippets/getting-started/nix.conf

··· 1 + substituters = https://wires.cachix.org 2 + trusted-public-keys = wires.cachix.org-1:7XQoG91Bh+Aj01mAJi77Ui5AYyM1uEyV0h1wOomqjpk=

+29

doc/snippets/getting-started/nixos.flake.nix

··· 1 + { 2 + inputs = { 3 + # ... 4 + nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable"; 5 + wire.url = "github:wires-org/wire"; # [!code ++] 6 + }; 7 + 8 + outputs = inputs @ { 9 + # ... 10 + nixpkgs, 11 + wire, # [!code ++] 12 + ... 13 + }: { 14 + nixosConfigurations.my-system = nixpkgs.lib.nixosSystem { 15 + system = "x86_64-linux"; 16 + specialArgs = {inherit inputs;}; 17 + modules = [ 18 + # ... 19 + ( 20 + {system, ...}: { 21 + environment.systemPackages = [ 22 + wire.packages.${system}.wire # [!code ++] 23 + ]; 24 + } 25 + ) 26 + ]; 27 + }; 28 + }; 29 + }

+9 -1

flake.nix

··· 38 38 pkgs, 39 39 inputs', 40 40 config, 41 + lib, 41 42 ... 42 43 }: 43 44 { ··· 49 50 programs = { 50 51 # rfc style 51 52 nixfmt.enable = true; 52 - 53 + # docs only 54 + alejandra.enable = true; 53 55 rustfmt.enable = true; 54 56 just.enable = true; 55 57 prettier.enable = true; 56 58 protolint.enable = true; 57 59 taplo.enable = true; 60 + }; 61 + settings.formatter = { 62 + nixfmt.excludes = [ "doc/snippets/*.nix" ]; 63 + alejandra = { 64 + includes = lib.mkForce [ "doc/snippets/*.nix" ]; 65 + }; 58 66 }; 59 67 }; 60 68 };

Configure Feed

Configure Feed