Skip to content

Consistent names for the equivalent options of the tasks (file path, base path, class...) #505

Open

Description

@njoubert-cleverage

Description

Equivalent options have different names from one task to another, in the core and in the bridge bundles:

Topic Names
File path file_path (csv_reader, csv_writer, json_stream_*, xml_*, yaml_*, file_splitter); filename (file_reader, file_writer, line_reader, archive_zip, archive_unzip); folder_path (folder_browser); destination (file_mover, archive_unzip)
Base path base_path (csv_splitter, input_csv_reader); base_folder_path (input_folder_browser); files_base_path (archive_zip)
Target class class (denormalizer, denormalize, instantiate); class_name (doctrine_reader); type (deserializer)
Logging of the empty case empty_log_level (doctrine_reader, doctrine_database_reader, folder_browser); log_empty_lines (bool, csv_reader)

A user writing a process has to look up each option name in the reference.

Proposed fix

Choose one name per topic (e.g. file_path, base_path, class), accept it in 5.x as an alias of the current name, deprecate the current name, and remove it in v6.0 (and in the next major versions of the bridge bundles: archive v3.0, doctrine v4.0). To decide before the v6.0 freeze: which names, and whether the referenced services (adapter, filesystem, client, entity_manager) stay named by bridge.

Requirements

  • Documentation updates
    • Reference
    • Cookbooks
    • Changelog
  • Unit tests

Breaking changes

Major (v6.0): removal of the former option names, deprecated in 5.x.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions