@oicl-lit/analyzer 0.14.1

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2022 Google LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,76 @@
+# @lit-labs/analyzer
+
+A static analyzer for Lit
+
+> [!WARNING]
+>
+> This package is part of [Lit Labs](https://lit.dev/docs/libraries/labs/). It
+> is published in order to get feedback on the design and may receive breaking
+> changes or stop being supported.
+>
+> Please read our [Lit Labs documentation](https://lit.dev/docs/libraries/labs/)
+> before using this library in production.
+
+## Overview
+
+This package contains static analysis utilities for analyzing source code that contain Lit templates and elements, that might be useful for other programs like linters, IDE plugins, code generators, etc.
+
+This is a very early stage Lit Labs package and is not ready for use.
+
+## Usage
+
+_This section is incomplete_
+
+### Node
+
+```ts
+import {createPackageAnalyzer} from '@lit-labs/analyzer/package-analyzer.js';
+import * as path from 'path';
+
+const packagePath = path.resolve('./my-package');
+const analyzer = createPackageAnalyzer(packagePath);
+const module = analyzer.getModule(
+  path.resolve(packagePath, 'src/my-element.ts')
+);
+```
+
+### Browser
+
+You must use a bundler to bundle TypeScript, such as Rollup with the CommonJS plugin.
+
+With `@rollup/plugin-commonjs` you need to ignore built-in libraries like `os`, `fs`, etc. You can isgnore these in your Rollup config:
+
+rollup.config.js:
+
+```ts
+import commonjs from '@rollup/plugin-commonjs';
+
+// ...
+    plugins: [
+      commonjs({
+          ignore: (id) => ['fs', 'os', 'inspector'].includes(id),
+      }),
+    ],
+// ...
+```
+
+You may need to install the `'path'` package:
+
+```sh
+npm i path
+```
+
+Then you can make an Analyzer using these imports:
+
+```ts
+import {Analyzer} from '@lit-labs/analyzer/lib/analyzer.js';
+import {AbsolutePath} from '@lit-labs/analyzer/lib/paths.js';
+import ts from 'typescript';
+import * as path from 'path';
+
+// TODO: show constructing an Analyzer in browser contexts
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

package/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export { Analyzer } from './lib/analyzer.js';
+export type { Package, Module, Reference, Type, Event, Declaration, VariableDeclaration, ClassDeclaration, ClassField, ClassMethod, Parameter, Return, LitElementDeclaration, MixinDeclaration, CustomElementDeclaration, LitElementExport, PackageJson, ModuleWithLitElementDeclarations, DeprecatableDescribed, FunctionDeclaration, } from './lib/model.js';
+export type { AbsolutePath, PackagePath } from './lib/paths.js';
+export { getImportsStringForReferences } from './lib/model.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AAE3C,YAAY,EACV,OAAO,EACP,MAAM,EACN,SAAS,EACT,IAAI,EACJ,KAAK,EACL,WAAW,EACX,mBAAmB,EACnB,gBAAgB,EAChB,UAAU,EACV,WAAW,EACX,SAAS,EACT,MAAM,EACN,qBAAqB,EACrB,gBAAgB,EAChB,wBAAwB,EACxB,gBAAgB,EAChB,WAAW,EACX,gCAAgC,EAChC,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,gBAAgB,CAAC;AAExB,YAAY,EAAC,YAAY,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AAI9D,OAAO,EAAC,6BAA6B,EAAC,MAAM,gBAAgB,CAAC"}

package/index.js

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export { Analyzer } from './lib/analyzer.js';
+// Any non-type exports below must be safe to use on objects between multiple
+// versions of the analyzer library
+export { getImportsStringForReferences } from './lib/model.js';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAC,QAAQ,EAAC,MAAM,mBAAmB,CAAC;AA2B3C,6EAA6E;AAC7E,mCAAmC;AACnC,OAAO,EAAC,6BAA6B,EAAC,MAAM,gBAAgB,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2022 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\nexport {Analyzer} from './lib/analyzer.js';\n\nexport type {\n  Package,\n  Module,\n  Reference,\n  Type,\n  Event,\n  Declaration,\n  VariableDeclaration,\n  ClassDeclaration,\n  ClassField,\n  ClassMethod,\n  Parameter,\n  Return,\n  LitElementDeclaration,\n  MixinDeclaration,\n  CustomElementDeclaration,\n  LitElementExport,\n  PackageJson,\n  ModuleWithLitElementDeclarations,\n  DeprecatableDescribed,\n  FunctionDeclaration,\n} from './lib/model.js';\n\nexport type {AbsolutePath, PackagePath} from './lib/paths.js';\n\n// Any non-type exports below must be safe to use on objects between multiple\n// versions of the analyzer library\nexport {getImportsStringForReferences} from './lib/model.js';\n"]}

package/lib/analyzer.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import type ts from 'typescript';
+import { AnalyzerInterface, Module, Package, PackageJson } from './model.js';
+import { AbsolutePath } from './paths.js';
+export { PackageJson };
+export type TypeScript = typeof ts;
+export interface AnalyzerInit {
+    typescript: TypeScript;
+    getProgram: () => ts.Program;
+    fs: AnalyzerInterface['fs'];
+    path: AnalyzerInterface['path'];
+    basePath?: AbsolutePath;
+}
+/**
+ * An analyzer for Lit typescript modules.
+ */
+export declare class Analyzer implements AnalyzerInterface {
+    readonly moduleCache: Map<AbsolutePath, Module>;
+    private readonly _getProgram;
+    readonly typescript: TypeScript;
+    readonly fs: AnalyzerInterface['fs'];
+    readonly path: AnalyzerInterface['path'];
+    private _commandLine;
+    private readonly diagnostics;
+    constructor(init: AnalyzerInit);
+    get program(): ts.Program;
+    get commandLine(): ts.ParsedCommandLine;
+    getModule(modulePath: AbsolutePath): Module;
+    getPackage(): Package;
+    addDiagnostic(diagnostic: ts.Diagnostic): void;
+    getDiagnostics(): Generator<ts.Diagnostic, void, unknown>;
+}
+/**
+ * Extracts a `ts.ParsedCommandLine` (essentially, the key bits of a
+ * `tsconfig.json`) from the analyzer's `ts.Program`.
+ *
+ * The `ts.getOutputFileNames()` function must be passed a
+ * `ts.ParsedCommandLine`; since not all usages of the analyzer create the
+ * program directly from a tsconfig (plugins get passed the program only),
+ * this allows backing the `ParsedCommandLine` out of an existing program.
+ */
+export declare const getCommandLineFromProgram: (analyzer: Analyzer) => ts.ParsedCommandLine;
+//# sourceMappingURL=analyzer.d.ts.map

package/lib/analyzer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzer.d.ts","sourceRoot":"","sources":["../src/lib/analyzer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAMjC,OAAO,EAAC,iBAAiB,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAC,MAAM,YAAY,CAAC;AAC3E,OAAO,EAAC,YAAY,EAAC,MAAM,YAAY,CAAC;AACxC,OAAO,EAAC,WAAW,EAAC,CAAC;AAErB,MAAM,MAAM,UAAU,GAAG,OAAO,EAAE,CAAC;AAEnC,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,MAAM,EAAE,CAAC,OAAO,CAAC;IAC7B,EAAE,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,YAAY,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,QAAS,YAAW,iBAAiB;IAGhD,QAAQ,CAAC,WAAW,4BAAmC;IACvD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmB;IAC/C,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,EAAE,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACzC,OAAO,CAAC,YAAY,CAA+C;IACnE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuB;gBAEvC,IAAI,EAAE,YAAY;IAS9B,IAAI,OAAO,eAEV;IAED,IAAI,WAAW,yBAEd;IAED,SAAS,CAAC,UAAU,EAAE,YAAY;IAIlC,UAAU;IAuBV,aAAa,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU;IAItC,cAAc;CAGhB;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,GACpC,UAAU,QAAQ,KACjB,EAAE,CAAC,iBA+BL,CAAC"}

package/lib/analyzer.js

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { getModule } from './javascript/modules.js';
+import { getPackageInfo, getPackageRootForModulePath, } from './javascript/packages.js';
+import { Package } from './model.js';
+/**
+ * An analyzer for Lit typescript modules.
+ */
+export class Analyzer {
+    constructor(init) {
+        // Cache of Module models by path; invalidated when the sourceFile
+        // or any of its dependencies change
+        this.moduleCache = new Map();
+        this._commandLine = undefined;
+        this.diagnostics = [];
+        ({
+            fs: this.fs,
+            path: this.path,
+            typescript: this.typescript,
+            getProgram: this._getProgram,
+        } = init);
+    }
+    get program() {
+        return this._getProgram();
+    }
+    get commandLine() {
+        return (this._commandLine ??= getCommandLineFromProgram(this));
+    }
+    getModule(modulePath) {
+        return getModule(modulePath, this);
+    }
+    getPackage() {
+        const rootFileNames = this.program.getRootFileNames();
+        // Find the package.json for this package based on the first root filename
+        // in the program (we assume all root files in a program belong to the same
+        // package)
+        if (rootFileNames.length === 0) {
+            throw new Error('No source files found in package.');
+        }
+        const packageInfo = getPackageInfo(rootFileNames[0], this);
+        return new Package({
+            ...packageInfo,
+            modules: rootFileNames.map((fileName) => getModule(this.path.normalize(fileName), this, packageInfo)),
+        });
+    }
+    addDiagnostic(diagnostic) {
+        this.diagnostics.push(diagnostic);
+    }
+    *getDiagnostics() {
+        yield* this.typescript.sortAndDeduplicateDiagnostics(this.diagnostics);
+    }
+}
+/**
+ * Extracts a `ts.ParsedCommandLine` (essentially, the key bits of a
+ * `tsconfig.json`) from the analyzer's `ts.Program`.
+ *
+ * The `ts.getOutputFileNames()` function must be passed a
+ * `ts.ParsedCommandLine`; since not all usages of the analyzer create the
+ * program directly from a tsconfig (plugins get passed the program only),
+ * this allows backing the `ParsedCommandLine` out of an existing program.
+ */
+export const getCommandLineFromProgram = (analyzer) => {
+    const { program, typescript, path, fs } = analyzer;
+    const compilerOptions = program.getCompilerOptions();
+    const files = program.getRootFileNames();
+    const json = {
+        files,
+        compilerOptions,
+    };
+    if (compilerOptions.configFilePath !== undefined) {
+        // For a TS project, derive the package root from the config file path
+        const packageRoot = path.basename(compilerOptions.configFilePath);
+        return typescript.parseJsonConfigFileContent(json, fs, packageRoot, undefined, compilerOptions.configFilePath);
+    }
+    else {
+        // Otherwise, this is a JS project; we can determine the package root
+        // based on the package.json location; we can look that up based on
+        // the first root file
+        const packageRoot = getPackageRootForModulePath(files[0], analyzer
+        // Note we don't pass a configFilePath since we don't have one; This just
+        // means we can't use ts.getOutputFileNames(), which we isn't needed in
+        // JS program
+        );
+        return typescript.parseJsonConfigFileContent(json, fs, packageRoot);
+    }
+};
+//# sourceMappingURL=analyzer.js.map

package/lib/analyzer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzer.js","sourceRoot":"","sources":["../src/lib/analyzer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAC,SAAS,EAAC,MAAM,yBAAyB,CAAC;AAClD,OAAO,EACL,cAAc,EACd,2BAA2B,GAC5B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAA4B,OAAO,EAAc,MAAM,YAAY,CAAC;AAc3E;;GAEG;AACH,MAAM,OAAO,QAAQ;IAWnB,YAAY,IAAkB;QAV9B,kEAAkE;QAClE,oCAAoC;QAC3B,gBAAW,GAAG,IAAI,GAAG,EAAwB,CAAC;QAK/C,iBAAY,GAAqC,SAAS,CAAC;QAClD,gBAAW,GAAoB,EAAE,CAAC;QAGjD,CAAC;YACC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,UAAU,EAAE,IAAI,CAAC,WAAW;SAC7B,GAAG,IAAI,CAAC,CAAC;IACZ,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,CAAC,IAAI,CAAC,YAAY,KAAK,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,SAAS,CAAC,UAAwB;QAChC,OAAO,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,UAAU;QACR,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;QAEtD,0EAA0E;QAC1E,2EAA2E;QAC3E,WAAW;QACX,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,WAAW,GAAG,cAAc,CAAC,aAAa,CAAC,CAAC,CAAiB,EAAE,IAAI,CAAC,CAAC;QAE3E,OAAO,IAAI,OAAO,CAAC;YACjB,GAAG,WAAW;YACd,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACtC,SAAS,CACP,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAiB,EAC7C,IAAI,EACJ,WAAW,CACZ,CACF;SACF,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,UAAyB;QACrC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAED,CAAC,cAAc;QACb,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACzE,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,QAAkB,EACI,EAAE;IACxB,MAAM,EAAC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAC,GAAG,QAAQ,CAAC;IACjD,MAAM,eAAe,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IACrD,MAAM,KAAK,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IACzC,MAAM,IAAI,GAAG;QACX,KAAK;QACL,eAAe;KAChB,CAAC;IACF,IAAI,eAAe,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QACjD,sEAAsE;QACtE,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,cAAwB,CAAC,CAAC;QAC5E,OAAO,UAAU,CAAC,0BAA0B,CAC1C,IAAI,EACJ,EAAE,EACF,WAAW,EACX,SAAS,EACT,eAAe,CAAC,cAAwB,CACzC,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,qEAAqE;QACrE,mEAAmE;QACnE,sBAAsB;QACtB,MAAM,WAAW,GAAG,2BAA2B,CAC7C,KAAK,CAAC,CAAC,CAAiB,EACxB,QAAQ;QACR,yEAAyE;QACzE,uEAAuE;QACvE,aAAa;SACd,CAAC;QACF,OAAO,UAAU,CAAC,0BAA0B,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,CAAC,CAAC;IACtE,CAAC;AACH,CAAC,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2022 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\nimport type ts from 'typescript';\nimport {getModule} from './javascript/modules.js';\nimport {\n  getPackageInfo,\n  getPackageRootForModulePath,\n} from './javascript/packages.js';\nimport {AnalyzerInterface, Module, Package, PackageJson} from './model.js';\nimport {AbsolutePath} from './paths.js';\nexport {PackageJson};\n\nexport type TypeScript = typeof ts;\n\nexport interface AnalyzerInit {\n  typescript: TypeScript;\n  getProgram: () => ts.Program;\n  fs: AnalyzerInterface['fs'];\n  path: AnalyzerInterface['path'];\n  basePath?: AbsolutePath;\n}\n\n/**\n * An analyzer for Lit typescript modules.\n */\nexport class Analyzer implements AnalyzerInterface {\n  // Cache of Module models by path; invalidated when the sourceFile\n  // or any of its dependencies change\n  readonly moduleCache = new Map<AbsolutePath, Module>();\n  private readonly _getProgram: () => ts.Program;\n  readonly typescript: TypeScript;\n  readonly fs: AnalyzerInterface['fs'];\n  readonly path: AnalyzerInterface['path'];\n  private _commandLine: ts.ParsedCommandLine | undefined = undefined;\n  private readonly diagnostics: ts.Diagnostic[] = [];\n\n  constructor(init: AnalyzerInit) {\n    ({\n      fs: this.fs,\n      path: this.path,\n      typescript: this.typescript,\n      getProgram: this._getProgram,\n    } = init);\n  }\n\n  get program() {\n    return this._getProgram();\n  }\n\n  get commandLine() {\n    return (this._commandLine ??= getCommandLineFromProgram(this));\n  }\n\n  getModule(modulePath: AbsolutePath) {\n    return getModule(modulePath, this);\n  }\n\n  getPackage() {\n    const rootFileNames = this.program.getRootFileNames();\n\n    // Find the package.json for this package based on the first root filename\n    // in the program (we assume all root files in a program belong to the same\n    // package)\n    if (rootFileNames.length === 0) {\n      throw new Error('No source files found in package.');\n    }\n    const packageInfo = getPackageInfo(rootFileNames[0] as AbsolutePath, this);\n\n    return new Package({\n      ...packageInfo,\n      modules: rootFileNames.map((fileName) =>\n        getModule(\n          this.path.normalize(fileName) as AbsolutePath,\n          this,\n          packageInfo\n        )\n      ),\n    });\n  }\n\n  addDiagnostic(diagnostic: ts.Diagnostic) {\n    this.diagnostics.push(diagnostic);\n  }\n\n  *getDiagnostics() {\n    yield* this.typescript.sortAndDeduplicateDiagnostics(this.diagnostics);\n  }\n}\n\n/**\n * Extracts a `ts.ParsedCommandLine` (essentially, the key bits of a\n * `tsconfig.json`) from the analyzer's `ts.Program`.\n *\n * The `ts.getOutputFileNames()` function must be passed a\n * `ts.ParsedCommandLine`; since not all usages of the analyzer create the\n * program directly from a tsconfig (plugins get passed the program only),\n * this allows backing the `ParsedCommandLine` out of an existing program.\n */\nexport const getCommandLineFromProgram = (\n  analyzer: Analyzer\n): ts.ParsedCommandLine => {\n  const {program, typescript, path, fs} = analyzer;\n  const compilerOptions = program.getCompilerOptions();\n  const files = program.getRootFileNames();\n  const json = {\n    files,\n    compilerOptions,\n  };\n  if (compilerOptions.configFilePath !== undefined) {\n    // For a TS project, derive the package root from the config file path\n    const packageRoot = path.basename(compilerOptions.configFilePath as string);\n    return typescript.parseJsonConfigFileContent(\n      json,\n      fs,\n      packageRoot,\n      undefined,\n      compilerOptions.configFilePath as string\n    );\n  } else {\n    // Otherwise, this is a JS project; we can determine the package root\n    // based on the package.json location; we can look that up based on\n    // the first root file\n    const packageRoot = getPackageRootForModulePath(\n      files[0] as AbsolutePath,\n      analyzer\n      // Note we don't pass a configFilePath since we don't have one; This just\n      // means we can't use ts.getOutputFileNames(), which we isn't needed in\n      // JS program\n    );\n    return typescript.parseJsonConfigFileContent(json, fs, packageRoot);\n  }\n};\n"]}

package/lib/custom-elements/custom-elements.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/**
+ * @fileoverview
+ *
+ * Utilities for analyzing native custom elements (i.e. `HTMLElement`)
+ * subclasses.
+ */
+import type ts from 'typescript';
+import { AnalyzerInterface, CustomElementDeclaration, Event, NamedDescribed } from '../model.js';
+export type CustomElementClassDeclaration = ts.ClassDeclaration & {
+    _customElementBrand: never;
+};
+export declare const isCustomElementSubclass: (node: ts.Node, analyzer: AnalyzerInterface) => node is CustomElementClassDeclaration;
+export declare const getTagName: (node: ts.ClassDeclaration | ts.ClassExpression, analyzer: AnalyzerInterface) => string | undefined;
+/**
+ * Parses element metadata from jsDoc tags from a LitElement declaration into
+ * Maps of <name, info>.
+ */
+export declare const getJSDocData: (node: ts.ClassDeclaration, analyzer: AnalyzerInterface) => {
+    events: Map<string, Event>;
+    slots: Map<string, NamedDescribed>;
+    cssProperties: Map<string, NamedDescribed>;
+    cssParts: Map<string, NamedDescribed>;
+    deprecated?: string | boolean | undefined;
+    description?: string | undefined;
+    summary?: string | undefined;
+};
+export declare const getCustomElementDeclaration: (node: CustomElementClassDeclaration, analyzer: AnalyzerInterface, isMixinClass?: boolean) => CustomElementDeclaration;
+//# sourceMappingURL=custom-elements.d.ts.map

package/lib/custom-elements/custom-elements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-elements.d.ts","sourceRoot":"","sources":["../../src/lib/custom-elements/custom-elements.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EACL,iBAAiB,EACjB,wBAAwB,EACxB,KAAK,EACL,cAAc,EACf,MAAM,aAAa,CAAC;AAuBrB,MAAM,MAAM,6BAA6B,GAAG,EAAE,CAAC,gBAAgB,GAAG;IAChE,mBAAmB,EAAE,KAAK,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAClC,MAAM,EAAE,CAAC,IAAI,EACb,UAAU,iBAAiB,KAC1B,IAAI,IAAI,6BAiBV,CAAC;AAEF,eAAO,MAAM,UAAU,GACrB,MAAM,EAAE,CAAC,gBAAgB,GAAG,EAAE,CAAC,eAAe,EAC9C,UAAU,iBAAiB,KAC1B,MAAM,GAAG,SAuCX,CAAC;AAiBF;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,MAAM,EAAE,CAAC,gBAAgB,EACzB,UAAU,iBAAiB;;;;;;;;CAoC5B,CAAC;AAEF,eAAO,MAAM,2BAA2B,GACtC,MAAM,6BAA6B,EACnC,UAAU,iBAAiB,EAC3B,eAAe,OAAO,KACrB,wBASF,CAAC"}

package/lib/custom-elements/custom-elements.js

@@ -0,0 +1,124 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { getClassMembers, getHeritage } from '../javascript/classes.js';
+import { CustomElementDeclaration, } from '../model.js';
+import { addEventsToMap } from './events.js';
+import { parseNodeJSDocInfo, parseNamedTypedJSDocInfo, } from '../javascript/jsdoc.js';
+import { getBaseTypes } from '../utils.js';
+const _isCustomElementClassDeclaration = (t, analyzer) => {
+    const declarations = t.getSymbol()?.getDeclarations();
+    return (declarations?.some((declaration) => (analyzer.typescript.isInterfaceDeclaration(declaration) &&
+        declaration.name?.text === 'HTMLElement') ||
+        isCustomElementSubclass(declaration, analyzer)) === true);
+};
+export const isCustomElementSubclass = (node, analyzer) => {
+    if (!analyzer.typescript.isClassLike(node)) {
+        return false;
+    }
+    if (getTagName(node, analyzer) !== undefined) {
+        return true;
+    }
+    const checker = analyzer.program.getTypeChecker();
+    const type = checker.getTypeAtLocation(node);
+    const baseTypes = getBaseTypes(type);
+    for (const t of baseTypes) {
+        if (_isCustomElementClassDeclaration(t, analyzer)) {
+            return true;
+        }
+    }
+    return false;
+};
+export const getTagName = (node, analyzer) => {
+    const jsdocTag = analyzer.typescript
+        .getJSDocTags(node)
+        .find((tag) => tag.tagName.text.toLowerCase() === 'customelement');
+    if (jsdocTag && typeof jsdocTag.comment === 'string') {
+        return jsdocTag.comment.trim();
+    }
+    let tagName = undefined;
+    // Otherwise, look for imperative define in the form of:
+    // `customElements.define('x-foo', XFoo);`
+    node.parent.forEachChild((child) => {
+        if (analyzer.typescript.isExpressionStatement(child) &&
+            analyzer.typescript.isCallExpression(child.expression) &&
+            analyzer.typescript.isPropertyAccessExpression(child.expression.expression) &&
+            child.expression.arguments.length >= 2) {
+            const [tagNameArg, ctorArg] = child.expression.arguments;
+            const { expression, name } = child.expression.expression;
+            if (analyzer.typescript.isIdentifier(expression) &&
+                expression.text === 'customElements' &&
+                analyzer.typescript.isIdentifier(name) &&
+                name.text === 'define' &&
+                analyzer.typescript.isStringLiteralLike(tagNameArg) &&
+                analyzer.typescript.isIdentifier(ctorArg) &&
+                ctorArg.text === node.name?.text) {
+                tagName = tagNameArg.text;
+            }
+        }
+    });
+    return tagName;
+};
+/**
+ * Adds name, description, and summary info for a given jsdoc tag into the
+ * provided map.
+ */
+const addNamedJSDocInfoToMap = (map, tag, analyzer) => {
+    const info = parseNamedTypedJSDocInfo(tag, analyzer);
+    if (info !== undefined) {
+        map.set(info.name, info);
+    }
+};
+/**
+ * Parses element metadata from jsDoc tags from a LitElement declaration into
+ * Maps of <name, info>.
+ */
+export const getJSDocData = (node, analyzer) => {
+    const events = new Map();
+    const slots = new Map();
+    const cssProperties = new Map();
+    const cssParts = new Map();
+    const jsDocTags = analyzer.typescript.getJSDocTags(node);
+    if (jsDocTags !== undefined) {
+        for (const tag of jsDocTags) {
+            switch (tag.tagName.text) {
+                case 'fires':
+                    addEventsToMap(tag, events, analyzer);
+                    break;
+                case 'slot':
+                    addNamedJSDocInfoToMap(slots, tag, analyzer);
+                    break;
+                case 'cssProp':
+                case 'cssprop':
+                case 'cssProperty':
+                case 'cssproperty':
+                    addNamedJSDocInfoToMap(cssProperties, tag, analyzer);
+                    break;
+                case 'cssPart':
+                case 'csspart':
+                    addNamedJSDocInfoToMap(cssParts, tag, analyzer);
+                    break;
+            }
+        }
+    }
+    return {
+        ...parseNodeJSDocInfo(node, analyzer),
+        events,
+        slots,
+        cssProperties,
+        cssParts,
+    };
+};
+export const getCustomElementDeclaration = (node, analyzer, isMixinClass) => {
+    return new CustomElementDeclaration({
+        tagname: getTagName(node, analyzer),
+        name: node.name?.text ?? '',
+        node,
+        ...getJSDocData(node, analyzer),
+        getHeritage: () => getHeritage(node, analyzer, isMixinClass),
+        ...getClassMembers(node, analyzer),
+    });
+};
+//# sourceMappingURL=custom-elements.js.map

package/lib/custom-elements/custom-elements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-elements.js","sourceRoot":"","sources":["../../src/lib/custom-elements/custom-elements.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAUH,OAAO,EAAC,eAAe,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAEL,wBAAwB,GAGzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,cAAc,EAAC,MAAM,aAAa,CAAC;AAC3C,OAAO,EACL,kBAAkB,EAClB,wBAAwB,GACzB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAEzC,MAAM,gCAAgC,GAAG,CACvC,CAAc,EACd,QAA2B,EAClB,EAAE;IACX,MAAM,YAAY,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,eAAe,EAAE,CAAC;IACtD,OAAO,CACL,YAAY,EAAE,IAAI,CAChB,CAAC,WAAW,EAAE,EAAE,CACd,CAAC,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC,WAAW,CAAC;QACtD,WAAW,CAAC,IAAI,EAAE,IAAI,KAAK,aAAa,CAAC;QAC3C,uBAAuB,CAAC,WAAW,EAAE,QAAQ,CAAC,CACjD,KAAK,IAAI,CACX,CAAC;AACJ,CAAC,CAAC;AAMF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,IAAa,EACb,QAA2B,EACY,EAAE;IACzC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,SAAS,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;IAClD,MAAM,IAAI,GAAG,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAErC,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1B,IAAI,gCAAgC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAA8C,EAC9C,QAA2B,EACP,EAAE;IACtB,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU;SACjC,YAAY,CAAC,IAAI,CAAC;SAClB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,CAAC;IAErE,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAED,IAAI,OAAO,GAAuB,SAAS,CAAC;IAE5C,wDAAwD;IACxD,0CAA0C;IAC1C,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QACjC,IACE,QAAQ,CAAC,UAAU,CAAC,qBAAqB,CAAC,KAAK,CAAC;YAChD,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,UAAU,CAAC;YACtD,QAAQ,CAAC,UAAU,CAAC,0BAA0B,CAC5C,KAAK,CAAC,UAAU,CAAC,UAAU,CAC5B;YACD,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,EACtC,CAAC;YACD,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC;YACzD,MAAM,EAAC,UAAU,EAAE,IAAI,EAAC,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC;YACvD,IACE,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC;gBAC5C,UAAU,CAAC,IAAI,KAAK,gBAAgB;gBACpC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC;gBACtC,IAAI,CAAC,IAAI,KAAK,QAAQ;gBACtB,QAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC,UAAU,CAAC;gBACnD,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC;gBACzC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,IAAI,EAChC,CAAC;gBACD,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,sBAAsB,GAAG,CAC7B,GAAgC,EAChC,GAAgB,EAChB,QAA2B,EAC3B,EAAE;IACF,MAAM,IAAI,GAAG,wBAAwB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,IAAyB,EACzB,QAA2B,EAC3B,EAAE;IACF,MAAM,MAAM,GAAG,IAAI,GAAG,EAAiB,CAAC;IACxC,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;IAChD,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0B,CAAC;IACxD,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA0B,CAAC;IACnD,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACzD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,QAAQ,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBACzB,KAAK,OAAO;oBACV,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;oBACtC,MAAM;gBACR,KAAK,MAAM;oBACT,sBAAsB,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;oBAC7C,MAAM;gBACR,KAAK,SAAS,CAAC;gBACf,KAAK,SAAS,CAAC;gBACf,KAAK,aAAa,CAAC;gBACnB,KAAK,aAAa;oBAChB,sBAAsB,CAAC,aAAa,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;oBACrD,MAAM;gBACR,KAAK,SAAS,CAAC;gBACf,KAAK,SAAS;oBACZ,sBAAsB,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;oBAChD,MAAM;YACV,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO;QACL,GAAG,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC;QACrC,MAAM;QACN,KAAK;QACL,aAAa;QACb,QAAQ;KACT,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,IAAmC,EACnC,QAA2B,EAC3B,YAAsB,EACI,EAAE;IAC5B,OAAO,IAAI,wBAAwB,CAAC;QAClC,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC;QACnC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE;QAC3B,IAAI;QACJ,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;QAC/B,WAAW,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC;QAC5D,GAAG,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC;KACnC,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2022 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\n/**\n * @fileoverview\n *\n * Utilities for analyzing native custom elements (i.e. `HTMLElement`)\n * subclasses.\n */\n\nimport type ts from 'typescript';\nimport {getClassMembers, getHeritage} from '../javascript/classes.js';\nimport {\n  AnalyzerInterface,\n  CustomElementDeclaration,\n  Event,\n  NamedDescribed,\n} from '../model.js';\nimport {addEventsToMap} from './events.js';\nimport {\n  parseNodeJSDocInfo,\n  parseNamedTypedJSDocInfo,\n} from '../javascript/jsdoc.js';\nimport {getBaseTypes} from '../utils.js';\n\nconst _isCustomElementClassDeclaration = (\n  t: ts.BaseType,\n  analyzer: AnalyzerInterface\n): boolean => {\n  const declarations = t.getSymbol()?.getDeclarations();\n  return (\n    declarations?.some(\n      (declaration) =>\n        (analyzer.typescript.isInterfaceDeclaration(declaration) &&\n          declaration.name?.text === 'HTMLElement') ||\n        isCustomElementSubclass(declaration, analyzer)\n    ) === true\n  );\n};\n\nexport type CustomElementClassDeclaration = ts.ClassDeclaration & {\n  _customElementBrand: never;\n};\n\nexport const isCustomElementSubclass = (\n  node: ts.Node,\n  analyzer: AnalyzerInterface\n): node is CustomElementClassDeclaration => {\n  if (!analyzer.typescript.isClassLike(node)) {\n    return false;\n  }\n  if (getTagName(node, analyzer) !== undefined) {\n    return true;\n  }\n  const checker = analyzer.program.getTypeChecker();\n  const type = checker.getTypeAtLocation(node);\n  const baseTypes = getBaseTypes(type);\n\n  for (const t of baseTypes) {\n    if (_isCustomElementClassDeclaration(t, analyzer)) {\n      return true;\n    }\n  }\n  return false;\n};\n\nexport const getTagName = (\n  node: ts.ClassDeclaration | ts.ClassExpression,\n  analyzer: AnalyzerInterface\n): string | undefined => {\n  const jsdocTag = analyzer.typescript\n    .getJSDocTags(node)\n    .find((tag) => tag.tagName.text.toLowerCase() === 'customelement');\n\n  if (jsdocTag && typeof jsdocTag.comment === 'string') {\n    return jsdocTag.comment.trim();\n  }\n\n  let tagName: string | undefined = undefined;\n\n  // Otherwise, look for imperative define in the form of:\n  // `customElements.define('x-foo', XFoo);`\n  node.parent.forEachChild((child) => {\n    if (\n      analyzer.typescript.isExpressionStatement(child) &&\n      analyzer.typescript.isCallExpression(child.expression) &&\n      analyzer.typescript.isPropertyAccessExpression(\n        child.expression.expression\n      ) &&\n      child.expression.arguments.length >= 2\n    ) {\n      const [tagNameArg, ctorArg] = child.expression.arguments;\n      const {expression, name} = child.expression.expression;\n      if (\n        analyzer.typescript.isIdentifier(expression) &&\n        expression.text === 'customElements' &&\n        analyzer.typescript.isIdentifier(name) &&\n        name.text === 'define' &&\n        analyzer.typescript.isStringLiteralLike(tagNameArg) &&\n        analyzer.typescript.isIdentifier(ctorArg) &&\n        ctorArg.text === node.name?.text\n      ) {\n        tagName = tagNameArg.text;\n      }\n    }\n  });\n\n  return tagName;\n};\n\n/**\n * Adds name, description, and summary info for a given jsdoc tag into the\n * provided map.\n */\nconst addNamedJSDocInfoToMap = (\n  map: Map<string, NamedDescribed>,\n  tag: ts.JSDocTag,\n  analyzer: AnalyzerInterface\n) => {\n  const info = parseNamedTypedJSDocInfo(tag, analyzer);\n  if (info !== undefined) {\n    map.set(info.name, info);\n  }\n};\n\n/**\n * Parses element metadata from jsDoc tags from a LitElement declaration into\n * Maps of <name, info>.\n */\nexport const getJSDocData = (\n  node: ts.ClassDeclaration,\n  analyzer: AnalyzerInterface\n) => {\n  const events = new Map<string, Event>();\n  const slots = new Map<string, NamedDescribed>();\n  const cssProperties = new Map<string, NamedDescribed>();\n  const cssParts = new Map<string, NamedDescribed>();\n  const jsDocTags = analyzer.typescript.getJSDocTags(node);\n  if (jsDocTags !== undefined) {\n    for (const tag of jsDocTags) {\n      switch (tag.tagName.text) {\n        case 'fires':\n          addEventsToMap(tag, events, analyzer);\n          break;\n        case 'slot':\n          addNamedJSDocInfoToMap(slots, tag, analyzer);\n          break;\n        case 'cssProp':\n        case 'cssprop':\n        case 'cssProperty':\n        case 'cssproperty':\n          addNamedJSDocInfoToMap(cssProperties, tag, analyzer);\n          break;\n        case 'cssPart':\n        case 'csspart':\n          addNamedJSDocInfoToMap(cssParts, tag, analyzer);\n          break;\n      }\n    }\n  }\n  return {\n    ...parseNodeJSDocInfo(node, analyzer),\n    events,\n    slots,\n    cssProperties,\n    cssParts,\n  };\n};\n\nexport const getCustomElementDeclaration = (\n  node: CustomElementClassDeclaration,\n  analyzer: AnalyzerInterface,\n  isMixinClass?: boolean\n): CustomElementDeclaration => {\n  return new CustomElementDeclaration({\n    tagname: getTagName(node, analyzer),\n    name: node.name?.text ?? '',\n    node,\n    ...getJSDocData(node, analyzer),\n    getHeritage: () => getHeritage(node, analyzer, isMixinClass),\n    ...getClassMembers(node, analyzer),\n  });\n};\n"]}

package/lib/custom-elements/events.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/**
+ * @fileoverview
+ *
+ * Utilities for analyzing with events
+ */
+import ts from 'typescript';
+import { Event } from '../model.js';
+import { AnalyzerInterface } from '../model.js';
+/**
+ * Returns an array of analyzer `Event` models for the given
+ * ts.ClassDeclaration.
+ */
+export declare const addEventsToMap: (tag: ts.JSDocTag, events: Map<string, Event>, analyzer: AnalyzerInterface) => void;
+//# sourceMappingURL=events.d.ts.map

package/lib/custom-elements/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/lib/custom-elements/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAC;AAClC,OAAO,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAG9C;;;GAGG;AACH,eAAO,MAAM,cAAc,GACzB,KAAK,EAAE,CAAC,QAAQ,EAChB,QAAQ,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,EAC1B,UAAU,iBAAiB,SAa5B,CAAC"}

package/lib/custom-elements/events.js

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { parseNamedTypedJSDocInfo } from '../javascript/jsdoc.js';
+import { getTypeForTypeString } from '../types.js';
+/**
+ * Returns an array of analyzer `Event` models for the given
+ * ts.ClassDeclaration.
+ */
+export const addEventsToMap = (tag, events, analyzer) => {
+    const info = parseNamedTypedJSDocInfo(tag, analyzer);
+    if (info === undefined) {
+        return;
+    }
+    const { name, type, description, summary } = info;
+    events.set(name, {
+        name,
+        type: type ? getTypeForTypeString(type, tag, analyzer) : undefined,
+        description,
+        summary,
+    });
+};
+//# sourceMappingURL=events.js.map

package/lib/custom-elements/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/lib/custom-elements/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,OAAO,EAAC,wBAAwB,EAAC,MAAM,wBAAwB,CAAC;AAGhE,OAAO,EAAC,oBAAoB,EAAC,MAAM,aAAa,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,GAAgB,EAChB,MAA0B,EAC1B,QAA2B,EAC3B,EAAE;IACF,MAAM,IAAI,GAAG,wBAAwB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IACD,MAAM,EAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC;IAChD,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE;QACf,IAAI;QACJ,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;QAClE,WAAW;QACX,OAAO;KACR,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2022 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\n/**\n * @fileoverview\n *\n * Utilities for analyzing with events\n */\n\nimport ts from 'typescript';\nimport {parseNamedTypedJSDocInfo} from '../javascript/jsdoc.js';\nimport {Event} from '../model.js';\nimport {AnalyzerInterface} from '../model.js';\nimport {getTypeForTypeString} from '../types.js';\n\n/**\n * Returns an array of analyzer `Event` models for the given\n * ts.ClassDeclaration.\n */\nexport const addEventsToMap = (\n  tag: ts.JSDocTag,\n  events: Map<string, Event>,\n  analyzer: AnalyzerInterface\n) => {\n  const info = parseNamedTypedJSDocInfo(tag, analyzer);\n  if (info === undefined) {\n    return;\n  }\n  const {name, type, description, summary} = info;\n  events.set(name, {\n    name,\n    type: type ? getTypeForTypeString(type, tag, analyzer) : undefined,\n    description,\n    summary,\n  });\n};\n"]}

package/lib/diagnostic-code.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export declare const DiagnosticCode: {
+    /**
+     * This is the default error code and doesn't indicate any specific error.
+     *
+     * We start numbering from 548000 to avoid collisions with other projects.
+     */
+    readonly UNKNOWN: 548000;
+    /**
+     * This code represents a situation where ordinary and otherwise-valid code
+     * is not yet supported in the Lit analyzer. We should aim to remove uses of
+     * this code.
+     */
+    readonly UNSUPPORTED: 548001;
+};
+export type DiagnosticCode = (typeof DiagnosticCode)[keyof typeof DiagnosticCode];
+//# sourceMappingURL=diagnostic-code.d.ts.map

package/lib/diagnostic-code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostic-code.d.ts","sourceRoot":"","sources":["../src/lib/diagnostic-code.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,eAAO,MAAM,cAAc;IACzB;;;;OAIG;;IAGH;;;;OAIG;;CAEK,CAAC;AAMX,MAAM,MAAM,cAAc,GACxB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC"}

package/lib/diagnostic-code.js

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export const DiagnosticCode = {
+    /**
+     * This is the default error code and doesn't indicate any specific error.
+     *
+     * We start numbering from 548000 to avoid collisions with other projects.
+     */
+    UNKNOWN: 548000, // The letters L-I-T are on digits 5-4-8 on a phone keypad.
+    /**
+     * This code represents a situation where ordinary and otherwise-valid code
+     * is not yet supported in the Lit analyzer. We should aim to remove uses of
+     * this code.
+     */
+    UNSUPPORTED: 548001,
+};
+//# sourceMappingURL=diagnostic-code.js.map

package/lib/diagnostic-code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostic-code.js","sourceRoot":"","sources":["../src/lib/diagnostic-code.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,EAAE,2DAA2D;IAE5E;;;;OAIG;IACH,WAAW,EAAE,MAAM;CACX,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2023 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\nexport const DiagnosticCode = {\n  /**\n   * This is the default error code and doesn't indicate any specific error.\n   *\n   * We start numbering from 548000 to avoid collisions with other projects.\n   */\n  UNKNOWN: 548000, // The letters L-I-T are on digits 5-4-8 on a phone keypad.\n\n  /**\n   * This code represents a situation where ordinary and otherwise-valid code\n   * is not yet supported in the Lit analyzer. We should aim to remove uses of\n   * this code.\n   */\n  UNSUPPORTED: 548001,\n} as const;\n\n// This lets the `DiagnosticCode` type act as an enum by extracting a union of\n// the value types of the `DiagnosticCode` object's properties.\n//\n// https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums\nexport type DiagnosticCode =\n  (typeof DiagnosticCode)[keyof typeof DiagnosticCode];\n"]}

package/lib/errors.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import type ts from 'typescript';
+import { DiagnosticCode } from './diagnostic-code.js';
+export type TypeScript = typeof ts;
+export interface DiagnosticOptions {
+    typescript: TypeScript;
+    node: ts.Node;
+    message: string;
+    category?: ts.DiagnosticCategory;
+    code?: DiagnosticCode | undefined;
+}
+export declare const createDiagnostic: ({ typescript, node, message, category, code, }: DiagnosticOptions) => {
+    file: ts.SourceFile;
+    start: number;
+    length: number;
+    category: ts.DiagnosticCategory;
+    code: DiagnosticCode;
+    messageText: string;
+};
+//# sourceMappingURL=errors.d.ts.map

package/lib/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/lib/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAEpD,MAAM,MAAM,UAAU,GAAG,OAAO,EAAE,CAAC;AAEnC,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC;IACjC,IAAI,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;CACnC;AAED,eAAO,MAAM,gBAAgB,GAAI,gDAM9B,iBAAiB;;;;;;;CASnB,CAAC"}

package/lib/errors.js

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { DiagnosticCode } from './diagnostic-code.js';
+export const createDiagnostic = ({ typescript, node, message, category, code, }) => {
+    return {
+        file: node.getSourceFile(),
+        start: node.getStart(),
+        length: node.getWidth(),
+        category: category ?? typescript.DiagnosticCategory.Error,
+        code: code ?? DiagnosticCode.UNKNOWN,
+        messageText: message ?? '',
+    };
+};
+//# sourceMappingURL=errors.js.map

package/lib/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/lib/errors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAYpD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,EAC/B,UAAU,EACV,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,IAAI,GACc,EAAE,EAAE;IACtB,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE;QAC1B,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE;QACtB,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE;QACvB,QAAQ,EAAE,QAAQ,IAAI,UAAU,CAAC,kBAAkB,CAAC,KAAK;QACzD,IAAI,EAAE,IAAI,IAAI,cAAc,CAAC,OAAO;QACpC,WAAW,EAAE,OAAO,IAAI,EAAE;KAC3B,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2022 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\nimport type ts from 'typescript';\nimport {DiagnosticCode} from './diagnostic-code.js';\n\nexport type TypeScript = typeof ts;\n\nexport interface DiagnosticOptions {\n  typescript: TypeScript;\n  node: ts.Node;\n  message: string;\n  category?: ts.DiagnosticCategory;\n  code?: DiagnosticCode | undefined;\n}\n\nexport const createDiagnostic = ({\n  typescript,\n  node,\n  message,\n  category,\n  code,\n}: DiagnosticOptions) => {\n  return {\n    file: node.getSourceFile(),\n    start: node.getStart(),\n    length: node.getWidth(),\n    category: category ?? typescript.DiagnosticCategory.Error,\n    code: code ?? DiagnosticCode.UNKNOWN,\n    messageText: message ?? '',\n  };\n};\n"]}