Add path logger

[mattstyles]

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Adds debug logging to rs-compiler based on the value of the environment variable STYLEX_DEBUG. If this env variable does not exist (or does not match the log levels below) then no log information will be output (same behaviour as now).

Log levels supported:

• error
• warn
• info
• debug

I have only added a few log instances to rs-compiler as I'm not sure on which areas are going to be most valuable.

Logs in this diff show which files are being traversed, and provides information on the resolved import path from the list of potential valid import paths.

Additional Info

I've added an info log and some debug logs regarding pathing of stylex imports.

$ STYLEX_DEBUG=debug pnpm run build

INFO stylex_compiler_rs                               > Transforming source file: /Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/app/Counter.tsx
INFO stylex_compiler_rs                               > Transforming source file: /Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/app/globalTokens.stylex.ts
INFO stylex_compiler_rs                               > Transforming source file: /Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/components/Card.tsx
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/globalTokens.stylex", "node_modules/@/app/globalTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/globalTokens.stylex"] for import `@/app/globalTokens.stylex`
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/globalTokens.stylex", "node_modules/@/app/globalTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/globalTokens.stylex"] for import `@/app/globalTokens.stylex`
DEBUG stylex_shared::shared::structures::state_manager > Resolved import path: app/globalTokens.stylex.ts
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/globalTokens.stylex", "node_modules/@/app/globalTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/globalTokens.stylex"] for import `@/app/globalTokens.stylex`
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/globalTokens.stylex", "node_modules/@/app/globalTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/globalTokens.stylex"] for import `@/app/globalTokens.stylex`
DEBUG stylex_shared::shared::structures::state_manager > Resolved import path: app/globalTokens.stylex.ts
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/CardTokens.stylex", "node_modules/@/app/CardTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/CardTokens.stylex"] for import `@/app/CardTokens.stylex`
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/CardTokens.stylex", "node_modules/@/app/CardTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/CardTokens.stylex"] for import `@/app/CardTokens.stylex`
DEBUG stylex_shared::shared::structures::state_manager > Resolved import path: app/CardTokens.stylex.ts
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["node_modules/@stylexjs/open-props/lib/colors.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@stylexjs/open-props/lib/colors.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@stylexjs/open-props/lib/colors.stylex.js", "node_modules/@stylexjs/open-props/lib/colors.stylex.js"] for import `@stylexjs/open-props/lib/colors.stylex`
DEBUG stylex_shared::shared::structures::state_manager > Resolved import path: /Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@stylexjs/open-props/lib/colors.stylex.js
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/globalTokens.stylex", "node_modules/@/app/globalTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/globalTokens.stylex"] for import `@/app/globalTokens.stylex`
DEBUG stylex_path_resolver::resolvers                  > Resolved potential paths: ["app/globalTokens.stylex", "node_modules/@/app/globalTokens.stylex", "/Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/apps/nextjs-postcss-example/node_modules/@/app/globalTokens.stylex"] for import `@/app/globalTokens.stylex`
DEBUG stylex_shared::shared::structures::state_manager > Resolved import path: app/globalTokens.stylex.ts
INFO stylex_compiler_rs                               > Transforming source file: /Users/mattstyles/projects/third-party/forks/stylex-swc-plugin/node_modules/.pnpm/@stylexjs+stylex@0.10.1/node_modules/@stylexjs/stylex/lib/es/stylex.mjs

Type of change

Please select options that are relevant.

• New feature (non-breaking change which adds functionality)

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• [-] I have made corresponding changes to the documentation
• New and existing unit tests pass locally with my changes
• I have read the CONTRIBUTING document

[Dwlad90]

Hi @mattstyles, thanks for the PR, great job.

It really does look a bit noisy, but I think the debugging value outweighs that.

It's probably worth printing out potentially valid import paths for StyleX files in crates/stylex-path-resolver/src/resolvers/mod.rs:411 file. Bugs are mostly related to this. Usually the correct path is missing from the list.

Something like this:

debug!("Resolved file paths: {:?} for import `{}`", valid_file_paths, import_path_str);

[Dwlad90]

/merge

[github-actions]

Success! Fast forwarded develop to add-path-logger!