SeaQL / SeaQL/sea-orm

Config file of `sea-orm-cli generate entity` command

Open
#1,185 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
9.9k
Forks
734
Avg merge
6h 36m
Merged PRs (30d)
8

Description

Motivation

The options and flags for sea-orm-cli generate entity command is getting more and more. It's time to consider a scalable plan: loading the options from a config file.

Proposed Solutions

Load all options by providing the path to the config file: sea-orm-cli generate entity --config generate-entity.config.json. The config file must be a JSON value.

{
    "compact_format": true,
    "expanded_format": true,
    "include_hidden_tables": true,
    "tables": "my_table",
    "ignore_tables": ["seaql_migrations"],
    "max_connections": 1,
    "output_dir": "out",
    "database_schema": "public",
    "database_url": "postgres://root:root@localhost/database",
    "with_serde": "none",
    "with_copy_enums": true,
    "date_time_crate": "chrono",
    "lib": true
}

Related Discussion

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the sea-orm-cli generate entity command entry point and review how its current options are defined and loaded. Use the proposed JSON keys and --config path as the acceptance checklist; done means the config file supplies the listed options for entity generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, database
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.