https://github.com/huang-julien/nuxt-runtime-compiler

A simple module to enable vue runtime bundle on Nuxt 2 and 3
https://github.com/huang-julien/nuxt-runtime-compiler

nuxt nuxt-module nuxtjs ssr vue

Last synced: about 1 month ago
JSON representation

A simple module to enable vue runtime bundle on Nuxt 2 and 3

• Host: GitHub
• URL: https://github.com/huang-julien/nuxt-runtime-compiler
• Owner: huang-julien
• Created: 2022-05-01T22:22:39.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-05-17T21:50:40.000Z (over 1 year ago)
• Last Synced: 2024-05-02T04:19:48.958Z (7 months ago)
• Topics: nuxt, nuxt-module, nuxtjs, ssr, vue
• Language: TypeScript
• Homepage:
• Size: 629 KB
• Stars: 17
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nuxt-runtime-compiler

A simple module to enable vue runtime bundle on Nuxt 2 and 3

:rocket: Runtime bundle can now be enabled in Nuxt 3.4 with `experimental.runtimeVueCompiler` and `vue.runtimeCompiler` in Nuxt 3.5 .

## Configuration

Add the module to nuxt config file:

`nuxt.config.ts`

```ts

export default defineNuxtConfig({

    modules: ['nuxt-runtime-compiler']

})

```

## Options 

The module has some options built-in

```ts

interface NuxtRuntimeCompilerOptions {

  nodeModulesRoot?: string

}

```

### nodeModulesRoot

You can specify the node_modules root directory if your `node_modules` directory is not at your `process.cwd()`.

- Default value is `./`

For example if you are running `nuxt build` from a project in `root/packages/{YOUR_WORKSPACE}` while your `node_modules` is in `root/`

then the nodeModulesRoot should be 

```ts

export default defineNuxtConfig({

    modules: ['nuxt-runtime-compiler', {

        nodeModulesRoot: "../../"

    }]

})

```

## RuntimeCompilerOptions

See [app.config documentation](https://nuxt.com/docs/examples/app/app-config)

This module overloads the `AppConfig` exported by `app.config.ts` to pass the [RuntimeCompilerOptions](https://github.com/vuejs/core/blob/dbe7109c8f6417770129dc92313f05feac0c0edb/packages/runtime-core/src/componentOptions.ts#L213-L218) to your VueApp in runtime.

Compatible options from [RuntimeCompilerOptions](https://github.com/vuejs/core/blob/dbe7109c8f6417770129dc92313f05feac0c0edb/packages/runtime-core/src/componentOptions.ts#L213-L218) in `app.config` will also be used by the builder during build time.

`app.config.ts`

```ts

export default defineAppConfig({

  vue: {

    compilerOptions: {

      isCustomElement: (tag) => {

        return [

          'math',

          'maction',

        ].includes(tag)

      }

    }

  }

})

```