refactor: Rename statements.X config properties to module.X as it's better.

Author: dsherret

Cargo.toml

@@ -2,7 +2,7 @@
 name = "dprint-plugin-typescript"
 description = "TypeScript code formatting plugin for dprint."
 keywords = ["formatting", "formatter", "typescript"]
-version = "0.34.0"
+version = "0.35.0"
 authors = ["David Sherret <[email protected]>"]
 edition = "2018"
 license = "MIT"
@@ -24,7 +24,7 @@ panic = "abort"
 wasm = ["serde_json", "dprint-core/wasm"]
 
 [dependencies]
-dprint-core = { version = "0.31.0", features = ["formatting"] }
+dprint-core = { version = "0.33.1", features = ["formatting"] }
 swc_common = "0.10.6"
 swc_ecmascript = { version = "0.14.4", features = ["parser"] }
 serde = { version = "1.0.88", features = ["derive"] }

src/configuration/builder.rs

@@ -66,8 +66,8 @@ impl ConfigurationBuilder {
             .quote_style(QuoteStyle::PreferDouble)
             .ignore_node_comment_text("deno-fmt-ignore")
             .ignore_file_comment_text("deno-fmt-ignore-file")
-            .statements_sort_import_declarations(SortOrder::Maintain)
-            .statements_sort_export_declarations(SortOrder::Maintain)
+            .module_sort_import_declarations(SortOrder::Maintain)
+            .module_sort_export_declarations(SortOrder::Maintain)
     }
 
     /// The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.
@@ -408,15 +408,15 @@ impl ConfigurationBuilder {
     /// Alphabetically sorts the import declarations based on their module specifiers.
     ///
     /// Default: Case insensitive
-    pub fn statements_sort_import_declarations(&mut self, value: SortOrder) -> &mut Self {
-        self.insert("statements.sortImportDeclarations", value.to_string().into())
+    pub fn module_sort_import_declarations(&mut self, value: SortOrder) -> &mut Self {
+        self.insert("module.sortImportDeclarations", value.to_string().into())
     }
 
     /// Alphabetically sorts the export declarations based on their module specifiers.
     ///
     /// Default: Case insensitive
-    pub fn statements_sort_export_declarations(&mut self, value: SortOrder) -> &mut Self {
-        self.insert("statements.sortExportDeclarations", value.to_string().into())
+    pub fn module_sort_export_declarations(&mut self, value: SortOrder) -> &mut Self {
+        self.insert("module.sortExportDeclarations", value.to_string().into())
     }
 
     /// Alphabetically sorts the import declaration's named imports.
@@ -892,8 +892,8 @@ mod tests {
             .type_literal_separator_kind_single_line(SemiColonOrComma::Comma)
             .type_literal_separator_kind_multi_line(SemiColonOrComma::Comma)
             /* sorting */
-            .statements_sort_import_declarations(SortOrder::Maintain)
-            .statements_sort_export_declarations(SortOrder::Maintain)
+            .module_sort_import_declarations(SortOrder::Maintain)
+            .module_sort_export_declarations(SortOrder::Maintain)
             .import_declaration_sort_named_imports(SortOrder::Maintain)
             .export_declaration_sort_named_exports(SortOrder::Maintain)
             /* ignore comments */

src/configuration/resolve_config.rs

@@ -44,6 +44,10 @@ pub fn resolve_config(config: ConfigKeyMap, global_config: &GlobalConfiguration)
     let prefer_single_line = prefer_single_line_nullable.unwrap_or(false);
     let type_literal_separator_kind = get_value(&mut config, "typeLiteral.separatorKind", SemiColonOrComma::SemiColon, &mut diagnostics);
 
+    // todo: remove these two lines after 2021-03
+    handle_renamed_config_property(&mut config, "statements.sortImportDeclarations", "module.sortImportDeclarations", &mut diagnostics);
+    handle_renamed_config_property(&mut config, "statements.sortExportDeclarations", "module.sortExportDeclarations", &mut diagnostics);
+
     let resolved_config = Configuration {
         line_width: get_value(&mut config, "lineWidth", global_config.line_width.unwrap_or(DEFAULT_GLOBAL_CONFIGURATION.line_width), &mut diagnostics),
         use_tabs: get_value(&mut config, "useTabs", global_config.use_tabs.unwrap_or(DEFAULT_GLOBAL_CONFIGURATION.use_tabs), &mut diagnostics),
@@ -58,8 +62,8 @@ pub fn resolve_config(config: ConfigKeyMap, global_config: &GlobalConfiguration)
         type_literal_separator_kind_single_line: get_value(&mut config, "typeLiteral.separatorKind.singleLine", type_literal_separator_kind, &mut diagnostics),
         type_literal_separator_kind_multi_line: get_value(&mut config, "typeLiteral.separatorKind.multiLine", type_literal_separator_kind, &mut diagnostics),
         /* sorting */
-        statements_sort_import_declarations: get_value(&mut config, "statements.sortImportDeclarations", SortOrder::CaseInsensitive, &mut diagnostics),
-        statements_sort_export_declarations: get_value(&mut config, "statements.sortExportDeclarations", SortOrder::CaseInsensitive, &mut diagnostics),
+        module_sort_import_declarations: get_value(&mut config, "module.sortImportDeclarations", SortOrder::CaseInsensitive, &mut diagnostics),
+        module_sort_export_declarations: get_value(&mut config, "module.sortExportDeclarations", SortOrder::CaseInsensitive, &mut diagnostics),
         import_declaration_sort_named_imports: get_value(&mut config, "importDeclaration.sortNamedImports", SortOrder::CaseInsensitive, &mut diagnostics),
         export_declaration_sort_named_exports: get_value(&mut config, "exportDeclaration.sortNamedExports", SortOrder::CaseInsensitive, &mut diagnostics),
         /* ignore comments */

src/configuration/types.rs

@@ -273,10 +273,10 @@ pub struct Configuration {
     #[serde(rename = "typeLiteral.separatorKind.multiLine")]
     pub type_literal_separator_kind_multi_line: SemiColonOrComma,
     /* sorting */
-    #[serde(rename = "statements.sortImportDeclarations")]
-    pub statements_sort_import_declarations: SortOrder,
-    #[serde(rename = "statements.sortExportDeclarations")]
-    pub statements_sort_export_declarations: SortOrder,
+    #[serde(rename = "module.sortImportDeclarations")]
+    pub module_sort_import_declarations: SortOrder,
+    #[serde(rename = "module.sortExportDeclarations")]
+    pub module_sort_export_declarations: SortOrder,
     #[serde(rename = "importDeclaration.sortNamedImports")]
     pub import_declaration_sort_named_imports: SortOrder,
     #[serde(rename = "exportDeclaration.sortNamedExports")]

src/parsing/parser.rs

@@ -4877,8 +4877,8 @@ fn parse_statements<'a>(inner_span_data: Span, stmts: Vec<Node<'a>>, context: &m
         context: &Context<'a>,
     ) -> Option<Box<dyn Fn((usize, Option<&Node<'a>>), (usize, Option<&Node<'a>>), &Context<'a>) -> std::cmp::Ordering>> {
         match group_kind {
-            StmtGroupKind::Imports => get_node_sorter_from_order(context.config.statements_sort_import_declarations),
-            StmtGroupKind::Exports => get_node_sorter_from_order(context.config.statements_sort_export_declarations),
+            StmtGroupKind::Imports => get_node_sorter_from_order(context.config.module_sort_import_declarations),
+            StmtGroupKind::Exports => get_node_sorter_from_order(context.config.module_sort_export_declarations),
             StmtGroupKind::Other => None,
         }
     }

tests/specs/statements/sorting/Statements_SortExportDeclarations_CaseInsensitive.txt renamed to tests/specs/file/sorting/Statements_SortExportDeclarations_CaseInsensitive.txt

@@ -1,4 +1,4 @@
-~~ statements.sortExportDeclarations: caseInsensitive ~~
+~~ module.sortExportDeclarations: caseInsensitive ~~
 == should sort the export declarations ==
 export {} from "a1.ts";
 export {} from "A2.ts";

tests/specs/statements/sorting/Statements_SortExportDeclarations_CaseSensitive.txt renamed to tests/specs/file/sorting/Statements_SortExportDeclarations_CaseSensitive.txt

@@ -1,4 +1,4 @@
-~~ statements.sortExportDeclarations: caseSensitive ~~
+~~ module.sortExportDeclarations: caseSensitive ~~
 == should sort the export declarations ==
 export {} from "a1.ts";
 export {} from "A2.ts";

tests/specs/statements/sorting/Statements_SortExportDeclarations_Maintain.txt renamed to tests/specs/file/sorting/Statements_SortExportDeclarations_Maintain.txt

@@ -1,4 +1,4 @@
-~~ statements.sortExportDeclarations: maintain ~~
+~~ module.sortExportDeclarations: maintain ~~
 == should keep the imports declaration sort order as-is ==
 export {} from "b.ts";
 export {} from "a.ts";

tests/specs/statements/sorting/Statements_SortImportDeclarations_CaseInsensitive.txt renamed to tests/specs/file/sorting/Statements_SortImportDeclarations_CaseInsensitive.txt

@@ -1,4 +1,4 @@
-~~ statements.sortImportDeclarations: caseInsensitive ~~
+~~ module.sortImportDeclarations: caseInsensitive ~~
 == should sort the import declarations ==
 import {} from "a1.ts";
 import {} from "A2.ts";

tests/specs/statements/sorting/Statements_SortImportDeclarations_CaseSensitive.txt renamed to tests/specs/file/sorting/Statements_SortImportDeclarations_CaseSensitive.txt

@@ -1,4 +1,4 @@
-~~ statements.sortImportDeclarations: caseSensitive ~~
+~~ module.sortImportDeclarations: caseSensitive ~~
 == should sort the import declarations ==
 import {} from "a1.ts";
 import {} from "A2.ts";