fix: don't override Intellij module config files (#351)

Fixes #333
invertase · Jul 14, 2022 · 850e9f8 · 850e9f8
1 parent a423718
commit 850e9f8
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 10 deletions.
diff --git a/docs/commands/clean.mdx b/docs/commands/clean.mdx
@@ -21,8 +21,6 @@ These files include;
 - `{packageRoot}/.dart_tool/package_config.json`
 - `{packageRoot}/.dart_tool/package_config_subset`
 - `{packageRoot}/.dart_tool/version`
-- `{packageRoot}/melos_{packageName}.iml`
-- `{workspaceRoot}/melos_{workspaceName}.iml`
 - `{workspaceRoot}/.idea/runConfigurations/melos_*.xml`
 
 This can be useful to give your workspace a 'fresh start', e.g.;

diff --git a/packages/melos/lib/src/common/intellij_project.dart b/packages/melos/lib/src/common/intellij_project.dart
@@ -83,6 +83,11 @@ class IntellijProject {
     return joinAll([package.path, 'melos_${package.name}.iml']);
   }
 
+  String pathWorkspaceModuleIml() {
+    final workspaceModuleName = _workspace.config.name.toLowerCase();
+    return joinAll([_workspace.path, 'melos_$workspaceModuleName.iml']);
+  }
+
   String injectTemplateVariable({
     required String template,
     required String variableName,
@@ -167,21 +172,43 @@ class IntellijProject {
   }
 
   Future<void> writePackageModule(Package package) async {
+    final path = pathPackageModuleIml(package);
+    if (fileExists(path)) {
+      // The user might have modified the module, so we don't want to overwrite
+      // them.
+      return;
+    }
+
     final template = await readFileTemplate(
       moduleTemplateFileForPackageType(package.type),
       templateCategory: 'modules',
     );
-    return forceWriteToFile(pathPackageModuleIml(package), template);
+
+    return forceWriteToFile(path, template);
+  }
+
+  Future<void> writePackageModules() async {
+    await Future.forEach(
+      _workspace.filteredPackages.values,
+      writePackageModule,
+    );
   }
 
   Future<void> writeWorkspaceModule() async {
+    final path = pathWorkspaceModuleIml();
+    if (fileExists(path)) {
+      // The user might have modified the module, so we don't want to overwrite
+      // them.
+      return;
+    }
+
     final ideaWorkspaceModuleImlTemplate = await readFileTemplate(
       'workspace_root_module.iml',
       templateCategory: 'modules',
     );
-    final workspaceModuleName = _workspace.config.name.toLowerCase();
+
     return forceWriteToFile(
-      joinAll([_workspace.path, 'melos_$workspaceModuleName.iml']),
+      path,
       ideaWorkspaceModuleImlTemplate,
     );
   }
@@ -312,11 +339,7 @@ class IntellijProject {
     await writeNameFile();
 
     // <WORKSPACE_ROOT>/<PACKAGE_DIR>/<PACKAGE_NAME>.iml
-
-    await Future.forEach(_workspace.filteredPackages.values,
-        (Package package) async {
-      await writePackageModule(package);
-    });
+    await writePackageModules();
 
     // <WORKSPACE_ROOT>/<WORKSPACE_NAME>.iml
     await writeWorkspaceModule();