wc-compiler 0.18.1 → 0.20.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2022 Project Evergreen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-<img src="https://merry-caramel-524e61.netlify.app/assets/wcc-logo.png" width="30%"/>
+<img src="https://wcc.dev/assets/wcc-logo.svg" width="30%"/>
 
 # Web Components Compiler (WCC)
 
@@ -8,7 +8,7 @@
 [![NodeJS compatibility](https://img.shields.io/node/v/wc-compiler.svg)](https://nodejs.org/en/about/previous-releases")
 [![Discord Chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://www.greenwoodjs.dev/discord/)
 
-> _Experimental Web Components compiler. It's Web Components all the way down!_ 🐢
+> _Native Web Components compiler. It's Web Components all the way down!_ 🐢
 
 ## How It Works
 
@@ -81,7 +81,7 @@ $ npm install wc-compiler --save-dev
 
 ## Documentation
 
-See our [website](https://merry-caramel-524e61.netlify.app/) for API docs and examples.
+See our [website](https://www.wcc.dev) for API docs and examples.
 
 ## Motivation
 

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "wc-compiler",
-  "version": "0.18.1",
-  "description": "Experimental native Web Components compiler.",
+  "version": "0.20.0",
+  "description": "WCC supports server-rendering of standard Web Components, generating HTML directly from your custom element definitions.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ProjectEvergreen/wcc.git"
+    "url": "git+https://github.com/ProjectEvergreen/wcc.git"
   },
   "type": "module",
   "main": "src/wcc.js",
   "types": "./src/index.d.ts",
   "exports": {
     ".": {
-      "import": "./src/wcc.js",
-      "types": "./src/index.d.ts"
+      "types": "./src/index.d.ts",
+      "import": "./src/wcc.js"
     },
     "./register": "./src/register.js",
-    "./src/jsx-loader.js": "./src/jsx-loader.js",
+    "./dom-shim": "./src/dom-shim.js",
+    "./jsx-loader": "./src/jsx-loader.js",
     "./jsx-runtime": "./src/jsx-runtime.ts"
   },
   "author": "Owen Buckley <owen@thegreenhouse.io>",
@@ -36,22 +37,22 @@
     "access": "public"
   },
   "scripts": {
-    "clean": "rimraf ./dist",
-    "lint": "npm run lint:js && npm run lint:ls",
+    "dev": "greenwood develop",
+    "build": "NODE_OPTIONS='--import @greenwood/cli/register' greenwood build",
+    "serve": "greenwood serve",
+    "lint": "npm run lint:js && npm run lint:ls && npm run lint:css",
     "lint:js": "eslint",
     "lint:ls": "ls-lint",
-    "lint:types": "tsc",
+    "lint:css": "stylelint \"./docs/**/*.css\"",
+    "check:types": "tsc",
     "format": "prettier . --write",
     "format:check": "prettier . --check",
-    "docs:dev": "concurrently \"nodemon --watch src --watch docs -e js,md,css,html,jsx,ts,tsx ./build.js\" \"http-server ./dist --open\"",
-    "docs:build": "node ./build.js",
-    "docs:serve": "npm run clean && npm run docs:build && http-server ./dist --open",
-    "sandbox": "npm run clean && concurrently \"nodemon --experimental-strip-types --loader ./test-loader.js --watch src --watch sandbox -e js,md,css,html,jsx,ts ./sandbox.js\" \"http-server ./dist --open\" \"livereload ./dist\"",
-    "start": "npm run docs:serve",
     "test": "mocha --exclude \"./test/cases/jsx*/**\" --exclude \"./test/cases/ts*/**\" --exclude \"./test/cases/custom-extension/**\" \"./test/**/**/*.spec.js\"",
     "test:jsx": "c8 node --import ./test-register.js --experimental-strip-types ./node_modules/mocha/bin/mocha \"./test/**/**/*.spec.js\"",
     "test:tdd": "npm run test -- --watch",
     "test:tdd:jsx": "npm run test:jsx -- --watch",
+    "test:docs": "vitest run --coverage",
+    "test:docs:tdd": "vitest",
     "prepare": "husky"
   },
   "dependencies": {
@@ -63,38 +64,45 @@
     "sucrase": "^3.35.0"
   },
   "devDependencies": {
+    "@double-great/stylelint-a11y": "^3.0.2",
     "@eslint/js": "^9.39.1",
+    "@greenwood/cli": "^0.34.0-alpha.4",
+    "@greenwood/plugin-css-modules": "^0.34.0-alpha.4",
+    "@greenwood/plugin-import-jsx": "^0.34.0-alpha.4",
+    "@greenwood/plugin-import-raw": "^0.34.0-alpha.4",
+    "@greenwood/plugin-markdown": "^0.34.0-alpha.4",
     "@ls-lint/ls-lint": "^2.3.1",
     "@mapbox/rehype-prism": "^0.8.0",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.13.4",
+    "@vitest/browser-playwright": "^4.0.18",
+    "@vitest/coverage-v8": "^4.0.18",
     "c8": "^7.11.2",
     "chai": "^4.3.6",
-    "concurrently": "^7.1.0",
     "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-no-only-tests": "^3.3.0",
+    "geist": "^1.2.0",
     "globals": "^15.10.0",
-    "http-server": "^14.1.0",
     "husky": "^9.1.7",
     "jsdom": "^19.0.0",
     "lint-staged": "^16.2.6",
-    "livereload": "^0.9.3",
     "mocha": "^9.2.2",
-    "nodemon": "^2.0.15",
+    "open-props": "^1.7.4",
+    "playwright": "^1.58.2",
     "prettier": "^3.6.2",
+    "prism-themes": "^1.9.0",
     "prismjs": "^1.28.0",
-    "rehype-autolink-headings": "^6.1.1",
-    "rehype-raw": "^6.1.1",
-    "rehype-slug": "^5.0.1",
-    "rehype-stringify": "^9.0.3",
-    "remark-parse": "^10.0.1",
-    "remark-rehype": "^10.1.0",
-    "remark-toc": "^8.0.1",
-    "rimraf": "^3.0.2",
-    "simple.css": "^0.1.3",
-    "typescript": "^5.8.2",
+    "rehype-autolink-headings": "^4.0.0",
+    "rehype-external-links": "^3.0.0",
+    "rehype-slug": "^3.0.0",
+    "remark-gfm": "^4.0.0",
+    "remark-github": "^10.0.1",
+    "stylelint": "^16.10.0",
+    "stylelint-config-recommended": "^14.0.1",
+    "typescript": "^5.9.3",
     "typescript-eslint": "^8.46.2",
-    "unified": "^10.1.2"
+    "vite": "^7.3.1",
+    "vitest": "^4.0.18"
   }
 }

package/src/jsx-loader.js

@@ -77,7 +77,7 @@ function applyDomDepthSubstitutions(tree, currentDepth = 1, hasShadowRoot = fals
   return tree;
 }
 
-function parseJsxElement(element, moduleContents = '') {
+function parseJsxElement(element, moduleContents = '', inferredObservability = false) {
   try {
     const { type } = element;
 
@@ -124,8 +124,14 @@ function parseJsxElement(element, moduleContents = '') {
 
               if (left.object.type === 'ThisExpression') {
                 if (left.property.type === 'Identifier') {
-                  // very naive (fine grained?) reactivity
-                  string += ` ${name}="__this__.${left.property.name}${expression.operator}${right.raw}; __this__.render();"`;
+                  if (inferredObservability) {
+                    // very naive (fine grained?) reactivity
+                    // string += ` ${name}="__this__.${left.property.name}${expression.operator}${right.raw}; __this__.update(\\'${left.property.name}\\', null, __this__.${left.property.name});"`;
+                    string += ` ${name}="__this__.${left.property.name}${expression.operator}${right.raw}; __this__.setAttribute(\\'${left.property.name}\\', __this__.${left.property.name});"`;
+                  } else {
+                    // implicit reactivity using this.render
+                    string += ` ${name}="__this__.${left.property.name}${expression.operator}${right.raw}; __this__.render();"`;
+                  }
                 }
               }
             }
@@ -160,6 +166,11 @@ function parseJsxElement(element, moduleContents = '') {
                 default:
                   break;
               }
+
+              // only apply this when dealing with `this` references
+              if (inferredObservability) {
+                string += ` data-wcc-${expression.name}="${name}" data-wcc-ins="attr"`;
+              }
             }
           } else {
             // xxx >
@@ -171,7 +182,9 @@ function parseJsxElement(element, moduleContents = '') {
       string += openingElement.selfClosing ? ' />' : '>';
 
       if (element.children.length > 0) {
-        element.children.forEach((child) => parseJsxElement(child, moduleContents));
+        element.children.forEach((child) =>
+          parseJsxElement(child, moduleContents, inferredObservability),
+        );
       }
 
       string += `</${tagName}>`;
@@ -186,6 +199,13 @@ function parseJsxElement(element, moduleContents = '') {
 
       if (type === 'Identifier') {
         // You have {count} TODOs left to complete
+        if (inferredObservability) {
+          const { name } = element.expression;
+
+          string = `${string.slice(0, string.lastIndexOf('>'))} data-wcc-${name}="\${this.${name}}" data-wcc-ins="text">`;
+        }
+        // TODO be able to remove this extra data attribute
+        // string = `${string.slice(0, string.lastIndexOf('>'))} data-wcc-${name} data-wcc-ins="text">`;
         string += `$\{${element.expression.name}}`;
       } else if (type === 'MemberExpression') {
         const { object } = element.expression.object;
@@ -233,10 +253,16 @@ function findThisReferences(context, statement) {
         // const { description } = this.todo;
         references.push(init.property.name);
       } else if (init.type === 'ThisExpression' && id && id.properties) {
-        // const { description } = this.todo;
+        // const { id, description } = this;
         id.properties.forEach((property) => {
           references.push(property.key.name);
         });
+      } else {
+        // TODO we are just blindly tracking anything here.
+        // everything should ideally be mapped to actual this references, to create a strong chain of direct reactivity
+        // instead of tracking any declaration as a derived tracking attr
+        // for convenience here, we push the entire declaration here, instead of the name like for direct this references (see above)
+        references.push(declaration);
       }
     });
   }
@@ -262,6 +288,35 @@ export function parseJsx(moduleURL) {
   });
   string = '';
 
+  // TODO: would be nice to do this one pass, but first we need to know if `inferredObservability` is set first
+  walk.simple(
+    tree,
+    {
+      ExportNamedDeclaration(node) {
+        const { declaration } = node;
+
+        if (
+          declaration &&
+          declaration.type === 'VariableDeclaration' &&
+          declaration.kind === 'const' &&
+          declaration.declarations.length === 1
+        ) {
+          // @ts-ignore
+          if (declaration.declarations[0].id.name === 'inferredObservability') {
+            // @ts-ignore
+            inferredObservability = Boolean(node.declaration.declarations[0].init.raw);
+          }
+        }
+      },
+    },
+    {
+      // https://github.com/acornjs/acorn/issues/829#issuecomment-1172586171
+      ...walk.base,
+      // @ts-ignore
+      JSXElement: () => {},
+    },
+  );
+
   walk.simple(
     tree,
     {
@@ -286,7 +341,7 @@ export function parseJsx(moduleURL) {
                     ];
                     // @ts-ignore
                   } else if (n.type === 'ReturnStatement' && n.argument.type === 'JSXElement') {
-                    const html = parseJsxElement(n.argument, moduleContents);
+                    const html = parseJsxElement(n.argument, moduleContents, inferredObservability);
                     const elementTree = getParse(html)(html);
                     const elementRoot = hasShadowRoot ? 'this.shadowRoot' : 'this';
 
@@ -325,22 +380,6 @@ export function parseJsx(moduleURL) {
           }
         }
       },
-      ExportNamedDeclaration(node) {
-        const { declaration } = node;
-
-        if (
-          declaration &&
-          declaration.type === 'VariableDeclaration' &&
-          declaration.kind === 'const' &&
-          declaration.declarations.length === 1
-        ) {
-          // @ts-ignore
-          if (declaration.declarations[0].id.name === 'inferredObservability') {
-            // @ts-ignore
-            inferredObservability = Boolean(node.declaration.declarations[0].init.raw);
-          }
-        }
-      },
     },
     {
       // https://github.com/acornjs/acorn/issues/829#issuecomment-1172586171
@@ -350,11 +389,10 @@ export function parseJsx(moduleURL) {
     },
   );
 
-  // TODO - signals: use constructor, render, HTML attributes?  some, none, or all?
   if (inferredObservability && observedAttributes.length > 0 && !hasOwnObservedAttributes) {
     let insertPoint;
     for (const line of tree.body) {
-      // test for class MyComponent vs export default class MyComponent
+      // TODO: test for class MyComponent vs export default class MyComponent
       // @ts-ignore
       if (
         line.type === 'ClassDeclaration' ||
@@ -366,11 +404,36 @@ export function parseJsx(moduleURL) {
     }
 
     let newModuleContents = generate(tree);
-
-    // TODO better way to determine value type?
+    const trackingAttrs = observedAttributes.filter((attr) => typeof attr === 'string');
+    // TODO ideally derivedAttrs would explicitly reference trackingAttrs
+    // and if there are no derivedAttrs, do not include the derivedGetters / derivedSetters code in the compiled output
+    const derivedAttrs = observedAttributes.filter((attr) => typeof attr !== 'string');
+    const derivedGetters = derivedAttrs
+      .map((attr) => {
+        return `
+        get_${attr.id.name}(${trackingAttrs.join(',')}) {
+          return ${moduleContents.slice(attr.init.start, attr.init.end)}
+        }
+      `;
+      })
+      .join('\n');
+    const derivedSetters = derivedAttrs
+      .map((attr) => {
+        const name = attr.id.name;
+
+        return `
+        const old_${name} = this.get_${name}(oldValue);
+        const new_${name} = this.get_${name}(newValue);
+        this.update('${name}', old_${name}, new_${name});
+      `;
+      })
+      .join('\n');
+
+    // TODO: better way to determine value type, e,g. array, int, object, etc?
+    // TODO: better way to test for shadowRoot presence when running querySelectorAll
     newModuleContents = `${newModuleContents.slice(0, insertPoint)}
       static get observedAttributes() {
-        return [${[...observedAttributes].map((attr) => `'${attr}'`).join(',')}]
+        return [${[...trackingAttrs].map((attr) => `'${attr}'`).join()}]
       }
 
       attributeChangedCallback(name, oldValue, newValue) {
@@ -385,21 +448,47 @@ export function parseJsx(moduleURL) {
         }
         if (newValue !== oldValue) {
           switch(name) {
-            ${observedAttributes
+            ${trackingAttrs
               .map((attr) => {
                 return `
-                case '${attr}':
-                  this.${attr} = getValue(newValue);
-                  break;
-              `;
+                  case '${attr}':
+                    this.${attr} = getValue(newValue);
+                    break;
+                `;
               })
               .join('\n')}
           }
+          this.update(name, oldValue, newValue);
+        }
+      }
 
-          this.render();
+      update(name, oldValue, newValue) {
+        const attr = \`data-wcc-\${name}\`;
+        const selector = \`[\${attr}]\`;
+
+        (this?.shadowRoot || this).querySelectorAll(selector).forEach((el) => {
+          // handle empty strings as a value for the purposes of attribute change detection
+          const needle = oldValue === '' ? '' : oldValue ?? el.getAttribute(attr);
+
+          switch(el.getAttribute('data-wcc-ins')) {
+            case 'text':
+              el.textContent = el.textContent.replace(needle, newValue);
+              break;
+            case 'attr':
+              if (el.hasAttribute(el.getAttribute(attr))) {
+                el.setAttribute(el.getAttribute(attr), newValue);
+              }
+              break;
+          }
+        })
+
+        if ([${[...trackingAttrs].map((attr) => `'${attr}'`).join()}].includes(name)) {
+          ${derivedSetters}
         }
       }
 
+      ${derivedGetters}
+
       ${newModuleContents.slice(insertPoint)}
     `;
 

package/src/jsx.d.ts

@@ -1,20 +1,31 @@
 // to support `style` attributes, we override `CSSStyleDeclaration` with `string`
 type IsCSSStyleDeclaration<T> = T extends CSSStyleDeclaration ? string : T;
 
-// create a utility type to extract the attributes from any given element's DOM interface.
+// creates a utility type to extract the attributes from any given element's DOM interface from `HTMLElementTagNameMap`
 type ElementAttributes<E extends HTMLElement> = {
-  // Extract all properties from the element, including inherited ones.
+  // Extract all properties from the element, including inherited ones
   [A in keyof E]?: E[A] extends (...args: any) => any ? any : IsCSSStyleDeclaration<E[A]>;
 } & {
   class?: string;
 };
 
-// map each HTML tag to a union of its attributes and the global attributes.
+type PopoverTargetAction = 'show' | 'hide' | 'toggle';
+type PopoverTargetAttributes = {
+  // have to manage this manually, can't seem to get this from TypeScript itself (not sure if just skill issue? :D)
+  // https://github.com/microsoft/TypeScript-DOM-lib-generator/issues/1790
+  // it should be there per https://github.com/mdn/browser-compat-data/pull/21875
+  // https://github.com/ProjectEvergreen/wcc/issues/236
+  // per the spec, this should only apply to <button> and <input> elements.
+  popovertarget?: string;
+  popovertargetaction?: PopoverTargetAction;
+};
+
+// map each HTML tag to its attributes
 type IntrinsicElementsFromDom = {
-  [E in keyof HTMLElementTagNameMap]: ElementAttributes<HTMLElementTagNameMap[E]>;
+  [E in keyof HTMLElementTagNameMap]: ElementAttributes<HTMLElementTagNameMap[E]> &
+    (E extends 'button' | 'input' ? PopoverTargetAttributes : {});
 };
 
-// declare the global JSX namespace with your generated intrinsic elements.
 declare namespace JSX {
   interface IntrinsicElements extends IntrinsicElementsFromDom {}
 }