search

allure-framework / allure-js

Allure integrations for JavaScript test frameworks
https://allurereport.org/
Apache License 2.0
228 stars 123 forks source link

Support disabling the plugin #1174

Open edikdeisling opened 1 month ago

edikdeisling commented 1 month ago

Is your feature request related to a problem? Please describe. It is not always necessary to run allure. For example, during development, it's not needed.

Describe the solution you'd like It would be nice to have the same as @cypress/code-coverage logic here(checking env variable) https://github.com/cypress-io/code-coverage/blob/a5a95d5a65be1509a55e81d238cacbf1418652e1/support.js#L279

Or export function, which I should call to run the plugin. For example, in cypress-terminal-report https://github.com/archfz/cypress-terminal-report/blob/master/src/installLogsCollector.ts#L117 But exporting the function is a breaking change.

Describe alternatives you've considered It is possible to make if (env) { await import('allure-cypress') }, but this works only in Component testing with vite dev server. For e2e, cypress has internal webpack logic with not allow to have top-level await

Additional context Add any other context or screenshots about the feature request here.

baev commented 1 month ago

Disabling the Allure integration will break the Allure Runtime API calls. Why does having the Allure plugin bother you?

edikdeisling commented 1 month ago

@baev We're moving the Cypress configuration inside the company to a common package, and allure is a part of this configuration. But not every team needs it. So I want to allow pass "allure: false" somehow.

This will allow not to run of unnecessary code, which produces files on disk, slow test runs and make the system less stable as a whole