@jsenv/cli 0.0.3 → 0.0.6

package/template-web-preact/.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']
+    },
+  },
+
+  // js import plugin
+  {
+    plugins: ["import"],
+    settings: {
+      "import/resolver": {
+        "@jsenv/eslint-import-resolver": {
+          rootDirectoryUrl: __dirname,
+          packageConditions: ["node", "import"],
+        },
+      },
+    },
+    rules: jsenvEslintRulesForImport,
+  },
+
+  // HTML plugin
+  {
+    plugins: ["html"],
+    settings: {
+      extensions: [".html"],
+      settings: {
+        "html/javascript-mime-types": [
+          "text/javascript",
+          "module",
+          "text/jsx",
+          "module/jsx",
+        ],
+      },
+    },
+  },
+
+  // react plugin
+  {
+    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-preact/.prettierrc.yml

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

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

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

package/template-web-preact/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "jsenv-template-web-preact",
+  "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": {
+    "preact": "10.22.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-preact": "1.6.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-preact/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 { jsenvPluginPreact } from "@jsenv/plugin-preact";
+
+await build({
+  sourceDirectoryUrl: new URL("../src/", import.meta.url),
+  buildDirectoryUrl: new URL("../dist/", import.meta.url),
+  entryPoints: {
+    "./index.html": "index.html",
+  },
+  bundling: {
+    js_module: {
+      chunks: {
+        vendors: { "file:///**/node_modules/": true },
+      },
+    },
+  },
+  plugins: [jsenvPluginPreact()],
+});

package/template-web-preact/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-preact/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 { jsenvPluginPreact } from "@jsenv/plugin-preact";
+
+export const devServer = await startDevServer({
+  sourceDirectoryUrl: new URL("../src/", import.meta.url),
+  plugins: [
+    jsenvPluginPreact({
+      refreshInstrumentation: { "file://**/*.jsx": true },
+    }),
+  ],
+  port: 3400,
+});
+if (process.argv.includes("--open")) {
+  open(`${devServer.origin}`);
+}

package/template-web-preact/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-preact/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-preact/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-preact/src/app/app.jsx

@@ -0,0 +1,52 @@
+import { useLayoutEffect } from "preact/hooks";
+
+import appStyleSheet from "./app.css" with { type: "css" };
+import { Counter } from "./counter.jsx";
+
+const preactLogoUrl = new URL("../preact_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={preactLogoUrl} className="app_logo" alt="logo" />
+        <p>Hello jsenv + preact!</p>
+        <p>
+          <Counter />
+        </p>
+        <p>
+          Edit{" "}
+          <a
+            className="app_link"
+            href="javascript: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-preact/src/app/counter.jsx

@@ -0,0 +1,20 @@
+import { Fragment } from "preact";
+import { useState } from "preact/hooks";
+
+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-preact/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="./preact_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-preact/src/main.jsx

@@ -0,0 +1,5 @@
+import { render } from "preact";
+
+import { App } from "./app/app.jsx";
+
+render(<App />, document.querySelector("#root"));

package/template-web-preact/src/preact_logo.svg

@@ -0,0 +1,6 @@
+<svg viewBox="0 0 32 32" xmlns="http://www.w3.org/2000/svg">
+    <path fill="#673ab8" d="M16 2l12.12 7v14L16 30 3.88 23V9z"/>
+    <ellipse fill="none" stroke="#fff" cx="16" cy="16" rx="10.72" ry="4.1" transform="rotate(-37.5 16.007 15.996)"/>
+    <ellipse fill="none" stroke="#fff" cx="16" cy="16" rx="4.1" ry="10.72" transform="rotate(-52.5 15.998 15.994)"/>
+    <circle fill="#fff" cx="16" cy="16" r="1.86"/>
+</svg>

package/template-web-preact/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-preact/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();
+}

package/template-web-react/.eslintignore

@@ -0,0 +1,3 @@
+.jsenv/
+.coverage/
+dist/