mirror of
https://github.com/renovatebot/renovate.git
synced 2026-11-06 20:20:44 +00:00
Sebastian Poxhofer
00043d193e
* ci(linter): add renovate/codeblock-in-spec-fixtures rule Add a custom oxlint rule that requires the codeBlock (or stripIndent) template helper from common-tags for multi-line string fixtures in spec files (enabled for **/*.spec.ts and test/** only). The rule only flags shapes whose value can round-trip through the common-tags helpers unchanged, since both codeBlock and stripIndent trim the end result and strip the shortest line indentation: - only literals spanning multiple source lines are flagged (escaped \n one-liners are left alone: tagging them is not value-preserving in general and gains nothing) - values with leading/trailing whitespace (e.g. fixtures ending in a newline) are not flagged - tagged templates, describe/it titles, and inline snapshot arguments are skipped All 55 pre-existing violations (22 files) were fixed with a one-off codemod that re-emits each fixture indented to the statement depth and verifies value preservation by evaluating codeBlock on the rewritten template (substitutions kept as opaque placeholders). One site (pip_requirements/artifacts.spec.ts) mixes line continuations with escaped newlines and was tagged verbatim instead of re-indented. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * ci(linter): address review findings Make getSimpleRequirementsFile in pip-compile/extract.spec.ts value-preserving again: tagging the whole template with codeBlock trimmed the trailing blank line when deps is empty (the headerOnly.txt case), silently changing the fixture from ending in '#\n\n' to '#'. Tag only the static header and append the deps section via a single-line template, which reproduces the original string exactly for both empty and non-empty deps (verified by executing old vs new in node). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Datasources
Datasources are used in Renovate primarily to fetch released versions of packages.
Follow the class-based programming style
New datasources must follow the class-based programming style.
Use the java-version datasource as a reference.
Add the datasource to the API in api.ts so that the new datasource is usable.
If you find Unused HTTP mocks errors in the Vitest tests and your mocked URLs are correct, make sure the datasource is correctly registered.
getReleases
The minimum exported interface for a datasource is a function called getReleases that takes a lookup config as input.
The config has:
packageName: the package's full name including scope if present (e.g.@foo/bar)registryUrls: an array of registry URLs to try
getReleases should return an object having:
releases: an array of strings of matched versions. This is the only mandatory fielddeprecationMessage: a string description of the package's deprecation notice, if applicablesourceUrl: a HTTP URL pointing to the source code (for example on GitHub)homepage: a HTTP URL for the package's homepage. Ideally should be empty if the homepage andsourceUrlare the samechangelogUrl: a URL pointing to the package's changelog (could be a Markdown file, for example). If not present then Renovate will search thesourceUrlfor a changelog filetags: an object mapping tag → version, for exampletags: { latest: '3.0.0' }. This is only used by thefollowTagsfunction
getDigest
Datasources that support digests (like Docker digests and Git commit hashes) can export a getDigest function.
The getDigest function has two inputs:
config: the Renovate config for the package being updated, has the same fields asgetReleasesnewValue: the version or value to retrieve the digest for
The getDigest function returns a string output representing the digest value.
If no digest is found, the getDigest function should return null.