Overview:

Server Block Nuxt is an experimental Nuxt module that adds server block support in your pages components. It allows you to write API handlers conveniently within your pages components.

Features:

• Server Block Support: Write API handlers within your pages components.
• Automatic Installation: The module and volar extension are installed automatically when you add the module to your Nuxt config.
• Custom Routes: Override the default route convention with the path attribute.
• Multiple HTTP Methods Support: All HTTP methods are supported for server block handlers.
• Clear Boundary: <server> blocks are completely removed from the Single File Component (SFC) and don’t interfere with <template> or <script> tags.
• Syntax Highlighting: Works in environments that use the lang attribute.
• No Need for defineServerProps or Loaders: You can combine Server Block Nuxt with other libraries for form actions and loaders.
• Gitignore File Generation: A .gitignore file will be generated to exclude the generated files from being committed to your repository.

Installation:

To install Server Block Nuxt, follow these steps:

1. Install the module and the volar extension:

npm install server-block-nuxt volar

2. Add the module to your Nuxt config:

// nuxt.config.js
export default {
  modules: [
    'server-block-nuxt',
  ],
}

Summary:

Server Block Nuxt is an experimental Nuxt module that adds server block support to your pages components. It allows you to conveniently write API handlers within your pages components. The module automatically installs the volar extension and provides features such as custom routes, support for multiple HTTP methods, and a clear boundary between the server block and other parts of the Single File Component. It also generates a .gitignore file to exclude the generated files from being committed to your repository. Feedback, issues, and contributions are welcome.