|
| 1 | +diff --git a/dist/generateDocgenCodeBlock.js b/dist/generateDocgenCodeBlock.js |
| 2 | +index 0993ac13e4b2aae6d24cf408d6a585b4ddeb7337..1405896291288eb1322d6c42144afd3b4fbd1abf 100644 |
| 3 | +--- a/dist/generateDocgenCodeBlock.js |
| 4 | ++++ b/dist/generateDocgenCodeBlock.js |
| 5 | +@@ -34,7 +34,7 @@ function insertTsIgnoreBeforeStatement(statement) { |
| 6 | + * ``` |
| 7 | + */ |
| 8 | + function setDisplayName(d) { |
| 9 | +- return insertTsIgnoreBeforeStatement(typescript_1.default.createExpressionStatement(typescript_1.default.createBinary(typescript_1.default.createPropertyAccess(typescript_1.default.createIdentifier(d.displayName), typescript_1.default.createIdentifier("displayName")), typescript_1.default.SyntaxKind.EqualsToken, typescript_1.default.createLiteral(d.displayName)))); |
| 10 | ++ return insertTsIgnoreBeforeStatement(typescript_1.default.factory.createExpressionStatement(typescript_1.default.factory.createBinaryExpression(typescript_1.default.factory.createPropertyAccessExpression(typescript_1.default.factory.createIdentifier(d.displayName), typescript_1.default.factory.createIdentifier("displayName")), typescript_1.default.SyntaxKind.EqualsToken, typescript_1.default.factory.createStringLiteral(d.displayName)))); |
| 11 | + } |
| 12 | + /** |
| 13 | + * Set a component prop description. |
| 14 | +@@ -65,7 +65,7 @@ function createPropDefinition(propName, prop, options) { |
| 15 | + * |
| 16 | + * @param defaultValue Default prop value or null if not set. |
| 17 | + */ |
| 18 | +- const setDefaultValue = (defaultValue) => typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral("defaultValue"), |
| 19 | ++ const setDefaultValue = (defaultValue) => typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral("defaultValue"), |
| 20 | + // Use a more extensive check on defaultValue. Sometimes the parser |
| 21 | + // returns an empty object. |
| 22 | + defaultValue !== null && |
| 23 | +@@ -75,12 +75,19 @@ function createPropDefinition(propName, prop, options) { |
| 24 | + (typeof defaultValue.value === "string" || |
| 25 | + typeof defaultValue.value === "number" || |
| 26 | + typeof defaultValue.value === "boolean") |
| 27 | +- ? typescript_1.default.createObjectLiteral([ |
| 28 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createIdentifier("value"), typescript_1.default.createLiteral(defaultValue.value)), |
| 29 | ++ ? typescript_1.default.factory.createObjectLiteralExpression([ |
| 30 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createIdentifier("value"), typeof defaultValue.value === "string" |
| 31 | ++ ? typescript_1.default.factory.createStringLiteral(defaultValue.value) |
| 32 | ++ : // eslint-disable-next-line no-nested-ternary |
| 33 | ++ typeof defaultValue.value === "number" |
| 34 | ++ ? typescript_1.default.factory.createNumericLiteral(defaultValue.value) |
| 35 | ++ : defaultValue.value |
| 36 | ++ ? typescript_1.default.factory.createTrue() |
| 37 | ++ : typescript_1.default.factory.createFalse()), |
| 38 | + ]) |
| 39 | +- : typescript_1.default.createNull()); |
| 40 | ++ : typescript_1.default.factory.createNull()); |
| 41 | + /** Set a property with a string value */ |
| 42 | +- const setStringLiteralField = (fieldName, fieldValue) => typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral(fieldName), typescript_1.default.createLiteral(fieldValue)); |
| 43 | ++ const setStringLiteralField = (fieldName, fieldValue) => typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral(fieldName), typescript_1.default.factory.createStringLiteral(fieldValue)); |
| 44 | + /** |
| 45 | + * ``` |
| 46 | + * SimpleComponent.__docgenInfo.props.someProp.description = "Prop description."; |
| 47 | +@@ -101,7 +108,7 @@ function createPropDefinition(propName, prop, options) { |
| 48 | + * ``` |
| 49 | + * @param required Whether prop is required or not. |
| 50 | + */ |
| 51 | +- const setRequired = (required) => typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral("required"), required ? typescript_1.default.createTrue() : typescript_1.default.createFalse()); |
| 52 | ++ const setRequired = (required) => typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral("required"), required ? typescript_1.default.factory.createTrue() : typescript_1.default.factory.createFalse()); |
| 53 | + /** |
| 54 | + * ``` |
| 55 | + * SimpleComponent.__docgenInfo.props.someProp.type = { |
| 56 | +@@ -113,7 +120,7 @@ function createPropDefinition(propName, prop, options) { |
| 57 | + */ |
| 58 | + const setValue = (typeValue) => Array.isArray(typeValue) && |
| 59 | + typeValue.every((value) => typeof value.value === "string") |
| 60 | +- ? typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral("value"), typescript_1.default.createArrayLiteral(typeValue.map((value) => typescript_1.default.createObjectLiteral([ |
| 61 | ++ ? typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral("value"), typescript_1.default.factory.createArrayLiteralExpression(typeValue.map((value) => typescript_1.default.factory.createObjectLiteralExpression([ |
| 62 | + setStringLiteralField("value", value.value), |
| 63 | + ])))) |
| 64 | + : undefined; |
| 65 | +@@ -130,9 +137,9 @@ function createPropDefinition(propName, prop, options) { |
| 66 | + if (valueField) { |
| 67 | + objectFields.push(valueField); |
| 68 | + } |
| 69 | +- return typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral(options.typePropName), typescript_1.default.createObjectLiteral(objectFields)); |
| 70 | ++ return typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral(options.typePropName), typescript_1.default.factory.createObjectLiteralExpression(objectFields)); |
| 71 | + }; |
| 72 | +- return typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral(propName), typescript_1.default.createObjectLiteral([ |
| 73 | ++ return typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral(propName), typescript_1.default.factory.createObjectLiteralExpression([ |
| 74 | + setDefaultValue(prop.defaultValue), |
| 75 | + setDescription(prop.description), |
| 76 | + setName(prop.name), |
| 77 | +@@ -158,10 +165,10 @@ function createPropDefinition(propName, prop, options) { |
| 78 | + * @param relativeFilename Relative file path of the component source file. |
| 79 | + */ |
| 80 | + function insertDocgenIntoGlobalCollection(d, docgenCollectionName, relativeFilename) { |
| 81 | +- return insertTsIgnoreBeforeStatement(typescript_1.default.createIf(typescript_1.default.createBinary(typescript_1.default.createTypeOf(typescript_1.default.createIdentifier(docgenCollectionName)), typescript_1.default.SyntaxKind.ExclamationEqualsEqualsToken, typescript_1.default.createLiteral("undefined")), insertTsIgnoreBeforeStatement(typescript_1.default.createStatement(typescript_1.default.createBinary(typescript_1.default.createElementAccess(typescript_1.default.createIdentifier(docgenCollectionName), typescript_1.default.createLiteral(`${relativeFilename}#${d.displayName}`)), typescript_1.default.SyntaxKind.EqualsToken, typescript_1.default.createObjectLiteral([ |
| 82 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createIdentifier("docgenInfo"), typescript_1.default.createPropertyAccess(typescript_1.default.createIdentifier(d.displayName), typescript_1.default.createIdentifier("__docgenInfo"))), |
| 83 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createIdentifier("name"), typescript_1.default.createLiteral(d.displayName)), |
| 84 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createIdentifier("path"), typescript_1.default.createLiteral(`${relativeFilename}#${d.displayName}`)), |
| 85 | ++ return insertTsIgnoreBeforeStatement(typescript_1.default.factory.createIfStatement(typescript_1.default.factory.createBinaryExpression(typescript_1.default.factory.createTypeOfExpression(typescript_1.default.factory.createIdentifier(docgenCollectionName)), typescript_1.default.SyntaxKind.ExclamationEqualsEqualsToken, typescript_1.default.factory.createStringLiteral("undefined")), insertTsIgnoreBeforeStatement(typescript_1.default.factory.createExpressionStatement(typescript_1.default.factory.createBinaryExpression(typescript_1.default.factory.createElementAccessExpression(typescript_1.default.factory.createIdentifier(docgenCollectionName), typescript_1.default.factory.createStringLiteral(`${relativeFilename}#${d.displayName}`)), typescript_1.default.SyntaxKind.EqualsToken, typescript_1.default.factory.createObjectLiteralExpression([ |
| 86 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createIdentifier("docgenInfo"), typescript_1.default.factory.createPropertyAccessExpression(typescript_1.default.factory.createIdentifier(d.displayName), typescript_1.default.factory.createIdentifier("__docgenInfo"))), |
| 87 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createIdentifier("name"), typescript_1.default.factory.createStringLiteral(d.displayName)), |
| 88 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createIdentifier("path"), typescript_1.default.factory.createStringLiteral(`${relativeFilename}#${d.displayName}`)), |
| 89 | + ])))))); |
| 90 | + } |
| 91 | + /** |
| 92 | +@@ -180,15 +187,15 @@ function insertDocgenIntoGlobalCollection(d, docgenCollectionName, relativeFilen |
| 93 | + * @param options Generator options. |
| 94 | + */ |
| 95 | + function setComponentDocGen(d, options) { |
| 96 | +- return insertTsIgnoreBeforeStatement(typescript_1.default.createStatement(typescript_1.default.createBinary( |
| 97 | ++ return insertTsIgnoreBeforeStatement(typescript_1.default.factory.createExpressionStatement(typescript_1.default.factory.createBinaryExpression( |
| 98 | + // SimpleComponent.__docgenInfo |
| 99 | +- typescript_1.default.createPropertyAccess(typescript_1.default.createIdentifier(d.displayName), typescript_1.default.createIdentifier("__docgenInfo")), typescript_1.default.SyntaxKind.EqualsToken, typescript_1.default.createObjectLiteral([ |
| 100 | ++ typescript_1.default.factory.createPropertyAccessExpression(typescript_1.default.factory.createIdentifier(d.displayName), typescript_1.default.factory.createIdentifier("__docgenInfo")), typescript_1.default.SyntaxKind.EqualsToken, typescript_1.default.factory.createObjectLiteralExpression([ |
| 101 | + // SimpleComponent.__docgenInfo.description |
| 102 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral("description"), typescript_1.default.createLiteral(d.description)), |
| 103 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral("description"), typescript_1.default.factory.createStringLiteral(d.description)), |
| 104 | + // SimpleComponent.__docgenInfo.displayName |
| 105 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral("displayName"), typescript_1.default.createLiteral(d.displayName)), |
| 106 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral("displayName"), typescript_1.default.factory.createStringLiteral(d.displayName)), |
| 107 | + // SimpleComponent.__docgenInfo.props |
| 108 | +- typescript_1.default.createPropertyAssignment(typescript_1.default.createLiteral("props"), typescript_1.default.createObjectLiteral(Object.entries(d.props).map(([propName, prop]) => createPropDefinition(propName, prop, options)))), |
| 109 | ++ typescript_1.default.factory.createPropertyAssignment(typescript_1.default.factory.createStringLiteral("props"), typescript_1.default.factory.createObjectLiteralExpression(Object.entries(d.props).map(([propName, prop]) => createPropDefinition(propName, prop, options)))), |
| 110 | + ])))); |
| 111 | + } |
| 112 | + function generateDocgenCodeBlock(options) { |
| 113 | +@@ -196,7 +203,7 @@ function generateDocgenCodeBlock(options) { |
| 114 | + const relativeFilename = path_1.default |
| 115 | + .relative("./", path_1.default.resolve("./", options.filename)) |
| 116 | + .replace(/\\/g, "/"); |
| 117 | +- const wrapInTryStatement = (statements) => typescript_1.default.createTry(typescript_1.default.createBlock(statements, true), typescript_1.default.createCatchClause(typescript_1.default.createVariableDeclaration(typescript_1.default.createIdentifier("__react_docgen_typescript_loader_error")), typescript_1.default.createBlock([])), undefined); |
| 118 | ++ const wrapInTryStatement = (statements) => typescript_1.default.factory.createTryStatement(typescript_1.default.factory.createBlock(statements, true), typescript_1.default.factory.createCatchClause(typescript_1.default.factory.createVariableDeclaration(typescript_1.default.factory.createIdentifier("__react_docgen_typescript_loader_error")), typescript_1.default.factory.createBlock([])), undefined); |
| 119 | + const codeBlocks = options.componentDocs.map((d) => wrapInTryStatement([ |
| 120 | + options.setDisplayName ? setDisplayName(d) : null, |
| 121 | + setComponentDocGen(d, options), |
| 122 | +@@ -208,7 +215,7 @@ function generateDocgenCodeBlock(options) { |
| 123 | + const printer = typescript_1.default.createPrinter({ newLine: typescript_1.default.NewLineKind.LineFeed }); |
| 124 | + const printNode = (sourceNode) => printer.printNode(typescript_1.default.EmitHint.Unspecified, sourceNode, sourceFile); |
| 125 | + // Concat original source code with code from generated code blocks. |
| 126 | +- const result = codeBlocks.reduce((acc, node) => `${acc}\n${printNode(node)}`, |
| 127 | ++ const result = codeBlocks.reduce((acc, node) => `${acc}\n${printNode(node)}`, |
| 128 | + // Use original source text rather than using printNode on the parsed form |
| 129 | + // to prevent issue where literals are stripped within components. |
| 130 | + // Ref: https://github.com/strothj/react-docgen-typescript-loader/issues/7 |
0 commit comments