Skip to content
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.

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

Can't upgrade from version 0.24 to 0.25 #2463

Closed
RebeccaStevens opened this issue Dec 23, 2023 · 1 comment
Closed

Can't upgrade from version 0.24 to 0.25 #2463

RebeccaStevens opened this issue Dec 23, 2023 · 1 comment
Labels
question Question about functionality wontfix Declining to implement

Comments

@RebeccaStevens
Copy link
Contributor

Search terms

upgrade
update
tsconfig

Question

I'm currently using version 0.24.8 in a project and everything works fine, but when I try to upgrade to 0.25.* I get a bunch of typescript errors when running typedoc. I can't figure out why this is happening.

My tsconfig file is being read but its values seem to be getting ignore as I'm getting errors like:
Property 'parseInt' does not exist on type 'NumberConstructor'. Do you need to change your target library? Try changing the 'lib' compiler option to 'es2015' or later.

Any idea what might be going wrong for me?

Here's my config details:

tsconfig
{
	"compilerOptions": {
		"declaration": true,
		"declarationMap": true,
		"esModuleInterop": true,
		"lib": ["ESNext"],
		"module": "ESNext",
		"moduleResolution": "bundler",
		"noEmit": true,
		"outDir": "lib",
		"skipLibCheck": true,
		"sourceMap": true,
		"strict": true,
		"target": "ES2021"
	},
	"include": ["src"]
}
typedoc.json
{
	"$schema": "https://typedoc.org/schema.json",
	"categoryOrder": [
		"Node Types",
		"Nodes - Type Guards",
		"Nodes - Flag Utilities",
		"Nodes - Other Utilities",
		"Modifier Utilities",
		"Scope Utilities",
		"Syntax Utilities",
		"Compiler Options",
		"*",
		"Other"
	],
	"customCss": "./docs/typedoc.css",
	"customValidation": {
		"byKind": [
			{
				"kinds": "Function",
				"tags": ["example"],
				"type": "code-only"
			}
		]
	},
	"defaultCategory": "Other",
	"entryPoints": ["./src/index.ts"],
	"exclude": ["./**/test/", "./**/*.test.*"],
	"excludeExternals": true,
	"excludeInternal": true,
	"excludeNotDocumented": false,
	"excludePrivate": true,
	"excludeProtected": true,
	"hideGenerator": true,
	"includeVersion": true,
	"kindSortOrder": [
		"Reference",
		"Project",
		"Module",
		"Namespace",
		"Constructor",
		"Property",
		"Variable",
		"Function",
		"Accessor",
		"Method",
		"Parameter",
		"Enum",
		"EnumMember",
		"Class",
		"Interface",
		"TypeAlias",
		"TypeParameter",
		"TypeLiteral",
		"CallSignature",
		"ConstructorSignature",
		"IndexSignature",
		"GetSignature",
		"SetSignature"
	],
	"out": "./docs/generated",
	"plugin": [
		"typedoc-plugin-coverage",
		"typedoc-plugin-custom-validation",
		"typedoc-plugin-konamimojisplosion",
		"typedoc-plugin-mdn-links",
		"typedoc-plugin-versions"
	],
	"readme": "./docs/index.md",
	"requiredToBeDocumented": [
		"Accessor",
		"CallSignature",
		"Class",
		"Enum",
		"Function",
		"Interface",
		"Method",
		"TypeAlias"
	]
}
@RebeccaStevens RebeccaStevens added the question Question about functionality label Dec 23, 2023
RebeccaStevens added a commit to JoshuaKGoldberg/ts-api-utils that referenced this issue Dec 23, 2023
@Gerrit0 Gerrit0 added the wontfix Declining to implement label Dec 26, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 26, 2023

This is caused by one of your plugins -- I installed your project, updated TypeDoc, and commented out the plugins I don't maintain:

		// "typedoc-plugin-custom-validation"
		// "typedoc-plugin-konamimojisplosion",
		// "typedoc-plugin-versions"

And conversion works as expected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality wontfix Declining to implement
Projects
None yet
Development

No branches or pull requests

2 participants