@sveltia/cms 0.86.2 → 0.87.0

package/README.md

@@ -57,6 +57,7 @@ The free, open source alternative/successor to Netlify/Decap CMS is now in publi
   - [Updates](#updates)
 - [Tips \& tricks](#tips--tricks)
   - [Moving your site from Netlify to another hosting service](#moving-your-site-from-netlify-to-another-hosting-service)
+  - [Enabling autocomplete and validation for the configuration file](#enabling-autocomplete-and-validation-for-the-configuration-file)
   - [Providing a JSON configuration file](#providing-a-json-configuration-file)
   - [Providing multiple configuration files](#providing-multiple-configuration-files)
   - [Working around an authentication error](#working-around-an-authentication-error)
@@ -124,7 +125,7 @@ While Sveltia CMS was created to replace legacy Netlify CMS instances, it can al
 
 ## Development status
 
-Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in Q4 2025. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) and follow us on [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates. See also our [roadmap](#roadmap).
+Sveltia CMS is currently in **beta** and version 1.0 (GA) is expected to ship in late 2025. Check our [release notes](https://github.com/sveltia/sveltia-cms/releases) and follow us on [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates. See also our [roadmap](#roadmap).
 
 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:
 
@@ -132,7 +133,7 @@ While we fix reported bugs as quickly as possible, usually within 24 hours, our
 - Tackling as many [Netlify/Decap CMS issues](https://github.com/decaporg/decap-cms/issues) as possible
   - So far, 230+ issues, or 470+ if including duplicates, have been effectively solved in Sveltia CMS (Yes, you read it right)
   - Target:
-    - 200 issues, or 400 if including duplicates, by GA — We did it! 🎉
+    - 250 issues, or 500 if including duplicates, by GA — Almost there!
     - 400 issues, or 800 if including duplicates, in the future 💪
     - or every single issue that’s relevant, fixable, and worth dealing with 🔥
   - Issues include everything from feature requests to bug reports and [issues closed as stale](https://github.com/decaporg/decap-cms/issues?q=is%3Aissue+%22Closing+as+stale%22) or without an effective solution, as well as [discussions](https://github.com/decaporg/decap-cms/discussions) and stalled [pull requests](https://github.com/decaporg/decap-cms/pulls)
@@ -231,9 +232,10 @@ Note: This lengthy section compares Sveltia CMS with both Netlify CMS and Decap
 
 ### Better configuration
 
+- We provide [our own JSON schema](#enabling-autocomplete-and-validation-for-the-configuration-file) for the YAML configuration file, which enables autocomplete and validation in IDEs such as VS Code.[^253]
 - Sveltia CMS supports a [JSON configuration file](#providing-a-json-configuration-file) that can be generated for bulk or complex collections.[^60]
 - Also supports [multiple configuration files](#providing-multiple-configuration-files) to allow developers to modularize the configuration.[^197]
-- Improved TypeScript support: We try to keep our type definitions for `CMS.init()` and other methods complete, accurate, up-to-date and annotated.[^190][^191][^192][^193][^227] This makes it easier to provide a site config object when [manually initializing](https://decapcms.org/docs/manual-initialization/) the CMS.
+- Improved TypeScript support: We keep our type definitions for `CMS.init()` and other methods complete, accurate, up-to-date and annotated.[^190][^191][^192][^193][^227] This makes it easier to provide a site config object when [manually initializing](https://decapcms.org/docs/manual-initialization/) the CMS.
 
 ### Better backend support
 
@@ -597,7 +599,7 @@ However, 100% feature parity is not planned, and some features are still missing
 
 ### Current limitations
 
-These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are working hard to add them before the 1.0 release due Q4 2025. Check the [release notes](https://github.com/sveltia/sveltia-cms/releases) and [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates.
+These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are working hard to add them before the 1.0 release due late 2025. Check the [release notes](https://github.com/sveltia/sveltia-cms/releases) and [Bluesky](https://bsky.app/profile/sveltiacms.app) for updates.
 
 - Comprehensive site config validation
 - [Localization](https://github.com/sveltia/sveltia-cms/blob/main/src/lib/locales/README.md) other than English and Japanese
@@ -610,11 +612,11 @@ These Netlify/Decap CMS features are not yet implemented in Sveltia CMS. We are
 - [Custom previews](https://decapcms.org/docs/customization/) ([#51](https://github.com/sveltia/sveltia-cms/issues/51))
 - [Event hooks](https://decapcms.org/docs/registering-events/) ([#167](https://github.com/sveltia/sveltia-cms/issues/167))
 
-Due to the complexity, we have decided to defer the following features to the 2.0 release. Netlify/Decap CMS has a number of open issues with these collaboration and beta features — we want to implement them the right way.
+Due to the complexity, we have decided to defer the following features to the 2.0 release due early 2026. Netlify/Decap CMS has a number of open issues with these collaboration and beta features — we want to implement them the right way.
 
-- [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/) & [Deploy Preview Links](https://decapcms.org/docs/deploy-preview-links/)
-- [Open Authoring](https://decapcms.org/docs/open-authoring/)
-- [Nested Collections](https://decapcms.org/docs/collection-nested/) (beta)
+- [Editorial workflow](https://decapcms.org/docs/editorial-workflows/) with [deploy preview links](https://decapcms.org/docs/deploy-preview-links/)
+- [Open authoring](https://decapcms.org/docs/open-authoring/)
+- [Nested collections](https://decapcms.org/docs/collection-nested/) (beta)
 
 Found a compatibility issue or other missing feature? [Let us know](https://github.com/sveltia/sveltia-cms/issues/new?type=bug). Bear in mind that undocumented behaviour can easily be overlooked.
 
@@ -743,6 +745,22 @@ If you’ve chosen to install with npm, updating the package is your responsibil
 
 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.
 
+### Enabling autocomplete and validation for the configuration file
+
+Sveltia CMS provides an up-to-date [JSON schema](https://json-schema.org/) for the site configuration file, so you can get autocomplete and validation in your favourite code editor while editing `config.yml`. The JSON schema for Netlify/Decap CMS is incomplete and outdated, so it’s not recommended to use it for Sveltia CMS.
+
+If you use [Visual Studio Code](https://code.visualstudio.com/), you can enable it for the YAML configuration file by installing the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) and adding the following to the `.vscode/settings.json` file in your project:
+
+```json
+{
+  "yaml.schemas": {
+    "https://unpkg.com/@sveltia/cms/schema/sveltia-cms.json": ["/static/admin/config.yml"]
+  }
+}
+```
+
+Change the path to your configuration file if it’s not `/static/admin/config.yml`.
+
 ### Providing a JSON configuration file
 
 Sveltia CMS supports a configuration file written in the JSON format in addition to the standard YAML format. This allows developers to programmatically generate the CMS configuration to enable bulk or complex collections. To do this, simply add a `<link>` tag to your HTML, just like a [custom YAML config link](https://decapcms.org/docs/configuration-options/#configuration-file), but with the type `application/json`:
@@ -831,7 +849,7 @@ fields:
 
 ### Adding dividers to the collection list
 
-Sveltia CMS allows developers to add dividers to the collection list to distinguish different types of collections. To do this, insert a fake collection with the `divider: true` option along with a random, unique `name`. In VS Code, you may get a validation error if `config.yml` is treated as a “Netlify YAML config” file. You can work around this by adding an empty `files` list as well:
+Sveltia CMS allows developers to add dividers to the collection list to distinguish different types of collections. To do this, insert a fake collection with the `divider: true` option along with a random, unique `name`. In VS Code, you may get a validation error if `config.yml` is treated as a “Netlify YAML config” file. You can work around this by [using our JSON schema](#enabling-autocomplete-and-validation-for-the-configuration-file) or adding an empty `files` list:
 
 ```yaml
 collections:
@@ -892,17 +910,33 @@ collections:
     label: Blog posts
     folder: content/posts
     fields: # Fields for regular entries
-      ...
+      - { name: title, label: Title }
+      - { name: date, label: Published Date, widget: datetime }
+      - { name: description, label: Description }
+      - { name: body, label: Body, widget: markdown }
     index_file:
-      # All of the following options are optional. However, if you want to omit them all,
-      # use `index_file: true` or `index_file: {}`. Otherwise the feature won’t work
-      name: _index # File name without a locale or extension. Default: _index
-      label: Index File # Human-readable file label. Default: Index File
-      icon: home # Material Symbols icon name. Default: home
-      fields: # Fields for the index file. If omitted, regular entry fields are used
-        ...
-      editor:
-        preview: false # Hide the preview pane if needed. Default: true
+      fields: # Fields for the index file
+        - { name: title, label: Title }
+        - { name: body, label: Body, widget: markdown }
+```
+
+Here is an example of full customization. All options are optional.
+
+```yaml
+index_file:
+  name: _index # File name without a locale or extension. Default: _index
+  label: Index File # Human-readable file label. Default: Index File
+  icon: home # Material Symbols icon name. Default: home
+  fields: # Fields for the index file. If omitted, regular entry fields are used
+    ...
+  editor:
+    preview: false # Hide the preview pane if needed. Default: true
+```
+
+If the regular entry fields and index file fields are identical and you don’t need any options, simply write:
+
+```yaml
+index_file: true
 ```
 
 Note that the special index file is placed right under the `folder`, regardless of the collection’s [`path` option](https://decapcms.org/docs/collection-folder/#folder-collections-path). For example, if the `path` is `{{year}}/{{slug}}`, a regular entry would be saved as `content/posts/2025/title.md`, but the index file remains at `content/posts/_index.md`.
@@ -1406,7 +1440,7 @@ See [Contributing to Sveltia CMS](https://github.com/sveltia/sveltia-cms/blob/ma
 
 ### v1.0
 
-Due Q4 2025
+Due late 2025
 
 - Enhanced [compatibility with Netlify/Decap CMS](#current-limitations)
 - Tackling some more Netlify/Decap CMS issues:
@@ -1428,10 +1462,12 @@ Due Q4 2025
 
 ### v2.0
 
+Due early 2026
+
 - Implementing [a few deferred Netlify/Decap CMS features](#current-limitations):
-  - [Editorial Workflow](https://decapcms.org/docs/editorial-workflows/) & [Deploy Preview Links](https://decapcms.org/docs/deploy-preview-links/)
-  - [Open Authoring](https://decapcms.org/docs/open-authoring/)
-  - [Nested Collections](https://decapcms.org/docs/collection-nested/) (beta)
+  - [Editorial workflow](https://decapcms.org/docs/editorial-workflows/) with [deploy preview links](https://decapcms.org/docs/deploy-preview-links/)
+  - [Open authoring](https://decapcms.org/docs/open-authoring/)
+  - [Nested collections](https://decapcms.org/docs/collection-nested/) (beta)
 - End-user documentation
 
 ### Future
@@ -1443,7 +1479,6 @@ Due Q4 2025
 - Search enhancements
 - Advanced digital asset management (DAM) features, including image editing and tagging[^114]
 - Marketplace for custom widgets, etc.
-- VS Code extension for `config.yml` schema validation
 - Official starter templates for the most popular frameworks, including SvelteKit and Next.js
 - Contributor documentation
 - and so much more!
@@ -1970,3 +2005,5 @@ This software is provided “as is” without any express or implied warranty. W
 [^251]: Netlify/Decap CMS [#6965](https://github.com/decaporg/decap-cms/issues/6965), [#7445](https://github.com/decaporg/decap-cms/issues/7445)
 
 [^252]: Netlify/Decap CMS [#6629](https://github.com/decaporg/decap-cms/issues/6629)
+
+[^253]: Netlify/Decap CMS [#6635](https://github.com/decaporg/decap-cms/issues/6635), [#7006](https://github.com/decaporg/decap-cms/issues/7006), [#7311](https://github.com/decaporg/decap-cms/issues/7311)