Files
renovate/lib/logger/with-sanitizer.ts
Sebastian Poxhofer 58771bb183 refactor(linters): enabled oxlints func-style (#44691)
* refactor(oxlint): enable func-style

Enable the built-in func-style rule as ["warn", "declaration"] so that
named functions are written as function declarations instead of arrow or
function expressions assigned to variables, matching the convention in
docs/development/best-practices.md (Functions section). Inline arrow
callbacks are unaffected; prefer-arrow-callback continues to cover the
callback direction.

Severity is "warn" instead of "error" as a fallback: a repo-wide run
found 196 pre-existing violations (70 in spec files, 126 in production
code), exceeding the 80-violation fix threshold for this change, so no
violations were fixed here. Follow-up work can convert the offenders
(largest clusters: lib/modules/versioning/ruby, lib/util/cache/package,
lib/modules/versioning/maven, lib/modules/versioning/gradle) and then
raise the rule to "error". Note oxlint 1.72 also supports an
allowTypeAnnotation option if typed consts should remain arrows.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci(linter): enforce func-style at error

* refactor(func-style): convert const-arrow functions to declarations in with-cache spec and ruby versioning

* refactor(func-style): convert const-arrow functions to declarations in maven/gradle modules

* refactor(func-style): convert const-arrow functions to declarations in remaining versioning modules

* refactor(func-style): convert const-arrow functions to declarations in platform modules

Discriminated-union closures (ensureCommentRemoval byTopic/byContent
helpers in github, gitlab, bitbucket, bitbucket-server) needed the
narrowed field passed explicitly as a parameter, since function
declarations are hoisted and lose the outer if-narrowing that inline
arrow-function closures previously relied on.

* refactor(func-style): convert const-arrow functions to declarations across util/manager/datasource modules

One case (logger/renovate-logger.ts logOnceFn) is kept as an arrow
function with a documented oxlint-disable: it is stored on
this.logger.once[level] and relies on lexically-bound this, which a
hoisted function declaration would not preserve.

* refactor(func-style): convert remaining const-arrow test helpers to declarations

get-updated.spec.ts: hoisted expectPipCompilePackageAndLockFile to
module scope (it only closes over the module-level pipCompile mock)
and added a documented oxlint-disable for vitest/expect-expect on its
caller test, since oxlint's expect-expect check does not trace
assertions through an externally-defined helper function.

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-19 11:14:22 +00:00

45 lines
1.2 KiB
TypeScript

import fs from 'fs-extra';
import { regEx } from '../util/regex.ts';
import { quickStringify } from '../util/stringify.ts';
import type { BunyanNodeStream, BunyanRecord, BunyanStream } from './types.ts';
import { sanitizeValue } from './utils.ts';
export function withSanitizer(streamConfig: BunyanStream): BunyanStream {
if (streamConfig.type === 'rotating-file') {
throw new Error("Rotating files aren't supported");
}
const stream = streamConfig.stream as BunyanNodeStream;
if (stream?.writable) {
function write(
chunk: BunyanRecord,
enc: BufferEncoding,
cb: (err?: Error | null) => void,
): void {
const raw = sanitizeValue(chunk);
const result =
streamConfig.type === 'raw'
? raw
: quickStringify(raw)?.replace(regEx(/\n?$/), '\n');
stream.write(result, enc, cb);
}
return {
...streamConfig,
type: 'raw',
stream: { write },
} as BunyanStream;
}
if (streamConfig.path) {
const fileStream = fs.createWriteStream(streamConfig.path, {
flags: 'a',
encoding: 'utf8',
});
return withSanitizer({ ...streamConfig, stream: fileStream });
}
throw new Error("Missing 'stream' or 'path' for bunyan stream");
}