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

Remove license comments from the UMD build #1437

Merged
merged 5 commits into from
Aug 6, 2024
Merged

Conversation

sequba
Copy link
Contributor

@sequba sequba commented Jul 23, 2024

Context

  • updated the webpack configuration to use the string-replace-loader plugin that removes all occurrences of the license comment from the UMD packages
  • added a step that verifies the number of license comments in the build to the verify:umd script that is called in the GH workflow

It reduced the size of hyperformula.min.js by 1.90% (from 527K to 517K) and hyperformula.full.min.js by 1.45% (from 691K to 681K)

How did you test your changes?

Run build manually and check the contents of files:

  • hyperformula.js
  • hyperformula.min.js
  • hyperformula.full.js
  • hyperformula.full.min.js

Types of changes

  • Breaking change (a fix or a feature because of which an existing functionality doesn't work as expected anymore)
  • New feature or improvement (a non-breaking change that adds functionality)
  • Bug fix (a non-breaking change that fixes an issue)
  • Additional language file, or a change to an existing language file (translations)
  • Change to the documentation

Related issues:

Fixes #1421

Checklist:

  • I have reviewed the guidelines about Contributing to HyperFormula and I confirm that my code follows the code style of this project.
  • I have signed the Contributor License Agreement.
  • My change is compliant with the OpenDocument standard.
  • My change is compatible with Microsoft Excel.
  • My change is compatible with Google Sheets.
  • I described my changes in the CHANGELOG.md file.
  • My changes require a documentation update.
  • My changes require a migration guide.

Copy link

github-actions bot commented Jul 23, 2024

Performance comparison of head (dc94bd9) vs base (f082027)

                                     testName |   base |   head | change
------------------------------------------------------------------------
                                      Sheet A |  525.2 | 528.39 | +0.61%
                                      Sheet B | 170.32 | 177.44 | +4.18%
                                      Sheet T | 150.95 | 155.45 | +2.98%
                                Column ranges | 528.46 | 526.99 | -0.28%
Sheet A:  change value, add/remove row/column |  16.03 |  15.19 | -5.24%
 Sheet B: change value, add/remove row/column |  141.6 | 136.72 | -3.45%
                   Column ranges - add column |  166.4 | 161.89 | -2.71%
                Column ranges - without batch |  475.2 | 469.14 | -1.28%
                        Column ranges - batch | 124.85 |  116.5 | -6.69%

Copy link

codecov bot commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.22%. Comparing base (d7ee29f) to head (59084c3).
Report is 23 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #1437      +/-   ##
===========================================
- Coverage    97.37%   97.22%   -0.16%     
===========================================
  Files          169      169              
  Lines        14428    14430       +2     
  Branches      3099     3101       +2     
===========================================
- Hits         14049    14029      -20     
- Misses         376      401      +25     
+ Partials         3        0       -3     

see 3 files with indirect coverage changes

@sequba sequba assigned evanSe and unassigned evanSe Jul 23, 2024
@sequba sequba requested a review from evanSe July 23, 2024 15:48
@sequba sequba requested review from budnix and removed request for evanSe August 6, 2024 07:15
Copy link
Member

@budnix budnix left a comment

Choose a reason for hiding this comment

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

👍

@sequba sequba merged commit 67bae9e into develop Aug 6, 2024
21 of 22 checks passed
@sequba sequba deleted the feature/issue-1421 branch August 6, 2024 14:40
sequba added a commit that referenced this pull request Nov 6, 2024
* Merge hotfix to develop (#1431)

Change publish-docs workflow to use Node 20 instead of 22 due to the temporary npm issue

* Merge hotfix to develop (#1432)

* Change publish-docs workflow to use Node 20 instead of 22 due to the temporary npm issue (#1424)

* Set NODE_OPTIONS=--openssl-legacy-provider for the typedoc command

* Merge hotfix to develop (#1433)

* Change publish-docs workflow to use Node 20 instead of 22 due to the temporary npm issue (#1424)

* Hotfix: Set NODE_OPTIONS=--openssl-legacy-provider for the typedoc command (#1425)

Set NODE_OPTIONS=--openssl-legacy-provider for the typedoc command

* Revert the publish-docs workflow to Node 16

* Add build-docs workflow (#1434)

* Add build-docs workflow

* Add environment variables necessary to build the docs with Node 20

* Use Node 20 in all the build/test workflows (#1435)

* Remove license comments from the UMD build (#1437)

* Install terser plugin explicite to enable extensive customization

* Remove license comment from the UMD builds using string-replace-loader webpack plugin

* Test for the redundant license comments in the UMD build inside the verify:umd script

* Update build badge in readme to show the build workflow status instead of test (#1443)

* Update build badge to show the build workflow status instead of test

* Native demos in the docs (#1447)

* Add markdown-it plugins

* Make HTML+CSS preview work

* Make some of the buttons work

* Add edit-in-stackblitz button

* Make the entire runtime of the demo work (including js)

* Add real HF demo.

* Make HyperFormula import work in runtime of the docs examples

* Add script code-examples-generator

* Style stackblitz button

* Style demo internal buttons

* Remove unused glue-code

* Remove not needed vuepress plugins

* Fix linter error

* Reformat demo/example1.ts file

* Add advanced-usage demo

* Change the framework demos in the docs to use Codesandbox iframe instead of Stackblitz

* Add basic-operations demo

* Add basic-usage demo

* Add batch-operations demo

* Add demo clipboard-operations

* Changed the custom-functions demo to use Codesandbox instead of Stackblitz

* Add date-time demo

* Add demo i18n

* Add localizing-functions guide

* Add named-expressions demo

* Add sorting-data demo

* Add undo-redo demo

* Fix lint errors

* Disable linter for the docs examples

* Tweak the styling of demo example

* Fix row and column counting in the docs examples

* Adjust css of basic-usage demo

* Adjust style of advanced-usage demo

* Fix styles for basic-operations demo

* Fix styles for batch-operations demo

* Fix styles for sorting demo

* Fix height of the table cell in the demos

* Adjust text decoration of the summary row in the i18n demo

* Fix styles for basic-operations demo

* Adjust styles for the inputs

* Disable logging HF version to console in the native examples embedded in the docs

* Update styles for the open-in-stackblitz button

* Fix broken favicon link

* Fix examples.js script to handle newline characters in both unix and windows styles

* Reduce space between buttons and table in the undo-redo demo

* Fix style for checkbox in the batch-operations demo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants