[MYFACES-4567] JavaScript Doc Errors For New Scripts

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 4.0.0-RC5
• Fix Version/s: 4.0.0
• Component/s: General
• Assignee: Werner Punz
• Reporter: Volodymyr Siedlecki
• Created: 16/Feb/23 20:40
• Updated: 02/Mar/23 00:57
• Resolved: 28/Feb/23 15:07

Description

[INFO] [ERROR] Failed to execute goal org.codehaus.mojo:dependency-maven-plugin:1.0:copy (copy-jsdoc) on project myfaces-core-assembly: Unable to find artifact.: Could not find artifact org.apache.myfaces.core:myfaces-api:jar:jsdoc:4.0.0-RC5 in central (
https://repo.maven.apache.org/maven2
)

Running, 'mvn clean install -PgenerateJsDoc' produced these errors:

[INFO] — frontend-maven-plugin:1.12.1:npm (npm run build) @ myfaces-api —
[INFO] Running 'npm run doc' in /Users/volosied/opensource/myfaces/api/src/client
[INFO]
[INFO] > myfaces.faces.ajax@1.0.0 doc
[INFO] > npx typedoc --tsconfig typescript/faces/tsconfig-typedoc.json
[INFO]
[INFO] error TS2318: Cannot find global type 'Boolean'.
[INFO]
[INFO] error TS2318: Cannot find global type 'Function'.
[INFO]
[INFO] error TS2318: Cannot find global type 'Number'.
[INFO]
[INFO] error TS2318: Cannot find global type 'RegExp'.
[INFO]
[INFO] typescript/faces/api/_api.ts:108:21 - error TS2339: Property 'match' does not exist on type '"#{facesContext.namingContainerSeparatorChar}"'.
[INFO]
[INFO] 108 return (sep.match(/#
{facesContext.namingContainerSeparatorChar}/gi)) ? Implementation.getSeparatorChar() : sep;
[INFO] ~~~~~
[INFO]
[INFO] typescript/faces/api/_api.ts:192:62 - error TS2304: Cannot find name 'Function'.
[INFO]
[INFO] 192 export function chain(source, event, ...funcs: Array<Function | string>): boolean {
[INFO] ~~~~~~~~
[INFO]
[INFO] typescript/faces/api/_api.ts:212:29 - error TS2304: Cannot find name 'Function'.
[INFO]
[INFO] 212 onopen: Function,
[INFO] ~~~~~~~~
[INFO]
[INFO] typescript/faces/api/_api.ts:213:32 - error TS2304: Cannot find name 'Function'.
[INFO]
[INFO] 213 onmessage: Function,
[INFO] ~~~~~~~~
[INFO]
[INFO] typescript/faces/api/_api.ts:214:30 - error TS2304: Cannot find name 'Function'.
[INFO]
[INFO] 214 onerror: Function,
[INFO] ~~~~~~~~
[INFO]
[INFO] typescript/faces/api/_api.ts:215:30 - error TS2304: Cannot find name 'Function'.
[INFO]
[INFO] 215 onclose: Function,
[INFO] ~~~~~~~~
[INFO]
[INFO] typescript/faces/api/faces.ts:33:19 - error TS2580: Cannot find name 'require'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node`.
[INFO]
[INFO] 33 const faces = require("./_api").faces;
[INFO] ~~~~~~~
[INFO]
[INFO] typescript/faces/api/faces.ts:37:21 - error TS2580: Cannot find name 'require'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node`.
[INFO]
[INFO] 37 const myfaces = require("./_api").myfaces;
[INFO] ~~~~~~~
[INFO]
[INFO] typescript/faces/api/faces.ts:41:5 - error TS2693: 'Object' only refers to a type, but is being used as a value here.
[INFO]
[INFO] 41 Object.keys(myfaces).forEach(key => window.myfaces[key] = window.myfaces?.[key] ?? myfaces[key]);
[INFO] ~~~~~~
[INFO]
[INFO] typescript/faces/api/jsf.ts:25:19 - error TS2580: Cannot find name 'require'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node`.
[INFO]
[INFO] 25 const faces = require("./_api").faces;
[INFO] ~~~~~~~
[INFO]
[INFO] typescript/faces/api/jsf.ts:38:32 - error TS2304: Cannot find name 'Function'.
[INFO]
[INFO] 38 onopen: Function,
[INFO] ~~~~~~~~
[INFO]
...
a lot more
...
[INFO] 85 (<any>global).XMLHttpRequest = window.XMLHttpRequest = this.xhr.restore();
[INFO] ~~~~~~
[INFO]
[INFO] typescript/faces/test/xhrCore/XhrFormDataTest.spec.ts:104:9 - error TS2304: Cannot find name 'global'.
[INFO]
[INFO] 104 global.debugf2 = true;
[INFO] ~~~~~~
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 24.280 s
[INFO] Finished at: 2023-02-16T14:39:06-05:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal com.github.eirslett:frontend-maven-plugin:1.12.1:npm (npm run build) on project myfaces-api: Failed to run task: 'npm run doc' failed. org.apache.commons.exec.ExecuteException: Process exited with an error: 3 (Exit value: 3) -> [Help 1]

POM:
https://github.com/apache/myfaces/blob/main/api/pom.xml#L379

Issue Links

• links to: GitHub Pull Request #526