Merge pull request #763 from estruyf/dev

Release v10.0.0
estruyf · Feb 28, 2024 · 6e26335 · 6e26335
2 parents 36ae708 + 2e35da3
commit 6e26335
Show file tree

Hide file tree

Showing 268 changed files with 15,508 additions and 20,983 deletions.
diff --git a/.github/actions/localization/action.yml b/.github/actions/localization/action.yml
@@ -0,0 +1,46 @@
+name: Localization sync
+description: Syncs the localization values from English to the other supported languages
+
+inputs:
+  TRANSLATION_API_KEY:
+    description: 'The API key for the translation service'
+    required: true
+  TRANSLATION_API_LOCATION:
+    description: 'The location of the translation service'
+    required: true
+  TRANSLATION_API_URL:
+    description: 'The URL of the translation service'
+    required: true
+  PACKAGE_NAME:
+    description: 'The name of the package to be uploaded'
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 18
+        registry-url: https://registry.npmjs.org/
+        cache: 'npm'
+
+    - name: Install the dependencies
+      shell: bash
+      run: npm ci
+
+    - name: Sync localization
+      shell: bash
+      run: npm run localization:sync
+      env:
+        TRANSLATION_API_KEY: ${{ inputs.TRANSLATION_API_KEY }}
+        TRANSLATION_API_LOCATION: ${{ inputs.TRANSLATION_API_LOCATION }}
+        TRANSLATION_API_URL: ${{ inputs.TRANSLATION_API_URL }}
+
+    - name: Remove the node_modules
+      shell: bash
+      run: rm -rf node_modules
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: ${{ inputs.PACKAGE_NAME }}
+        path: .
diff --git a/.github/workflows/release-beta.yml b/.github/workflows/release-beta.yml
@@ -5,35 +5,79 @@ on:
       - dev
   workflow_dispatch:
 
+env:
+  PACKAGE_NAME: 'fm-localized'
+  MS_URL: 'https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter-beta'
+  VSX_URL: 'https://open-vsx.org/extension/eliostruyf/vscode-front-matter-beta'
+
 jobs:
-  build:
-    name: 'Build and release'
+  localization:
+    name: 'Localization'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Localize the solution
+        uses: ./.github/actions/localization
+        with:
+          TRANSLATION_API_KEY: ${{ secrets.TRANSLATION_API_KEY }}
+          TRANSLATION_API_LOCATION: ${{ secrets.TRANSLATION_API_LOCATION }}
+          TRANSLATION_API_URL: ${{ secrets.TRANSLATION_API_URL }}
+          PACKAGE_NAME: ${{ env.PACKAGE_NAME }}
+
+  release-ms:
+    name: 'Release to VSCode Marketplace'
     runs-on: ubuntu-latest
+    needs: localization
     environment:
-      name: Beta
+      name: 'MS - BETA'
+      url: ${{ env.MS_URL }}
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/download-artifact@v4
+        with:
+          name: ${{ env.PACKAGE_NAME }}
+
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
           registry-url: https://registry.npmjs.org/
+          cache: 'npm'
 
       - name: Install the dependencies
         run: npm ci
 
       - name: Prepare BETA
         run: node scripts/beta-release.js $GITHUB_RUN_ID
 
-      - name: Run localization sync
-        run: npm run localization:sync
-        env:
-          TRANSLATION_API_KEY: ${{ secrets.TRANSLATION_API_KEY }}
-          TRANSLATION_API_LOCATION: ${{ secrets.TRANSLATION_API_LOCATION }}
-          TRANSLATION_API_URL: ${{ secrets.TRANSLATION_API_URL }}
-
       - name: Publish
         run: npx @vscode/vsce publish -p ${{ secrets.VSCE_PAT }} --baseImagesUrl https://raw.githubusercontent.com/estruyf/vscode-front-matter/dev
 
+  release-vsx:
+    name: 'Release to Open VSX'
+    runs-on: ubuntu-latest
+    needs: localization
+    environment:
+      name: 'Open VSX - BETA'
+      url: ${{ env.VSX_URL }}
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: ${{ env.PACKAGE_NAME }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+          cache: 'npm'
+
+      - name: Install the dependencies
+        run: npm ci
+
+      - name: Prepare BETA
+        run: node scripts/beta-release.js $GITHUB_RUN_ID
+
       - name: Publish to open-vsx.org
         run: npx ovsx publish -p ${{ secrets.OPEN_VSX_PAT }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -5,35 +5,79 @@ on:
       - published
   workflow_dispatch:
 
+env:
+  PACKAGE_NAME: 'fm-localized'
+  MS_URL: 'https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter'
+  VSX_URL: 'https://open-vsx.org/extension/eliostruyf/vscode-front-matter'
+
 jobs:
-  build:
-    name: 'Build and release'
+  localization:
+    name: 'Localization'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Localize the solution
+        uses: ./.github/actions/localization
+        with:
+          TRANSLATION_API_KEY: ${{ secrets.TRANSLATION_API_KEY }}
+          TRANSLATION_API_LOCATION: ${{ secrets.TRANSLATION_API_LOCATION }}
+          TRANSLATION_API_URL: ${{ secrets.TRANSLATION_API_URL }}
+          PACKAGE_NAME: ${{ env.PACKAGE_NAME }}
+
+  release-ms:
+    name: 'Release to VSCode Marketplace'
     runs-on: ubuntu-latest
+    needs: localization
     environment:
-      name: Stable
+      name: 'MS - Stable'
+      url: ${{ env.MS_URL }}
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/download-artifact@v4
+        with:
+          name: ${{ env.PACKAGE_NAME }}
+
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
           registry-url: https://registry.npmjs.org/
+          cache: 'npm'
 
       - name: Install the dependencies
         run: npm ci
 
       - name: Prepare MAIN release
         run: node scripts/main-release.js
 
-      - name: Run localization sync
-        run: npm run localization:sync
-        env:
-          TRANSLATION_API_KEY: ${{ secrets.TRANSLATION_API_KEY }}
-          TRANSLATION_API_LOCATION: ${{ secrets.TRANSLATION_API_LOCATION }}
-          TRANSLATION_API_URL: ${{ secrets.TRANSLATION_API_URL }}
-
       - name: Publish
         run: npx @vscode/vsce publish -p ${{ secrets.VSCE_PAT }}
 
+  release-vsx:
+    name: 'Release to Open VSX'
+    runs-on: ubuntu-latest
+    needs: localization
+    environment:
+      name: 'Open VSX - Stable'
+      url: ${{ env.VSX_URL }}
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: ${{ env.PACKAGE_NAME }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+          cache: 'npm'
+
+      - name: Install the dependencies
+        run: npm ci
+
+      - name: Prepare MAIN release
+        run: node scripts/main-release.js
+
       - name: Publish to open-vsx.org
         run: npx ovsx publish -p ${{ secrets.OPEN_VSX_PAT }}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,11 @@
 // Place your settings in this file to overwrite default and user settings.
 {
+  "workbench.colorCustomizations": {
+    "titleBar.activeBackground": "#15c2cb",
+    "titleBar.inactiveBackground": "#44ffd299",
+    "titleBar.activeForeground": "#0E131F",
+    "titleBar.inactiveForeground": "#0E131F99"
+  },
   "files.exclude": {
     "out": false // set this to true to hide the "out" folder with the compiled JS files
   },
@@ -8,8 +14,6 @@
   },
   // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
   "typescript.tsc.autoDetect": "off",
-  "eliostruyf.writingstyleguide.terms.isDisabled": true,
-  "eliostruyf.writingstyleguide.biasFree.isDisabled": true,
   "squarl.groups": [
     {
       "id": "dashboard",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,35 @@
 # Change Log
 
+## [10.0.0] - 2024-02-28 - [Release notes](https://beta.frontmatter.codes/updates/v10.0.0)
+
+### ✨ New features
+
+- [#731](https://github.com/estruyf/vscode-front-matter/issues/731): Added the ability to map/unmap taxonomy to multiple pages at once
+- [#746](https://github.com/estruyf/vscode-front-matter/issues/746): Placeholder support added to to the `slug` field
+- [#749](https://github.com/estruyf/vscode-front-matter/issues/749): Ability to set your own filters on the content dashboard with the `frontMatter.content.filters` setting
+- [#756](https://github.com/estruyf/vscode-front-matter/issues/756): i18n/multilingual content support
+
+### 🎨 Enhancements
+
+- [#673](https://github.com/estruyf/vscode-front-matter/pull/673): Added git settings to the welcome view and settings view
+- [#727](https://github.com/estruyf/vscode-front-matter/pull/727): Updated Japanese translations thanks to [mayumihara](https://github.com/mayumih387)
+- [#737](https://github.com/estruyf/vscode-front-matter/issues/737): Optimize the grid layout of the content and media dashboards
+- [#739](https://github.com/estruyf/vscode-front-matter/pull/739): New Git settings to disable and require a commit message
+- [#741](https://github.com/estruyf/vscode-front-matter/issues/741): Added message on the content dashboard when content is processed
+- [#747](https://github.com/estruyf/vscode-front-matter/issues/747): The `@frontmatter/extensibility` dependency now supports scripts for placeholders
+- [#752](https://github.com/estruyf/vscode-front-matter/issues/752): Placeholder support in default `list` field values
+- Support for using the `fieldCollection` field in a `block` field
+- Updated the list of commands which are available in the command palette
+
+### 🐞 Fixes
+
+- [#721](https://github.com/estruyf/vscode-front-matter/issues/721): Fix keywords regex to support unicode characters
+- [#725](https://github.com/estruyf/vscode-front-matter/issues/725): Fix for opening menu of pinned items
+- [#730](https://github.com/estruyf/vscode-front-matter/issues/730): Add debounce to the input fields
+- [#738](https://github.com/estruyf/vscode-front-matter/issues/738): Fix when re-opening the preview after closing it
+- [#743](https://github.com/estruyf/vscode-front-matter/issues/743): Fix for storing data in YAML data files
+- [#745](https://github.com/estruyf/vscode-front-matter/issues/745): Fix for date field values in `block` field type
+
 ## [9.4.0] - 2023-12-12 - [Release notes](https://beta.frontmatter.codes/updates/v9.4.0)
 
 ### ✨ New features

diff --git a/README.beta.md b/README.beta.md
@@ -54,6 +54,12 @@ A couple of our extension highlights that hopefully get you interested in giving
 
 > If you see something missing in your article creation flow, please feel free to reach out.
 
+**Version 10**
+
+In version 10, we introduced the new i18n/multilingual support for your content. You can now manage your content in multiple languages, more information can be found in the [multilingual](https://frontmatter.codes/docs/content-creation/multilingual) section of our documentation.
+
+![Multilingual support](https://beta.frontmatter.codes/releases/v10.0.0/multilingual-content.png)
+
 **Version 9**
 
 The extension is now available in multiple languages: English, German, and Japanese. Want to add your language? Check out the [localization the extension](https://frontmatter.codes/docs/contributing#translating-the-extension).
@@ -187,6 +193,27 @@ You can open showcase issues for the following things:
   </a>
 </p>
 
+## 📊 Telemetry
+
+The Front Matter CMS extension collects telemetry data to help us build a better understand which features from the CMS are used. The extension respects the `telemetry.enableTelemetry` setting which you can learn more about in the [Visual Studio Code FAQ](https://aka.ms/vscode-remote/telemetry), or you can only disable it for the extension by configuring the `frontMatter.telemetry.disable` setting.
+
+We only collect the following data:
+
+- Type of event
+- Extension title (main or beta)
+- Extension version
+
+No user-specific data is collected, you can check the telemetry implementation in the following files:
+
+- [Telemetry class](https://github.com/estruyf/vscode-front-matter/blob/59528a3db01be8d34dc40638e6cf827090e31986/src/helpers/Telemetry.ts)
+- [Metrics API](https://github.com/FrontMatter/web-documentation-nextjs/blob/main/pages/api/metrics.ts)
+
+For crash reports in the webviews, we make use of Sentry to help us understand what went wrong. This data is only used to fix issues and improve the extension. You can find more information about the Sentry implementation in the following files:
+
+- [Sentry config](https://github.com/estruyf/vscode-front-matter/blob/63e296d62f11be73ac86d9e823084247952a7ddc/src/utils/sentryInit.ts)
+
+> The user ip address is not collected.
+
 ## 🔑 License
 
 [MIT](./LICENSE)

diff --git a/README.md b/README.md
@@ -52,6 +52,12 @@ A couple of our extension highlights that hopefully get you interested in giving
 
 > If you see something missing in your article creation flow, please feel free to reach out.
 
+**Version 10**
+
+In version 10, we introduced the new i18n/multilingual support for your content. You can now manage your content in multiple languages, more information can be found in the [multilingual](https://frontmatter.codes/docs/content-creation/multilingual) section of our documentation.
+
+![Multilingual support](https://beta.frontmatter.codes/releases/v10.0.0/multilingual-content.png)
+
 **Version 9**
 
 The extension is now available in multiple languages: English, German, and Japanese. Want to add your language? Check out the [localization the extension](https://frontmatter.codes/docs/contributing#translating-the-extension).
@@ -193,6 +199,27 @@ You can open showcase issues for the following things:
    </a>
 </p>
 
+## 📊 Telemetry
+
+The Front Matter CMS extension collects telemetry data to help us build a better understand which features from the CMS are used. The extension respects the `telemetry.enableTelemetry` setting which you can learn more about in the [Visual Studio Code FAQ](https://aka.ms/vscode-remote/telemetry), or you can only disable it for the extension by configuring the `frontMatter.telemetry.disable` setting.
+
+We only collect the following data:
+
+- Type of event
+- Extension title (main or beta)
+- Extension version
+
+No user-specific data is collected, you can check the telemetry implementation in the following files:
+
+- [Telemetry class](https://github.com/estruyf/vscode-front-matter/blob/59528a3db01be8d34dc40638e6cf827090e31986/src/helpers/Telemetry.ts)
+- [Metrics API](https://github.com/FrontMatter/web-documentation-nextjs/blob/main/pages/api/metrics.ts)
+
+For crash reports in the webviews, we make use of Sentry to help us understand what went wrong. This data is only used to fix issues and improve the extension. You can find more information about the Sentry implementation in the following files:
+
+- [Sentry config](https://github.com/estruyf/vscode-front-matter/blob/63e296d62f11be73ac86d9e823084247952a7ddc/src/utils/sentryInit.ts)
+
+> The user ip address is not collected.
+
 ## 🔑 License
 
 [MIT](./LICENSE)

diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,17 @@
+# Support
+
+This article provides information on how to get support for Front Matter CMS.
+
+> 👉 Note: before participating in our community, please read our [code of conduct](./CODE_OF_CONDUCT.md). By interacting with this repository, organization, or community you agree to abide by its terms.
+
+## Asking for help
+
+There are a few different ways to ask for help with Front Matter CMS:
+
+1. **GitHub Discussions**: You can ask questions and share your experiences in the [Discussions](https://github.com/estruyf/vscode-front-matter/discussions) section of this repository.
+2. **GitHub Issues**: If you encounter a bug or have a feature request, you can open an issue in the [Issues](https://github.com/estruyf/vscode-front-matter/issues) section of this repository.
+3. **Discord**: You can join our [Discord](https://discord.gg/JBVtNMsJFB) server and ask your questions there.
+
+## Contributing
+
+If you would like to contribute to Front Matter CMS, please read our [contributing guide](./CONTRIBUTING.md).
diff --git a/assets/icons/i18n-dark.svg b/assets/icons/i18n-dark.svg
diff --git a/assets/icons/i18n-light.svg b/assets/icons/i18n-light.svg