chore: add code quality tools and contribution guidelines (#1)

- Add MIT LICENSE and CONTRIBUTING.md
- Set up ESLint, Prettier, and EditorConfig
- Configure Husky with pre-commit hooks and commitlint
- Add GitHub Actions CI workflow for PR validation
- Add FUNDING.yml for Ko-fi sponsorship
- Update package.json metadata for public release

Author: JZimz

.commitlintrc

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.editorconfig

@@ -0,0 +1,24 @@
+# EditorConfig helps maintain consistent coding styles
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.json]
+indent_size = 2
+
+[*.yml]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+ko_fi: jzimz

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint:eslint
+
+      - name: Check formatting with Prettier
+        run: npm run format:check
+
+      - name: Type check with TypeScript
+        run: npm run lint:types
+
+      - name: Run tests
+        run: npm test

.github/workflows/release.yml

@@ -3,13 +3,34 @@ name: Release Build
 on:
   push:
     tags:
-      - "v*"
+      - 'v*'
 
 permissions:
   contents: write
 
 jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run linting and tests
+        run: |
+          npm run lint
+          npm test
+
   build-and-release:
+    needs: validate
     strategy:
       matrix:
         os: [macos-latest, windows-latest]
@@ -28,8 +49,8 @@ jobs:
       - name: Setup node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "22"
-          cache: "npm"
+          node-version: '22'
+          cache: 'npm'
 
       - name: Set release version
         shell: bash
@@ -63,4 +84,4 @@ jobs:
         with:
           environment: production
           sourcemaps: .vite/build .vite/renderer/main_window/assets
-          release: "ROMie@${{ env.RELEASE_VERSION }}"
+          release: 'ROMie@${{ env.RELEASE_VERSION }}'

.gitignore

@@ -1,99 +1,47 @@
+# Personal/Local files
+.vscode
+CLAUDE.local.md
+.DS_Store
+
+# Secrets & Credentials
 *.p12
+.env
+.env.test
+.env.sentry-build-plugin
+
+# App data directory
 .romie
-.vscode
+
+# Dependencies
+node_modules/
+
+# Build outputs
+out/
+build/Release
 
 # Logs
 logs
 *.log
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-.DS_Store
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
+# TypeScript
+*.tsbuildinfo
 
-# Coverage directory used by tools like istanbul
+# Test coverage
 coverage
 *.lcov
 
-# nyc test coverage
-.nyc_output
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
+# Vite
+.vite/
 
-# Optional npm cache directory
+# Caches
+.cache
 .npm
-
-# Optional eslint cache
 .eslintcache
 
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
+# Misc
 *.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# next.js build output
-.next
-
-# nuxt.js build output
-.nuxt
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# Webpack
-.webpack/
-
-# Vite
-.vite/
-
-# Electron-Forge
-out/
-
-# Sentry Config File
-.env.sentry-build-plugin
+*.pid
+*.seed
+*.pid.lock
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.lintstagedrc

@@ -0,0 +1,4 @@
+{
+  "*.{js,cjs,mjs,ts,vue}": ["eslint --fix", "prettier --write"],
+  "*.{json,md,yml,yaml}": ["prettier --write"]
+}

.prettierignore

@@ -0,0 +1,21 @@
+# Build outputs
+out/
+dist/
+build/
+.vite/
+
+# Dependencies
+node_modules/
+
+# Generated files
+*.min.js
+*.min.css
+
+# Large data files
+src/data/ra/*.json
+
+# Logs
+*.log
+
+# OS files
+.DS_Store