node-sass VS css-modules

For many years, Culture Amp took the second option, and distributed shared components without compiled CSS. This meant that every app that consumed shared components needed to include the necessary CSS build tooling – at that time CSS Modules and node-sass – with a compatible version and configuration. This was relatively easy to set up, but over time proved difficult to maintain. When node-sass was deprecated in favour of (the much faster but slightly incompatible) Dart Sass, this demanded a difficult lock-step migration across all those codebases, which we have yet to achieve. And as new applications have switched to Tailwind for their own styles, they've had to continue to maintain those old build tools in parallel for the shared components' styles.

The project that we developed use a node version 14.18.0 and we use a node-sass version 4.14.1 package and this package also deprecated for today.

ES 2 component Sass files are compiled using dart Sass instead of node-sass. This change was made because node-sass has been deprecated.

node-sass - yes i am aware its deprecated 😅

C:\Webparts\react-script-editor>npm install npm WARN deprecated @types/[email protected]: This is a stub types definition. classnames provides its own type definitions, so you do not need this installed. > [email protected] install C:\Webparts\react-script-editor\node_modules\node-sass > node scripts/install.js Downloading binary from https://github.com/sass/node-sass/releases/download/v4.12.0/win32-x64-83_binding.node Cannot download "https://github.com/sass/node-sass/releases/download/v4.12.0/win32-x64-83_binding.node": HTTP error 404 Not Found

Are you referring to when it's trying to download 'https://github.com/sass/node-sass/releases/download/v4.12.0/win32-x64-83_binding.node' after I typed 'npm install'?

This Github issue helped me a lot.

remote: ERROR in ./app/javascript/stylesheets/application.scss (./node_modules/css-loader/dist/cjs.js??ref--7-1!./node_modules/postcss-loader/src??ref--7-2!./node_modules/sass-loader/dist/cjs.js??ref--7-3!./app/javascript/stylesheets/application.scss) remote: Module build failed (from ./node_modules/sass-loader/dist/cjs.js): remote: Error: Node Sass does not yet support your current environment: Linux 64-bit with Unsupported runtime (93) remote: For more information on which environments are supported please see: remote: https://github.com/sass/node-sass/releases/tag/v4.14.1 remote: at module.exports (/tmp/build_37040035/node_modules/node-sass/lib/binding.js:13:13) remote: at Object. (/tmp/build_37040035/node_modules/node-sass/lib/index.js:14:35) remote: at Module._compile (node:internal/modules/cjs/loader:1101:14) remote: at Object.Module._extensions..js (node:internal/modules/cjs/loader:1153:10) remote: at Module.load (node:internal/modules/cjs/loader:981:32) remote: at Function.Module._load (node:internal/modules/cjs/loader:822:12) remote: at Module.require (node:internal/modules/cjs/loader:1005:19) remote: at require (node:internal/modules/cjs/helpers:102:18) remote: at getDefaultSassImpl (/tmp/build_37040035/node_modules/sass-loader/dist/index.js:198:10) remote: at Object.loader (/tmp/build_37040035/node_modules/sass-loader/dist/index.js:80:29)

Ah damn I did not save the full error before uninstalling everything and rethinking my next move. From the various posts it seems I'm not the only one having the same issue, but never really found out what the smartest solution would be to go forward as none of those suggestions worked with the latest node-js version.

One aspect of CSS modules that I truly appreciate is its ability to compress class names into very short hashes. This feature allows me to keep my CSS selectors as long and descriptive as needed, while still compressing them into concise three or four character hashes. It aligns with my rule for CSS: selectors should be written for human readability, but compressed for machine efficiency.

Use methodologies such as BEM, and technologies including CSS modules, CSS-in-JS, and Shadow DOM to isolate the styles of each micro-application and prevent conflicts, thus ensuring reliable encapsulation and modularity.

For many years, Culture Amp took the second option, and distributed shared components without compiled CSS. This meant that every app that consumed shared components needed to include the necessary CSS build tooling – at that time CSS Modules and node-sass – with a compatible version and configuration. This was relatively easy to set up, but over time proved difficult to maintain. When node-sass was deprecated in favour of (the much faster but slightly incompatible) Dart Sass, this demanded a difficult lock-step migration across all those codebases, which we have yet to achieve. And as new applications have switched to Tailwind for their own styles, they've had to continue to maintain those old build tools in parallel for the shared components' styles.

So CSS modules are a form of 3rd-party CSS-in-JS, where what you import are the class names, which are then usually obfuscated etc at compile time, and all the actual style declarations are (usually) compiled into a single css file or tag as part of the bundling process. You can read the og docs on'em here, and you've probably seen'em used in React like:

import styles from "./styles.css";

function Example(){
    return (
        

            Hello
        
    );
}

They predate the ability to import non-js files in vanilla by a good while, and rely on the compile process to translate your .css files into .js files that can be imported using whichever loader you use in your bundler.

Import assertions are a vanilla way to import non-js files by telling the browser how to import them; assert { type: "css" } says to treat the file as CSS and create a CSSStyleSheet, assert { type: "json" } says to treat the file as JSON and create a JSON object - and hopefully assert { type: "html" } will hopefully arrive soon and create a #document-fragment or something similar.

Hope that clears it up!

Extensions of CSS: for example, Sass, Less, Tailwind, CSS Modules, to make stuff look a certain way on your own.

The components are styled with CSS modules. When building the library, these styles will get transformed to normal CSS style sheets. This means that the consuming application will not even be required to support CSS modules. (In the future I want to extend this tutorial to use vanilla-extract instead.)

NextJS comes with built-in support for CSS Modules which allows you to scope your styles locally in individual components without worrying about name collisions or messing up other parts of the codebase.

CSS modules are not to be confused with mixins, as they serve the opposite purpose. While mixins are components or functions to be reused globally, modules are style sheets with a local scope used in a similar way as styled components in React.

CSS Modules CSS Modules is a pre-processing step: by default, styles are scoped locally to the current component, and the transpiler ensures no conflicts.