feat: exclude interface properties with the @exclude-docs annotation from ArgTypes

Author: fge-aeb

packages/angular-demo/src/app/app.component.ts

@@ -23,6 +23,7 @@ export class AppComponent {
 			amount: 5.99,
 			unit: '€',
 		},
+		hiddenProperty: '',
 	};
 
 	/**

packages/angular-demo/src/app/stories/interface.mdx

@@ -15,6 +15,20 @@ Interfaces need to be annotated with `@include-docs` for the type information to
 >
 > Add at least one **used** constant or function declaration to the file containing the interface.
 
+To exclude certain properties, annotate them with the `@exclude-docs` annotation:
+
+```typescript
+/**
+ * @include-docs Product
+ */
+export interface Product {
+	/**
+	 * @exclude-docs
+	 */
+	hiddenProperty: unknown;
+}
+```
+
 <ArgTypes of="Product" />
 
 ## Aliases

packages/angular-demo/src/app/types.ts

@@ -31,6 +31,11 @@ export interface Item {
 	description?: string;
 	size?: Size3;
 	meta?: object;
+
+	/**
+	 * @exclude-docs
+	 */
+	hiddenProperty: unknown;
 }
 
 export interface Size3 extends Size2 {

packages/storybook-webpack-angular-types-plugin/src/lib/webpack-angular-types-plugin/type-extraction/interface-type-extraction.ts

@@ -1,7 +1,7 @@
 import { EntitiesByCategory, Entity, InterfaceInformation } from '../../types';
 import { InterfaceDeclaration } from 'ts-morph';
-import { groupBy } from '../utils';
-import { collectBaseInterfaces, getJsDocsIncludeDocsAliases } from './ast-utils';
+import { EXCLUDE_DOCS_JS_DOCS_PARAM, groupBy } from '../utils';
+import { collectBaseInterfaces, getJsDocsIncludeDocsAliases, hasJsDocsTag } from './ast-utils';
 import { mapSignatureToEntity } from './signature-mappers';
 import { getterOrSetterInputExists, mergeEntities } from './utils';
 
@@ -17,6 +17,10 @@ function getInterfaceEntities(
 	const entities = new Map<string, Entity>();
 
 	for (const signature of [...properties, ...methods]) {
+		if (hasJsDocsTag(signature, EXCLUDE_DOCS_JS_DOCS_PARAM)) {
+			continue;
+		}
+
 		// do not include the property if it passes the exclusion test
 		if (propertiesToExclude?.test(signature.getName())) {
 			continue;