Workspace library scss import
- 主要言語
- TypeScript
- スター
- 27k
- フォーク
- 11.8k
- 平均マージ
- 14時間 23分
- マージ済み PR(30日)
- 162
説明
# 🚀 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).
コントリビューションガイド
調査の方向性
ワークスペースライブラリの build パスと generate パスから始め、再現ポイントとして生成された dist/my-company/my-lib/assets/_theme.scss、package.json の exports エントリ、projects/app/src/styles.scss を使用します。アプリの @use インポートを実行し、生成された tsconfig.json の設定を確認します。完了条件は、手動のパス指定や npm-link の回避策なしでエクスポートされた SCSS が解決されることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- angular, scss, typescript
- 領域
- build-system, cli, frontend
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100