Merge pull request #37 from tweedegolf/check-fmt

Check formatting

Author: tdittr

.github/workflows/check.yml

@@ -34,12 +34,22 @@ jobs:
         uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84
         with:
           shared-key: "check"
+          cache-all-crates: true # Also cache taplo-cli
+      - name: Install tools
+        run: cargo install taplo-cli --locked
       - name: Clippy
         run: cargo clippy --locked --all-targets --all-features --workspace -- -Dwarnings
       - name: Test rust
         run: cargo test --locked
       - name: Check rust formatting
         run: cargo fmt --all --check
+      - name: Check frontend formatting
+        run: npm run fmt-check
+        working-directory: frontend
+      - name: Check driver-db syntax
+        run: taplo check driver-db/*.toml
+      - name: Check driver-db formatting
+        run: taplo fmt --check --diff
       - name: Download db-dump
         run: wget --no-verbose https://static.crates.io/db-dump.tar.gz
       - name: Build database

.prettierignore

@@ -0,0 +1,3 @@
+/*
+
+!frontend/

.taplo.toml

@@ -0,0 +1,4 @@
+include = [".taplo.toml", "driver-db/*.toml"]
+
+[formatting]
+indent_string = "    "

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "svelte.svelte-vscode",
+    "esbenp.prettier-vscode",
+    "rust-lang.rust-analyzer",
+    "tamasfe.even-better-toml"
+  ]
+}

driver-db/ad57xx.toml

@@ -1,4 +1,3 @@
-#:schema ../schema.json
 manifest_version = "0.0.1"
 
 [meta]

driver-db/lsm303agr.toml

@@ -13,7 +13,9 @@ packages = ["LGA-14"]
 [dev_boards]
 adafruit = 4413
 mikroe = 2684
-other = [{ name = "BBC micro:bit v2", link = "https://tech.microbit.org/hardware/" }]
+other = [
+    { name = "BBC micro:bit v2", link = "https://tech.microbit.org/hardware/" },
+]
 
 [interfaces.i2c]
 addrs = [0x1E, 0x1D]

frontend/.prettierignore

@@ -0,0 +1,5 @@
+package-lock.json
+.vite/
+.vscode/
+dist/
+README.md

frontend/.vscode

@@ -0,0 +1 @@
+../.vscode

frontend/.vscode/extensions.json

@@ -8,7 +8,9 @@ This template should help get you started developing with Svelte and TypeScript
 
 ## Need an official Svelte framework?
 
-Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
+Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its
+serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less,
+and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
 
 ## Technical considerations
 
@@ -17,27 +19,39 @@ Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also pow
 - It brings its own routing solution which might not be preferable for some users.
 - It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
 
-This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
+This template contains as little as possible to get started with Vite + TypeScript + Svelte, while taking into account
+the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other
+`create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
 
-Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
+Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been
+structured similarly to SvelteKit so that it is easy to migrate.
 
 **Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
 
-Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
+Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash
+references keeps the default TypeScript setting of accepting type information from the entire workspace, while also
+adding `svelte` and `vite/client` type information.
 
 **Why include `.vscode/extensions.json`?**
 
-Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
+Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to
+install the recommended extension upon opening the project.
 
 **Why enable `allowJs` in the TS template?**
 
-While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
+While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of
+JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds:
+not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing
+JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
 
 **Why is HMR not preserving my local component state?**
 
-HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
+HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and
+`@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the
+details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
 
-If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
+If you have state that's important to retain within a component, consider creating an external store which would not be
+replaced by HMR.
 
 ```ts
 // store.ts

frontend/README.md

@@ -1,13 +1,13 @@
 <!doctype html>
 <html lang="en">
-<head>
-    <meta charset="UTF-8"/>
-    <link rel="icon" type="image/svg+xml" href="src/logo.svg"/>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="src/logo.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Rust Drivers</title>
-</head>
-<body>
-<div id="app"></div>
-<script type="module" src="/src/main.ts"></script>
-</body>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
 </html>

frontend/index.html

@@ -7,7 +7,9 @@
     "dev": "vite",
     "build": "vite build",
     "preview": "vite preview",
-    "check": "svelte-check --tsconfig ./tsconfig.json"
+    "check": "svelte-check --tsconfig ./tsconfig.json",
+    "fmt": "prettier --write .",
+    "fmt-check": "prettier --check ."
   },
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
@@ -16,8 +18,8 @@
     "svelte-check": "^3.6.7",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2",
-    "vite": "^5.4.2"
+    "vite": "^5.4.2",
+    "prettier": "^3.3.3"
   },
-  "dependencies": {
-  }
+  "dependencies": {}
 }

frontend/package-lock.json

@@ -38,11 +38,13 @@
 html {
   box-sizing: border-box;
   font-size: 16px;
-  min-width: 454px
+  min-width: 454px;
 }
 
-*, *:before, *:after {
-  box-sizing: inherit
+*,
+*:before,
+*:after {
+  box-sizing: inherit;
 }
 
 a {
@@ -52,7 +54,7 @@ a {
 }
 
 a:hover {
-  color: var(--color-secondary)
+  color: var(--color-secondary);
 }
 
 body {
@@ -85,15 +87,15 @@ main {
   align-items: flex-start;
 }
 
-
 table {
   flex: 1;
   width: 100%;
   border-collapse: collapse;
   height: auto;
 }
 
-th, td {
+th,
+td {
   border: none;
   padding: 0.5rem;
 }
@@ -126,16 +128,16 @@ fieldset {
   background-color: var(--color-background-secondary);
 }
 
-input[type=text] {
+input[type="text"] {
   border: 1px solid var(--color-border);
   width: 100%;
   font-size: 1rem;
   padding: 0.25rem;
   outline-color: var(--color-primary);
 }
 
-input[type=checkbox] {
-  margin: 0 0.25rem 0 0 ;
+input[type="checkbox"] {
+  margin: 0 0.25rem 0 0;
   vertical-align: middle;
 }
 
@@ -152,9 +154,7 @@ label {
 }
 
 .filter {
-
   .filter-box {
-
     display: flex;
     flex-direction: row;
     align-items: center;
@@ -229,13 +229,13 @@ label {
 
         &.sorted.asc {
           &::after {
-            content: '↑';
+            content: "↑";
           }
         }
 
         &.sorted.desc {
           &::after {
-            content: '↓';
+            content: "↓";
           }
         }
       }
@@ -266,7 +266,6 @@ label {
   }
 
   &.open {
-
     .filter-box {
       border-bottom: 0px;
       padding-bottom: 1.5rem;