@elenajs/plugin-cem-tag 0.4.0 → 1.0.0-beta.1

package/README.md

@@ -0,0 +1,109 @@
+<div align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://elenajs.com/img/elena-dark.png" alt="Elena" width="558" height="220">
+  </source>
+  <source media="(prefers-color-scheme: light)" srcset="https://elenajs.com/img/elena-light.png" alt="Elena" width="558" height="220">
+  </source>
+  <img src="https://elenajs.com/img/elena-light.png" alt="Elena" width="558" height="220">
+</picture>
+
+### CEM analyzer plugin that copies custom Elena JSDoc tags into the manifest.
+
+<br/>
+
+<a href="https://arielsalminen.com"><img src="https://img.shields.io/badge/creator-@arielle-F95B1F" alt="Creator @arielle"/></a>
+<a href="https://www.npmjs.com/package/@elenajs/plugin-cem-tag"><img src="https://img.shields.io/npm/v/@elenajs/plugin-cem-tag.svg" alt="Latest version on npm" /></a>
+<a href="https://github.com/getelena/elena/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellow.svg" alt="Elena is released under the MIT license." /></a>
+<a href="https://github.com/getelena/elena/actions/workflows/tests.yml"><img src="https://github.com/getelena/elena/actions/workflows/tests.yml/badge.svg" alt="Tests status" /></a>
+
+</div>
+
+<br/>
+
+<p align="center"><strong>@elenajs/plugin-cem-tag</strong> is a <a href="https://custom-elements-manifest.open-wc.org/">Custom Elements Manifest</a> analyzer plugin that copies custom JSDoc tags from <a href="https://elenajs.com">Elena</a> Progressive Web Component classes into the manifest.</p>
+
+<br/>
+
+## Table of contents
+
+- **[Install](#install)**
+- **[Usage](#usage)**
+- **[How it works](#how-it-works)**
+
+## Install
+
+```bash
+npm install --save-dev @elenajs/plugin-cem-tag
+```
+
+**Peer dependency:** `@custom-elements-manifest/analyzer >= 0.10.0`
+
+## Usage
+
+Create one plugin instance per JSDoc tag you want to extract:
+
+```js
+import { elenaTagPlugin } from "@elenajs/plugin-cem-tag";
+
+// In your CEM analyzer config
+export default {
+  plugins: [
+    elenaTagPlugin("status"),
+    elenaTagPlugin("displayName"),
+  ],
+};
+```
+
+Or when using `@elenajs/bundler`, add it to the `analyze.plugins` array in `elena.config.mjs`:
+
+```js
+import { elenaTagPlugin } from "@elenajs/plugin-cem-tag";
+
+export default {
+  analyze: {
+    plugins: [
+      elenaTagPlugin("status"),
+      elenaTagPlugin("displayName"),
+    ],
+  },
+};
+```
+
+> [!NOTE]
+> The `@elenajs/bundler` already includes this plugin by default for `@status` and `@displayName`. You only need to add it manually if you're using the CEM analyzer independently or want to extract additional custom tags.
+
+## How it works
+
+The plugin scans registered custom element classes for a specified JSDoc tag and writes its value onto the CEM class declaration. For example, given this component:
+
+```js
+/**
+ * Button component for interface actions.
+ *
+ * @displayName Button
+ * @status beta
+ */
+export default class Button extends Elena(HTMLElement, {
+  tagName: "elena-button",
+}) {}
+```
+
+Using `elenaTagPlugin("status")` will add `"status": "beta"` to the component's CEM declaration, and `elenaTagPlugin("displayName")` will add `"displayName": "Button"`. This metadata is then available to IDEs, documentation generators, and other tools that consume the Custom Elements Manifest.
+
+## API
+
+### `elenaTagPlugin(tagName)`
+
+Returns a CEM analyzer plugin that extracts the specified JSDoc tag.
+
+| Parameter | Type     | Description                                                       |
+| --------- | -------- | ----------------------------------------------------------------- |
+| `tagName` | `string` | The JSDoc tag name to extract (e.g. `"status"`, `"displayName"`). |
+
+## License
+
+MIT
+
+## Copyright
+
+Copyright © 2026 [Ariel Salminen](https://arielsalminen.com)

package/package.json

@@ -1,9 +1,17 @@
 {
   "name": "@elenajs/plugin-cem-tag",
-  "version": "0.4.0",
+  "version": "1.0.0-beta.1",
   "description": "CEM analyzer plugin that copies custom Elena JSDoc tags into the manifest.",
   "author": "Elena <hi@elenajs.com>",
   "homepage": "https://elenajs.com/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/getelena/elena.git",
+    "directory": "packages/plugin-cem-tag"
+  },
+  "bugs": {
+    "url": "https://github.com/getelena/elena/issues"
+  },
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -26,8 +34,8 @@
   },
   "devDependencies": {
     "@custom-elements-manifest/analyzer": "0.11.0",
-    "@elenajs/plugin-cem-define": "0.4.0",
+    "@elenajs/plugin-cem-define": "1.0.0-beta.1",
     "vitest": "4.0.18"
   },
-  "gitHead": "b4c41483e5196b542a1b87361f7d37222737fccc"
+  "gitHead": "66d1e66dd467c20d7c5c70ffcb5678c6a2694690"
 }

package/src/index.js

@@ -1,10 +1,10 @@
 /**
  *  ██████████ ████
  * ░░███░░░░░█░░███
- *  ░███  █ ░  ███   ██████  ████████    ██████
- *  ░██████    ███  ███░░███░░███░░███  ░░░░░███
- *  ░███░░█    ███ ░███████  ░███ ░███   ███████
- *  ░███ ░   █ ███ ░███░░░   ░███ ░███  ███░░███
+ *  ░███  █ ░  ░███   ██████  ████████    ██████
+ *  ░██████    ░███  ███░░███░░███░░███  ░░░░░███
+ *  ░███░░█    ░███ ░███████  ░███ ░███   ███████
+ *  ░███ ░   █ ░███ ░███░░░   ░███ ░███  ███░░███
  *  ██████████ █████░░██████  ████ █████░░████████
  * ░░░░░░░░░░ ░░░░░  ░░░░░░  ░░░░ ░░░░░  ░░░░░░░░
  *