Merge pull request #817 from estruyf/dev

Merge for release 10.2.0

.vscode/launch.json

@@ -10,7 +10,9 @@
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
-      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}", "--disable-extension=eliostruyf.vscode-front-matter"
+      ],
       "outFiles": ["${workspaceFolder}/dist/**/*.js"],
       "preLaunchTask": "npm: build:ext"
     },
@@ -19,7 +21,9 @@
 			"type": "extensionHost",
 			"request": "launch",
 			"runtimeExecutable": "${execPath}",
-      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}", "--disable-extension=eliostruyf.vscode-front-matter"
+      ],
       "outFiles": ["${workspaceFolder}/dist/**/*.js"]
     }
   ]

.vscode/settings.json

@@ -1,5 +1,15 @@
 // Place your settings in this file to overwrite default and user settings.
 {
+  "commitHelper.messages": [
+    {
+      "type": "👨‍💻 apps",
+      "values": ["#search", "#profile"]
+    },
+    {
+      "type": "⚙️ tasks",
+      "values": ["#build", "#deploy", "#skip"]
+    }
+  ],
   "workbench.colorCustomizations": {
     "titleBar.activeBackground": "#15c2cb",
     "titleBar.inactiveBackground": "#44ffd299",

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## [10.2.0] - 2024-xx-xx
+## [10.2.0] - 2024-06-12 - [Release notes](https://beta.frontmatter.codes/updates/v10.2.0)
 
 ### ✨ New features
 
@@ -9,15 +9,15 @@
 ### 🎨 Enhancements
 
 - [#441](https://github.com/estruyf/vscode-front-matter/issues/441): Show input descriptions for snippet and data forms
-- [#442](https://github.com/estruyf/vscode-front-matter/issues/442): Hide sidebar on data view when data file is selecte + show dropdown of data files
+- [#442](https://github.com/estruyf/vscode-front-matter/issues/442): Hide sidebar on data view when data file is selected + show dropdown of data files
 - [#788](https://github.com/estruyf/vscode-front-matter/issues/788): Show a warning on setting update when it exists in an extended configuration
 - [#798](https://github.com/estruyf/vscode-front-matter/issues/798): Changed dialog to slide-over for the snippet forms
-- [#799](https://github.com/estruyf/vscode-front-matter/issues/799): Added `frontMatter.logging` setting to define the logging output. Options are `info`, `warn`, `error`, and `verbose`. Default is `info`.
+- [#799](https://github.com/estruyf/vscode-front-matter/issues/799): Added `frontMatter.logging` setting to define the logging output. Options are `info`, `warn`, `error`, and `verbose`. The default is `info`.
 - [#800](https://github.com/estruyf/vscode-front-matter/issues/800): Add colors for the Front Matter CMS output
 - [#808](https://github.com/estruyf/vscode-front-matter/issues/808): Add support to generate field groups and `block` fields in content type generation
 - [#810](https://github.com/estruyf/vscode-front-matter/issues/810): Update the tab title based on the view
 - [#811](https://github.com/estruyf/vscode-front-matter/issues/811): Added `panel.gitActions` view mode option to hide the Git actions in the panel
-- [#812](https://github.com/estruyf/vscode-front-matter/issues/812): Added the `{{locale}}` placeholder which can be used in the `previewPath` property
+- [#812](https://github.com/estruyf/vscode-front-matter/issues/812): Added the `{{locale}}` placeholder, which can be used in the `previewPath` property
 
 ### ⚡️ Optimizations
 

package.json

@@ -1176,7 +1176,7 @@
           "scope": "Site preview"
         },
         "frontMatter.preview.trailingSlash": {
-          "type": "string",
+          "type": "boolean",
           "default": "",
           "markdownDescription": "%setting.frontMatter.preview.trailingSlash.markdownDescription%",
           "scope": "Site preview"

src/commands/Article.ts

@@ -27,6 +27,7 @@ import { CustomPlaceholder, Field } from '../models';
 import { format } from 'date-fns';
 import {
   ArticleHelper,
+  Logger,
   Settings,
   SlugHelper,
   processArticlePlaceholdersFromData,
@@ -133,6 +134,7 @@ export class Article {
   private static async setLastModifiedDateInner(
     document: TextDocument
   ): Promise<ParsedFrontMatter | undefined> {
+    Logger.verbose(`Article:setLastModifiedDateInner:Start`);
     const article = ArticleHelper.getFrontMatterFromDocument(document);
 
     // Only set the date, if there is already front matter set
@@ -142,9 +144,16 @@ export class Article {
 
     const cloneArticle = Object.assign({}, article);
     const dateField = await ArticleHelper.getModifiedDateField(article);
+    Logger.verbose(`Article:setLastModifiedDateInner:DateField - ${JSON.stringify(dateField)}`);
+
     try {
       const fieldName = dateField?.name || DefaultFields.LastModified;
-      cloneArticle.data[fieldName] = Article.formatDate(new Date(), dateField?.dateFormat);
+      const fieldValue = Article.formatDate(new Date(), dateField?.dateFormat);
+      cloneArticle.data[fieldName] = fieldValue;
+      Logger.verbose(
+        `Article:setLastModifiedDateInner:DateField name - ${fieldName} - value - ${fieldValue}`
+      );
+      Logger.verbose(`Article:setLastModifiedDateInner:End`);
       return cloneArticle;
     } catch (e: unknown) {
       Notifications.error(
@@ -371,11 +380,16 @@ export class Article {
   public static formatDate(dateValue: Date, fieldDateFormat?: string): string {
     const dateFormat = Settings.get(SETTING_DATE_FORMAT) as string;
 
+    Logger.verbose(`Article:formatDate:Start`);
+
     if (fieldDateFormat) {
+      Logger.verbose(`Article:formatDate:FieldDateFormat - ${fieldDateFormat}`);
       return format(dateValue, DateHelper.formatUpdate(fieldDateFormat) as string);
     } else if (dateFormat && typeof dateFormat === 'string') {
+      Logger.verbose(`Article:formatDate:DateFormat - ${dateFormat}`);
       return format(dateValue, DateHelper.formatUpdate(dateFormat) as string);
     } else {
+      Logger.verbose(`Article:formatDate:toISOString - ${dateValue}`);
       return typeof dateValue.toISOString === 'function'
         ? dateValue.toISOString()
         : dateValue?.toString();

src/commands/Preview.ts

@@ -250,9 +250,7 @@ export class Preview {
     // Check if there is a pathname defined on content folder level
     const folders = await Folders.get();
     if (folders.length > 0) {
-      const foldersWithPath = folders.filter((folder) => folder.previewPath);
-
-      for (const folder of foldersWithPath) {
+      for (const folder of folders) {
         const folderPath = parseWinPath(folder.path);
         if (filePath.startsWith(folderPath)) {
           if (!selectedFolder || selectedFolder.path.length < folderPath.length) {

src/constants/DefaultFeatureFlags.ts

@@ -0,0 +1,12 @@
+import { FEATURE_FLAG } from './Features';
+
+export const DEFAULT_PANEL_FEATURE_FLAGS = Object.values(FEATURE_FLAG.panel).filter(
+  (v) => v !== FEATURE_FLAG.panel.globalSettings
+);
+
+export const DEFAULT_DASHBOARD_FEATURE_FLAGS = [
+  FEATURE_FLAG.dashboard.data.view,
+  FEATURE_FLAG.dashboard.taxonomy.view,
+  FEATURE_FLAG.dashboard.snippets.view,
+  FEATURE_FLAG.dashboard.snippets.manage
+];

src/dashboardWebView/components/Header/Tabs.tsx

@@ -9,6 +9,7 @@ import { Tab } from './Tab';
 import * as l10n from '@vscode/l10n';
 import { LocalizationKey } from '../../../localization';
 import { PageIcon } from '../../../panelWebView/components/Icons';
+import { DEFAULT_DASHBOARD_FEATURE_FLAGS } from '../../../constants/DefaultFeatureFlags';
 
 export interface ITabsProps {
   onNavigate: (navigationType: NavigationType) => void;
@@ -19,12 +20,6 @@ export const Tabs: React.FunctionComponent<ITabsProps> = ({
 }: React.PropsWithChildren<ITabsProps>) => {
   const mode = useRecoilValue(ModeAtom);
 
-  const allDashboardVIews = [
-    FEATURE_FLAG.dashboard.snippets.view,
-    FEATURE_FLAG.dashboard.data.view,
-    FEATURE_FLAG.dashboard.taxonomy.view
-  ];
-
   return (
     <ul
       className="flex items-center justify-start h-full space-x-4"
@@ -43,7 +38,7 @@ export const Tabs: React.FunctionComponent<ITabsProps> = ({
           <span>{l10n.t(LocalizationKey.dashboardHeaderTabsMedia)}</span>
         </Tab>
       </li>
-      <FeatureFlag features={mode?.features || [...allDashboardVIews]} flag={FEATURE_FLAG.dashboard.snippets.view}>
+      <FeatureFlag features={mode?.features || DEFAULT_DASHBOARD_FEATURE_FLAGS} flag={FEATURE_FLAG.dashboard.snippets.view}>
         <li role="presentation">
           <Tab navigationType={NavigationType.Snippets} onNavigate={onNavigate}>
             <ScissorsIcon className={`h-4 w-auto mr-2`} />
@@ -51,7 +46,7 @@ export const Tabs: React.FunctionComponent<ITabsProps> = ({
           </Tab>
         </li>
       </FeatureFlag>
-      <FeatureFlag features={mode?.features || [...allDashboardVIews]} flag={FEATURE_FLAG.dashboard.data.view}>
+      <FeatureFlag features={mode?.features || DEFAULT_DASHBOARD_FEATURE_FLAGS} flag={FEATURE_FLAG.dashboard.data.view}>
         <li role="presentation">
           <Tab navigationType={NavigationType.Data} onNavigate={onNavigate}>
             <CircleStackIcon className={`h-4 w-auto mr-2`} />
@@ -59,7 +54,7 @@ export const Tabs: React.FunctionComponent<ITabsProps> = ({
           </Tab>
         </li>
       </FeatureFlag>
-      <FeatureFlag features={mode?.features || [...allDashboardVIews]} flag={FEATURE_FLAG.dashboard.taxonomy.view}>
+      <FeatureFlag features={mode?.features || DEFAULT_DASHBOARD_FEATURE_FLAGS} flag={FEATURE_FLAG.dashboard.taxonomy.view}>
         <li role="presentation">
           <Tab navigationType={NavigationType.Taxonomy} onNavigate={onNavigate}>
             <TagIcon className={`h-4 w-auto mr-2`} />

src/dashboardWebView/components/SnippetsView/Item.tsx

@@ -19,6 +19,7 @@ import { LocalizationKey } from '../../../localization';
 import { FooterActions } from './FooterActions';
 import { ItemMenu } from './ItemMenu';
 import { SlideOver } from '../Modals/SlideOver';
+import { DEFAULT_DASHBOARD_FEATURE_FLAGS } from '../../../constants/DefaultFeatureFlags';
 
 export interface IItemProps {
   snippetKey: string;
@@ -163,7 +164,7 @@ export const Item: React.FunctionComponent<IItemProps> = ({
           </h2>
 
           <FeatureFlag
-            features={mode?.features || []}
+            features={mode?.features || DEFAULT_DASHBOARD_FEATURE_FLAGS}
             flag={FEATURE_FLAG.dashboard.snippets.manage}
             alternative={
               <ItemMenu
@@ -190,7 +191,7 @@ export const Item: React.FunctionComponent<IItemProps> = ({
         </div>
 
         <FeatureFlag
-          features={mode?.features || []}
+          features={mode?.features || DEFAULT_DASHBOARD_FEATURE_FLAGS}
           flag={FEATURE_FLAG.dashboard.snippets.manage}
           alternative={
             <FooterActions

src/dashboardWebView/components/SnippetsView/Snippets.tsx

@@ -18,6 +18,7 @@ import * as l10n from '@vscode/l10n';
 import { LocalizationKey } from '../../../localization';
 import { List } from '../Media/List';
 import { SlideOver } from '../Modals/SlideOver';
+import { DEFAULT_DASHBOARD_FEATURE_FLAGS } from '../../../constants/DefaultFeatureFlags';
 
 export interface ISnippetsProps { }
 
@@ -96,7 +97,9 @@ export const Snippets: React.FunctionComponent<ISnippetsProps> = (
   return (
     <PageLayout
       header={
-        <FeatureFlag features={mode?.features || []} flag={FEATURE_FLAG.dashboard.snippets.manage}>
+        <FeatureFlag
+          features={mode?.features || DEFAULT_DASHBOARD_FEATURE_FLAGS}
+          flag={FEATURE_FLAG.dashboard.snippets.manage}>
           <div
             className={`py-3 px-4 flex items-center justify-between border-b border-[var(--frontmatter-border)]`}
             aria-label={l10n.t(LocalizationKey.dashboardSnippetsViewSnippetsAriaLabel)}

src/listeners/dashboard/PagesListener.ts

@@ -71,7 +71,7 @@ export class PagesListener extends BaseListener {
         // Optimize the list of recently changed files
         DataListener.getFoldersAndFiles(doc.uri);
         // Trigger the metadata update
-        this.watcherExec(doc.uri);
+        this.watcherExec(doc.uri, 'save');
       }
     });
   }
@@ -103,9 +103,9 @@ export class PagesListener extends BaseListener {
         false,
         false
       );
-      watcher.onDidCreate(async (uri: Uri) => this.watcherExec(uri));
-      watcher.onDidChange(async (uri: Uri) => this.watcherExec(uri));
-      watcher.onDidDelete(async (uri: Uri) => this.watcherExec(uri));
+      watcher.onDidCreate(async (uri: Uri) => this.watcherExec(uri, 'create'));
+      watcher.onDidChange(async (uri: Uri) => this.watcherExec(uri, 'change'));
+      watcher.onDidDelete(async (uri: Uri) => this.watcherExec(uri, 'delete'));
       this.watchers[folderUri.fsPath] = watcher;
     }
   }
@@ -162,10 +162,10 @@ export class PagesListener extends BaseListener {
    * Watcher for processing page updates
    * @param file
    */
-  private static async watcherExec(file: Uri) {
+  private static async watcherExec(file: Uri, type?: 'create' | 'change' | 'delete' | 'save') {
     const progressFile = async (file: Uri) => {
       const ext = Extension.getInstance();
-      Logger.info(`File watcher execution for: ${file.fsPath}`);
+      Logger.info(`File watcher execution for (${type}): ${file.fsPath}`);
 
       const pageIdx = this.lastPages.findIndex((p) => p.fmFilePath === file.fsPath);
       if (pageIdx !== -1) {

src/panelWebView/ViewPanel.tsx

@@ -17,6 +17,7 @@ import { usePrevious } from './hooks/usePrevious';
 import * as l10n from '@vscode/l10n';
 import { LocalizationKey } from '../localization';
 import { InitializeAction } from './components/InitializeAction';
+import { DEFAULT_PANEL_FEATURE_FLAGS } from '../constants/DefaultFeatureFlags';
 
 export interface IViewPanelProps { }
 
@@ -37,10 +38,6 @@ export const ViewPanel: React.FunctionComponent<IViewPanelProps> = (
   const prevMediaSelection = usePrevious(mediaSelecting);
   const [scrollY, setScrollY] = useState(0);
 
-  const allPanelValues = useMemo(() => {
-    return Object.values(FEATURE_FLAG.panel).filter(v => v !== FEATURE_FLAG.panel.globalSettings)
-  }, [FEATURE_FLAG.panel]);
-
   const scollListener = useCallback((e: Event) => {
     if (!mediaSelecting) {
       setScrollY(window.scrollY);
@@ -48,7 +45,7 @@ export const ViewPanel: React.FunctionComponent<IViewPanelProps> = (
   }, [mediaSelecting]);
 
   const isSomethingShown = useMemo(() => {
-    const panelModeValues = (mode?.features || [...allPanelValues]).filter(v => v.startsWith('panel.'));
+    const panelModeValues = (mode?.features || DEFAULT_PANEL_FEATURE_FLAGS).filter(v => v.startsWith('panel.'));
 
     if (panelModeValues.length === 0) {
       return false;
@@ -125,19 +122,19 @@ export const ViewPanel: React.FunctionComponent<IViewPanelProps> = (
       <InitializeAction settings={settings} />
 
       <div className={`ext_actions`}>
-        <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.gitActions}>
+        <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.gitActions}>
           <GitAction settings={settings} />
         </FeatureFlag>
 
         {!loading && (<CustomView metadata={metadata} />)}
 
-        <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.globalSettings}>
+        <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.globalSettings}>
           <GlobalSettings settings={settings} isBase={!metadata} />
         </FeatureFlag>
 
         {
           !loading && metadata && settings && settings.seo && (
-            <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.seo}>
+            <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.seo}>
               <SeoStatus
                 seo={settings.seo}
                 data={metadata}
@@ -149,7 +146,7 @@ export const ViewPanel: React.FunctionComponent<IViewPanelProps> = (
         }
 
         {!loading && settings && (
-          <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.actions}>
+          <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.actions}>
             <Actions
               metadata={metadata}
               settings={settings}
@@ -159,23 +156,23 @@ export const ViewPanel: React.FunctionComponent<IViewPanelProps> = (
 
         {
           !loading && metadata && (
-            <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.metadata}>
+            <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.metadata}>
               <Metadata
                 settings={settings}
                 metadata={metadata}
                 focusElm={focusElm}
                 unsetFocus={unsetFocus}
-                features={mode?.features || [...allPanelValues]}
+                features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS}
               />
             </FeatureFlag>
           )
         }
 
-        <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.recentlyModified}>
+        <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.recentlyModified}>
           <FolderAndFiles data={folderAndFiles} isBase={!metadata} />
         </FeatureFlag>
 
-        <FeatureFlag features={mode?.features || [...allPanelValues]} flag={FEATURE_FLAG.panel.otherActions}>
+        <FeatureFlag features={mode?.features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.otherActions}>
           <OtherActions settings={settings} isFile={!!metadata} isBase={!metadata} />
         </FeatureFlag>
 

src/panelWebView/components/Metadata.tsx

@@ -12,6 +12,7 @@ import { FEATURE_FLAG, GeneralCommands } from '../../constants';
 import { Messenger } from '@estruyf/vscode/dist/client';
 import * as l10n from '@vscode/l10n';
 import { LocalizationKey } from '../../localization';
+import { DEFAULT_PANEL_FEATURE_FLAGS } from '../../constants/DefaultFeatureFlags';
 
 export interface IMetadata {
   [prop: string]: string[] | string | null | IMetadata;
@@ -95,7 +96,7 @@ const Metadata: React.FunctionComponent<IMetadataProps> = ({
       id={`tags`}
       title={`${l10n.t(LocalizationKey.panelMetadataTitle)}${contentType?.name ? ` (${contentType?.name})` : ""}`}
       className={`inherit z-20`}>
-      <FeatureFlag features={features || []} flag={FEATURE_FLAG.panel.contentType}>
+      <FeatureFlag features={features || DEFAULT_PANEL_FEATURE_FLAGS} flag={FEATURE_FLAG.panel.contentType}>
         <ContentTypeValidator fields={contentType?.fields || []} metadata={metadata} />
       </FeatureFlag>