Merge pull request #1 from 1Cor125/project_structure

chore: init proj structure of crate within plugin

Author: jjhafer

.cargo/config.toml

@@ -0,0 +1,5 @@
+[alias]
+lint-clippy = "clippy --all-targets --all-features -- -D warnings"
+fix-clippy = "clippy --all-targets --all-features --fix --allow-dirty --allow-staged"
+lint-fmt = "fmt --all -- --check"
+fix-fmt = "fmt --all"

.editorconfig

@@ -0,0 +1 @@
+./node_modules/@silvermine/standardization/.editorconfig

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+   push: # Runs on push to any branch
+   pull_request:
+      branches: [ "master" ]
+
+env:
+   CARGO_TERM_COLOR: always
+
+jobs:
+   ci:
+      name: Continuous Integration
+      runs-on: ubuntu-latest
+
+      steps:
+         - name: Checkout repository
+           uses: actions/checkout@v4
+
+         - name: Setup Node.js
+           uses: actions/setup-node@v4
+           with:
+              node-version-file: '.nvmrc'
+              cache: 'npm'
+
+         - name: Install system dependencies
+           run: |
+              sudo apt-get update
+              sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev
+
+         - name: Setup Rust toolchain
+           uses: actions-rust-lang/setup-rust-toolchain@v1
+           with:
+              toolchain: '1.89.0'
+              components: rustfmt, clippy
+              cache: true
+
+         - name: Install npm dependencies
+           run: npm ci
+
+         - name: Run standards checks
+           run: npm run standards
+
+         - name: Run cargo check
+           run: cargo check --workspace --all-targets
+
+         - name: Run cargo tests
+           run: cargo test --workspace

.gitignore

@@ -0,0 +1,22 @@
+# Rust
+/target/
+Cargo.lock
+
+# Node
+node_modules/
+dist-js/
+*.log
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Tauri
+/gen/

.markdownlint-cli2.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+const sharedStandards = require('@silvermine/standardization/.markdownlint-cli2.shared.cjs');
+
+module.exports = {
+   ...sharedStandards,
+   globs: [
+      ...sharedStandards.globs,
+   ],
+   ignores: [
+      ...sharedStandards.ignores,
+      '**/dist-js',
+      '**/permissions/autogenerated',
+   ],
+};

.npmrc

@@ -0,0 +1 @@
+save-exact=true

.nvmrc

@@ -0,0 +1 @@
+20.12.2

Cargo.toml

@@ -0,0 +1,22 @@
+[workspace]
+resolver = "2"
+members = [
+   "crates/sqlx-sqlite-conn-mgr",
+]
+
+[package]
+name = "tauri-plugin-sqlite"
+version = "0.1.0"
+description = "A Tauri plugin for SQLite database access with connection management"
+license = "MIT"
+edition = "2024"
+rust-version = "1.89"
+links = "tauri-plugin-sqlite"
+
+[dependencies]
+tauri = "2.5.1"
+serde = { version = "1", features = ["derive"] }
+thiserror = "1"
+
+[build-dependencies]
+tauri-plugin = { version = "2.5.1", features = ["build"] }

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jeremy Thomerson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,155 @@
-# tauri-plugin-sqlite
+# Tauri SQLite Plugin
+
+[![CI][ci-badge]][ci-url]
+
+A Tauri plugin for SQLite database access with connection management. This plugin
+depends on [SQLx](https://github.com/launchbadge/sqlx) and enforces pragmatic policies
+for connection management.
+
+[ci-badge]: https://github.com/silvermine/tauri-plugin-sqlite/actions/workflows/ci.yml/badge.svg
+[ci-url]: https://github.com/silvermine/tauri-plugin-sqlite/actions/workflows/ci.yml
+
+## Project Structure
+
+This project is organized as a Cargo workspace with the following structure:
+
+```text
+tauri-plugin-sqlite/
+├── crates/
+│   └── sqlx-sqlite-conn-mgr/   # SQLx SQLite connection pool manager
+│       ├── src/
+│       │   └── lib.rs
+│       └── Cargo.toml
+├── src/                        # Tauri plugin implementation
+│   ├── commands.rs             # Plugin commands
+│   ├── error.rs                # Error types
+│   ├── lib.rs                  # Main plugin code
+│   └── models.rs               # Data models
+├── guest-js/                   # JavaScript/TypeScript bindings
+│   ├── index.ts
+│   └── tsconfig.json
+├── permissions/                # Permission definitions (mostly generated)
+├── dist-js/                    # Compiled JS (generated)
+├── Cargo.toml                  # Workspace configuration
+├── package.json                # NPM package configuration
+└── build.rs                    # Build script
+```
+
+## Crates
+
+### sqlx-sqlite-conn-mgr
+
+A pure Rust module with no dependencies on Tauri or its plugin architecture. It
+provides connection management for SQLite databases using SQLx. It's designed to be
+published as a standalone crate in the future with minimal changes.
+
+See [`crates/sqlx-sqlite-conn-mgr/README.md`](crates/sqlx-sqlite-conn-mgr/README.md)
+for more details.
+
+### Tauri Plugin
+
+The main plugin provides a Tauri integration layer that exposes SQLite functionality
+to Tauri applications. It uses the `sqlx-sqlite-conn-mgr` module internally.
+
+## Getting Started
+
+### Installation
+
+1. Install NPM dependencies:
+
+   ```bash
+   npm install
+   ```
+
+2. Build the TypeScript bindings:
+
+   ```bash
+   npm run build
+   ```
+
+3. Build the Rust plugin:
+
+   ```bash
+   cargo build
+   ```
+
+### Tests
+
+Run Rust tests:
+
+```bash
+cargo test
+```
+
+### Linting and standards checks
+
+```bash
+npm run standards
+```
+
+## Usage
+
+### In a Tauri Application
+
+Add the plugin to your Tauri application's `Cargo.toml`:
+
+```toml
+[dependencies]
+tauri-plugin-sqlite = { path = "../path/to/tauri-plugin-sqlite" }
+```
+
+Initialize the plugin in your Tauri app:
+
+```rust
+fn main() {
+    tauri::Builder::default()
+        .plugin(tauri_plugin_sqlite::init())
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+```
+
+### JavaScript/TypeScript API
+
+Install the JavaScript package in your frontend:
+
+```bash
+npm install @silvermine/tauri-plugin-sqlite
+```
+
+Use the plugin from JavaScript:
+
+```typescript
+// TODO: Add real examples once we have decided on the plugin API
+import { hello } from '@silvermine/tauri-plugin-sqlite';
+
+// Call the hello command
+const greeting = await hello('World');
+console.log(greeting); // "Hello, World! This is the SQLite plugin."
+```
+
+## Development Standards
+
+This project follows the
+[Silvermine standardization](https://github.com/silvermine/standardization)
+guidelines. Key standards include:
+
+   * **EditorConfig**: Consistent editor settings across the team
+   * **Markdownlint**: Markdown linting for documentation
+   * **Commitlint**: Conventional commit message format
+   * **Code Style**: 3-space indentation, LF line endings
+
+### Running Standards Checks
+
+```bash
+npm run standards
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please follow the established coding standards and commit
+message conventions.