Send PRs to all plugins

[ehmicky]

We should go through each plugin from the list we have and send a PR with:

• Add keywords "netlify" and "netlify-plugin" in the package.json if missing
• Add repository "user/repo" in the package.json if missing
• Add bugs { "url": "https://github.com/user/repo/issues" } in the package.json if missing
• Ensure the latest names for the arguments passed to event handlers are used
• Ensure the latest names for the constants are used
• Ensure the latest names for the events are used
• Use utils.build.* where possible
• Remove the name and config properties from the main JavaScript file
• Add a manifest.yml including the name and each inputs (name, default, required). Explain in the PR that we are working on adding more validation keywords.

For the following plugins:

• netlify-plugin-cypress - PR 1, PR 2
• netlify-plugin-gatsby-cache - PR
• netlify-plugin-prisma-provider - PR
• netlify-plugin-checklinks - PR
• netlify-plugin-subfont - PR, PR 2, PR 3, PR 4
• netlify-plugin-sitemap - PR
• netlify-cache-nextjs - PR
• netlify-plugin-env - PR, Issue
• netlify-plugin-a11y - PR 1, PR 2, PR 3, PR 4, PR 5, PR 6, PR 7, PR 8, PR 9, PR 10, PR 11, PR 12, PR 13
• netlify-plugin-debug-cache - PR
• netlify-plugin-rss - PR 1, PR 2, PR 3, PR 4, PR 5, PR 6
• netlify-plugin-inline-source - PR 1, PR 2
• netlify-plugin-ghost-markdown - PR
• netlify-plugin-hashfiles - Several pending PRs
• netlify-plugin-no-more-404 - Several pending PRs
• netlify-deployment-hours-plugin - PR 1, PR 2, PR 3, PR 4, PR 5
• netlify-build-plugin-speedcurve - PR
• netlify-plugin-fetch-feeds - Several pending PRs
• netlify-plugin-yield-data-for-eleventy - Several pending PRs
• netlify-plugin-image-optim - Several pending PRs
• netlify-plugin-search-index - PR 1, PR 2, PR 3, more pending PRs
• netlify-plugin-encrypted-files - Several pending PRs
• netlify-plugin-out-of-minutes

[ehmicky]

As I go along each plugin, I will compile a list of common mistakes. This can used:

• For QA check before adding the plugin to our list
• For a future linting tool
• For our documentation

The current list of mistakes follows.

Missing metadata:

• package.json should contain the keywords "netlify" and "netlify-plugin"
• package.json should contain a repository property
• package.json should contain a bugs property
• package.json should contain an engines.node property. 12.16.3 needs to be allowed by the version range. We recommend allowing at least >=8.3.0.
• A manifest.yml file should be present
• If the package.json has a files field, it should include the manifest.yml
• If there is a .npmignore file, it should not include the manifest.yml
• Plugin inputs should use the default keyword in the manifest.yml instead of assigning a default value in the JavaScript file
• Plugin inputs should use the required keyword in the manifest.yml instead of validating whether the input is defined in the JavaScript file

Utilities:

• the constants argument and Netlify environment variables should be used when possible
• the cache utility should be used to cache files
• the run utility should be used to execute commands and child processes
• the git utility and the Netlify environment variables should be used to retrieve git-related information

Control flow:

• Async event handlers should not end until all async operations have completed (success or failure)
• process.exit() should not be used
• Errors that are not bugs should be reported with utils.build.failPlugin() (if the build can continue) or utils.build.failBuild() (if the build should stop). Throwing errors should not be used.
• Successful information that should be exposed in the UI build summary should use utils.status.show(), not console.*().
• utils.build.failPlugin() should be used, not utils.status.show(), to log errors.
• The JavaScript file should preferably export an object. A function should be exported instead only if some event handlers are enabled/disabled depending on user inputs.

Older syntax:

• Plugin JavaScript files should not contain the name nor config properties
• Ensure inputs are not called config nor pluginConfig
• Ensure the constants names are valid
• Ensure the events names are valid

Optional but recommended:

• Repository name, package.json name and manifest name should be the same
• Plugin name should start with netlify-plugin-
• There should be automated tests

[Munter]

@ehmicky netlify-plugin-hashfiles should be up to date now

[ehmicky]

PRs have been sent to all plugins currently in our plugins.json.

I went through the list of all those plugins and checked which ones were using any deprecated syntax described in #1303, that we intend to remove before GA as a breaking change. I have made a PR to fix each instance of those (marked as PR below). This is the list.

• netlify-plugin-encrypted-files
  • pluginConfig -> inputs (PR)
  • remove plugin.name (PR)
  • onInit -> onPreBuild (PR)
• netlify-plugin-prerender-spa
  • remove plugin.name (PR)
• netlify-plugin-get-env-vars
  • remove plugin.name (PR)
• netlify-plugin-chromium
  • missing manifest.yml (PR)
  • onInstall -> onPreBuild (PR)
• netlify-plugin-to-all-events
  • onInit -> onPreBuild (PR)

[Munter]

netlify-plugin-hashfiles has been updated and released in v4.0.2

[Munter]

netlify-plugin-checklinks has been updated and released in v4.1.1

[ehmicky]

Thanks a lot @Munter! 🎉

[ehmicky]

PR to temporarily disable the remaining plugins: netlify/plugins#45.
Closing this issue.