generator-begcode/dist/generators/maven/internal/pom-sort.js

Spring Boot + Angular/React/Vue in one handy generator

import sortKeys from 'sort-keys';
export const formatPomFirstLevel = content => content.replace(/(\n {4}<(?:groupId|distributionManagement|repositories|pluginRepositories|properties|dependencyManagement|dependencies|build|profiles)>)/g, '\n$1');
const rootAndProfileOrder = [
    'id',
    'activation',
    '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.apache.maven.plugins',
    '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, a, b) => {
    if (isComment(a))
        return -1;
    if (isComment(b))
        return 1;
    const indexOfA = toMaxInt(template.indexOf(a));
    const indexOfB = toMaxInt(template.indexOf(b));
    if (indexOfA === indexOfB) {
        return a.localeCompare(b);
    }
    return indexOfA - indexOfB;
};
const comparator = (order) => (a, b) => sortWithTemplate(order, a, b);
const sortProperties = properties => sortKeys(properties, { compare: comparator(propertiesOrder) });
const sortArtifacts = (artifacts) => artifacts.sort((a, b) => {
    if (a.scope === 'import' || b.scope === 'import') {
        if (a.scope === b.scope) {
            return 1;
        }
        return a.scope === 'import' ? -1 : 1;
    }
    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) => profiles.sort((a, b) => a.id?.localeCompare(b.id) ?? 1);
const sortProjectLike = (projectLike, options = {}) => {
    const { sortPlugins = true } = options;
    projectLike = sortKeys(projectLike, { compare: comparator(rootAndProfileOrder) });
    if (projectLike.properties) {
        projectLike.properties = sortProperties(projectLike.properties);
    }
    if (Array.isArray(projectLike.dependencies?.dependency)) {
        projectLike.dependencies.dependency = sortArtifacts(projectLike.dependencies.dependency);
    }
    if (Array.isArray(projectLike.dependencyManagement?.dependencies?.dependency)) {
        projectLike.dependencyManagement.dependencies.dependency = sortArtifacts(projectLike.dependencyManagement.dependencies.dependency);
    }
    if (projectLike.build) {
        projectLike.build = sortSection(projectLike.build);
        if (sortPlugins && Array.isArray(projectLike.build.plugins?.plugin)) {
            projectLike.build.plugins.plugin = sortArtifacts(projectLike.build.plugins.plugin);
        }
        if (Array.isArray(projectLike.build.pluginManagement?.plugins?.plugin)) {
            projectLike.build.pluginManagement.plugins.plugin = sortArtifacts(projectLike.build.pluginManagement.plugins.plugin);
        }
    }
    return projectLike;
};
export const sortPomProject = (project) => {
    project = sortProjectLike(project);
    if (Array.isArray(project.profiles?.profile)) {
        project.profiles.profile = sortProfiles(project.profiles.profile.map(profile => sortProjectLike(profile, { sortPlugins: false })));
    }
    else if (project.profiles?.profile) {
        project.profiles.profile = sortProjectLike(project.profiles.profile, { sortPlugins: false });
    }
    return project;
};