How to make ignores work?

[davestewart]

Hi.

I've been trying to make ignores work properly, but I don't understand the intended usage.

The docs suggest you can ignore words:

• https://content.nuxtjs.org/api/configuration#ignores

The module options restrict you to strings but the module code suggests that you can pass a RegExp:

https://github.com/nuxt/content/blob/main/src/module.ts#L646-L661

        let keys = await storage.getKeys('content:source')

        // Filter invalid characters & ignore patterns
        const invalidKeyCharacters = "'\"?#/".split('')
        const contentIgnores: Array<RegExp> = contentContext.ignores.map((p: any) =>
          typeof p === 'string' ? new RegExp(`^${p}|:${p}`) : p
        )
        keys = keys.filter((key) => {
          if (key.startsWith('preview:') || contentIgnores.some(prefix => prefix.test(key))) {
            return false
          }
          if (invalidKeyCharacters.some(ik => key.includes(ik))) {
            return false
          }
          return true
        })

And if you pass a string, the RegExp effectively limits you to matching the start of key segments, which suggests folders prefixes only.

This makes sense in the terms of the supplied defaults:

ignores: ['\\.', '-'],

But it doesn't really seem to provide a particularly intuitive way to programatically ignore items.

Would you consider modifying the defaults so the internal code could be simplified to something like this:

const ignores: string[] = [
  '^[.-]|:[.-]'
]

Also of note; ignores doesn't have any effect on the storage instance at the bottom of src/module.ts. Saving ignored files still triggers sockets and refreshNuxtData()

Thanks,
Dave

[davestewart]

For anyone following in my footsteps, I got to the bottom of it, created an issue (#2017) and a PR (#2022). 🤞 it's OK and gets merged!