Skip to content

Commit

Permalink
undo formatting fiasco
Browse files Browse the repository at this point in the history
  • Loading branch information
@jvsteiner
jvsteiner committed May 15, 2024
1 parent d408587 commit 27b6f92
Showing 1 changed file with 160 additions and 163 deletions.
323 changes: 160 additions & 163 deletions main.ts
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

/*
* main.ts
*
Expand All @@ -6,182 +7,178 @@
*
*/

import * as fs from "fs";
import * as path from "path";
import * as fs from 'fs';
import * as path from 'path';

import { Notice, Plugin, FileSystemAdapter, MarkdownView } from "obsidian";
import { lookpath } from "lookpath";
import { pandoc, inputExtensions, outputFormats, OutputFormat, needsLaTeX, needsPandoc } from "./pandoc";
import * as YAML from "yaml";
import * as temp from "temp";
import { Notice, Plugin, FileSystemAdapter, MarkdownView } from 'obsidian';
import { lookpath } from 'lookpath';
import { pandoc, inputExtensions, outputFormats, OutputFormat, needsLaTeX, needsPandoc } from './pandoc';
import * as YAML from 'yaml';
import * as temp from 'temp';

import render from "./renderer";
import PandocPluginSettingTab from "./settings";
import { PandocPluginSettings, DEFAULT_SETTINGS, replaceFileExtension } from "./global";
import render from './renderer';
import PandocPluginSettingTab from './settings';
import { PandocPluginSettings, DEFAULT_SETTINGS, replaceFileExtension } from './global';
export default class PandocPlugin extends Plugin {
settings: PandocPluginSettings;
features: { [key: string]: string | undefined } = {};

async onload() {
console.log("Loading Pandoc plugin");
await this.loadSettings();

// Check if Pandoc, LaTeX, etc. are installed and in the PATH
this.createBinaryMap();

// Register all of the command palette entries
this.registerCommands();

this.addSettingTab(new PandocPluginSettingTab(this.app, this));
}

registerCommands() {
for (let [prettyName, pandocFormat, extension, shortName] of outputFormats) {
const name = "Export as " + prettyName;
this.addCommand({
id: "pandoc-export-" + pandocFormat,
name,
checkCallback: (checking: boolean) => {
if (!this.app.workspace.activeLeaf) return false;
if (!this.currentFileCanBeExported(pandocFormat as OutputFormat)) return false;
if (!checking) {
this.startPandocExport(this.getCurrentFile(), pandocFormat as OutputFormat, extension, shortName);
}
return true;
},
});
settings: PandocPluginSettings;
features: { [key: string]: string | undefined } = {};

async onload() {
console.log('Loading Pandoc plugin');
await this.loadSettings();

// Check if Pandoc, LaTeX, etc. are installed and in the PATH
this.createBinaryMap();

// Register all of the command palette entries
this.registerCommands();

this.addSettingTab(new PandocPluginSettingTab(this.app, this));
}
}

vaultBasePath(): string {
return (this.app.vault.adapter as FileSystemAdapter).getBasePath();
}

getCurrentFile(): string | null {
const fileData = this.app.workspace.getActiveFile();
if (!fileData) return null;
const adapter = this.app.vault.adapter;
if (adapter instanceof FileSystemAdapter) return adapter.getFullPath(fileData.path);
return null;
}

currentFileCanBeExported(format: OutputFormat): boolean {
// Is it an available output type?
if (needsPandoc(format) && !this.features["pandoc"]) return false;
if (needsLaTeX(format) && !this.features["pdflatex"]) return false;
// Is it a supported input type?
const file = this.getCurrentFile();
if (!file) return false;
for (const ext of inputExtensions) {
if (file.endsWith(ext)) return true;

registerCommands() {
for (let [prettyName, pandocFormat, extension, shortName] of outputFormats) {

const name = 'Export as ' + prettyName;
this.addCommand({
id: 'pandoc-export-' + pandocFormat, name,
checkCallback: (checking: boolean) => {
if (!this.app.workspace.activeLeaf) return false;
if (!this.currentFileCanBeExported(pandocFormat as OutputFormat)) return false;
if (!checking) {
this.startPandocExport(this.getCurrentFile(), pandocFormat as OutputFormat, extension, shortName);
}
return true;
}
});
}
}
return false;
}

async createBinaryMap() {
this.features["pandoc"] = this.settings.pandoc || (await lookpath("pandoc"));
this.features["pdflatex"] = this.settings.pdflatex || (await lookpath("pdflatex"));
}

async startPandocExport(inputFile: string, format: OutputFormat, extension: string, shortName: string) {
new Notice(`Exporting ${inputFile} to ${shortName}`);
const noteFile = this.app.workspace.getActiveFile();
let fm = this.app.metadataCache.getFileCache(noteFile)?.frontmatter;
let extraArguments = [];
if (fm && fm["additional-pandoc-arguments"]) {
extraArguments.push(...fm["additional-pandoc-arguments"]);

vaultBasePath(): string {
return (this.app.vault.adapter as FileSystemAdapter).getBasePath();
}
extraArguments.push(...this.settings.extraArguments.split("\n"));

// Instead of using Pandoc to process the raw Markdown, we use Obsidian's
// internal markdown renderer, and process the HTML it generates instead.
// This allows us to more easily deal with Obsidian specific Markdown syntax.
// However, we provide an option to use MD instead to use citations
getCurrentFile(): string | null {
const fileData = this.app.workspace.getActiveFile();
if (!fileData) return null;
const adapter = this.app.vault.adapter;
if (adapter instanceof FileSystemAdapter)
return adapter.getFullPath(fileData.path);
return null;
}

let outputFile: string = replaceFileExtension(inputFile, extension);
if (this.settings.outputFolder) {
outputFile = path.join(this.settings.outputFolder, path.basename(outputFile));
currentFileCanBeExported(format: OutputFormat): boolean {
// Is it an available output type?
if (needsPandoc(format) && !this.features['pandoc']) return false;
if (needsLaTeX(format) && !this.features['pdflatex']) return false;
// Is it a supported input type?
const file = this.getCurrentFile();
if (!file) return false;
for (const ext of inputExtensions) {
if (file.endsWith(ext)) return true;
}
return false;
}

async createBinaryMap() {
this.features['pandoc'] = this.settings.pandoc || await lookpath('pandoc');
this.features['pdflatex'] = this.settings.pdflatex || await lookpath('pdflatex');
}
const view = this.app.workspace.getActiveViewOfType(MarkdownView);

try {
let error, command;

switch (this.settings.exportFrom) {
case "html": {
const { html, metadata } = await render(this, view, inputFile, format);

if (format === "html") {
// Write to HTML file
await fs.promises.writeFile(outputFile, html);
new Notice("Successfully exported via Pandoc to " + outputFile);
return;
} else {
// Spawn Pandoc
const metadataFile = temp.path();
const metadataString = YAML.stringify(metadata);
await fs.promises.writeFile(metadataFile, metadataString);
const result = await pandoc(
{
file: "STDIN",
contents: html,
format: "html",
metadataFile,
pandoc: this.settings.pandoc,
pdflatex: this.settings.pdflatex,
directory: path.dirname(inputFile),
},
{ file: outputFile, format },
extraArguments
);
error = result.error;
command = result.command;
}
break;

async startPandocExport(inputFile: string, format: OutputFormat, extension: string, shortName: string) {
new Notice(`Exporting ${inputFile} to ${shortName}`);
const noteFile = this.app.workspace.getActiveFile();
let fm = this.app.metadataCache.getFileCache(noteFile)?.frontmatter;
let extraArguments = [];
if (fm && fm["additional-pandoc-arguments"]) {
extraArguments.push(...fm["additional-pandoc-arguments"]);
}
case "md": {
const result = await pandoc(
{
file: inputFile,
format: "markdown",
pandoc: this.settings.pandoc,
pdflatex: this.settings.pdflatex,
directory: path.dirname(inputFile),
},
{ file: outputFile, format },
extraArguments
);
error = result.error;
command = result.command;
break;
extraArguments.push(...this.settings.extraArguments.split("\n"));

// Instead of using Pandoc to process the raw Markdown, we use Obsidian's
// internal markdown renderer, and process the HTML it generates instead.
// This allows us to more easily deal with Obsidian specific Markdown syntax.
// However, we provide an option to use MD instead to use citations

let outputFile: string = replaceFileExtension(inputFile, extension);
if (this.settings.outputFolder) {
outputFile = path.join(this.settings.outputFolder, path.basename(outputFile));
}
const view = this.app.workspace.getActiveViewOfType(MarkdownView);

try {
let error, command;

switch (this.settings.exportFrom) {
case 'html': {
const { html, metadata } = await render(this, view, inputFile, format);

if (format === 'html') {
// Write to HTML file
await fs.promises.writeFile(outputFile, html);
new Notice('Successfully exported via Pandoc to ' + outputFile);
return;
} else {
// Spawn Pandoc
const metadataFile = temp.path();
const metadataString = YAML.stringify(metadata);
await fs.promises.writeFile(metadataFile, metadataString);
const result = await pandoc(
{
file: 'STDIN', contents: html, format: 'html', metadataFile,
pandoc: this.settings.pandoc, pdflatex: this.settings.pdflatex,
directory: path.dirname(inputFile),
},
{ file: outputFile, format },
extraArguments
);
error = result.error;
command = result.command;
}
break;
}
case 'md': {
const result = await pandoc(
{
file: inputFile, format: 'markdown',
pandoc: this.settings.pandoc, pdflatex: this.settings.pdflatex,
directory: path.dirname(inputFile),
},
{ file: outputFile, format },
extraArguments
);
error = result.error;
command = result.command;
break;
}
}

if (error.length) {
new Notice('Exported via Pandoc to ' + outputFile + ' with warnings');
new Notice('Pandoc warnings:' + error, 10000);
} else {
new Notice('Successfully exported via Pandoc to ' + outputFile);
}
if (this.settings.showCLICommands) {
new Notice('Pandoc command: ' + command, 10000);
console.log(command);
}

} catch (e) {
new Notice('Pandoc export failed: ' + e.toString(), 15000);
console.error(e);
}
}

if (error.length) {
new Notice("Exported via Pandoc to " + outputFile + " with warnings");
new Notice("Pandoc warnings:" + error, 10000);
} else {
new Notice("Successfully exported via Pandoc to " + outputFile);
}
if (this.settings.showCLICommands) {
new Notice("Pandoc command: " + command, 10000);
console.log(command);
}
} catch (e) {
new Notice("Pandoc export failed: " + e.toString(), 15000);
console.error(e);
}
}

onunload() {
console.log("Unloading Pandoc plugin");
}
onunload() {
console.log('Unloading Pandoc plugin');
}

async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}

async saveSettings() {
await this.saveData(this.settings);
}
async saveSettings() {
await this.saveData(this.settings);
}
}

0 comments on commit 27b6f92

Please sign in to comment.