[Build] Babylon eslint plugin (step 1 - typedoc)

[RaananW]

As the tsdoc eslint task is not very flexible, we have to adjust it to make it work with our repository.

This PR adds 2 new rules:

1. Babylon/syntax which will notify if a comment is not formatted correctly, taking our quircks into account.
2. babylon/available - text-based codedoc inspector for methods
3. babylon/existing - typescript-based codedoc inspector.

The difference between 2 and 3 is that 3 is much (MUCH) more precise and correct, but takes a long time to run, especially in such a large repository. The 2nd step is quick but prone to errors, as it is basically a text-based parser.

Further eslint rules will be added to this package when needed.

[azure-pipelines[bot]]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s). To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[azure-pipelines[bot]]

Reviewer - this PR has made changes to one or more package.json files.

[azure-pipelines[bot]]

Snapshot stored with reference name: refs/pull/12689/merge

Test environment: https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html

To test a playground add it to the URL, for example:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html#WGZLGJ#4600

Links to test babylon tools with this snapshot:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge https://sandbox.babylonjs.com/?snapshot=refs/pull/12689/merge https://gui.babylonjs.com/?snapshot=refs/pull/12689/merge https://nme.babylonjs.com/?snapshot=refs/pull/12689/merge

To test the snapshot in the playground with a playground ID add it after the snapshot query string:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge#BCU1XR#0

[azure-pipelines[bot]]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s). To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[azure-pipelines[bot]]

Reviewer - this PR has made changes to one or more package.json files.

[azure-pipelines[bot]]

Snapshot stored with reference name: refs/pull/12689/merge

Test environment: https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html

To test a playground add it to the URL, for example:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html#WGZLGJ#4600

Links to test babylon tools with this snapshot:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge https://sandbox.babylonjs.com/?snapshot=refs/pull/12689/merge https://gui.babylonjs.com/?snapshot=refs/pull/12689/merge https://nme.babylonjs.com/?snapshot=refs/pull/12689/merge

To test the snapshot in the playground with a playground ID add it after the snapshot query string:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge#BCU1XR#0

[azure-pipelines[bot]]

Visualization tests for webgl1 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl1/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Visualization tests for webgl2 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl2/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s). To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[azure-pipelines[bot]]

Reviewer - this PR has made changes to one or more package.json files.

[azure-pipelines[bot]]

Snapshot stored with reference name: refs/pull/12689/merge

Test environment: https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html

To test a playground add it to the URL, for example:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html#WGZLGJ#4600

Links to test babylon tools with this snapshot:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge https://sandbox.babylonjs.com/?snapshot=refs/pull/12689/merge https://gui.babylonjs.com/?snapshot=refs/pull/12689/merge https://nme.babylonjs.com/?snapshot=refs/pull/12689/merge

To test the snapshot in the playground with a playground ID add it after the snapshot query string:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge#BCU1XR#0

[azure-pipelines[bot]]

Visualization tests for webgl2 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl2/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Visualization tests for webgl1 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl1/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s). To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[azure-pipelines[bot]]

Reviewer - this PR has made changes to one or more package.json files.

[azure-pipelines[bot]]

Snapshot stored with reference name: refs/pull/12689/merge

Test environment: https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html

To test a playground add it to the URL, for example:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html#WGZLGJ#4600

Links to test babylon tools with this snapshot:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge https://sandbox.babylonjs.com/?snapshot=refs/pull/12689/merge https://gui.babylonjs.com/?snapshot=refs/pull/12689/merge https://nme.babylonjs.com/?snapshot=refs/pull/12689/merge

To test the snapshot in the playground with a playground ID add it after the snapshot query string:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge#BCU1XR#0

[azure-pipelines[bot]]

Visualization tests for webgl2 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl2/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Visualization tests for webgl1 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl1/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Please make sure to label your PR with "bug", "new feature" or "breaking change" label(s). To prevent this PR from going to the changelog marked it with the "skip changelog" label.

[azure-pipelines[bot]]

Snapshot stored with reference name: refs/pull/12689/merge

Test environment: https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html

To test a playground add it to the URL, for example:

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/index.html#WGZLGJ#4600

Links to test babylon tools with this snapshot:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge https://sandbox.babylonjs.com/?snapshot=refs/pull/12689/merge https://gui.babylonjs.com/?snapshot=refs/pull/12689/merge https://nme.babylonjs.com/?snapshot=refs/pull/12689/merge

To test the snapshot in the playground with a playground ID add it after the snapshot query string:

https://playground.babylonjs.com/?snapshot=refs/pull/12689/merge#BCU1XR#0

[azure-pipelines[bot]]

Visualization tests for webgl1 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl1/index.html

If tests were successful afterwards, this report might not be available anymore.

[azure-pipelines[bot]]

Visualization tests for webgl2 have failed. If some tests failed because the snapshots do not match, the report can be found at

https://babylonsnapshots.z22.web.core.windows.net/refs/pull/12689/merge/testResults/webgl2/index.html

If tests were successful afterwards, this report might not be available anymore.

[sebavan]

@RaananW I guess we can close this one ???

[RaananW]

Closing and will open a new branch with a fix.