semantic-release-openapi 1.4.3 → 1.5.0

package/README.md

@@ -3,13 +3,11 @@
 [![npm](https://img.shields.io/npm/v/semantic-release-openapi)][npm]
 [![npm types](https://badgen.net/npm/types/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)
+[![npm downloads](https://img.shields.io/npm/dw/semantic-release-openapi)][npm]
 
 [![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://qlty.sh/gh/aensley/projects/semantic-release-openapi/maintainability.svg)](https://qlty.sh/gh/aensley/projects/semantic-release-openapi)
-[![Test Coverage](https://qlty.sh/gh/aensley/projects/semantic-release-openapi/coverage.svg)](https://qlty.sh/gh/aensley/projects/semantic-release-openapi)
-[![npm downloads](https://img.shields.io/npm/dw/semantic-release-openapi)][npm]
+[![Maintainability](https://qlty.sh/gh/aensley/projects/semantic-release-openapi/maintainability.svg)][qltysh]
+[![Test Coverage](https://qlty.sh/gh/aensley/projects/semantic-release-openapi/coverage.svg)][qltysh]
 
 A Semantic Release plugin to update versions in OpenAPI / Swagger specification files.
 
@@ -17,7 +15,7 @@ A Semantic Release plugin to update versions in OpenAPI / Swagger specification
 
 This module is distributed via npm and should be installed as one of your project's `devDependencies`:
 
-```bash
+```
 npm install --save-dev semantic-release-openapi
 ```
 
@@ -59,3 +57,4 @@ This plugin has one configuration option which must be supplied.
 ```
 
 [npm]: https://www.npmjs.com/package/semantic-release-openapi
+[qltysh]: https://qlty.sh/gh/aensley/projects/semantic-release-openapi

package/package.json

@@ -1,175 +1,52 @@
 {
-  "name": "semantic-release-openapi",
-  "version": "1.4.3",
-  "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)"
-    ]
-  }
+	"name": "semantic-release-openapi",
+	"version": "1.5.0",
+	"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": "index.js",
+	"module": "index.js",
+	"types": "index.d.ts",
+	"files": [
+		"**/*"
+	],
+	"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"
+	},
+	"peerDependencies": {
+		"semantic-release": ">=20.0.0"
+	}
 }

package/src/@types/pluginConfig.ts

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

package/src/getReplaceInFile.ts

@@ -1,12 +0,0 @@
-/**
- * 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

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

package/src/prepare.ts

@@ -1,87 +0,0 @@
-import fsExtra from 'fs-extra'
-import PluginConfig from './@types/pluginConfig.js'
-import { fdir } from 'fdir'
-import getReplaceInFile from './getReplaceInFile.js'
-
-const { readJsonSync, writeJsonSync } = fsExtra
-
-/**
- * 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

@@ -1,40 +0,0 @@
-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'
-    )
-  }
-}