Add types

[OliverJAsh]

Hey! Could we add these types to the repository so TS users don't have to define them manually? 😄

declare module '@cypress/webpack-preprocessor' {
  import * as webpack from 'webpack';

  type FilePreprocessor = (file: Cypress.FileObject) => string | Promise<string>;

  namespace _default {
    export type Options = { webpackOptions: webpack.Configuration };
  }

  const _default: (options: _default.Options) => FilePreprocessor;

  export = _default;
}

[jennifer-shehane]

This is very low priority for us, but we would be open to a PR.

[NickBolles]

@OliverJAsh are you using typescript in plugin files? if so how? Regardless, VSCode uses typescript types for intellisense for javascript too. I'll take a crack at this today.

[OliverJAsh]

Yes, via the checkJs compiler option.

[chrisbreiding]

The main cypress package now includes types for the plugins file. See this example for how to utilize them.

[OliverJAsh]

Does it include types for module @cypress/webpack-preprocessor?

[OliverJAsh]

E.g. if I do this in my plugins file:

const webpack = require('@cypress/webpack-preprocessor');

I want webpack to have types.

[chrisbreiding]

🎉 This issue has been resolved in version 5.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[OliverJAsh]

Unfortunately this is not quite fixed: https://github.com/cypress-io/cypress-webpack-preprocessor/pull/72/files#r404905879

Can we re-open? @chrisbreiding

[chrisbreiding]

Properly fixed in 5.1.1

[OliverJAsh]

How do I import the Options type? I would like to use that type to annotate my options.

[OliverJAsh]

const webpack = require('@cypress/webpack-preprocessor');
// Namespace '_default' has no exported member 'Options'
/** @type {webpack.Options} */
const options = {
  webpackOptions: {}
}