1.18.0

Bump lodash from 4.17.19 to 4.17.21

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [1.18.0] - 2020-07-20
+
+- Updated README
+## [1.17.1] - 2020-06-28
+
+- [#34](https://github.com/estruyf/vscode-front-matter/issues/34): Fix that last modification date does not update the publication date
+- [#38](https://github.com/estruyf/vscode-front-matter/issues/38): Update the last modification date on new page creation from the template
+
+## [1.17.0] - 2020-06-14
+
+- [#36](https://github.com/estruyf/vscode-front-matter/issues/36): Add the option to change the Front Matter its description field
+
 ## [1.16.1] - 2020-05-27
 
 - Fix for Node.js v14.16.0

README.md

@@ -1,8 +1,24 @@
-[![Version](https://vsmarketplacebadge.apphb.com/version/eliostruyf.vscode-front-matter.svg)](https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter)
-  
-[![Installs](https://vsmarketplacebadge.apphb.com/installs/eliostruyf.vscode-front-matter.svg)](https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter)
-  
-[![Rating](https://vsmarketplacebadge.apphb.com/rating/eliostruyf.vscode-front-matter.svg)](https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter&ssr=false#review-details)
+<h1 align="center">
+  <a href="https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter">
+    <img alt="Front Matter" src="./assets/front-matter.png">
+  </a>
+</h1>
+
+<h2 align="center">Front Matter is an essential Visual Studio Code extension when you want to manage the markdown pages of your static sites.</h2>
+
+<p align="center">
+  <a href="https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter" title="Check it out on the Visual Studio Marketplace">
+    <img src="https://vsmarketplacebadge.apphb.com/version/eliostruyf.vscode-front-matter.svg" alt="Visual Studio Marketplace" style="display: inline-block" />
+  </a>
+
+  <img src="https://vsmarketplacebadge.apphb.com/installs/eliostruyf.vscode-front-matter.svg" alt="Number of installs"  style="display: inline-block;margin-left:10px" />
+  
+  <img src="https://vsmarketplacebadge.apphb.com/rating/eliostruyf.vscode-front-matter.svg" alt="Ratings" style="display: inline-block;margin-left:10px" />
+
+  <a href="https://www.buymeacoffee.com/zMeFRy9" title="Buy me a coffee" style="margin-left:10px">
+    <img src="https://img.shields.io/badge/Buy%20me%20a%20coffee-€%203-blue?logo=buy-me-a-coffee&style=flat" alt="Buy me a coffee" style="display: inline-block" />
+  </a>
+</p>
 
 This VSCode extension simplifies working with your markdown articles' front matter when using a static site generator like Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more... For example, you can keep a list of used tags, categories and add/remove them from your article with the extension.
 
@@ -32,12 +48,18 @@ The current workspace-, file-path, and front matter data will be passed as an ar
 
 ```javascript
 const arguments = process.argv;
-const workspaceArg = arguments[2];
-const fileArg = arguments[3];
-const dataArg = arguments[4];
-const data = dataArg && typeof dataArg === "string" ? JSON.parse(dataArg) : null;
+
+if (arguments && arguments.length > 0) {
+  const workspaceArg = arguments[2]; // The workspace path
+  const fileArg = arguments[3]; // The file path
+  const frontMatterArg = arguments[4]; // Front matter data
+
+  console.log(`The content returned for your notification.`);
+}
 ```
 
+> A sample file can be found here: [script-sample.js](./sample/script-sample.js)
+
 The output of the script will be passed as a notification, and it allows you to copy the output.
 
 ![](./assets/custom-action-notification.png)
@@ -139,6 +161,15 @@ Specifies the optimal description length for SEO (set to `-1` to turn it off). D
   "frontMatter.taxonomy.seoDescriptionLength": 160
 }
 ```
+### `frontMatter.taxonomy.seoDescriptionLength`
+
+Specifies the name of the SEO description field for your page. Default is `description`.
+
+```json
+{
+  "frontMatter.taxonomy.seoDescriptionField": "description"
+}
+```
 
 ### `frontMatter.taxonomy.frontMatterType`
 
@@ -216,3 +247,9 @@ Allows you to specify a title and script path (starting relative from the root o
 ## Feedback / issues / ideas
 
 Please submit them via creating an issue in the project repository: [issue list](https://github.com/estruyf/vscode-front-matter/issues).
+
+<p align="center">
+  <a href="#">
+      <img src="https://estruyf-github.azurewebsites.net/api/VisitorHit?user=estruyf&repo=vscode-front-matter&countColor=%23F05450&labelColor=%230E131F" />
+   </a>
+</p>

package.json

@@ -3,7 +3,7 @@
 	"displayName": "Front Matter",
 	"description": "Simplifies working with front matter of your articles. Useful extension when you are using a static site generator like: Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more...",
 	"icon": "assets/front-matter.png",
-	"version": "1.16.1",
+	"version": "1.18.0",
 	"preview": false,
 	"publisher": "eliostruyf",
 	"galleryBanner": {
@@ -15,6 +15,11 @@
 			"description": "version",
 			"url": "https://img.shields.io/github/package-json/v/estruyf/vscode-front-matter?color=green&label=vscode-front-matter&style=flat-square",
 			"href": "https://github.com/estruyf/vscode-front-matter"
+		},
+		{
+			"description": "Buy me a coffee",
+			"url": "https://img.shields.io/badge/Buy%20me%20a%20coffee-€%203-blue?logo=buy-me-a-coffee&style=flat-square",
+			"href": "https://www.buymeacoffee.com/zMeFRy9"
 		}
 	],
 	"engines": {
@@ -137,6 +142,11 @@
 					"default": 160,
 					"description": "Specifies the optimal description length for SEO (set to `-1` to turn it off)."
 				},
+				"frontMatter.taxonomy.seoDescriptionField": {
+					"type": "string",
+					"default": "description",
+					"description": "Specifies the name of the SEO description field for your page. Default is 'description'."
+				},
 				"frontMatter.templates.folder": {
 					"type": "string",
 					"default": ".templates",

sample/script-sample.js

@@ -0,0 +1,10 @@
+
+const arguments = process.argv;
+
+if (arguments && arguments.length > 0) {
+  const workspaceArg = arguments[2]; // The workspace path
+  const fileArg = arguments[3]; // The file path
+  const frontMatterArg = arguments[4]; // Front matter data
+
+  console.log(`The content returned for your notification.`);
+}

src/commands/Article.ts

@@ -101,14 +101,11 @@ export class Article {
     const config = vscode.workspace.getConfiguration(CONFIG_KEY);
     const dateFormat = config.get(SETTING_DATE_FORMAT) as string;
     const dateField = config.get(SETTING_DATE_FIELD) as string || "date";
+    const modField = config.get(SETTING_MODIFIED_FIELD) as string || "date";
+
+    article = this.articleDate(article, dateFormat, dateField, forceCreate);
+    article = this.articleDate(article, dateFormat, modField, false);   
 
-    if (typeof article.data[dateField] !== "undefined" || forceCreate) {
-      if (dateFormat && typeof dateFormat === "string") {
-        article.data[dateField] = format(new Date(), dateFormat);
-      } else {
-        article.data[dateField] = new Date();
-      }
-    }
     return article;
   }
 
@@ -133,7 +130,7 @@ export class Article {
       if (dateFormat && typeof dateFormat === "string") {
         article.data[dateField] = format(new Date(), dateFormat);
       } else {
-        article.data[dateField] = new Date();
+        article.data[dateField] = new Date().toISOString();
       }
 
       ArticleHelper.update(editor, article);
@@ -185,4 +182,22 @@ export class Article {
     article.data["draft"] = newDraftStatus;
     ArticleHelper.update(editor, article);
   }
+
+  /**
+   * Update the article date and return it
+   * @param article 
+   * @param dateFormat 
+   * @param field 
+   * @param forceCreate 
+   */
+  private static articleDate(article: matter.GrayMatterFile<string>, dateFormat: string, field: string, forceCreate: boolean) {
+    if (typeof article.data[field] !== "undefined" || forceCreate) {
+      if (dateFormat && typeof dateFormat === "string") {
+        article.data[field] = format(new Date(), dateFormat);
+      } else {
+        article.data[field] = new Date().toISOString();
+      }
+    }
+    return article;
+  }
 }

src/commands/StatusListener.ts

@@ -1,4 +1,4 @@
-import { SETTING_SEO_DESCRIPTION_LENGTH, SETTING_SEO_TITLE_LENGTH } from './../constants/settings';
+import { SETTING_SEO_DESCRIPTION_FIELD, SETTING_SEO_DESCRIPTION_LENGTH, SETTING_SEO_TITLE_LENGTH } from './../constants/settings';
 import * as vscode from 'vscode';
 import { CONFIG_KEY } from '../constants';
 import { ArticleHelper, SeoHelper } from '../helpers';
@@ -41,13 +41,14 @@ export class StatusListener {
           const config = vscode.workspace.getConfiguration(CONFIG_KEY);
           const titleLength = config.get(SETTING_SEO_TITLE_LENGTH) as number || -1;
           const descLength = config.get(SETTING_SEO_DESCRIPTION_LENGTH) as number || -1;
+          const fieldName = config.get(SETTING_SEO_DESCRIPTION_FIELD) as string || "description";
           
           if (article.data.title && titleLength > -1) {
             SeoHelper.checkLength(editor, collection, article, "title", titleLength);
           }
           
-          if (article.data.description && descLength > -1) {
-            SeoHelper.checkLength(editor, collection, article, "description", descLength);
+          if (article.data[fieldName] && descLength > -1) {
+            SeoHelper.checkLength(editor, collection, article, fieldName, descLength);
           }
         }
         

src/constants/settings.ts

@@ -18,6 +18,7 @@ export const SETTING_FRONTMATTER_TYPE = "taxonomy.frontMatterType";
 
 export const SETTING_SEO_TITLE_LENGTH = "taxonomy.seoTitleLength";
 export const SETTING_SEO_DESCRIPTION_LENGTH = "taxonomy.seoDescriptionLength";
+export const SETTING_SEO_DESCRIPTION_FIELD = "taxonomy.seoDescriptionField";
 
 export const SETTING_TEMPLATES_FOLDER = "templates.folder";
 export const SETTING_TEMPLATES_PREFIX = "templates.prefix";

src/models/PanelSettings.ts

@@ -11,6 +11,7 @@ export interface PanelSettings {
 export interface SEO {
   title: number;
   description: number;
+  descriptionField: string;
 }
 
 export interface Slug {

src/viewpanel/components/SeoStatus.tsx

@@ -11,7 +11,9 @@ export const SeoStatus: React.FunctionComponent<ISeoStatusProps> = (props: React
   const { data, seo } = props;
   const { title, description } = data;
 
-  if (!title && !description) {
+  const { descriptionField } = seo;
+
+  if (!title && !data[descriptionField]) {
     return null;
   }
 
@@ -19,7 +21,7 @@ export const SeoStatus: React.FunctionComponent<ISeoStatusProps> = (props: React
     <div className="seo__status">
       <h3>SEO Status</h3>
       { (title && seo.title > 0) && <SeoDetails title="Title" allowedLength={seo.title} value={title} /> }
-      { (description && seo.description > 0) && <SeoDetails title="Description" allowedLength={seo.description} value={description} /> }
+      { (data[descriptionField] && seo.description > 0) && <SeoDetails title="Description" allowedLength={seo.description} value={data[descriptionField]} /> }
     </div>
   );
 };

src/webview/ExplorerView.ts

@@ -1,4 +1,4 @@
-import { SETTING_CUSTOM_SCRIPTS } from './../constants/settings';
+import { SETTING_CUSTOM_SCRIPTS, SETTING_SEO_DESCRIPTION_FIELD } from './../constants/settings';
 import * as os from 'os';
 import { PanelSettings, CustomScript } from './../models/PanelSettings';
 import { CancellationToken, Disposable, Uri, Webview, WebviewView, WebviewViewProvider, WebviewViewResolveContext, window, workspace, commands, env as vscodeEnv } from "vscode";
@@ -220,7 +220,8 @@ export class ExplorerView implements WebviewViewProvider, Disposable {
       data: {
         seo: {
           title: config.get(SETTING_SEO_TITLE_LENGTH) as number || -1,
-          description: config.get(SETTING_SEO_DESCRIPTION_LENGTH) as number || -1
+          description: config.get(SETTING_SEO_DESCRIPTION_LENGTH) as number || -1,
+          descriptionField: config.get(SETTING_SEO_DESCRIPTION_FIELD) as string || "description"
         },
         slug: {
           prefix: config.get(SETTING_SLUG_PREFIX) || "",