Merge branch 'acacode:main' into main

Author: JorensM

.env.example

@@ -1,2 +1,3 @@
-ko_fi: js2me
 custom: ["https://paypal.me/acacode"]
+github: smorimoto
+ko_fi: js2me

.github/FUNDING.yml

@@ -4,10 +4,11 @@ on:
   - push
   - pull_request
 
+permissions: read-all
+
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout tree
         uses: actions/checkout@v4
@@ -25,4 +26,4 @@ jobs:
         run: yarn format:check
 
       - name: Run the tests
-        run: yarn test-all
+        run: yarn test

.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+
+permissions: read-all
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tree
+        uses: actions/checkout@v4
+
+      - name: Set-up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          check-latest: true
+
+      - name: Publish
+        run: yarn npm publish --tolerate-republish
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/publish.yml

@@ -1,11 +1,3 @@
 /.yarn/*
 !/.yarn/releases
-
-/.idea/
-/.vscode/
-/dist/
 /node_modules/
-
-.env
-swagger-test-cli
-swagger-test-cli.*

.gitignore

@@ -1,5 +1,11 @@
+defaultSemverRangePrefix: ""
+
 nodeLinker: node-modules
 
+npmRegistries:
+  //registry.npmjs.org:
+    npmAuthToken: "${NPM_AUTH_TOKEN:-''}"
+
 preferInteractive: true
 
-yarnPath: .yarn/releases/yarn-4.2.2.cjs
+yarnPath: .yarn/releases/yarn-4.3.1.cjs

.yarn/releases/yarn-4.2.2.cjs renamed to .yarn/releases/yarn-4.3.1.cjs

@@ -19,4 +19,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

.yarnrc.yml

@@ -1,30 +1,15 @@
 # swagger-typescript-api
 
-<img
-  src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo.png"
-  title="swagger-typescript-api logo by js2me"
-  align="left"
-  height="180"
-  width="93"
-/>
+- Support for OpenAPI 3.0, 2.0, JSON and YAML
+- Generate the API Client for Fetch or Axios from an OpenAPI Specification
 
-- Generate api via swagger scheme
-- Supports OA 3.0, 2.0, JSON, yaml
-- Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or [**Axios**](https://github.com/axios/axios) to make requests.
+Any questions you can ask [**here**](https://github.com/acacode/swagger-typescript-api/discussions)
 
-<br>
+## Examples
 
-Any questions you can ask [**here**](https://github.com/acacode/swagger-typescript-api/issues) or in [**our Slack**](https://join.slack.com/t/acacode/shared_invite/enQtOTQ5ODgyODQzMzYwLWYxOGI1MzQ3Yzg1ZWI5ZTI5NzNiZjExZTE5OWI1YjQ4NjBiNTk4NWVlNjM5YmU1ZWI2ZDkyMzZkZGIxNjA5NTQ)(**#swagger-typescript-api** channel)
+All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/main/tests)
 
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/components-converter-example.jpg)
-
-Thanks to [JetBrains](https://www.jetbrains.com/?from=swaggertypescriptapi) for providing a free license for their excellent Webstorm IDE.
-
-## 👀 Examples
-
-All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/master/tests)
-
-## 📄 Usage
+## Usage
 
 ```muse
 Usage: sta [options]
@@ -203,7 +188,7 @@ generateTemplates({
 });
 ```
 
-## 💎 options
+## Options
 
 ### **`--templates`**
 
@@ -487,21 +472,13 @@ generateApi({
 
 See more about [swagger schema type/format data here](https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times)
 
-## 📄 Mass media
+## Mass media
 
 - [5 Lessons learned about swagger-typescript-api](https://christo8989.medium.com/5-lessons-learned-about-swagger-typescript-api-511240b34c1)
 - [Why Swagger schemes are needed in frontend development ?](https://dev.to/js2me/why-swagger-schemes-are-needed-in-frontend-development-2cb4)
 - [Migration en douceur vers TypeScript (French)](https://www.premieroctet.com/blog/migration-typescript/)
 - [swagger-typescript-api usage (Japanese)](https://zenn.dev/watahaya/articles/2f4a716c47903b)
 
-## 🚀 How it looks
-
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/npx.gif)
-
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/auth-example.gif)
-
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/typings1.gif)
-
-## 📝 License
+## License
 
-Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/master/LICENSE).
+Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/main/LICENSE).

LICENSE

@@ -1,15 +1,7 @@
 {
   "$schema": "node_modules/@biomejs/biome/configuration_schema.json",
   "files": {
-    "ignore": [
-      "package.json",
-      "tests/**/expected.ts",
-      "tests/**/expected/**",
-      "tests/**/generated/**",
-      "tests/**/schema.d.ts",
-      "tests/**/schema.js",
-      "tests/**/schema.ts"
-    ],
+    "ignore": ["package.json"],
     "maxSize": 10000000
   },
   "formatter": {

README.md

@@ -3,8 +3,4 @@ const skip_command = Symbol("skip");
 
 const reservedOptions = ["version", "help"];
 
-module.exports = {
-  root_command,
-  skip_command,
-  reservedOptions,
-};
+export { root_command, skip_command, reservedOptions };

assets/auth-example.gif

@@ -1,7 +1,7 @@
-const _ = require("lodash");
-const { root_command, skip_command } = require("./constants");
-const { parseArgs } = require("./parse-args");
-const didYouMean = require("didyoumean");
+import didYouMean from "didyoumean";
+import _ from "lodash";
+import { root_command, skip_command } from "./constants.js";
+import { parseArgs } from "./parse-args.js";
 
 didYouMean.threshold = 0.5;
 
@@ -177,6 +177,4 @@ const processArgs = (commands, args) => {
   };
 };
 
-module.exports = {
-  execute,
-};
+export { execute };

assets/components-converter-example.jpg

@@ -1,18 +1,19 @@
 type CliStructOption = {
-  flags?: string;
-  description?: string;
   default?: unknown;
+  description?: string;
+  flags?: string;
   internal?: { name?: string; formatter?: (value: any) => any };
+  required?: boolean;
 };
 
 type CliStruct = {
-  inherited?: string | null;
-  name?: string;
   alias?: string;
-  version?: string;
+  commands?: CliStruct[];
   description?: string;
+  inherited?: string | null;
+  name?: string;
   options: CliStructOption[];
-  commands?: CliStruct[];
+  version?: string;
 };
 
 type ExecuteOptions = {

assets/npx.gif

@@ -1,9 +1,9 @@
-const _ = require("lodash");
-const { reservedOptions, root_command } = require("./constants");
-const { processOption } = require("./process-option");
-const { execute } = require("./execute");
-const { displayHelp } = require("./operations/display-help");
-const { displayVersion } = require("./operations/display-version");
+import _ from "lodash";
+import { reservedOptions, root_command } from "./constants.js";
+import { execute } from "./execute.js";
+import { displayHelp } from "./operations/display-help.js";
+import { displayVersion } from "./operations/display-version.js";
+import { processOption } from "./process-option.js";
 
 const cli = (input) => {
   const commands = {};
@@ -91,6 +91,4 @@ const cli = (input) => {
   return instance;
 };
 
-module.exports = {
-  cli,
-};
+export { cli };

assets/swagger-typescript-api-logo.png

@@ -1,5 +1,5 @@
-const _ = require("lodash");
-const { root_command } = require("../constants");
+import _ from "lodash";
+import { root_command } from "../constants.js";
 
 const generateOptionsOutput = (options) =>
   options.reduce(
@@ -174,6 +174,4 @@ ${command.description}`
 ${outputTest}`);
 };
 
-module.exports = {
-  displayHelp,
-};
+export { displayHelp };

assets/typings1.gif

@@ -2,4 +2,4 @@ const displayVersion = (instance) => {
   console.log(instance.input.version);
 };
 
-module.exports = { displayVersion };
+export { displayVersion };

biome.json

@@ -21,6 +21,4 @@ const parseArgs = (args, type) => {
   }
 };
 
-module.exports = {
-  parseArgs,
-};
+export { parseArgs };

cli/constants.js

@@ -1,4 +1,4 @@
-const _ = require("lodash");
+import _ from "lodash";
 
 const optionFormatters = {
   number: (str) => +str,
@@ -72,6 +72,4 @@ const processOption = (option) => {
   };
 };
 
-module.exports = {
-  processOption,
-};
+export { processOption };

cli/execute.js

@@ -1,28 +1,23 @@
 #!/usr/bin/env node
 
-// Copyright (c) 2019-present acacode
-// Node module: swagger-typescript-api
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
-// Repository https://github.com/acacode/swagger-typescript-api
+import { createRequire } from "node:module";
+import { resolve } from "node:path";
+import { cli } from "./cli/index.js";
+import { TemplatesGenConfig } from "./src/commands/generate-templates/configuration.js";
+import { CodeGenConfig } from "./src/configuration.js";
+import { HTTP_CLIENT } from "./src/constants.js";
+import { generateApi, generateTemplates } from "./src/index.js";
 
-const { version, name } = require("./package.json");
-const { cli } = require("./cli");
-const { generateApi, generateTemplates } = require("./src");
-const { HTTP_CLIENT } = require("./src/constants");
-const { resolve } = require("node:path");
-const { CodeGenConfig } = require("./src/configuration");
-const {
-  TemplatesGenConfig,
-} = require("./src/commands/generate-templates/configuration");
+const require = createRequire(import.meta.url);
+const packageJson = require("./package.json");
 
 const codeGenBaseConfig = new CodeGenConfig({});
 const templateGenBaseConfig = new TemplatesGenConfig({});
 
 const program = cli({
-  name: name,
+  name: packageJson.name,
   alias: "sta",
-  version: version,
+  version: packageJson.version,
   description:
     "Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.",
   options: [