Merge pull request #451 from icelam/test-different-os

ci: run tests on different os

Author: icelam

.github/workflows/ci.yml

@@ -13,10 +13,11 @@ on:
 jobs:
   test:
     name: Test
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [14.x, 16.x, 18.x, 20.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
     env:
       HUSKY: 0
     steps:
@@ -28,6 +29,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
+        shell: bash
         run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
       - name: Restore yarn cache
         uses: actions/cache@v3

README.md

@@ -129,6 +129,10 @@ module.exports = {
 };
 ```
 
+## Known limitations
+1. This plugin does not transform Web Worker syntax like `new Worker(new URL('./worker.js', import.meta.url));``. It simply embeds the source code processed by webpack into HTML files, and emits any JavaScript files that is not processed by the plugin.
+2. This plugin is designed to embed script content into HTML files for deployment to environments where only a single file can be uploaded, or where the script file itself is small enough that it doesn't warrant an additional HTTP request. It is not intended for use in development, and may fail if HMR is enabled.
+
 ## Contributors
 
 Thanks goes to these wonderful people:
@@ -145,7 +149,7 @@ Thanks goes to these wonderful people:
         </td>
         <td align="center" valign="top" width="20%">
             <a href="https://github.com/SorsOps">
-                <img src="https://avatars.githubusercontent.com/u/80043879?s=120&v=4" width="60px;" alt="@kmalakoff"/>
+                <img src="https://avatars.githubusercontent.com/u/80043879?s=120&v=4" width="60px;" alt="@SorsOps"/>
                 <br />
                 <b>@SorsOps</b>
             </a>

__tests__/HtmlInlineScriptPlugin.test.ts

@@ -9,7 +9,6 @@ import preserveConfig from './cases/preserveAsset/webpack.config';
 import multipleInstanceConfig from './cases/multiple-instance/webpack.config';
 import jsWithImportConfig from './cases/js-with-import/webpack.config';
 import webWorkerConfig from './cases/web-worker/webpack.config';
-import inlineWebWorkerConfig from './cases/inline-web-worker/webpack.config';
 import ignoreScriptsConfig from './cases/ignore-scripts/webpack.config';
 import ignoreHtmlsConfig from './cases/ignore-htmls/webpack.config';
 import ignoreScriptsAndHtmlsConfig from './cases/ignore-scripts-and-htmls/webpack.config';
@@ -206,39 +205,6 @@ describe('HtmlInlineScriptPlugin', () => {
     await webpackPromise;
   });
 
-  it('should build webpack config having inline web worker without error', async () => {
-    const webpackPromise = new Promise((resolve) => {
-      const compiler = webpack(inlineWebWorkerConfig);
-
-      compiler.run((error, stats) => {
-        expect(error).toBeNull();
-
-        const statsErrors = stats?.compilation.errors;
-        expect(statsErrors?.length).toBe(0);
-
-        const result1 = fs.readFileSync(
-          path.join(__dirname, 'cases/inline-web-worker/dist/index.html'),
-          'utf8',
-        );
-
-        const expected1 = fs.readFileSync(
-          path.join(__dirname, 'cases/inline-web-worker/expected/index.html'),
-          'utf8',
-        );
-
-        expect(result1).toBe(expected1);
-
-        const expectedFileList = fs.readdirSync(path.join(__dirname, 'cases/inline-web-worker/expected/'));
-        const generatedFileList = fs.readdirSync(path.join(__dirname, 'cases/inline-web-worker/dist/'));
-        expect(expectedFileList.sort()).toEqual(generatedFileList.sort());
-
-        resolve(true);
-      });
-    });
-
-    await webpackPromise;
-  });
-
   it('should inline filename with spacial characters without error', async () => {
     const webpackPromise = new Promise((resolve) => {
       const compiler = webpack(filenameWithSpecialCharactersConfig);