Canary 12032024

[soranoo]

Deprecated HTML Entities Replacement #30
Reintroduced HTML AST Based Replace Strategy #25

Summary by CodeRabbit

• New Features
  • Improved handling of HTML obfuscation, including support for script tags, void tags, and preservation of comments.
• Bug Fixes
  • Enhanced accuracy in obfuscating class names within script content and self-closing HTML tags.
• Refactor
  • Streamlined HTML obfuscation logic for better maintainability and consistency.
• Tests
  • Added new test cases for script tags, void tags, and HTML comments; updated test argument style.
• Chores
  • Updated package version and dependencies.
  • Excluded coverage reports from npm package.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
next-css-obfuscator	✅ Ready (Inspect)	Visit Preview	Mar 14, 2024 4:24pm

[github-actions]

🎉 This PR is included in version 1.0.0-beta.1 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update introduces several changes focused on improving HTML and JavaScript class name obfuscation, test coverage, and package configuration. The obfuscateHtmlClassNames function was refactored to accept a single options object and now properly handles script tags, void tags, and comments in HTML. Related test cases were updated and expanded to validate these scenarios. The package version was incremented, and a new code coverage tool was added as a development dependency. The Jest configuration file was removed, and the .npmignore file was updated to exclude coverage reports. Deprecated HTML entity handling was commented out, and the logic for obfuscating HTML in files was streamlined.

Changes

File(s)	Change Summary
.npmignore	Added coverage directory to ignore list for npm package publishing.
jest.config.js	Removed Jest configuration file that set up TypeScript integration and test path ignores.
package.json	Bumped version from 2.2.13 to 2.2.14; added @vitest/coverage-v8 as a dev dependency.
src/handlers/html.ts	Refactored obfuscateHtmlClassNames to use an options object; improved handling of script tags, void tags, and comments; updated output reconstruction logic.
src/handlers/html.test.ts	Updated tests to use new argument style for obfuscateHtmlClassNames; added new tests for script tags, void tags, and comments; renamed and restructured some tests.
src/utils.ts	Deprecated HTML entity conversion; replaced granular HTML/script obfuscation with unified obfuscateHtmlClassNames call; improved regex for key matching; made content extraction more generic.
src/utils.test.ts	Removed a debugging console.log statement from a test.

Sequence Diagram(s)

sequenceDiagram
    participant FileProcessor
    participant obfuscateHtmlClassNames
    participant obfuscateJs

    FileProcessor->>obfuscateHtmlClassNames: Call with { html, selectorConversion, obfuscateMarkerClass, contentIgnoreRegexes }
    obfuscateHtmlClassNames->>obfuscateJs: For each <script> tag, obfuscate JS content
    obfuscateHtmlClassNames-->>FileProcessor: Return obfuscated HTML and used keys

Loading

Poem

In the warren, code grows neat and bright,
HTML and scripts now obfuscated right.
Void tags and comments, handled with care,
Coverage ignored, no clutter to share.
Tests hop along with new cases in tow—
This bunny’s proud of how these changes flow!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 956da95 and b6d71ae.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (7)

• .npmignore (1 hunks)
• jest.config.js (0 hunks)
• package.json (2 hunks)
• src/handlers/html.test.ts (8 hunks)
• src/handlers/html.ts (3 hunks)
• src/utils.test.ts (0 hunks)
• src/utils.ts (5 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

🎉 This PR is included in version 3.0.0-beta.3 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀