Merge branch 'master' into master

Author: YousefHaggy

.browserslistrc

@@ -2,7 +2,7 @@
 maintained node versions
 
 [node-development]
-node 20.3.0
+node 22
 
 [browser-production]
 > 1%
@@ -26,4 +26,4 @@ maintained node versions
 last 1 chrome version
 last 1 firefox version
 last 1 safari version
-node 20.3.0
+node 22

.eslintrc

@@ -0,0 +1,78 @@
+/**
+ * @prettier
+ */
+const path = require("node:path")
+
+module.exports = {
+  parser: "@babel/eslint-parser",
+  env: {
+    browser: true,
+    node: true,
+    es6: true,
+    jest: true,
+    "jest/globals": true,
+  },
+  parserOptions: {
+    ecmaFeatures: { jsx: true },
+    babelOptions: { configFile: path.join(__dirname, "babel.config.js") },
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:prettier/recommended",
+  ],
+  plugins: ["react", "import", "jest", "prettier"],
+  settings: {
+    react: {
+      pragma: "React",
+      version: "15.0",
+    },
+  },
+  rules: {
+    semi: [2, "never"],
+    strict: 0,
+    quotes: [
+      2,
+      "double",
+      {
+        avoidEscape: true,
+        allowTemplateLiterals: true,
+      },
+    ],
+    "no-unused-vars": 2,
+    "no-multi-spaces": 1,
+    camelcase: [
+      "error",
+      {
+        allow: [
+          "^UNSAFE_",
+          "^requestSnippetGenerator_",
+          "^JsonSchema_",
+          "^curl_",
+          "^dom_",
+          "^api_",
+          "^client_",
+          "^grant_",
+          "^code_",
+          "^redirect_",
+          "^spec",
+        ],
+      },
+    ],
+    "no-use-before-define": [2, "nofunc"],
+    "no-underscore-dangle": 0,
+    "no-unused-expressions": 1,
+    "comma-dangle": 0,
+    "no-console": [
+      2,
+      {
+        allow: ["warn", "error"],
+      },
+    ],
+    "react/jsx-no-bind": 1,
+    "react/jsx-no-target-blank": 2,
+    "react/display-name": 0,
+    "import/no-extraneous-dependencies": 2,
+    "react/jsx-filename-extension": 2,
+  },
+}

.eslintrc.js

@@ -17,7 +17,7 @@ jobs:
       # will not occur.
       - name: Dependabot metadata
         id: dependabot-metadata
-        uses: dependabot/fetch-metadata@v2.2.0
+        uses: dependabot/fetch-metadata@v2.3.0
         with:
           github-token: "${{ secrets.GITHUB_TOKEN }}"
       # Here the PR gets approved.

.github/workflows/dependabot-merge.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Run Trivy vulnerability scanner
         uses: aquasecurity/trivy-action@master
         with:
-          image-ref: 'docker.io/swaggerapi/swagger-ui:unstable'
+          image-ref: 'docker.swagger.io/swaggerapi/swagger-ui:unstable'
           format: 'table'
           exit-code: '1'
           ignore-unfixed: true

.github/workflows/docker-image-check.yml

@@ -1,3 +1,4 @@
 {
-  "*.js": "eslint"
+  "*.{js,jsx}": ["eslint --max-warnings 0"],
+  "*.scss": ["stylelint '**/*.scss'"]
 }

.lintstagedrc

@@ -1 +1 @@
-20.3.0
+22.11.0

.nvmrc

@@ -1,13 +1,6 @@
 {
   "branches": [
-    {
-      "name": "master"
-    },
-    {
-      "name": "next",
-      "channel": "alpha",
-      "prerelease": "alpha"
-    }
+    {"name": "master"}
   ],
   "tagFormat": "v${version}",
   "plugins": [
@@ -21,15 +14,12 @@
     "@semantic-release/release-notes-generator",
     "@semantic-release/npm",
     "@semantic-release/github",
-    [
-      "@semantic-release/git",
-      {
-        "assets": [
-          "package.json",
-          "package-lock.json"
-        ],
-        "message": "chore(release): cut the ${nextRelease.version} release\n\n${nextRelease.notes}"
-      }
-    ]
+    ["@semantic-release/git", {
+      "assets": [
+        "package.json",
+        "package-lock.json"
+      ],
+      "message": "chore(release): cut the ${nextRelease.version} release\n\n${nextRelease.notes}"
+    }]
   ]
-}
+}

.releaserc

@@ -2,9 +2,16 @@
 # We don't declare them here — take a look at our docs.
 # https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md
 
-FROM nginx:1.27.3-alpine
+FROM nginx:1.27.4-alpine
 
-RUN apk add --update-cache --no-cache "nodejs"
+LABEL maintainer="vladimir.gorej@gmail.com" \
+      org.opencontainers.image.authors="vladimir.gorej@gmail.com" \
+      org.opencontainers.image.url="docker.swagger.io/swaggerapi/swagger-ui" \
+      org.opencontainers.image.source="https://github.com/swagger-api/swagger-ui" \
+      org.opencontainers.image.description="SwaggerUI Docker image" \
+      org.opencontainers.image.licenses="Apache-2.0"
+
+RUN apk add --update-cache --no-cache "nodejs" "libxml2>=2.13.4-r4"
 
 LABEL maintainer="char0n"
 

Dockerfile

@@ -6,7 +6,7 @@
 ![total GitHub contributors](https://img.shields.io/github/contributors-anon/swagger-api/swagger-ui.svg)
 
 ![monthly npm installs](https://img.shields.io/npm/dm/swagger-ui.svg?label=npm%20downloads)
-![total docker pulls](https://img.shields.io/docker/pulls/swaggerapi/swagger-ui.svg)
+![docker registry](https://img.shields.io/badge/docker-docker.swagger.io%2Fswaggerapi%2Fswagger--ui-blue)
 ![monthly packagist installs](https://img.shields.io/packagist/dm/swagger-api/swagger-ui.svg?label=packagist%20installs)
 ![gzip size](https://img.shields.io/bundlephobia/minzip/swagger-ui.svg?label=gzip%20size)
 
@@ -33,17 +33,18 @@ If you are looking for plain ol' HTML/JS/CSS, [download the latest release](http
 ## Compatibility
 The OpenAPI Specification has undergone 5 revisions since initial creation in 2010.  Compatibility between Swagger UI and the OpenAPI Specification is as follows:
 
-| Swagger UI Version | Release Date | OpenAPI Spec compatibility             | Notes                                                                 |
-|--------------------|--------------|----------------------------------------|-----------------------------------------------------------------------|
-| 5.0.0              | 2023-06-12   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | [tag v5.0.0](https://github.com/swagger-api/swagger-ui/tree/v5.0.0)   |
-| 4.0.0              | 2021-11-03   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3        | [tag v4.0.0](https://github.com/swagger-api/swagger-ui/tree/v4.0.0)   |
-| 3.18.3             | 2018-08-03   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3        | [tag v3.18.3](https://github.com/swagger-api/swagger-ui/tree/v3.18.3) |
-| 3.0.21             | 2017-07-26   | 2.0                                    | [tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21) |
-| 2.2.10             | 2017-01-04   | 1.1, 1.2, 2.0                          | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10) |
-| 2.1.5              | 2016-07-20   | 1.1, 1.2, 2.0                          | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5)   |
-| 2.0.24             | 2014-09-12   | 1.1, 1.2                               | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
-| 1.0.13             | 2013-03-08   | 1.1, 1.2                               | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) |
-| 1.0.1              | 2011-10-11   | 1.0, 1.1                               | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1)   |
+| Swagger UI Version | Release Date | OpenAPI Spec compatibility                           | Notes                                                                 |
+|--------------------|--------------|------------------------------------------------------|-----------------------------------------------------------------------|
+| 5.19.0             | 2025-02-17   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1 | [tag v5.19.0](https://github.com/swagger-api/swagger-ui/tree/v5.19.0) |
+| 5.0.0              | 2023-06-12   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0               | [tag v5.0.0](https://github.com/swagger-api/swagger-ui/tree/v5.0.0)   |
+| 4.0.0              | 2021-11-03   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3                      | [tag v4.0.0](https://github.com/swagger-api/swagger-ui/tree/v4.0.0)   |
+| 3.18.3             | 2018-08-03   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3                      | [tag v3.18.3](https://github.com/swagger-api/swagger-ui/tree/v3.18.3) |
+| 3.0.21             | 2017-07-26   | 2.0                                                  | [tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21) |
+| 2.2.10             | 2017-01-04   | 1.1, 1.2, 2.0                                        | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10) |
+| 2.1.5              | 2016-07-20   | 1.1, 1.2, 2.0                                        | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5)   |
+| 2.0.24             | 2014-09-12   | 1.1, 1.2                                             | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
+| 1.0.13             | 2013-03-08   | 1.1, 1.2                                             | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) |
+| 1.0.1              | 2011-10-11   | 1.0, 1.1                                             | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1)   |
 
 ## Anonymized analytics
 

README.md

@@ -18,6 +18,6 @@ module.exports = {
   moduleNameMapper: {
     '^.+\\.svg$': 'jest-transform-stub'
   },
-  transformIgnorePatterns: ['/node_modules/(?!(sinon|react-syntax-highlighter)/)'],
+  transformIgnorePatterns: ['/node_modules/(?!(sinon|react-syntax-highlighter|@asamuzakjp/css-color)/)'],
   silent: true, // set to `false` to allow console.* calls to be printed
 };

config/jest/jest.unit.config.js

@@ -10,6 +10,8 @@ Script name | Description
 `lint` | Report ESLint style errors and warnings.
 `lint-errors` | Report ESLint style errors, without warnings.
 `lint-fix` | Attempt to fix style errors automatically.
+`lint-styles` | Report Stylelint style errors and warnings.
+`lint-styles-fix` | Attempt to fix Stylelint errors and warnings automatically.
 `watch` | Rebuild the core files in `/dist` when the source code changes. Useful for `npm link` with Swagger Editor.
 
 ### Building

dist/swagger-ui-bundle.js

@@ -1,20 +1,23 @@
 # Setting up a dev environment
 
-Swagger UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
+SwaggerUI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
 
 ### Prerequisites
 
 - git, any version
-- **Node.js >=20.3.0** and **npm >=9.6.7** are the minimum required versions that this repo runs on, but we always recommend using the latest version of Node.js.
+- **Node.js >=22.11.0** and **npm >=10.9.0** are the minimum required versions that this repo runs on, but we always recommend using the latest version of Node.js.
+
+
 
 ### Steps
 
 1. `git clone https://github.com/swagger-api/swagger-ui.git`
 2. `cd swagger-ui`
 3. `npm install`
-4. `npm run dev`
-5. Wait a bit
-6. Open http://localhost:3200/
+4. `npx husky init` (optional)
+5. `npm run dev`
+6. Wait a bit
+7. Open http://localhost:3200/
 
 ### Using your own local api definition with local dev build
 

dist/swagger-ui-es-bundle-core.js

@@ -1,4 +1,4 @@
-openapi: "3.0.0"
+openapi: "3.0.4"
 info:
   version: "0.0.1"
   title: "Swagger UI Webpack Setup"

dist/swagger-ui-es-bundle-core.js.map

@@ -371,7 +371,7 @@ Set the value to the literal object value you'd like, taking care to escape char
 Example:
 
 ```sh
-SPEC="{ \"openapi\": \"3.0.0\" }"
+SPEC="{ \"openapi\": \"3.0.4\" }"
 ```
 
 ### Docker-Compose