Gitignore page-vue-render.js files in CLI Functional Tests

[gerteck]

What is the purpose of this pull request?

• Documentation update
• Bug fix
• Feature addition or enhancement
• Code maintenance
• DevOps
• Improve developer experience
• Others, please explain:

Overview of changes:

Fixes #2623
Partially Addresses #1637 (See last bullet point)

This PR does basically 3 things.

1. Update compare.js function to skip comparison check for PageVueRenderFiles
2. Delete all .page-vue-render.js files from in expected snapshots
3. Add .page-vue-render.js to gitignores to prevent it from being commited during future updatetest

Will need help to verify correctness of changes and no unrelated changes or regressions. Thank you!

Anything you'd like to highlight/discuss:

The *.page-vue-render.js files that exist in expected snapshots for CLI functional tests have diffs that are unreadable.

This PR removes diff checking for these files (in compare.js), adds gitignore to prevent these files from being unnecessarily committed during snapshot updates and removes the associated render files from the repository.

1. Reduces bloat in expected test files for CLI snapshot testing.
2. Removes unreadable non-value adding changes to the render function during snapshot updates in relevant future PRs

Testing instructions:

Automated tests should work and pass, in particular, CLI functional tests.

Proposed commit message: (wrap lines at 72 characters)

Remove page-vue-render.js files from test

*.page-vue-render.js files that exist in expected snapshots for CLI
functional tests have diffs that are unreadable.

Remove diff checking for these files, and add gitignore to
prevent files from being unnecessarily committed.

---

Checklist: ☑️

• Updated the documentation for feature additions and enhancements
• Added tests for bug fixes or features
• Linked all related issues
• No unrelated changes

---

Reviewer checklist:

Indicate the SEMVER impact of the PR:

• Major (when you make incompatible API changes)
• Minor (when you add functionality in a backward compatible manner)
• Patch (when you make backward compatible bug fixes)

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

• To be included in the release note for any feature that is made obsolete/breaking

Give a brief explanation note about:

• what was the old feature that was made obsolete
• any replacement feature (if any), and
• how the author should modify his website to migrate from the old feature to the replacement feature (if possible).

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.84%. Comparing base (8e52d96) to head (24b41b5).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #2718    +/-   ##
========================================
  Coverage   52.84%   52.84%            
========================================
  Files         130      130            
  Lines        7162     7162            
  Branches     1572     1533    -39     
========================================
  Hits         3785     3785            
+ Misses       3222     3072   -150     
- Partials      155      305   +150     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull Request Overview

This PR streamlines CLI functional tests by removing and ignoring verbose Vue render snapshot files.

• Skip comparing *.page-vue-render.js files in compare.js
• Remove existing *.page-vue-render.js files from test expectations
• Add *.page-vue-render.js to .gitignore

Reviewed Changes

Copilot reviewed 111 out of 111 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
packages/cli/test/functional/test_site/expected/testGlyphiconInPage.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testFontAwesomeInPage.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testExternalScripts.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testEmptyFrontmatter.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testEmptyAltFrontMatter.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testDates.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testCodeBlocks.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testCenterText.page-vue-render.js	Cleared out verbose Vue render snapshot file
packages/cli/test/functional/test_site/expected/testBootstrapIconInPage.page-vue-render.js	Cleared out verbose Vue render snapshot file

Comments suppressed due to low confidence (1)

packages/cli/test/functional/test_site/expected/testGlyphiconInPage.page-vue-render.js:1

• [nitpick] Since the file has been emptied, consider deleting the file entirely instead of leaving an empty placeholder; this makes the test directory clearer.

-

[AgentHagu]

There's a minor issue with the current fix. Although *.page-vue-render.js files are correctly ignored by .gitignore and not committed, they are still generated locally whenever npm run updatetest is ran with changes to the code.

This causes npm run test to throw the following error:

The issue arises because the test comparison logic filters out *.page-vue-render.js from the actual output but not from the expected snapshot paths, which may now include these newly generated files. We can fix this by also filtering out *.page-vue-render.js from expectedPaths in case of these newly generated files.

Alternatively, we can try to prevent these files from being generated in the expected snapshot paths, but I'm not familiar with how feasible or practical this solution will be.

EDIT:
Actually, is it possible to just add *.page-vue-render.js to the TEST_BLACKLIST instead of filtering out the files specifically? That way, the files existence is still checked but the content itself is ignored so there wouldn't be any time incurred from diff.

[gerteck]

Thanks for spotting what I missed out! Indeed, on updating tests, the render files will be there and cause an error, even if not commited and gitignored.

I tested your suggested change and it works well, by excluding these render files that are generated on test update!

EDIT:
Actually, is it possible to just add *.page-vue-render.js to the TEST_BLACKLIST instead of filtering out the files specifically? That way, the files existence is still checked but the content itself is ignored so there wouldn't be any time incurred from diff.

Checking file existence could be beneficial, but my rationale for completely removing the render files existence was to lower version history bloat for these render files, as well as reduce changes shown on PR diffs when updating tests. What do you think>

Accidentally clicked close this branch

[AgentHagu]

LGTM!

This change skips any diff checks for *.page-vue-render.js files, reducing overhead during tests.

[AgentHagu]

Checking file existence could be beneficial, but my rationale for completely removing the render files existence was to lower version history bloat for these render files, as well as reduce changes shown on PR diffs when updating tests. What do you think>

I see! In that case, I think the current solution should work best for us

[github-actions]

@gerteck Each PR must have a SEMVER impact label, please remember to label the PR properly.