[#111] Make styleId an optional string or function (#110)

pedrosousa13 · web-flow · commit 8e1a392d8647 · 2023-08-07T21:37:40.000+02:00
* feat: allow for unique styleId when relativeCssInjection

* fix: remove dash when there is no styleId

* fix: only run changes if styleId exists

* fix: move uuid to devDependencies + update README

* fix: PR comments

* fix: remove empty line

* fix: remove empty line

* fix: remove empty line

* fix: remove unused duplicate test

* refactor: styleId as callback function
diff --git a/README.md b/README.md
@@ -53,9 +53,9 @@ export default {
 }
 ```
 
-#### styleId (string)
+#### styleId (string | function)
 
-If you provide a `string` for `styleId` param the code of injection will set the `id` attribute of the `style` element
+If you provide a `string` for `styleId` param, the code of injection will set the `id` attribute of the `style` element
 with the value of the parameter provided. This is an example:
 
 ```ts
@@ -77,6 +77,25 @@ The output injected into the DOM will look like this example:
 </head>
 ```
 
+If you provide a `function` for `styleId` param, it will run that function and return a string. It's especially useful if you use `relativeCSSInjection` and want unique styleIds for each file.
+
+```ts
+import cssInjectedByJsPlugin from 'vite-plugin-css-injected-by-js'
+
+export default {
+    plugins: [
+        cssInjectedByJsPlugin({styleId: () => `foo-${Math.random() * 100}`}),
+    ]
+}
+```
+
+```html
+<head>
+    <style id="foo-1234">/* Generated CSS rules */</style>
+    <style id="foo-4321">/* Generated CSS rules */</style>
+</head>
+```
+
 #### preRenderCSSCode (function)
 
 You can use the `preRenderCSSCode` parameter to make specific changes to your CSS before it is printed in the output JS
diff --git a/src/index.ts b/src/index.ts
@@ -67,7 +67,7 @@ export default function cssInjectedByJsPlugin({
                     injectCode,
                     injectCodeFunction,
                     useStrictCSP,
-                    buildOptions: config.build,
+                    buildOptions: config.build
                 });
 
             const cssAssetsFilter = (asset: OutputAsset): boolean => {
diff --git a/src/interface.ts b/src/interface.ts
@@ -5,7 +5,7 @@ import type { BuildOptions } from 'vite';
 export interface BaseOptions {
     injectCode?: InjectCode;
     injectCodeFunction?: InjectCodeFunction;
-    styleId?: string;
+    styleId?: string | (() => string);
     topExecutionPriority?: boolean;
     useStrictCSP?: boolean;
 }
diff --git a/src/utils.ts b/src/utils.ts
@@ -3,7 +3,7 @@ import type { OutputAsset, OutputBundle, OutputChunk } from 'rollup';
 import type { BuildCSSInjectionConfiguration, CSSInjectionConfiguration, PluginConfiguration } from './interface';
 
 interface InjectCodeOptions {
-    styleId?: string;
+    styleId?: string | (() => string);
     useStrictCSP?: boolean;
 }
 
@@ -29,11 +29,19 @@ export async function buildCSSInjectionCode({
 }: BuildCSSInjectionConfiguration): Promise<OutputChunk | null> {
     let { minify, target } = buildOptions;
 
+    const generatedStyleId = typeof styleId === 'function' ? styleId() : styleId;
+
     const res = await build({
         root: '',
         configFile: false,
         logLevel: 'error',
-        plugins: [injectionCSSCodePlugin({ cssToInject, styleId, injectCode, injectCodeFunction, useStrictCSP })],
+        plugins: [injectionCSSCodePlugin({
+            cssToInject,
+            styleId: generatedStyleId,
+            injectCode,
+            injectCodeFunction,
+            useStrictCSP
+        })],
         build: {
             write: false,
             target,
diff --git a/test/utils.spec.ts b/test/utils.spec.ts
@@ -69,6 +69,42 @@ describe('utils', () => {
             expect(getComputedStyle(document.body).color).toBe('red');
         });
 
+        test('Generate JS that applies styles with callback styleID', async () => {
+            const styleId = () => `styleId-${Math.random()}`;
+            const builds = await Promise.all([
+                buildCSSInjectionCode({
+                    cssToInject: 'body { color: red; }',
+                    styleId,
+                    buildOptions: { minify: true, target: 'es2015' },
+                }),
+                buildCSSInjectionCode({
+                    cssToInject: 'body { background: blue; }',
+                    styleId,
+                    buildOptions: { minify: true, target: 'es2015' },
+                })
+            ]);
+
+            builds?.map((output) => {
+                const $script = document.createElement('script');
+                $script.textContent = output?.code || 'throw new Error("UNCAUGHT ERROR")';
+                document.head.appendChild($script);
+            });
+
+            // Doesn't error
+            expect(onerror).not.toBeCalled();
+
+            // StyleId applied
+            const styles = document.head.querySelectorAll(`style[id^=styleId-]`);
+
+            expect(styles).toHaveLength(2);
+            // Expect unique style ids
+            expect([...new Set(styles.map((style) => style.id))]).toHaveLength(2)
+
+            // Applied style!
+            expect(getComputedStyle(document.body).color).toBe('red');
+            expect(getComputedStyle(document.body).background).toBe('blue');
+        });
+
         test('Generate JS that applies styles, without styleId', async () => {
             const output = await buildCSSInjectionCode({
                 cssToInject: 'body { color: red; }',

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import type { BuildOptions } from 'vite';`
`5`	`5`	`export interface BaseOptions {`
`6`	`6`	`injectCode?: InjectCode;`
`7`	`7`	`injectCodeFunction?: InjectCodeFunction;`
`8`		`- styleId?: string;`
	`8`	`+ styleId?: string \| (() => string);`
`9`	`9`	`topExecutionPriority?: boolean;`
`10`	`10`	`useStrictCSP?: boolean;`
`11`	`11`	`}`