Add Web-Types generation support

.gitignore

@@ -5,4 +5,5 @@ node_modules
 dist
 lib
 *.tgz
+yarn.lock
 

doc/web-types.md

@@ -0,0 +1,152 @@
+# Web-types
+
+## web-component-analyzer usage
+
+### With package.json configuration
+
+You can add a `wca` section in your `package.json` to configure wca for web-types build.
+
+```json
+"wca": {
+  "webtypesConfig": {
+    "name": "your-project-name",
+    "version": "0.0.1",
+    "framework": "lit",
+    "description-markup": "markdown"
+  }
+}
+```
+
+To run wca then use command:
+
+```bash
+wca analyze src --format webtypes --outFile web-types-custom.json
+```
+
+If you run `wca` from project npm `scripts` section of `package.json`, you can omit `name` and `version` property
+in `webtypesConfig`, this will take package `name` and `version` by default.
+
+### With command line only
+
+You can also avoid updating `package.json` `wca` section and use only command line by providing a json configuration to `--webtypesConfig` argument:
+
+```bash
+wca analyze src --format webtypes --outFile web-types-custom.json --webtypesConfig='{"name": "your-project-name", "version": "0.0.1", "framework": "lit", "description-markup": "markdown"}'
+```
+
+If you run `wca` from project npm `scripts` section of `package.json`, you can omit `name` and `version` property
+in `webtypesConfig`, this will take package `name` and `version` by default.
+
+## Project setup
+
+### For Lit
+
+Generated web-types are working with the generic `lit-web-types` library. You need to add it on your project.
+
+<!-- prettier-ignore -->
+```bash
+npm i lit-web-types -D
+```
+
+Add `wca` section in your `package.json`:
+
+```json
+"wca": {
+  "webtypesConfig": {
+    "framework": "lit",
+    "description-markup": "markdown"
+  }
+}
+```
+
+Working with lit, `framework` must have `lit` value. See [Web types config parameters](#web-types-config-parameters) documentation section for more info.
+
+Add `scripts` section in your `package.json`:
+
+```json
+"scripts": {
+  "web-types": "wca analyze src --format webtypes --outFile web-types.json"
+}
+```
+
+Generate your components descriptions with wca
+
+<!-- prettier-ignore -->
+```bash
+npm web-types
+```
+
+If your web-types is not named `web-types.json` and placed at root of your project, you need to declare it in your `package.json`
+
+```json
+"web-types": [
+  "..../web-types-custom.json"
+]
+```
+
+After the first setup on Intellij, IDE restart might be needed to enable components completion.
+
+### For Polymer
+
+Generated web-types are working with the generic `polymer-web-types` library. You need to add it on your project.
+
+<!-- prettier-ignore -->
+```bash
+npm i polymer-web-types -D
+```
+
+Add `wca` section in your `package.json`:
+
+```json
+"wca": {
+  "webtypesConfig": {
+    "framework": "@polymer/polymer",
+    "description-markup": "markdown"
+  }
+}
+```
+
+Working with lit, `framework` must have `@polymer/polymer` value. See [Web types config parameters](#web-types-config-parameters) documentation section for more info.
+
+Add `scripts` section in your `package.json`:
+
+```json
+"scripts": {
+  "web-types": "wca analyze src --format webtypes --outFile web-types.json"
+}
+```
+
+Generate your components descriptions with wca
+
+<!-- prettier-ignore -->
+```bash
+npm web-types
+```
+
+If your web-types is not named `web-types.json` and placed at root of your project, you need to declare it in your `package.json`
+
+```json
+"web-types": [
+  "..../web-types-custom.json"
+]
+```
+
+After the first setup on Intellij, IDE restart might be needed to enable components completion.
+
+## Web types config parameters
+
+`webtypesConfig` parameter is a json object containing web-types file root parameter.
+
+Available parameters:
+
+| Name               | Description                                                                                                   |
+| ------------------ | ------------------------------------------------------------------------------------------------------------- |
+| name               | Name of library                                                                                               |
+| version            | Version of the library, for which Web-Types are provided                                                      |
+| framework          | See [http://json.schemastore.org/web-types](http://json.schemastore.org/web-types) framework section          |
+| js-types-syntax    | See [http://json.schemastore.org/web-types](http://json.schemastore.org/web-types) js-types-syntax section    |
+| description-markup | See [http://json.schemastore.org/web-types](http://json.schemastore.org/web-types) description-markup section |
+| framework-config   | See [http://json.schemastore.org/web-types](http://json.schemastore.org/web-types) framework-config section   |
+| default-icon       | See [http://json.schemastore.org/web-types](http://json.schemastore.org/web-types) default-icon section       |
+
+See [web-types project:](https://github.com/JetBrains/web-types) for more info.

package.json

@@ -34,7 +34,8 @@
 	"keywords": [
 		"web components",
 		"web",
-		"components"
+		"components",
+		"web-types"
 	],
 	"contributors": [
 		{

src/cli/analyze/analyze-cli-command.ts

@@ -23,7 +23,7 @@ export const analyzeCliCommand: CliCommand = async (config: AnalyzerCliConfig):
 	const inputGlobs = config.glob || [];
 
 	// Log warning for experimental json format
-	if (config.format === "json" || config.format === "json2" || config.outFile?.endsWith(".json")) {
+	if (config.format === "json" || config.format === "json2" || (config.outFile?.endsWith(".json") && config.format !== "webtypes")) {
 		log(
 			`
 !!!!!!!!!!!!!  WARNING !!!!!!!!!!!!!
@@ -37,6 +37,43 @@ Please follow and contribute to the discussion at:
 		);
 	}
 
+	if (config.format === "webtypes") {
+		if (!config.webtypesConfig) throw makeCliError("Missing webtypes-config configuration");
+
+		// Allow object being passed as JSON from command line
+		let cleanedConfiguration;
+		if (typeof config.webtypesConfig === "string") {
+			try {
+				cleanedConfiguration = JSON.parse(config.webtypesConfig);
+			} catch (e) {
+				const message = e instanceof Error ? e.message : e;
+				throw makeCliError("webtypes-config JSON format issue: " + message + "\nReceived value: " + config.webtypesConfig);
+			}
+		} else {
+			cleanedConfiguration = config.webtypesConfig;
+		}
+
+		if (!cleanedConfiguration.name) {
+			// Take package name if ran from npm script
+			if (process.env.npm_package_name) {
+				cleanedConfiguration.name = process.env.npm_package_name;
+			} else {
+				throw makeCliError('Missing webtypes-config "name" property');
+			}
+		}
+
+		if (!cleanedConfiguration.version) {
+			// Take package version if ran from npm script
+			if (process.env.npm_package_version) {
+				cleanedConfiguration.version = process.env.npm_package_version;
+			} else {
+				throw makeCliError('Missing webtypes-config "version" property');
+			}
+		}
+
+		config.parsedWebtypesConfig = cleanedConfiguration;
+	}
+
 	// If no "out" is specified, output to console
 	const outStrategy: OutStrategy = (() => {
 		if (config.outDir == null && config.outFile == null && config.outFiles == null) {
@@ -122,8 +159,12 @@ function transformResults(results: AnalyzerResult[] | AnalyzerResult, program: P
 		inlineTypes: config.inlineTypes ?? false,
 		visibility: config.visibility ?? "public",
 		markdown: config.markdown,
-		cwd: config.cwd
+		cwd: config.cwd,
+		pathAsAbsolute: config.pathAsAbsolute
 	};
+	if (format == "webtypes") {
+		transformerConfig.webTypes = config.parsedWebtypesConfig;
+	}
 
 	return transformAnalyzerResult(format, results, program, transformerConfig);
 }
@@ -227,6 +268,7 @@ function formatToExtension(kind: TransformerKind): string {
 	switch (kind) {
 		case "json":
 		case "vscode":
+		case "webtypes":
 			return ".json";
 		case "md":
 		case "markdown":

src/cli/analyzer-cli-config.ts

@@ -2,6 +2,7 @@ import * as tsModule from "typescript";
 import { ComponentFeature } from "../analyze/types/features/component-feature";
 import { VisibilityKind } from "../analyze/types/visibility-kind";
 import { TransformerKind } from "../transformers/transformer-kind";
+import { WebTypesTransformerConfig } from "../transformers";
 
 export interface AnalyzerCliConfig {
 	glob?: string[];
@@ -30,4 +31,8 @@ export interface AnalyzerCliConfig {
 
 	ts?: typeof tsModule;
 	cwd?: string;
+	pathAsAbsolute?: boolean;
+
+	webtypesConfig?: string | WebTypesTransformerConfig;
+	parsedWebtypesConfig?: WebTypesTransformerConfig;
 }

src/cli/cli.ts

@@ -9,6 +9,7 @@ import { log } from "./util/log";
  */
 export function cli(): void {
 	const argv = yargs
+		.pkgConf("wca")
 		.usage("Usage: $0 <command> [glob..] [options]")
 		.command<AnalyzerCliConfig>({
 			command: ["analyze [glob..]", "$0"],
@@ -50,7 +51,7 @@ o {tagname}: The element's tag name`,
 		})
 		.option("format", {
 			describe: `Specify output format`,
-			choices: ["md", "markdown", "json", "json2", "vscode"],
+			choices: ["md", "markdown", "json", "json2", "vscode", "webtypes"],
 			nargs: 1,
 			alias: "f"
 		})
@@ -103,6 +104,15 @@ o {tagname}: The element's tag name`,
 			string: true,
 			hidden: true
 		})
+		.option("pathAsAbsolute", {
+			describe: "Consider paths as absolute: don't add './' in front of paths",
+			boolean: true,
+			hidden: true
+		})
+		.option("webtypesConfig", {
+			describe: "WebTypes header configuration",
+			string: true
+		})
 
 		.alias("v", "version")
 		.help("h")

src/transformers/transform-analyzer-result.ts

@@ -8,14 +8,16 @@ import { TransformerConfig } from "./transformer-config";
 import { TransformerFunction } from "./transformer-function";
 import { TransformerKind } from "./transformer-kind";
 import { vscodeTransformer } from "./vscode/vscode-transformer";
+import { webtypesTransformer } from "./webtypes/webtypes-transformer";
 
 const transformerFunctionMap: Record<TransformerKind, TransformerFunction> = {
 	debug: debugJsonTransformer,
 	json: jsonTransformer,
 	json2: json2Transformer,
 	markdown: markdownTransformer,
 	md: markdownTransformer,
-	vscode: vscodeTransformer
+	vscode: vscodeTransformer,
+	webtypes: webtypesTransformer
 };
 
 /**

src/transformers/transformer-config.ts

@@ -1,11 +1,28 @@
 import { VisibilityKind } from "../analyze/types/visibility-kind";
+import { GenericContributions } from "./webtypes/webtypes-schema";
 
 export interface TransformerConfig {
 	cwd?: string;
+	pathAsAbsolute?: boolean;
 	visibility?: VisibilityKind;
 	markdown?: {
 		titleLevel?: number; // deprecated
 		headerLevel?: number;
 	};
 	inlineTypes?: boolean;
+	webTypes?: WebTypesTransformerConfig;
+}
+
+export interface WebTypesTransformerConfig {
+	name: string;
+	version: string;
+	"default-icon"?: string;
+	"js-types-syntax"?: "typescript";
+	framework?: string;
+	"framework-config"?: WebTypesFrameworkConfig;
+	"description-markup"?: "html" | "markdown" | "none";
+}
+
+export interface WebTypesFrameworkConfig {
+	[k: string]: GenericContributions;
 }

src/transformers/transformer-kind.ts

@@ -1 +1 @@
-export type TransformerKind = "md" | "markdown" | "json" | "vscode" | "debug" | "json2";
+export type TransformerKind = "md" | "markdown" | "json" | "vscode" | "debug" | "json2" | "webtypes";