Skip to content

DO NOT MERGE prevent importing Sass/CSS from JS #1160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
apaleslimghost wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

DO NOT MERGE prevent importing Sass/CSS from JS #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62d37b5
fix(dotcom-build-css): prevent importing CSS from JS files
apaleslimghost Apr 24, 2025
297813e
fix(dotcom-build-sass): prevent importing Sass from JS files
apaleslimghost Apr 24, 2025
effa891
docs(dotcom-build-sass): document preventing sass imports from js
apaleslimghost Apr 24, 2025
58e281b
docs(dotcom-build-css): document preventing css imports from js
apaleslimghost Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/dotcom-build-css/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module.exports = {

This plugin adds a [rule] to the Webpack configuration to handle `.css` files. It calls the [css-loader] package to load and parse the source files. The CSS is optimised using [css-minimizer-webpack-plugin], which runs [cssnano] under the hood. The [mini-css-extract-plugin] is added to generate `.css` files and the [webpack-fix-style-only-entries] to clean up any empty JavaScript bundles.

The CSS loader has `url()` resolution disabled as we don't use, nor recommend, the function currently.
The CSS loader has `url()` resolution disabled as we don't use, nor recommend, the function currently. We also prevent importing CSS from Javascript files, as that's incompatible with the Asset Loader in production.

[rule]: https://webpack.js.org/configuration/module/#rule
[css-loader]: https://github.com/webpack-contrib/css-loader
Expand Down
3 changes: 3 additions & 0 deletions packages/dotcom-build-css/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ export class PageKitCssPlugin {

compiler.options.module.rules.push({
test: [/\.css$/],
issuer: {
not: [/\.(js|ts)x?$/],
},
use: cssRule()
})

Expand Down
2 changes: 1 addition & 1 deletion packages/dotcom-build-sass/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Sass supports both relative paths and paths that can be resolved within your `no
new PageKitSassPlugin({ includePaths: [path.resolve('./path-to-sass-files')] })
```

The CSS loader has `url()` resolution disabled as we don't use, nor recommend, the function currently.
The CSS loader has `url()` resolution disabled as we don't use, nor recommend, the function currently. We also prevent importing Sass from Javascript files, as that's incompatible with the Asset Loader in production.

[rule]: https://webpack.js.org/configuration/module/#rule
[@financial-times/dotcom-build-css]: ../dotcom-build-css
Expand Down
3 changes: 3 additions & 0 deletions packages/dotcom-build-sass/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ export class PageKitSassPlugin {

compiler.options.module.rules.push({
test: [/\.sass|scss$/],
issuer: {
not: [/\.(js|ts)x?$/],
},
use: [
// Load generated CSS using the same logic as
// @financial-times/dotcom-build-css
Expand Down