Improve obsolete attribute detection

[j9t]

Summary by CodeRabbit

• New Features

  • Updated the regular expression for identifying obsolete HTML attributes, enhancing detection accuracy.

• Bug Fixes

  • Improved robustness in the detection of obsolete attributes, addressing previously missed cases.

• Documentation

  • Added @AndrewMac to the acknowledgments section in the README.md, recognizing contributions to the project.

• Chores

  • Incremented package version from 1.6.0 to 1.6.2 in package.json, indicating minor improvements.

[coderabbitai]

Walkthrough

This update primarily includes enhancements to the ObsoHTML project, notably improving the detection of obsolete HTML attributes through regex adjustments, adding a table structure in the test cases for more robust validations, and updating the project version in the package manifest. Additionally, the acknowledgments section of the README has been modified to recognize a new contributor.

Changes

File	Change Summary
README.md	Added @AndrewMac to the acknowledgments section.
bin/obsohtml.js	Enhanced regex in findObsolete function to better detect obsolete attributes without explicit values.
bin/obsohtml.test.js	Updated test file to include a new <table> element in the temporary HTML output for improved testing.
package.json	Version updated from 1.6.0 to 1.6.2, indicating minor improvements or bug fixes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ObsoHTML
    participant TestRunner

    User->>ObsoHTML: Scan HTML
    ObsoHTML->>ObsoHTML: Identify attributes
    ObsoHTML->>User: Return obsolete attributes
    User->>TestRunner: Validate HTML structure
    TestRunner->>ObsoHTML: Test with new table structure
    ObsoHTML->>TestRunner: Output results

Loading

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

README.md (1)

85-85: Consider rephrasing for clarity and style.

The phrase "for helping to make ObsoHTML better" can be improved for clarity. Consider rephrasing it to something like "for their contributions to improving ObsoHTML."

- Thanks to @mattbrundage, @FabianBeiner, and @AndrewMac for helping to make ObsoHTML better!
+ Thanks to @mattbrundage, @FabianBeiner, and @AndrewMac for their contributions to improving ObsoHTML!

Tools

LanguageTool

[style] ~85-~85: The wording of this phrase can be improved.
Context: ...anBeiner, and @AndrewMac for helping to make ObsoHTML better!

(MAKE_STYLE_BETTER)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d8574de and b33b690.

Files ignored due to path filters (1)

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

Files selected for processing (4)

• README.md (1 hunks)
• bin/obsohtml.js (1 hunks)
• bin/obsohtml.test.js (1 hunks)
• package.json (1 hunks)

Files skipped from review due to trivial changes (1)

• package.json

Additional context used

LanguageTool

README.md

[style] ~85-~85: The wording of this phrase can be improved.
Context: ...anBeiner, and @AndrewMac for helping to make ObsoHTML better!

(MAKE_STYLE_BETTER)

Additional comments not posted (2)

bin/obsohtml.test.js (1)

19-19: Test enhancement with table element.

The addition of a <table> element with a <tr> and <th> tag in the test file enhances the coverage for detecting obsolete attributes within table elements. Ensure that the test cases are updated to validate this scenario.

bin/obsohtml.js (1)

37-37: Improved regex for attribute detection.

The updated regex pattern for detecting obsolete attributes enhances the robustness by allowing for optional whitespace and accommodating attributes without explicit values. This change should improve the accuracy of attribute detection.