@oicl-lit/analyzer 0.14.1

package/lib/types.js

@@ -0,0 +1,257 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { getPackageInfo } from './javascript/packages.js';
+import { Type } from './model.js';
+import { absoluteToPackage, resolveExtension, } from './paths.js';
+import { getImportReference, getReferenceForSymbol, getSymbolForName, } from './references.js';
+import { createDiagnostic } from './errors.js';
+/**
+ * Returns an analyzer `Type` object for the given type string,
+ * evaluated at the given location.
+ *
+ * Used for parsing types from JSDoc.
+ */
+export const getTypeForTypeString = (typeString, location, analyzer) => {
+    const { typescript, program } = analyzer;
+    if (typeString !== undefined) {
+        const typeNode = parseType(typescript, typeString);
+        if (typeNode == undefined) {
+            analyzer.addDiagnostic(createDiagnostic({
+                typescript,
+                node: location,
+                message: `Failed to parse type from JSDoc comment.`,
+                category: typescript.DiagnosticCategory.Warning,
+            }));
+            return undefined;
+        }
+        const type = program.getTypeChecker().getTypeFromTypeNode(typeNode);
+        return new Type({
+            type,
+            text: typeString,
+            getReferences: () => getReferencesForTypeNode(typeNode, location, analyzer),
+        });
+    }
+    else {
+        return undefined;
+    }
+};
+/**
+ * Returns an analyzer `Type` object for the given AST node.
+ */
+export const getTypeForNode = (node, analyzer) => {
+    return getTypeForType(analyzer.program.getTypeChecker().getTypeAtLocation(node), node, analyzer);
+};
+/**
+ * Converts a ts.Type into an analyzer Type object (which wraps
+ * the ts.Type, but also provides analyzer Reference objects).
+ */
+export const getTypeForType = (type, location, analyzer) => {
+    const { typescript } = analyzer;
+    const checker = analyzer.program.getTypeChecker();
+    // Ensure we treat inferred `foo = 'hi'` as 'string' not '"hi"',
+    // but retain explicitly defined unions
+    if (!type.isUnion()) {
+        type = checker.getBaseTypeOfLiteralType(type);
+    }
+    const text = checker.typeToString(type);
+    const typeNode = checker.typeToTypeNode(type, location, typescript.NodeBuilderFlags.IgnoreErrors);
+    let getReferences;
+    if (typeNode === undefined) {
+        analyzer.addDiagnostic(createDiagnostic({
+            typescript,
+            node: location,
+            message: `Could not convert type to type node`,
+            category: typescript.DiagnosticCategory.Warning,
+        }));
+        getReferences = () => [];
+    }
+    else {
+        getReferences = () => getReferencesForTypeNode(typeNode, location, analyzer);
+    }
+    return new Type({
+        type,
+        text,
+        getReferences,
+    });
+};
+/**
+ * For a given TypeNode syntax tree, walk the AST and extract Reference
+ * model objects for any TypeReferenceNode or ImportTypeNode's.
+ */
+const getReferencesForTypeNode = (typeNode, location, analyzer) => {
+    const { typescript } = analyzer;
+    const references = [];
+    const visit = (node) => {
+        if (typescript.isTypeReferenceNode(node)) {
+            const name = getRootName(typescript, node.typeName);
+            // TODO(kschaaf): we'd like to just do
+            // `checker.getSymbolAtLocation(node)` to get the symbol, but it appears
+            // that nodes created with `checker.typeToTypeNode()` do not have
+            // associated symbols, so we need to look up by name via
+            // `checker.getSymbolsInScope()`
+            const symbol = getSymbolForName(name, location, analyzer);
+            if (symbol === undefined) {
+                analyzer.addDiagnostic(createDiagnostic({
+                    typescript,
+                    node: location,
+                    message: `Could not get symbol for '${name}'.`,
+                }));
+                return;
+            }
+            const ref = getReferenceForSymbol(symbol, location, analyzer);
+            if (ref !== undefined) {
+                references.push(ref);
+            }
+        }
+        else if (typescript.isImportTypeNode(node)) {
+            if (!typescript.isLiteralTypeNode(node.argument)) {
+                analyzer.addDiagnostic(createDiagnostic({
+                    typescript,
+                    node: node.argument,
+                    message: 'Expected a string literal.',
+                }));
+                return;
+            }
+            const name = getRootName(typescript, node.qualifier);
+            if (!typescript.isStringLiteral(node.argument.literal)) {
+                analyzer.addDiagnostic(createDiagnostic({
+                    typescript,
+                    node: node.argument.literal,
+                    message: `Expected import specifier to be a string literal`,
+                }));
+                return;
+            }
+            const specifier = getSpecifierFromTypeImport(node.argument.literal.text, analyzer);
+            // TODO(kschaaf): This may have been an inferred type from a transitive
+            // dependency; in this case we should include version information in the
+            // reference model
+            references.push(getImportReference(specifier, node.argument.literal, name, analyzer));
+        }
+        typescript.forEachChild(node, visit);
+    };
+    visit(typeNode);
+    return references;
+};
+/**
+ * If the given specifier is an absolute path, turns it into an npm import
+ * specifier by looking for its package.json and using package information found
+ * there.
+ *
+ * If the path was not absolute, it returns the specifier as-is.
+ */
+const getSpecifierFromTypeImport = (specifier, analyzer) => {
+    specifier = analyzer.path.normalize(
+    // Types can resolve to source or declaration files, so include those
+    // extensions as well. We still include JS extensions to support JSDoc
+    // types.
+    // We don't include the CommonJS-only extensions .cts and .d.cts here
+    resolveExtension(specifier, analyzer, [
+        'js',
+        'mjs',
+        'ts',
+        'mts',
+        'tsx',
+        'jsx',
+        'd.ts',
+        'd.mts',
+    ]));
+    if (analyzer.path.isAbsolute(specifier)) {
+        const { rootDir, name, packageJson: { main, module }, } = getPackageInfo(specifier, analyzer);
+        let modulePath = absoluteToPackage(specifier, rootDir, analyzer.path.sep);
+        const packageMain = module ?? main;
+        if (packageMain !== undefined && modulePath === packageMain) {
+            modulePath = '';
+        }
+        specifier = name + (modulePath ? `/${modulePath}` : '');
+    }
+    return specifier;
+};
+/**
+ * Gets the left-most name of a (possibly qualified) identifier, i.e.
+ * 'Foo' returns 'Foo', but 'ts.SyntaxKind' returns 'ts'. This is the
+ * symbol that would need to be imported into a given scope.
+ */
+const getRootName = (typescript, name) => {
+    if (name === undefined) {
+        return '';
+    }
+    if (typescript.isQualifiedName(name)) {
+        return getRootName(typescript, name.left);
+    }
+    else {
+        return name.text;
+    }
+};
+/**
+ * Below is a minimal LanguageService that allows quickly parsing snippets of TS
+ * syntax into an AST. There's one file `contents.ts` in the program that we
+ * update with snippets to parse.
+ *
+ * This allows extracting a type string from a custom JSDoc comment (like
+ * `@event`), parsing it into syntax, and than walking it to extract references.
+ *
+ * Note, the program may have semantic errors (e.g. it may reference imports
+ * that aren't included in the snippet), but that's ok because we only care
+ * about parsing the syntax. When extracting references, we can use
+ * `getSymbolByName` to re-associate symbols by name from a disassociated syntax
+ * tree and the actual program.
+ *
+ * TODO(kschaaf): Providing diagnostic errors for semantically incorrect custom
+ * JSDoc types would be nice, but that's pretty difficult in analyzers
+ * where we don't control the TS program creation such that we can re-write
+ * source files, etc. (as is the case when using in plugins).
+ */
+let contents = '';
+let contentsId = 0;
+const services = new WeakMap();
+const getService = (typescript) => {
+    let service = services.get(typescript);
+    if (service === undefined) {
+        service = typescript.createLanguageService({
+            getScriptFileNames: () => ['contents.ts'],
+            getScriptVersion: () => contentsId.toString(),
+            getScriptSnapshot: () => typescript.ScriptSnapshot.fromString(contents),
+            getCurrentDirectory: () => '',
+            getCompilationSettings: () => ({ include: ['contents.ts'] }),
+            getDefaultLibFileName: (options) => typescript.getDefaultLibFilePath(options),
+            fileExists: () => true,
+            readFile: () => undefined,
+            readDirectory: () => [],
+            directoryExists: () => true,
+            getDirectories: () => [],
+        }, typescript.createDocumentRegistry());
+        services.set(typescript, service);
+    }
+    return service;
+};
+/**
+ * Uses the stub LSH above to parse a type string and return a syntax-only
+ * TypeNode (there will be no valid symbol information retrievable directly from
+ * these nodes).
+ */
+// TODO (justinfagnani): This would probably be a bit cleaner as an instance
+// method on Analyzer now.
+const parseType = (typescript, typeString) => {
+    // Update the file
+    contents = `export type typeToParse = ${typeString}`;
+    contentsId++;
+    // Get a new program & parsed source file
+    const sourceFile = getService(typescript)
+        .getProgram()
+        ?.getSourceFileByPath('contents.ts');
+    if (sourceFile === undefined) {
+        return undefined;
+    }
+    // Find the type alias node and return it
+    let typeNode = undefined;
+    typescript.forEachChild(sourceFile, (node) => {
+        if (typescript.isTypeAliasDeclaration(node)) {
+            typeNode = node.type;
+        }
+    });
+    return typeNode;
+};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/lib/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAC,cAAc,EAAC,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAC,IAAI,EAA+B,MAAM,YAAY,CAAC;AAC9D,OAAO,EAEL,iBAAiB,EAEjB,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAC;AAI7C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,UAAkB,EAClB,QAAiB,EACjB,QAA2B,EACT,EAAE;IACpB,MAAM,EAAC,UAAU,EAAE,OAAO,EAAC,GAAG,QAAQ,CAAC;IACvC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QACnD,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC1B,QAAQ,CAAC,aAAa,CACpB,gBAAgB,CAAC;gBACf,UAAU;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,0CAA0C;gBACnD,QAAQ,EAAE,UAAU,CAAC,kBAAkB,CAAC,OAAO;aAChD,CAAC,CACH,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACpE,OAAO,IAAI,IAAI,CAAC;YACd,IAAI;YACJ,IAAI,EAAE,UAAU;YAChB,aAAa,EAAE,GAAG,EAAE,CAClB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;SACzD,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAa,EACb,QAA2B,EACrB,EAAE;IACR,OAAO,cAAc,CACnB,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EACzD,IAAI,EACJ,QAAQ,CACT,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAa,EACb,QAAiB,EACjB,QAA2B,EACrB,EAAE;IACR,MAAM,EAAC,UAAU,EAAC,GAAG,QAAQ,CAAC;IAC9B,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;IAClD,gEAAgE;IAChE,uCAAuC;IACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACpB,IAAI,GAAG,OAAO,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CACrC,IAAI,EACJ,QAAQ,EACR,UAAU,CAAC,gBAAgB,CAAC,YAAY,CACzC,CAAC;IACF,IAAI,aAAa,CAAC;IAClB,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,QAAQ,CAAC,aAAa,CACpB,gBAAgB,CAAC;YACf,UAAU;YACV,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,qCAAqC;YAC9C,QAAQ,EAAE,UAAU,CAAC,kBAAkB,CAAC,OAAO;SAChD,CAAC,CACH,CAAC;QACF,aAAa,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,aAAa,GAAG,GAAG,EAAE,CACnB,wBAAwB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,IAAI,IAAI,CAAC;QACd,IAAI;QACJ,IAAI;QACJ,aAAa;KACd,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,wBAAwB,GAAG,CAC/B,QAAqB,EACrB,QAAiB,EACjB,QAA2B,EACd,EAAE;IACf,MAAM,EAAC,UAAU,EAAC,GAAG,QAAQ,CAAC;IAC9B,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,EAAE;QAC9B,IAAI,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpD,sCAAsC;YACtC,wEAAwE;YACxE,iEAAiE;YACjE,wDAAwD;YACxD,gCAAgC;YAChC,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC1D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzB,QAAQ,CAAC,aAAa,CACpB,gBAAgB,CAAC;oBACf,UAAU;oBACV,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,6BAA6B,IAAI,IAAI;iBAC/C,CAAC,CACH,CAAC;gBACF,OAAO;YACT,CAAC;YACD,MAAM,GAAG,GAAG,qBAAqB,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC9D,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;aAAM,IAAI,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjD,QAAQ,CAAC,aAAa,CACpB,gBAAgB,CAAC;oBACf,UAAU;oBACV,IAAI,EAAE,IAAI,CAAC,QAAQ;oBACnB,OAAO,EAAE,4BAA4B;iBACtC,CAAC,CACH,CAAC;gBACF,OAAO;YACT,CAAC;YACD,MAAM,IAAI,GAAG,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACvD,QAAQ,CAAC,aAAa,CACpB,gBAAgB,CAAC;oBACf,UAAU;oBACV,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;oBAC3B,OAAO,EAAE,kDAAkD;iBAC5D,CAAC,CACH,CAAC;gBACF,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,0BAA0B,CAC1C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAC1B,QAAQ,CACT,CAAC;YACF,uEAAuE;YACvE,wEAAwE;YACxE,kBAAkB;YAClB,UAAU,CAAC,IAAI,CACb,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CACrE,CAAC;QACJ,CAAC;QACD,UAAU,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC;IACF,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChB,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,0BAA0B,GAAG,CACjC,SAAiB,EACjB,QAA2B,EAC3B,EAAE;IACF,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS;IACjC,qEAAqE;IACrE,sEAAsE;IACtE,SAAS;IACT,qEAAqE;IACrE,gBAAgB,CAAC,SAAyB,EAAE,QAAQ,EAAE;QACpD,IAAI;QACJ,KAAK;QACL,IAAI;QACJ,KAAK;QACL,KAAK;QACL,KAAK;QACL,MAAM;QACN,OAAO;KACR,CAAC,CACH,CAAC;IACF,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,MAAM,EACJ,OAAO,EACP,IAAI,EACJ,WAAW,EAAE,EAAC,IAAI,EAAE,MAAM,EAAC,GAC5B,GAAG,cAAc,CAAC,SAAyB,EAAE,QAAQ,CAAC,CAAC;QACxD,IAAI,UAAU,GAAG,iBAAiB,CAChC,SAAyB,EACzB,OAAO,EACP,QAAQ,CAAC,IAAI,CAAC,GAAG,CAClB,CAAC;QACF,MAAM,WAAW,GAAG,MAAM,IAAI,IAAI,CAAC;QACnC,IAAI,WAAW,KAAK,SAAS,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;YAC5D,UAAU,GAAG,EAAiB,CAAC;QACjC,CAAC;QACD,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,GAAG,CAClB,UAAsB,EACtB,IAAkD,EAC1C,EAAE;IACV,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,OAAO,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AAEH,IAAI,QAAQ,GAAG,EAAE,CAAC;AAClB,IAAI,UAAU,GAAG,CAAC,CAAC;AAEnB,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAkC,CAAC;AAC/D,MAAM,UAAU,GAAG,CAAC,UAAsB,EAAE,EAAE;IAC5C,IAAI,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,GAAG,UAAU,CAAC,qBAAqB,CACxC;YACE,kBAAkB,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC;YACzC,gBAAgB,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC7C,iBAAiB,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC;YACvE,mBAAmB,EAAE,GAAG,EAAE,CAAC,EAAE;YAC7B,sBAAsB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAC,OAAO,EAAE,CAAC,aAAa,CAAC,EAAC,CAAC;YAC1D,qBAAqB,EAAE,CAAC,OAAO,EAAE,EAAE,CACjC,UAAU,CAAC,qBAAqB,CAAC,OAAO,CAAC;YAC3C,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI;YACtB,QAAQ,EAAE,GAAG,EAAE,CAAC,SAAS;YACzB,aAAa,EAAE,GAAG,EAAE,CAAC,EAAE;YACvB,eAAe,EAAE,GAAG,EAAE,CAAC,IAAI;YAC3B,cAAc,EAAE,GAAG,EAAE,CAAC,EAAE;SACzB,EACD,UAAU,CAAC,sBAAsB,EAAE,CACpC,CAAC;QACF,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF;;;;GAIG;AACH,4EAA4E;AAC5E,0BAA0B;AAC1B,MAAM,SAAS,GAAG,CAChB,UAAsB,EACtB,UAAkB,EACO,EAAE;IAC3B,kBAAkB;IAClB,QAAQ,GAAG,6BAA6B,UAAU,EAAE,CAAC;IACrD,UAAU,EAAE,CAAC;IACb,yCAAyC;IACzC,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC;SACtC,UAAU,EAAE;QACb,EAAE,mBAAmB,CAAC,aAAwB,CAAC,CAAC;IAClD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,yCAAyC;IACzC,IAAI,QAAQ,GAA4B,SAAS,CAAC;IAClD,UAAU,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;QAC3C,IAAI,UAAU,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5C,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,QAAQ,CAAC;AAClB,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 {getPackageInfo} from './javascript/packages.js';\nimport {Type, Reference, AnalyzerInterface} from './model.js';\nimport {\n  AbsolutePath,\n  absoluteToPackage,\n  PackagePath,\n  resolveExtension,\n} from './paths.js';\nimport {\n  getImportReference,\n  getReferenceForSymbol,\n  getSymbolForName,\n} from './references.js';\nimport {createDiagnostic} from './errors.js';\n\nexport type TypeScript = typeof ts;\n\n/**\n * Returns an analyzer `Type` object for the given type string,\n * evaluated at the given location.\n *\n * Used for parsing types from JSDoc.\n */\nexport const getTypeForTypeString = (\n  typeString: string,\n  location: ts.Node,\n  analyzer: AnalyzerInterface\n): Type | undefined => {\n  const {typescript, program} = analyzer;\n  if (typeString !== undefined) {\n    const typeNode = parseType(typescript, typeString);\n    if (typeNode == undefined) {\n      analyzer.addDiagnostic(\n        createDiagnostic({\n          typescript,\n          node: location,\n          message: `Failed to parse type from JSDoc comment.`,\n          category: typescript.DiagnosticCategory.Warning,\n        })\n      );\n      return undefined;\n    }\n    const type = program.getTypeChecker().getTypeFromTypeNode(typeNode);\n    return new Type({\n      type,\n      text: typeString,\n      getReferences: () =>\n        getReferencesForTypeNode(typeNode, location, analyzer),\n    });\n  } else {\n    return undefined;\n  }\n};\n\n/**\n * Returns an analyzer `Type` object for the given AST node.\n */\nexport const getTypeForNode = (\n  node: ts.Node,\n  analyzer: AnalyzerInterface\n): Type => {\n  return getTypeForType(\n    analyzer.program.getTypeChecker().getTypeAtLocation(node),\n    node,\n    analyzer\n  );\n};\n\n/**\n * Converts a ts.Type into an analyzer Type object (which wraps\n * the ts.Type, but also provides analyzer Reference objects).\n */\nexport const getTypeForType = (\n  type: ts.Type,\n  location: ts.Node,\n  analyzer: AnalyzerInterface\n): Type => {\n  const {typescript} = analyzer;\n  const checker = analyzer.program.getTypeChecker();\n  // Ensure we treat inferred `foo = 'hi'` as 'string' not '\"hi\"',\n  // but retain explicitly defined unions\n  if (!type.isUnion()) {\n    type = checker.getBaseTypeOfLiteralType(type);\n  }\n  const text = checker.typeToString(type);\n  const typeNode = checker.typeToTypeNode(\n    type,\n    location,\n    typescript.NodeBuilderFlags.IgnoreErrors\n  );\n  let getReferences;\n  if (typeNode === undefined) {\n    analyzer.addDiagnostic(\n      createDiagnostic({\n        typescript,\n        node: location,\n        message: `Could not convert type to type node`,\n        category: typescript.DiagnosticCategory.Warning,\n      })\n    );\n    getReferences = () => [];\n  } else {\n    getReferences = () =>\n      getReferencesForTypeNode(typeNode, location, analyzer);\n  }\n  return new Type({\n    type,\n    text,\n    getReferences,\n  });\n};\n\n/**\n * For a given TypeNode syntax tree, walk the AST and extract Reference\n * model objects for any TypeReferenceNode or ImportTypeNode's.\n */\nconst getReferencesForTypeNode = (\n  typeNode: ts.TypeNode,\n  location: ts.Node,\n  analyzer: AnalyzerInterface\n): Reference[] => {\n  const {typescript} = analyzer;\n  const references: Reference[] = [];\n  const visit = (node: ts.Node) => {\n    if (typescript.isTypeReferenceNode(node)) {\n      const name = getRootName(typescript, node.typeName);\n      // TODO(kschaaf): we'd like to just do\n      // `checker.getSymbolAtLocation(node)` to get the symbol, but it appears\n      // that nodes created with `checker.typeToTypeNode()` do not have\n      // associated symbols, so we need to look up by name via\n      // `checker.getSymbolsInScope()`\n      const symbol = getSymbolForName(name, location, analyzer);\n      if (symbol === undefined) {\n        analyzer.addDiagnostic(\n          createDiagnostic({\n            typescript,\n            node: location,\n            message: `Could not get symbol for '${name}'.`,\n          })\n        );\n        return;\n      }\n      const ref = getReferenceForSymbol(symbol, location, analyzer);\n      if (ref !== undefined) {\n        references.push(ref);\n      }\n    } else if (typescript.isImportTypeNode(node)) {\n      if (!typescript.isLiteralTypeNode(node.argument)) {\n        analyzer.addDiagnostic(\n          createDiagnostic({\n            typescript,\n            node: node.argument,\n            message: 'Expected a string literal.',\n          })\n        );\n        return;\n      }\n      const name = getRootName(typescript, node.qualifier);\n      if (!typescript.isStringLiteral(node.argument.literal)) {\n        analyzer.addDiagnostic(\n          createDiagnostic({\n            typescript,\n            node: node.argument.literal,\n            message: `Expected import specifier to be a string literal`,\n          })\n        );\n        return;\n      }\n      const specifier = getSpecifierFromTypeImport(\n        node.argument.literal.text,\n        analyzer\n      );\n      // TODO(kschaaf): This may have been an inferred type from a transitive\n      // dependency; in this case we should include version information in the\n      // reference model\n      references.push(\n        getImportReference(specifier, node.argument.literal, name, analyzer)\n      );\n    }\n    typescript.forEachChild(node, visit);\n  };\n  visit(typeNode);\n  return references;\n};\n\n/**\n * If the given specifier is an absolute path, turns it into an npm import\n * specifier by looking for its package.json and using package information found\n * there.\n *\n * If the path was not absolute, it returns the specifier as-is.\n */\nconst getSpecifierFromTypeImport = (\n  specifier: string,\n  analyzer: AnalyzerInterface\n) => {\n  specifier = analyzer.path.normalize(\n    // Types can resolve to source or declaration files, so include those\n    // extensions as well. We still include JS extensions to support JSDoc\n    // types.\n    // We don't include the CommonJS-only extensions .cts and .d.cts here\n    resolveExtension(specifier as AbsolutePath, analyzer, [\n      'js',\n      'mjs',\n      'ts',\n      'mts',\n      'tsx',\n      'jsx',\n      'd.ts',\n      'd.mts',\n    ])\n  );\n  if (analyzer.path.isAbsolute(specifier)) {\n    const {\n      rootDir,\n      name,\n      packageJson: {main, module},\n    } = getPackageInfo(specifier as AbsolutePath, analyzer);\n    let modulePath = absoluteToPackage(\n      specifier as AbsolutePath,\n      rootDir,\n      analyzer.path.sep\n    );\n    const packageMain = module ?? main;\n    if (packageMain !== undefined && modulePath === packageMain) {\n      modulePath = '' as PackagePath;\n    }\n    specifier = name + (modulePath ? `/${modulePath}` : '');\n  }\n  return specifier;\n};\n\n/**\n * Gets the left-most name of a (possibly qualified) identifier, i.e.\n * 'Foo' returns 'Foo', but 'ts.SyntaxKind' returns 'ts'. This is the\n * symbol that would need to be imported into a given scope.\n */\nconst getRootName = (\n  typescript: TypeScript,\n  name: ts.Identifier | ts.QualifiedName | undefined\n): string => {\n  if (name === undefined) {\n    return '';\n  }\n  if (typescript.isQualifiedName(name)) {\n    return getRootName(typescript, name.left);\n  } else {\n    return name.text;\n  }\n};\n\n/**\n * Below is a minimal LanguageService that allows quickly parsing snippets of TS\n * syntax into an AST. There's one file `contents.ts` in the program that we\n * update with snippets to parse.\n *\n * This allows extracting a type string from a custom JSDoc comment (like\n * `@event`), parsing it into syntax, and than walking it to extract references.\n *\n * Note, the program may have semantic errors (e.g. it may reference imports\n * that aren't included in the snippet), but that's ok because we only care\n * about parsing the syntax. When extracting references, we can use\n * `getSymbolByName` to re-associate symbols by name from a disassociated syntax\n * tree and the actual program.\n *\n * TODO(kschaaf): Providing diagnostic errors for semantically incorrect custom\n * JSDoc types would be nice, but that's pretty difficult in analyzers\n * where we don't control the TS program creation such that we can re-write\n * source files, etc. (as is the case when using in plugins).\n */\n\nlet contents = '';\nlet contentsId = 0;\n\nconst services = new WeakMap<TypeScript, ts.LanguageService>();\nconst getService = (typescript: TypeScript) => {\n  let service = services.get(typescript);\n  if (service === undefined) {\n    service = typescript.createLanguageService(\n      {\n        getScriptFileNames: () => ['contents.ts'],\n        getScriptVersion: () => contentsId.toString(),\n        getScriptSnapshot: () => typescript.ScriptSnapshot.fromString(contents),\n        getCurrentDirectory: () => '',\n        getCompilationSettings: () => ({include: ['contents.ts']}),\n        getDefaultLibFileName: (options) =>\n          typescript.getDefaultLibFilePath(options),\n        fileExists: () => true,\n        readFile: () => undefined,\n        readDirectory: () => [],\n        directoryExists: () => true,\n        getDirectories: () => [],\n      },\n      typescript.createDocumentRegistry()\n    );\n    services.set(typescript, service);\n  }\n  return service;\n};\n\n/**\n * Uses the stub LSH above to parse a type string and return a syntax-only\n * TypeNode (there will be no valid symbol information retrievable directly from\n * these nodes).\n */\n// TODO (justinfagnani): This would probably be a bit cleaner as an instance\n// method on Analyzer now.\nconst parseType = (\n  typescript: TypeScript,\n  typeString: string\n): ts.TypeNode | undefined => {\n  // Update the file\n  contents = `export type typeToParse = ${typeString}`;\n  contentsId++;\n  // Get a new program & parsed source file\n  const sourceFile = getService(typescript)\n    .getProgram()\n    ?.getSourceFileByPath('contents.ts' as ts.Path);\n  if (sourceFile === undefined) {\n    return undefined;\n  }\n  // Find the type alias node and return it\n  let typeNode: ts.TypeNode | undefined = undefined;\n  typescript.forEachChild(sourceFile, (node) => {\n    if (typescript.isTypeAliasDeclaration(node)) {\n      typeNode = node.type;\n    }\n  });\n  return typeNode;\n};\n"]}

package/lib/utils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+/**
+ * @fileoverview
+ *
+ * Helper utilities for analyzing declarations
+ */
+import type ts from 'typescript';
+import { Privacy } from './model.js';
+export type TypeScript = typeof ts;
+export declare const hasModifier: (ts: TypeScript, node: ts.HasModifiers, modifier: ts.SyntaxKind) => boolean;
+export declare const hasExportModifier: (ts: TypeScript, node: ts.HasModifiers) => boolean;
+export declare const hasDefaultModifier: (ts: TypeScript, node: ts.HasModifiers) => boolean;
+export declare const hasStaticModifier: (ts: TypeScript, node: ts.HasModifiers) => boolean;
+export declare const hasPrivateModifier: (ts: TypeScript, node: ts.HasModifiers) => boolean;
+export declare const hasProtectedModifier: (ts: TypeScript, node: ts.HasModifiers) => boolean;
+export declare const getPrivacy: (ts: TypeScript, node: ts.Node) => Privacy;
+export declare const getBaseTypes: (type: ts.Type) => ts.BaseType[];
+//# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/lib/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AAEnC,MAAM,MAAM,UAAU,GAAG,OAAO,EAAE,CAAC;AAEnC,eAAO,MAAM,WAAW,GACtB,IAAI,UAAU,EACd,MAAM,EAAE,CAAC,YAAY,EACrB,UAAU,EAAE,CAAC,UAAU,YAGxB,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAI,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC,YAAY,YAEtE,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC,YAAY,YAEvE,CAAC;AAEF,eAAO,MAAM,iBAAiB,GAAI,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC,YAAY,YAEtE,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC,YAAY,YAEvE,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAAI,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC,YAAY,YAEzE,CAAC;AAkBF,eAAO,MAAM,UAAU,GAAI,IAAI,UAAU,EAAE,MAAM,EAAE,CAAC,IAAI,KAAG,OAM1D,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,MAAM,EAAE,CAAC,IAAI,KAAG,EAAE,CAAC,QAAQ,EAUvD,CAAC"}

package/lib/utils.js

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+import { hasJSDocTag } from './javascript/jsdoc.js';
+export const hasModifier = (ts, node, modifier) => {
+    return ts.getModifiers(node)?.some((s) => s.kind === modifier) ?? false;
+};
+export const hasExportModifier = (ts, node) => {
+    return hasModifier(ts, node, ts.SyntaxKind.ExportKeyword);
+};
+export const hasDefaultModifier = (ts, node) => {
+    return hasModifier(ts, node, ts.SyntaxKind.DefaultKeyword);
+};
+export const hasStaticModifier = (ts, node) => {
+    return hasModifier(ts, node, ts.SyntaxKind.StaticKeyword);
+};
+export const hasPrivateModifier = (ts, node) => {
+    return hasModifier(ts, node, ts.SyntaxKind.PrivateKeyword);
+};
+export const hasProtectedModifier = (ts, node) => {
+    return hasModifier(ts, node, ts.SyntaxKind.ProtectedKeyword);
+};
+const isPrivate = (ts, node) => {
+    return ((ts.canHaveModifiers(node) && hasPrivateModifier(ts, node)) ||
+        ((ts.isPropertyDeclaration(node) || ts.isMethodDeclaration(node)) &&
+            ts.isPrivateIdentifier(node.name)) ||
+        hasJSDocTag(ts, node, 'private'));
+};
+const isProtected = (ts, node) => {
+    return ((ts.canHaveModifiers(node) && hasProtectedModifier(ts, node)) ||
+        hasJSDocTag(ts, node, 'protected'));
+};
+export const getPrivacy = (ts, node) => {
+    return isPrivate(ts, node)
+        ? 'private'
+        : isProtected(ts, node)
+            ? 'protected'
+            : 'public';
+};
+export const getBaseTypes = (type) => {
+    if (type.isClassOrInterface()) {
+        return type.getBaseTypes() ?? [];
+    }
+    if (type.isIntersection()) {
+        return type.types.map(getBaseTypes).flat();
+    }
+    return [];
+};
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/lib/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AASH,OAAO,EAAC,WAAW,EAAC,MAAM,uBAAuB,CAAC;AAKlD,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,EAAc,EACd,IAAqB,EACrB,QAAuB,EACvB,EAAE;IACF,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,KAAK,CAAC;AAC1E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAAc,EAAE,IAAqB,EAAE,EAAE;IACzE,OAAO,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAc,EAAE,IAAqB,EAAE,EAAE;IAC1E,OAAO,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAAc,EAAE,IAAqB,EAAE,EAAE;IACzE,OAAO,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAc,EAAE,IAAqB,EAAE,EAAE;IAC1E,OAAO,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAc,EAAE,IAAqB,EAAE,EAAE;IAC5E,OAAO,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAC/D,CAAC,CAAC;AAEF,MAAM,SAAS,GAAG,CAAC,EAAc,EAAE,IAAa,EAAE,EAAE;IAClD,OAAO,CACL,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC3D,CAAC,CAAC,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC/D,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,CACjC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,EAAc,EAAE,IAAa,EAAE,EAAE;IACpD,OAAO,CACL,CAAC,EAAE,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAC7D,WAAW,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,CAAC,CACnC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EAAc,EAAE,IAAa,EAAW,EAAE;IACnE,OAAO,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC;QACxB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC;YACrB,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,QAAQ,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAa,EAAiB,EAAE;IAC3D,IAAI,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC;IACnC,CAAC;IAED,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2022 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\n/**\n * @fileoverview\n *\n * Helper utilities for analyzing declarations\n */\n\nimport type ts from 'typescript';\nimport {hasJSDocTag} from './javascript/jsdoc.js';\nimport {Privacy} from './model.js';\n\nexport type TypeScript = typeof ts;\n\nexport const hasModifier = (\n  ts: TypeScript,\n  node: ts.HasModifiers,\n  modifier: ts.SyntaxKind\n) => {\n  return ts.getModifiers(node)?.some((s) => s.kind === modifier) ?? false;\n};\n\nexport const hasExportModifier = (ts: TypeScript, node: ts.HasModifiers) => {\n  return hasModifier(ts, node, ts.SyntaxKind.ExportKeyword);\n};\n\nexport const hasDefaultModifier = (ts: TypeScript, node: ts.HasModifiers) => {\n  return hasModifier(ts, node, ts.SyntaxKind.DefaultKeyword);\n};\n\nexport const hasStaticModifier = (ts: TypeScript, node: ts.HasModifiers) => {\n  return hasModifier(ts, node, ts.SyntaxKind.StaticKeyword);\n};\n\nexport const hasPrivateModifier = (ts: TypeScript, node: ts.HasModifiers) => {\n  return hasModifier(ts, node, ts.SyntaxKind.PrivateKeyword);\n};\n\nexport const hasProtectedModifier = (ts: TypeScript, node: ts.HasModifiers) => {\n  return hasModifier(ts, node, ts.SyntaxKind.ProtectedKeyword);\n};\n\nconst isPrivate = (ts: TypeScript, node: ts.Node) => {\n  return (\n    (ts.canHaveModifiers(node) && hasPrivateModifier(ts, node)) ||\n    ((ts.isPropertyDeclaration(node) || ts.isMethodDeclaration(node)) &&\n      ts.isPrivateIdentifier(node.name)) ||\n    hasJSDocTag(ts, node, 'private')\n  );\n};\n\nconst isProtected = (ts: TypeScript, node: ts.Node) => {\n  return (\n    (ts.canHaveModifiers(node) && hasProtectedModifier(ts, node)) ||\n    hasJSDocTag(ts, node, 'protected')\n  );\n};\n\nexport const getPrivacy = (ts: TypeScript, node: ts.Node): Privacy => {\n  return isPrivate(ts, node)\n    ? 'private'\n    : isProtected(ts, node)\n      ? 'protected'\n      : 'public';\n};\n\nexport const getBaseTypes = (type: ts.Type): ts.BaseType[] => {\n  if (type.isClassOrInterface()) {\n    return type.getBaseTypes() ?? [];\n  }\n\n  if (type.isIntersection()) {\n    return type.types.map(getBaseTypes).flat();\n  }\n\n  return [];\n};\n"]}

package/package-analyzer.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export * from './index.js';
+export * from './lib/package-analyzer.js';
+//# sourceMappingURL=package-analyzer.d.ts.map

package/package-analyzer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-analyzer.d.ts","sourceRoot":"","sources":["src/package-analyzer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,2BAA2B,CAAC"}

package/package-analyzer.js

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright 2023 Google LLC
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+export * from './index.js';
+export * from './lib/package-analyzer.js';
+//# sourceMappingURL=package-analyzer.js.map

package/package-analyzer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-analyzer.js","sourceRoot":"","sources":["src/package-analyzer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAC;AAC3B,cAAc,2BAA2B,CAAC","sourcesContent":["/**\n * @license\n * Copyright 2023 Google LLC\n * SPDX-License-Identifier: BSD-3-Clause\n */\n\nexport * from './index.js';\nexport * from './lib/package-analyzer.js';\n"]}

package/package.json

@@ -0,0 +1,109 @@
+{
+  "name": "@oicl-lit/analyzer",
+  "version": "0.14.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "A static analyzer for Lit",
+  "license": "BSD-3-Clause",
+  "author": "Google LLC",
+  "homepage": "https://github.com/lit/lit/tree/main/packages/labs/analyzer",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lit/lit.git",
+    "directory": "packages/labs/analyzer"
+  },
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "build": "wireit",
+    "test": "wireit",
+    "test:server": "wireit",
+    "test:browser": "wireit"
+  },
+  "wireit": {
+    "build": {
+      "command": "tsc --build --pretty",
+      "dependencies": [
+        "../../lit:build"
+      ],
+      "files": [
+        "src/**/*.ts",
+        "tsconfig.json"
+      ],
+      "output": [
+        "lib",
+        "test",
+        "index.{js,js.map,d.ts,d.ts.map}",
+        "package-analyzer.{js,js.map,d.ts,d.ts.map}",
+        "tsconfig.tsbuildinfo",
+        "!test/browser/typescript.js"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "build:ts-bundle": {
+      "#comment": "This builds a JS module of typescript for use in browser tests",
+      "command": "rollup -c rollup.config.typescript.js",
+      "files": [
+        "rollup.config.typescript.js"
+      ],
+      "output": [
+        "test/browser/typescript.js"
+      ]
+    },
+    "test": {
+      "dependencies": [
+        "test:server",
+        "test:browser"
+      ]
+    },
+    "test:server": {
+      "command": "node --enable-source-maps --test-reporter=spec --test test/server/*_test.js test/server/**/*_test.js",
+      "dependencies": [
+        "build"
+      ],
+      "files": [
+        "test-files/"
+      ],
+      "output": []
+    },
+    "test:browser": {
+      "command": "node ../../tests/run-web-tests.js \"test/browser/**/*_test.js\" --config ../../tests/web-test-runner.config.js",
+      "dependencies": [
+        "build",
+        "build:ts-bundle",
+        "../../tests:build"
+      ],
+      "env": {
+        "BROWSERS": {
+          "external": true
+        },
+        "MODE": "dev"
+      },
+      "files": [],
+      "output": []
+    }
+  },
+  "files": [
+    "index.*",
+    "package-analyzer.*",
+    "/lib/",
+    "!/lib/.tsbuildinfo"
+  ],
+  "exports": {
+    ".": "./index.js",
+    "./package-analyzer.js": "./package-analyzer.js",
+    "./lib/*.js": "./lib/*.js"
+  },
+  "dependencies": {
+    "@parse5/tools": "^0.7.0",
+    "lit-html": "^3.1.2",
+    "package-json-type": "^1.0.3",
+    "parse5": "^7.3.0",
+    "typescript": "~5.9.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "path-module": "^0.1.2"
+  }
+}