semantic-release-minecraft 1.1.2 → 1.2.0

package/src/prepare.ts

@@ -1,37 +1,38 @@
 import axios from 'axios';
-import { NextRelease } from 'semantic-release';
+import { PrepareContext } from 'semantic-release';
 import {
     BUKKIT_GAME_VERSION_TYPE,
     CurseForgeGameVersion,
     CurseForgeGameVersionMap,
     CurseForgeGameVersionType,
 } from './definitions/curseforge.js';
-import { Plugin_config } from './definitions/plugin_config.js';
-import { getCurseForgeModLoaders, toArray } from './utils/utils.js';
+import { PluginConfig } from './definitions/plugin-config';
+import { getCurseForgeModLoaders } from './utils/platform/curseforge-utils';
+import { toArray } from './utils/utils.js';
 
 /**
- * 根据提供的游戏版本联合对象检索游戏版本 ID 变体数组。
+ * Get CurseForge game version IDs based on the plugin configuration.
  */
 export async function getCurseForgeGameVersionIds(
     apiToken: string,
-    pluginConfig: Plugin_config,
-    env: Record<string, string>,
-    nextRelease: NextRelease
+    pluginConfig: PluginConfig,
+    context: PrepareContext
 ): Promise<number[]> {
+    const { nextRelease } = context;
+
     const curseforgeConfig = pluginConfig.curseforge!;
 
-    const modLoaders = getCurseForgeModLoaders(pluginConfig, env, nextRelease);
-    const javaVersions = toArray(curseforgeConfig.java_versions || []);
+    const modLoaders = getCurseForgeModLoaders(pluginConfig, nextRelease);
+
+    const javaVersions = toArray(curseforgeConfig.java_versions);
     const gameVersions = toArray(
-        curseforgeConfig.game_versions || pluginConfig.game_versions || []
+        curseforgeConfig.game_versions || pluginConfig.game_versions
     );
     const pluginGameVersions = toArray(
-        curseforgeConfig.game_versions_for_plugins || []
-    );
-    const addonGameVersions = toArray(
-        curseforgeConfig.game_versions_for_addon || []
+        curseforgeConfig.game_versions_for_plugins
     );
-    const environments = toArray(curseforgeConfig.environments || []);
+    const addonGameVersions = toArray(curseforgeConfig.game_versions_for_addon);
+    const environments = toArray(curseforgeConfig.environments);
 
     const map = await createCurseForgeGameVersionMap(apiToken);
 
@@ -42,12 +43,9 @@ export async function getCurseForgeGameVersionIds(
     // TODO: Modrinth 和 CurseForge 的游戏版本命名格式转化，以 Modrinth 为基准
     // const gameVersionNames = gameVersions.map(x => formatCurseForgeGameVersionSnapshot(x));
 
-    // 模组的游戏版本名称
     const gameVersionIds = findCurseForgeGameVersionIdsByNames(
         map.game_versions,
-        gameVersions,
-        undefined,
-        CURSEFORGE_GAME_VERSION_SNAPSHOT_NAME_COMPARER
+        gameVersions
     );
 
     const loaderIds = findCurseForgeGameVersionIdsByNames(
@@ -60,13 +58,11 @@ export async function getCurseForgeGameVersionIds(
         javaVersionNames
     );
 
-    // 插件的游戏版本名称
     const pluginGameVersionIds = findCurseForgeGameVersionIdsByNames(
         map.game_versions_for_plugins,
         pluginGameVersions
     );
 
-    // 附加组件的游戏版本名称
     const addonGameVersionIds = findCurseForgeGameVersionIdsByNames(
         map.game_versions_for_addons,
         addonGameVersions
@@ -89,7 +85,9 @@ export async function getCurseForgeGameVersionIds(
     return curseforgeGameVersionIds;
 }
 
-// 创建一个 CurseForge 游戏版本映射，通过根据类型名称对游戏版本类型进行分类。
+/**
+ * Create a CurseForge game version map by categorizing game versions based on their type names.
+ */
 async function createCurseForgeGameVersionMap(
     apiToken: string
 ): Promise<CurseForgeGameVersionMap> {
@@ -120,18 +118,9 @@ async function createCurseForgeGameVersionMap(
     };
 }
 
-function filterGameVersionsByTypeName(
-    versions: CurseForgeGameVersion[],
-    types: CurseForgeGameVersionType[],
-    typeName: string
-): CurseForgeGameVersion[] {
-    const filteredTypes = types.filter((x) => x.slug.startsWith(typeName));
-    return versions.filter((v) =>
-        filteredTypes.some((t) => t.id === v.gameVersionTypeID)
-    );
-}
-
-// 获取 CurseForge 游戏版本和版本类型信息
+/**
+ * Fetch CurseForge game version and version type information.
+ */
 async function fetchCurseForgeGameVersionInfo(apiToken: string): Promise<{
     versions: CurseForgeGameVersion[];
     types: CurseForgeGameVersionType[];
@@ -158,7 +147,7 @@ async function fetchCurseForgeGameVersionInfo(apiToken: string): Promise<{
         gameVersionTypesRes.data as CurseForgeGameVersionType[];
 
     if (!gameVersionTypes.some((x) => x.id === BUKKIT_GAME_VERSION_TYPE.id)) {
-        gameVersionTypes.unshift(BUKKIT_GAME_VERSION_TYPE);
+        gameVersionTypes.push(BUKKIT_GAME_VERSION_TYPE);
     }
 
     return {
@@ -167,33 +156,35 @@ async function fetchCurseForgeGameVersionInfo(apiToken: string): Promise<{
     };
 }
 
+/**
+ * Filter game versions by their type name prefix.
+ */
+function filterGameVersionsByTypeName(
+    versions: CurseForgeGameVersion[],
+    types: CurseForgeGameVersionType[],
+    typeName: string
+): CurseForgeGameVersion[] {
+    const filteredTypes = types.filter((x) => x.slug.startsWith(typeName));
+    return versions.filter((v) =>
+        filteredTypes.some((t) => t.id === v.gameVersionTypeID)
+    );
+}
+
+/**
+ * Find CurseForge game version IDs by their names using a custom comparer.
+ */
 function findCurseForgeGameVersionIdsByNames(
     versions: { id: number; name: string }[],
     names: string[],
     comparer: (a: string, b: string) => boolean = (a, b) =>
-        a.toLowerCase() === b.toLowerCase(),
-    fallbackComparer?: (a: string, b: string) => boolean
+        a.toLowerCase() === b.toLowerCase()
 ): number[] {
     const result: number[] = [];
 
     for (const name of names) {
         let version = versions.find((v) => comparer(v.name, name));
-        if (!version && fallbackComparer) {
-            version = versions.find((v) => fallbackComparer(v.name, name));
-        }
         if (version) result.push(version.id);
     }
 
-    return [...new Set(result)];
+    return result;
 }
-
-/**
- * 比较器：忽略名称中的 "-Snapshot" 后缀
- */
-export const CURSEFORGE_GAME_VERSION_SNAPSHOT_NAME_COMPARER = (
-    a: string,
-    b: string
-): boolean => {
-    const normalize = (s: string) => s?.replace(/-snapshot$/i, '') ?? '';
-    return normalize(a).toLowerCase() === normalize(b).toLowerCase();
-};

package/src/utils/glob-utils.ts

@@ -0,0 +1,38 @@
+import { glob } from 'glob';
+import { resolve } from 'path';
+import { PublishContext } from 'semantic-release';
+
+/**
+ * Find files based on provided glob patterns.
+ */
+export async function findFilesByGlob(
+    patterns: string[] = [
+        'build/libs/!(*-@(dev|sources|javadoc)).jar',
+        'build/libs/*-@(dev|sources|javadoc).jar',
+    ],
+    context: PublishContext
+): Promise<string[]> {
+    const { logger, cwd } = context;
+
+    const allFiles: string[] = [];
+
+    for (const pattern of patterns) {
+        logger.log(`Searching for files with pattern: ${pattern}`);
+        const files = await glob(pattern, {
+            cwd,
+            nodir: true,
+        });
+        allFiles.push(...files);
+    }
+
+    // 转换为绝对路径
+    const files = allFiles.map((file) => resolve(cwd!, file));
+
+    if (files.length === 0) {
+        throw new Error(
+            `No files found matching patterns: ${patterns.join(', ')}`
+        );
+    }
+
+    return files;
+}

package/src/utils/platform/curseforge-utils.ts

@@ -0,0 +1,17 @@
+import { NextRelease } from 'semantic-release';
+import { PluginConfig } from '../../definitions/plugin-config';
+import { renderTemplates, resolveAndRenderTemplates } from '../template-utils';
+
+export function getCurseForgeModLoaders(
+    pluginConfig: PluginConfig,
+    nextRelease: NextRelease
+): string[] {
+    return (
+        resolveAndRenderTemplates(
+            [pluginConfig.curseforge?.mod_loaders, pluginConfig.mod_loaders],
+            {
+                nextRelease,
+            }
+        ) || []
+    );
+}

package/src/utils/platform/utils.ts

@@ -0,0 +1,84 @@
+import { glob } from 'glob';
+import { resolve } from 'path';
+import { PublishContext } from 'semantic-release';
+import { PluginConfig } from '../../definitions/plugin-config';
+import { findFilesByGlob } from '../glob-utils';
+import { resolveAndRenderTemplates } from '../template-utils';
+
+/**
+ * Find files and primary file for publishing.
+ */
+export async function findFilesAndPrimaryFile(
+    pluginConfig: PluginConfig,
+    context: PublishContext,
+    strategy: Record<string, string>
+): Promise<{ files: string[]; primaryFile: string }> {
+    const { nextRelease, logger } = context;
+
+    const modrinthGlob = resolveAndRenderTemplates(
+        [pluginConfig.modrinth?.glob, pluginConfig.glob],
+        {
+            nextRelease,
+            ...strategy,
+        }
+    );
+
+    const files = await findFilesByGlob(modrinthGlob, context);
+    logger.log(
+        `Found ${files.length} file(s) for publishing: ${files.join(', ')}`
+    );
+
+    if (files.length === 0) {
+        throw new Error('No files found for publishing.');
+    }
+
+    const primaryPatterns = resolveAndRenderTemplates(
+        [
+            pluginConfig.modrinth?.primary_file_glob,
+            pluginConfig.primary_file_glob,
+        ],
+        {
+            nextRelease,
+            ...strategy,
+        }
+    );
+
+    if (primaryPatterns) {
+        let primaryCandidates: string[] = [];
+
+        for (const pattern of primaryPatterns) {
+            logger.log(`Searching for primary file with pattern: ${pattern}`);
+            const matches = await glob(pattern, {
+                cwd: context.cwd,
+                nodir: true,
+            });
+            primaryCandidates.push(
+                ...matches.map((file) => resolve(context.cwd!, file))
+            );
+        }
+
+        primaryCandidates = primaryCandidates.filter((file) =>
+            files.includes(file)
+        );
+
+        if (primaryCandidates.length === 1) {
+            const primaryFile = primaryCandidates[0];
+            logger.log(`Selected primary file: ${primaryFile}`);
+            return { files: files, primaryFile };
+        } else if (primaryCandidates.length > 1) {
+            throw new Error(
+                `Multiple files matched primary file glob. Please specify a more specific pattern. Found: ${primaryCandidates.join(', ')}`
+            );
+        } else {
+            throw new Error(
+                `No files matched primary file glob that were also in the main file list.`
+            );
+        }
+    } else if (files.length > 1) {
+        throw new Error(
+            `Multiple files found but no primary file glob specified. Please specify which file should be primary.`
+        );
+    } else {
+        return { files: files, primaryFile: files[0] };
+    }
+}

package/src/utils/template-utils.ts

@@ -0,0 +1,54 @@
+import lodash from 'lodash';
+import { toArray } from './utils';
+
+/**
+ * Renders one or more template strings sequentially using lodash.template.
+ *
+ * @param templates - A single template string or an array of template strings.
+ * @param context - The context object passed to each template during rendering.
+ * @returns An array of rendered strings.
+ */
+export function renderTemplates(
+    templates: string | string[],
+    context: Record<string, any>
+): string[] {
+    return toArray(templates).map((tpl) => lodash.template(tpl)(context));
+}
+
+/**
+ * Resolves the first non-empty template from multiple sources and renders it.
+ *
+ * @param sources - A list of template string sources, ordered by priority (highest first).
+ * @param context - The rendering context passed to lodash.template.
+ * @returns The rendered string, or undefined if no valid source is found.
+ */
+export function resolveAndRenderTemplate(
+    sources: Array<string | undefined | null>,
+    context: Record<string, any>
+): string | undefined {
+    const source = sources.find(Boolean);
+    if (!source) return undefined;
+
+    return lodash.template(source)(context);
+}
+
+/**
+ * Resolves the first non-empty template (or array of templates) from multiple sources
+ * and renders all templates sequentially.
+ *
+ * @param sources - A list of template sources (string or string array), ordered by priority.
+ * @param context - The rendering context passed to lodash.template.
+ * @returns An array of rendered strings, or undefined if no valid source is found.
+ */
+export function resolveAndRenderTemplates(
+    sources: Array<string | string[] | undefined | null>,
+    context: Record<string, any>
+): string[] | undefined {
+    const source = sources.find(Boolean);
+    if (!source) return undefined;
+
+    return renderTemplates(
+        typeof source === 'string' ? toArray(source) : source,
+        context
+    );
+}

package/src/utils/utils.ts

@@ -1,120 +1,10 @@
-import { glob } from 'glob';
-import _ from 'lodash';
-import { resolve } from 'path';
-import { NextRelease, PublishContext } from 'semantic-release';
-import { Plugin_config } from '../definitions/plugin_config.js';
-
 /**
- * 根据 glob 模式查找文件
- */
-export async function findFiles(
-    patterns: string[] = [
-        'build/libs/!(*-@(dev|sources|javadoc)).jar',
-        'build/libs/*-@(dev|sources|javadoc).jar',
-    ],
-    context: PublishContext
-): Promise<string[]> {
-    const { logger, cwd } = context;
-
-    const allFiles: string[] = [];
-
-    for (const pattern of patterns) {
-        logger.log(`Searching for files with pattern: ${pattern}`);
-        const files = await glob(pattern, {
-            cwd,
-            nodir: true,
-        });
-        allFiles.push(...files);
-    }
-
-    // 转换为绝对路径
-    const files = allFiles.map((file) => resolve(cwd!, file));
-
-    if (files.length === 0) {
-        throw new Error(
-            `No files found matching patterns: ${patterns.join(', ')}`
-        );
-    }
-
-    return files;
-}
-
-/**
- * 依次使用 lodash.template 渲染字符串数组。
- * @param templates 字符串模板数组
- * @param context 模板变量上下文对象
- * @returns 渲染后的字符串数组
- */
-export function renderTemplates(
-    templates: string[],
-    context: Record<string, any>
-): string[] {
-    return templates.map((tpl) => _.template(tpl)(context));
-}
-
-/**
- * 从多个来源中按优先级选择第一个非空模板并渲染。
- * @param sources 模板字符串来源（优先级从高到低）
- * @param context 模板渲染上下文（传给 lodash.template）
- * @returns 渲染后的字符串或 undefined
- */
-export function resolveTemplate(
-    sources: Array<string | undefined | null>,
-    context: Record<string, any>
-): string | undefined {
-    const source = sources.find(Boolean);
-    if (!source) return undefined;
-
-    return _.template(source)(context);
-}
-
-export function resolveMultipleTemplate(
-    sources: Array<string | string[] | undefined | null>,
-    context: Record<string, any>
-): string[] | undefined {
-    const source = sources.find(Boolean);
-    if (!source) return undefined;
-
-    return renderTemplates(
-        typeof source === 'string' ? toArray(source) : source,
-        context
-    );
-}
-
-/**
- * 确保给定的值总是以数组形式返回。
+ * Ensures that the given value is always returned as an array.
  *
- * @param value - 单个项目或项目数组。
- * @returns 如果不是数组，则将值包装在数组中返回。
+ * @param value - A single item, an array of items, or null/undefined.
+ * @returns An array. If the input is not an array, it will be wrapped into one.
  */
-export function toArray<T>(value: T | T[]): T[] {
+export function toArray<T>(value: T | T[] | undefined | null): T[] {
+    if (value == null) return [];
     return Array.isArray(value) ? value : [value];
 }
-
-export function getCurseForgeModLoaders(
-    pluginConfig: Plugin_config,
-    env: Record<string, string>,
-    nextRelease: NextRelease
-): string[] {
-    const curseforge = pluginConfig.curseforge;
-
-    let modLoaders: string[] | undefined;
-    if (curseforge?.mod_loaders && curseforge.mod_loaders.length > 0) {
-        modLoaders = renderTemplates(toArray(curseforge.mod_loaders), {
-            nextRelease,
-        });
-    } else if (
-        pluginConfig.mod_loaders &&
-        pluginConfig.mod_loaders.length > 0
-    ) {
-        modLoaders = renderTemplates(toArray(pluginConfig.mod_loaders), {
-            nextRelease,
-        }) as string[];
-    } else if (env.CURSEFORGE_MOD_LOADERS) {
-        modLoaders = env.CURSEFORGE_MOD_LOADERS.split(',').map((s) => s.trim());
-    } else if (env.MOD_LOADERS) {
-        modLoaders = env.MOD_LOADERS.split(',').map((s) => s.trim());
-    }
-
-    return modLoaders || [];
-}

package/dist/definitions/plugin_config.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin_config.d.ts","sourceRoot":"","sources":["../../src/definitions/plugin_config.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAExB,YAAY,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;IAC5C,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAClC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAGzB,UAAU,CAAC,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAClC,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAClC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACjC,yBAAyB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC9C,uBAAuB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAC5C,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QAChC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;QAC9C,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,4BAA4B,CAAC,EAAE,OAAO,CAAC;QACvC,SAAS,CAAC,EAAE;YACR,QAAQ,CAAC,EAAE,KAAK,CAAC;gBACb,IAAI,EAAE,MAAM,CAAC;gBACb,UAAU,CAAC,EAAE,MAAM,CAAC;gBACpB,IAAI,EACE,kBAAkB,GAClB,cAAc,GACd,qBAAqB,GACrB,qBAAqB,GACrB,MAAM,CAAC;aAChB,CAAC,CAAC;SACN,CAAC;QACF,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC5B,CAAC;IACF,QAAQ,CAAC,EAAE;QACP,UAAU,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;QACzB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,KAAK,CAAC;YACjB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,eAAe,EACT,UAAU,GACV,UAAU,GACV,cAAc,GACd,UAAU,CAAC;SACpB,CAAC,CAAC;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EACD,QAAQ,GACR,UAAU,GACV,OAAO,GACP,UAAU,GACV,WAAW,GACX,SAAS,CAAC;QAChB,gBAAgB,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,GAAG,UAAU,CAAC;QAChE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KACzC,CAAC;CACL,CAAC"}

package/dist/definitions/plugin_config.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=plugin_config.js.map

package/dist/definitions/plugin_config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin_config.js","sourceRoot":"","sources":["../../src/definitions/plugin_config.ts"],"names":[],"mappings":""}

package/src/definitions/plugin_config.ts

@@ -1,68 +0,0 @@
-export type Plugin_config = {
-    // 全局发布相关配置
-    release_type?: 'alpha' | 'beta' | 'release'; // 全局发布类型
-    game_versions?: string | string[]; // 全局游戏版本列表
-    mod_loaders?: string | string[]; // 全局模组加载器列表
-    display_name?: string;
-
-    // 全局文件查找相关配置（如果平台没有指定自己的 glob，则使用此配置）
-    glob?: string | string[]; // glob 模式，用于查找要发布的文件
-
-    // Minecraft 发布相关配置
-    curseforge?: {
-        project_id: string;
-        game_versions?: string | string[]; // CurseForge 专用的游戏版本列表
-        java_versions?: string | string[];
-        environments?: string | string[];
-        game_versions_for_plugins?: string | string[];
-        game_versions_for_addon?: string | string[];
-        mod_loaders?: string | string[]; // CurseForge 专用的模组加载器列表
-        changelog?: string;
-        changelog_type?: 'text' | 'html' | 'markdown';
-        display_name?: string; // 可选：网站上显示的友好名称
-        parent_file_id?: number; // 可选：此文件的父文件 ID
-        is_marked_for_manual_release?: boolean; // 可选：如果为 true，文件获批后不会立即发布
-        relations?: {
-            projects?: Array<{
-                slug: string; // 相关插件的 slug
-                project_id?: string; // 可选：用于精确匹配项目
-                type:
-                    | 'embedded_library'
-                    | 'incompatible'
-                    | 'optional_dependency'
-                    | 'required_dependency'
-                    | 'tool';
-            }>;
-        };
-        glob?: string | string[]; // CurseForge 专用的 glob 模式，用于查找要发布的 JAR 文件
-    };
-    modrinth?: {
-        project_id: string;
-        version_number?: string;
-        display_name?: string;
-        game_versions?: string[]; // Modrinth 专用的游戏版本列表
-        mod_loaders?: string[]; // Modrinth 专用的模组加载器列表
-        changelog?: string;
-        dependencies?: Array<{
-            version_id?: string; // 可选：依赖版本的 ID
-            project_id?: string; // 可选：依赖项目的 ID
-            file_name?: string; // 可选：依赖的文件名
-            dependency_type:
-                | 'required'
-                | 'optional'
-                | 'incompatible'
-                | 'embedded'; // 依赖类型
-        }>;
-        featured?: boolean; // 是否标记为特色版本
-        status?:
-            | 'listed'
-            | 'archived'
-            | 'draft'
-            | 'unlisted'
-            | 'scheduled'
-            | 'unknown'; // 版本状态
-        requested_status?: 'listed' | 'archived' | 'draft' | 'unlisted'; // 请求的状态
-        glob?: string | string[]; // Modrinth 专用的 glob 模式
-        primary_file_glob?: string | string[]; // 用于匹配主要文件的 glob 模式
-    };
-};