Skip to content

Conversation

@shakeelmohamed
Copy link
Owner

@shakeelmohamed shakeelmohamed commented Aug 10, 2025

Summary by Sourcery

Integrate author metadata across all pages, restructure thesis page acknowledgements with a new copyright block, secure external links, and set up Playwright end-to-end testing with CI workflow while updating test/lint scripts and expanding the Alex ignore list.

New Features:

  • Add Playwright end-to-end testing setup with initial homepage test

Enhancements:

  • Add author meta tag site-wide and update super layout to include author metadata
  • Restructure thesis project page to integrate acknowledgements and add copyright section
  • Add rel="noopener noreferrer" to external links and update Midjourney diagram caption

Build:

  • Update package.json scripts to run Playwright tests and shift Alex lint to posttest

CI:

  • Add GitHub Actions workflow for running Playwright tests

Tests:

  • Add Playwright configuration file and initial test spec

Chores:

  • Expand Alex ignore list with additional terms

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 10, 2025

Reviewer's Guide

This PR globally injects author metadata, restructures the thesis acknowledgements section, refines linting rules, enhances external link security, and integrates Playwright end-to-end tests with CI configuration.

File-Level Changes

Change Details Files
Added author meta tag across all pages
  • Insert <meta name="author" content="Shakeel Mohamed"> into every HTML document
  • Update base Pug layout to include author metadata
docs/**/*.html
src/_includes/layouts/super.pug
Restructured thesis project acknowledgements
  • Convert single-column acknowledgements into two-column layout for acknowledgements and copyright
  • Remove redundant frontmatter 'thanks' and update Pug template block
docs/projects/thesis/index.html
src/projects/thesis/index.pug
Integrated Playwright testing framework and CI
  • Replace alex test command with npx playwright test in package.json
  • Add Playwright config file and example homepage spec
  • Configure GitHub Actions workflow to run Playwright tests
package.json
playwright.config.js
tests/home.spec.js
.github/workflows/playwright.yml
Extended lint ignore list in alex config
  • Add additional gendered and loaded terms to .alexrc.js ignore list
.alexrc.js
Hardened external links with security attributes
  • Add rel="noopener noreferrer" to outbound links in gradshow page
docs/gradshow/index.html
Minor content and template tweaks for Midjourney project
  • Update image caption to remove redundant 'wall graphics' text
  • Remove extraneous portfolioImg call in Pug template
docs/projects/midjourney/index.html
src/projects/midjourney/index.pug

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

@netlify
Copy link

netlify bot commented Aug 10, 2025

Deploy Preview for shakeelmohamed ready!

Name Link
🔨 Latest commit 71a0de4
🔍 Latest deploy log https://app.netlify.com/projects/shakeelmohamed/deploys/68981e885d517b0008bb703d
😎 Deploy Preview https://deploy-preview-191--shakeelmohamed.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@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 @shakeelmohamed - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Missing comma between array elements may cause a syntax error. (link)

General comments:

  • You’ve manually added tags to every page, but since you updated the super layout to include author metadata, you can remove the duplicates and rely on the shared layout.
  • There’s a missing comma between "prince-princess" and "deaf-to" in .alexrc.js that will break the config—add the comma or adjust the array formatting.
  • tests/home.spec.js still has commented-out code and a TODO; tidy up or remove unused snippets before merging.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- You’ve manually added <meta name="author"/> tags to every page, but since you updated the super layout to include author metadata, you can remove the duplicates and rely on the shared layout.
- There’s a missing comma between "prince-princess" and "deaf-to" in .alexrc.js that will break the config—add the comma or adjust the array formatting.
- tests/home.spec.js still has commented-out code and a TODO; tidy up or remove unused snippets before merging.

## Individual Comments

### Comment 1
<location> `.alexrc.js:25` </location>
<code_context>
+        "gals-man",
+        "straightforward",
+        "clearly",
+        "prince-princess"
+        "deaf-to"
     ]
 };
</code_context>

<issue_to_address>
Missing comma between array elements may cause a syntax error.

A comma is needed after 'prince-princess' to ensure valid array syntax.
</issue_to_address>

### Comment 2
<location> `playwright.config.js:76` </location>
<code_context>
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: 'npm run start',
+    url: 'http://localhost:8080',
+    reuseExistingServer: !process.env.CI,
+  },
</code_context>

<issue_to_address>
Hardcoded server port may cause issues if port changes.

If the dev server runs on a different port locally or in CI, tests will fail. Make the port configurable via an environment variable.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
  webServer: {
+    command: 'npm run start',
+    url: 'http://localhost:8080',
+    reuseExistingServer: !process.env.CI,
+  },
=======
  webServer: {
    // Use DEV_SERVER_PORT env var if set, otherwise default to 8080
    port: process.env.DEV_SERVER_PORT || 8080,
    command: `npm run start`,
    url: `http://localhost:${process.env.DEV_SERVER_PORT || 8080}`,
    reuseExistingServer: !process.env.CI,
  },
>>>>>>> REPLACE

</suggested_fix>

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.

.alexrc.js Outdated
Comment on lines 25 to 26
"prince-princess"
"deaf-to"
Copy link
Contributor

Choose a reason for hiding this comment

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

issue (bug_risk): Missing comma between array elements may cause a syntax error.

A comma is needed after 'prince-princess' to ensure valid array syntax.

Comment on lines +75 to +79
webServer: {
command: 'npm run start',
url: 'http://localhost:8080',
reuseExistingServer: !process.env.CI,
},
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Hardcoded server port may cause issues if port changes.

If the dev server runs on a different port locally or in CI, tests will fail. Make the port configurable via an environment variable.

Suggested change
webServer: {
command: 'npm run start',
url: 'http://localhost:8080',
reuseExistingServer: !process.env.CI,
},
webServer: {
// Use DEV_SERVER_PORT env var if set, otherwise default to 8080
port: process.env.DEV_SERVER_PORT || 8080,
command: `npm run start`,
url: `http://localhost:${process.env.DEV_SERVER_PORT || 8080}`,
reuseExistingServer: !process.env.CI,
},

@shakeelmohamed shakeelmohamed merged commit 842b14a into main Aug 10, 2025
6 checks passed
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.

2 participants