Merge pull request #35 from jamiefdhurst/improve-build-process

chore: improve build and update deps

Author: jamiefdhurst

.eslintignore

@@ -0,0 +1,101 @@
+# Commit Message Convention
+
+This project uses a commit message convention to automatically determine version bumps and generate changelogs.
+
+## Format
+
+All commit messages must follow this format:
+
+```
+<type>[optional scope]: <description>
+```
+
+## Commit Types
+
+### Version Bumps
+
+These commit types will trigger a new release:
+
+| Type                        | Version Bump      | Description                    | Example                           |
+| --------------------------- | ----------------- | ------------------------------ | --------------------------------- |
+| `feat:`, `feature:`, `add:` | **Minor** (0.X.0) | New features or additions      | `feat: Add user authentication`   |
+| `fix:`, `bug:`              | **Patch** (0.0.X) | Bug fixes                      | `fix: Resolve login issue`        |
+| `update:`, `refactor:`      | **Patch** (0.0.X) | Code improvements              | `refactor: Simplify API client`   |
+| `improve:`, `perf:`         | **Patch** (0.0.X) | Performance improvements       | `perf: Optimize database queries` |
+| `breaking:`, `major:`       | **Major** (X.0.0) | Breaking changes               | `breaking: Remove deprecated API` |
+| `<type>!:`                  | **Major** (X.0.0) | Breaking change (conventional) | `feat!: Redesign authentication`  |
+
+### No Version Bump
+
+These commit types will NOT trigger a release:
+
+| Type              | Description             | Example                        |
+| ----------------- | ----------------------- | ------------------------------ |
+| `docs:`, `doc:`   | Documentation changes   | `docs: Update README`          |
+| `test:`, `tests:` | Test changes only       | `test: Add integration tests`  |
+| `chore:`          | Maintenance tasks       | `chore: Update dependencies`   |
+| `build:`          | Build system changes    | `build: Update webpack config` |
+| `ci:`             | CI/CD changes           | `ci: Add new workflow step`    |
+| `style:`          | Code style/formatting   | `style: Run prettier`          |
+| `revert:`         | Revert previous commits | `revert: Revert feature X`     |
+
+## Scopes (Optional)
+
+You can add a scope to provide more context:
+
+```
+feat(auth): Add OAuth support
+fix(api): Resolve timeout issue
+chore(deps): Update packages
+```
+
+## Examples
+
+### Good Commit Messages
+
+```
+feat: Add dark mode toggle
+fix(ui): Resolve button alignment issue
+docs: Update installation instructions
+chore(deps): Bump lodash from 4.17.19 to 4.17.21
+refactor: Extract validation logic
+perf: Optimize image loading
+breaking: Remove support for Node 12
+build: Update webpack to v5
+ci: Add code coverage reporting
+style: Apply prettier formatting
+revert: Revert "Add experimental feature"
+```
+
+### Bad Commit Messages (Will be Rejected)
+
+```
+Update files
+WIP
+quick fix
+Fixed bug
+Added feature
+```
+
+## Automatic Validation
+
+Commit messages are validated in two places:
+
+1. **Locally (git hook)**: When you commit, a git hook validates your message. If invalid, you'll see a helpful error message with examples.
+2. **In CI (GitHub Actions)**: All commits in a pull request are validated using the same hook. The PR will fail if any commits don't follow the convention.
+
+This ensures everyone follows the same standards, whether they have git hooks installed or not.
+
+## Version Calculation
+
+- Pull requests show a comment indicating what version bump will occur
+- When merged to main, the version is automatically calculated and released
+- Only commits with releasable types trigger new versions
+
+## Special Cases
+
+- Merge commits are automatically skipped from validation
+- `[skip ci]` commits (auto-generated) are skipped from validation
+- Only non-releasable changes (docs/test/chore/build/ci/style/revert) won't trigger a release
+- If a PR contains both releasable and non-releasable commits, a release will be triggered
+- Dependabot is configured to use `chore(deps):` format automatically

.eslintrc

@@ -0,0 +1,48 @@
+version: 2
+updates:
+  # Enable version updates for npm
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "chore"
+      prefix-development: "chore"
+      include: "scope"
+    ignore:
+      # Keep Obsidian at current version - controlled via package.json overrides
+      - dependency-name: "obsidian"
+    groups:
+      # Group all TypeScript/ESLint related updates
+      typescript-eslint:
+        patterns:
+          - "@typescript-eslint/*"
+          - "typescript"
+      # Group all Jest related updates
+      jest:
+        patterns:
+          - "jest*"
+          - "@types/jest"
+          - "ts-jest"
+      # Group development tools
+      dev-tools:
+        patterns:
+          - "prettier"
+          - "husky"
+          - "lint-staged"
+          - "eslint"
+
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    open-pull-requests-limit: 5
+    labels:
+      - "⬆️ dependencies"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/COMMIT_CONVENTION.md

@@ -0,0 +1,110 @@
+#!/bin/bash
+
+# Get the latest tag, or default to 0.0.0 if no tags exist
+LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0")
+echo "Latest tag: $LATEST_TAG"
+
+# Get commits since the latest tag
+if [ "$LATEST_TAG" = "0.0.0" ]; then
+  COMMITS=$(git log --pretty=format:"%s" --no-merges)
+else
+  COMMITS=$(git log ${LATEST_TAG}..HEAD --pretty=format:"%s" --no-merges)
+fi
+
+# Initialize bump type and releasable commits flag
+BUMP_TYPE="patch"
+HAS_RELEASABLE_COMMITS=false
+
+# Analyze commits to determine bump type
+while IFS= read -r commit; do
+  # Skip empty lines
+  [ -z "$commit" ] && continue
+
+  # Convert to lowercase for case-insensitive matching
+  commit_lower=$(echo "$commit" | tr '[:upper:]' '[:lower:]')
+
+  # Skip commits that are only documentation, tests, chores, build, ci, style, or reverts
+  if [[ "$commit_lower" =~ ^docs?(\(.*\))?:|^documentation:|^test(s)?(\(.*\))?:|^chore(\(.*\))?:|^build(\(.*\))?:|^ci(\(.*\))?:|^style(\(.*\))?:|^revert(\(.*\))?: ]] || \
+     [[ "$commit_lower" =~ ^update.*documentation|^update.*readme|^update.*test ]]; then
+    echo "Skipping non-release commit: $commit"
+    continue
+  fi
+
+  # Mark that we have at least one releasable commit
+  HAS_RELEASABLE_COMMITS=true
+
+  # Check for major version indicators
+  if [[ "$commit_lower" =~ ^breaking|^major|breaking\ change|breaking:|^[^:]+\!: ]]; then
+    BUMP_TYPE="major"
+    echo "Found breaking change: $commit"
+    break
+  fi
+
+  # Check for minor version indicators (features, additions)
+  if [[ "$commit_lower" =~ ^feat|^feature|^add|^minor ]]; then
+    if [ "$BUMP_TYPE" != "major" ]; then
+      BUMP_TYPE="minor"
+      echo "Found feature/addition: $commit"
+    fi
+  fi
+
+  # Everything else defaults to patch (fixes, updates, refactors, etc.)
+done <<< "$COMMITS"
+
+# If only non-releasable commits were found, don't create a release
+if [ "$HAS_RELEASABLE_COMMITS" = false ]; then
+  echo "Only non-releasable changes found (docs/test/chore/build/ci/style/revert) - no release needed"
+  BUMP_TYPE="none"
+fi
+
+echo "Determined bump type: $BUMP_TYPE"
+
+# Parse current version
+if [ "$LATEST_TAG" = "0.0.0" ]; then
+  MAJOR=0
+  MINOR=0
+  PATCH=0
+else
+  # Remove 'v' prefix if present
+  VERSION=${LATEST_TAG#v}
+
+  # Split version into components
+  IFS='.' read -r MAJOR MINOR PATCH <<< "$VERSION"
+fi
+
+# Calculate new version based on bump type
+case $BUMP_TYPE in
+  major)
+    MAJOR=$((MAJOR + 1))
+    MINOR=0
+    PATCH=0
+    ;;
+  minor)
+    MINOR=$((MINOR + 1))
+    PATCH=0
+    ;;
+  patch)
+    PATCH=$((PATCH + 1))
+    ;;
+  none)
+    # Keep version the same
+    ;;
+esac
+
+NEW_VERSION="${MAJOR}.${MINOR}.${PATCH}"
+echo "New version: $NEW_VERSION"
+
+# Determine if we should create a release
+if [ "$BUMP_TYPE" = "none" ] || [ "$LATEST_TAG" = "$NEW_VERSION" ] || [ "v$LATEST_TAG" = "$NEW_VERSION" ]; then
+  SHOULD_RELEASE="false"
+  echo "No release will be created (version unchanged)"
+else
+  SHOULD_RELEASE="true"
+  echo "Release will be created"
+fi
+
+# Output to GitHub Actions
+echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
+echo "bump_type=$BUMP_TYPE" >> $GITHUB_OUTPUT
+echo "previous_version=$LATEST_TAG" >> $GITHUB_OUTPUT
+echo "should_release=$SHOULD_RELEASE" >> $GITHUB_OUTPUT