`registerCSS` rejects the `debug: "verbose"` it passes on, and never calls a `logger` it is given

未关闭 适合新手
#562 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 5 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
react-native, typescript

调研方向

从 src/jest/index.ts 开始,追踪 registerCSS 如何为选项指定类型并将其传递给 compileWithAutoDebug。复现用例指出 src/__tests__/native/jest-helper-options.test.ts,并给出两项检查:debug: "verbose" 应通过类型检查,提供的 logger 应收到与 compile 相同的消息。

由索引模型根据 Issue 内容生成。

描述

Before submitting a new issue
  • I tested using the latest version of the library, as the bug might be already fixed.
  • I tested using a supported version of react native.
  • I checked for possible duplicate issues, with possible answers.
Bug summary

registerCSS(css, options) in src/jest/index.ts types options as CompilerOptions & { debug?: boolean } and passes them to compileWithAutoDebug, which takes debug?: boolean | "verbose" and prints the rule log only for "verbose", so registerCSS(css, { debug: "verbose" }) fails to type-check. Both accept CompilerOptions.logger, and compileWithAutoDebug returns compile(css, { ...options, logger }), which replaces it, so a logger handed to either is never called.

The test harnesses' registerCSS(output, { debug: Boolean(debug) }), reported in #545 and nativewind/nativewind#1878, turns "verbose" into true at that call.

Library version

main at df32ce3

Environment info
System:
  OS: Windows 11 10.0.26300
  CPU: "(32) x64 AMD Ryzen 9 9950X3D 16-Core Processor          "
  Memory: 160.57 GB / 255.67 GB
Binaries:
  Node:
    version: 26.12.1
    path: C:\Program Files\nodejs\node.EXE
  Yarn:
    version: 4.9.2
    path: C:\Users\<user>\AppData\Roaming\npm\yarn.CMD
  npm:
    version: 12.2.1
    path: C:\Program Files\nodejs\npm.CMD
  Watchman: Not Found
SDKs:
  Android SDK: Not Found
  Windows SDK:
    AllowDevelopmentWithoutDevLicense: Enabled
    Versions:
      - 10.0.19041.0
      - 10.0.26100.0
IDEs:
  Android Studio: AI-262.9437.185.2621.16467767
  Visual Studio: Not Found
Languages:
  Java:
    version: 17.0.20.1
    path: C:\Program Files\Microsoft\jdk-17.0.20.101-hotspot\bin\javac.EXE
  Ruby: Not Found
npmPackages:
  "@react-native-community/cli": Not Found
  react:
    installed: 19.2.3
    wanted: 19.2.3
  react-native:
    installed: 0.86.3
    wanted: 0.86.3
  react-native-windows: Not Found
npmGlobalPackages:
  "*react-native*": Not Found
Android:
  hermesEnabled: Not found
  newArchEnabled: Not found
iOS:
  hermesEnabled: Not found
  newArchEnabled: Not found
Steps to reproduce
  1. Clone the reproducer branch, which is main at df32ce3 with one file added, src/__tests__/native/jest-helper-options.test.ts, and install:
    git clone --branch repro/jest-helper-option-types https://github.com/YevheniiKotyrlo/react-native-css
    cd react-native-css
    yarn install
    
  2. Run yarn test src/__tests__/native/jest-helper-options.test.ts.

src/__tests__/native/jest-helper-options.test.ts:

import { join } from "node:path";

import { compile } from "react-native-css/compiler";
import { registerCSS } from "react-native-css/jest";
import ts from "typescript";

const root = join(__dirname, "../../..").replaceAll("\\", "/");
const fixtureName = `${root}/src/__tests__/native/jest-helper-options.fixture.ts`;

function diagnostics(text: string): readonly string[] {
  const { config } = ts.readConfigFile(`${root}/tsconfig.json`, (path) =>
    ts.sys.readFile(path),
  );
  const { options } = ts.parseJsonConfigFileContent(config, ts.sys, root);
  const host = ts.createCompilerHost(options, true);
  const program = ts.createProgram([fixtureName], options, {
    ...host,
    getCurrentDirectory: () => root,
    fileExists: (name) => name === fixtureName || host.fileExists(name),
    readFile: (name) => (name === fixtureName ? text : host.readFile(name)),
    getSourceFile: (name, languageVersion, ...rest) =>
      name === fixtureName
        ? ts.createSourceFile(name, text, languageVersion, true)
        : host.getSourceFile(name, languageVersion, ...rest),
  });
  return ts
    .getPreEmitDiagnostics(program, program.getSourceFile(fixtureName))
    .map(({ messageText }) =>
      ts.flattenDiagnosticMessageText(messageText, "\n"),
    );
}

test('registerCSS takes the debug: "verbose" it hands compileWithAutoDebug', () => {
  expect(
    diagnostics(
      [
        `import { registerCSS } from "react-native-css/jest";`,
        `registerCSS(".a { color: red; }", { debug: "verbose" });`,
      ].join("\n"),
    ),
  ).toStrictEqual([]);
});

test("registerCSS calls the logger it is given, as compile does", () => {
  const css = ".a { color: red; }";
  const compileMessages: string[] = [];
  const registerMessages: string[] = [];

  compile(css, {
    logger: (message: string) => {
      compileMessages.push(message);
    },
  });
  registerCSS(css, {
    logger: (message: string) => {
      registerMessages.push(message);
    },
  });

  expect(registerMessages).toStrictEqual(compileMessages);
});

Expected: both cases pass: debug: "verbose" type-checks, and registerCSS's logger receives the messages compile's does.

Actual: the type check reports Type 'string' is not assignable to type 'boolean | undefined'. for debug: "verbose", and registerCSS's logger receives none of the messages compile's receives.

The run's output on main at df32ce3, Windows 11, Node 26.12.1
FAIL src/__tests__/native/jest-helper-options.test.ts (30.993 s)
  × registerCSS takes the debug: "verbose" it hands compileWithAutoDebug (2495 ms)
  × registerCSS calls the logger it is given, as compile does (27 ms)
  ● registerCSS takes the debug: "verbose" it hands compileWithAutoDebug
    expect(received).toStrictEqual(expected) // deep equality
    - Expected  - 1
    + Received  + 3
    - Array []
    + Array [
    +   "Type 'string' is not assignable to type 'boolean | undefined'.",
    + ]
  ● registerCSS calls the logger it is given, as compile does
    expect(received).toStrictEqual(expected) // deep equality
    - Expected  - 47
    + Received  +  1
    - Array [
    -   "Features {}",
    -   "Lightningcss first pass",
    -   ".a {
    -   "Lightningcss second pass",
    -   "Found 1 rules to process",
    -   "[
    -   "Exiting lightningcss",
    - ]
    + Array []
Test Suites: 1 failed, 1 total
Tests:       2 failed, 2 total
Reproducible example repository

https://github.com/YevheniiKotyrlo/react-native-css/tree/repro/jest-helper-option-types

主要语言
TypeScript
星标
166
派生
45
平均合并
10 天 1 小时
30 天内合并 PR
4

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

nativewind/react-native-css 的其他 Issue

查看 nativewind/react-native-css 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。