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

chore: fix lib-check errors in examples #3370

Merged
merged 9 commits into from
Jun 30, 2023

Conversation

haakonflatval-cognite
Copy link
Contributor

@haakonflatval-cognite haakonflatval-cognite commented Jun 12, 2023

Type of change

Chore

Jira ticket 📘

https://cognitedata.atlassian.net/browse/

Description 📝

Remove some lib check errors that have accumulated in our examples.

A recent fix in ts-loader allows us to override skipLibCheck and set it to false in examples/tsconfig.json. We have had it set to false for a while, but it has had no effect. This was fixed in ts-loader v9.4.4.

A couple of other changes have been made:

  • tsconfig.json target has been set to es6. Before, it complained about the accessor keyword introduced in the PointCloudMaterial code not too long ago.
  • Some types and dependencies have been updated (/ removed) to satisfy the picky lib check.
  • VariableWidthLine was modified so as to not expose Line2 from three examples in its types, as it was not found by reveal/examples in compile time. Still unsure of why that was.

As a side-effect of the investigation, we have a theory that Reveal no longer supports being imported as CommonJS, because of the sparse-octree dependency which is ESM only.

How has this been tested? 🔍

Test instructions ℹ️

Checklist ☑️

  • I am proud of this feature.
  • I have performed a self-review of my own code.
  • I have added PR type (Feat, Bug, Chore, Test, Docs, Style, Refactor) to the PR title.
  • I have manually tested this for different scenarios (different models, formats, devices, browsers).
  • I have commented my code in hard-to-understand areas.
  • I have made corresponding changes to the public documentation.
  • I have added unit and visuals tests to prove that my feature works to the best of my ability.
  • I have refactored the code for readability to the best of my ability.
  • I have checked that my changes do not introduce regressions in the public documentation.
  • I have outlined any known defects / lacking capabilities in the contents of this PR.
  • I have listed any remaining work that should follow this PR in the description or jira/miro/etc.
  • I have added TSDoc to any public facing changes.
  • I have added "developer documentation" in any package README.md that is related / applicable to this PR.
  • I have noted down and am currently tracking any technical debt introduced in this PR.
  • I have thoroughly thought about the architecture of this implementation.
  • I have asked peers to test this feature.

@codecov
Copy link

codecov bot commented Jun 12, 2023

Codecov Report

Merging #3370 (4ed20b0) into master (d197669) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 4ed20b0 differs from pull request most recent head 072f00e. Consider uploading reports for the commit 072f00e to get more accurate results

@@           Coverage Diff           @@
##           master    #3370   +/-   ##
=======================================
  Coverage   71.52%   71.53%           
=======================================
  Files         344      344           
  Lines       33241    33241           
  Branches     2583     2585    +2     
=======================================
+ Hits        23776    23778    +2     
+ Misses       9361     9359    -2     
  Partials      104      104           
Impacted Files Coverage Δ
.../packages/utilities/src/three/VariableWidthLine.ts 87.50% <100.00%> (ø)

... and 1 file with indirect coverage changes

@github-actions
Copy link

📙 Documentation preview is available from
https://cognitedata.github.io/reveal-docs-preview/3370/docs/next/.

@haakonflatval-cognite haakonflatval-cognite marked this pull request as ready for review June 29, 2023 14:14
@haakonflatval-cognite haakonflatval-cognite requested a review from a team as a code owner June 29, 2023 14:14
@haakonflatval-cognite haakonflatval-cognite added the slack PRs and issues with this label will be pushed to Slack label Jun 29, 2023
Copy link
Contributor

@christjt christjt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for tracking this down! LGTM!

@haakonflatval-cognite haakonflatval-cognite enabled auto-merge (squash) June 30, 2023 07:22
@haakonflatval-cognite haakonflatval-cognite merged commit 2e5b17f into master Jun 30, 2023
12 checks passed
@haakonflatval-cognite haakonflatval-cognite deleted the hflatval/fix-lib-check-errors branch June 30, 2023 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
slack PRs and issues with this label will be pushed to Slack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants