iarv/vscode-front-matter
1
0
Fork 1
mirror of https://github.com/estruyf/vscode-front-matter.git synced 2026-05-08 22:34:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

#193 - Added data type support

Browse Source
This commit is contained in:
Elio Struyf
2022-01-14 13:00:27 +01:00
parent 01921c799c
commit 9744cf0117
8 changed files with 85 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
package.json
+43 -1
View File
@@ -358,6 +358,11 @@
"default": {},
"description": "The JSON schema for your data which will be used to render the data form.",
"additionalProperties": true
},
"type": {
"type": "string",
"default": "content",
"description": "If you are using data types, you can specify your type ID."
}
},
"additionalProperties": false,
@@ -365,8 +370,45 @@
"id",
"title",
"file",
"schema",
"labelField"
],
"anyOf": [
{
"required": [
"schema"
]
},
{
"required": [
"type"
]
}
]
},
"scope": "Data"
},
"frontMatter.data.types": {
"type": "array",
"default": [],
"markdownDescription": "Specify the data types. These types can be used in for your data files. [Check in the docs](https://frontmatter.codes/docs/settings#frontmatter.data.types)",
"items": {
"type": "object",
"default": {},
"properties": {
"id": {
"type": "string",
"description": "Your unique ID you want to use for your data type."
},
"schema": {
"type": "object",
"default": {},
"description": "The JSON schema for your data which will be used to render the data form.",
"additionalProperties": true
}
},
"required": [
"id",
"schema"
]
},
"scope": "Data"
src/constants/settings.ts
+1
View File
@@ -56,6 +56,7 @@ export const SETTINGS_DASHBOARD_OPENONSTART = "dashboard.openOnStart";
export const SETTINGS_DASHBOARD_MEDIA_SNIPPET = "dashboard.mediaSnippet";
export const SETTINGS_DATA_FILES = "data.files";
export const SETTINGS_DATA_TYPES = "data.types";
export const SETTINGS_FRAMEWORK_ID = "framework.id";
src/dashboardWebView/components/DataView/DataView.tsx
+23 -3
View File
@@ -18,6 +18,7 @@ import { SortableItem } from './SortableItem';
import { ChevronRightIcon } from '@heroicons/react/outline';
import { ToastContainer, toast, Slide } from 'react-toastify';
import 'react-toastify/dist/ReactToastify.css';
import { DataType } from '../../../models/DataType';
export interface IDataViewProps {}
@@ -75,7 +76,7 @@ export const DataView: React.FunctionComponent<IDataViewProps> = (props: React.P
});
// Show toast message
toast.success("Wow so easy!", {
toast.success("Your entry was submitted", {
position: "top-right",
autoClose: 2000,
hideProgressBar: true,
@@ -115,6 +116,25 @@ export const DataView: React.FunctionComponent<IDataViewProps> = (props: React.P
Messenger.unlisten(messageListener);
}
}, []);
// Retrieve the data files, check if they have a schema or ID, if not, they shouldn't be shown
const dataFiles = (settings?.dataFiles || []).map((dataFile: DataFile) => {
if (!dataFile.schema && !dataFile.id) {
return null;
}
const clonedFile = Object.assign({}, dataFile);
if (clonedFile.type) {
const dataType = settings?.dataTypes?.find((dataType: DataType) => dataType.id === clonedFile.type);
if (!dataType) {
return null;
}
clonedFile.schema = Object.assign({}, dataType.schema);
}
return clonedFile;
}).filter(d => d !== null) as DataFile[];
return (
<div className="flex flex-col h-full overflow-auto inset-y-0">
@@ -130,8 +150,8 @@ export const DataView: React.FunctionComponent<IDataViewProps> = (props: React.P
<nav className={`flex-1 py-4 -mx-4 `}>
<div className={`divide-y divide-gray-200 dark:divide-vulcan-300 border-t border-b border-gray-200 dark:border-vulcan-300`}>
{
(settings?.dataFiles && settings.dataFiles.length > 0) && (
settings.dataFiles.map((dataFile) => (
(dataFiles && dataFiles.length > 0) && (
dataFiles.map((dataFile) => (
<button
key={dataFile.id}
type='button'
src/dashboardWebView/components/DataView/SortableItem.tsx
+6 -3
View File
@@ -1,4 +1,4 @@
import { PencilIcon, SelectorIcon, XIcon } from '@heroicons/react/outline';
import { PencilIcon, SelectorIcon, TrashIcon, XIcon } from '@heroicons/react/outline';
import * as React from 'react';
import { SortableHandle, SortableElement } from 'react-sortable-hoc';
import { Alert } from '../Modals/Alert';
@@ -43,7 +43,7 @@ export const SortableItem = SortableElement(({ value, selectedIndex, crntIndex,
className={`text-gray-500 dark:text-whisper-900 hover:text-gray-600 dark:hover:text-whisper-500`}
title={`Delete "${value}"`}
onClick={() => deleteItemConfirm()}>
<XIcon className='w-4 h-4' />
<TrashIcon className='w-4 h-4' />
<span className='sr-only'>Delete</span>
</button>
</div>
@@ -57,7 +57,10 @@ export const SortableItem = SortableElement(({ value, selectedIndex, crntIndex,
okBtnText={`Delete`}
cancelBtnText={`Cancel`}
dismiss={() => setShowAlert(false)}
trigger={() => onDeleteItem(crntIndex)} />
trigger={() => {
setShowAlert(false);
onDeleteItem(crntIndex);
}} />
)
}
</>
src/dashboardWebView/models/Settings.ts
+2
View File
@@ -1,3 +1,4 @@
import { DataType } from './../../models/DataType';
import { VersionInfo } from '../../models/VersionInfo';
import { ContentFolder } from '../../models/ContentFolder';
import { ContentType, CustomScript, DraftField, Framework, SortingSetting } from '../../models';
@@ -26,6 +27,7 @@ export interface Settings {
dashboardState: DashboardState;
scripts: CustomScript[];
dataFiles: DataFile[] | undefined;
dataTypes: DataType[] | undefined;
}
export interface DashboardState {
src/helpers/DashboardSettings.ts
+4 -2
View File
@@ -1,9 +1,10 @@
import { Folders } from "../commands/Folders";
import { Template } from "../commands/Template";
import { ExtensionState, SETTINGS_CONTENT_DRAFT_FIELD, SETTINGS_CONTENT_SORTING, SETTINGS_CONTENT_SORTING_DEFAULT, SETTINGS_CONTENT_STATIC_FOLDER, SETTINGS_DASHBOARD_MEDIA_SNIPPET, SETTINGS_DASHBOARD_OPENONSTART, SETTINGS_DATA_FILES, SETTINGS_FRAMEWORK_ID, SETTINGS_MEDIA_SORTING_DEFAULT, SETTING_CUSTOM_SCRIPTS, SETTING_TAXONOMY_CONTENT_TYPES } from "../constants";
import { ExtensionState, SETTINGS_CONTENT_DRAFT_FIELD, SETTINGS_CONTENT_SORTING, SETTINGS_CONTENT_SORTING_DEFAULT, SETTINGS_CONTENT_STATIC_FOLDER, SETTINGS_DASHBOARD_MEDIA_SNIPPET, SETTINGS_DASHBOARD_OPENONSTART, SETTINGS_DATA_FILES, SETTINGS_DATA_TYPES, SETTINGS_FRAMEWORK_ID, SETTINGS_MEDIA_SORTING_DEFAULT, SETTING_CUSTOM_SCRIPTS, SETTING_TAXONOMY_CONTENT_TYPES } from "../constants";
import { DashboardViewType, SortingOption, Settings as ISettings } from "../dashboardWebView/models";
import { CustomScript, DraftField, ScriptType, SortingSetting, TaxonomyType } from "../models";
import { DataFile } from "../models/DataFile";
import { DataType } from "../models/DataType";
import { Extension } from "./Extension";
import { FrameworkDetector } from "./FrameworkDetector";
import { Settings } from "./SettingsHelper";
@@ -46,7 +47,8 @@ export class DashboardSettings {
selectedFolder: await ext.getState<string | undefined>(ExtensionState.SelectedFolder, "workspace")
}
},
dataFiles: Settings.get<DataFile[]>(SETTINGS_DATA_FILES)
dataFiles: Settings.get<DataFile[]>(SETTINGS_DATA_FILES),
dataTypes: Settings.get<DataType[]>(SETTINGS_DATA_TYPES)
} as ISettings
}
}
src/models/DataFile.ts
+2 -1
View File
@@ -3,5 +3,6 @@ export interface DataFile {
title: string;
file: string;
labelField: string;
schema: any;
schema?: any;
type?: string;
}
src/models/DataType.ts
+4
View File
@@ -0,0 +1,4 @@
export interface DataType {
id: string;
schema: any;
}