From 3b497fb3a549c44763e6538e1f2887856fe79785 Mon Sep 17 00:00:00 2001 From: Khalil LAGRIDA <32600911+khalilou88@users.noreply.github.com> Date: Thu, 10 Oct 2024 13:37:06 +0200 Subject: [PATCH] feat: add skipFormat option (#1333) --- packages/nx-gradle/src/generators/application/generator.ts | 4 +++- packages/nx-gradle/src/generators/application/schema.d.ts | 1 + packages/nx-gradle/src/generators/application/schema.json | 5 +++++ packages/nx-gradle/src/generators/init/generator.ts | 4 +++- packages/nx-gradle/src/generators/init/schema.d.ts | 1 + packages/nx-gradle/src/generators/init/schema.json | 5 +++++ packages/nx-gradle/src/generators/library/generator.ts | 4 +++- packages/nx-gradle/src/generators/library/schema.d.ts | 1 + packages/nx-gradle/src/generators/library/schema.json | 5 +++++ packages/nx-gradle/src/generators/wrapper/generator.ts | 4 +++- packages/nx-gradle/src/generators/wrapper/schema.d.ts | 1 + packages/nx-gradle/src/generators/wrapper/schema.json | 5 +++++ packages/nx-maven/src/generators/application/generator.ts | 4 +++- packages/nx-maven/src/generators/application/schema.d.ts | 1 + packages/nx-maven/src/generators/application/schema.json | 5 +++++ packages/nx-maven/src/generators/init/generator.ts | 4 +++- packages/nx-maven/src/generators/init/schema.d.ts | 1 + packages/nx-maven/src/generators/init/schema.json | 5 +++++ packages/nx-maven/src/generators/library/generator.ts | 4 +++- packages/nx-maven/src/generators/library/schema.d.ts | 1 + packages/nx-maven/src/generators/library/schema.json | 5 +++++ packages/nx-maven/src/generators/parent-project/generator.ts | 4 +++- packages/nx-maven/src/generators/parent-project/schema.d.ts | 1 + packages/nx-maven/src/generators/parent-project/schema.json | 5 +++++ packages/nx-maven/src/generators/wrapper/generator.ts | 4 +++- packages/nx-maven/src/generators/wrapper/schema.d.ts | 1 + packages/nx-maven/src/generators/wrapper/schema.json | 5 +++++ 27 files changed, 81 insertions(+), 9 deletions(-) diff --git a/packages/nx-gradle/src/generators/application/generator.ts b/packages/nx-gradle/src/generators/application/generator.ts index 93fefe275..7da932d45 100644 --- a/packages/nx-gradle/src/generators/application/generator.ts +++ b/packages/nx-gradle/src/generators/application/generator.ts @@ -454,5 +454,7 @@ async function applicationGenerator( addFiles(tree, normalizedOptions); addProjectToGradleSetting(tree, normalizedOptions); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } diff --git a/packages/nx-gradle/src/generators/application/schema.d.ts b/packages/nx-gradle/src/generators/application/schema.d.ts index cce26a6c9..43d72a234 100644 --- a/packages/nx-gradle/src/generators/application/schema.d.ts +++ b/packages/nx-gradle/src/generators/application/schema.d.ts @@ -14,4 +14,5 @@ export interface NxGradleAppGeneratorSchema { minimal?: boolean; port?: string | number; framework?: FrameworkType; + skipFormat?: boolean; } diff --git a/packages/nx-gradle/src/generators/application/schema.json b/packages/nx-gradle/src/generators/application/schema.json index 8fb5850bd..55c1ebff0 100644 --- a/packages/nx-gradle/src/generators/application/schema.json +++ b/packages/nx-gradle/src/generators/application/schema.json @@ -134,6 +134,11 @@ ], "default": 8080, "description": "Port to start the server at. Default is 8080." + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": ["name", "language", "groupId", "projectVersion", "configFormat"] diff --git a/packages/nx-gradle/src/generators/init/generator.ts b/packages/nx-gradle/src/generators/init/generator.ts index 1bb5cda48..c876a0305 100644 --- a/packages/nx-gradle/src/generators/init/generator.ts +++ b/packages/nx-gradle/src/generators/init/generator.ts @@ -144,7 +144,9 @@ export async function initGenerator( '755', ); } - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } return () => { installPackagesTask(tree); diff --git a/packages/nx-gradle/src/generators/init/schema.d.ts b/packages/nx-gradle/src/generators/init/schema.d.ts index 6e1b62318..9d73ea6fd 100644 --- a/packages/nx-gradle/src/generators/init/schema.d.ts +++ b/packages/nx-gradle/src/generators/init/schema.d.ts @@ -8,4 +8,5 @@ export interface NxGradleInitGeneratorSchema { preset: PresetType; skipWrapper?: boolean; versionManagement: VersionManagementType; + skipFormat?: boolean; } diff --git a/packages/nx-gradle/src/generators/init/schema.json b/packages/nx-gradle/src/generators/init/schema.json index b9489d5fb..ea3832a14 100644 --- a/packages/nx-gradle/src/generators/init/schema.json +++ b/packages/nx-gradle/src/generators/init/schema.json @@ -112,6 +112,11 @@ } ] } + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": [ diff --git a/packages/nx-gradle/src/generators/library/generator.ts b/packages/nx-gradle/src/generators/library/generator.ts index 07869c519..1a3c31787 100644 --- a/packages/nx-gradle/src/generators/library/generator.ts +++ b/packages/nx-gradle/src/generators/library/generator.ts @@ -335,5 +335,7 @@ async function libraryGenerator( addFiles(tree, normalizedOptions); addProjectToGradleSetting(tree, normalizedOptions); addLibraryToProjects(tree, normalizedOptions); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } diff --git a/packages/nx-gradle/src/generators/library/schema.d.ts b/packages/nx-gradle/src/generators/library/schema.d.ts index 41d1a6c80..147477504 100644 --- a/packages/nx-gradle/src/generators/library/schema.d.ts +++ b/packages/nx-gradle/src/generators/library/schema.d.ts @@ -12,4 +12,5 @@ export interface NxGradleLibGeneratorSchema { projects?: string; skipStarterCode?: boolean; framework?: FrameworkType; + skipFormat?: boolean; } diff --git a/packages/nx-gradle/src/generators/library/schema.json b/packages/nx-gradle/src/generators/library/schema.json index 612532e69..28c64526d 100644 --- a/packages/nx-gradle/src/generators/library/schema.json +++ b/packages/nx-gradle/src/generators/library/schema.json @@ -101,6 +101,11 @@ "description": "Skip starter code", "type": "boolean", "default": false + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": ["name", "language", "groupId", "projectVersion"] diff --git a/packages/nx-gradle/src/generators/wrapper/generator.ts b/packages/nx-gradle/src/generators/wrapper/generator.ts index 62f413d45..c102c4abb 100644 --- a/packages/nx-gradle/src/generators/wrapper/generator.ts +++ b/packages/nx-gradle/src/generators/wrapper/generator.ts @@ -56,7 +56,9 @@ export default async function ( joinPathFragments(normalizedOptions.gradleRootDirectory, 'gradlew.bat'), '755', ); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } export function updateGitIgnore(tree: Tree) { diff --git a/packages/nx-gradle/src/generators/wrapper/schema.d.ts b/packages/nx-gradle/src/generators/wrapper/schema.d.ts index bf2a564c4..83df0d91d 100644 --- a/packages/nx-gradle/src/generators/wrapper/schema.d.ts +++ b/packages/nx-gradle/src/generators/wrapper/schema.d.ts @@ -1,3 +1,4 @@ export interface NxGradleWrapperGeneratorSchema { skipGitignore?: boolean; + skipFormat?: boolean; } diff --git a/packages/nx-gradle/src/generators/wrapper/schema.json b/packages/nx-gradle/src/generators/wrapper/schema.json index 2deeff68b..6eeaf4237 100644 --- a/packages/nx-gradle/src/generators/wrapper/schema.json +++ b/packages/nx-gradle/src/generators/wrapper/schema.json @@ -8,6 +8,11 @@ "description": "Don't add Gradle Wrapper to .gitignore", "type": "boolean", "default": false + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": [] diff --git a/packages/nx-maven/src/generators/application/generator.ts b/packages/nx-maven/src/generators/application/generator.ts index a42218a49..e26a0e4c9 100644 --- a/packages/nx-maven/src/generators/application/generator.ts +++ b/packages/nx-maven/src/generators/application/generator.ts @@ -489,5 +489,7 @@ async function applicationGenerator( aggregatorProject: normalizedOptions.aggregatorProject, mavenRootDirectory: normalizedOptions.mavenRootDirectory, }); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } diff --git a/packages/nx-maven/src/generators/application/schema.d.ts b/packages/nx-maven/src/generators/application/schema.d.ts index d74317925..6386f2d1b 100644 --- a/packages/nx-maven/src/generators/application/schema.d.ts +++ b/packages/nx-maven/src/generators/application/schema.d.ts @@ -16,4 +16,5 @@ export interface NxMavenAppGeneratorSchema { minimal?: boolean; port?: string | number; framework?: FrameworkType; + skipFormat?: boolean; } diff --git a/packages/nx-maven/src/generators/application/schema.json b/packages/nx-maven/src/generators/application/schema.json index 8085724b1..142dc823d 100644 --- a/packages/nx-maven/src/generators/application/schema.json +++ b/packages/nx-maven/src/generators/application/schema.json @@ -144,6 +144,11 @@ ], "default": 8080, "description": "Port to start the server at. Default is 8080." + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": [ diff --git a/packages/nx-maven/src/generators/init/generator.ts b/packages/nx-maven/src/generators/init/generator.ts index df5171274..0e43cecb2 100644 --- a/packages/nx-maven/src/generators/init/generator.ts +++ b/packages/nx-maven/src/generators/init/generator.ts @@ -120,7 +120,9 @@ export async function initGenerator( '755', ); } - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } return () => { installPackagesTask(tree); diff --git a/packages/nx-maven/src/generators/init/schema.d.ts b/packages/nx-maven/src/generators/init/schema.d.ts index b4f53803a..9ae6ec9bb 100644 --- a/packages/nx-maven/src/generators/init/schema.d.ts +++ b/packages/nx-maven/src/generators/init/schema.d.ts @@ -9,4 +9,5 @@ export interface NxMavenInitGeneratorSchema { dependencyManagement: DependencyManagementType; skipWrapper?: boolean; localRepoRelativePath: string; + skipFormat?: boolean; } diff --git a/packages/nx-maven/src/generators/init/schema.json b/packages/nx-maven/src/generators/init/schema.json index 8cfe35e0c..434a7c9e3 100644 --- a/packages/nx-maven/src/generators/init/schema.json +++ b/packages/nx-maven/src/generators/init/schema.json @@ -86,6 +86,11 @@ "type": "string", "description": "Maven local repository relative path to {workspaceRoot}/{mavenRootDirectory}", "default": ".m2/repository" + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": [ diff --git a/packages/nx-maven/src/generators/library/generator.ts b/packages/nx-maven/src/generators/library/generator.ts index ec85ed219..c0e9ec123 100644 --- a/packages/nx-maven/src/generators/library/generator.ts +++ b/packages/nx-maven/src/generators/library/generator.ts @@ -340,5 +340,7 @@ async function libraryGenerator( mavenRootDirectory: normalizedOptions.mavenRootDirectory, }); addLibraryToProjects(tree, normalizedOptions); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } diff --git a/packages/nx-maven/src/generators/library/schema.d.ts b/packages/nx-maven/src/generators/library/schema.d.ts index 312c4823b..1aa42ccc9 100644 --- a/packages/nx-maven/src/generators/library/schema.d.ts +++ b/packages/nx-maven/src/generators/library/schema.d.ts @@ -14,4 +14,5 @@ export interface NxMavenLibGeneratorSchema { projects?: string; skipStarterCode?: boolean; framework?: FrameworkType; + skipFormat?: boolean; } diff --git a/packages/nx-maven/src/generators/library/schema.json b/packages/nx-maven/src/generators/library/schema.json index d0fe87e45..947b1092b 100644 --- a/packages/nx-maven/src/generators/library/schema.json +++ b/packages/nx-maven/src/generators/library/schema.json @@ -111,6 +111,11 @@ "description": "Skip starter code", "type": "boolean", "default": false + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": ["name", "language", "groupId", "projectVersion", "parentProject"] diff --git a/packages/nx-maven/src/generators/parent-project/generator.ts b/packages/nx-maven/src/generators/parent-project/generator.ts index af9d6c8ac..3009af95c 100644 --- a/packages/nx-maven/src/generators/parent-project/generator.ts +++ b/packages/nx-maven/src/generators/parent-project/generator.ts @@ -191,5 +191,7 @@ async function parentProjectGenerator( aggregatorProject: normalizedOptions.aggregatorProject, mavenRootDirectory: normalizedOptions.mavenRootDirectory, }); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } diff --git a/packages/nx-maven/src/generators/parent-project/schema.d.ts b/packages/nx-maven/src/generators/parent-project/schema.d.ts index ed08f1828..3dd102b13 100644 --- a/packages/nx-maven/src/generators/parent-project/schema.d.ts +++ b/packages/nx-maven/src/generators/parent-project/schema.d.ts @@ -12,4 +12,5 @@ export interface NxMavenParentProjectGeneratorSchema { aggregatorProject?: string; framework?: FrameworkType; language: 'java' | 'kotlin' | 'java-kotlin'; + skipFormat?: boolean; } diff --git a/packages/nx-maven/src/generators/parent-project/schema.json b/packages/nx-maven/src/generators/parent-project/schema.json index f7e863a3c..08bc32a6e 100644 --- a/packages/nx-maven/src/generators/parent-project/schema.json +++ b/packages/nx-maven/src/generators/parent-project/schema.json @@ -104,6 +104,11 @@ "aggregatorProject": { "type": "string", "description": "ArtifactId of the aggregator project (that manages a group of submodules) or leave it blank for the root project" + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": ["name", "projectType", "groupId", "projectVersion"] diff --git a/packages/nx-maven/src/generators/wrapper/generator.ts b/packages/nx-maven/src/generators/wrapper/generator.ts index 56b74e48c..17c4fb901 100644 --- a/packages/nx-maven/src/generators/wrapper/generator.ts +++ b/packages/nx-maven/src/generators/wrapper/generator.ts @@ -60,7 +60,9 @@ export default async function ( joinPathFragments(normalizedOptions.mavenRootDirectory, 'mvnw.cmd'), '755', ); - await formatFiles(tree); + if (!options.skipFormat) { + await formatFiles(tree); + } } function updateGitIgnore(tree: Tree) { diff --git a/packages/nx-maven/src/generators/wrapper/schema.d.ts b/packages/nx-maven/src/generators/wrapper/schema.d.ts index 4a24c0136..cf04c0c9b 100644 --- a/packages/nx-maven/src/generators/wrapper/schema.d.ts +++ b/packages/nx-maven/src/generators/wrapper/schema.d.ts @@ -1,3 +1,4 @@ export interface NxMavenWrapperGeneratorSchema { skipGitignore?: boolean; + skipFormat?: boolean; } diff --git a/packages/nx-maven/src/generators/wrapper/schema.json b/packages/nx-maven/src/generators/wrapper/schema.json index 0ec45cdeb..6cb79535a 100644 --- a/packages/nx-maven/src/generators/wrapper/schema.json +++ b/packages/nx-maven/src/generators/wrapper/schema.json @@ -8,6 +8,11 @@ "description": "Don't add Maven Wrapper to .gitignore", "type": "boolean", "default": false + }, + "skipFormat": { + "description": "Skip formatting files.", + "type": "boolean", + "default": false } }, "required": []