eslint-plugin-webmcp 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026-PRESENT ntnyq <https://github.com/ntnyq>
+
+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

@@ -0,0 +1,151 @@
+# eslint-plugin-webmcp
+
+[![CI](https://github.com/ntnyq/eslint-plugin-webmcp/workflows/CI/badge.svg)](https://github.com/ntnyq/eslint-plugin-webmcp/actions)
+[![NPM VERSION](https://img.shields.io/npm/v/eslint-plugin-webmcp.svg)](https://www.npmjs.com/package/eslint-plugin-webmcp)
+[![LICENSE](https://img.shields.io/github/license/ntnyq/eslint-plugin-webmcp.svg)](https://github.com/ntnyq/eslint-plugin-webmcp/blob/main/LICENSE)
+
+Conservative ESLint rules for browser WebMCP tool definitions and consumers. Includes **24 rules**, `recommended` and `strict` Flat Config presets, and two fixed API targets.
+
+Requires ESLint 9 or 10 and Node.js `^22.13.0 || >=24.0.0`. ESM only. This initial implementation covers imperative JavaScript and TypeScript; it does not lint HTML or Vue templates.
+
+## Install
+
+```sh
+pnpm add -D eslint eslint-plugin-webmcp
+```
+
+For an unpublished checkout, run `pnpm install && pnpm build && pnpm pack` and install the generated tarball in the consuming project.
+
+## Usage
+
+```js
+// eslint.config.mjs
+import webmcp from 'eslint-plugin-webmcp'
+
+export default [webmcp.configs.recommended]
+```
+
+The presets select JS/TS file extensions and never replace your parser or enable type services. Supply a parser when linting TypeScript:
+
+```js
+import parser from '@typescript-eslint/parser'
+import webmcp from 'eslint-plugin-webmcp'
+
+export default [
+  webmcp.configs.recommended,
+  {
+    files: ['**/*.{ts,mts,cts,tsx}'],
+    languageOptions: {
+      parser,
+      parserOptions: { ecmaFeatures: { jsx: true } },
+    },
+  },
+]
+```
+
+Install `@typescript-eslint/parser` separately. This checkout tests typescript-eslint 8.69 with TypeScript 6.0; follow your parser's supported TypeScript range.
+
+## Fixed API targets
+
+```js
+import { createConfig } from 'eslint-plugin-webmcp'
+
+export default [
+  createConfig({
+    target: 'chrome-2026-09-01',
+    preset: 'strict',
+    files: ['src/**/*.{js,ts,tsx}'],
+  }),
+]
+```
+
+| Target                       | Entry point             | `executeTool` input               |
+| ---------------------------- | ----------------------- | --------------------------------- |
+| `draft-2026-09-04` (default) | `document.modelContext` | Optional object, defaults to `{}` |
+| `chrome-2026-09-01`          | `document.modelContext` | Required JSON text                |
+
+Both snapshots use Promise-based registration, `options.signal` for unregistration and the `toolchange` event. The Chrome profile is backed by dated documentation and a fixed Chromium development commit; it does not claim that every Chrome release implements that snapshot. See [sources and snapshot details](docs/targets.md).
+
+Manual configurations can set `settings: { webmcp: { target: 'draft-2026-09-04' } }`. Unknown targets, presets, invalid file lists and malformed wrapper settings produce configuration errors. There is no floating `latest` or partially supported legacy target.
+
+## Rules and presets
+
+`recommended` enables provable API errors and the empty-description warning. `strict` includes recommended and additional metadata, option, origin and description warnings. Team-specific naming, titles, length budgets and explicit hint requirements remain opt-in.
+
+See the [complete rule table](docs/rules.md) for all 24 rules, defaults, examples and options. No rule automatically changes names, descriptions, callbacks, origins or registration lifetimes.
+
+```js
+import webmcp from 'eslint-plugin-webmcp'
+
+export default [
+  webmcp.configs.strict,
+  {
+    rules: {
+      'webmcp/valid-input-schema': [
+        'error',
+        { mode: 'json-schema', dialect: '2020-12' },
+      ],
+      'webmcp/tool-name-convention': [
+        'warn',
+        {
+          style: 'dot-separated',
+          segmentStyle: 'kebab-case',
+          prefix: 'catalog.',
+        },
+      ],
+      'webmcp/require-explicit-annotations': [
+        'warn',
+        { fields: ['readOnlyHint', 'consequentialHint'] },
+      ],
+    },
+  },
+]
+```
+
+By default, `valid-input-schema` checks only known platform boundary failures. Its opt-in JSON Schema mode validates the JSON representation against the 2020-12 meta-schema. It does not enforce object roots, closed properties or parameter descriptions, validate tool inputs at runtime, resolve remote references, or execute user code. Other explicitly declared dialects are skipped.
+
+## Tool-definition wrappers
+
+Recognize a project factory through its import binding, including renamed imports:
+
+```js
+export default [
+  webmcp.configs.recommended,
+  {
+    settings: {
+      webmcp: {
+        wrappers: [
+          {
+            module: '@app/webmcp',
+            imported: 'defineWebMcpTool',
+            toolArgument: 0,
+            kind: 'definition',
+          },
+        ],
+      },
+    },
+  },
+]
+```
+
+Only named imports are recognized. Definition factories do not imply registration, cancellation or Promise semantics. Modules are never loaded by the analyzer.
+
+## Analysis boundaries
+
+Direct `document`, `window.document` and `globalThis.document` receivers, static computed keys, optional chaining, TypeScript wrappers, and limited const aliases are supported. Local bindings that shadow platform globals are excluded. Unknown spreads and computed keys invalidate preceding fields; later explicit fields remain analyzable. Getters, setters and `__proto__` providers cause the object to be skipped.
+
+Object aliases must have a single read in the same execution scope and no writes, exports or escapes. Shared definitions and cross-function objects are intentionally skipped. This favors useful, predictable diagnostics over speculative data flow. See [analysis details](docs/analysis.md) and the [remaining design roadmap](docs/roadmap.md).
+
+## Development
+
+```sh
+pnpm install --frozen-lockfile
+pnpm release:check
+pnpm pack --dry-run
+```
+
+`release:check` runs formatting, lint, type checks, RuleTester/integration tests, the declaration build and a JS/TS smoke test imported through the package export. It does not publish the package.
+
+## License
+
+[MIT](./LICENSE) License © 2026-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.d.mts

@@ -0,0 +1,44 @@
+import { ESLint, Linter } from "eslint";
+//#region src/types.d.ts
+/**
+ * Fixed upstream snapshots; the target is never inferred from the environment.
+ */
+type WebMcpTarget = 'draft-2026-09-04' | 'chrome-2026-09-01';
+type WebMcpPreset = 'recommended' | 'strict';
+interface WebMcpConfigOptions {
+  target?: WebMcpTarget;
+  preset?: WebMcpPreset;
+  files?: string[];
+}
+/**
+ * An explicitly trusted tool-definition factory, identified by its import binding.
+ */
+interface WebMcpWrapper {
+  module: string;
+  imported: string;
+  toolArgument: number;
+  kind: 'definition';
+}
+interface WebMcpSettings {
+  target?: WebMcpTarget;
+  wrappers?: WebMcpWrapper[];
+}
+//#endregion
+//#region src/index.d.ts
+/**
+ * Native ESLint types keep consumer configs compatible with ESLint 9 and 10.
+ */
+export interface WebMcpPlugin extends ESLint.Plugin {
+  rules: NonNullable<ESLint.Plugin['rules']>;
+  configs: Record<WebMcpPreset, Linter.Config>;
+}
+/**
+ * Create a parser-independent Flat Config for a fixed WebMCP API snapshot.
+ *
+ * @param options Target, preset and optional file globs
+ * @returns A standalone Flat Config referencing this plugin
+ */
+export declare function createConfig(options?: WebMcpConfigOptions): Linter.Config;
+declare const webmcp: WebMcpPlugin;
+//#endregion
+export { type WebMcpConfigOptions, type WebMcpPreset, type WebMcpSettings, type WebMcpTarget, type WebMcpWrapper, webmcp as default };