first commit

.github/pull_request_template.md

@@ -0,0 +1,28 @@
+<!--
+
+Thank you for your contribution! 👍
+
+-->
+
+## Types of changes
+
+- [ ] Bug fixes
+  - resolves #<!-- Please add issue number -->
+- [ ] Features
+  - resolves #<!-- Please add issue number -->
+- [ ] Maintenance
+- [ ] Documentation
+
+## Changes
+
+- ...
+
+
+## Additional context
+
+
+## Community note
+
+<!-- Please keep this section. -->
+
+Please upvote with reacting as :+1: to express your agreement.

.github/workflows/nodejs.yml

@@ -0,0 +1,60 @@
+name: Node.js CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: 'Test on Node:${{ matrix.node-version }} OS:${{ matrix.os }}'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node-version: [18, 20]
+        os: [ubuntu-latest]
+        include:
+          - os: windows-latest
+            node-version: 20
+    steps:
+      - uses: actions/checkout@v3
+      - name: setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        id: npm-cache
+        with:
+          path: 'node_modules'
+          key: ${{ runner.os }}-node-v${{ matrix.node-version }}-npm-${{ hashFiles('package-lock.json') }}
+      - run: npm install
+        if: steps.npm-cache.outputs.cache-hit != 'true'
+      - run: npm run lint
+        if: matrix.os != 'windows-latest'
+      - run: npm run typecheck
+      - run: npm test
+      - run: npm run build
+
+  release:
+    runs-on: ubuntu-latest
+    needs: test
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+      - uses: actions/cache@v2
+        id: npm-cache
+        with:
+          path: 'node_modules'
+          key: ${{ runner.os }}-node-v20-npm-${{ hashFiles('package-lock.json') }}
+      - run: npm install
+        if: steps.npm-cache.outputs.cache-hit != 'true'
+      - run: npm run build
+      - run: |
+          VERSION="$(node -e 'console.log(process.argv[1].match(/^refs\/tags\/v(\d+\.\d+\.\d+)$/)[1])' "${{ github.ref }}")"
+          node -e 'console.log(JSON.stringify({...require("./package.json"),version:process.argv[1]}, null, 2))' "$VERSION" | tee ./tmp-package.json
+          mv ./tmp-package.json ./package.json
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.prettierignore

@@ -0,0 +1,2 @@
+dist
+samples

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "plugins": ["prettier-plugin-organize-imports"]
+}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+  "eslint.run": "onSave",
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.referencesCodeLens.enabled": true,
+  "files.eol": "\n",
+  "editor.tabSize": 2,
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+  "files.trimFinalNewlines": true,
+  "explorer.fileNesting.enabled": true
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present, Solufa <[email protected]>
+
+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.

README.md

@@ -0,0 +1,22 @@
+# aspida to OpenAPI
+
+<br />
+<img src="https://aspida.github.io/aspida/logos/png/logo.png" alt="aspida" title="aspida" />
+<div align="center">
+  <a href="https://www.npmjs.com/package/aspida2openapi">
+    <img src="https://img.shields.io/npm/v/aspida2openapi" alt="npm version" />
+  </a>
+  <a href="https://www.npmjs.com/package/aspida2openapi">
+    <img src="https://img.shields.io/npm/dm/aspida2openapi" alt="npm download" />
+  </a>
+</div>
+<br />
+<p align="center">Convert aspida type definitions into OpenAPI 3.0 Specification.</p>
+<br />
+<br />
+
+## Getting Started
+
+## License
+
+aspida2openapi is licensed under a [MIT License](https://github.com/aspida/aspida2openapi/blob/main/LICENSE).

bin/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../dist/cli').run(process.argv.slice(2));

eslint.config.mjs

@@ -0,0 +1,26 @@
+import js from '@eslint/js';
+import gitignore from 'eslint-config-flat-gitignore';
+import prettierConfig from 'eslint-config-prettier';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  { files: ['**/*.ts'] },
+  gitignore(),
+  { ignores: ['samples'] },
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    languageOptions: { globals: { ...globals.node, ...globals.es2020 } },
+    rules: {
+      eqeqeq: 'error',
+      'no-param-reassign': 'error',
+      'object-shorthand': ['error', 'always'],
+      'prefer-template': 'error',
+      '@typescript-eslint/consistent-type-imports': 'error',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
+  prettierConfig,
+);