Skip to content

Don't use variables for string keys#3613

Merged
rtibbles merged 1 commit intolearningequality:unstablefrom
bjester:string-keys
Sep 8, 2022
Merged

Don't use variables for string keys#3613
rtibbles merged 1 commit intolearningequality:unstablefrom
bjester:string-keys

Conversation

@bjester
Copy link
Copy Markdown
Member

@bjester bjester commented Sep 8, 2022

Summary

Description of the change(s) you made

  • String extraction is complicated when using variables for string keys, so this removes those and creates JSDoc references instead to maintain references to those variables

References

https://learningequality.slack.com/archives/C0LE9NLCE/p1662595256874999

Comments


Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • 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
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • 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

@bjester bjester added the javascript Pull requests that update Javascript code label Sep 8, 2022
@rtibbles rtibbles merged commit d7785c7 into learningequality:unstable Sep 8, 2022
Comment on lines +254 to +263
/* eslint-disable kolibri/vue-no-unused-translations */
/** @see TabNames.DETAILS */
details: 'Details',
/** @see TabNames.PREVIEW */
preview: 'Preview',
/** @see TabNames.QUESTIONS */
questions: 'Questions',
/** @see TabNames.RELATED */
related: 'Related',
/* eslint-enable kolibri/vue-no-unused-translations */
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Love the JSDoc replacement, thanks @bjester

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

javascript Pull requests that update Javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants