Move codegen api to separate package #201

adamdicarlo0 · 2025-06-23T22:42:52Z

Sorry... it's a huge PR! But most of the diff is

New elm-codegen Gen modules (so, so many)
Moving files

It includes some new scripts, which must be used to test things locally until the new package is published.

After cloning, this series of commands should (in theory) just work:

scripts/link-local-package   # `npm run link-local-package` also works
npm test
scripts/unlink-local-package # `npm run unlink-local-package` also works

Slightly tangential changes:

Always use tools installed via shell.nix, rather than installing duplicates via npm, to remove the need to keep them in sync (I probably wouldn't have tried it if I'd realized how much work CI would be, lol)
Use shell.nix in CI, as well (this requires quite a bit of boilerplate to make caching work, without using something like devbox directly)
- NB: For cache misses it takes around 35 seconds in CI to "build" the dev shell, so this will at time slow down CI runs
Rework basically all the scripts, like test, review, format because the project structure has changed so much

cc @miniBill

adamdicarlo0 · 2025-06-23T22:43:28Z

codegen/elm.codegen.json

            "elm-community/json-extra": "4.3.0",
            "elm/url": "1.0.0",
-            "dillonkearns/elm-pages": "10.1.0",
+            "dillonkearns/elm-pages": "10.2.2",


This and similar upgrades were necessary for the example-using-api project to be able to compile.

adamdicarlo0 · 2025-06-23T23:53:49Z

TODO:

Finish adding function/type docs for elm-open-api-codegen
Wiring up elm-review to also run in elm-open-api-codegen in CI

adamdicarlo0 · 2025-06-25T00:05:11Z

shell.nix

    pkgs.elmPackages.elm-review
-    pkgs.nodejs-18_x
+    pkgs.nodejs_20


Upgraded this to match the node version used in CI.

Now CI is using the Nix shell, so this dictates the Node version everywhere.

adamdicarlo0 · 2025-06-25T00:09:23Z

elm-open-api-codegen/codegen/elm.codegen.json

        ]
    }
-}
+}


NB: This file moved to the elm-open-api-codegen/ folder

adamdicarlo0 · 2025-06-25T00:13:32Z

elm-open-api-codegen/src/OpenApi/BackendTask.elm

@@ -0,0 +1,906 @@
+module OpenApi.BackendTask exposing (withConfig)


This code comes from the old Cli module.

adamdicarlo0 · 2025-06-25T00:14:34Z

elm-open-api-codegen/src/OpenApi/Generate.elm

-
-        Cli.Validate.Invalid _ ->
-            False
+    regexToCheckIfJson mediaType


Changed these functions to not need the Cli module, since this is now in an Elm package.

adamdicarlo0 · 2025-06-25T00:15:10Z

elm.json

-            "elm-explorations/test": "2.2.0",
-            "miniBill/elm-unicode": "1.1.1"
-        },
+        "direct": {},


Test suite has moved into the package (elm-open-api-codegen) subfolder

adamdicarlo0 · 2025-06-25T00:18:17Z

review-pty.json

+    },
+    "defaultStatus": ["⏳", "S"]
+  }
+]


this run-pty config is for npm run review:watch

adamdicarlo0 · 2025-06-25T00:30:45Z

elm.json

-            "wolfadex/elm-ansi": "3.0.0",
-            "wolfadex/elm-open-api": "2.0.0"
+            "elmcraft/core-extra": "2.2.0",
+            "wolfadex/elm-open-api-codegen": "1.0.0",


This package is not published yet, so this elm.json file cannot work as-is. The TEMP HACK blocks in the CI workflow work around this (with the same method I used to work around it locally).

adamdicarlo0 · 2025-07-29T23:55:32Z

Superceded by #214

adamdicarlo0 added 4 commits June 23, 2025 14:34

Move codegen API to separate Elm package

5ab00d5

Replace elm-placeholder-pkg with (to-be) real package

03a1662

Flesh out example project, add scripts & docs, clean up

f9e38db

Clean up and simplify

9d31e67

adamdicarlo0 commented Jun 23, 2025

View reviewed changes

adamdicarlo0 added 8 commits June 23, 2025 15:45

Minor CONTRIBUTING fixes

d103146

Add gnused dependency to avoid dev script havoc on macOS

ac42431

Add safety/better error message if wrong sed is present

021d6f1

Small doc fix

c452cac

Add gitignore note

af109e0

Don't run elm-format on generated elm-codegen code

51e1220

Add findutils to shell.nix

cd59d0f

Fix a couple things and start adding package docs

ead5a0b

adamdicarlo0 added 15 commits June 23, 2025 18:54

Improve format script

4d02e39

Scripts, CI

477c247

Add package docs, hopefully fix CI

1cbfea5

Remove no-longer-needed codegen project, packages, etc.

1a63738

Use tools from nix devShell in CI

a8b469a

Dig in deeper / debug

efbe082

Suppress error for unused placeholder module

2eea035

ci: Clean up, add 'build' step (to make sure it works)

9a716b5

Upgrade elm-pages

aef5460

Desperation

e51cab4

Fix cache keys

0d53db2

Desperation

45e501f

Fix example-using-api in CI

b5e8111

Fix TestGenScript

ded0297

ci: Fix nix store caching

e80b96a

adamdicarlo0 force-pushed the move-codegen-api-to-separate-package branch from 78c0ac4 to e80b96a Compare June 24, 2025 23:57

adamdicarlo0 commented Jun 25, 2025

View reviewed changes

elm-open-api-codegen/codegen/elm.codegen.json

]

}

}

}

Copy link

Contributor Author

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NB: This file moved to the elm-open-api-codegen/ folder

Clean up, add back elm-codegen for package folder script

5b07230

adamdicarlo0 commented Jun 25, 2025

View reviewed changes

review-pty.json

},

"defaultStatus": ["⏳", "S"]

}

]

Copy link

Contributor Author

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this run-pty config is for npm run review:watch

Fix readme typo

4764546

adamdicarlo0 commented Jun 25, 2025

View reviewed changes

adamdicarlo0 added 2 commits June 24, 2025 18:58

Remove the sync-elm-codegen hack

9bb0776

elm-open-api-codegen: Auto-remove unused Gen modules in codegen script

fa349f8

This was referenced Jul 2, 2025

Remove unused custom-backend-task.ts #202

Merged

Add nix installation instructions #203

Merged

Remove unused elm-codegen bindings #204

Closed

adamdicarlo0 added 2 commits July 2, 2025 18:37

Resolve security vulnerabilities in dependencies

1d4cdb2

Simplify example-using-api, improve new READMEs

0dad6d0

adamdicarlo0 closed this Jul 29, 2025

adamdicarlo0 deleted the move-codegen-api-to-separate-package branch July 29, 2025 23:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Move codegen api to separate package #201

Move codegen api to separate package #201

Uh oh!

adamdicarlo0 commented Jun 23, 2025 •

edited

Loading

Uh oh!

adamdicarlo0 Jun 23, 2025

Uh oh!

adamdicarlo0 commented Jun 23, 2025 •

edited

Loading

Uh oh!

adamdicarlo0 Jun 25, 2025

Uh oh!

adamdicarlo0 Jun 25, 2025

Uh oh!

adamdicarlo0 Jun 25, 2025

Uh oh!

adamdicarlo0 Jun 25, 2025 •

edited

Loading

Uh oh!

adamdicarlo0 Jun 25, 2025

Uh oh!

adamdicarlo0 Jun 25, 2025

Uh oh!

adamdicarlo0 Jun 25, 2025

Uh oh!

adamdicarlo0 commented Jul 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		@@ -0,0 +1,906 @@
		module OpenApi.BackendTask exposing (withConfig)

Move codegen api to separate package #201

Move codegen api to separate package #201

Uh oh!

Conversation

adamdicarlo0 commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adamdicarlo0 Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 Jun 25, 2025

Choose a reason for hiding this comment

Uh oh!

adamdicarlo0 commented Jul 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

adamdicarlo0 commented Jun 23, 2025 •

edited

Loading

adamdicarlo0 commented Jun 23, 2025 •

edited

Loading

adamdicarlo0 Jun 25, 2025 •

edited

Loading