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

Tweaks to CLI and message extraction utility function #12320

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

rtibbles
Copy link
Member

Summary

  • Properly updates our programmatic invocation of help inside CLI commands to prevent trying to redefine an existing command (needed since the upgrade to commander v12).
  • Ensures the message extraction utility function always returns an object, just empty in the case where a file could not be parsed.

References

Fixes issues seen by @marcellamaki while trying to do a string audit.

Reviewer guidance

Run yarn exec kolibri-tools <name of command> for several of the i18n commands in cli.js to confirm it properly shows the help messages.
Run yarn exec kolibri-tools i18n-audit -- --output-file audit.csv --ditto-file <path to ditto export csv> --pluginFile ./build_tools/build_plugins.txt with a file in one of the plugin src directories that has invalid syntax in it, and confirm it does not error.


Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@github-actions github-actions bot added DEV: tools Internal tooling for development SIZE: small labels Jun 19, 2024
@rtibbles rtibbles added this to the Kolibri 0.17: Planned Patch 1 milestone Jul 1, 2024
@rtibbles rtibbles changed the base branch from develop to release-v0.17.x July 12, 2024 16:17
@marcellamaki marcellamaki self-requested a review October 22, 2024 14:56
Copy link
Member

@marcellamaki marcellamaki left a comment

Choose a reason for hiding this comment

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

Help messages work as expected, and error handling for invalid syntax in .js files also works when doing the string audit!

@rtibbles rtibbles merged commit caa8930 into learningequality:release-v0.17.x Oct 22, 2024
34 checks passed
@rtibbles rtibbles deleted the cli_for_you_and_i branch October 22, 2024 22:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DEV: tools Internal tooling for development SIZE: small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants