feat(module): support src as a function in addModule

[ricardogobbosouza]

Types of changes

• Bug fix (a non-breaking change which fixes an issue)
• New feature (a non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

While developing a module I came across a problem in its coverage.

If you are analyzing the modules such as pwa, moment-module, nuxt-i18n the coverage is made on top of the test folder and not the lib or src, this is why nuxt solves the module using esm by default, so the module is not is covered.

Today to test the modules we created a nuxt.config.js like this:

modules: [
  '@@'
]

and this has no coverage.

With this correction we can create like this:

modules: [
  require('../../')
]

and this has coverage

If we want to create the module using ESM and with coverage we have to add new configurations in jest and babel:

  "babel": {
    "presets": [
      [
        "env",
        {
          "modules": false
        }
      ]
    ],
    "env": {
      "test": {
        "presets": [
          [
            "env",
            {
              "targets": {
                "node": "current"
              }
            }
          ]
        ]
      }
    }
  },
  "jest": {
    "testEnvironment": "node",
    "collectCoverage": true,
    "collectCoverageFrom": [
      "lib/**/*.js"
    ],
    "transform": {
      "^.+\\.js$": "babel-jest"
    }
  }

and add the dependencies babel-jest and babel-preset-env

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly. (PR: #)
• I have added tests to cover my changes (if not applicable, please state why)
• All new and existing tests are passing.

[manniL]

Does that fix #4119 😱

[ricardogobbosouza]

@manniL yeah! ::smiley:
I didn't realize that I had issue

[pi0]

Fantastic investigation and improvement for module coverage. For ecosystem consistency, I suggest not documenting this to prevent module incompatibility for 2.x users prior to this version.

@ricardogobbosouza Would you please also open a PR on module template to reflect changes to the default test suit?

[ricardogobbosouza]

@pi0 I will suggest improvements in module-template

[ricardogobbosouza]

Fantastic investigation and improvement for module coverage. For ecosystem consistency, I suggest not documenting this to prevent module incompatibility for 2.x users prior to this version.

@ricardogobbosouza Would you please also open a PR on module template to reflect changes to the default test suit?

@pi0 PR on module template
nuxt-community/module-template#9