typedoc-plugin-missing-exports - npm Package Compare versions

Comparing version 0.23.0 to 1.0.0

CHANGELOG.md

		@@ -0,1 +1,6 @@
		### 1.0.0 (2022-08-12)

		- BREAKING: Will now create an `<internals>`module rather than a namespace to allow support for referenced default exports, #15.
		- BREAKING: Renamed `internalNamespace` option to `internalModule`

		### 0.23.0 (2022-06-26)
		@@ -2,0 +7,0 @@

index.js

		@@ -7,4 +7,4 @@ "use strict";
		app.options.addDeclaration({
		name: "internalNamespace",
		help: "Define the name of the namespace that internal symbols which are not exported should be placed into.",
		name: "internalModule",
		help: "Define the name of the module that internal symbols which are not exported should be placed into.",
		defaultValue: "<internal>",
		@@ -35,3 +35,3 @@ });
		.withScope(mod)
		.createDeclarationReflection(typedoc_1.ReflectionKind.Namespace, void 0, void 0, context.converter.application.options.getValue("internalNamespace"));
		.createDeclarationReflection(typedoc_1.ReflectionKind.Module, void 0, void 0, context.converter.application.options.getValue("internalModule"));
		context.finalizeDeclarationReflection(internalNs);
		@@ -143,3 +143,3 @@ const internalContext = context.withScope(internalNs);
		// inside something that can have properties.
		if (symbol.flags & typedoc_1.TypeScript.SymbolFlags.Property) {
		if (symbol.flags & typedoc_1.TypeScript.SymbolFlags.Property && symbol.name !== "default") {
		return false;
		@@ -146,0 +146,0 @@ }

package.json

		{
		"name": "typedoc-plugin-missing-exports",
		"version": "0.23.0",
		"version": "1.0.0",
		"description": "Include non-exported types in TypeDoc documentation",
		@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

		@@ -9,3 +9,3 @@ # typedoc-plugin-missing-exports

		For libraries which export their full exposed API, this works well, but some packages are extremely resistant to exporting everything. This plugin is for them. After TypeDoc has finished converting packages, it will look for types which are referenced, but not exported, and place them into an internal namespace for that entry point (called `<internal>` by default).
		For libraries which export their full exposed API, this works well, but some packages are extremely resistant to exporting everything. This plugin is for them. After TypeDoc has finished converting packages, it will look for types which are referenced, but not exported, and place them into an internal module for that entry point (called `<internal>` by default).

		@@ -22,3 +22,3 @@ If your project references classes which are built into the language (e.g. `HTMLElement`), this package _will_ result in those types being documented to. If you want to prevent this, set TypeDoc's `excludeExternals` option to `true`. The default pattern for determining if a symbol is external will exclude everything within `node_modules`.

		- `internalNamespace` - Define the name of the namespace that internal symbols which are not exported should be placed into.
		- `internalModule` - Define the name of the module that internal symbols which are not exported should be placed into.

		@@ -25,0 +25,0 @@ ### Additional Reading

New alerts