feat(injector): add component to shouldInclude (#8)

src/injector.ts

@@ -21,7 +21,11 @@ export type InjectOptions = {
 	 * use the default behaviour
 	 * @default includeUnusedProps ? true : data.usedProps.includes(data.prop.name)
 	 */
-	shouldInclude?(data: { prop: t.PropTypeNode; usedProps: string[] }): boolean | undefined;
+	shouldInclude?(data: {
+		component: t.ComponentNode;
+		prop: t.PropTypeNode;
+		usedProps: string[];
+	}): boolean | undefined;
 
 	/**
 	 * Options passed to babel.transformSync
@@ -82,7 +86,7 @@ function plugin(
 ): babel.PluginObj {
 	const { includeUnusedProps = false, removeExistingPropTypes = false, ...otherOptions } = options;
 
-	const shouldInclude: InjectOptions['shouldInclude'] = (data) => {
+	const shouldInclude: Exclude<InjectOptions['shouldInclude'], undefined> = (data) => {
 		if (options.shouldInclude) {
 			const result = options.shouldInclude(data);
 			if (result !== undefined) {
@@ -263,7 +267,7 @@ function plugin(
 		const source = generate(props, {
 			...otherOptions,
 			importedName: importName,
-			shouldInclude: (prop) => shouldInclude!({ prop, usedProps }),
+			shouldInclude: (prop) => shouldInclude({ component: props, prop, usedProps }),
 		});
 
 		if (source.length === 0) {

test/injector/should-include-component-based/input.tsx

@@ -0,0 +1,20 @@
+import * as React from 'react';
+
+export interface SnackBarProps {
+	/**
+	 * Some hints about why this is useful
+	 */
+	id?: string;
+	/**
+	 * some prop that is inherited which we don't care about here
+	 */
+	onChange?: () => void;
+}
+
+export function Snackbar(props: SnackBarProps) {
+	return <div {...props} />;
+}
+
+export function SomeOtherComponent(props: { id?: string }) {
+	return <div {...props} />;
+}

test/injector/should-include-component-based/options.ts

@@ -0,0 +1,13 @@
+import { TestOptions } from '../../types';
+
+const options: TestOptions = {
+	injector: {
+		shouldInclude({ component, prop }) {
+			if (component.name === 'Snackbar' && prop.name === 'id') {
+				return true;
+			}
+		},
+	},
+};
+
+export default options;

test/injector/should-include-component-based/output.js

@@ -0,0 +1,17 @@
+import * as React from 'react';
+import PropTypes from 'prop-types';
+function Snackbar(props) {
+	return <div {...props} />;
+}
+
+Snackbar.propTypes = {
+	/**
+	 * Some hints about why this is useful
+	 */
+	id: PropTypes.string,
+};
+
+export { Snackbar };
+export function SomeOtherComponent(props) {
+	return <div {...props} />;
+}

test/injector/should-include-component-based/output.json

@@ -0,0 +1,43 @@
+{
+	"type": "ProgramNode",
+	"body": [
+		{
+			"type": "ComponentNode",
+			"name": "Snackbar",
+			"types": [
+				{
+					"type": "PropTypeNode",
+					"name": "id",
+					"jsDoc": "Some hints about why this is useful",
+					"propType": {
+						"type": "UnionNode",
+						"types": [{ "type": "UndefinedNode" }, { "type": "StringNode" }]
+					}
+				},
+				{
+					"type": "PropTypeNode",
+					"name": "onChange",
+					"jsDoc": "some prop that is inherited which we don't care about here",
+					"propType": {
+						"type": "UnionNode",
+						"types": [{ "type": "UndefinedNode" }, { "type": "FunctionNode" }]
+					}
+				}
+			]
+		},
+		{
+			"type": "ComponentNode",
+			"name": "SomeOtherComponent",
+			"types": [
+				{
+					"type": "PropTypeNode",
+					"name": "id",
+					"propType": {
+						"type": "UnionNode",
+						"types": [{ "type": "UndefinedNode" }, { "type": "StringNode" }]
+					}
+				}
+			]
+		}
+	]
+}