← Discussions Feel++

Toolboxes

Proposal: Adopt `.fpp.json` as the Standard Extension for Feel++ JSON Files

Lire et commenter sur GitHub ↗

Texte original de GitHub, conservé dans sa langue de publication. Ce texte décrit la situation à sa date de publication. Les commentaires sont disponibles sur GitHub.

Background

Feel++ uses JSON files to define models, boundary conditions, materials, and post-processing configurations. To improve consistency, tooling support, and schema validation, we propose adopting a standardized file extension.

Proposed Change

We suggest using .fpp.json as the standard extension for Feel++ JSON files.

Reasons for Choosing .fpp.json

  1. Distinct Feel++ Identity

    • .json alone is too generic.
    • .fpp.json clearly indicates a Feel++-specific JSON file.
  2. Schema Validation Support

    • Editors like VSCode allow automatic schema validation based on file extensions.
    • Easier to apply a JSON Schema for Feel++ in IDEs.
  3. Better Tooling & Automation

    • CI/CD pipelines, JSON validators, and Feel++ tools can quickly identify and process Feel++ configurations.
    • Prevents accidental mixing with general-purpose JSON files.

Alternatives Considered

  • .feel.json: Explicit but longer.
  • .toolbox.json: Too specific to the Feel++ toolboxes.
  • .feelpp.json: Explicit but redundant.

We find .fpp.json to be the best balance between clarity, brevity, and compatibility.

Questions for Discussion

  1. Do you agree with .fpp.json as the standard extension?
  2. Are there any other concerns or suggestions?
  3. What would be the best way to transition existing files (e.g., automatic renaming, documentation updates)?

Looking forward to your feedback!