forked from jhipster/generator-jhipster
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
201 additions
and
115 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /** | ||
| * Copyright 2013-2024 the original author or authors from the JHipster project. | ||
| * | ||
| * This file is part of the JHipster project, see https://www.jhipster.tech/ | ||
| * for more information. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import sortKeys from 'sort-keys'; | ||
|
|
||
| import { MavenArtifact, MavenProfile } from '../types.js'; | ||
|
|
||
| const rootOrder = [ | ||
| 'modelVersion', | ||
| 'groupId', | ||
| 'artifactId', | ||
| 'version', | ||
| 'packaging', | ||
| 'name', | ||
| 'description', | ||
| 'parent', | ||
| 'repositories', | ||
| 'pluginRepositories', | ||
| 'distributionManagement', | ||
| 'properties', | ||
| 'dependencyManagement', | ||
| 'dependencies', | ||
| 'build', | ||
| 'profiles', | ||
| ]; | ||
|
|
||
| const propertiesOrder = [ | ||
| 'maven.version', | ||
| 'java.version', | ||
| 'node.version', | ||
| 'npm.version', | ||
| 'project.build.sourceEncoding', | ||
| 'project.reporting.outputEncoding', | ||
| 'maven.build.timestamp.format', | ||
| 'maven.compiler.source', | ||
| 'maven.compiler.target', | ||
| 'start-class', | ||
| 'argLine', | ||
| 'm2e.apt.activation', | ||
| 'run.addResources', | ||
| 'jhipster-dependencies.version', | ||
| 'spring-boot.version', | ||
| ]; | ||
|
|
||
| const groupIdOrder = ['tech.jhipster', 'org.springframework.boot', 'org.springframework.security', 'org.springdoc']; | ||
|
|
||
| const sortSection = section => { | ||
| return Object.fromEntries( | ||
| Object.entries(section).sort(([key1, value1], [key2, value2]) => { | ||
| if (typeof value1 === typeof value2) key1.localeCompare(key2); | ||
| if (typeof value1 === 'string') return -1; | ||
| if (typeof value2 === 'string') return 1; | ||
| return 0; | ||
| }), | ||
| ); | ||
| }; | ||
|
|
||
| const isComment = name => name.startsWith('#'); | ||
|
|
||
| const toMaxInt = nr => (nr === -1 ? Number.MAX_SAFE_INTEGER : nr); | ||
|
|
||
| const sortWithTemplate = (template: string[], a: string, b: string) => { | ||
| if (isComment(a)) return -1; | ||
| if (isComment(b)) return 1; | ||
| const indexOfA = toMaxInt(template.findIndex(item => item === a)); | ||
| const indexOfB = toMaxInt(template.findIndex(item => item === b)); | ||
| if (indexOfA === indexOfB) { | ||
| return a.localeCompare(b); | ||
| } | ||
| return indexOfA - indexOfB; | ||
| }; | ||
|
|
||
| const comparator = (order: string[]) => (a: string, b: string) => sortWithTemplate(order, a, b); | ||
|
|
||
| const sortProperties = properties => sortKeys(properties, { compare: comparator(propertiesOrder) }); | ||
|
|
||
| const sortArtifacts = (artifacts: MavenArtifact[]) => | ||
| artifacts.sort((a: MavenArtifact, b: MavenArtifact) => { | ||
| if (a.groupId !== b.groupId) { | ||
| if (a.groupId === undefined) { | ||
| return -1; | ||
| } | ||
| if (b.groupId === undefined) { | ||
| return 1; | ||
| } | ||
| const groupIdCompared = sortWithTemplate(groupIdOrder, a.groupId, b.groupId); | ||
| if (groupIdCompared) return groupIdCompared; | ||
| } | ||
| return a.artifactId.localeCompare(b.artifactId); | ||
| }); | ||
|
|
||
| const sortProfiles = (profiles: MavenProfile[]) => profiles.sort((a, b) => a.id?.localeCompare(b.id) ?? 1); | ||
|
|
||
| export const sortPomProject = project => { | ||
| project = sortKeys(project, { compare: comparator(rootOrder) }); | ||
| if (project.properties) { | ||
| project.properties = sortProperties(project.properties); | ||
| } | ||
| if (Array.isArray(project.dependencies?.dependency)) { | ||
| project.dependencies.dependency = sortArtifacts(project.dependencies.dependency); | ||
| } | ||
| if (Array.isArray(project.dependencyManagement?.dependencies?.dependency)) { | ||
| project.dependencyManagement.dependencies.dependency = sortArtifacts(project.dependencyManagement.dependencies.dependency); | ||
| } | ||
| if (project.build) { | ||
| project.build = sortSection(project.build); | ||
|
|
||
| if (Array.isArray(project.build.plugins?.plugin)) { | ||
| project.build.plugins.plugin = sortArtifacts(project.build.plugins.plugin); | ||
| } | ||
| if (Array.isArray(project.build.pluginManagement?.plugins?.plugin)) { | ||
| project.build.pluginManagement.plugins.plugin = sortArtifacts(project.build.pluginManagement.plugins.plugin); | ||
| } | ||
| } | ||
| if (Array.isArray(project.profiles?.profile)) { | ||
| project.profiles.profile = sortProfiles(project.profiles.profile); | ||
| } | ||
| return project; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /** | ||
| * Copyright 2013-2024 the original author or authors from the JHipster project. | ||
| * | ||
| * This file is part of the JHipster project, see https://www.jhipster.tech/ | ||
| * for more information. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| import { XMLParser, XMLBuilder, XmlBuilderOptions, X2jOptions } from 'fast-xml-parser'; | ||
|
|
||
| import { defaultXmlBuildOptions, defaultXmlParserOptions } from '../internal/xml-store.js'; | ||
| import { sortPomProject } from '../internal/pom-project-sort.js'; | ||
|
|
||
| type SortPomFileOptions = { xmlParserOptions?: Partial<X2jOptions>; xmlBuildOptions?: Partial<XmlBuilderOptions> }; | ||
|
|
||
| export const sortPomFile = (pomFile: string, { xmlParserOptions, xmlBuildOptions }: SortPomFileOptions = {}): string => { | ||
| const parser = new XMLParser({ ...defaultXmlParserOptions, ...xmlParserOptions }); | ||
| const pomObject = parser.parse(pomFile); | ||
| pomObject.project = sortPomProject(pomObject.project); | ||
|
|
||
| const builder = new XMLBuilder({ ...defaultXmlBuildOptions, ...xmlBuildOptions }); | ||
| return builder.build(pomObject); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters