refactor!: unify runtime again

wix · Oct 2, 2023 · f8565f2 · f8565f2
1 parent 92af4b1
commit f8565f2
Show file tree

Hide file tree

Showing 44 changed files with 4,620 additions and 1,525 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/src/build.ts b/packages/cli/src/build.ts
@@ -40,8 +40,8 @@ export async function build(
         diagnostics,
         diagnosticsMode,
         inlineRuntime,
-        runtimeCjsRequest = '@stylable/runtime/dist/pure.js',
-        runtimeEsmRequest = '@stylable/runtime/esm/pure.js',
+        runtimeCjsRequest = '@stylable/runtime/dist/index.js',
+        runtimeEsmRequest = '@stylable/runtime/dist/index.mjs',
     }: BuildOptions,
     {
         projectRoot: _projectRoot,

diff --git a/packages/cli/test/build.spec.ts b/packages/cli/test/build.spec.ts
@@ -423,7 +423,7 @@ describe('build stand alone', () => {
                 esm: true,
                 inlineRuntime: true,
                 runtimeCjsRequest: '/node_modules/@stylable/runtime/dist/index.js',
-                runtimeEsmRequest: '/node_modules/@stylable/runtime/esm/index.js',
+                runtimeEsmRequest: '/node_modules/@stylable/runtime/dist/index.mjs',
             },
             {
                 fs,
@@ -440,18 +440,18 @@ describe('build stand alone', () => {
 
         // this makes sure that we actually copied the runtime
         const runtimeCjs = fs.readFileSync('/dist/stylable-cjs-runtime.js', 'utf8');
-        const runtimeMjs = fs.readFileSync('/dist/stylable-esm-runtime.js', 'utf8');
+        const runtimeMjs = fs.readFileSync('/dist/stylable-esm-runtime.mjs', 'utf8');
 
         expect(builtFileCjs, 'imports the cjs runtime with full extension').to.contain(
             `./stylable-cjs-runtime.js`
         );
         expect(builtFileEsm, 'imports the esm runtime with full extension').to.contain(
-            `./stylable-esm-runtime.js`
+            `./stylable-esm-runtime.mjs`
         );
         expect(
             innerPathBuiltFileEsm,
             'imports the esm runtime with full extension with relative path'
-        ).to.contain(`./../stylable-esm-runtime.js`);
+        ).to.contain(`./../stylable-esm-runtime.mjs`);
         expect(runtimeCjs).to.eql(`// runtime cjs`);
         expect(runtimeMjs).to.eql(`// runtime esm`);
     });
@@ -495,10 +495,10 @@ describe('build stand alone', () => {
         const builtFileEsm = fs.readFileSync('/dist/comp.st.css.js', 'utf8');
 
         expect(builtFileCjs, 'imports the cjs runtime with full extension').to.contain(
-            `"@stylable/runtime/dist/pure.js"`
+            `"@stylable/runtime/dist/index.js"`
         );
         expect(builtFileEsm, 'imports the esm runtime with full extension').to.contain(
-            `"@stylable/runtime/esm/pure.js"`
+            `"@stylable/runtime/dist/index.mjs"`
         );
     });
 

diff --git a/packages/core/src/stylable-js-module-source.ts b/packages/core/src/stylable-js-module-source.ts
@@ -128,8 +128,8 @@ function runtimeImport(
         runtimeRequest ??
             // TODO: we use direct requests here since we don't know how this will be resolved
             (moduleType === 'esm'
-                ? '@stylable/runtime/esm/runtime.js'
-                : '@stylable/runtime/dist/runtime.js')
+                ? '@stylable/runtime/dist/index.mjs'
+                : '@stylable/runtime/dist/index.js')
     );
     return moduleType === 'esm'
         ? `import { classesRuntime, statesRuntime${importInjectCSS} } from ${request};`

diff --git a/packages/dom-test-kit/test/contract-test.ts b/packages/dom-test-kit/test/contract-test.ts
@@ -1,30 +1,23 @@
-import { create } from '@stylable/runtime';
-import type { PartialElement } from '@stylable/dom-test-kit';
+import { statesRuntime, type StateValue } from '@stylable/runtime';
+import type { PartialElement, StylesheetHost } from '@stylable/dom-test-kit';
+
 import { expect } from 'chai';
 
 export const contractTest =
     <T extends PartialElement>(
-        StylableUtilClass: any,
+        StylableUtilClass: new (
+            host: StylesheetHost & { cssStates(states: Record<string, StateValue>): string }
+        ) => any,
         options: { scopeSelectorTest?: boolean; createElement: () => T }
     ) =>
     () => {
-        const s = create(
-            'ns',
-            {
-                classes: { root: 'ns-root', x: 'ns__x', y: 'ns__y', z: 'ns__z ns__y' },
-                keyframes: {},
-                layers: {},
-                containers: {},
-                vars: {},
-                stVars: {},
-            },
-            '',
-            0,
-            '0',
-            null
-        );
-
-        const util = new StylableUtilClass(s);
+        const namespace = 'ns';
+        const classes = { root: 'ns-root', x: 'ns__x', y: 'ns__y', z: 'ns__z ns__y' };
+        const util = new StylableUtilClass({
+            classes,
+            namespace,
+            cssStates: statesRuntime.bind(null, namespace),
+        });
 
         if (options.scopeSelectorTest) {
             it('scopeSelector defaults to root', () => {
@@ -67,17 +60,17 @@ export const contractTest =
         describe('Style state', () => {
             it('hasStyleState returns true if the requested style state exists', async () => {
                 const elem = options.createElement();
-                elem.classList.add(s.cssStates({ loading: true }));
+                elem.classList.add(statesRuntime(namespace, { loading: true }));
                 expect(await util.hasStyleState(elem, 'loading')).to.equal(true);
             });
             it('getStyleState returns the requested boolean style state value', async () => {
                 const elem = options.createElement();
-                elem.classList.add(s.cssStates({ loading: true }));
+                elem.classList.add(statesRuntime(namespace, { loading: true }));
                 expect(await util.getStyleState(elem, 'loading')).to.equal(true);
             });
             it('getStyleState returns the requested string style state value', async () => {
                 const elem = options.createElement();
-                elem.classList.add(s.cssStates({ loading: 'value' }));
+                elem.classList.add(statesRuntime(namespace, { loading: 'value' }));
                 expect(await util.getStyleState(elem, 'loading')).to.equal('value');
             });
         });

diff --git a/packages/e2e-test-kit/src/stylable-webpack-test-utils.ts b/packages/e2e-test-kit/src/stylable-webpack-test-utils.ts
@@ -1,4 +1,4 @@
-import { RuntimeRenderer } from '@stylable/runtime';
+import * as runtime from '@stylable/runtime';
 import * as stylesheet from '@stylable/runtime';
 
 export interface MinimalModule {
@@ -48,7 +48,7 @@ export function evalStylableModule(
     const moduleFactory = new Function('module', 'exports', '__webpack_require__', code);
     const customRequire = (id: string) => {
         if (id.match(/@stylable\/runtime$/)) {
-            return new RuntimeRenderer();
+            return runtime;
         }
         if (id.match(/css-runtime-stylesheet.js$/)) {
             return stylesheet;

diff --git a/packages/esbuild/src/stylable-esbuild-plugin.ts b/packages/esbuild/src/stylable-esbuild-plugin.ts
@@ -231,7 +231,7 @@ export const stylablePlugin = (initialPluginOptions: ESBuildOptions = {}): Plugi
                         namespace: res.meta.namespace,
                         jsExports: res.exports,
                         moduleType: 'esm',
-                        runtimeRequest: '@stylable/runtime/esm/pure',
+                        runtimeRequest: '@stylable/runtime',
                     },
                     cssInjection === 'js'
                         ? {

diff --git a/packages/experimental-loader/src/create-runtime-target-code.ts b/packages/experimental-loader/src/create-runtime-target-code.ts
@@ -1,15 +1,12 @@
 import type { StylableExports } from '@stylable/core/dist/index-internal';
+import { generateStylableJSModuleSource } from '@stylable/core';
 
-export function createRuntimeTargetCode(namespace: string, mapping: StylableExports) {
-    return `
-  var rt = require("@stylable/runtime/dist/css-runtime-stylesheet.js");
-
-  module.exports = rt.create(
-      ${JSON.stringify(namespace)},
-      ${JSON.stringify(mapping)},
-      "",
-      -1,
-      module.id
-  );
-  `;
+export function createRuntimeTargetCode(namespace: string, jsExports: StylableExports) {
+    const code = generateStylableJSModuleSource({
+        jsExports,
+        moduleType: 'cjs',
+        namespace,
+        varType: 'var',
+    });
+    return code;
 }
diff --git a/packages/module-utils/test/test-kit.ts b/packages/module-utils/test/test-kit.ts
@@ -23,12 +23,7 @@ function evalModule(id: string, source: string, requireModule: (s: string) => an
  */
 export function evalStylableModule<T = unknown>(source: string, fullPath: string): T {
     return evalModule(fullPath, source, (id) => {
-        if (
-            id === '@stylable/runtime' ||
-            id === '@stylable/runtime/dist/runtime' ||
-            id === '@stylable/runtime/dist/runtime.js' ||
-            id === '@stylable/runtime/dist/pure.js'
-        ) {
+        if (id === '@stylable/runtime' || id === '@stylable/runtime/dist/index.js' || id === '@stylable/runtime/dist/index.mjs') {
             return runtime;
         }
         throw new Error(`Could not find module: ${id}`);

diff --git a/packages/node/src/loader.ts b/packages/node/src/loader.ts
@@ -29,7 +29,7 @@ async function initiateModuleFactory() {
             // point to cjs - the esm runtime isn't published with mjs
             // and causes issues. currently it's problematic for direct esm
             // usage and only works for bundlers.
-            runtimePath: '@stylable/runtime/dist/pure.js',
+            runtimePath: '@stylable/runtime',
         }
     );
 }

diff --git a/packages/rollup-plugin/package.json b/packages/rollup-plugin/package.json
@@ -14,6 +14,7 @@
     "@stylable/build-tools": "^5.16.0",
     "@stylable/cli": "^5.16.0",
     "@stylable/core": "^5.16.0",
+    "@stylable/module-utils": "^5.16.0",
     "@stylable/node": "^5.16.0",
     "@stylable/optimizer": "^5.16.0",
     "@stylable/runtime": "^5.16.0",

diff --git a/packages/rollup-plugin/runtime.js b/packages/rollup-plugin/runtime.js
diff --git a/packages/rollup-plugin/src/index.ts b/packages/rollup-plugin/src/index.ts
@@ -1,7 +1,7 @@
 import type { Plugin } from 'rollup';
 import fs from '@file-services/node';
 import { join, parse } from 'path';
-import { Stylable, StylableConfig } from '@stylable/core';
+import { Stylable, StylableConfig, generateStylableJSModuleSource } from '@stylable/core';
 import {
     emitDiagnostics,
     DiagnosticsMode,
@@ -17,12 +17,7 @@ import {
 import { packageJsonLookupCache, resolveNamespace as resolveNamespaceNode } from '@stylable/node';
 import { StylableOptimizer } from '@stylable/optimizer';
 import decache from 'decache';
-import {
-    emitAssets,
-    generateCssString,
-    generateStylableModuleCode,
-    getDefaultMode,
-} from './plugin-utils';
+import { emitAssets, generateCssString, getDefaultMode } from './plugin-utils';
 import { resolveConfig as resolveStcConfig, STCBuilder } from '@stylable/cli';
 
 export interface StylableRollupPluginOptions {
@@ -190,18 +185,20 @@ export function stylableRollupPlugin({
             const { meta, exports } = stylable.transform(stylable.analyze(path, source));
             const assetsIds = emitAssets(this, stylable, meta, emittedAssets, inlineAssets);
             const css = generateCssString(meta, minify, stylable, assetsIds);
-            const moduleImports: string[] = [];
+            const moduleImports: { from: string }[] = [];
 
             if (includeGlobalSideEffects) {
                 // new mode that collect deep side effects
                 collectImportsWithSideEffects(stylable, meta, (_contextMeta, absPath, isUsed) => {
                     if (isUsed) {
                         if (!absPath.endsWith(ST_CSS)) {
-                            moduleImports.push(
-                                `import ${JSON.stringify(absPath + LOADABLE_CSS_QUERY)};`
-                            );
+                            moduleImports.push({
+                                from: absPath + LOADABLE_CSS_QUERY,
+                            });
                         } else {
-                            moduleImports.push(`import ${JSON.stringify(absPath)};`);
+                            moduleImports.push({
+                                from: absPath,
+                            });
                         }
                     }
                 });
@@ -220,11 +217,13 @@ export function stylableRollupPlugin({
                     }
                     // include Stylable and native css files that have effects on other files as regular imports
                     if (resolved.endsWith('.css') && !resolved.endsWith(ST_CSS)) {
-                        moduleImports.push(
-                            `import ${JSON.stringify(resolved + LOADABLE_CSS_QUERY)};`
-                        );
+                        moduleImports.push({
+                            from: resolved + LOADABLE_CSS_QUERY,
+                        });
                     } else if (hasImportedSideEffects(stylable, meta, imported)) {
-                        moduleImports.push(`import ${JSON.stringify(imported.request)};`);
+                        moduleImports.push({
+                            from: imported.request,
+                        });
                     }
                 }
             }
@@ -249,8 +248,16 @@ export function stylableRollupPlugin({
                 );
             }
 
+            const code = generateStylableJSModuleSource({
+                jsExports: exports,
+                moduleType: 'esm',
+                namespace: meta.namespace,
+                varType: 'var',
+                imports: moduleImports,
+            });
+
             return {
-                code: generateStylableModuleCode(meta, exports, moduleImports),
+                code,
                 map: { mappings: '' },
             };
         },

diff --git a/packages/rollup-plugin/src/plugin-utils.ts b/packages/rollup-plugin/src/plugin-utils.ts
@@ -1,5 +1,4 @@
 import type { Stylable, StylableMeta } from '@stylable/core';
-import type { StylableExports } from '@stylable/core/dist/index-internal';
 import type { PluginContext } from 'rollup';
 import type { StylableRollupPluginOptions } from './index';
 import { processUrlDependencies } from '@stylable/build-tools';
@@ -8,30 +7,6 @@ import { basename, extname, isAbsolute, join } from 'path';
 import { createHash } from 'crypto';
 import { getType } from 'mime';
 
-const runtimePath = JSON.stringify(require.resolve('@stylable/rollup-plugin/runtime'));
-const runtimeImport = `import { stc, sts } from ${runtimePath};`;
-
-export function generateStylableModuleCode(
-    meta: StylableMeta,
-    exports: StylableExports,
-    moduleImports: string[]
-) {
-    return `
-        ${runtimeImport}
-        ${moduleImports.join('\n')}
-        export var namespace = ${JSON.stringify(meta.namespace)};
-        export var st = sts.bind(null, namespace);
-        export var style = st;
-        export var cssStates = stc.bind(null, namespace);
-        export var classes = ${JSON.stringify(exports.classes)}; 
-        export var keyframes = ${JSON.stringify(exports.keyframes)};
-        export var layers = ${JSON.stringify(exports.layers)};
-        export var containers = ${JSON.stringify(exports.containers)};
-        export var stVars = ${JSON.stringify(exports.stVars)}; 
-        export var vars = ${JSON.stringify(exports.vars)}; 
-    `;
-}
-
 export function generateCssString(
     meta: StylableMeta,
     minify: boolean,

diff --git a/packages/runtime/package.json b/packages/runtime/package.json
@@ -8,6 +8,15 @@
     "test:unit": "mocha \"dist/test/unit/**/*.spec.js\"",
     "test:e2e": "mocha \"dist/test/e2e/**/*.spec.js\" --timeout 20000"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json",
+    "./dist/index.js": "./dist/index.js",
+    "./dist/index.mjs": "./dist/index.mjs"
+  },
   "files": [
     "dist",
     "esm",