feat: publish only core files to npm package

[MikeMcC399]

Situation

The npm package eslint-plugin-cypress published to the npm registry includes files that are not necessary to run the plugin. This bloats the package making it twice the size it needs to be.

The current package.json contains no files options. When this option is omitted, it defaults to ["*"], which means it includes all files from the repo.

Change

Add a files option to package.json.

For linting add the directory:

• lib

For links in the README.md, add

• docs directory
• CONTRIBUTING.md file

The following files are automatically included:

• LICENSE
• README.md
• package.json

Other files, that are used to set up the repo for development, in CI, for internal testing, and are not needed to run the plugin as a package, are not published with the package to the npm registry.

Impact

The reduction for each of the following metrics related to the published npm package eslint-plugin-cypress is approximately 65%:

Metric	Before	After
# files	84	30
package size	37.2 kB	13.0 kB
unpacked size	157.7 kB	55.2 kB

Verification

Execute the following:

git clean -xfd
npm ci
npm pack

and inspect the list of files packed into the npm package. There should be 30 files in the package.

Linting

mv eslint-plugin-cypress-0.0.0-development.tgz test-project
cd test-project
npm install eslint@latest eslint-plugin-cypress-0.0.0-development.tgz -D
npx eslint
npx eslint --config eslint-configs/eslint.default.mjs
npx eslint --config eslint-configs/eslint.default-deprecated.mjs
npx eslint --config eslint-configs/eslint.globals.mjs
npx eslint --config eslint-configs/eslint.recommended.mjs

No linting or other errors should be reported.

Markdown links

npm install markdown-link-check -g
markdown-link-check node_modules/eslint-plugin-cypress/README.md

No link errors should be reported.

Clean up

Clean up temporary files:

cd ..
git restore .
git clean -xfd
git status

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[jennifer-shehane]

🎉 This PR is included in version 5.1.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀