#52338: docs: fix command for clang-tidy usage
Merged
Description of Change
npm run needs an extra -- to make sure the arguments are passed to the script, instead of npm itself.
$ npm run --help
Run arbitrary package scripts
Usage:
npm run <command> [-- <args>]
The example command fails with:
$ npm run lint:clang-tidy --out-dir ../out/Testing
npm warn "../out/Testing" is being parsed as a normal command line argument.
npm warn Unknown cli config "--out-dir". This will stop working in the next major version of npm.
> @electron-ci/dev-root@0.0.0-development lint:clang-tidy
> ts-node ./script/run-clang-tidy.ts ../out/Testing
--out-dir is a required argument
Checklist
- I have filled out the PR description
- I have reviewed and verified the changes
- relevant API documentation, tutorials, and examples are updated and follow the documentation style guide
Release Notes
Notes: none
Backports
Semver Impact
Major
Breaking changes
Minor
New features
Patch
Bug fixes
None
Docs, tests, etc.
Semantic Versioning helps users understand the impact of updates:
- Major (X.y.z): Breaking changes that may require code modifications
- Minor (x.Y.z): New features that maintain backward compatibility
- Patch (x.y.Z): Bug fixes that don't change the API
- None: Changes that don't affect using facing parts of Electron