Skip to content

update typescript and fix deprecation warnings #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open

update typescript and fix deprecation warnings #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d04e95
update typescript and fix deprecation warnings
onigoetz Nov 25, 2022
b49e4d3
bump node versions
ndelangen Jun 13, 2023
c56b72d
Merge branch 'next' into next
ndelangen Jun 13, 2023
7708734
Merge pull request #8 from onigoetz/next
ndelangen Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [16.x]

steps:
- uses: actions/checkout@v1
- name: Use Node.js 16.x
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@
"react": "^17.0.1",
"ts-jest": "^26.5.6",
"ts-loader": "^9.1.2",
"typescript": "3.8.3",
"typescript": "4.9.3",
"webpack": "^5.36.2",
"webpack-cli": "^4.7.0",
"yarn-add-no-save": "^1.0.3"
},
"peerDependencies": {
"typescript": ">= 3.x",
"typescript": ">= 4.x",
"webpack": ">= 4"
},
"lint-staged": {
Expand Down
4 changes: 2 additions & 2 deletions src/__tests__/__snapshots__/generateDocgenCodeBlock.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ try {
// @ts-ignore
DefaultPropValueComponent.displayName = \\"DefaultPropValueComponent\\";
// @ts-ignore
DefaultPropValueComponent.__docgenInfo = { \\"description\\": \\"Component with a prop with a default value.\\", \\"displayName\\": \\"DefaultPropValueComponent\\", \\"props\\": { \\"color\\": { \\"defaultValue\\": null, \\"description\\": \\"Button color.\\", \\"name\\": \\"color\\", \\"required\\": true, \\"type\\": { \\"name\\": \\"\\\\\\"blue\\\\\\" | \\\\\\"green\\\\\\"\\" } }, \\"counter\\": { \\"defaultValue\\": { value: 123 }, \\"description\\": \\"Button counter.\\", \\"name\\": \\"counter\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"number\\" } }, \\"disabled\\": { \\"defaultValue\\": { value: false }, \\"description\\": \\"Button disabled.\\", \\"name\\": \\"disabled\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"boolean\\" } } } };
DefaultPropValueComponent.__docgenInfo = { \\"description\\": \\"Component with a prop with a default value.\\", \\"displayName\\": \\"DefaultPropValueComponent\\", \\"props\\": { \\"color\\": { \\"defaultValue\\": { value: \\"blue\\" }, \\"description\\": \\"Button color.\\", \\"name\\": \\"color\\", \\"required\\": true, \\"type\\": { \\"name\\": \\"\\\\\\"blue\\\\\\" | \\\\\\"green\\\\\\"\\" } }, \\"counter\\": { \\"defaultValue\\": { value: 123 }, \\"description\\": \\"Button counter.\\", \\"name\\": \\"counter\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"number\\" } }, \\"disabled\\": { \\"defaultValue\\": { value: false }, \\"description\\": \\"Button disabled.\\", \\"name\\": \\"disabled\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"boolean\\" } } } };
}
catch (__react_docgen_typescript_loader_error) { }"
`;
Expand Down Expand Up @@ -273,7 +273,7 @@ try {
// @ts-ignore
DefaultPropValueComponent.displayName = \\"DefaultPropValueComponent\\";
// @ts-ignore
DefaultPropValueComponent.__docgenInfo = { \\"description\\": \\"Component with a prop with a default value.\\", \\"displayName\\": \\"DefaultPropValueComponent\\", \\"props\\": { \\"color\\": { \\"defaultValue\\": null, \\"description\\": \\"Button color.\\", \\"name\\": \\"color\\", \\"required\\": true, \\"type\\": { \\"name\\": \\"enum\\", \\"value\\": [{ \\"value\\": \\"\\\\\\"blue\\\\\\"\\" }, { \\"value\\": \\"\\\\\\"green\\\\\\"\\" }] } }, \\"counter\\": { \\"defaultValue\\": { value: 123 }, \\"description\\": \\"Button counter.\\", \\"name\\": \\"counter\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"number\\" } }, \\"disabled\\": { \\"defaultValue\\": { value: false }, \\"description\\": \\"Button disabled.\\", \\"name\\": \\"disabled\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"boolean\\" } } } };
DefaultPropValueComponent.__docgenInfo = { \\"description\\": \\"Component with a prop with a default value.\\", \\"displayName\\": \\"DefaultPropValueComponent\\", \\"props\\": { \\"color\\": { \\"defaultValue\\": { value: \\"blue\\" }, \\"description\\": \\"Button color.\\", \\"name\\": \\"color\\", \\"required\\": true, \\"type\\": { \\"name\\": \\"enum\\", \\"value\\": [{ \\"value\\": \\"\\\\\\"blue\\\\\\"\\" }, { \\"value\\": \\"\\\\\\"green\\\\\\"\\" }] } }, \\"counter\\": { \\"defaultValue\\": { value: 123 }, \\"description\\": \\"Button counter.\\", \\"name\\": \\"counter\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"number\\" } }, \\"disabled\\": { \\"defaultValue\\": { value: false }, \\"description\\": \\"Button disabled.\\", \\"name\\": \\"disabled\\", \\"required\\": false, \\"type\\": { \\"name\\": \\"boolean\\" } } } };
}
catch (__react_docgen_typescript_loader_error) { }"
`;
2 changes: 1 addition & 1 deletion src/dependency.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class DocGenTemplate extends NullDependency.Template
}

// eslint-disable-next-line
// @ts-ignore TODO: How to type this correctly?
// @ts-expect-error TODO: How to type this correctly?
DocGenDependency.Template = DocGenTemplate;

// Default imports are tricky with CommonJS
Expand Down
150 changes: 79 additions & 71 deletions src/generateDocgenCodeBlock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ function insertTsIgnoreBeforeStatement(statement: ts.Statement): ts.Statement {
*/
function setDisplayName(d: ComponentDoc): ts.Statement {
return insertTsIgnoreBeforeStatement(
ts.createExpressionStatement(
ts.createBinary(
ts.createPropertyAccess(
ts.createIdentifier(d.displayName),
ts.createIdentifier("displayName")
ts.factory.createExpressionStatement(
ts.factory.createBinaryExpression(
ts.factory.createPropertyAccessExpression(
ts.factory.createIdentifier(d.displayName),
ts.factory.createIdentifier("displayName")
),
ts.SyntaxKind.EqualsToken,
ts.createLiteral(d.displayName)
ts.factory.createStringLiteral(d.displayName)
)
)
);
Expand Down Expand Up @@ -93,8 +93,8 @@ function createPropDefinition(
const setDefaultValue = (
defaultValue: { value: string | number | boolean } | null
) =>
ts.createPropertyAssignment(
ts.createLiteral("defaultValue"),
ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral("defaultValue"),
// Use a more extensive check on defaultValue. Sometimes the parser
// returns an empty object.
defaultValue !== null &&
Expand All @@ -104,20 +104,28 @@ function createPropDefinition(
(typeof defaultValue.value === "string" ||
typeof defaultValue.value === "number" ||
typeof defaultValue.value === "boolean")
? ts.createObjectLiteral([
ts.createPropertyAssignment(
ts.createIdentifier("value"),
ts.createLiteral(defaultValue.value)
? ts.factory.createObjectLiteralExpression([
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier("value"),
// eslint-disable-next-line no-nested-ternary
typeof defaultValue.value === "string"
? ts.factory.createStringLiteral(defaultValue.value)
: // eslint-disable-next-line no-nested-ternary
typeof defaultValue.value === "number"
? ts.factory.createNumericLiteral(defaultValue.value)
: defaultValue.value
? ts.factory.createTrue()
: ts.factory.createFalse()
),
])
: ts.createNull()
: ts.factory.createNull()
);

/** Set a property with a string value */
const setStringLiteralField = (fieldName: string, fieldValue: string) =>
ts.createPropertyAssignment(
ts.createLiteral(fieldName),
ts.createLiteral(fieldValue)
ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral(fieldName),
ts.factory.createStringLiteral(fieldValue)
);

/**
Expand All @@ -144,9 +152,9 @@ function createPropDefinition(
* @param required Whether prop is required or not.
*/
const setRequired = (required: boolean) =>
ts.createPropertyAssignment(
ts.createLiteral("required"),
required ? ts.createTrue() : ts.createFalse()
ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral("required"),
required ? ts.factory.createTrue() : ts.factory.createFalse()
);

/**
Expand All @@ -161,11 +169,11 @@ function createPropDefinition(
const setValue = (typeValue?: any[]) =>
Array.isArray(typeValue) &&
typeValue.every((value) => typeof value.value === "string")
? ts.createPropertyAssignment(
ts.createLiteral("value"),
ts.createArrayLiteral(
? ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral("value"),
ts.factory.createArrayLiteralExpression(
typeValue.map((value) =>
ts.createObjectLiteral([
ts.factory.createObjectLiteralExpression([
setStringLiteralField("value", value.value),
])
)
Expand All @@ -188,15 +196,15 @@ function createPropDefinition(
objectFields.push(valueField);
}

return ts.createPropertyAssignment(
ts.createLiteral(options.typePropName),
ts.createObjectLiteral(objectFields)
return ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral(options.typePropName),
ts.factory.createObjectLiteralExpression(objectFields)
);
};

return ts.createPropertyAssignment(
ts.createLiteral(propName),
ts.createObjectLiteral([
return ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral(propName),
ts.factory.createObjectLiteralExpression([
setDefaultValue(prop.defaultValue),
setDescription(prop.description),
setName(prop.name),
Expand Down Expand Up @@ -229,35 +237,35 @@ function insertDocgenIntoGlobalCollection(
relativeFilename: string
): ts.Statement {
return insertTsIgnoreBeforeStatement(
ts.createIf(
ts.createBinary(
ts.createTypeOf(ts.createIdentifier(docgenCollectionName)),
ts.factory.createIfStatement(
ts.factory.createBinaryExpression(
ts.factory.createTypeOfExpression(ts.factory.createIdentifier(docgenCollectionName)),
ts.SyntaxKind.ExclamationEqualsEqualsToken,
ts.createLiteral("undefined")
ts.factory.createStringLiteral("undefined")
),
insertTsIgnoreBeforeStatement(
ts.createStatement(
ts.createBinary(
ts.createElementAccess(
ts.createIdentifier(docgenCollectionName),
ts.createLiteral(`${relativeFilename}#${d.displayName}`)
ts.factory.createExpressionStatement(
ts.factory.createBinaryExpression(
ts.factory.createElementAccessExpression(
ts.factory.createIdentifier(docgenCollectionName),
ts.factory.createStringLiteral(`${relativeFilename}#${d.displayName}`)
),
ts.SyntaxKind.EqualsToken,
ts.createObjectLiteral([
ts.createPropertyAssignment(
ts.createIdentifier("docgenInfo"),
ts.createPropertyAccess(
ts.createIdentifier(d.displayName),
ts.createIdentifier("__docgenInfo")
ts.factory.createObjectLiteralExpression([
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier("docgenInfo"),
ts.factory.createPropertyAccessExpression(
ts.factory.createIdentifier(d.displayName),
ts.factory.createIdentifier("__docgenInfo")
)
),
ts.createPropertyAssignment(
ts.createIdentifier("name"),
ts.createLiteral(d.displayName)
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier("name"),
ts.factory.createStringLiteral(d.displayName)
),
ts.createPropertyAssignment(
ts.createIdentifier("path"),
ts.createLiteral(`${relativeFilename}#${d.displayName}`)
ts.factory.createPropertyAssignment(
ts.factory.createIdentifier("path"),
ts.factory.createStringLiteral(`${relativeFilename}#${d.displayName}`)
),
])
)
Expand Down Expand Up @@ -287,29 +295,29 @@ function setComponentDocGen(
options: GeneratorOptions
): ts.Statement {
return insertTsIgnoreBeforeStatement(
ts.createStatement(
ts.createBinary(
ts.factory.createExpressionStatement(
ts.factory.createBinaryExpression(
// SimpleComponent.__docgenInfo
ts.createPropertyAccess(
ts.createIdentifier(d.displayName),
ts.createIdentifier("__docgenInfo")
ts.factory.createPropertyAccessExpression(
ts.factory.createIdentifier(d.displayName),
ts.factory.createIdentifier("__docgenInfo")
),
ts.SyntaxKind.EqualsToken,
ts.createObjectLiteral([
ts.factory.createObjectLiteralExpression([
// SimpleComponent.__docgenInfo.description
ts.createPropertyAssignment(
ts.createLiteral("description"),
ts.createLiteral(d.description)
ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral("description"),
ts.factory.createStringLiteral(d.description)
),
// SimpleComponent.__docgenInfo.displayName
ts.createPropertyAssignment(
ts.createLiteral("displayName"),
ts.createLiteral(d.displayName)
ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral("displayName"),
ts.factory.createStringLiteral(d.displayName)
),
// SimpleComponent.__docgenInfo.props
ts.createPropertyAssignment(
ts.createLiteral("props"),
ts.createObjectLiteral(
ts.factory.createPropertyAssignment(
ts.factory.createStringLiteral("props"),
ts.factory.createObjectLiteralExpression(
Object.entries(d.props).map(([propName, prop]) =>
createPropDefinition(propName, prop, options)
)
Expand All @@ -333,13 +341,13 @@ export function generateDocgenCodeBlock(options: GeneratorOptions): string {
.replace(/\\/g, "/");

const wrapInTryStatement = (statements: ts.Statement[]): ts.TryStatement =>
ts.createTry(
ts.createBlock(statements, true),
ts.createCatchClause(
ts.createVariableDeclaration(
ts.createIdentifier("__react_docgen_typescript_loader_error")
ts.factory.createTryStatement(
ts.factory.createBlock(statements, true),
ts.factory.createCatchClause(
ts.factory.createVariableDeclaration(
ts.factory.createIdentifier("__react_docgen_typescript_loader_error")
),
ts.createBlock([])
ts.factory.createBlock([])
),
undefined
);
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6180,10 +6180,10 @@ typescript-memoize@^1.0.0-alpha.3:
dependencies:
core-js "2.4.1"

typescript@3.8.3:
version "3.8.3"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.8.3.tgz#409eb8544ea0335711205869ec458ab109ee1061"
integrity sha512-MYlEfn5VrLNsgudQTVJeNaQFUAI7DkhnOjdpAp4T+ku1TfQClewlbSuTVHiA+8skNBgaf02TL/kLOvig4y3G8w==
typescript@4.9.3:
version "4.9.3"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.3.tgz#3aea307c1746b8c384435d8ac36b8a2e580d85db"
integrity sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==

typical@^4.0.0:
version "4.0.0"
Expand Down