.nuxtignore

You can use a .nuxtignore file to let Nuxt.js ignore layout, page, store and middleware files in your project’s root directory (rootDir) during the build phase. The .nuxtignore file is subject to the same specification as .gitignore and .eslintignore files, in which each line is a glob pattern indicating which files should be ignored.

For example:

# ignore layout foo.vue
layouts/foo.vue
# ignore layout files whose name ends with -ignore.vue
layouts/*-ignore.vue

# ignore page bar.vue
pages/bar.vue
# ignore page inside ignore folder
layouts/ignore/*.vue

# ignore store baz.js
store/baz.js
# ignore store files match *.test.*
store/ignore/*.test.*

# ignore middleware files under foo folder except foo/bar.js
middleware/foo/*.js
!middleware/foo/bar.js

More details about the spec are in gitignore doc

The ignorePrefix Property

  • Type: String
  • Default: '-'

Any file in pages/ layout/ middleware/ or store/ will be ignored during building if its filename starts with the prefix specified by ignorePrefix.

By default all files which start with - will be ignored, such as store/-foo.js and pages/-bar.vue. This allows for co-locating tests, utilities, and components with their callers without themselves being converted into routes, stores, etc.

Note: This option will be deprecated in Nuxt.js 3. We recommend using a .nuxtignore file instead.

The ignore Property

  • Type: Array
  • Default: ['**/*.test.*']

More customizable than ignorePrefix: all files matching glob patterns specified inside ignore will be ignored in building.

Note: This option will be deprecated in Nuxt.js 3. We recommend using a .nuxtignore file instead.

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!