fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

fix minor issues in the nest.js v3 docs, switch to SQLite - #532

Merged
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs
Dec 22, 2025
Merged

fix minor issues in the nest.js v3 docs, switch to SQLite#532
ymc9 merged 1 commit into
zenstackhq:mainfrom
lsmith77:fix-v3-nestjs

Conversation

@lsmith77

@lsmith77lsmith77 commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

If you prefer I can keep PostgreSQL but I think SQLite makes it easier for people to get this setup quickly. How to deal with PostgreSQL is then handled elsewhere in the docs.

Summary by CodeRabbit

  • Documentation
    • Updated NestJS recipe to use SQLite-backed examples instead of PostgreSQL.
    • Reorganized example file structure and adjusted import paths for clarity.
    • Clarified module exports and updated code samples for consistent access-control and API-handler examples.

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel

vercelBot commented Dec 19, 2025

Copy link
Copy Markdown

@lsmith77 is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Dec 19, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

Reworks NestJS recipe docs: replaces PostgreSQL dialect with SqliteDialect and a SQLite DB in samples; updates file path annotations and import paths to use src/ layout; adds explicit export class AppModule and includes schema import in the API handler example.

Changes

Cohort / File(s)Change Summary
NestJS Recipe Documentation
versioned_docs/version-3.x/recipe/nestjs.md
Replaced Postgres setup with SqliteDialect and a SQLite-backed database in DbService sample; updated file path annotations from root-level names to src/db/db.service.ts, src/app.module.ts, src/app.controller.ts; adjusted import paths to the new locations; added export class AppModule and added schema import to API handler example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Consistent, repetitive documentation changes across a single file.
  • Focused on examples/path adjustments and a dialect swap; no executable code outside docs to validate.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately describes the main changes: fixing minor documentation issues and switching the example database from PostgreSQL to SQLite in the NestJS v3 docs.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e99836f and a6b149c.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (6)
versioned_docs/version-3.x/recipe/nestjs.md (6)

13-29: Import paths and SQLite setup look correct.

All imports properly reference the new src/ directory structure. The path ../../zenstack/schema correctly resolves from src/db/db.service.ts to the root-level zenstack/schema. SQLite configuration with better-sqlite3 is straightforward and makes the quick-start simpler than PostgreSQL.


33-43: AppModule structure and imports are correct.

The explicit export class AppModule {} is good practice. Import path ./db/db.service correctly resolves from src/app.module.ts to src/db/db.service.ts.


47-60: AppController import paths verified.

Import path ./db/db.service correctly resolves from src/app.controller.ts.


68-105: Access-controlled ORM AppModule is consistent.

The explicit export class AppModule {} and import paths match the plain ORM pattern, maintaining consistency across examples.


109-124: Access-controlled ORM AppController is consistent.

Import paths align with the plain ORM example.


130-168: CRUD service example properly imports schema.

The schema import on Line 135 (../zenstack/schema) correctly resolves from src/app.controller.ts to the root-level schema file. This aligns with the API handler setup shown in the code.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
versioned_docs/version-3.x/recipe/nestjs.md (2)

47-60: Fix incorrect import path on line 49.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the AppModule (line 36) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';

109-124: Fix incorrect import path on line 111.

The import path './db.service' is inconsistent with the file structure. Since DbService is located at src/db/db.service.ts, the correct import from src/app.controller.ts should be './db/db.service'. This matches the import path used in the access-controlled AppModule (line 71) and the CRUD example (line 134).

🔎 Proposed fix
 import { Controller, Get, Inject } from '@nestjs/common';
- import { DbService } from './db.service';+ import { DbService } from './db/db.service';
📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89846e0 and e99836f.

📒 Files selected for processing (1)
  • versioned_docs/version-3.x/recipe/nestjs.md (4 hunks)
🔇 Additional comments (3)
versioned_docs/version-3.x/recipe/nestjs.md (3)

13-43: SQLite migration and module setup look good.

The DbService correctly switches to SqliteDialect with better-sqlite3, and the AppModule properly registers it as a provider with correct import paths.


68-105: Access-controlled module setup is correct.

The AppModule properly registers both the standard and access-controlled DbService instances, with correct imports and the explicit export class AppModule {} declaration.


130-168: CRUD API handler example is well-structured.

The import paths are correct ('./db/db.service' and '../zenstack/schema'), and the example properly demonstrates injecting the access-controlled DbService and initializing the RestApiHandler with the schema.

Comment threadversioned_docs/version-3.x/recipe/nestjs.md

@ymc9ymc9 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @lsmith77 !

@ymc9
ymc9 merged commit 86bbb8c into zenstackhq:mainDec 22, 2025
2 of 3 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@lsmith77@ymc9