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.

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

change *file to *filePath in function parameters #385

Merged
merged 4 commits into from
Dec 19, 2023

Conversation

Casheeew
Copy link
Member

Some parameters are named ...file when in reality they are actually the path to that file.
When I see a parameter named "file", its easy to think that it is a File or Buffer, or when its type is string, the file read to string. This change renames the occurrences where that is the case to "filePath" instead.

It also helps maintain consistency: In functions such as https://github.com/themoeway/yomitan/blob/eb7bf9542c92ea7937d4b4a699ae2d47270da96b/test/document-test.js#L42
it is correctly named htmlFilePath.

@Casheeew Casheeew requested a review from a team as a code owner December 19, 2023 03:05
Copy link

github-actions bot commented Dec 19, 2023

✔️ No visual differences introduced by this PR.

View Playwright Report (note: open the "playwright-report" artifact)

djahandarie
djahandarie previously approved these changes Dec 19, 2023
themoeway-bot
themoeway-bot previously approved these changes Dec 19, 2023
auto-merge was automatically disabled December 19, 2023 04:49

Head branch was pushed to by a user without write access

@Casheeew Casheeew dismissed stale reviews from themoeway-bot and djahandarie via 374ef9e December 19, 2023 04:49
@djahandarie djahandarie added this pull request to the merge queue Dec 19, 2023
Merged via the queue into yomidevs:master with commit ae2e2db Dec 19, 2023
5 checks passed
@Casheeew Casheeew deleted the change-file-to-filePath branch December 19, 2023 10:45
@djahandarie djahandarie added the kind/meta The issue or PR is meta label Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/meta The issue or PR is meta
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants