Skip to content

chore(ci/docs/playground): clean dependencies, add linting, update readme#31

Draft
kheiner wants to merge 24 commits intorolleyio:nextfrom
kheiner:docs/add-linting
Draft

chore(ci/docs/playground): clean dependencies, add linting, update readme#31
kheiner wants to merge 24 commits intorolleyio:nextfrom
kheiner:docs/add-linting

Conversation

@kheiner
Copy link
Copy Markdown
Contributor

@kheiner kheiner commented Apr 10, 2026

This PR replaces #27.

  • docs: Add Linting to docs.
  • chore(playground): Remove the package-lock.json & add tsconfig to playground.
  • docs: updated readme to give details about the Directus CMS directus-template-cli
  • Update package.json scripts for explicit-build warning
  • Review Dependencies
    • @nuxt/kit latest is 4.4.2
      Notes:

      • 4.1 moduleDependencies will assist with fixing bug: NuxtImage not installed by module #26
      • 4.1 onInstall and onUpgrade seem interesting and likely worth noting that we can put empty scaffolding in the project. This may be useful in addressing development stuff but probably not a production benefit. (example: better notification of reminders for admin_token)
      • Nothing notable in 4.2
      • 4.3 Deprecations only impacts examples in docs
        • update docs/guide/server-side.md to Web API Naming conventions for throw createError({... (statusCode => status && message => statusText)
      • Nothing notable in 4.4
    • change-case is no longer used natively in the module

    • defu: bump from 6.1.1...6.1.7

      • Change: merge objects recursive from * as export. Nothing found where import * as is used
    • http-proxy: verified still in use & on latest package

    • ufo: bump from 1.6.1...1.6.3

      • Change: hasProtocol is not used
      • Change: withBase is not used
      • Change: withoutBase is not used
    • Inspect Breaking Changes

      Details by Dependency

      • @antfu/eslint-config: [ ❌ Moved to Issues with bump: eslint 10.20.0 and @antfu/eslint-config 8.2.0 #33 ]
      • @directus/sdk: [ BUMPING | REVIEWING | NOT-BUMPING ]
        • ...
      • @directus/types: [ BUMPING | REVIEWING | NOT-BUMPING ]
        • ...
      • @directus/visual-editing: [ 🔍 REVIEWING v2.0.0 ]
        • NOTE: To bump to v2.0.0 will break visual-editor for versions prior to Directus v11.16.0
      • @nuxt/devtools: [ 🔒 BUMPING ]
        • dev tools being tagged to latest caused issues with the nuxt team preparing for v5. In short latest captured unstable versions of dev tools.
      • @nuxt/test-utils: [ ✅ BUMPING v4.0.2 ]
        • Requires bump to vitest ^4.0.2
      • eslint: [ ❌ Moved to Issues with bump: eslint 10.20.0 and @antfu/eslint-config 8.2.0 #33 ]
      • vitest: [ ✅ BUMPING v4.1.4 ]
        • NOTE: There are 1,000+ commits in this bump, I opted to blindly bump here and verify that current tests continue to pass.
        • All existing test continue to pass.

: bun outdated

Package Current Update Latest
@antfu/eslint-config (dev) 4.19.0 4.19.0 8.1.1
@directus/sdk (dev) 20.3.0 20.3.0 21.2.2
@directus/types (dev) 13.5.0 13.5.0 15.0.1
@directus/visual-editing (dev) 1.2.0 1.2.0 2.0.0
@nuxt/devtools (dev) 3.2.4 3.2.4 4.0.0-alpha.4
@nuxt/test-utils (dev) 3.23.0 3.23.0 4.0.2
eslint (dev) 9.39.4 9.39.4 10.2.0
vitest (dev) 3.2.4 3.2.4 4.1.4
@directus/sdk (peer) 20.3.0 21.2.2 21.2.2
@directus/types (peer) 13.5.0 15.0.1 15.0.1
@directus/visual-editing (peer) 1.2.0 2.0.0 2.0.0
@directus/types (peer) 13.5.0 15.0.1 15.0.1
@directus/visual-editing (peer) 1.2.0 2.0.0 2.0.0

kheiner added 2 commits April 10, 2026 14:17
The previous example used a collection that is not available in the playground and suggested that directus_webhooks could be read with readItems(). updated for clarity.
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 10, 2026

@kheiner is attempting to deploy a commit to the Rolley Team on Vercel.

A member of the Team first needs to authorize it.

kheiner added 2 commits April 11, 2026 11:50
Removed package-lock.json to avoid conflicts with bun.lock.
Added playground/tsconfig.json to eliminate ambiguity for lsp
This should help ensure that all playground cases use a consistent
directus instance.
@kheiner kheiner changed the base branch from main to next April 11, 2026 20:11
kheiner added 2 commits April 11, 2026 18:46
The previous example used a collection that is not available in the playground and suggested that directus_webhooks could be read with readItems(). updated for clarity.
Copy link
Copy Markdown
Contributor Author

@kheiner kheiner left a comment

Choose a reason for hiding this comment

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

The linting caught a lot of errors, glad it will be implemented forward.

I think the pipeline doesn't capture updating the docs hosted on your domain; they appear to not match the main or next branch currently.

@kheiner kheiner marked this pull request as ready for review April 12, 2026 01:52
@kheiner
Copy link
Copy Markdown
Contributor Author

kheiner commented Apr 12, 2026

opted to merge #32 here. I'm not quite sure how you'll want me to tag the versions with your new pipeline setup. In the new setup at least I can identify that there should be fewer micro PR's.

Moving comment from other PR here:

I'm going to work on bumping versions of dependencies; I think there's some discussion about how the VisualEditor works and the updates to Directus that happened about a month ago @directus/visual-editing v2.0.0. I haven't looked deeply but wonder what versions of Directus will be backwards compatible with the versioning piece. I regularly update my Directus instance so I'm mostly concerned that bumping will have effects that I won't know to test.

kheiner added 2 commits April 12, 2026 10:26
The strict-peer-dependencies is not supported by BUN.

https://bun.com/docs/pm/npmrc#npmrc-support
fixes warning for non-explicit build command [using nuxt/starter/module
as
example](https://github.com/nuxt/starter/blob/6b698a45323ce40e05349c6ccd8a08fe8f791155/package.json#L28-L38)
@kheiner kheiner marked this pull request as draft April 12, 2026 18:16
@kheiner kheiner changed the title docs: add linting chore(ci/docs/playground): clean dependencies, add linting, update readme Apr 12, 2026
kheiner added 13 commits April 12, 2026 12:26
The latest tag in devtools pulled in a development branch.
defu: No conflicts found. Researched object merging for `import as *`
bug. All other minor version bumps were not fixes or changes relevant to
consumers of code.

ufo: No conflicts found. Three functions had fixes `hasProtocol`,
`withBase`, and `withoutBase`. None are used in project.
Verified no conflicts with bumping from 4.0.0 to 4.4.2:
=> docs: Updated to use non-deprecated `throw createError({` in examples

NOTE: Removed commented line from eslint.config.js to see if that fixes the CI error.
Note: I'm not sure how these weren't caught/fixed by linter before. May require some investigation.
1.6.3 and 1.6.4 are the same release code, only change is the notice of incompatability with rolldown-vite. (doesn't apply)
vuejs/vitepress@v1.6.3...v1.6.4
Reviewed documentation for breaking changes, none apply to tests as written. Verified clean install & all tests pass.
Add ignore statements to intentional `markdown/heading-increment` in docs.

Apply recommendations for e18e/prefer-regex-test. Manually tested this for both instances and it still works.
Supports node 24. Checkout v4 supported node 20.20.2 => eslint 10.2 showed rqeuiring version node 20.19.
@kheiner
Copy link
Copy Markdown
Contributor Author

kheiner commented Apr 13, 2026

Outstanding to do's as of right now:

  • Review @directus/types
  • Review @directus/sdk

In both of those packages I made contributions to support the datetime, date, and time string literals. I know there was bunch of AI features supported in those versions, too. Because it's a monorepo, that one is really hard to get a clear picture of potential breaking changes so it's going to be a while to get through the commits to verify nothing breaks.

Feedback Requested:
@matt-rolley I know that if we bump @directus/visual-editing, the module will require a Directus instance running version 11.16.0. I'm fine with the bump but hoping you can weigh in here.

This exercise of bumping packages makes me want to invest time into building tests for everything: so much easier to bump and test once you know you have a good set of tests up.

@matt-rolley
Copy link
Copy Markdown
Contributor

I think it's probably better to bump it. I probably should have bumped it before we went with version 5. The user can just use version 4 of the Nuxt Directus SDK if they need to support an older version of Directus.

So yeah, I think we just say that version 5 requires the latest version of Directus and that the user can use v4 of the nuxt-directus-sdk if backwards compatibility is needed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants