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

Document the available plugin events in the scaffold file #1861

Open
brian-mann opened this Issue Jun 3, 2018 · 3 comments

Comments

4 participants
@brian-mann
Member

brian-mann commented Jun 3, 2018

Currently the scaffolded file looks like this...

// ***********************************************************
// This example plugins/index.js can be used to load plugins
//
// You can change the location of this file or turn off loading
// the plugins file with the 'pluginsFile' configuration option.
//
// You can read more here:
// https://on.cypress.io/plugins-guide
// ***********************************************************

// This function is called when a project is opened or re-opened (e.g. due to
// the project's config changing)

module.exports = (on, config) => {
  // `on` is used to hook into various events Cypress emits
  // `config` is the resolved Cypress config
}

I think this puts too much emphasis on "turning off this file" - there's not really even a use case of that, and instead we should maybe list out the available plugin events.

The only problem I see with this is that when this file is scaffolded - it's scaffolded based on the current version of Cypress. As users upgrade Cypress we may release new plugin events but they won't be listed into the commented out code.

@jennifer-shehane

This comment has been minimized.

@wildaces215

This comment has been minimized.

wildaces215 commented Sep 7, 2018

Is this open?

@jennifer-shehane

This comment has been minimized.

Member

jennifer-shehane commented Sep 10, 2018

@wildaces215 Yes, no work has been done on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment