-
-
Notifications
You must be signed in to change notification settings - Fork 35
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
Conversation
…flow and consistency
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Reviewer's GuideThis 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 componentclassDiagram
class Footer {
+render(): JSX.Element
// rel attribute removed from external link
}
Flow diagram for new clean and update npm scriptsflowchart 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]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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>
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", |
There was a problem hiding this comment.
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.
"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", |
There was a problem hiding this comment.
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'.
"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" |
There was a problem hiding this comment.
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.
This pull request includes updates to the
README.md
,components/navigation/footer.tsx
, andpackage.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 therel="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 usingnpm-check-updates
, installs updated packages, and runs theclean
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 consistencySummary by Sourcery
Standardize README separators, simplify footer link, and enhance development workflow with new maintenance scripts and devDependency upgrades
Enhancements:
Build:
Documentation: