design-system icon indicating copy to clipboard operation
design-system copied to clipboard

Update Prime NG package setup

Open alizedebray opened this issue 6 months ago • 0 comments

Current PrimeNg Package Setup

Our PrimeNg package currently uses an Angular setup that includes two projects:

  • The styles-primeng library which contains the actual PrimeNG styles
  • The styles-primeng-showcase app used for development purposes to showcase different table settings and styles

However, this setup has two main issues:

  1. Timing Issue: When you try to start the showcase app, the styles aren't yet present in the build folder, leading to an error. Currently, to see the styles, you must manually erase any dependencies, start the app, and then re-add the dependencies. This process is inefficient and error-prone.

  2. SCSS Compilation Issue: With the Angular builder, the library styles are bundled only as assets. As a result, the SCSS files are never compiled to CSS, meaning errors aren't cached during the build process, which can cause issues.

Goal

The goal of this ticket is to update the package setup to address these two issues.

Possible Solutions

  1. Timing Issue: To resolve the timing issue, we could replace npm-run-all with concurrently. For reference, you can check the ESLint package for an example of how this works.

  2. SCSS Compilation Issue: To ensure the SCSS styles are compiled, we have two potential options:

    • Create a custom Angular builder to handle SCSS compilation.
    • Alternatively, move the styles completely out of the Angular setup.

Tasks

  • [ ] Add this info to the contribution guidelines at the package level

alizedebray avatar Apr 16 '25 07:04 alizedebray