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)

  1. cd /Users/scottdejonge/Projects/design.gitlab.com && yarn install the workspace currently has no node_modules, so index.js can't resolve @clack/prompts yet
  2. cd packages/gitlab-create-ui && yarn build copies the pajamas skill into template/.claude; without this both projects scaffold with no skills

Scaffold both

  1. node index.js /tmp/starter-compat --vue-version compat
  2. node index.js /tmp/starter-vue2 --vue-version 2

Run each

Do in separate terminals, they'll both want a port

  1. cd /tmp/starter-compat && yarn install && yarn start
  2. cd /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_EXTEND deprecation warning that's supposed to be suppressed. Vue.extend runs at import time in @gitlab/ui's dropdown, before main.js calls configureCompat
  • 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 — .agents symlink present, .gitignore renamed from gitignore, .claude/skills/pajamas there
  • README.md and AGENTS.md in each — no leftover {{VUE_STACK}} / {{VUE_VERSION_NOTE}} tokens, and the right Vue version note

Also worth exercising the CLI itself

  • node index.js --help
  • node index.js /tmp/x --vue-version 3 → should reject with Unknown 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

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

Documentation

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-label for 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" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.

Related to #3587 (closed)

Edited by Scott de Jonge

Merge request reports

Loading
Loading