Skip to content

refactor: Move entry points to src/

Lukas 'ai-pi' Eipert requested to merge leipert-move-entry-points into main

What does this MR do?

This moves our source entry points from the root folder to the src/ folder. This has the following benefits:

  1. Simpler rollup config, as src/ and dist/ will have the same resulting structure.
  2. Allows it to switch to consume the source of GitLab UI more easily. We could for example simply tell webpack in GitLab to replace imports from @gitlab/ui/dist with @gitlab/ui/src.

BREAKING CHANGE: If you consumed GitLab UI from source (e.g. @gitlab/ui/index.js, you need to adjust the import to @gitlab/ui/src/index.js

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

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.
Edited by Lukas 'ai-pi' Eipert

Merge request reports