@gyeonghokim/bruno-to-openapi 0.0.0

package/.github/workflows/release.yml

@@ -0,0 +1,35 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gyeongho Kim
+
+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,80 @@
+# Bruno to OpenAPI
+
+Convert Bruno collections to OpenAPI specifications with ease. This library provides a simple way to transform Bruno collection JSON files into standardized OpenAPI 3.x specifications.
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install @gyeonghokim/bruno-to-openapi
+```
+
+## Get Started
+
+Once installed, you can use the library to convert your Bruno collections to OpenAPI specifications. Below are examples showing how to export to both JSON and YAML formats.
+
+### JSON Export
+
+```javascript
+import { convertBrunoToOpenAPI } from '@gyeonghokim/bruno-to-openapi';
+import fs from 'fs';
+
+// Load your Bruno collection JSON file
+import brunoCollection from './path-to-your-bruno-collection.json';
+
+// Convert Bruno collection to OpenAPI specification
+const openApiSpec = convertBrunoToOpenAPI(brunoCollection);
+
+// Save as JSON file
+fs.writeFileSync('openapi-spec.json', JSON.stringify(openApiSpec, null, 2));
+console.log('OpenAPI specification saved as openapi-spec.json');
+```
+
+### YAML Export
+
+To export as YAML, you can use the `js-yaml` library along with this package:
+
+```bash
+npm install js-yaml
+```
+
+```javascript
+import { convertBrunoToOpenAPI } from '@gyeonghokim/bruno-to-openapi';
+import yaml from 'js-yaml';
+import fs from 'fs';
+
+// Load your Bruno collection JSON file
+import brunoCollection from './path-to-your-bruno-collection.json';
+
+// Convert Bruno collection to OpenAPI specification
+const openApiSpec = convertBrunoToOpenAPI(brunoCollection);
+
+// Convert to YAML and save
+const yamlString = yaml.dump(openApiSpec, { indent: 2 });
+fs.writeFileSync('openapi-spec.yaml', yamlString);
+console.log('OpenAPI specification saved as openapi-spec.yaml');
+```
+
+## Features
+
+- Converts Bruno collections to OpenAPI 3.x specifications
+- Supports all common HTTP methods and parameters
+- Handles authentication configurations
+- Preserves request/response examples
+- Maintains folder structures as tags
+- Supports both JSON and YAML output formats
+
+## API Reference
+
+The library exports a single function:
+
+- `convertBrunoToOpenAPI(brunoCollection)`: Takes a Bruno collection object and returns an OpenAPI specification object.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License.

package/biome.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.0.0/schema.json",
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "noStaticOnlyClass": "off"
+      }
+    }
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded",
+      "arrowParentheses": "asNeeded"
+    }
+  },
+  "files": {
+    "include": ["**/*.js", "**/*.ts", "**/*.jsx", "**/*.tsx"],
+    "ignore": [
+      "**/specs/**/*",
+      "**/tests/fixtures/**/*",
+      "**/node_modules/**/*",
+      "**/dist/**/*",
+      "**/build/**/*",
+      "**/*.json",
+      "**/*.md",
+      "**/*.yaml",
+      "**/*.yml"
+    ],
+    "ignoreUnknown": true
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@gyeonghokim/bruno-to-openapi",
+  "private": false,
+  "version": "0.0.0",
+  "description": "Convert Bruno API collections to OpenAPI 3.0 specification",
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check .",
+    "lint:fix": "biome check --apply .",
+    "format": "biome format .",
+    "format:write": "biome format --write .",
+    "typecheck": "npm run typecheck:app && npm run typecheck:test",
+    "typecheck:app": "tsc --noEmit",
+    "typecheck:test": "tsc --noEmit -p tsconfig.test.json"
+  },
+  "keywords": [
+    "bruno",
+    "openapi",
+    "api",
+    "specification",
+    "converter"
+  ],
+  "author": "GyeongHo Kim",
+  "license": "MIT",
+  "devDependencies": {
+    "@apidevtools/swagger-parser": "^12.1.0",
+    "@biomejs/biome": "^1.0.0",
+    "@types/node": "^18.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "removeComments": false,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "useUnknownInCatchVariables": true,
+    "sourceMap": true,
+    "types": ["node"],
+    "verbatimModuleSyntax": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "tests"
+  ]
+}

package/tsconfig.test.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "types": ["node", "vitest/globals"]
+  },
+  "include": [
+    "src/**/*",
+    "tests/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/vite.config.ts

@@ -0,0 +1,17 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    include: ['tests/**/*.test.{ts,js}'],
+    exclude: ['node_modules', 'dist', 'tests/fixtures'],
+    environment: 'node',
+    tsconfig: './tsconfig.test.json',
+    globals: true,
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+      include: ['src/**/*'],
+      exclude: ['src/types/**/*', 'src/**/*.d.ts', 'src/index.ts'],
+    },
+  },
+})