Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Add error handling for nonexistent file case with --file option #5086

Merged
merged 29 commits into from
Jun 25, 2024
Merged

fix: Add error handling for nonexistent file case with --file option #5086

merged 29 commits into from
Jun 25, 2024

Conversation

khoaHyh
Copy link
Contributor

@khoaHyh khoaHyh commented Jan 24, 2024 •
edited by JoshuaKGoldberg
Loading

🔎 Overview

Fixes #4047

  • Added validation to the file(s) passed in to the --file option by resolving the argument to an absolute path and check for its existence. We now log a warning and exit if the file does not exist.
    • the errors for --require bubble up to the middleware in lib/cli/run.js. See here. This specific error occurs in lib/cli/run-helpers.js in the singleRun method when we load files asynchronously. Since we were lacking error handling there, the errors appeared the way they previously did before these changes.
  • Added a test to assert our changes

Screenshot from 2024-02-07 00-34-30

@khoaHyh
feat: handle nonexistent files passed to --file
bd47d79 
- added error handling when using the --file flag to do it the way
  --require does
- added a test to assert that we throw the same type of error
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Jan 24, 2024 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@khoaHyh khoaHyh marked this pull request as ready for review January 24, 2024 06:57
@khoaHyh khoaHyh changed the title ISSUE #4047: Add error handling for nonexistent file case with --file option feat: Add error handling for nonexistent file case with --file option Jan 24, 2024
@khoaHyh
refactor: remove path.resolve()
4aad184 
- require.resolve() by Node.js follows a Node.js module resolution algo
  which includes checking if the resolved path actually exists on the
  file system.
@khoaHyh
add comment to new code in collect-files.js
8983b84
@khoaHyh
fix: add back absolute path resolving
b6d6dc2
@khoaHyh khoaHyh mentioned this pull request Feb 7, 2024
Closed
@coveralls
Copy link

coveralls commented Feb 7, 2024 •
edited
Loading

Coverage Status

coverage: 94.257% (-0.1%) from 94.358%
when pulling 1a9f155 on khoaHyh:issue/4047
into 472a8be on mochajs:master.

JoshuaKGoldberg
JoshuaKGoldberg requested changes Mar 4, 2024
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! 😎

Requesting changes on adding a bit more testing. But also let's talk about the direction a bit - I feel nervous adding in process.exit/throws deep within code. Thanks for sending!

test/integration/options/file.spec.js Show resolved Hide resolved
lib/cli/collect-files.js Outdated Show resolved Hide resolved
@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author waiting on response from OP - more information needed label Mar 4, 2024
khoaHyh
khoaHyh commented May 29, 2024
View reviewed changes
Copy link
Contributor Author

@khoaHyh khoaHyh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JoshuaKGoldberg tagging for re-review just in case this disappeared into the backlog abyss 😅

@nerds-github nerds-github mentioned this pull request Oct 24, 2024
Open
@abdulrahman305 abdulrahman305 mentioned this pull request Oct 27, 2024
Open
This was referenced Nov 1, 2024
Open
Open
Open
Open
@HaLaGu1L HaLaGu1L mentioned this pull request Nov 1, 2024
Open
This was referenced Nov 1, 2024
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
This was referenced Nov 9, 2024
Open
Open
@SkyeFull90 SkyeFull90 mentioned this pull request Nov 9, 2024
Open
This was referenced Nov 9, 2024
Open
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoshuaKGoldberg JoshuaKGoldberg JoshuaKGoldberg approved these changes

@voxpelli voxpelli Awaiting requested review from voxpelli

Assignees
No one assigned
Labels
semver-patch implementation requires increase of "patch" version number; "bug fixes"
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

🚀 Feature: Better error for --file option with non-existent file
4 participants
@khoaHyh @coveralls @JoshuaKGoldberg @voxpelli