Home Original page

Delete deprecated functions in Config.util, and associated tests. by jdmarshall · Pull Request #845 · node-config/node-config

Walkthrough

Removed many deprecated util wrapper functions from lib/config.js and pruned/updated tests and fixtures accordingly; several tests were refactored to use the Load utility and some assertions now expect makeImmutable instead of cloneDeep. No new runtime features added.

Changes

Cohort / File(s) Summary
Core util wrapper removals
lib/config.js		 Removed many deprecated util wrappers (e.g., makeHidden, getOption, locateMatchingFiles, resolveDeferredConfigs, parseFile, parseString, cloneDeep, setPath, substituteDeep, getCustomEnvVars, equalsDeep, diffDeep, extendDeep, isObject, isPromise, initParam, getCmdLineArg, getEnv, getRegExpFlags). Core behavior and non-deprecated APIs unchanged.
Pruned util-related tests
test/1-protected-test.js, test/util.js		 Deleted test suites covering many util functions and some attachProtoDeep cases; reduced coverage for deprecated helpers.
Env precedence tests and fixtures removed
test/12-node_env-override.js, test/13-node_env-hostname.js, test/12-config/*.json		 Removed environment-precedence tests and related fixture entries (apollo.json, development.json content removed, mercury.json deleted).
SkipConfigSources tests and fixtures removed
test/18-skipConfigSources.js, test/18-config/default.json, test/18-extra-config/*		 Deleted skipConfigSources tests and associated fixture files (default.json, customFile.json, etc.).
Load-based test refactors
test/19-custom-environment-variables.js, test/7-unicode-situations.js		 Replaced direct parseFile usage in tests with Load.loadFile from lib/util (introduces test use of named export Load); removed getCustomEnvVars test block.
API assertion update
test/2-config-test.js		 Updated tests to expect config.util.makeImmutable (replacing prior cloneDeep checks); removed makeHidden tests.

Sequence Diagram(s)

sequenceDiagram
    participant Test
    participant Load
    participant FS
    Test->>Load: LOAD.loadFile(filePath)
    Load->>FS: read file content
    FS-->>Load: file content
    Load->>Load: parse/interpret content
    Load-->>Test: returned config object
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • markstos

Poem

Thump-thump—I cleaned the old code stack,
Buried wrappers in a tidy pack.
Tests now hop to Load’s quick track,
makeImmutable keeps settings intact.
A carrot’s cheer, the burrow’s back. 🥕🐇

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.