Read jsdoc @private and @protected annotations

dev/src/lit-element/lit-element.js

@@ -4,8 +4,15 @@ import { customElement, LitElement } from "lit-element";
 export class MyElement extends LitElement {
 	@property() myBoolean = true;
 
+	/**
+	 * @private
+	 */
 	myString = "hello";
 
+	/**
+	 * @protected
+	 * @type {string}
+	 */
 	myProp = "hejsa";
 
 	static get properties() {

src/analyze/analyze-components.ts

@@ -9,6 +9,7 @@ import { parseComponentDefinitions } from "./parse/parse-definitions";
 import { parseGlobalEvents } from "./parse/parse-global-events";
 import { ComponentDefinition } from "./types/component-definition";
 import { ComponentDiagnostic } from "./types/component-diagnostic";
+import { ComponentMemberVisibilityKind } from "./types/component-member";
 import { EventDeclaration } from "./types/event-types";
 
 const DEFAULT_FLAVORS = [new LitElementFlavor(), new CustomElementFlavor(), new JsDocFlavor(), new StencilFlavor()];
@@ -28,6 +29,7 @@ export interface AnalyzeComponentsOptions {
  */
 export interface AnalyzeComponentsConfig {
 	diagnostics?: boolean;
+	visibility?: ComponentMemberVisibilityKind;
 	analyzeLibDom?: boolean;
 	excludedDeclarationNames?: string[];
 }

src/analyze/flavors/custom-element/custom-element-flavor.ts

@@ -1,6 +1,7 @@
 import { Node } from "typescript";
 import { ComponentMember } from "../../types/component-member";
 import { EventDeclaration } from "../../types/event-types";
+import { isNodeInLibDom } from "../../util/ast-util";
 import {
 	ParseComponentFlavor,
 	ParseComponentMembersContext,
@@ -32,4 +33,10 @@ export class CustomElementFlavor implements ParseComponentFlavor {
 	visitGlobalEvents(node: Node, context: ParseVisitContextGlobalEvents): void {
 		visitGlobalEvents(node, context);
 	}
+
+	isNodeInLib(node: Node) {
+		if (isNodeInLibDom(node)) {
+			return true;
+		}
+	}
 }

src/analyze/flavors/custom-element/parse-declaration-members.ts

@@ -1,7 +1,7 @@
 import { SimpleTypeKind, toSimpleType } from "ts-simple-type";
 import { BinaryExpression, ExpressionStatement, Node, ReturnStatement } from "typescript";
 import { ComponentMember } from "../../types/component-member";
-import { hasModifier, hasPublicSetter, isPropertyRequired, isPropNamePublic } from "../../util/ast-util";
+import { hasModifier, isPropertyRequired, isNamePrivate, getMemberVisibility, isMemberAndWritable } from "../../util/ast-util";
 import { getJsDoc } from "../../util/js-doc-util";
 import { resolveNodeValue } from "../../util/resolve-node-value";
 import { relaxType } from "../../util/type-util";
@@ -26,6 +26,7 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 						members.push({
 							kind: "attribute",
 							attrName,
+							visibility: isNamePrivate(attrName) ? "private" : "public",
 							type: { kind: SimpleTypeKind.ANY },
 							node: attrNameNode
 						});
@@ -38,17 +39,19 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 	}
 
 	// class { myProp = "hello"; }
-	else if ((ts.isPropertyDeclaration(node) || ts.isPropertySignature(node)) && hasPublicSetter(node, ts)) {
+	else if ((ts.isPropertyDeclaration(node) || ts.isPropertySignature(node)) && isMemberAndWritable(node, ts)) {
 		const { name, initializer } = node;
 
 		if (ts.isIdentifier(name) || ts.isStringLiteralLike(name)) {
 			// Find default value based on initializer
 			const def = "initializer" in node && node.initializer != null ? resolveNodeValue(initializer, context) : undefined;
+			const propName = name.text;
 
 			return [
 				{
 					kind: "property",
-					propName: name.text,
+					propName,
+					visibility: getMemberVisibility(node, ts),
 					type: checker.getTypeAtLocation(node),
 					required: isPropertyRequired(node, context.checker),
 					default: def,
@@ -61,10 +64,13 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 
 	// class { 'hello'?: number }
 	else if (ts.isConditionalExpression(node) && (ts.isStringLiteralLike(node.condition) || ts.isIdentifier(node.condition))) {
+		const propName = node.condition.text;
+
 		return [
 			{
 				kind: "property",
-				propName: node.condition.text,
+				propName,
+				visibility: isNamePrivate(propName) ? "private" : "public",
 				type: checker.getTypeAtLocation(node),
 				jsDoc: getJsDoc(node, ts),
 				node
@@ -73,16 +79,18 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 	}
 
 	// class { set myProp(value: string) { ... } }
-	else if (ts.isSetAccessor(node) && hasPublicSetter(node, ts)) {
+	else if (ts.isSetAccessor(node) && isMemberAndWritable(node, ts)) {
 		const { name, parameters } = node;
 
 		if (ts.isIdentifier(name) && parameters.length > 0) {
 			const parameter = parameters[0];
+			const propName = name.text;
 
 			return [
 				{
 					kind: "property",
-					propName: name.text,
+					propName,
+					visibility: getMemberVisibility(node, ts),
 					type: context.checker.getTypeAtLocation(parameter),
 					jsDoc: getJsDoc(node, ts),
 					required: false,
@@ -114,13 +122,14 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 
 						const parsedClassField = classFieldDeclaration == null ? undefined : parseDeclarationMembers(classFieldDeclaration, context);
 
-						if (isPropNamePublic(propName) && (classFieldDeclaration == null || parsedClassField != null)) {
+						if (classFieldDeclaration == null || parsedClassField != null) {
 							const simpleType = relaxType(toSimpleType(checker.getTypeAtLocation(right), checker));
 
 							members.push({
 								kind: "property",
 								propName,
 								default: resolveNodeValue(right, context),
+								visibility: isNamePrivate(propName) ? "private" : "public",
 								type: simpleType,
 								jsDoc: getJsDoc(assignment.parent, ts),
 								required: false,

src/analyze/flavors/js-doc/parse-declaration-members.ts

@@ -1,6 +1,7 @@
 import { SimpleTypeKind } from "ts-simple-type";
 import { Node } from "typescript";
 import { ComponentMember, ComponentMemberAttribute, ComponentMemberProperty } from "../../types/component-member";
+import { isNamePrivate } from "../../util/ast-util";
 import { parseJsDocTypeString } from "../../util/js-doc-util";
 import { ParseComponentMembersContext } from "../parse-component-flavor";
 import { parseJsDocForNode } from "./helper";
@@ -18,10 +19,13 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 			node,
 			["prop", "property"],
 			(tagNode, parsed) => {
-				if (parsed.name != null) {
+				const propName = parsed.name;
+
+				if (propName != null) {
 					return {
 						kind: "property",
-						propName: parsed.name,
+						propName,
+						visibility: isNamePrivate(propName) ? "private" : "public",
 						jsDoc: parsed.comment != null ? { comment: parsed.comment } : undefined,
 						type: (parsed.type && parseJsDocTypeString(parsed.type)) || { kind: SimpleTypeKind.ANY },
 						node: tagNode
@@ -35,10 +39,12 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 			node,
 			["attr", "attribute"],
 			(tagNode, parsed) => {
-				if (parsed.name != null) {
+				const attrName = parsed.name;
+				if (attrName != null) {
 					return {
 						kind: "attribute",
-						attrName: parsed.name,
+						attrName,
+						visibility: isNamePrivate(attrName) ? "private" : "public",
 						jsDoc: parsed.comment && { comment: parsed.comment },
 						type: (parsed.type && parseJsDocTypeString(parsed.type)) || { kind: SimpleTypeKind.ANY },
 						node: tagNode

src/analyze/flavors/lit-element/lit-element-flavor.ts

@@ -12,4 +12,13 @@ export class LitElementFlavor implements ParseComponentFlavor {
 	parseDeclarationMembers(node: Node, context: ParseComponentMembersContext): ComponentMember[] | undefined {
 		return parseDeclarationMembers(node, context);
 	}
+
+	isNodeInLib(node: Node, context: ParseComponentMembersContext) {
+		if (context.ts.isClassLike(node)) {
+			const name = (node.name != null && node.name.text) || "";
+			if (["LitElement", "PolymerElement", "Polymer.Element"].includes(name)) {
+				return true;
+			}
+		}
+	}
 }

src/analyze/flavors/lit-element/parse-declaration-members.ts

@@ -1,7 +1,7 @@
 import { isAssignableToSimpleTypeKind, SimpleType, SimpleTypeKind, toSimpleType, toTypeString } from "ts-simple-type";
 import { Node, PropertyLikeDeclaration, PropertySignature, ReturnStatement, SetAccessorDeclaration } from "typescript";
 import { ComponentMember } from "../../types/component-member";
-import { hasModifier, hasPublicSetter, isPropertyRequired, isPropNamePublic } from "../../util/ast-util";
+import { getMemberVisibility, hasModifier, isMemberAndWritable, isNamePrivate, isPropertyRequired } from "../../util/ast-util";
 import { isValidAttributeName } from "../../util/is-valid-attribute-name";
 import { getJsDoc, getJsDocType } from "../../util/js-doc-util";
 import { resolveNodeValue } from "../../util/resolve-node-value";
@@ -36,7 +36,7 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 	}
 
 	// @property({type: String}) myProp = "hello";
-	else if ((ts.isSetAccessorDeclaration(node) || ts.isPropertyDeclaration(node) || ts.isPropertySignature(node)) && hasPublicSetter(node, ts)) {
+	else if ((ts.isSetAccessorDeclaration(node) || ts.isPropertyDeclaration(node) || ts.isPropertySignature(node)) && isMemberAndWritable(node, ts)) {
 		return parsePropertyDecorator(node, context);
 	}
 }
@@ -101,6 +101,7 @@ function parsePropertyDecorator(
 				attrName,
 				type,
 				node,
+				visibility: getMemberVisibility(node, ts),
 				default: def || litConfig.default,
 				required,
 				jsDoc
@@ -156,7 +157,7 @@ function parseStaticProperties(returnStatement: ReturnStatement, context: Flavor
 		for (const propNode of returnStatement.expression.properties) {
 			// Get propName
 			const propName = propNode.name != null && ts.isIdentifier(propNode.name) ? propNode.name.text : undefined;
-			if (propName == null || !isPropNamePublic(propName)) {
+			if (propName == null) {
 				continue;
 			}
 
@@ -203,6 +204,7 @@ function parseStaticProperties(returnStatement: ReturnStatement, context: Flavor
 			members.push({
 				kind: "property",
 				type,
+				visibility: isNamePrivate(propName) ? "private" : "public",
 				propName: propName,
 				attrName: emitAttribute ? attrName : undefined,
 				jsDoc,

src/analyze/flavors/parse-component-flavor.ts

@@ -11,9 +11,9 @@ export interface FlavorVisitContext {
 	checker: TypeChecker;
 	ts: typeof tsModule;
 	config: AnalyzeComponentsConfig;
+	features?: FlavorVisitContextFeatures;
 	emitContinue?(): void;
 	emitDiagnostics(diagnostic: ComponentDiagnostic): void;
-	features?: FlavorVisitContextFeatures;
 }
 
 export interface FlavorVisitContextFeatures {
@@ -53,4 +53,6 @@ export interface ParseComponentFlavor {
 	parseDeclarationCSSProps?(node: Node, context: ParseComponentMembersContext): ComponentCSSProperty[] | undefined;
 
 	visitGlobalEvents?(node: Node, context: ParseVisitContextGlobalEvents): void;
+
+	isNodeInLib?(node: Node, context: ParseComponentMembersContext): boolean | undefined;
 }

src/analyze/flavors/stencil/parse-declaration-members.ts

@@ -1,5 +1,6 @@
 import { Node } from "typescript";
 import { ComponentMember } from "../../types/component-member";
+import { isNamePrivate } from "../../util/ast-util";
 import { ParseComponentMembersContext } from "../parse-component-flavor";
 
 /**
@@ -20,10 +21,12 @@ export function parseDeclarationMembers(node: Node, context: ParseComponentMembe
 	if (ts.isPropertyDeclaration(node) || ts.isPropertySignature(node) || ts.isConditionalExpression(node)) {
 		const name = ts.isConditionalExpression(node) ? node.condition : node.name;
 		if (ts.isIdentifier(name) || ts.isStringLiteralLike(name)) {
+			const attrName = name.text;
 			return [
 				{
 					kind: "attribute",
-					attrName: name.text,
+					attrName,
+					visibility: isNamePrivate(attrName) ? "private" : "public",
 					type: checker.getTypeAtLocation(node),
 					node
 				}

src/analyze/flavors/stencil/stencil-flavor.ts

@@ -10,4 +10,10 @@ export class StencilFlavor implements ParseComponentFlavor {
 	visitComponentDefinitions(node: Node, context: VisitComponentDefinitionContext): void {
 		visitComponentDefinitions(node, context);
 	}
+
+	isNodeInLib(node: Node) {
+		if (node.getSourceFile().fileName.endsWith("stencil.core.d.ts")) {
+			return true;
+		}
+	}
 }

src/analyze/parse/expand-from-js-doc.ts

@@ -26,6 +26,12 @@ export function expandMemberFromJsDoc(member: ComponentMember): ComponentMember
 		newMember.deprecated = deprecatedTag.comment || true;
 	}
 
+	// Check "@private" and "@protected
+	const visibilityTag = member.jsDoc.tags.find(t => t.tag === "private" || t.tag === "protected");
+	if (visibilityTag != null) {
+		newMember.visibility = visibilityTag.tag === "private" ? "private" : "protected";
+	}
+
 	// Check "@prop {Number} myProp - My comment"
 	if (newMember.kind === "property" && newMember.attrName == null) {
 		const attrNameTag = member.jsDoc.tags.find(t => ["attr", "attribute"].includes(t.tag));

src/analyze/parse/merge-declarations.ts

@@ -3,10 +3,11 @@ import { Type, TypeChecker } from "typescript";
 import { FlavorVisitContext } from "../flavors/parse-component-flavor";
 import { ComponentCSSProperty } from "../types/component-css-property";
 import { ComponentDeclaration } from "../types/component-declaration";
-import { ComponentMember, ComponentMemberAttribute, ComponentMemberProperty } from "../types/component-member";
+import { ComponentMember, ComponentMemberAttribute, ComponentMemberProperty, ComponentMemberVisibilityKind } from "../types/component-member";
 import { ComponentSlot } from "../types/component-slot";
 import { EventDeclaration } from "../types/event-types";
 import { JsDoc } from "../types/js-doc";
+import { compareVisibility } from "../util/component-util";
 import { mergeJsDocs } from "./merge-js-docs";
 
 /**
@@ -196,7 +197,8 @@ function mergeAttrIntoProp(prop: ComponentMemberProperty, attr: ComponentMemberA
 		default: attr.default || prop.default,
 		required: attr.required || prop.required,
 		jsDoc: attr.jsDoc || prop.jsDoc,
-		attrName: attr.attrName
+		attrName: attr.attrName,
+		visibility: mergeVisibility(attr.visibility, prop.visibility)
 	};
 }
 
@@ -211,7 +213,8 @@ function mergeMemberIntoMember<T extends ComponentMemberProperty | ComponentMemb
 	return {
 		...b,
 		attrName: a.attrName || b.attrName,
-		type: mergeTypes(a.type, b.type, checker)
+		type: mergeTypes(a.type, b.type, checker),
+		visibility: mergeVisibility(a.visibility, b.visibility)
 	};
 }
 
@@ -238,3 +241,15 @@ function mergeTypes(typeA: SimpleType | Type, typeB: SimpleType | Type, checker:
 	// Else return "typeB"
 	return typeB;
 }
+
+/**
+ * Merges two visibilities. Picks the lowest visibility.
+ * @param visibilityA
+ * @param visibilityB
+ */
+export function mergeVisibility(
+	visibilityA: ComponentMemberVisibilityKind,
+	visibilityB: ComponentMemberVisibilityKind
+): ComponentMemberVisibilityKind {
+	return compareVisibility(visibilityA, visibilityB) < 0 ? visibilityA : visibilityB;
+}