Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We should not keep a minified version of respec.js #3845

Closed
Bellangelo opened this issue May 23, 2024 · 2 comments · Fixed by #3944
Closed

We should not keep a minified version of respec.js #3845

Bellangelo opened this issue May 23, 2024 · 2 comments · Fixed by #3944
Assignees
Labels
Housekeeping script Pull requests that update Bash or JavaScript code

Comments

@Bellangelo
Copy link
Member

Bellangelo commented May 23, 2024

Problem

There are 2 minified versions of respec.js for 3.x and for 4.x versions. These files exists in the gh-pages:

  1. /js/respec-oai.js
  2. /js/respec-arrazzo.js

These files are basically unmaintainable and should instead try to store a human-readable version of it.

Proposed solution

There is a respec-oai.build.js.map which might help us decouple the minified version respec-oai.js.
After we succeed in decoupling the file and keep only the source code in our repo, we need to add a build step in our deploy process so we can push the minified version again.

Alternative Proposal

Do not use a modified fork of ReSpec, instead use the unmodified original, see #3944.

@ralfhandl
Copy link
Contributor

In addition we should update to the latest version of ReSpec and have a documented process to refresh our snapshot.

Which also means we should not "fork" or otherwise modify the original ReSpec, and use the same snapshot for OpenAPI and Arazzo.

@ralfhandl
Copy link
Contributor

Differences between OAI snapshots of ReSpec 21.0.1 and the original:

  • Added Apache2 license
    • doesn't seem to have any visible effect in the rendered spec
  • Tweaked Copyright line
    • can (now) be done per document
  • Changed linter defaults
    • can be done via respecConfig
  • Changed logo image and url
    • can be done via respecConfig
  • Changed section heading of "abstract"
    • can (now) be done per document
    • this is the only difference between the OpenAPI and Arazzo clones of ReSpec
  • Changed DateTimeFormat from Australian English to British English
    • what's the difference?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Housekeeping script Pull requests that update Bash or JavaScript code
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants