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

util: add logging & err handling, docs updates #36

Merged
merged 10 commits into from
Jan 5, 2024
Merged

util: add logging & err handling, docs updates #36

merged 10 commits into from
Jan 5, 2024

Conversation

wexxlee
Copy link
Collaborator

@wexxlee wexxlee commented Jan 4, 2024

PR 3 of 3 (ref: #26 & #28)

A handful of misc. improvements:

  • More robust console logging functionality to the util data scripts and xivapi library
  • Adds the 3 de-pythoned scripts to the npm run util CLI utility (along with a run-all option), and allows the user to specify a logging level to control console output
  • Better error capture throughout
  • Some minor code cleanup (mostly standardization around use of CSV/locale tables)
  • Corresponding docs updates to util/README.md and docs/PatchUpdateChecklist.md

All scripts re-run, no data changes (as expected).

This completes the work I had planned on this project, but in the course of pulling all this together, I wrote a super-lightweight CLI utility (integrated into npm run util ) to run custom queries against xivapi, along with some very basic filtering capability. It came in very handy for investigating data issues, and I could see it being useful if (when 👀 ) future patches create new data collisions or other issues. It needs some cleanup before it's ready for code review, but I'll likely add that as a future PR, time permitting.

@wexxlee wexxlee requested a review from valarnin January 4, 2024 22:16
@github-actions github-actions bot added docs /docs, /screenshots, *.md util /util labels Jan 4, 2024
util/gen_effect_id.ts Outdated Show resolved Hide resolved
@wexxlee wexxlee merged commit 2c7b245 into OverlayPlugin:main Jan 5, 2024
6 checks passed
github-actions bot pushed a commit that referenced this pull request Jan 5, 2024
PR 3 of 3 (ref: #26 & #28)

A handful of misc. improvements:
- More robust console logging functionality to the util data scripts and
xivapi library
- Adds the 3 de-pythoned scripts to the `npm run util` CLI utility
(along with a run-all option), and allows the user to specify a logging
level to control console output
 - Better error capture throughout
- Some minor code cleanup (mostly standardization around use of
CSV/locale tables)
- Corresponding docs updates to `util/README.md` and
`docs/PatchUpdateChecklist.md`

All scripts re-run, no data changes (as expected).

This completes the work I had planned on this project, but in the course
of pulling all this together, I wrote a super-lightweight CLI utility
(integrated into `npm run util` ) to run custom queries against xivapi,
along with some very basic filtering capability. It came in very handy
for investigating data issues, and I could see it being useful if (when
👀 ) future patches create new data collisions or other issues. It needs
some cleanup before it's ready for code review, but I'll likely add that
as a future PR, time permitting. 2c7b245
@wexxlee wexxlee deleted the util-cleanup2 branch January 12, 2024 00:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs /docs, /screenshots, *.md util /util
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants