@sveltia/cms 0.121.2 → 0.121.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -12
- package/dist/sveltia-cms.js +251 -264
- package/dist/sveltia-cms.js.map +1 -1
- package/dist/sveltia-cms.mjs +264 -277
- package/dist/sveltia-cms.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -127,13 +127,13 @@ Due to its unfortunate abandonment in early 2022, Netlify CMS spawned 3 successo
|
|
|
127
127
|
- **Sveltia CMS**: not a fork but a **complete rewrite**
|
|
128
128
|
- Started in November 2022, first appeared on GitHub in March 2023
|
|
129
129
|
- ✅ Actively developed with frequent releases and numerous improvements
|
|
130
|
-
- ✅ Relevant issues are
|
|
130
|
+
- ✅ Relevant issues are being addressed regardless of their age or status
|
|
131
131
|
- ✅ Most of bug reports are addressed promptly, usually within a day
|
|
132
132
|
- ✅ No known unpatched security vulnerabilities, with dependencies kept up-to-date
|
|
133
133
|
- [Decap CMS](https://github.com/decaporg/decap-cms): a rebranded version
|
|
134
134
|
- [Announced in February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/) as an official continuation with a Netlify agency partner taking ownership
|
|
135
135
|
- ⚠️ Mostly low activity with only occasional releases and a few minor improvements
|
|
136
|
-
- ⚠️ Seemingly random issues were closed as stale following the
|
|
136
|
+
- ⚠️ Seemingly random issues were closed as stale following the takeover
|
|
137
137
|
- ⚠️ Bug reports continue to pile up, often without any response
|
|
138
138
|
- ❌ A moderate severity [XSS vulnerability](https://github.com/advisories/GHSA-xp8g-32qh-mv28), high severity dependency vulnerabilities and fatal crashes remain unaddressed
|
|
139
139
|
|
|
@@ -169,24 +169,26 @@ Sveltia CMS is currently in **beta**, with version 1.0 (GA) scheduled for releas
|
|
|
169
169
|
While we fix reported bugs as quickly as possible, usually within 24 hours, our overall progress may be slower than you think. The thing is, it’s not just a personal project of [@kyoshino](https://github.com/kyoshino), but also a complicated system involving various kinds of activities that require considerable effort:
|
|
170
170
|
|
|
171
171
|
- Ensuring near-complete [compatibility with Netlify/Decap CMS](#compatibility)
|
|
172
|
+
- The vast majority of existing configurations work out of the box
|
|
173
|
+
- It works as a drop-in replacement for most use cases
|
|
172
174
|
- Some missing features will be implemented before or shortly after GA
|
|
173
175
|
- Providing partial [compatibility with Static CMS](#compatibility-with-static-cms)
|
|
174
176
|
- Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
|
|
175
|
-
- So far, **270+ issues, or
|
|
177
|
+
- So far, **270+ issues, or 585+ if including duplicates, have been effectively solved** in Sveltia CMS (Yes, you read it right)
|
|
176
178
|
- Target:
|
|
177
179
|
- 250 issues, or 500 if including duplicates, by GA — We did it! 🎉
|
|
178
180
|
- 450 issues, or 900 if including duplicates, in the future 💪
|
|
179
181
|
- or every single issue that’s relevant, fixable, and worth dealing with 🔥
|
|
180
182
|
- Issues include everything:
|
|
181
183
|
- Outstanding issues from feature requests to bug reports
|
|
182
|
-
- [Issues closed as stale](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22)
|
|
183
|
-
- Issues closed without an optimal solution
|
|
184
|
+
- [Issues closed as stale](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) or without an optimal solution
|
|
184
185
|
- [Discussions](https://github.com/decaporg/decap-cms/discussions)
|
|
185
186
|
- Stalled [pull requests](https://github.com/decaporg/decap-cms/pulls)
|
|
186
187
|
- Many of the bugs, including the annoying crashes, have already been solved
|
|
187
188
|
- The remaining bugs are mostly related to [unimplemented features](#current-limitations)
|
|
188
189
|
- Many of their [top-voted features](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) are [on our table](#roadmap) or already implemented in Sveltia CMS
|
|
189
190
|
- Solving [our own issues](https://github.com/sveltia/sveltia-cms/issues)
|
|
191
|
+
- Preparing comprehensive, up-to-date, easy-to-understand documentation
|
|
190
192
|
- Implementing our own enhancement ideas for every part of the product
|
|
191
193
|
- Responding to requests from the maintainer’s clients
|
|
192
194
|
- Making the code clean and maintainable
|
|
@@ -333,7 +335,7 @@ The [GitHub](https://decapcms.org/docs/github-backend/), [GitLab](https://decapc
|
|
|
333
335
|
- Comes with background [service status](https://status.gitlab.com/) checking, just like GitHub.
|
|
334
336
|
- Supports Git LFS ([documentation](https://docs.gitlab.com/topics/git/lfs/)).[^231]
|
|
335
337
|
- Users won’t get a 404 Not Found error when you sign in to the GitLab backend.[^115]
|
|
336
|
-
- We
|
|
338
|
+
- We implemented a workaround for a [GraphQL complexity limit issue](https://github.com/sveltia/sveltia-cms/issues/525) in GitLab 18.4.2, while Netlify/Decap CMS continued to suffer from the same problem.[^301] Our workaround was removed after GitHub 18.4.5 solved the underlying issue.
|
|
337
339
|
- Our Gitea/Forgejo backend is high-performing because it retrieves multiple entries at once. It also supports Git LFS ([documentation](https://docs.gitea.com/administration/git-lfs-setup)). Additionally, the backend won’t cause 400 Bad Request errors due to the presence of `DRAFT_MEDIA_FILES` in file paths.[^222]
|
|
338
340
|
- Unlike Netlify/Decap CMS, Sveltia CMS does not have a hardcoded API request timeout of 60 seconds, which can lead to unexpected errors when working with large files or slow networks.[^304] Though users may still experience timeouts due to server-side limitations, at least the client-side won’t impose an arbitrary limit.
|
|
339
341
|
- Features the all-new [local repository workflow](#working-with-a-local-git-repository) for a better DX. See the [productivity section](#better-productivity) above.
|
|
@@ -690,18 +692,18 @@ Sveltia CMS supports all the [built-in widgets](https://decapcms.org/docs/widget
|
|
|
690
692
|
|
|
691
693
|
We are working to make Sveltia CMS compatible with Netlify/Decap CMS wherever possible so that more users can seamlessly switch to our modern successor. In some casual use cases, Sveltia CMS can be used as a drop-in replacement for Netlify/Decap CMS with [just a one-line code update](#migration).
|
|
692
694
|
|
|
693
|
-
However, 100% feature parity is never planned, and some features are still missing or will not be added due to
|
|
695
|
+
However, 100% feature parity is never planned, and some features are still missing or will not be added due to deprecation and other factors. Look at the compatibility info below to see if you can migrate now or in the near future.
|
|
694
696
|
|
|
695
697
|
### Current limitations
|
|
696
698
|
|
|
697
|
-
|
|
699
|
+
We are working hard to implement several missing features from Netlify/Decap CMS. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) and [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates.
|
|
698
700
|
|
|
699
701
|
- The following advanced customization features are not yet implemented and will be added before the 1.0 release:
|
|
700
702
|
- Preview for [custom editor components](https://decapcms.org/docs/custom-widgets/#registereditorcomponent) (`CMS.registerEditorComponent`)
|
|
701
703
|
- [Custom widgets](https://decapcms.org/docs/custom-widgets/) (`CMS.registerWidget`)
|
|
702
704
|
- [Custom preview templates](https://decapcms.org/docs/customization/#registerpreviewtemplate) (`CMS.registerPreviewTemplate`) ([#51](https://github.com/sveltia/sveltia-cms/issues/51))
|
|
703
705
|
- [Event hooks](https://decapcms.org/docs/registering-events/) (`CMS.registerEventListener`) ([#167](https://github.com/sveltia/sveltia-cms/issues/167))
|
|
704
|
-
- [Documentation](https://github.com/sveltia/sveltia-cms/issues/485) and site config validation are
|
|
706
|
+
- [Documentation](https://github.com/sveltia/sveltia-cms/issues/485) and site config validation are under development.
|
|
705
707
|
- [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md) and a [demo site](https://github.com/sveltia/sveltia-cms/issues/1) will follow soon.
|
|
706
708
|
- Due to the complexity, we have decided to **defer the following features to the 1.x or 2.0 release** due mid-2026. Netlify/Decap CMS has dozens of open issues with these collaboration and beta features — we want to implement them the right way.
|
|
707
709
|
- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/)
|
|
@@ -710,10 +712,10 @@ There are still some missing features and limitations in Sveltia CMS compared to
|
|
|
710
712
|
|
|
711
713
|
### Features not to be implemented
|
|
712
714
|
|
|
713
|
-
The following Netlify/Decap CMS features will not be added to Sveltia CMS, primarily due to
|
|
715
|
+
The following Netlify/Decap CMS features will not be added to Sveltia CMS, primarily due to considerations relating to their deprecation.
|
|
714
716
|
|
|
715
717
|
- **Azure and Bitbucket backends**: For performance reasons. We’ll support these platforms if their APIs improve to allow the CMS to fetch multiple entries at once.
|
|
716
|
-
- **Git Gateway backend**:
|
|
718
|
+
- **Git Gateway backend**: Git Gateway is now [deprecated](https://docs.netlify.com/manage/security/secure-access-to-sites/git-gateway/) by Netlify. Like the Azure and Bitbucket backends, it also has performance issues. We plan to develop a GraphQL-based high-performance alternative [in the future](#roadmap) to provide a migration path for existing Git Gateway users.
|
|
717
719
|
- **Netlify Identity Widget**: It’s not useful without Git Gateway, and the Netlify Identity service itself is now [deprecated](https://www.netlify.com/changelog/deprecation-netlify-identity/). We plan to develop an alternative solution with role support [in the future](#roadmap), most likely using [Cloudflare Workers](https://workers.cloudflare.com/) and [Auth.js](https://authjs.dev/).
|
|
718
720
|
- [Gatsby plugin](https://github.com/decaporg/gatsby-plugin-decap-cms): In light of Gatsby’s [uncertainty](https://github.com/gatsbyjs/gatsby/discussions/39062), we won’t be investing time in developing a plugin for it. Gatsby users can still create `index.html` themselves. Note: We don’t support Netlify Identity Widget; the favicon can be specified with the `logo.src` option.
|
|
719
721
|
- The deprecated client-side implicit grant for the GitLab backend: It has already been [removed from GitLab 15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/344609). Use the client-side PKCE authorization instead.
|
|
@@ -755,7 +757,7 @@ There may be other minor differences in behaviour that are not listed here.
|
|
|
755
757
|
|
|
756
758
|
Sveltia CMS is also adding various config validation checks to help users identify potential issues, so you may see errors that were not present in Netlify/Decap CMS before. For example, Sveltia CMS raises an error if the `slug` collection option contains slashes (`/`), which is supposed to be invalid.
|
|
757
759
|
|
|
758
|
-
[Let us know](https://github.com/sveltia/sveltia-cms/issues/new?type=bug) if you have encounter any compatibility issues not mentioned
|
|
760
|
+
[Let us know](https://github.com/sveltia/sveltia-cms/issues/new?type=bug) if you have encounter any compatibility issues not mentioned above. We want to make the migration process as smooth as possible for our users.
|
|
759
761
|
|
|
760
762
|
### Framework support
|
|
761
763
|
|