Skip to content

Conversation

@fhur
Copy link
Collaborator

@fhur fhur commented Oct 10, 2024

SynthQL pull request template

Why

Motivation an context for the change.

What changed

Brief summary of the changes.

Important

Mention important points that require special attention or that might surprise
reviewers.

Summary by CodeRabbit

  • New Features

    • Added a new blog post titled "What are database apps? and why SynthQL?" discussing database applications and introducing SynthQL for efficient development.
  • Bug Fixes

    • Updated the author image URL for Fernando Hurtado to a new Gravatar link with enhanced specifications.

@vercel
Copy link

vercel bot commented Oct 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 10, 2024 8:28pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 10, 2024

Walkthrough

This pull request introduces a new blog post titled "What are database apps? and why SynthQL?" authored by Fernando Hurtado, detailing the concept and components of database applications. It critiques traditional REST API approaches and presents SynthQL as a solution for building database apps more efficiently. Additionally, the author’s image URL in the authors.yml file has been updated to a new Gravatar link.

Changes

File Path Change Summary
packages/docs/blog/2024-10-09-the-database-app/index.md New blog post added: "What are database apps? and why SynthQL?" discussing database applications and SynthQL.
packages/docs/blog/authors.yml Updated image_url for Fernando Hurtado's author entry with a new Gravatar link.

Possibly related PRs

  • fix: add composite type support #46: The PR addresses issues related to the command-line interface (CLI) for SynthQL, which is mentioned in the main PR as part of the discussion on database applications and SynthQL's role in simplifying development.

Poem

🐇 In the world of data, apps do play,
With SynthQL guiding the way.
CRUD and more, they help us see,
How to fetch and sync with glee!
Fernando's tale, a rabbit's delight,
In the realm of code, we take flight! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (4)
packages/docs/blog/2024-10-09-the-database-app/index.md (4)

8-20: Minor improvements for clarity and correctness

The introduction effectively sets the context for database apps. Consider the following minor adjustments:

  1. Line 12: Change "a interesting" to "an interesting" for correct grammar.
  2. Line 14: Remove the comma before "because" as the clause is essential to the meaning.
  3. Line 16: Consider adding a comma after "of course" for better readability.
  4. Line 20: Add a comma before "so" to connect two independent clauses.

These small changes will enhance the overall quality of the introduction.

🧰 Tools
🪛 LanguageTool

[misspelling] ~12-~12: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...oftware developer, I've "re-discovered" a interesting pattern: a surprising numbe...

(EN_A_VS_AN)


[formatting] ~14-~14: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nipulate that data. I say re-discovered, because it's hardly a discovery at all. We've k...

(COMMA_BEFORE_BECAUSE)


[typographical] ~16-~16: Consider adding a comma here.
Context: ...c way such as Airtable, Notion, Retool, and of course the venerable Excel. I call these **"...

(OF_COURSE_COMMA)


[uncategorized] ~20-~20: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... me build database apps ontop of my data so I can build a custom (and hopefully gre...

(COMMA_COMPOUND_SENTENCE)

🪛 Markdownlint

16-16: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


20-20: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


12-12: Expected: 250; Actual: 335
Line length

(MD013, line-length)


14-14: Expected: 250; Actual: 360
Line length

(MD013, line-length)


8-8: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


22-66: Enhance clarity and correct minor issues

This section provides a comprehensive overview of database apps and their components. Consider the following improvements:

  1. Line 34: Replace "very good" with a more specific adjective to avoid the overused intensifier.
  2. Line 37: Change "believe" to "belief" for correct grammar.
  3. Line 40: Add a comma after "Usually" for clarity.
  4. Line 46: Change "sub-optimal" to "suboptimal" for correct spelling.
  5. Line 51: Consider using an en dash instead of a hyphen in "3-4 levels".
  6. Line 55: Add a comma before "and" to connect two independent clauses.
  7. Line 59: Replace "very big" with a more specific description to avoid the overused intensifier.
  8. Line 63: Consider using a synonym for "really hard" to elevate the writing style.

Additionally, there are a few typos:

  • Line 44: "prolem" should be "problem"
  • Line 61: "higih" should be "high"
  • Line 63: "oeprations" should be "operations"

Addressing these points will improve the overall quality and readability of this section.

🧰 Tools
🪛 LanguageTool

[style] ~34-~34: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t's not that React is perfect, but it's a very good abstraction for building complex UIs. T...

(EN_WEAK_ADJECTIVE)


[grammar] ~37-~37: The word ‘believe’ is a verb. Did you mean the noun “belief”?
Context: ...iences. ### The database It is also my believe that Postgres has solved the database p...

(PREPOSITION_VERB)


[typographical] ~40-~40: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...client, so the data needs to be synced. Usually this is done with a REST API. The prob...

(RB_LY_COMMA)


[misspelling] ~46-~46: This word is normally spelled as one.
Context: ...that this data fetching is usually very sub-optimal. Two important problems arise: Over-fet...

(EN_COMPOUNDS_SUB_OPTIMAL)


[typographical] ~51-~51: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...asily to the point where you often have 3-4 levels of dependencies. Now let's ass...

(HYPHEN_TO_EN)


[uncategorized] ~55-~55: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ons get made implicitly by the developer and they result in non-optimal fetching tre...

(COMMA_COMPOUND_SENTENCE)


[style] ~59-~59: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... the puzzle is the authorization layer. A very big and important layer that often gets neg...

(EN_WEAK_ADJECTIVE)


[style] ~63-~63: To elevate your writing, try using a synonym here.
Context: ...ross the codebase. This makes it really hard to audit and reason about. Even in a sm...

(HARD_TO)

🪛 Markdownlint

49-49: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


51-51: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


61-61: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


34-34: Expected: 250; Actual: 437
Line length

(MD013, line-length)


37-37: Expected: 250; Actual: 351
Line length

(MD013, line-length)


42-42: Expected: 250; Actual: 442
Line length

(MD013, line-length)


44-44: Expected: 250; Actual: 287
Line length

(MD013, line-length)


47-47: Expected: 250; Actual: 285
Line length

(MD013, line-length)


53-53: Expected: 250; Actual: 293
Line length

(MD013, line-length)


61-61: Expected: 250; Actual: 281
Line length

(MD013, line-length)


63-63: Expected: 250; Actual: 339
Line length

(MD013, line-length)


65-65: Expected: 250; Actual: 398
Line length

(MD013, line-length)


33-33: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


28-28: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


29-29: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


30-30: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


31-31: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


47-47: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


49-49: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


47-47: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


98-135: Clear explanations with minor grammatical correction needed

The "Declarative" and "Frontend ORM" sections provide excellent explanations of SynthQL's features, supported by a well-structured code example. The demonstration of how to use SynthQL in a React component is particularly helpful.

One minor correction:

  • Line 107: Change "can built" to "can build" for correct grammar.

Overall, these sections effectively communicate the benefits and usage of SynthQL as a frontend ORM.

🧰 Tools
🪛 LanguageTool

[grammar] ~107-~107: The modal verb ‘can’ requires the verb’s base form.
Context: ...ur React components. This means you can built mini-endpoints that are tightly coupled...

(MD_BASEFORM)

🪛 Markdownlint

103-103: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


98-98: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


137-157: Enhance readability and remove excess blank lines

The "Secure by default" section effectively explains SynthQL's security features. Consider the following improvements:

  1. Line 139: Add a hyphen to "role-based" for correct hyphenation.
  2. Line 141: Remove the comma before "so that" as it's unnecessary in this context.

Additionally, please remove the excessive blank lines at the end of the file (lines 149-157). Keeping one or two blank lines at the end is sufficient.

These minor adjustments will improve the overall polish of the document.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~139-~139: This expression is usually spelled with a hyphen.
Context: ...features that set it apart: Declarative role based access controls and query whitelisting....

(BASED_HYPHEN)


[typographical] ~141-~141: The conjunction “so that” does not require a comma.
Context: ... to whitelist the query with the backend, so that the backend can check that the user has...

(SO_THAT_UNNECESSARY_COMMA)

🪛 Markdownlint

143-143: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


149-149: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


150-150: Expected: 1; Actual: 3
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


151-151: Expected: 1; Actual: 4
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


152-152: Expected: 1; Actual: 5
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


153-153: Expected: 1; Actual: 6
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


154-154: Expected: 1; Actual: 7
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


155-155: Expected: 1; Actual: 8
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


156-156: Expected: 1; Actual: 9
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


157-157: Expected: 1; Actual: 10
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5df8937 and 2ab41b1.

📒 Files selected for processing (2)
  • packages/docs/blog/2024-10-09-the-database-app/index.md (1 hunks)
  • packages/docs/blog/authors.yml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/docs/blog/authors.yml
🧰 Additional context used
🪛 LanguageTool
packages/docs/blog/2024-10-09-the-database-app/index.md

[misspelling] ~12-~12: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...oftware developer, I've "re-discovered" a interesting pattern: a surprising numbe...

(EN_A_VS_AN)


[formatting] ~14-~14: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nipulate that data. I say re-discovered, because it's hardly a discovery at all. We've k...

(COMMA_BEFORE_BECAUSE)


[typographical] ~16-~16: Consider adding a comma here.
Context: ...c way such as Airtable, Notion, Retool, and of course the venerable Excel. I call these **"...

(OF_COURSE_COMMA)


[uncategorized] ~20-~20: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... me build database apps ontop of my data so I can build a custom (and hopefully gre...

(COMMA_COMPOUND_SENTENCE)


[style] ~34-~34: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t's not that React is perfect, but it's a very good abstraction for building complex UIs. T...

(EN_WEAK_ADJECTIVE)


[grammar] ~37-~37: The word ‘believe’ is a verb. Did you mean the noun “belief”?
Context: ...iences. ### The database It is also my believe that Postgres has solved the database p...

(PREPOSITION_VERB)


[typographical] ~40-~40: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...client, so the data needs to be synced. Usually this is done with a REST API. The prob...

(RB_LY_COMMA)


[misspelling] ~46-~46: This word is normally spelled as one.
Context: ...that this data fetching is usually very sub-optimal. Two important problems arise: Over-fet...

(EN_COMPOUNDS_SUB_OPTIMAL)


[typographical] ~51-~51: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...asily to the point where you often have 3-4 levels of dependencies. Now let's ass...

(HYPHEN_TO_EN)


[uncategorized] ~55-~55: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ons get made implicitly by the developer and they result in non-optimal fetching tre...

(COMMA_COMPOUND_SENTENCE)


[style] ~59-~59: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... the puzzle is the authorization layer. A very big and important layer that often gets neg...

(EN_WEAK_ADJECTIVE)


[style] ~63-~63: To elevate your writing, try using a synonym here.
Context: ...ross the codebase. This makes it really hard to audit and reason about. Even in a sm...

(HARD_TO)


[style] ~71-~71: To elevate your writing, try using a synonym here.
Context: ...bout any of this complexity. I find it hard to come up with a catchy name for it, b...

(HARD_TO)


[typographical] ~71-~71: Consider adding a comma after ‘lately’ for more clarity.
Context: ... come up with a catchy name for it, but lately I've been thinking of SynthQL as a secu...

(RB_LY_COMMA)


[grammar] ~107-~107: The modal verb ‘can’ requires the verb’s base form.
Context: ...ur React components. This means you can built mini-endpoints that are tightly coupled...

(MD_BASEFORM)


[uncategorized] ~139-~139: This expression is usually spelled with a hyphen.
Context: ...features that set it apart: Declarative role based access controls and query whitelisting....

(BASED_HYPHEN)


[typographical] ~141-~141: The conjunction “so that” does not require a comma.
Context: ... to whitelist the query with the backend, so that the backend can check that the user has...

(SO_THAT_UNNECESSARY_COMMA)

🪛 Markdownlint
packages/docs/blog/2024-10-09-the-database-app/index.md

16-16: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


20-20: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


49-49: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


51-51: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


61-61: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


103-103: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


143-143: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


98-98: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


149-149: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


150-150: Expected: 1; Actual: 3
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


151-151: Expected: 1; Actual: 4
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


152-152: Expected: 1; Actual: 5
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


153-153: Expected: 1; Actual: 6
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


154-154: Expected: 1; Actual: 7
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


155-155: Expected: 1; Actual: 8
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


156-156: Expected: 1; Actual: 9
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


157-157: Expected: 1; Actual: 10
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


12-12: Expected: 250; Actual: 335
Line length

(MD013, line-length)


14-14: Expected: 250; Actual: 360
Line length

(MD013, line-length)


34-34: Expected: 250; Actual: 437
Line length

(MD013, line-length)


37-37: Expected: 250; Actual: 351
Line length

(MD013, line-length)


42-42: Expected: 250; Actual: 442
Line length

(MD013, line-length)


44-44: Expected: 250; Actual: 287
Line length

(MD013, line-length)


47-47: Expected: 250; Actual: 285
Line length

(MD013, line-length)


53-53: Expected: 250; Actual: 293
Line length

(MD013, line-length)


61-61: Expected: 250; Actual: 281
Line length

(MD013, line-length)


63-63: Expected: 250; Actual: 339
Line length

(MD013, line-length)


65-65: Expected: 250; Actual: 398
Line length

(MD013, line-length)


33-33: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


8-8: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


28-28: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


29-29: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


30-30: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


31-31: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


47-47: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


49-49: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


47-47: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

🔇 Additional comments (3)
packages/docs/blog/2024-10-09-the-database-app/index.md (3)

1-6: LGTM: Frontmatter is well-structured and informative.

The frontmatter provides clear and relevant metadata for the blog post. The slug, title, author, and tag are all appropriate and align with the content of the post.


67-96: LGTM: Effective introduction to SynthQL with clear code example

This section does an excellent job of introducing SynthQL and demonstrating its usage through a well-structured code example. The explanation is concise, and the code snippet effectively illustrates how to declare and use a query with SynthQL. This provides readers with a clear understanding of the library's capabilities and syntax.

🧰 Tools
🪛 LanguageTool

[style] ~71-~71: To elevate your writing, try using a synonym here.
Context: ...bout any of this complexity. I find it hard to come up with a catchy name for it, b...

(HARD_TO)


[typographical] ~71-~71: Consider adding a comma after ‘lately’ for more clarity.
Context: ... come up with a catchy name for it, but lately I've been thinking of SynthQL as a secu...

(RB_LY_COMMA)


1-157: Excellent blog post with valuable insights on database apps and SynthQL

This blog post provides a comprehensive and insightful exploration of database apps and introduces SynthQL as a solution for building them more efficiently. The content is well-structured, with clear explanations and relevant code examples that effectively demonstrate the concepts discussed.

Key strengths of the post include:

  1. A thorough breakdown of database app components
  2. Clear explanations of the challenges in traditional approaches
  3. Effective introduction and demonstration of SynthQL's features
  4. Good balance between technical depth and readability

While there are some minor grammatical and stylistic issues throughout the document, addressing these will further enhance the overall quality of the post. The information provided is valuable for developers looking to understand database apps and explore new tools for building them.

Great job on creating an informative and engaging blog post that will surely be beneficial to your readers!

🧰 Tools
🪛 LanguageTool

[misspelling] ~12-~12: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...oftware developer, I've "re-discovered" a interesting pattern: a surprising numbe...

(EN_A_VS_AN)


[formatting] ~14-~14: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nipulate that data. I say re-discovered, because it's hardly a discovery at all. We've k...

(COMMA_BEFORE_BECAUSE)


[typographical] ~16-~16: Consider adding a comma here.
Context: ...c way such as Airtable, Notion, Retool, and of course the venerable Excel. I call these **"...

(OF_COURSE_COMMA)


[uncategorized] ~20-~20: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... me build database apps ontop of my data so I can build a custom (and hopefully gre...

(COMMA_COMPOUND_SENTENCE)


[style] ~34-~34: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...t's not that React is perfect, but it's a very good abstraction for building complex UIs. T...

(EN_WEAK_ADJECTIVE)


[grammar] ~37-~37: The word ‘believe’ is a verb. Did you mean the noun “belief”?
Context: ...iences. ### The database It is also my believe that Postgres has solved the database p...

(PREPOSITION_VERB)


[typographical] ~40-~40: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...client, so the data needs to be synced. Usually this is done with a REST API. The prob...

(RB_LY_COMMA)


[misspelling] ~46-~46: This word is normally spelled as one.
Context: ...that this data fetching is usually very sub-optimal. Two important problems arise: Over-fet...

(EN_COMPOUNDS_SUB_OPTIMAL)


[typographical] ~51-~51: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...asily to the point where you often have 3-4 levels of dependencies. Now let's ass...

(HYPHEN_TO_EN)


[uncategorized] ~55-~55: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ons get made implicitly by the developer and they result in non-optimal fetching tre...

(COMMA_COMPOUND_SENTENCE)


[style] ~59-~59: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ... the puzzle is the authorization layer. A very big and important layer that often gets neg...

(EN_WEAK_ADJECTIVE)


[style] ~63-~63: To elevate your writing, try using a synonym here.
Context: ...ross the codebase. This makes it really hard to audit and reason about. Even in a sm...

(HARD_TO)


[style] ~71-~71: To elevate your writing, try using a synonym here.
Context: ...bout any of this complexity. I find it hard to come up with a catchy name for it, b...

(HARD_TO)


[typographical] ~71-~71: Consider adding a comma after ‘lately’ for more clarity.
Context: ... come up with a catchy name for it, but lately I've been thinking of SynthQL as a secu...

(RB_LY_COMMA)


[grammar] ~107-~107: The modal verb ‘can’ requires the verb’s base form.
Context: ...ur React components. This means you can built mini-endpoints that are tightly coupled...

(MD_BASEFORM)


[uncategorized] ~139-~139: This expression is usually spelled with a hyphen.
Context: ...features that set it apart: Declarative role based access controls and query whitelisting....

(BASED_HYPHEN)


[typographical] ~141-~141: The conjunction “so that” does not require a comma.
Context: ... to whitelist the query with the backend, so that the backend can check that the user has...

(SO_THAT_UNNECESSARY_COMMA)

🪛 Markdownlint

16-16: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


20-20: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


49-49: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


51-51: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


61-61: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


103-103: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


143-143: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


98-98: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


149-149: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


150-150: Expected: 1; Actual: 3
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


151-151: Expected: 1; Actual: 4
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


152-152: Expected: 1; Actual: 5
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


153-153: Expected: 1; Actual: 6
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


154-154: Expected: 1; Actual: 7
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


155-155: Expected: 1; Actual: 8
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


156-156: Expected: 1; Actual: 9
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


157-157: Expected: 1; Actual: 10
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


12-12: Expected: 250; Actual: 335
Line length

(MD013, line-length)


14-14: Expected: 250; Actual: 360
Line length

(MD013, line-length)


34-34: Expected: 250; Actual: 437
Line length

(MD013, line-length)


37-37: Expected: 250; Actual: 351
Line length

(MD013, line-length)


42-42: Expected: 250; Actual: 442
Line length

(MD013, line-length)


44-44: Expected: 250; Actual: 287
Line length

(MD013, line-length)


47-47: Expected: 250; Actual: 285
Line length

(MD013, line-length)


53-53: Expected: 250; Actual: 293
Line length

(MD013, line-length)


61-61: Expected: 250; Actual: 281
Line length

(MD013, line-length)


63-63: Expected: 250; Actual: 339
Line length

(MD013, line-length)


65-65: Expected: 250; Actual: 398
Line length

(MD013, line-length)


33-33: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


36-36: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


8-8: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)


28-28: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


29-29: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


30-30: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


31-31: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


47-47: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


49-49: Expected: 2; Actual: 1
Spaces after list markers

(MD030, list-marker-space)


47-47: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

Sign up for free to 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.

1 participant