mage-obsidian 1.0.0

package/jest.config.js

@@ -0,0 +1,5 @@
+export default {
+    testEnvironment: 'node',
+    transform: {},
+    testPathIgnorePatterns: ['/__tests__/magento_scenarios/','/node_modules/', '/__tests__/__mocks__/'],
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "mage-obsidian",
+  "version": "1.0.0",
+  "description": "Mage Obsidian Ultis",
+  "main": "./src/scripts/buildThemes.js",
+  "keywords": [
+    "Magento",
+    "MageObsidian"
+  ],
+  "author": "Jeanmarcos Juarez",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "mage-obsidian:build-themes": "./src/scripts/buildThemes.js"
+  },
+  "imports": {
+    "#utils/*": "./src/utils/*",
+    "#config/*": "./src/config/*",
+    "#service/*": "./src/service/*"
+  },
+  "exports": {
+    ".": "./src/scripts/buildThemes.js",
+    "./service/": "./src/service/",
+    "./utils/": "./src/utils/",
+    "./config/": "./src/config/"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "deepmerge": "^4.3.1",
+    "jest": "^29.7.0",
+    "jest-environment-node": "^29.7.0",
+    "readline-sync": "^1.4.10"
+  },
+  "scripts": {
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
+  }
+}

package/src/__tests__/__mocks__/configResolver.js

@@ -0,0 +1,35 @@
+import path from "path";
+import fs from "fs";
+import { jest } from '@jest/globals';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const createMockConfigResolver = (scenario) => {
+    const configPath = path.resolve(__dirname, `../magento_scenarios/app/etc/mage_obsidian_frontend_modules_${scenario}.json`);
+    const magentoConfigJson = fs.readFileSync(configPath, 'utf-8');
+    const mockMagentoConfig = JSON.parse(magentoConfigJson);
+    for (const key in mockMagentoConfig.modules) {
+        let module = mockMagentoConfig.modules[key];
+        module.src = path.resolve(__dirname, '..', module.src);
+    }
+    for (const key in mockMagentoConfig.themes) {
+        let theme = mockMagentoConfig.themes[key];
+        theme.src = path.resolve(__dirname, '..', theme.src);
+    }
+    return {
+        default: {
+            getMagentoConfig: jest.fn(() => mockMagentoConfig),
+            getModulesConfigArray: jest.fn(() => Object.entries(mockMagentoConfig.modules)),
+            getThemesConfigArray: jest.fn(() => Object.entries(mockMagentoConfig.themes)),
+            getAllMagentoModulesEnabled: jest.fn(() => mockMagentoConfig.allModules),
+            isDev: jest.fn(() => mockMagentoConfig.mode === 'development'),
+            getOutputDirFromTheme: jest.fn((themePath) => `${themePath}/output`),
+            getThemeDefinition: jest.fn((themeName) => mockMagentoConfig.themes[themeName]),
+            getModuleDefinition: jest.fn((moduleName) => mockMagentoConfig.modules[moduleName]),
+        }
+    }
+};
+
+export default createMockConfigResolver;

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameA/view/frontend/web/module.config.cjs

@@ -0,0 +1,9 @@
+module.exports = {
+    tailwind: {
+        theme: { extend: {} },
+        plugins: [],
+        content: [
+            '../templates/**/*.phtml'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameB/view/frontend/web/css/module.extend.css

@@ -0,0 +1,2 @@
+body {
+}

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameB/view/frontend/web/module.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+    tailwind: {
+        content: [
+            '../templates/**/*.phtml'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameC/view/frontend/web/css/module.extend.css

@@ -0,0 +1,2 @@
+body {
+}

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameC/view/frontend/web/module.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+    tailwind: {
+        content: [
+            '../templates/**/*.phtml'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/Vendor_ModuleNameA/web/module.config.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+    tailwind: {
+        content: [
+            '../templates/**/*.phtml',
+            '/from_theme'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/Vendor_ModuleNameB/web/module.config.cjs

@@ -0,0 +1,7 @@
+module.exports = {
+    tailwind: {
+        content: [
+            '../templates/**/*.phtml'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/Vendor_ModuleNameNoConfig/web/module.config.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+    tailwind: {
+        content: [
+            '../templates/**/*.phtml',
+            'pollo'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/web/css/tailwind.source.css

@@ -0,0 +1,6 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+body {
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/web/theme.config.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+    tailwind: {
+        theme: {
+            extend: {
+            },
+        },
+        plugins: [],
+        content: [
+            './**/*.{vue,js}',
+            '../**/*.phtml',
+            '../*/page_layout/override/base/*.xml',
+        ],
+    },
+    ignoredTailwindConfigFromModules: [],
+    ignoredCssFromModules: [
+        'Vendor_ModuleNameA'
+    ]
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-b/web/css/tailwind.source.css

@@ -0,0 +1,6 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+body {
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-b/web/theme.config.cjs

@@ -0,0 +1,22 @@
+module.exports = {
+    tailwind: {
+        theme: {
+            extend: {
+                textColor: {
+                    'primary': '#3490dc',
+                    'secondary': '#ffed4a',
+                    'danger': '#e3342f',
+                },
+            },
+        },
+        plugins: [],
+        content: [
+            './**/*.{vue,js}',
+            '../**/*.phtml',
+            '../*/page_layout/override/base/*.xml',
+        ],
+    },
+    ignoredCssFromModules: [
+        'Vendor_ModuleNameNoConfig'
+    ]
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-c/Vendor_ModuleNameB/web/module.config.cjs

@@ -0,0 +1,9 @@
+module.exports = {
+    tailwind: {
+        plugins: ['test_from_theme'],
+        content: [
+            '../templates/**/*.phtml',
+            '/from_theme'
+        ]
+    }
+};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-c/web/css/tailwind.source.css

@@ -0,0 +1,6 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+body {
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-c/web/theme.config.cjs

@@ -0,0 +1,16 @@
+module.exports = {
+    tailwind: {
+        theme: {
+            extend: {
+            },
+        },
+        plugins: [],
+        content: [
+            './**/*.{vue,js}',
+            '../**/*.phtml',
+            '../*/page_layout/override/base/*.xml',
+        ],
+    },
+    includeTailwindConfigFromParentThemes: false,
+    ignoredTailwindConfigFromModules: 'all'
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-d/web/css/tailwind.source.css

@@ -0,0 +1,6 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+body {
+}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-d/web/theme.config.cjs

@@ -0,0 +1,14 @@
+module.exports = {
+    tailwind: {
+        theme: {
+            extend: {
+            },
+        },
+        plugins: [],
+        content: [],
+    },
+    ignoredTailwindConfigFromModules: [
+        'Vendor_ModuleNameC'
+    ],
+    includeCssSourceFromParentThemes: false,
+}

package/src/__tests__/magento_scenarios/app/etc/mage_obsidian_frontend_modules_a.json

@@ -0,0 +1,53 @@
+{
+    "modules": {
+        "Vendor_ModuleNameA": {
+            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameA"
+        },
+        "Vendor_ModuleNameB": {
+            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameB"
+        },
+        "Vendor_ModuleNameC": {
+            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameC"
+        }
+    },
+    "themes": {
+        "Vendor\/theme-a": {
+            "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-a",
+            "parent": null
+        },
+        "Vendor\/theme-b": {
+          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-b",
+          "parent": "Vendor\/theme-a"
+        },
+        "Vendor\/theme-c": {
+          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-c",
+          "parent": "Vendor\/theme-b"
+        },
+        "Vendor\/theme-d": {
+          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-d",
+          "parent": null
+        }
+    },
+    "allModules": [
+      "Vendor_ModuleNameA",
+      "Vendor_ModuleNameB",
+      "Vendor_ModuleNameC"
+    ],
+    "VUE_COMPONENTS_PATH": "components",
+    "JS_PATH": "js",
+    "FOLDERS_TO_WATCH": [
+        "components",
+        "js"
+    ],
+    "ALLOWED_EXTENSIONS": [
+        "js",
+        "vue",
+        "cjs",
+        "ts"
+    ],
+    "MODULE_CSS_EXTEND_FILE": "module.extend.css",
+    "MODULE_CONFIG_FILE": "module.config.cjs",
+    "THEME_CONFIG_FILE": "theme.config.cjs",
+    "THEME_TAILWIND_SOURCE_FILE": "tailwind.source.css",
+    "LIB_PATH": "lib"
+}

package/src/__tests__/magento_scenarios/app/etc/mage_obsidian_frontend_modules_b.json

@@ -0,0 +1,50 @@
+{
+    "modules": {
+        "Vendor_ModuleNameA": {
+            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameA"
+        },
+        "Vendor_ModuleNameC": {
+            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameC"
+        }
+    },
+    "themes": {
+        "Vendor\/theme-a": {
+            "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-a",
+            "parent": null
+        },
+        "Vendor\/theme-b": {
+          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-b",
+          "parent": "Vendor\/theme-a"
+        },
+        "Vendor\/theme-c": {
+          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-c",
+          "parent": "Vendor\/theme-b"
+        },
+        "Vendor\/theme-d": {
+          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-d",
+          "parent": null
+        }
+    },
+    "allModules": [
+      "Vendor_ModuleNameA",
+      "Vendor_ModuleNameB",
+      "Vendor_ModuleNameNoConfig"
+    ],
+    "VUE_COMPONENTS_PATH": "components",
+    "JS_PATH": "js",
+    "FOLDERS_TO_WATCH": [
+        "components",
+        "js"
+    ],
+    "ALLOWED_EXTENSIONS": [
+        "js",
+        "vue",
+        "cjs",
+        "ts"
+    ],
+    "MODULE_CSS_EXTEND_FILE": "module.extend.css",
+    "MODULE_CONFIG_FILE": "module.config.cjs",
+    "THEME_CONFIG_FILE": "theme.config.cjs",
+    "THEME_TAILWIND_SOURCE_FILE": "tailwind.source.css",
+    "LIB_PATH": "lib"
+}

package/src/__tests__/service/inheritModuleResolver.test.js

@@ -0,0 +1,69 @@
+import { jest } from '@jest/globals';
+import createMockConfigResolver from '../__mocks__/configResolver.js';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+let scenarios = [
+    {
+        scenario: 'a',
+        themes: [
+            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameA::js/test', expected: '/TEST/web/js/test.js' },
+            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameA::js/test.vue', expected: '/TEST/web/js/test.js' },
+            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameA::js/test.css', expected: undefined },
+            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameB::js/test', expected: undefined },
+            { code: 'Vendor/theme-a', codeImport: null, expected: undefined },
+            { code: 'Vendor/theme-b', codeImport: 'Vendor_ModuleNameA::js/unknown', expected: undefined }
+        ]
+    }
+];
+
+function mockConfigAndModules(scenario) {
+    jest.mock(
+        '#service/configResolver.cjs',
+        () => createMockConfigResolver(scenario).default
+    );
+    jest.unstable_mockModule(
+        '#service/moduleResolver.js',
+        () => ({
+            default: {
+                getAllJsVueFilesWithInheritanceCached: jest.fn(() => ({
+                    'Vendor_ModuleNameA/js/test': '/TEST/web/js/test.js',
+                })),
+            }
+        })
+    );
+}
+
+async function setupInheritModuleResolver(scenario) {
+    mockConfigAndModules(scenario);
+    const resolver = await import('#service/inheritModuleResolver.js');
+    return resolver.default();
+}
+
+describe('inherit-resolver', () => {
+    let inheritModuleResolver;
+
+    beforeEach(() => {
+        jest.resetModules();
+    });
+
+    test.each(scenarios.flatMap(({ scenario, themes }) =>
+        themes.map(({ code, codeImport, expected }) => ([scenario, code, codeImport, expected]))
+    ))('Scenario "%s", Theme "%s", Import "%s"', async (scenario, code, codeImport, expected) => {
+        process.env.CURRENT_THEME = code;
+        inheritModuleResolver = await setupInheritModuleResolver(scenario);
+        const result = await inheritModuleResolver.resolveId.handler(codeImport);
+
+        expect(result).toEqual(
+            expected,
+            `Scenario: "${scenario}"
+            Theme: "${code}"
+            Import: "${codeImport}"
+            Expected: ${JSON.stringify(expected, null, 2)}
+            Received: ${JSON.stringify(result, null, 2)}`
+        );
+    });
+});