[CLI] Show progress when generating entity files

[billy1624]

Motivation

The sea-orm-cli generate entity command doesn't show its progress such as which entity (db table) it's generating. Some time when it fail, user have no idea which db table is at fault and making it hard to debug.

Proposed Solutions

• Display the progress when running the command and show info such as the table name and the specification of table columns that it's currently generating

Additional Information

• Discussed and suggested on thread 'main' panicked at 'Ident cannot be a number; use Literal instead' if enum field include numeric values #702

[kyoto7250]

@billy1624

Hello, I am interested in this issue.
I am new comer to contributing to this repository, Could you tell me about it?

[billy1624]

Hey @kyoto7250, thanks for the interest!

I think there are two things we need to code.

First, log the table name and its column info of the generating entity.

• We could add the tracing::info! macro to

  sea-orm/sea-orm-codegen/src/entity/writer.rs

  Lines 93 to 111 in e005626

  	pub fn write_entities(&self, expanded_format: bool, with_serde: &WithSerde) -> Vec<OutputFile> {
  	self.entities
  	.iter()
  	.map(|entity| {
  	let mut lines = Vec::new();
  	Self::write_doc_comment(&mut lines);
  	let code_blocks = if expanded_format {
  	Self::gen_expanded_code_blocks(entity, with_serde)
  	} else {
  	Self::gen_compact_code_blocks(entity, with_serde)
  	};
  	Self::write(&mut lines, code_blocks);
  	OutputFile {
  	name: format!("{}.rs", entity.get_table_name_snake_case()),
  	content: lines.join("\n\n"),
  	}
  	})
  	.collect()
  	}

• For example, in sea-orm-migration we have done something similar logging

  sea-orm/sea-orm-migration/src/migrator.rs

  Lines 154 to 157 in e005626

  	info!(
  	"Dropping foreign key '{}' from table '{}'",
  	constraint_name, table_name
  	);

Second, print log of log level info via tracing_subscriber.

• We could initialize the tracing_subscriber at the else part of

  sea-orm/sea-orm-cli/src/commands.rs

  Lines 19 to 24 in e005626

  	if args.is_present("VERBOSE") {
  	let _ = tracing_subscriber::fmt()
  	.with_max_level(tracing::Level::DEBUG)
  	.with_test_writer()
  	.try_init();
  	}

• For example,

  sea-orm/sea-orm-migration/src/cli.rs

  Lines 45 to 54 in e005626

  	} else {
  	let fmt_layer = tracing_subscriber::fmt::layer()
  	.with_target(false)
  	.with_level(false)
  	.without_time();
  	tracing_subscriber::registry()
  	.with(filter_layer)
  	.with(fmt_layer)
  	.init()
  	};