gitlab-ui-starter Add a Vue version prompt with a @vue/compat template
What does this MR do?
yarn create @gitlab/ui now asks which Vue version to scaffold. The new
default is Vue 3 through the migration build (@vue/compat), matching
how GitLab runs Vue 3, with vue-router 4 and compat mode configured in
src/compat.js. Vue 2.7 with vue-router 3 remains available as the
second option, unchanged from what the kit produced before.
Setup
Initial setup (once)
cd /Users/scottdejonge/Projects/design.gitlab.com && yarn installthe workspace currently has nonode_modules, soindex.jscan't resolve@clack/promptsyetcd packages/gitlab-create-ui && yarn buildcopies thepajamasskill intotemplate/.claude; without this both projects scaffold with no skills
Scaffold both
node index.js /tmp/starter-compat --vue-version compatnode index.js /tmp/starter-vue2 --vue-version 2
Run each
Do in separate terminals, they'll both want a port
cd /tmp/starter-compat && yarn install && yarn startcd /tmp/starter-vue2 && yarn install && yarn start
Check
- Browser console on the compat app — that's where the ordering issue would show, as a
GLOBAL_EXTENDdeprecation warning that's supposed to be suppressed.Vue.extendruns at import time in@gitlab/ui's dropdown, beforemain.jscallsconfigureCompat - Dropdowns and buttons in the compat app specifically — those are the components that break when compat can't adapt the vnodes
ls -a /tmp/starter-compat—.agentssymlink present,.gitignorerenamed fromgitignore,.claude/skills/pajamasthereREADME.mdandAGENTS.mdin each — no leftover{{VUE_STACK}}/{{VUE_VERSION_NOTE}}tokens, and the right Vue version note
Also worth exercising the CLI itself
node index.js --helpnode index.js /tmp/x --vue-version 3→ should reject withUnknown Vue version "3". Pass one of compat, 2.
To validate the packaging fix rather than the checkout, use npm pack and scaffold from the tarball instead
Integrations
- GitLab: mr_url
- CustomersDot: mr_url
- Duo UI: mr_url
- Status Page: mr_url
- Docs: mr_url
- Switchboard: mr_url
Does this MR meet the acceptance criteria?
This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.
Toggle the acceptance checklist
Conformity
- The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”.
- For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
- Relevant label(s) are applied to the MR.
- The MR is added to a milestone.
- Added the
~"component:*"label(s) if applicable. - A changeset is added when this MR will do a patch, minor, or major update. More information can be found in
doc/changesets.md.
Components
- GitLab UI's contributing guidelines.
- If the MR changes a component's API, integration MR(s) have been opened (see integrations above).
Documentation
- If creating a new component page from scratch, it follows the page template structure.
- Content follows the GitLab Documentation Style Guide when appropriate.
- Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter.
- If embedding a Figma file, it follows the Figma embed guide.
- Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.
- Maintainer review follows the Pajamas UX maintainer review checklist.
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
- Label as security and @ mention
@gitlab-com/gl-security/appsec - Security reports checked/validated by a reviewer from the AppSec team
Accessibility
If this MR adds or modifies a component, take a few moments to review the following:
- All actions and functionality can be done with a keyboard.
- Links, buttons, and controls have a visible focus state.
- All content is presented in text or with a text equivalent. For example, alt text for SVG, or
aria-labelfor icons that have meaning or perform actions. - Changes in a component’s state are announced by a screen reader. For example, changing
aria-expanded="false"toaria-expanded="true"when an accordion is expanded. - Color combinations have sufficient contrast.
Related to #3587 (closed)