Skip to content

Commit 4b2e6d8

Browse files
mceachenmceachen
committed
chore(docs): prettier
1 parent 7206cf6 commit 4b2e6d8

File tree

3 files changed

+40
-38
lines changed

3 files changed

+40
-38
lines changed

‎.github/ISSUE_TEMPLATE/security-report.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
name: Security Vulnerability Report
33
about: Report a security vulnerability (for non-sensitive issues only)
4-
title: '[SECURITY] '
4+
title: "[SECURITY] "
55
labels: security
6-
assignees: ''
6+
assignees: ""
77
---
88

99
<!--
@@ -36,4 +36,4 @@ If you have suggestions on how to address this issue, please describe them here.
3636

3737
## Additional Context
3838

39-
Add any other context about the security concern here.
39+
Add any other context about the security concern here.

‎COMPATIBILITY.md‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -72,45 +72,45 @@ Our implementation is feature-complete with Node.js's SQLite module. All documen
7272

7373
### DatabaseSync Methods
7474

75-
| Method | Our Status | Node.js Equivalent | Notes |
76-
| ----------------------- | ----------- | ------------------ | ---------------------------------- |
75+
| Method | Our Status | Node.js Equivalent | Notes |
76+
| ----------------------- | ----------- | ------------------ | ------------------------------------- |
7777
| `constructor()` | ✅ Complete | ✅ | Full path support (string/Buffer/URL) |
78-
| `open()` | ✅ Complete | ✅ | All configuration options |
79-
| `close()` | ✅ Complete | ✅ | Proper cleanup |
80-
| `prepare()` | ✅ Complete | ✅ | Statement preparation |
81-
| `exec()` | ✅ Complete | ✅ | Direct SQL execution |
82-
| `function()` | ✅ Complete | ✅ | User function registration |
83-
| `aggregate()` | ✅ Complete | ✅ | Aggregate function registration |
84-
| `backup()` | ✅ Complete | ✅ | Async with progress callbacks |
85-
| `createSession()` | ✅ Complete | ✅ | Session tracking |
86-
| `applyChangeset()` | ✅ Complete | ✅ | Change application |
87-
| `enableLoadExtension()` | ✅ Complete | ✅ | Extension loading control |
88-
| `loadExtension()` | ✅ Complete | ✅ | Extension loading |
89-
| `location(dbName?)` | ✅ Complete | ✅ | Enhanced with attached DB support |
78+
| `open()` | ✅ Complete | ✅ | All configuration options |
79+
| `close()` | ✅ Complete | ✅ | Proper cleanup |
80+
| `prepare()` | ✅ Complete | ✅ | Statement preparation |
81+
| `exec()` | ✅ Complete | ✅ | Direct SQL execution |
82+
| `function()` | ✅ Complete | ✅ | User function registration |
83+
| `aggregate()` | ✅ Complete | ✅ | Aggregate function registration |
84+
| `backup()` | ✅ Complete | ✅ | Async with progress callbacks |
85+
| `createSession()` | ✅ Complete | ✅ | Session tracking |
86+
| `applyChangeset()` | ✅ Complete | ✅ | Change application |
87+
| `enableLoadExtension()` | ✅ Complete | ✅ | Extension loading control |
88+
| `loadExtension()` | ✅ Complete | ✅ | Extension loading |
89+
| `location(dbName?)` | ✅ Complete | ✅ | Enhanced with attached DB support |
9090

9191
### StatementSync Methods
9292

93-
| Method | Our Status | Node.js Equivalent | Notes |
94-
| ------------------------------- | ----------- | ------------------ | ------------------------- |
95-
| `run()` | ✅ Complete | ✅ | Statement execution |
96-
| `get()` | ✅ Complete | ✅ | Single row query |
97-
| `all()` | ✅ Complete | ✅ | Multi-row query |
98-
| `iterate()` | ✅ Complete | ✅ | Iterator interface |
99-
| `finalize()` | ✅ Complete | ✅ | Statement cleanup |
100-
| `setReadBigInts()` | ✅ Complete | ✅ | BigInt reading control |
101-
| `setAllowBareNamedParameters()` | ✅ Complete | ✅ | Parameter binding control |
93+
| Method | Our Status | Node.js Equivalent | Notes |
94+
| ------------------------------- | ----------- | ------------------ | ----------------------------- |
95+
| `run()` | ✅ Complete | ✅ | Statement execution |
96+
| `get()` | ✅ Complete | ✅ | Single row query |
97+
| `all()` | ✅ Complete | ✅ | Multi-row query |
98+
| `iterate()` | ✅ Complete | ✅ | Iterator interface |
99+
| `finalize()` | ✅ Complete | ✅ | Statement cleanup |
100+
| `setReadBigInts()` | ✅ Complete | ✅ | BigInt reading control |
101+
| `setAllowBareNamedParameters()` | ✅ Complete | ✅ | Parameter binding control |
102102
| `setReturnArrays()` | ✅ Complete | Extension | Our extension, not in Node.js |
103-
| `columns()` | ✅ Complete | ✅ | Column metadata |
103+
| `columns()` | ✅ Complete | ✅ | Column metadata |
104104

105105
### Configuration Options
106106

107-
| Option | Our Status | Node.js Equivalent | Notes |
108-
| ---------------------------------- | ----------- | ------------------ | ----------------------- |
107+
| Option | Our Status | Node.js Equivalent | Notes |
108+
| ---------------------------------- | ----------- | ------------------ | ------------------------- |
109109
| `location` | ✅ Complete | ✅ | String/Buffer/URL support |
110-
| `readOnly` | ✅ Complete | ✅ | Read-only mode |
111-
| `enableForeignKeyConstraints` | ✅ Complete | ✅ | Foreign key enforcement |
112-
| `timeout` | ✅ Complete | ✅ | Busy timeout |
113-
| `enableDoubleQuotedStringLiterals` | ✅ Complete | ✅ | DQS configuration |
110+
| `readOnly` | ✅ Complete | ✅ | Read-only mode |
111+
| `enableForeignKeyConstraints` | ✅ Complete | ✅ | Foreign key enforcement |
112+
| `timeout` | ✅ Complete | ✅ | Busy timeout |
113+
| `enableDoubleQuotedStringLiterals` | ✅ Complete | ✅ | DQS configuration |
114114

115115
## Test Coverage
116116

@@ -200,11 +200,12 @@ export { DatabaseSync, StatementSync, Session, constants };
200200
Our implementation provides complete compatibility with Node.js's SQLite module. All documented APIs are fully implemented.
201201

202202
**Key Achievements:**
203+
203204
- All core and advanced SQLite features implemented
204205
- Full API compatibility with Node.js
205206
- Enhanced with `setReturnArrays()` method not in Node.js
206207
- Comprehensive test coverage (295 tests passing)
207208
- Multi-platform support with prebuilds
208209
- Production-ready with proper error handling and memory management
209210

210-
**Production Status: ✅ Ready for production use**
211+
**Production Status: ✅ Ready for production use**

‎SECURITY.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ This project employs multiple layers of automated security scanning:
5353
5. **TruffleHog** - Secrets detection in code
5454

5555
These scans run automatically on:
56+
5657
- Every push to the main branch
5758
- Every pull request
5859
- Weekly scheduled scans
@@ -82,15 +83,15 @@ The following SQLite security features are available:
8283

8384
```javascript
8485
// Restrict file access to read-only
85-
const db = new DatabaseSync('database.db', {
86-
readonly: true
86+
const db = new DatabaseSync("database.db", {
87+
readonly: true,
8788
});
8889

8990
// Disable extension loading by default
9091
// Extensions must be explicitly enabled
9192
db.allowExtension(); // Required first
9293
db.enableLoadExtension(true); // Then enable
93-
db.loadExtension('path/to/extension');
94+
db.loadExtension("path/to/extension");
9495
```
9596

9697
### Best Practices
@@ -110,4 +111,4 @@ When we receive a security report, we will:
110111
3. Prepare fixes for all supported versions
111112
4. Coordinate disclosure with the reporter
112113

113-
We aim to disclose vulnerabilities responsibly, balancing the need for users to be informed with giving them time to update.
114+
We aim to disclose vulnerabilities responsibly, balancing the need for users to be informed with giving them time to update.

0 commit comments

Comments
 (0)