semantic-release-openapi 1.4.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Andrew Ensley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# semantic-release-openapi
+
+[![npm](https://img.shields.io/npm/v/@aensley/semantic-release-openapi)][npm]
+[![npm types](https://badgen.net/npm/types/@aensley/semantic-release-openapi?icon=typescript)][npm]
+[![license](https://img.shields.io/github/license/aensley/semantic-release-openapi.svg)](https://github.com/aensley/semantic-release-openapi/blob/main/LICENSE)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat)](https://standardjs.com)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://prettier.io)
+
+[![ci](https://github.com/aensley/semantic-release-openapi/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/aensley/semantic-release-openapi/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ac7dbc9a2d5e0bf8bd7d/maintainability)](https://codeclimate.com/github/aensley/semantic-release-openapi/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ac7dbc9a2d5e0bf8bd7d/test_coverage)](https://codeclimate.com/github/aensley/semantic-release-openapi/test_coverage)
+[![npm downloads](https://img.shields.io/npm/dw/@aensley/semantic-release-openapi)][npm]
+
+A Semantic Release plugin to update versions in OpenAPI / Swagger specification files.
+
+## Installation
+
+This module is distributed via npm and should be installed as one of your project's `devDependencies`:
+
+```bash
+npm install --save-dev @aensley/semantic-release-openapi
+```
+
+## Usage
+
+### Plugin Config
+
+This plugin has one configuration option which must be supplied.
+
+- **`apiSpecFiles`**: An array of OpenAPI / Swagger specification file paths. [Glob patterns](https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching) (e.g. `'*.yaml'`) are supported.
+
+  _All matching files must have a `.json`, `.yaml`, or `.yml` extension._
+
+### Committing Changes
+
+**IMPORTANT**: Semantic Release will not commit changes to your OpenAPI spec files unless you add the same files in `assets` for the **@semantic-release/git** plugin! See the example below.
+
+### Example
+
+```json
+{
+  "release": {
+    "plugins": [
+      [
+        "@aensley/semantic-release-openapi",
+        {
+          "apiSpecFiles": ["openapi.yaml", "src/swagger-*.json"]
+        }
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": ["package.json", "openapi.yaml", "src/swagger-*.json"]
+        }
+      ]
+    ]
+  }
+}
+```
+
+[npm]: https://www.npmjs.com/package/@aensley/semantic-release-openapi

package/dist/@types/pluginConfig.d.ts

@@ -0,0 +1,3 @@
+export default interface PluginConfig {
+    apiSpecFiles: string[];
+}

package/dist/@types/pluginConfig.js

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

package/dist/@types/pluginConfig.js.map

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

package/dist/getReplaceInFile.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Dynamically imports and returns the default export from the 'replace-in-file' module.
+ *
+ * This function uses dynamic import to load the 'replace-in-file' package at runtime,
+ * which can help reduce initial load time and dependencies if the functionality is only
+ * needed conditionally.
+ *
+ * @returns A promise that resolves to the default export of the 'replace-in-file' module.
+ */
+export default function (): Promise<typeof import('replace-in-file').default>;

package/dist/getReplaceInFile.js

@@ -0,0 +1,13 @@
+/**
+ * Dynamically imports and returns the default export from the 'replace-in-file' module.
+ *
+ * This function uses dynamic import to load the 'replace-in-file' package at runtime,
+ * which can help reduce initial load time and dependencies if the functionality is only
+ * needed conditionally.
+ *
+ * @returns A promise that resolves to the default export of the 'replace-in-file' module.
+ */
+export default async function () {
+    return (await import('replace-in-file')).default;
+}
+//# sourceMappingURL=getReplaceInFile.js.map

package/dist/getReplaceInFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getReplaceInFile.js","sourceRoot":"","sources":["../src/getReplaceInFile.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK;IAClB,OAAO,CAAC,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAA;AAClD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { default as verifyConditions } from './verifyConditions.js';
+export { default as prepare } from './prepare.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export { default as verifyConditions } from './verifyConditions.js';
+export { default as prepare } from './prepare.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/dist/prepare.d.ts

@@ -0,0 +1,7 @@
+import PluginConfig from './@types/pluginConfig.js';
+/**
+ * prepare hook for semantic release
+ *
+ * @throws {SemanticReleaseError}
+ */
+export default function ({ apiSpecFiles }: PluginConfig, { nextRelease, logger }: any): Promise<any>;

package/dist/prepare.js

@@ -0,0 +1,83 @@
+import { readJsonSync, writeJsonSync } from 'fs-extra';
+import { fdir } from 'fdir';
+import getReplaceInFile from './getReplaceInFile.js';
+/**
+ * Prepare the API Spec files
+ *
+ * @param {string[]}          apiSpecFiles List of api spec file paths, globs supported
+ * @param {string}            version      The version string to write to the files
+ * @param {Context['logger']} logger       The semantic release logger instance
+ *
+ * @throws {SemanticReleaseError}
+ */
+const prepareApiSpecFiles = async (apiSpecFiles, version, logger) => {
+    const SemanticReleaseError = (await import('@semantic-release/error')).default;
+    try {
+        for (const fileNameGlob of apiSpecFiles) {
+            // eslint-disable-next-line new-cap
+            const fileNames = new fdir().withRelativePaths().glob(fileNameGlob).crawl('.').sync();
+            for (const fileName of fileNames) {
+                let results;
+                if (fileName.split('.').pop() === 'json') {
+                    results = prepareApiSpecFileJson(fileName, version);
+                }
+                else {
+                    results = await prepareApiSpecFileYml(fileName, version);
+                }
+                results.forEach((resultFileName) => {
+                    logger.log('Wrote version %s to %s', version, resultFileName);
+                });
+            }
+        }
+    }
+    catch (error) {
+        throw new SemanticReleaseError(error);
+    }
+};
+/**
+ * Prepares a single API spec file in YAML format
+ *
+ * @param {string} apiSpecFile Single spec file to update, no globs
+ * @param {string} version     The version string to write to the file
+ *
+ * @returns {string[]} A list of altered files
+ */
+const prepareApiSpecFileYml = async (apiSpecFile, version) => {
+    const replace = await getReplaceInFile();
+    return replace
+        .sync({
+        files: apiSpecFile,
+        from: /version: ?.+$/im,
+        to: 'version: ' + version
+    })
+        .filter((result) => result.hasChanged)
+        .map((result) => result.file);
+};
+/**
+ * Prepares a single API spec file in JSON format
+ *
+ * @param {string} apiSpecFile Single spec file to update, no globs
+ * @param {string} version     The version string to write to the file
+ *
+ * @returns {string[]} A list of altered files
+ */
+const prepareApiSpecFileJson = (apiSpecFile, version) => {
+    const specFile = readJsonSync(apiSpecFile);
+    specFile.info.version = version;
+    writeJsonSync(apiSpecFile, specFile, { spaces: 2 });
+    return [apiSpecFile];
+};
+/**
+ * prepare hook for semantic release
+ *
+ * @throws {SemanticReleaseError}
+ */
+export default async function ({ apiSpecFiles }, { nextRelease, logger }) {
+    const version = nextRelease?.version ?? '';
+    if (version.length < 1) {
+        const SemanticReleaseError = (await import('@semantic-release/error')).default;
+        throw new SemanticReleaseError('Could not determine the version from semantic release.');
+    }
+    await prepareApiSpecFiles(apiSpecFiles, version, logger);
+}
+//# sourceMappingURL=prepare.js.map

package/dist/prepare.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepare.js","sourceRoot":"","sources":["../src/prepare.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAEtD,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC3B,OAAO,gBAAgB,MAAM,uBAAuB,CAAA;AAEpD;;;;;;;;GAQG;AACH,MAAM,mBAAmB,GAAG,KAAK,EAAE,YAAsB,EAAE,OAAe,EAAE,MAAW,EAAgB,EAAE;IACvG,MAAM,oBAAoB,GAAG,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAA;IAC9E,IAAI,CAAC;QACH,KAAK,MAAM,YAAY,IAAI,YAAY,EAAE,CAAC;YACxC,mCAAmC;YACnC,MAAM,SAAS,GAAa,IAAI,IAAI,EAAE,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;YAC/F,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,IAAI,OAAiB,CAAA;gBACrB,IAAI,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,MAAM,EAAE,CAAC;oBACzC,OAAO,GAAG,sBAAsB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;gBACrD,CAAC;qBAAM,CAAC;oBACN,OAAO,GAAG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;gBAC1D,CAAC;gBACD,OAAO,CAAC,OAAO,CAAC,CAAC,cAAsB,EAAE,EAAE;oBACzC,MAAM,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;gBAC/D,CAAC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,MAAM,IAAI,oBAAoB,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,qBAAqB,GAAG,KAAK,EAAE,WAAmB,EAAE,OAAe,EAAqB,EAAE;IAC9F,MAAM,OAAO,GAAG,MAAM,gBAAgB,EAAE,CAAA;IACxC,OAAQ,OAAe;SACpB,IAAI,CAAC;QACJ,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,iBAAiB;QACvB,EAAE,EAAE,WAAW,GAAG,OAAO;KAC1B,CAAC;SACD,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;SAC1C,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;AACtC,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,sBAAsB,GAAG,CAAC,WAAmB,EAAE,OAAe,EAAY,EAAE;IAChF,MAAM,QAAQ,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;IAC1C,QAAQ,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IAC/B,aAAa,CAAC,WAAW,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAA;IACnD,OAAO,CAAC,WAAW,CAAC,CAAA;AACtB,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,WAAW,EAAE,YAAY,EAAgB,EAAE,EAAE,WAAW,EAAE,MAAM,EAAO;IACzF,MAAM,OAAO,GAAG,WAAW,EAAE,OAAO,IAAI,EAAE,CAAA;IAC1C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,oBAAoB,GAAG,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAA;QAC9E,MAAM,IAAI,oBAAoB,CAAC,wDAAwD,CAAC,CAAA;IAC1F,CAAC;IACD,MAAM,mBAAmB,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;AAC1D,CAAC"}

package/dist/verifyConditions.d.ts

@@ -0,0 +1,7 @@
+import PluginConfig from './@types/pluginConfig.js';
+/**
+ * verifyConditions hook for semantic release
+ *
+ * @throws {SemanticReleaseError}
+ */
+export default function ({ apiSpecFiles }: PluginConfig): Promise<any>;

package/dist/verifyConditions.js

@@ -0,0 +1,30 @@
+import { fdir } from 'fdir';
+/**
+ * verifyConditions hook for semantic release
+ *
+ * @throws {SemanticReleaseError}
+ */
+export default async function ({ apiSpecFiles }) {
+    const SemanticReleaseError = (await import('@semantic-release/error')).default;
+    if (apiSpecFiles.length < 1) {
+        throw new SemanticReleaseError('Option "apiSpecFiles" was not included in the plugin config. See the README for instructions.', 'ENOAPISPECFILES');
+    }
+    const expectedExts = ['json', 'yaml', 'yml'];
+    let specFilesFound = false;
+    apiSpecFiles.forEach((fileNameGlob) => {
+        // eslint-disable-next-line new-cap
+        const fileNames = new fdir().glob(fileNameGlob).crawl('.').sync();
+        if (fileNames.length > 0) {
+            specFilesFound = true;
+            fileNames.forEach((fileName) => {
+                if (!expectedExts.includes(fileName.split('.').pop() ?? '')) {
+                    throw new SemanticReleaseError('File "' + fileName + '" is not valid. Must be a file with .json, .yaml, or .yml extension', 'EINVALIDAPISPECFILETYPE');
+                }
+            });
+        }
+    });
+    if (!specFilesFound) {
+        throw new SemanticReleaseError('No files match the paths in "apiSpecFiles". Check your plugin config and try again.', 'EINVALIDAPISPECFILES');
+    }
+}
+//# sourceMappingURL=verifyConditions.js.map

package/dist/verifyConditions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verifyConditions.js","sourceRoot":"","sources":["../src/verifyConditions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAG3B;;;;GAIG;AACH,MAAM,CAAC,OAAO,CAAC,KAAK,WAAW,EAAE,YAAY,EAAgB;IAC3D,MAAM,oBAAoB,GAAG,CAAC,MAAM,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAA;IAC9E,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,oBAAoB,CAC5B,+FAA+F,EAC/F,iBAAiB,CAClB,CAAA;IACH,CAAC;IACD,MAAM,YAAY,GAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IACtD,IAAI,cAAc,GAAY,KAAK,CAAA;IACnC,YAAY,CAAC,OAAO,CAAC,CAAC,YAAoB,EAAE,EAAE;QAC5C,mCAAmC;QACnC,MAAM,SAAS,GAAa,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;QAC3E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,cAAc,GAAG,IAAI,CAAA;YACrB,SAAS,CAAC,OAAO,CAAC,CAAC,QAAgB,EAAE,EAAE;gBACrC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;oBAC5D,MAAM,IAAI,oBAAoB,CAC5B,QAAQ,GAAG,QAAQ,GAAG,qEAAqE,EAC3F,yBAAyB,CAC1B,CAAA;gBACH,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;IACF,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,MAAM,IAAI,oBAAoB,CAC5B,qFAAqF,EACrF,sBAAsB,CACvB,CAAA;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,175 @@
+{
+  "name": "semantic-release-openapi",
+  "version": "1.4.1",
+  "description": "A Semantic Release plugin to update versions in OpenAPI / Swagger specification files",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aensley/semantic-release-openapi.git"
+  },
+  "keywords": [
+    "semantic-release",
+    "plugin",
+    "openapi",
+    "version",
+    "swagger",
+    "asyncapi"
+  ],
+  "author": {
+    "name": "Andrew Ensley",
+    "email": "aensley@users.noreply.github.com",
+    "url": "https://andrewensley.com"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/aensley/semantic-release-openapi/issues/new?template=bug-report.yml"
+  },
+  "funding": [
+    "https://github.com/sponsors/aensley",
+    "https://paypal.me/AndrewEnsley"
+  ],
+  "homepage": "https://github.com/aensley/semantic-release-openapi#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "dist/index.d.ts",
+  "source": "src/index.ts",
+  "files": [
+    "dist/**/*",
+    "src/**/*",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "platform": "node",
+  "dependencies": {
+    "@semantic-release/error": "^4.0.0",
+    "fdir": "^6.4.6",
+    "fs-extra": "^11.3.0",
+    "picomatch": "^4.0.2",
+    "replace-in-file": "^8.3.0"
+  },
+  "devDependencies": {
+    "@semantic-release/git": "^10.0.1",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^29",
+    "@types/node": "^24.0.10",
+    "@types/picomatch": "^4.0.0",
+    "@types/semantic-release": "^20.0.6",
+    "@types/semantic-release__error": "^3.0.3",
+    "jest": "^29",
+    "pre-commit": "^1.2.2",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29",
+    "ts-node": "^10.9.2",
+    "ts-standard": "^12.0.2",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "semantic-release": ">=20.0.0"
+  },
+  "scripts": {
+    "pre-commit-msg": "echo Running pre-commit checks...",
+    "build": "tsc --build",
+    "format": "prettier --write .",
+    "test": "ts-standard && prettier --check . && jest --coverage --verbose",
+    "lint": "ts-standard && prettier --check .",
+    "setup": "npm install && npm run prepare-hook",
+    "update": "npx npm-check-updates -u && npm update"
+  },
+  "pre-commit": {
+    "run": [
+      "pre-commit-msg",
+      "test"
+    ],
+    "silent": true,
+    "colors": true
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/github",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json"
+          ]
+        }
+      ]
+    ]
+  },
+  "eslintConfig": {
+    "extends": "standard-with-typescript",
+    "parserOptions": {
+      "project": "./tsconfig.json"
+    }
+  },
+  "ts-standard": {
+    "globals": [],
+    "ignore": [
+      "/test/**/*.ts"
+    ]
+  },
+  "prettier": {
+    "tabWidth": 2,
+    "printWidth": 120,
+    "useTabs": false,
+    "endOfLine": "lf",
+    "trailingComma": "none",
+    "semi": false,
+    "singleQuote": true,
+    "arrowParens": "always",
+    "bracketSameLine": true,
+    "bracketSpacing": true,
+    "embeddedLanguageFormatting": "auto",
+    "htmlWhitespaceSensitivity": "css",
+    "insertPragma": false,
+    "jsxSingleQuote": false,
+    "proseWrap": "preserve",
+    "quoteProps": "as-needed",
+    "requirePragma": false,
+    "vueIndentScriptAndStyle": false
+  },
+  "jest": {
+    "preset": "ts-jest/presets/default-esm",
+    "testEnvironment": "node",
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "useESM": true
+        }
+      ]
+    },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    },
+    "testMatch": [
+      "**/test/**/*.test.ts"
+    ],
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "json",
+      "node"
+    ],
+    "coverageDirectory": "./coverage",
+    "collectCoverageFrom": [
+      "src/**/*.{ts,js}"
+    ],
+    "transformIgnorePatterns": [
+      "/node_modules/(?!@semantic-release/error)"
+    ]
+  }
+}

package/src/@types/pluginConfig.ts

@@ -0,0 +1,3 @@
+export default interface PluginConfig {
+  apiSpecFiles: string[]
+}

package/src/getReplaceInFile.ts

@@ -0,0 +1,12 @@
+/**
+ * Dynamically imports and returns the default export from the 'replace-in-file' module.
+ *
+ * This function uses dynamic import to load the 'replace-in-file' package at runtime,
+ * which can help reduce initial load time and dependencies if the functionality is only
+ * needed conditionally.
+ *
+ * @returns A promise that resolves to the default export of the 'replace-in-file' module.
+ */
+export default async function (): Promise<typeof import('replace-in-file').default> {
+  return (await import('replace-in-file')).default
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { default as verifyConditions } from './verifyConditions.js'
+export { default as prepare } from './prepare.js'

package/src/prepare.ts

@@ -0,0 +1,85 @@
+import { readJsonSync, writeJsonSync } from 'fs-extra'
+import PluginConfig from './@types/pluginConfig.js'
+import { fdir } from 'fdir'
+import getReplaceInFile from './getReplaceInFile.js'
+
+/**
+ * Prepare the API Spec files
+ *
+ * @param {string[]}          apiSpecFiles List of api spec file paths, globs supported
+ * @param {string}            version      The version string to write to the files
+ * @param {Context['logger']} logger       The semantic release logger instance
+ *
+ * @throws {SemanticReleaseError}
+ */
+const prepareApiSpecFiles = async (apiSpecFiles: string[], version: string, logger: any): Promise<any> => {
+  const SemanticReleaseError = (await import('@semantic-release/error')).default
+  try {
+    for (const fileNameGlob of apiSpecFiles) {
+      // eslint-disable-next-line new-cap
+      const fileNames: string[] = new fdir().withRelativePaths().glob(fileNameGlob).crawl('.').sync()
+      for (const fileName of fileNames) {
+        let results: string[]
+        if (fileName.split('.').pop() === 'json') {
+          results = prepareApiSpecFileJson(fileName, version)
+        } else {
+          results = await prepareApiSpecFileYml(fileName, version)
+        }
+        results.forEach((resultFileName: string) => {
+          logger.log('Wrote version %s to %s', version, resultFileName)
+        })
+      }
+    }
+  } catch (error: any) {
+    throw new SemanticReleaseError(error)
+  }
+}
+
+/**
+ * Prepares a single API spec file in YAML format
+ *
+ * @param {string} apiSpecFile Single spec file to update, no globs
+ * @param {string} version     The version string to write to the file
+ *
+ * @returns {string[]} A list of altered files
+ */
+const prepareApiSpecFileYml = async (apiSpecFile: string, version: string): Promise<string[]> => {
+  const replace = await getReplaceInFile()
+  return (replace as any)
+    .sync({
+      files: apiSpecFile,
+      from: /version: ?.+$/im,
+      to: 'version: ' + version
+    })
+    .filter((result: any) => result.hasChanged)
+    .map((result: any) => result.file)
+}
+
+/**
+ * Prepares a single API spec file in JSON format
+ *
+ * @param {string} apiSpecFile Single spec file to update, no globs
+ * @param {string} version     The version string to write to the file
+ *
+ * @returns {string[]} A list of altered files
+ */
+const prepareApiSpecFileJson = (apiSpecFile: string, version: string): string[] => {
+  const specFile = readJsonSync(apiSpecFile)
+  specFile.info.version = version
+  writeJsonSync(apiSpecFile, specFile, { spaces: 2 })
+  return [apiSpecFile]
+}
+
+/**
+ * prepare hook for semantic release
+ *
+ * @throws {SemanticReleaseError}
+ */
+export default async function ({ apiSpecFiles }: PluginConfig, { nextRelease, logger }: any): Promise<any> {
+  const version = nextRelease?.version ?? ''
+  if (version.length < 1) {
+    const SemanticReleaseError = (await import('@semantic-release/error')).default
+    throw new SemanticReleaseError('Could not determine the version from semantic release.')
+  }
+  await prepareApiSpecFiles(apiSpecFiles, version, logger)
+}

package/src/verifyConditions.ts

@@ -0,0 +1,40 @@
+import { fdir } from 'fdir'
+import PluginConfig from './@types/pluginConfig.js'
+
+/**
+ * verifyConditions hook for semantic release
+ *
+ * @throws {SemanticReleaseError}
+ */
+export default async function ({ apiSpecFiles }: PluginConfig): Promise<any> {
+  const SemanticReleaseError = (await import('@semantic-release/error')).default
+  if (apiSpecFiles.length < 1) {
+    throw new SemanticReleaseError(
+      'Option "apiSpecFiles" was not included in the plugin config. See the README for instructions.',
+      'ENOAPISPECFILES'
+    )
+  }
+  const expectedExts: string[] = ['json', 'yaml', 'yml']
+  let specFilesFound: boolean = false
+  apiSpecFiles.forEach((fileNameGlob: string) => {
+    // eslint-disable-next-line new-cap
+    const fileNames: string[] = new fdir().glob(fileNameGlob).crawl('.').sync()
+    if (fileNames.length > 0) {
+      specFilesFound = true
+      fileNames.forEach((fileName: string) => {
+        if (!expectedExts.includes(fileName.split('.').pop() ?? '')) {
+          throw new SemanticReleaseError(
+            'File "' + fileName + '" is not valid. Must be a file with .json, .yaml, or .yml extension',
+            'EINVALIDAPISPECFILETYPE'
+          )
+        }
+      })
+    }
+  })
+  if (!specFilesFound) {
+    throw new SemanticReleaseError(
+      'No files match the paths in "apiSpecFiles". Check your plugin config and try again.',
+      'EINVALIDAPISPECFILES'
+    )
+  }
+}