Add jsdoc pluginsfile (#354)

* lowercase reference types * add jsdoc to pluginsFile for type-completions * trigger ci Co-authored-by: Gleb Bahmutov <[email protected]>
cypress-io · Feb 5, 2020 · 035fa6c · 035fa6c
1 parent 3506918
commit 035fa6c
Show file tree

Hide file tree

Showing 20 changed files with 23 additions and 19 deletions.
diff --git a/cypress/integration/examples/actions.spec.js b/cypress/integration/examples/actions.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Actions', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/aliasing.spec.js b/cypress/integration/examples/aliasing.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Aliasing', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/assertions.spec.js b/cypress/integration/examples/assertions.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Assertions', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/connectors.spec.js b/cypress/integration/examples/connectors.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Connectors', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/cookies.spec.js b/cypress/integration/examples/cookies.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Cookies', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/cypress_api.spec.js b/cypress/integration/examples/cypress_api.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Cypress.Commands', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/files.spec.js b/cypress/integration/examples/files.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 /// JSON fixture file can be loaded directly using
 // the built-in JavaScript bundler

diff --git a/cypress/integration/examples/local_storage.spec.js b/cypress/integration/examples/local_storage.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Local Storage', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/location.spec.js b/cypress/integration/examples/location.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Location', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/misc.spec.js b/cypress/integration/examples/misc.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Misc', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/navigation.spec.js b/cypress/integration/examples/navigation.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Navigation', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/network_requests.spec.js b/cypress/integration/examples/network_requests.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Network Requests', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/querying.spec.js b/cypress/integration/examples/querying.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Querying', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/spies_stubs_clocks.spec.js b/cypress/integration/examples/spies_stubs_clocks.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Spies, Stubs, and Clock', () => {
   it('cy.spy() - wrap a method in a spy', () => {

diff --git a/cypress/integration/examples/traversal.spec.js b/cypress/integration/examples/traversal.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Traversal', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/utilities.spec.js b/cypress/integration/examples/utilities.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Utilities', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/viewport.spec.js b/cypress/integration/examples/viewport.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Viewport', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/waiting.spec.js b/cypress/integration/examples/waiting.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Waiting', () => {
   beforeEach(() => {

diff --git a/cypress/integration/examples/window.spec.js b/cypress/integration/examples/window.spec.js
@@ -1,4 +1,4 @@
-/// <reference types="Cypress" />
+/// <reference types="cypress" />
 
 context('Window', () => {
   beforeEach(() => {

diff --git a/cypress/plugins/index.js b/cypress/plugins/index.js
@@ -1,3 +1,4 @@
+/// <reference types="cypress" />
 // ***********************************************************
 // This example plugins/index.js can be used to load plugins
 //
@@ -11,6 +12,9 @@
 // This function is called when a project is opened or re-opened (e.g. due to
 // the project's config changing)
 
+/**
+ * @type {Cypress.PluginConfig}
+ */
 // eslint-disable-next-line no-unused-vars
 module.exports = (on, config) => {
   // `on` is used to hook into various events Cypress emits