Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: rename pluginsFile to backgroundFile #2285

Closed
chrisbreiding opened this issue Aug 6, 2018 · 4 comments
Closed

Proposal: rename pluginsFile to backgroundFile #2285

chrisbreiding opened this issue Aug 6, 2018 · 4 comments
Assignees
Labels
pkg/server This is due to an issue in the packages/server directory type: breaking change Requires a new major release version
Milestone

Comments

@chrisbreiding
Copy link
Contributor

The term pluginsFile is somewhat of a misnomer, since it is exclusive to the background node process, but a plugin could be created that solely affects the driver and events in the browser.

We should rename the pluginsFile to the backgroundFile to make it clear it runs in the background process. We should also update the documentation to make it clear plugins can be implemented for the browser in the supportFile, for the background in the backgroundFile, or both.

Code-wise, we should deprecate the pluginFile config option and log a warning that the user should rename it to backgroundFile. Then in a future version, remove pluginsFile entirely.

@chrisbreiding chrisbreiding added pkg/server This is due to an issue in the packages/server directory external: documentation labels Aug 6, 2018
@chrisbreiding chrisbreiding self-assigned this Aug 6, 2018
@jennifer-shehane jennifer-shehane added the stage: proposal 💡 No work has been done of this issue label Aug 6, 2018
@chrisbreiding chrisbreiding added stage: in progress type: breaking change Requires a new major release version and removed stage: proposal 💡 No work has been done of this issue labels Aug 30, 2018
@chrisbreiding chrisbreiding modified the milestones: Sprint 0.5, Sprint 1 Sep 4, 2018
@brian-mann brian-mann modified the milestones: Sprint 1, Sprint 2 Sep 10, 2018
@chrisbreiding
Copy link
Contributor Author

@chrisbreiding
Copy link
Contributor Author

The code for this is complete, but not yet released. It will be released in 4.0.

@jennifer-shehane
Copy link
Member

The work for this was never released.

@cypress-bot cypress-bot bot added the stage: ready for work The issue is reproducible and in scope label Jun 30, 2020
@jennifer-shehane
Copy link
Member

Closing due to recent changes we've decided to make for the configuration file.

@jennifer-shehane jennifer-shehane removed the stage: ready for work The issue is reproducible and in scope label Jul 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg/server This is due to an issue in the packages/server directory type: breaking change Requires a new major release version
Projects
None yet
Development

No branches or pull requests

3 participants