mirror of
https://github.com/mayurankv/Obsidian-Code-Styler.git
synced 2026-07-22 08:10:29 +00:00
update
This commit is contained in:
mayurankv
parent
bb66a4c343
commit
7fac024932
7 changed files with 190 additions and 140 deletions
|
|
@ -1,11 +1,11 @@
|
|||
import { MarkdownPreviewRenderer, Plugin } from "obsidian";
|
||||
import { Plugin } from "obsidian";
|
||||
|
||||
import CodeStylerPlugin from "../../main";
|
||||
import { CodeStylerTheme, EXECUTE_CODE_SUPPORTED_LANGUAGES } from "../Settings";
|
||||
import { EXECUTE_CODE_SUPPORTED_LANGUAGES } from "../Settings";
|
||||
import { CodeBlockArgs, getArgs } from "../../../External/ExecuteCode/CodeBlockArgs";
|
||||
import { getReference } from "src/_temp/_Old/Referencing";
|
||||
import { Reference } from "./ReferenceParsing";
|
||||
import { basename } from "path";
|
||||
import { FenceCodeParameters } from "src/Internal/types/parsing";
|
||||
|
||||
|
||||
interface ExternalPlugin extends Plugin {
|
||||
|
|
@ -22,8 +22,107 @@ interface ExternalPlugin extends Plugin {
|
|||
analyzeHighLightLines?: (lines: string[], source: string | string[])=>Map<number,boolean>;
|
||||
}
|
||||
|
||||
async function pluginAdjustParameters(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
plugin: CodeStylerPlugin,
|
||||
codeblockLines: Array<string>,
|
||||
sourcePath?: string,
|
||||
): Promise<FenceCodeParameters> {
|
||||
const plugins: Record<string,ExternalPlugin> = plugin.app.plugins.plugins;
|
||||
if (fenceCodeParameters.language === "reference") {
|
||||
if (typeof sourcePath === "undefined")
|
||||
throw Error("Reference block has undefined sourcePath");
|
||||
fenceCodeParameters = await adjustReference(fenceCodeParameters, codeblockLines, sourcePath, plugin);
|
||||
} else if (fenceCodeParameters.language === "preview")
|
||||
fenceCodeParameters = await pluginAdjustPreviewCode(fenceCodeParameters,plugins,codeblockLines,sourcePath);
|
||||
else if (fenceCodeParameters.language === "include")
|
||||
fenceCodeParameters = pluginAdjustFileInclude(fenceCodeParameters,plugins,codeblockLines);
|
||||
else if (/run-\w*/.test(fenceCodeParameters.language))
|
||||
fenceCodeParameters = pluginAdjustExecuteCodeRun(fenceCodeParameters,plugin,plugins);
|
||||
fenceCodeParameters = pluginAdjustExecuteCode(fenceCodeParameters,plugins,codeblockLines);
|
||||
return fenceCodeParameters;
|
||||
}
|
||||
async function adjustReference(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
codeblockLines: Array<string>,
|
||||
sourcePath: string,
|
||||
plugin: CodeStylerPlugin,
|
||||
): Promise<FenceCodeParameters> {
|
||||
const reference = await getReference(codeblockLines, sourcePath, plugin);
|
||||
if (!fenceCodeParameters.lineNumbers.alwaysDisabled && !fenceCodeParameters.lineNumbers.alwaysEnabled) {
|
||||
fenceCodeParameters.lineNumbers.offset = reference.startLine - 1;
|
||||
fenceCodeParameters.lineNumbers.alwaysEnabled = Boolean(reference.startLine !== 1);
|
||||
}
|
||||
if (fenceCodeParameters.title === "")
|
||||
fenceCodeParameters.title = reference.external?.info?.title ?? basename(reference.path);
|
||||
if (fenceCodeParameters.reference === "")
|
||||
//@ts-expect-error Undocumented Obsidian API
|
||||
fenceCodeParameters.reference = reference.external?.info?.displayUrl ?? reference.external?.info?.url ?? plugin.app.vault.adapter.getFilePath(reference.path);
|
||||
fenceCodeParameters.language = reference.language;
|
||||
if (reference.external)
|
||||
fenceCodeParameters.externalReference = reference;
|
||||
return fenceCodeParameters;
|
||||
}
|
||||
async function pluginAdjustPreviewCode(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
plugins: Record<string, ExternalPlugin>,
|
||||
codeblockLines: Array<string>,
|
||||
sourcePath?: string,
|
||||
): Promise<FenceCodeParameters> {
|
||||
if (plugins?.["obsidian-code-preview"]?.code && plugins?.["obsidian-code-preview"]?.analyzeHighLightLines) {
|
||||
const codePreviewParams = await plugins["obsidian-code-preview"].code(codeblockLines.slice(1,-1).join("\n"),sourcePath);
|
||||
if (!fenceCodeParameters.lineNumbers.alwaysDisabled && !fenceCodeParameters.lineNumbers.alwaysEnabled) {
|
||||
if (typeof codePreviewParams.start === "number")
|
||||
fenceCodeParameters.lineNumbers.offset = codePreviewParams.start - 1;
|
||||
fenceCodeParameters.lineNumbers.alwaysEnabled = Boolean(codePreviewParams.linenumber);
|
||||
}
|
||||
fenceCodeParameters.highlights.default.lineNumbers = [...new Set(fenceCodeParameters.highlights.default.lineNumbers.concat(Array.from(plugins["obsidian-code-preview"].analyzeHighLightLines(codePreviewParams.lines,codePreviewParams.highlight),(pair: [number,boolean])=>(pair[0]))))];
|
||||
if (fenceCodeParameters.title === "")
|
||||
fenceCodeParameters.title = codePreviewParams.filePath.split("\\").pop()?.split("/").pop() ?? "";
|
||||
fenceCodeParameters.language = codePreviewParams.language;
|
||||
}
|
||||
return fenceCodeParameters;
|
||||
}
|
||||
function pluginAdjustFileInclude(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
plugins: Record<string, ExternalPlugin>,
|
||||
parameterLine: string,
|
||||
): FenceCodeParameters {
|
||||
if ("file-include" in plugins) {
|
||||
const fileIncludeLanguage = /include (\w+)/.exec(parameterLine)?.[1];
|
||||
if (typeof fileIncludeLanguage !== "undefined")
|
||||
fenceCodeParameters.language = fileIncludeLanguage;
|
||||
}
|
||||
return fenceCodeParameters;
|
||||
}
|
||||
function pluginAdjustExecuteCode(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
plugins: Record<string, ExternalPlugin>,
|
||||
parameterLine: string,
|
||||
): FenceCodeParameters {
|
||||
if ("execute-code" in plugins) {
|
||||
const codeblockArgs: CodeBlockArgs = getArgs(parameterLine);
|
||||
if ("label" in codeblockArgs)
|
||||
fenceCodeParameters.title = codeblockArgs.label;
|
||||
}
|
||||
return fenceCodeParameters;
|
||||
}
|
||||
|
||||
function pluginAdjustExecuteCodeRun(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
plugin: CodeStylerPlugin,
|
||||
plugins: Record<string, ExternalPlugin>,
|
||||
): FenceCodeParameters {
|
||||
if ("execute-code" in plugins) {
|
||||
if (EXECUTE_CODE_SUPPORTED_LANGUAGES.includes(fenceCodeParameters.language.slice(4)) && !isCodeblockIgnored(fenceCodeParameters.language,plugin.settings.processedCodeblocksWhitelist))
|
||||
fenceCodeParameters.language = fenceCodeParameters.language.slice(4);
|
||||
}
|
||||
return fenceCodeParameters;
|
||||
}
|
||||
|
||||
//!==========================================================================
|
||||
|
||||
export async function parseCodeblockSource(codeSection: Array<string>, plugin: CodeStylerPlugin, sourcePath?: string): Promise<{codeblocksParameters: Array<CodeblockParameters>, nested: boolean}> {
|
||||
// @ts-expect-error Undocumented Obsidian API
|
||||
const plugins: Record<string,ExternalPlugin> = plugin.app.plugins.plugins;
|
||||
const admonitions: boolean = ("obsidian-admonition" in plugins);
|
||||
const codeblocks: Array<Array<string>> = [];
|
||||
|
|
@ -49,106 +148,9 @@ export async function parseCodeblockSource(codeSection: Array<string>, plugin: C
|
|||
parseCodeblockSection(codeSection.slice(openDelimiterIndex+1+closeDelimiterIndex+1));
|
||||
}
|
||||
parseCodeblockSection(codeSection);
|
||||
return {codeblocksParameters: await (typeof sourcePath !== "undefined"?parseCodeblocks(codeblocks,plugin,plugins,sourcePath):parseCodeblocks(codeblocks,plugin,plugins)), nested: codeblocks[0]?!arraysEqual(codeSection,codeblocks[0]):true};
|
||||
}
|
||||
const nested = codeblocks[0] ? !arraysEqual(codeSection, codeblocks[0]) : true
|
||||
|
||||
async function parseCodeblocks(codeblocks: Array<Array<string>>, plugin: CodeStylerPlugin, plugins: Record<string,ExternalPlugin>, sourcePath?: string): Promise<Array<CodeblockParameters>> {
|
||||
const codeblocksParameters: Array<CodeblockParameters> = [];
|
||||
for (const codeblockLines of codeblocks) {
|
||||
const codeblockParameters = await (typeof sourcePath !== "undefined"?parseCodeblock(codeblockLines,plugin,plugins,sourcePath):parseCodeblock(codeblockLines,plugin,plugins));
|
||||
if (codeblockParameters !== null)
|
||||
codeblocksParameters.push(codeblockParameters);
|
||||
}
|
||||
return codeblocksParameters;
|
||||
}
|
||||
|
||||
async function parseCodeblock(codeblockLines: Array<string>, plugin: CodeStylerPlugin, plugins: Record<string,ExternalPlugin>, sourcePath?: string): Promise<CodeblockParameters | null> {
|
||||
const parameterLine = getParameterLine(codeblockLines);
|
||||
if (!parameterLine)
|
||||
return null;
|
||||
const codeblockParameters = parseCodeblockParameters(parameterLine,plugin.settings.currentTheme);
|
||||
|
||||
if (isCodeblockIgnored(codeblockParameters.language,plugin.settings.processedCodeblocksWhitelist) && codeblockParameters.language !== "reference")
|
||||
return null;
|
||||
|
||||
return await (typeof sourcePath !== "undefined"?pluginAdjustParameters(codeblockParameters,plugin,plugins,codeblockLines,sourcePath):pluginAdjustParameters(codeblockParameters,plugin,plugins,codeblockLines));
|
||||
}
|
||||
|
||||
//?======================================================================
|
||||
|
||||
async function pluginAdjustParameters(codeblockParameters: CodeblockParameters, plugin: CodeStylerPlugin, plugins: Record<string,ExternalPlugin>, codeblockLines: Array<string>, sourcePath?: string): Promise<CodeblockParameters> {
|
||||
if (codeblockParameters.language === "reference") {
|
||||
if (typeof sourcePath === "undefined")
|
||||
throw Error("Reference block has undefined sourcePath");
|
||||
codeblockParameters = await adjustReference(codeblockParameters, codeblockLines, sourcePath, plugin);
|
||||
} else if (codeblockParameters.language === "preview")
|
||||
codeblockParameters = await (typeof sourcePath !== "undefined"?pluginAdjustPreviewCode(codeblockParameters,plugins,codeblockLines,sourcePath):pluginAdjustPreviewCode(codeblockParameters,plugins,codeblockLines));
|
||||
else if (codeblockParameters.language === "include")
|
||||
codeblockParameters = pluginAdjustFileInclude(codeblockParameters,plugins,codeblockLines);
|
||||
else if (/run-\w*/.test(codeblockParameters.language))
|
||||
codeblockParameters = pluginAdjustExecuteCodeRun(codeblockParameters,plugin,plugins);
|
||||
codeblockParameters = pluginAdjustExecuteCode(codeblockParameters,plugins,codeblockLines);
|
||||
return codeblockParameters;
|
||||
}
|
||||
async function adjustReference(codeblockParameters: CodeblockParameters, codeblockLines: Array<string>, sourcePath: string, plugin: CodeStylerPlugin): Promise<CodeblockParameters> {
|
||||
const reference = await getReference(codeblockLines, sourcePath, plugin);
|
||||
if (!codeblockParameters.lineNumbers.alwaysDisabled && !codeblockParameters.lineNumbers.alwaysEnabled) {
|
||||
codeblockParameters.lineNumbers.offset = reference.startLine - 1;
|
||||
codeblockParameters.lineNumbers.alwaysEnabled = Boolean(reference.startLine !== 1);
|
||||
}
|
||||
if (codeblockParameters.title === "")
|
||||
codeblockParameters.title = reference.external?.info?.title ?? basename(reference.path);
|
||||
if (codeblockParameters.reference === "")
|
||||
//@ts-expect-error Undocumented Obsidian API
|
||||
codeblockParameters.reference = reference.external?.info?.displayUrl ?? reference.external?.info?.url ?? plugin.app.vault.adapter.getFilePath(reference.path);
|
||||
codeblockParameters.language = reference.language;
|
||||
if (reference.external)
|
||||
codeblockParameters.externalReference = reference;
|
||||
return codeblockParameters;
|
||||
}
|
||||
async function pluginAdjustPreviewCode(codeblockParameters: CodeblockParameters, plugins: Record<string,ExternalPlugin>, codeblockLines: Array<string>, sourcePath?: string): Promise<CodeblockParameters> {
|
||||
if (plugins?.["obsidian-code-preview"]?.code && plugins?.["obsidian-code-preview"]?.analyzeHighLightLines) {
|
||||
const codePreviewParams = await plugins["obsidian-code-preview"].code(codeblockLines.slice(1,-1).join("\n"),sourcePath);
|
||||
if (!codeblockParameters.lineNumbers.alwaysDisabled && !codeblockParameters.lineNumbers.alwaysEnabled) {
|
||||
if (typeof codePreviewParams.start === "number")
|
||||
codeblockParameters.lineNumbers.offset = codePreviewParams.start - 1;
|
||||
codeblockParameters.lineNumbers.alwaysEnabled = Boolean(codePreviewParams.linenumber);
|
||||
}
|
||||
codeblockParameters.highlights.default.lineNumbers = [...new Set(codeblockParameters.highlights.default.lineNumbers.concat(Array.from(plugins["obsidian-code-preview"].analyzeHighLightLines(codePreviewParams.lines,codePreviewParams.highlight),(pair: [number,boolean])=>(pair[0]))))];
|
||||
if (codeblockParameters.title === "")
|
||||
codeblockParameters.title = codePreviewParams.filePath.split("\\").pop()?.split("/").pop() ?? "";
|
||||
codeblockParameters.language = codePreviewParams.language;
|
||||
}
|
||||
return codeblockParameters;
|
||||
}
|
||||
function pluginAdjustFileInclude(codeblockParameters: CodeblockParameters, plugins: Record<string,ExternalPlugin>, codeblockLines: Array<string>): CodeblockParameters {
|
||||
if ("file-include" in plugins) {
|
||||
const fileIncludeLanguage = /include (\w+)/.exec(codeblockLines[0])?.[1];
|
||||
if (typeof fileIncludeLanguage !== "undefined")
|
||||
codeblockParameters.language = fileIncludeLanguage;
|
||||
}
|
||||
return codeblockParameters;
|
||||
}
|
||||
function pluginAdjustExecuteCode(codeblockParameters: CodeblockParameters, plugins: Record<string,ExternalPlugin>, codeblockLines: Array<string>): CodeblockParameters {
|
||||
if ("execute-code" in plugins) {
|
||||
const codeblockArgs: CodeBlockArgs = getArgs(codeblockLines[0]);
|
||||
codeblockParameters.title = codeblockParameters.title ?? codeblockArgs?.label ?? "";
|
||||
}
|
||||
return codeblockParameters;
|
||||
}
|
||||
function pluginAdjustExecuteCodeRun(codeblockParameters: CodeblockParameters, plugin: CodeStylerPlugin, plugins: Record<string,ExternalPlugin>): CodeblockParameters {
|
||||
if ("execute-code" in plugins) {
|
||||
if (EXECUTE_CODE_SUPPORTED_LANGUAGES.includes(codeblockParameters.language.slice(4)) && !isCodeblockIgnored(codeblockParameters.language,plugin.settings.processedCodeblocksWhitelist))
|
||||
codeblockParameters.language = codeblockParameters.language.slice(4);
|
||||
}
|
||||
return codeblockParameters;
|
||||
}
|
||||
|
||||
//?======================================================================
|
||||
|
||||
export function isCodeblockIgnored(language: string, whitelistedCodeblocksString: string): boolean {
|
||||
//@ts-expect-error Undocumented Obsidian API
|
||||
return (language in MarkdownPreviewRenderer.codeBlockPostProcessors) && !isLanguageIgnored(language, whitelistedCodeblocksString);
|
||||
return codeblocks
|
||||
}
|
||||
|
||||
function getParameterLine(codeblockLines: Array<string>): string | undefined {
|
||||
|
|
@ -168,7 +170,3 @@ export function testOpeningLine(codeblockLine: string): string {
|
|||
return lineMatch[2];
|
||||
return "";
|
||||
}
|
||||
|
||||
function arraysEqual(array1: Array<unknown>,array2: Array<unknown>): boolean {
|
||||
return array1.length === array2.length && array1.every((el) => array2.includes(el));
|
||||
}
|
||||
|
|
|
|||
55
main.js
55
main.js
File diff suppressed because one or more lines are too long
|
|
@ -1,8 +1,9 @@
|
|||
import CodeStylerPlugin from "src/main";
|
||||
import { FenceCodeParameters, Highlights } from "../types/parsing";
|
||||
import { separateParameters } from "./utils";
|
||||
import { FENCE_PARAMETERS_KEY_VALUE, FENCE_PARAMETERS_SHORTHAND } from "../constants/parsing";
|
||||
import { isLanguageMatched, separateParameters } from "./utils";
|
||||
import { FENCE_PARAMETERS_KEY_VALUE, FENCE_PARAMETERS_SHORTHAND, PLUGIN_CODEBLOCK_WHITELIST } from "../constants/parsing";
|
||||
import { convertBoolean, removeBoundaryQuotes, removeCurlyBraces } from "../utils/text";
|
||||
import { MarkdownPreviewRenderer, Plugin } from "obsidian";
|
||||
|
||||
export function parseFenceCodeParameters(
|
||||
fenceCodeParametersLine: string,
|
||||
|
|
@ -62,13 +63,31 @@ export function parseFenceCodeParameters(
|
|||
{ highlights: { default: {lineNumbers: [], plainText: [], regularExpressions: []}, alternative: {} } },
|
||||
)
|
||||
|
||||
const fenceCodeParameters = new FenceCodeParameters(fenceCodeParametersParsed)
|
||||
const fenceCodeParameters = pluginAdjustFenceCodeParameters(
|
||||
new FenceCodeParameters(fenceCodeParametersParsed),
|
||||
)
|
||||
|
||||
|
||||
//todo: Adjust parameters
|
||||
|
||||
return fenceCodeParameters
|
||||
}
|
||||
|
||||
function pluginAdjustFenceCodeParameters(
|
||||
fenceCodeParameters: FenceCodeParameters,
|
||||
plugins: Record<string, Plugin>,
|
||||
): FenceCodeParameters {
|
||||
const adjustedParameters: Partial<FenceCodeParameters> = {}
|
||||
if ("execute-code" in plugins) {
|
||||
|
||||
}
|
||||
if ("file-include" in plugins) {
|
||||
|
||||
}
|
||||
|
||||
return {...fenceCodeParameters}
|
||||
}
|
||||
|
||||
function inferFenceValue(
|
||||
parameterKey: string,
|
||||
parameterValue: string,
|
||||
|
|
@ -325,19 +344,15 @@ export function toDecorateFenceCode(
|
|||
if (isLanguageMatched(fenceCodeParameters.language, plugin.settings.excludedLanguages))
|
||||
return false
|
||||
|
||||
if (
|
||||
// @ts-expect-error Undocumented Obsidian API
|
||||
(fenceCodeParameters.language in MarkdownPreviewRenderer.codeBlockPostProcessors) &&
|
||||
!isLanguageMatched(fenceCodeParameters.language, plugin.settings.processedCodeblocksWhitelist + "," + PLUGIN_CODEBLOCK_WHITELIST)
|
||||
)
|
||||
return false
|
||||
|
||||
if (fenceCodeParameters.ignore)
|
||||
return false
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
export function isLanguageMatched(
|
||||
language: string,
|
||||
languagesString: string,
|
||||
): boolean {
|
||||
return languagesString.split(",").map(
|
||||
regexLanguage => new RegExp(`^${regexLanguage.trim().replace(/\*/g, ".+")}$`, "i"),
|
||||
).some(
|
||||
regexLanguage => regexLanguage.test(language),
|
||||
);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,3 +3,16 @@ export function separateParameters(
|
|||
): Array<string> {
|
||||
return parametersLine.match(new RegExp(`(?:[^\\s"']+|"[^"]*"|'[^']*')+`, "gi")) ?? [];
|
||||
}
|
||||
|
||||
export function isLanguageMatched(
|
||||
language: string,
|
||||
languagesString: string,
|
||||
): boolean {
|
||||
return languagesString.split(",").filter(
|
||||
regexLanguage => regexLanguage !== ""
|
||||
).map(
|
||||
regexLanguage => new RegExp(`^${regexLanguage.trim().replace(/\*/g, ".+")}$`, "i"),
|
||||
).some(
|
||||
regexLanguage => regexLanguage.test(language),
|
||||
);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ export const INLINE_PARAMETERS_KEY_VALUE = ["title", "icon", "language", "ignore
|
|||
export const INLINE_PARAMETERS_SHORTHAND = ["icon", "ignore"]
|
||||
export const INLINE_PARAMETERS = [...new Set([...INLINE_PARAMETERS_KEY_VALUE, ...INLINE_PARAMETERS_SHORTHAND])];
|
||||
|
||||
export const PLUGIN_CODEBLOCK_WHITELIST = ["reference"]
|
||||
|
||||
const PRISM_LANGUAGES: {[key: string]: string} = { // Prism Languages: https://prismjs.com/plugins/show-language/
|
||||
// "none": "Plain text", // NOTE: Obsidian uses this for codeblocks without language names
|
||||
"plain": "Plain text",
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ export const INBUILT_THEMES: Record<string, CodeStylerTheme> = Object.fromEntrie
|
|||
|
||||
export const EXCLUDED_LANGUAGES = "ad-*, reference";
|
||||
export const WHITELIST_CODEBLOCKS = "run-*, include";
|
||||
export const SPECIAL_LANGUAGES = ["^reference$","^foofoo","^preview$","^include$","^output$","^run-.+$"];
|
||||
export const SPECIAL_LANGUAGES = ["^reference$","^preview$","^include$","^output$","^run-.+$"];
|
||||
|
||||
export const DECORATE_ON_PRINT = true
|
||||
export const EXTERNAL_REFERENCE_UPDATE_ON_LOAD = false
|
||||
|
|
|
|||
3
src/Internal/utils/arrays.ts
Normal file
3
src/Internal/utils/arrays.ts
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
export function arraysEqual(array1: Array<unknown>,array2: Array<unknown>): boolean {
|
||||
return array1.length === array2.length && array1.every((el) => array2.includes(el));
|
||||
}
|
||||
Loading…
Reference in a new issue