build: 🔨 add typos to justfile recipe (#18)

# Description

This adds the typos spell checker to the justfile.

Needs a quick review

Author: lwjohnst86

.typos.toml

@@ -0,0 +1,4 @@
+[files]
+extend-exclude = [
+  "*.json",
+]

.vscode/extensions.json

@@ -1,22 +1,21 @@
 {
-  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
-  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
-  // List of extensions which should be recommended for users of this workspace.
   "recommendations": [
+    "eamodio.gitlens",
+    "github.vscode-github-actions",
+    "redhat.vscode-yaml",
     "donjayamanne.githistory",
     "felipecaputo.git-project-manager",
     "GitHub.vscode-pull-request-github",
-    "ms-azuretools.vscode-docker",
     "ms-python.python",
     "ms-python.vscode-pylance",
     "njpwerner.autodocstring",
     "quarto.quarto",
     "ms-toolsai.jupyter",
-    "streetsidesoftware.code-spell-checker",
     "vivaxy.vscode-conventional-commits",
     "charliermarsh.ruff",
     "pshaddel.conventional-branch",
-    "yy0931.vscode-sqlite3-editor"
+    "tekumara.typos-vscode",
+    "EditorConfig.EditorConfig"
   ],
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
   "unwantedRecommendations": []

.vscode/settings.json

@@ -31,9 +31,4 @@
   },
   "python.defaultInterpreterPath": "${workspaceFolder}/.venv",
   "python.languageServer": "Pylance",
-  "files.insertFinalNewline": true,
-  "cSpell.enabledFileTypes": {
-    "quarto": true
-  },
-  "cSpell.language": "en,en-GB",
-}
+  "files.insertFinalNewline": true

README.md

@@ -1,28 +1,35 @@
 # Template for Seedcase Python packages
 
-This repository contains a template for setting up new data example repos in Seedcase. The first step is to create a new repository using this template. This can easily be done by clicking the "Use this template" button on the repository page or by using the GitHub CLI:
+This repository contains a template for setting up new data example
+repos in Seedcase. The first step is to create a new repository using
+this template. This can easily be done by clicking the "Use this
+template" button on the repository page or by using the GitHub CLI:
 
 ``` bash
 # NAME is the name to give the new repository
-gh repo create NAME --template seedcase-project/template-example-repo
+gh repo create NAME --template seedcase-project/template-data-package
 ```
 
 ## Setting things up after cloning
 
 To add uv:
 
-1. Delete the `pyproject.toml` file.
-2. In the terminal run `uv init`.
-3. Look at the Git pane and take what was removed and move it over into the new `pyproject.toml` file. You can mimic what was done in `example-seed-beetle` repo.
+1.  Delete the `pyproject.toml` file.
+2.  In the terminal run `uv init`.
+3.  Look at the Git pane and take what was removed and move it over into
+    the new `pyproject.toml` file. You can mimic what was done in
+    `example-seed-beetle` repo.
 
 Then, in the terminal, run:
 
 ``` bash
 uv add polars pyjanitor
 uv add "seedcase-sprout @ git+<https://github.com/seedcase-project/seedcase-sprout>"
-uv add --dev ruff commitizen pre-commit
+uv add --dev ruff commitizen pre-commit typos
 ```
 
 ## Setting things up
 
-Use the commands found in [`spaid`](https://github.com/seedcase-project/spaid) repo to run the next setup steps.
+Use the commands found in
+[`spaid`](https://github.com/seedcase-project/spaid) repo to run the
+next setup steps.

justfile

@@ -2,11 +2,11 @@
     just --list --unsorted
 
 # Run all build-related recipes in the justfile
-run-all: install-deps format-python check-python check-commits
+run-all: install-deps format-python check-python check-spelling check-commits
 
 # Install Python package dependencies
 install-deps:
-  uv sync --upgrade --dev
+  uv sync --upgrade --dev --all-extras
 
 # Check Python code with the linter for any errors that need manual attention
 check-python:
@@ -28,3 +28,7 @@ check-commits:
   else
     echo "Not on main or haven't committed yet."
   fi
+
+# Check for spelling errors in files
+check-spelling:
+  uv run typos

pyproject.toml

@@ -29,6 +29,7 @@ dev = [
     "commitizen>=4.5.1",
     "pre-commit>=4.2.0",
     "ruff>=0.11.4",
+    "typos>=1.32.0",
 ]
 
 [tool.uv.sources]