Skip to content

chore: update package.json scripts and dependencies for improved work… #85

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

Merged
merged 1 commit into from
Jun 17, 2025

Conversation

rubixvi
Copy link
Owner

@rubixvi rubixvi commented Jun 17, 2025

This pull request includes updates to the README.md, components/navigation/footer.tsx, and package.json files. The changes primarily focus on improving documentation formatting, modifying the footer component, and enhancing the development workflow with new scripts and dependency updates.

Documentation Formatting:

  • README.md: Replaced *** separators with --- for consistent markdown formatting across sections. This change impacts multiple areas, including the overview, features, quick start, usage, screenshots, contributing, license, and contact sections. [1] [2] [3] [4] [5] [6]

Footer Component Update:

  • components/navigation/footer.tsx: Removed the rel="noopener noreferrer" attribute from the external link in the footer component. This simplifies the link configuration while maintaining functionality.

Development Workflow Enhancements:

  • package.json: Added two new scripts:
    • clean: Runs lint fixes, formatting, and format checks in sequence.
    • update: Updates dependencies using npm-check-updates, installs updated packages, and runs the clean script.

Dependency Updates:

  • package.json: Updated several development dependencies to newer versions for improved stability and compatibility:
    • @types/node from ^24.0.1 to ^24.0.3
    • @typescript-eslint/parser from ^8.34.0 to ^8.34.1
    • eslint from ^9.28.0 to ^9.29.0
    • postcss from ^8.5.5 to ^8.5.6…flow and consistency

Summary by Sourcery

Standardize README separators, simplify footer link, and enhance development workflow with new maintenance scripts and devDependency upgrades

Enhancements:

  • Simplify footer external link by removing redundant rel attribute

Build:

  • Add clean and update scripts to streamline linting, formatting, and dependency updates
  • Upgrade devDependencies (@types/node, @typescript-eslint/parser, eslint, postcss) to patch versions for stability

Documentation:

  • Replace inconsistent markdown separators in README with consistent horizontal rules

Copy link

vercel bot commented Jun 17, 2025

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

Name Status Preview Comments Updated (UTC)
rubix-documents 🔄 Building (Inspect) Visit Preview 💬 Add feedback Jun 17, 2025 4:45am

Copy link

sourcery-ai bot commented Jun 17, 2025

Reviewer's Guide

This PR standardizes README markdown separators, simplifies the footer’s external link configuration, adds automated workflow scripts, and bumps core development dependencies to their latest patch versions.

Class diagram for updated Footer component

classDiagram
    class Footer {
        +render(): JSX.Element
        // rel attribute removed from external link
    }
Loading

Flow diagram for new clean and update npm scripts

flowchart TD
    A[Developer runs 'npm run clean'] --> B[Run lint:fix]
    B --> C[Run format]
    C --> D[Run format:check]

    E[Developer runs 'npm run update'] --> F[Run npm-check-updates -u]
    F --> G[Run npm install]
    G --> H[Run clean script]
Loading

File-Level Changes

Change Details Files
Standardize markdown separators in documentation
  • Replaced *** with --- across key README sections for consistent formatting
README.md
Simplify external link in footer component
  • Removed unnecessary rel="noopener noreferrer" attribute from the footer’s external link
components/navigation/footer.tsx
Add clean and update npm scripts for workflow automation
  • Introduced clean script to run lint fixes, formatting, and format checks
  • Introduced update script to upgrade dependencies and then run the cleaning sequence
package.json
Bump development dependencies to latest patch versions
  • Updated @types/node, @typescript-eslint/parser, eslint, and postcss to their newest patch releases
package.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@rubixvi rubixvi merged commit ec39968 into main Jun 17, 2025
4 of 5 checks passed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @rubixvi - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Missing rel attribute exposes window.opener vulnerability (link)

General comments:

  • Consider using a consistent package manager in your scripts (e.g. stick to npm or pnpm) rather than mixing both in the clean script.
  • Re-evaluate removing rel="noopener noreferrer" from external links—this could reintroduce potential security or performance issues when opening new tabs.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using a consistent package manager in your scripts (e.g. stick to npm or pnpm) rather than mixing both in the `clean` script.
- Re-evaluate removing `rel="noopener noreferrer"` from external links—this could reintroduce potential security or performance issues when opening new tabs.

## Individual Comments

### Comment 1
<location> `package.json:13` </location>
<code_context>
     "lint:fix": "npx lint . --fix --quiet",
     "format": "npx prettier --write . --log-level warn",
     "format:check": "npx prettier --check .",
+    "clean": "npm run lint:fix && npm run format && pnpm run format:check",
+    "update": "npx npm-check-updates -u && npm install && npm run clean",
     "generate-content-json": "ts-node scripts/content.ts",
</code_context>

<issue_to_address>
Inconsistent package manager usage in scripts

Please update the clean script to use only one package manager for consistency with the rest of the scripts.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    "clean": "npm run lint:fix && npm run format && pnpm run format:check",
=======
    "clean": "npm run lint:fix && npm run format && npm run format:check",
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `package.json:14` </location>
<code_context>
     "format": "npx prettier --write . --log-level warn",
     "format:check": "npx prettier --check .",
+    "clean": "npm run lint:fix && npm run format && pnpm run format:check",
+    "update": "npx npm-check-updates -u && npm install && npm run clean",
     "generate-content-json": "ts-node scripts/content.ts",
     "generate-content-json:ide": "node -r esbuild-register scripts/content.ts",
</code_context>

<issue_to_address>
Rename update script to avoid collision with built-in npm command

Using 'update' as a script name can override the default npm command, leading to confusion. Please rename it to avoid conflicts, such as 'upgrade-deps' or 'deps:update'.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
    "update": "npx npm-check-updates -u && npm install && npm run clean",
=======
    "upgrade-deps": "npx npm-check-updates -u && npm install && npm run clean",
>>>>>>> REPLACE

</suggested_fix>

### Comment 3
<location> `components/navigation/footer.tsx:23` </location>
<code_context>
               className="font-semibold"
               href="https://rubixstudios.com.au"
               target="_blank"
-              rel="noopener noreferrer"
             >
               <Image
</code_context>

<issue_to_address>
Missing rel attribute exposes window.opener vulnerability

Please add rel="noopener noreferrer" back to links with target="_blank" to prevent security risks from window.opener.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -10,6 +10,8 @@
"lint:fix": "npx lint . --fix --quiet",
"format": "npx prettier --write . --log-level warn",
"format:check": "npx prettier --check .",
"clean": "npm run lint:fix && npm run format && pnpm run format:check",
Copy link

Choose a reason for hiding this comment

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

suggestion: Inconsistent package manager usage in scripts

Please update the clean script to use only one package manager for consistency with the rest of the scripts.

Suggested change
"clean": "npm run lint:fix && npm run format && pnpm run format:check",
"clean": "npm run lint:fix && npm run format && npm run format:check",

@@ -10,6 +10,8 @@
"lint:fix": "npx lint . --fix --quiet",
"format": "npx prettier --write . --log-level warn",
"format:check": "npx prettier --check .",
"clean": "npm run lint:fix && npm run format && pnpm run format:check",
"update": "npx npm-check-updates -u && npm install && npm run clean",
Copy link

Choose a reason for hiding this comment

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

suggestion: Rename update script to avoid collision with built-in npm command

Using 'update' as a script name can override the default npm command, leading to confusion. Please rename it to avoid conflicts, such as 'upgrade-deps' or 'deps:update'.

Suggested change
"update": "npx npm-check-updates -u && npm install && npm run clean",
"upgrade-deps": "npx npm-check-updates -u && npm install && npm run clean",

@@ -20,7 +20,6 @@ export function Footer() {
className="font-semibold"
href="https://rubixstudios.com.au"
target="_blank"
rel="noopener noreferrer"
Copy link

Choose a reason for hiding this comment

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

🚨 issue (security): Missing rel attribute exposes window.opener vulnerability

Please add rel="noopener noreferrer" back to links with target="_blank" to prevent security risks from window.opener.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant