Skip to content

FAQ

Jump to bottom
Manuel Gil @imgildev edited this page Feb 7, 2025 · 1 revision

General Questions

1. What is JSON Flow?

JSON Flow is a Visual Studio Code extension designed to simplify the process of analyzing and navigating through JSON and similar structured files. It provides intuitive visualizations, better management of file patterns, and improved usability.

Features

2. What file types are supported?

The extension supports the following file formats by default:

  • JSON, JSONC, JSON5
  • YAML, YML
  • XML, CSV, TSV
  • Configuration files such as ENV, INI, HCL, CFG, and PROPERTIES

Custom file formats can also be included via configuration settings.

3. Can I exclude certain files or folders from being processed?

Yes, you can exclude files or folders by adding patterns to the jsonFlow.files.excludedFilePatterns setting. By default, directories like node_modules, dist, out, and build are excluded.

Configuration

4. How do I customize the layout of the graph?

The graph's layout orientation can be configured using the jsonFlow.graph.layoutOrientation setting. Supported values are:

  • TB: Top to Bottom
  • LR: Left to Right
  • BT: Bottom to Top
  • RL: Right to Left

5. Can I include the file path in the generated file list?

Yes, you can enable this by setting jsonFlow.files.includeFilePath to true in your configuration.

Development

6. How do I contribute to the project?

Contributions are welcome! Follow these steps to get started:

  1. Fork the repository.
  2. Clone it locally.
  3. Create a new branch for your feature or fix.
  4. Submit a pull request once your changes are ready.

For detailed instructions, check the Contributing Guide.

7. How do I test the extension while developing?

You can test the extension by:

  1. Running npm install to set up dependencies.
  2. Pressing F5 in Visual Studio Code to launch the Extension Development Host.
  3. Running npm run dev to test the React webview.

Troubleshooting

8. The extension is not working. What should I do?

  • Ensure that Node.js and the extension’s dependencies are installed.
  • Check for error logs in the Developer Tools Console (Help > Toggle Developer Tools).
  • If issues persist, report them on the GitHub Issues page.

9. How do I reset the extension’s configuration?

You can reset settings to their default values by:

  1. Navigating to your Settings in VS Code.
  2. Searching for jsonFlow.
  3. Resetting individual settings or using the Reset Settings button (if available).

License and Credits

10. Is JSON Flow free to use?

Yes, JSON Flow is open source and licensed under the MIT License. You can use, modify, and distribute it freely under the terms of the license.

11. Who maintains JSON Flow?

The extension is maintained by a team of contributors. For a full list, visit the Contributors page.

Clone this wiki locally