angular / angular/angular-cli

Workspace library scss import

Offen
#23,552 9 Kommentare 19 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
area: @schematics/angular freq1: low severity3: broken type: bug/fix
Vorherrschende Sprache
TypeScript
Sterne
27k
Forks
11.8k
Ø Merge
14 Std. 23 Min.
Gemergte PRs (30 T.)
162

Beschreibung

# 🚀 Feature request

### Command (mark with an `x`)

- [ ] new
- [x] build
- [ ] serve
- [ ] test
- [ ] e2e
- [x] generate
- [ ] add
- [ ] update
- [ ] lint
- [ ] extract-i18n
- [ ] run
- [ ] config
- [ ] help
- [ ] version
- [ ] doc

### Description

With a workspace architecture, the exported stylesheets cannot be imported using package name. Given a library (`lib`) and a project (`app`) in an angular workspace. The library properly copies an scss file to the `dist` folder (which is the default output folder) and adds it to the `exports` section of the `package.json`. However, the consuming app cannot `@import` or `@use` the exported scss file.

Given the following files:

- dist/my-company/my-lib/assets/_theme.scss
- projects/app/src/styles.scss

And the following export in the `package.json` of the library:

```
"exports": {
"./theme": {
"sass": "./assets/_theme.scss"
}
},
```

And the default settings that the Angular CLI generates (with `ng new library` and so on...),

### Describe the solution you'd like

With the settings mentioned above, importing an exported scss file should work out of the box (currently it does not compile with the error `SassError: Can't find stylesheet to import.`).

```
// styles.scss
@use "@my-company/my-lib/theme" as myTheme;
```

### Describe alternatives you've considered

1. Changing the default `dist` output of the library to the `node_modules` and the automatically removed `@` symbol is added to the path (in short `dist/my-company/my-lib` -> `node_modules/@my-company/my-lib`) resolves the scss import problem. The `tsconfig.json` must be adjusted as well. If this is the desired solution, then it should be the default generated with the CLI.
2. Create an NPM Link to the dist directory (which has its own pros and cons). If this is the desired solution, then the `tsconfig.json` does not need to define additional `paths` and this should be an operation that the generation (through the CLI) does automatically. Or at least extend [the documentation](https://angular.io/guide/creating-libraries#managing-assets-in-a-library).

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginnen Sie mit den Build- und Generate-Pfaden für eine Workspace-Bibliothek und verwenden Sie dist/my-company/my-lib/assets/_theme.scss, den Exports-Eintrag in package.json und projects/app/src/styles.scss als Reproduktionspunkte. Führen Sie den @use-Import der App aus und prüfen Sie die Einstellungen in der generierten tsconfig.json; abgeschlossen ist die Aufgabe, wenn das exportierte SCSS ohne manuelle Pfad- oder npm-link-Workarounds aufgelöst wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
angular, scss, typescript
Bereich
build-system, cli, frontend
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.