feat(eslint): Add new no-hardcoded-src rule
#11486
Conversation
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
slorber
changed the title
no-hardcoded-src rule
slorber
left a comment
slorber
left a comment
There was a problem hiding this comment.
Thanks
I'll review the rule/test later, but there are already things to change in this PR.
Was this PR created with AI? If so, you have to disclose it clearly.
| "scripts": { | ||
| "build": "tsc" | ||
| "build": "tsc", | ||
| "test": "jest" |
There was a problem hiding this comment.
You don't need to add that
| "@types/eslint": "^9.6.1", | ||
| "@types/jest": "^30.0.0", | ||
| "eslint-plugin-eslint-plugin": "^5.1.0", | ||
| "ts-jest": "^29.4.5" |
There was a problem hiding this comment.
You don't need to add that
| /** @type {import('ts-jest').JestConfigWithTsJest} */ | ||
| module.exports = { | ||
| preset: 'ts-jest', | ||
| testEnvironment: 'node', | ||
| testMatch: ['**/*.test.ts'], | ||
| moduleFileExtensions: ['ts', 'js'], | ||
| verbose: true, | ||
| }; |
There was a problem hiding this comment.
You don't need to add that
| return advancedPreset; | ||
| }; | ||
|
|
||
| // @ts-expect-error: TODO fix later |
There was a problem hiding this comment.
you don't need to remove that
|
|
||
| // To continue supporting `require('npm2yarn')` without the `.default` ㄟ(▔,▔)ㄏ | ||
| // TODO change to export default after migrating to ESM | ||
| // @ts-expect-error: Docusaurus v4: remove |
There was a problem hiding this comment.
you don't need to remove that
|
|
||
| import rules from './rules'; | ||
|
|
||
| // @ts-expect-error: TODO try to remove later |
There was a problem hiding this comment.
you don't need to remove that
| "incremental": true, | ||
| "tsBuildInfoFile": "${configDir}/lib/.tsbuildinfo", | ||
| "erasableSyntaxOnly": true, | ||
| //"erasableSyntaxOnly": true, |
| js-tokens "^4.0.0" | ||
| picocolors "^1.0.0" | ||
|
|
||
| "@babel/code-frame@^7.27.1": |
There was a problem hiding this comment.
you shouldn't need to change deps?
|
Hi @slorber, thank you for the detailed feedback. You are right, the pull request included many unnecessary changes. I wrote the initial implementation and tests for the no-hardcoded-src rule myself. When I ran into some build errors during the setup, I used an AI assistant to help me debug. It unfortunately introduced a lot of unrelated configuration changes, and I apologize for the messy pull request. I should have reviewed its changes more carefully. To fix this, I have closed this PR and started over with a new, clean branch. The new pull request contains only the new rule and its test file, with no other changes. Thank you again for your guidance and for helping me learn the correct process. |
2 participants
Pre-flight checklist
Motivation
This pull request adds a new ESLint rule,
no-hardcoded-src, to the@docusaurus/eslint-plugin, as proposed in issue #6472.The goal of this rule is to prevent developers from using hardcoded URLs in
srcattributes (like in<img>tags). Instead, it encourages the use ofrequire()oruseBaseUrl()so that images and assets work correctly across different base URLs and environments.Test Plan
I have added a new test suite for this rule at
packages/eslint-plugin/src/rules/__tests__/no-hardcoded-src.test.ts.The tests cover both valid cases (using
require(),useBaseUrl(), etc.) and invalid cases (using hardcoded strings), ensuring the rule works as expected.I have verified the implementation by running all tests for the package, which passed successfully.