@jsenv/cli 0.0.2 → 0.0.5

package/template-web-react/.eslintrc.cjs

@@ -0,0 +1,175 @@
+/*
+ * This file uses "@jsenv/eslint-config" to configure ESLint
+ * https://github.com/jsenv/eslint-config#eslint-config----
+ */
+
+const {
+  composeEslintConfig,
+  eslintConfigBase,
+  eslintConfigForPrettier,
+  eslintConfigToPreferExplicitGlobals,
+  jsenvEslintRules,
+  jsenvEslintRulesForImport,
+  jsenvEslintRulesForReact,
+} = require("@jsenv/eslint-config");
+
+const eslintConfig = composeEslintConfig(
+  eslintConfigBase,
+
+  // By default files are meant to be executed in Node.js
+  // and we want to tell this to ESLint.
+  // As a result ESLint can consider `window` as undefined
+  // and `global` as an existing global variable.
+  {
+    env: {
+      node: true,
+    },
+  },
+
+  // enable top level await
+  {
+    parserOptions: {
+      ecmaVersion: 2022,
+    },
+  },
+
+  // use "@babel/eslint-parser" until import assertions is supported natively by ESLint
+  {
+    parser: "@babel/eslint-parser",
+    parserOptions: {
+      requireConfigFile: false,
+    },
+  },
+
+  // Reuse jsenv eslint rules
+  {
+    rules: {
+      ...jsenvEslintRules,
+      // Example of code changing the ESLint configuration to enable a rule:
+      // 'prefer-const':  ['error']
+    },
+  },
+
+  // Enable import plugin
+  {
+    plugins: ["import"],
+    settings: {
+      "import/resolver": {
+        "@jsenv/eslint-import-resolver": {
+          rootDirectoryUrl: __dirname,
+          packageConditions: ["node", "import"],
+        },
+      },
+    },
+    rules: jsenvEslintRulesForImport,
+  },
+
+  // Enable HTML plugin
+  {
+    plugins: ["html"],
+    settings: {
+      extensions: [".html"],
+      settings: {
+        "html/javascript-mime-types": [
+          "text/javascript",
+          "module",
+          "text/jsx",
+          "module/jsx",
+        ],
+      },
+    },
+  },
+
+  // react
+  {
+    plugins: ["react"],
+    settings: {
+      react: {
+        version: "detect",
+      },
+    },
+    rules: {
+      ...jsenvEslintRulesForReact,
+      "react/jsx-filename-extension": ["error", { extensions: [".jsx"] }],
+      "react/react-in-jsx-scope": ["off"],
+    },
+  },
+
+  // jsx
+  {
+    parser: "@babel/eslint-parser",
+    parserOptions: {
+      ecmaFeatures: {
+        jsx: true,
+      },
+    },
+    settings: {
+      extensions: [".jsx"],
+    },
+  },
+
+  // Configure which files are written for the web
+  {
+    overrides: [
+      {
+        files: ["./src/**"],
+        env: {
+          browser: true,
+          node: false,
+        },
+        settings: {
+          "import/resolver": {
+            "@jsenv/eslint-import-resolver": {
+              rootDirectoryUrl: `${__dirname}/src/`,
+              packageConditions: ["browser", "import"],
+            },
+          },
+        },
+      },
+    ],
+  },
+
+  // package is "type": "module" so:
+  // 1. disable commonjs globals by default
+  // 2. Re-enable commonjs into *.cjs files
+  {
+    globals: {
+      __filename: "off",
+      __dirname: "off",
+      require: "off",
+      exports: "off",
+    },
+    overrides: [
+      {
+        files: ["**/*.cjs"],
+        env: {
+          commonjs: true,
+        },
+        // inside *.cjs files. restore commonJS "globals"
+        globals: {
+          __filename: true,
+          __dirname: true,
+          require: true,
+          exports: true,
+        },
+        // inside *.cjs files, use commonjs module resolution
+        settings: {
+          "import/resolver": {
+            "@jsenv/eslint-import-resolver": {
+              rootDirectoryUrl: __dirname,
+              packageConditions: ["node", "require"],
+            },
+          },
+        },
+      },
+    ],
+  },
+
+  eslintConfigToPreferExplicitGlobals,
+
+  // We are using prettier, disable all eslint rules
+  // already handled by prettier.
+  eslintConfigForPrettier,
+);
+
+module.exports = eslintConfig;

package/template-web-react/.prettierrc.yml

@@ -0,0 +1,2 @@
+trailingComma: "all"
+quoteProps: "consistent"

package/template-web-react/babel.config.cjs

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: [
+    "@babel/plugin-syntax-import-assertions",
+    [
+      "@babel/plugin-transform-react-jsx",
+      {
+        pragma: "React.createElement",
+        pragmaFrag: "React.Fragment",
+      },
+    ],
+  ],
+};

package/template-web-react/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "jsenv-template-web-react",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "start": "npm run dev -- --open",
+    "dev": "node ./scripts/dev.mjs",
+    "test": "node ./scripts/test.mjs",
+    "test:coverage": "npm run test -- --coverage",
+    "build": "node ./scripts/build.mjs",
+    "build:serve": "node ./scripts/build_serve.mjs --open",
+    "eslint": "npx eslint . --ext=.html,.js,.jsx,.mjs,.cjs",
+    "prettier": "prettier --write .",
+    "playwright:install": "npx playwright install-deps && npx playwright install"
+  },
+  "dependencies": {
+    "react": "18.3.1",
+    "react-dom": "18.3.1"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "7.24.8",
+    "@babel/plugin-syntax-import-assertions": "7.24.7",
+    "@babel/plugin-transform-react-jsx": "7.24.7",
+    "@jsenv/assert": "4.1.4",
+    "@jsenv/core": "39.2.1",
+    "@jsenv/plugin-react": "1.5.2",
+    "@jsenv/plugin-bundling": "2.6.17",
+    "@jsenv/plugin-minification": "1.5.5",
+    "@jsenv/eslint-config": "16.5.2",
+    "@jsenv/eslint-import-resolver": "8.1.2",
+    "@jsenv/test": "3.3.11",
+    "eslint": "8.56.0",
+    "eslint-plugin-html": "8.1.1",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-react": "7.34.4",
+    "open": "10.1.0",
+    "@playwright/browser-chromium": "1.45.2",
+    "prettier": "3.3.3"
+  }
+}

package/template-web-react/scripts/build.mjs

@@ -0,0 +1,23 @@
+/*
+ * Optimize source files and write them into "./dist/"
+ * Read more in https://github.com/jsenv/core/wiki
+ */
+
+import { build } from "@jsenv/core";
+import { jsenvPluginReact } from "@jsenv/plugin-react";
+
+await build({
+  sourceDirectoryUrl: new URL("../src/", import.meta.url),
+  buildDirectoryUrl: new URL("../dist/", import.meta.url),
+  entryPoints: {
+    "./index.html": "index.html",
+  },
+  plugins: [jsenvPluginReact()],
+  bundling: {
+    js_module: {
+      chunks: {
+        vendors: { "file:///**/node_modules/": true },
+      },
+    },
+  },
+});

package/template-web-react/scripts/build_serve.mjs

@@ -0,0 +1,16 @@
+/*
+ * Start a server serving files into dist/.
+ * Useful to test the files generated during the build
+ * Read more in https://github.com/jsenv/core/wiki
+ */
+
+import open from "open";
+import { startBuildServer } from "@jsenv/core";
+
+const buildServer = await startBuildServer({
+  buildDirectoryUrl: new URL("../dist/", import.meta.url),
+  port: 3501,
+});
+if (process.argv.includes("--open")) {
+  open(buildServer.origin);
+}

package/template-web-react/scripts/dev.mjs

@@ -0,0 +1,21 @@
+/*
+ * Start a development server for files inside src/
+ * Read more in https://github.com/jsenv/core/wiki
+ */
+
+import open from "open";
+import { startDevServer } from "@jsenv/core";
+import { jsenvPluginReact } from "@jsenv/plugin-react";
+
+export const devServer = await startDevServer({
+  sourceDirectoryUrl: new URL("../src/", import.meta.url),
+  plugins: [
+    jsenvPluginReact({
+      refreshInstrumentation: true,
+    }),
+  ],
+  port: 3400,
+});
+if (process.argv.includes("--open")) {
+  open(`${devServer.origin}`);
+}

package/template-web-react/scripts/test.mjs

@@ -0,0 +1,28 @@
+/*
+ * Execute all test files
+ * Read more in https://github.com/jsenv/core/wiki
+ */
+
+import { executeTestPlan, chromium, nodeWorkerThread } from "@jsenv/test";
+
+await executeTestPlan({
+  rootDirectoryUrl: new URL("../", import.meta.url),
+  testPlan: {
+    "./src/**/*.test.html": {
+      chromium: {
+        runtime: chromium(),
+      },
+    },
+    "./src/**/*.test.mjs": {
+      node: {
+        runtime: nodeWorkerThread(),
+      },
+    },
+  },
+  webServer: {
+    origin: "http://localhost:3400",
+    moduleUrl: new URL("./dev.mjs", import.meta.url),
+  },
+  coverage: process.argv.includes("--coverage"),
+  githubCheck: false,
+});

package/template-web-react/src/app/animals.js

@@ -0,0 +1,11 @@
+/*
+ * This file exists to show code using the browser runtime to operate:
+ * code writes "countDogs" function on window
+ *
+ * As a result testing "countDogs" should be done in a browser.
+ * See "animals.test.html"
+ */
+
+window.countDogs = (animals) => {
+  return animals.filter((animal) => animal === "dog").length;
+};

package/template-web-react/src/app/app.css

@@ -0,0 +1,42 @@
+.app {
+  text-align: center;
+}
+
+.app_logo {
+  height: 40vmin;
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .app_logo {
+    animation: app_logo_spin infinite 20s linear;
+  }
+}
+
+.app_header {
+  background-color: #282c34;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.app_link {
+  color: #61dafb;
+}
+
+@keyframes app_logo_spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+button {
+  font-size: calc(10px + 2vmin);
+}

package/template-web-react/src/app/app.jsx

@@ -0,0 +1,55 @@
+import { useLayoutEffect } from "react";
+
+import appStyleSheet from "./app.css" with { type: "css" };
+import { Counter } from "./counter.jsx";
+
+const reactLogoUrl = new URL("../react_logo.svg", import.meta.url);
+
+export const App = () => {
+  useLayoutEffect(() => {
+    document.adoptedStyleSheets = [
+      ...document.adoptedStyleSheets,
+      appStyleSheet,
+    ];
+    return () => {
+      document.adoptedStyleSheets = document.adoptedStyleSheets.filter(
+        (s) => s !== appStyleSheet,
+      );
+    };
+  }, []);
+
+  return (
+    <div className="app">
+      <header className="app_header">
+        <img src={reactLogoUrl} className="app_logo" alt="logo" />
+        <p>Hello jsenv + React!</p>
+        <p>
+          <Counter />
+        </p>
+        <p>
+          Edit{" "}
+          <a
+            className="app_link"
+            onClick={(e) => {
+              e.preventDefault();
+              window.fetch("/__open_in_editor__/app/app.jsx");
+            }}
+          >
+            app.jsx
+          </a>{" "}
+          and save to test HMR updates.
+        </p>
+        <p>
+          <a
+            className="app_link"
+            href="https://github.com/jsenv/core"
+            target="_blank"
+            rel="noopener noreferrer"
+          >
+            Jsenv documentation
+          </a>
+        </p>
+      </header>
+    </div>
+  );
+};

package/template-web-react/src/app/counter.jsx

@@ -0,0 +1,19 @@
+import { useState, Fragment } from "react";
+
+export const Counter = () => {
+  const [count, setCount] = useState(0);
+
+  return (
+    <Fragment>
+      <button
+        id="counter_button"
+        type="button"
+        onClick={() => setCount((count) => count + 1)}
+      >
+        Click me
+      </button>
+      <br />
+      number of click: <span id="counter_output">{count}</span>
+    </Fragment>
+  );
+};

package/template-web-react/src/index.html

@@ -0,0 +1,28 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/react_logo.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <style>
+      body {
+        margin: 0;
+        font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Roboto",
+          "Oxygen", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans",
+          "Helvetica Neue", sans-serif;
+        -webkit-font-smoothing: antialiased;
+        -moz-osx-font-smoothing: grayscale;
+      }
+
+      code {
+        font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New",
+          monospace;
+      }
+    </style>
+    <title>Jsenv App</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="./main.jsx"></script>
+  </body>
+</html>

package/template-web-react/src/main.jsx

@@ -0,0 +1,14 @@
+import React from "react";
+import ReactDOM from "react-dom/client";
+
+import { App } from "./app/app.jsx";
+
+ReactDOM.createRoot(document.querySelector("#root")).render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>,
+);
+
+if (import.meta.hot) {
+  import.meta.hot.accept();
+}

package/template-web-react/src/react_logo.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
+    <g fill="#61DAFB">
+        <path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
+        <circle cx="420.9" cy="296.5" r="45.7"/>
+        <path d="M520.5 78.1z"/>
+    </g>
+</svg>

package/template-web-react/src/tests/animals.test.html

@@ -0,0 +1,32 @@
+<!--
+This HTML file demo how to write a test using jsenv.
+This file is testing a "countDogs" function implemented in "animals.js"
+-->
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="data:," />
+  </head>
+
+  <body>
+    <script type="module">
+      import { assert } from "@jsenv/assert";
+      import "/app/animals.js";
+
+      {
+        const actual = window.countDogs(["dog", "dog"]);
+        const expect = 2;
+        assert({ actual, expect });
+      }
+
+      {
+        const actual = window.countDogs(["dog", "cat"]);
+        const expect = 1;
+        assert({ actual, expect });
+      }
+
+      document.body.appendChild(document.createTextNode("ok"));
+    </script>
+  </body>
+</html>

package/template-web-react/src/tests/app.test.mjs

@@ -0,0 +1,26 @@
+import { chromium } from "playwright";
+import { assert } from "@jsenv/assert";
+
+const browser = await chromium.launch();
+
+try {
+  const browserContext = await browser.newContext({ ignoreHTTPSErrors: true });
+  const page = await browserContext.newPage();
+  await page.goto(`http://localhost:3400`);
+
+  const getCounterOutput = () => {
+    return page.locator("#counter_output").innerHTML();
+  };
+
+  assert({
+    actual: await getCounterOutput(),
+    expect: "0",
+  });
+  await page.locator("#counter_button").click();
+  assert({
+    actual: await getCounterOutput(),
+    expect: "1",
+  });
+} finally {
+  browser.close();
+}