@sveltia/cms 0.19.0 → 0.19.2

package/README.md

@@ -22,7 +22,7 @@ Our goal is to make it a viable successor to Netlify CMS, expand the Git-based h
 
 ## Features
 
-We are working hard to create a **much better alternative to Netlify/Decap CMS**. Here’s what makes Sveltia CMS different. (Whoa, there are so many!)
+We are working hard to create a **much better alternative to Netlify CMS** and Decap CMS. Here’s what makes Sveltia CMS different. Look how serious we are!
 
 ### Compatible with Netlify/Decap CMS
 
@@ -43,7 +43,7 @@ We are working hard to create a **much better alternative to Netlify/Decap CMS**
 
 - Built completely from scratch with Svelte instead of forking React-based Netlify/Decap CMS. The app starts fast and stays fast. The compiled code is vanilla JavaScript — you can use it with almost any framework.
 - Small footprint: The bundle size is less than 350 KB when minified and gzipped, compared to 1.5 MB of Netlify/Decap CMS. And [no virtual DOM overhead](https://svelte.dev/blog/virtual-dom-is-pure-overhead).
-- Uses the GraphQL API for GitHub/GitLab to quickly fetch content at once, so that entries and assets can be listed and searched instantly[^32]. It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
+- Uses the GraphQL API for GitHub and GitLab to quickly fetch content at once, so that entries and assets can be listed and searched instantly[^32]. It also avoids the slowness and potential API rate limit violations caused by hundreds of requests with Relation widgets[^14].
 - Saving entries and assets is also much faster thanks to the [GraphQL mutation](https://github.blog/changelog/2021-09-13-a-simpler-api-for-authoring-commits/).
 - A list of repository files is cached locally for faster startup and bandwidth savings.
 - Thumbnails of assets, including PDF files, are generated and cached for faster rendering of the Asset Library and other parts of the CMS[^39].
@@ -95,7 +95,7 @@ We are working hard to create a **much better alternative to Netlify/Decap CMS**
 - Entry slug template tags support [filter transformations](https://decapcms.org/docs/summary-strings/) just like summary string template tags[^29].
 - You can set the maximum number of characters for an entry slug with the new `slug_length` collection option[^25].
 
-### Better data entry
+### Better content editing
 
 - Required fields, not optional fields, are clearly marked for efficient data entry.
 - Leading and trailing spaces in text-type field values are automatically removed when you save the entry[^37].
@@ -104,32 +104,41 @@ We are working hard to create a **much better alternative to Netlify/Decap CMS**
 - Fields with validation errors are automatically expanded if they are part of nested, collapsed objects[^40].
 - When you click on a field in the Preview pane, the corresponding field in the Editor pane is highlighted. It will be automatically expanded if collapsed[^41].
 
-### Better fields/widgets
-
-- The String widget supports the `type` property that accepts `url` or `email` as a value, which will validate the value as a URL or email.
-- The String widget supports the `prefix` and `suffix` string properties, which automatically prepend and/or append the developer-defined value to the user-input value.
-- The Boolean, Number and String widgets support the `before_input` and `after_input` string properties, which allow developers to display custom labels before and/or after the input UI[^28]. Markdown is supported in the value.
-- Relation field options are displayed with no additional API requests[^14]. The `options_length` property is therefore ignored.
-- The `summary` for the List and Object widgets is displayed correctly when it refers to a Relation field[^36].
-- Provides a reimagined all-in-one asset selection dialog for File and Image fields.
-  - [Collection-specific assets](#use-a-custom-media-folder-for-a-collection) will be listed first for easy selection, while all assets can also be displayed in a separate tab[^19].
-  - New assets can be uploaded by dragging & dropping them into the dialog[^20].
-  - A file/image URL can also be entered in the dialog.
-  - Integration with Pexels, Pixabay and Unsplash makes it easy to select and insert free stock photos[^8].
-- The Object widget supports [variable types](https://decapcms.org/docs/variable-type-widgets/) just like the List widget. This allows you to have dependent fields in a collection[^30].
-- Optional Object fields (`widget: object` with `required: false`) can be manually added or removed. If unadded or removed, the required subfields won’t trigger validation errors[^16].
-- In addition to [generating UUIDs for entry slugs](#use-a-random-id-for-an-entry-slug), Sveltia CMS also supports the proposed `uuid` widget with the following properties[^12]:
-  - `prefix`: A string to be prepended to the value. Default: an empty string.
-  - `use_b32_encoding`: Whether to encode the value with Base32. Default: `false`.
-  - `read_only`: Whether to make the field read-only. Default: `true`.
-- The experimental `compute` widget allows to reference the value of other fields in the same collection, similar to the `summary` property for the List and Object widgets. Use the `value` property to define the value template, e.g. `posts-{{fields.slug}}` ([example](https://github.com/sveltia/sveltia-cms/issues/111)).
+### Better widgets
+
+- List
+  - Supports previewing variable types without having to register a preview template[^42].
+- Object
+  - Supports [variable types](https://decapcms.org/docs/variable-type-widgets/) just like the List widget. This allows you to have dependent fields in a collection[^30].
+  - Optional Object fields (`required: false`) can be manually added or removed. If unadded or removed, the required subfields won’t trigger validation errors[^16].
+- Relation
+  - Field options are displayed with no additional API requests[^14]. The `options_length` property is therefore ignored.
+- String
+  - Supports the `type` property that accepts `url` or `email` as a value, which will validate the value as a URL or email.
+  - Supports the `prefix` and `suffix` string properties, which automatically prepend and/or append the developer-defined value to the user-input value.
+- Boolean, Number and String
+  - Supports the `before_input` and `after_input` string properties, which allow developers to display custom labels before and/or after the input UI[^28]. Markdown is supported in the value.
+- List and Object
+  - The `summary` is displayed correctly when it refers to a Relation field[^36].
+- File and Image
+  - Provides a reimagined all-in-one asset selection dialog for File and Image fields.
+    - [Collection-specific assets](#use-a-custom-media-folder-for-a-collection) will be listed first for easy selection, while all assets can also be displayed in a separate tab[^19].
+    - New assets can be uploaded by dragging & dropping them into the dialog[^20].
+    - A URL can also be entered in the dialog.
+    - Integration with Pexels, Pixabay and Unsplash makes it easy to select and insert free stock photos[^8].
+- New widgets
+  - In addition to [generating UUIDs for entry slugs](#use-a-random-id-for-an-entry-slug), Sveltia CMS also supports the proposed `uuid` widget with the following properties[^12]:
+    - `prefix`: A string to be prepended to the value. Default: an empty string.
+    - `use_b32_encoding`: Whether to encode the value with Base32. Default: `false`.
+    - `read_only`: Whether to make the field read-only. Default: `true`.
+  - The experimental `compute` widget allows to reference the value of other fields in the same collection, similar to the `summary` property for the List and Object widgets. Use the `value` property to define the value template, e.g. `posts-{{fields.slug}}` ([example](https://github.com/sveltia/sveltia-cms/issues/111)).
 
 ### Better asset management
 
 - A completely new Asset Library, built separately from the image selection dialog, makes it easy to manage all of your files, including images, videos and documents.
   - Navigate between the global media folder and per-collection media folders[^6].
   - Preview image, audio, video, text and PDF files. Check your site’s [CSP](#set-up-content-security-policy) if the preview doesn’t work.
-  - Copy the public URL, file path or text/image data of a selected asset to clipboard.
+  - Copy the public URL, file path, text data or image data of a selected asset to clipboard.
   - Edit plaintext assets, including SVG images.
   - Replace existing assets.
   - Download one or more selected assets at once.
@@ -155,8 +164,8 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
 | Editorial Workflow | Not supported yet. |
 | Open Authoring | Not supported yet. |
 | Collections | Nested collections are not supported yet. |
-| Widgets | [See below](#widget-limitations) for the current limitations. |
-| Customizations | Custom widgets, custom previews, custom formatters, manual initialization and CMS event subscriptions are not supported yet. |
+| Widgets | Custom widgets are not supported yet. [See below](#widget-limitations) for other limitations. |
+| Customizations | Custom previews, custom formatters, manual initialization and event subscriptions are not supported yet. |
 
 ### Widget limitations
 
@@ -182,6 +191,7 @@ While it’s not our goal to recreate all the features found in Netlify/Decap CM
 ### Before the 1.0 release
 
 - [Svelte 5](https://svelte.dev/blog/runes) migration
+- Automation test coverage
 - Further Netlify/Decap CMS compatibility, including Editorial Workflow
 - Localization
 - Documentation
@@ -214,14 +224,23 @@ Alternatively, you can probably use one of the [Netlify/Decap CMS templates](htt
 
 ### Migration
 
-Have a look at the [compatibility chart](#compatibility) above first. If you’re already using Netlify/Decap CMS with the GitHub/GitLab backend and don’t have any custom widget, custom preview or plugin, migrating to Sveltia CMS is super easy. Edit `/admin/index.html` to replace the CMS `script` tag, and push the change to your repository:
+Have a look at the [compatibility chart](#compatibility) above first. If you’re already using Netlify/Decap CMS with the GitHub or GitLab backend and don’t have any custom widget, custom preview or plugin, migrating to Sveltia CMS is super easy. Edit `/admin/index.html` to replace the CMS `script` tag, and push the change to your repository.
+
+From Netlify CMS:
 
 ```diff
 -<script src="https://unpkg.com/netlify-cms@^2.0.0/dist/netlify-cms.js"></script>
 +<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js" type="module"></script>
 ```
 
-That’s it! You can open `https://[hostname]/admin/` as before to start editing. There is even no authentication process if you’ve already been signed in with GitHub/GitLab on Netlify/Decap CMS because Sveltia CMS uses your auth token stored in the browser. Simple enough!
+From Decap CMS:
+
+```diff
+-<script src="https://unpkg.com/decap-cms@^3.0.0/dist/decap-cms.js"></script>
++<script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js" type="module"></script>
+```
+
+That’s it! You can open `https://[hostname]/admin/` as before to start editing. There is even no authentication process if you’ve already been signed in with GitHub or GitLab on Netlify/Decap CMS because Sveltia CMS uses your auth token stored in the browser. Simple enough!
 
 That said, we strongly recommend testing your new Sveltia CMS instance first on your local machine. [See below](#work-with-a-local-git-repository) for how.
 
@@ -229,7 +248,7 @@ That said, we strongly recommend testing your new Sveltia CMS instance first on
 
 ### Move your site from Netlify to another hosting service
 
-You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](https://pages.cloudflare.com/) or [GitHub Pages](https://pages.github.com/). But moving away from Netlify means you can no longer sign in with GitHub/GitLab via Netlify. Instead, you can use [our own OAuth client](https://github.com/sveltia/sveltia-cms-auth), which can be easily deployed to Cloudflare Workers, or [any other 3rd party client](https://decapcms.org/docs/external-oauth-clients/) made for Netlify/Decap CMS.
+You can host your Sveltia CMS-managed site anywhere, such as [Cloudflare Pages](https://pages.cloudflare.com/) or [GitHub Pages](https://pages.github.com/). But moving away from Netlify means you can no longer sign in with GitHub or GitLab via Netlify. Instead, you can use [our own OAuth client](https://github.com/sveltia/sveltia-cms-auth), which can be easily deployed to Cloudflare Workers, or [any other 3rd party client](https://decapcms.org/docs/external-oauth-clients/) made for Netlify/Decap CMS.
 
 ### Work with a local Git repository
 
@@ -451,7 +470,7 @@ Want to build a website with Sveltia CMS? Maintainer [@kyoshino](https://github.
 
 ## Contributions
 
-Sveltia CMS is still in early beta, so we do expect various problems. Please [report any bugs to us](https://github.com/sveltia/sveltia-cms/issues/new). Feel free to submit feature requests as well. Meanwhile, pull requests may not be accepted for the time being due to limited review resources. As we get closer to the 1.0 release, we’ll be welcoming [localizers](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md).
+Since Sveltia CMS is still in beta, we expect various problems. Please [report any bugs to us](https://github.com/sveltia/sveltia-cms/issues/new) so we can make it better for everyone. Feel free to submit feature requests as well. Meanwhile, pull requests may not be accepted for the time being due to limited review resources and the upcoming Svelte 5 migration. As we get closer to the 1.0 release, we’ll be welcoming [localizers](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md).
 
 ## Related links
 
@@ -507,3 +526,4 @@ This software is provided “as is” without any express or implied warranty. W
 [^39]: Netlify/Decap CMS [#946](https://github.com/decaporg/decap-cms/issues/946)
 [^40]: Netlify/Decap CMS [#5630](https://github.com/decaporg/decap-cms/issues/5630)
 [^41]: Netlify/Decap CMS [#7011](https://github.com/decaporg/decap-cms/issues/7011)
+[^42]: Netlify/Decap CMS [#2307](https://github.com/decaporg/decap-cms/issues/2307)