Add serde skip options for hidden columns to the CLI (#1171)

* Add serde skip options for hidden columns to the CLI * Resolve rustfmt and clippy issues * Use SerdeDeriveOptions instead of WithSerde in tests * Resolve upstream conflict Co-authored-by: Billy Chan <ccw.billy.123@gmail.com>
SeaQL · Dec 19, 2022 · 09075f5 · 09075f5
1 parent 1f27837
commit 09075f5
Show file tree

Hide file tree

Showing 4 changed files with 132 additions and 64 deletions.
diff --git a/sea-orm-cli/src/cli.rs b/sea-orm-cli/src/cli.rs
@@ -200,6 +200,14 @@ pub enum GenerateSubcommands {
         )]
         with_serde: String,
 
+        #[clap(
+            action,
+            long,
+            default_value = "false",
+            help = "Opt-in to add skip attributes to hidden columns (i.e. when 'with-serde' enabled and column name starts with an underscore)"
+        )]
+        serde_skip_hidden_columns: bool,
+
         #[clap(
             action,
             long,

diff --git a/sea-orm-cli/src/commands/generate.rs b/sea-orm-cli/src/commands/generate.rs
@@ -1,8 +1,8 @@
 use sea_orm_codegen::{
     DateTimeCrate as CodegenDateTimeCrate, EntityTransformer, EntityWriterContext, OutputFile,
-    WithSerde,
+    SerdeDeriveOptions,
 };
-use std::{error::Error, fs, io::Write, path::Path, process::Command, str::FromStr};
+use std::{error::Error, fs, io::Write, path::Path, process::Command};
 use tracing_subscriber::{prelude::*, EnvFilter};
 use url::Url;
 
@@ -24,6 +24,7 @@ pub async fn run_generate_command(
             database_schema,
             database_url,
             with_serde,
+            serde_skip_hidden_columns,
             with_copy_enums,
             date_time_crate,
             lib,
@@ -159,7 +160,8 @@ pub async fn run_generate_command(
 
             let writer_context = EntityWriterContext::new(
                 expanded_format,
-                WithSerde::from_str(&with_serde).unwrap(),
+                SerdeDeriveOptions::from_options(&with_serde, serde_skip_hidden_columns)
+                    .expect("Serde derive options must be valid"),
                 with_copy_enums,
                 date_time_crate.into(),
                 schema_name,

diff --git a/sea-orm-codegen/src/entity/active_enum.rs b/sea-orm-codegen/src/entity/active_enum.rs
@@ -3,7 +3,7 @@ use proc_macro2::TokenStream;
 use quote::{format_ident, quote};
 use sea_query::DynIden;
 
-use crate::WithSerde;
+use crate::SerdeDeriveOptions;
 
 #[derive(Clone, Debug)]
 pub struct ActiveEnum {
@@ -12,7 +12,11 @@ pub struct ActiveEnum {
 }
 
 impl ActiveEnum {
-    pub fn impl_active_enum(&self, with_serde: &WithSerde, with_copy_enums: bool) -> TokenStream {
+    pub fn impl_active_enum(
+        &self,
+        serde_options: &SerdeDeriveOptions,
+        with_copy_enums: bool,
+    ) -> TokenStream {
         let enum_name = &self.enum_name.to_string();
         let enum_iden = format_ident!("{}", enum_name.to_camel_case());
         let values: Vec<String> = self.values.iter().map(|v| v.to_string()).collect();
@@ -24,7 +28,7 @@ impl ActiveEnum {
             }
         });
 
-        let extra_derive = with_serde.extra_derive();
+        let extra_derive = serde_options.extra_derive();
         let copy_derive = if with_copy_enums {
             quote! { , Copy }
         } else {
@@ -72,7 +76,7 @@ mod tests {
                 .map(|variant| Alias::new(variant).into_iden())
                 .collect(),
             }
-            .impl_active_enum(&WithSerde::None, true)
+            .impl_active_enum(&SerdeDeriveOptions::None, true)
             .to_string(),
             quote!(
                 #[derive(Debug, Clone, PartialEq, Eq, EnumIter, DeriveActiveEnum, Copy)]