Upgrade prettier to v3 (#88)

- Update prettier to v3
- Use default config for prettier
- Switch from pretty-quick which does not work with prettier v3 to
lint-staged

Author: BrianMitchL

.eleventy.js

@@ -1,48 +1,48 @@
-const fs = require('node:fs');
-const inclusiveLangPlugin = require('@11ty/eleventy-plugin-inclusive-language');
-const cacheBuster = require('@mightyplow/eleventy-plugin-cache-buster');
-const pluginSitemap = require('@quasibit/eleventy-plugin-sitemap');
-const htmlmin = require('html-minifier');
-const { minify } = require('terser');
-const siteSettings = require('./src/globals/site.json');
+const fs = require("node:fs");
+const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");
+const cacheBuster = require("@mightyplow/eleventy-plugin-cache-buster");
+const pluginSitemap = require("@quasibit/eleventy-plugin-sitemap");
+const htmlmin = require("html-minifier");
+const { minify } = require("terser");
+const siteSettings = require("./src/globals/site.json");
 
-const dateFormatter = Intl.DateTimeFormat('en-US', {
-  year: 'numeric',
-  month: 'long',
-  day: 'numeric',
-  weekday: 'long',
-  hour: 'numeric',
-  minute: 'numeric',
-  timeZoneName: 'short',
+const dateFormatter = Intl.DateTimeFormat("en-US", {
+  year: "numeric",
+  month: "long",
+  day: "numeric",
+  weekday: "long",
+  hour: "numeric",
+  minute: "numeric",
+  timeZoneName: "short",
 });
 
 module.exports = function (eleventyConfig) {
   const runMode = process.env.ELEVENTY_RUN_MODE;
-  const isProduction = runMode === 'build';
+  const isProduction = runMode === "build";
 
   eleventyConfig.addPlugin(pluginSitemap, {
     sitemap: {
       hostname: siteSettings.url,
     },
   });
 
-  eleventyConfig.addPassthroughCopy({ public: './' });
+  eleventyConfig.addPassthroughCopy({ public: "./" });
 
-  eleventyConfig.addShortcode('year', function () {
+  eleventyConfig.addShortcode("year", function () {
     return new Date().getFullYear().toString();
   });
 
-  eleventyConfig.addFilter('formatDateTime', function (date) {
+  eleventyConfig.addFilter("formatDateTime", function (date) {
     return dateFormatter.format(date);
   });
 
   eleventyConfig.addPlugin(inclusiveLangPlugin);
 
   if (isProduction) {
-    eleventyConfig.addPlugin(cacheBuster({ outputDirectory: 'dist' }));
+    eleventyConfig.addPlugin(cacheBuster({ outputDirectory: "dist" }));
 
-    eleventyConfig.addTransform('htmlmin', function (content, outputPath) {
-      if (outputPath && outputPath.endsWith('.html')) {
+    eleventyConfig.addTransform("htmlmin", function (content, outputPath) {
+      if (outputPath && outputPath.endsWith(".html")) {
         return htmlmin.minify(content, {
           useShortDoctype: true,
           removeComments: true,
@@ -54,13 +54,13 @@ module.exports = function (eleventyConfig) {
     });
   }
 
-  eleventyConfig.addAsyncFilter('jsmin', async function (code) {
+  eleventyConfig.addAsyncFilter("jsmin", async function (code) {
     if (isProduction) {
       try {
         const minified = await minify(code);
         return minified.code;
       } catch (err) {
-        console.error('Terser error: ', err);
+        console.error("Terser error: ", err);
         // Fail gracefully.
         return code;
       }
@@ -72,11 +72,11 @@ module.exports = function (eleventyConfig) {
   return {
     pathPrefix: siteSettings.baseUrl,
     dir: {
-      input: 'src',
-      output: 'dist',
-      includes: 'includes',
-      layouts: 'includes/layouts',
-      data: 'globals',
+      input: "src",
+      output: "dist",
+      includes: "includes",
+      layouts: "includes/layouts",
+      data: "globals",
     },
   };
 };

.github/workflows/ci.yml

@@ -13,5 +13,7 @@ jobs:
           node-version: '18.x'
       - name: Install dependencies
         run: npm ci
+      - name: Check formatting
+        run: npm run check
       - name: Build site
         run: npm run build

.github/workflows/deploy.yml

@@ -14,6 +14,8 @@ jobs:
           node-version: '18.x'
       - name: Install dependencies
         run: npm ci
+      - name: Check formatting
+        run: npm run check
       - name: Build site
         run: npm run build
       - name: Deploy

.prettierignore

@@ -1,4 +1,5 @@
 /dist
+/public
 *.include.css
 package.json
-package-lock.json
+package-lock.json

README.md

@@ -7,6 +7,7 @@ PRs should be made against the `main` branch. Upon merging, a GitHub Action will
 ## Prerequisites
 
 Install dependencies with `npm install`.
+Set up git hooks with `npm run setup-git-hooks`.
 
 ## Develop