* [Major] Introduce a new `Ref` and `Path` type
This introduces a new `Ref` and `Path` type, which try to be as lightweight and rigorous as possible. More description in the PR
* [Minor] Updated Syntax
* [Minor] Updated Type
* [Minor] Renamed file
* [Minor] Updated type
* [Minor] Updated Syntax
* [Major] Rename css classes for wiki links
Previously all the parts of a wiki link were tagged with `sb-wiki-link-page`. This didn't make a whole lot of sense. Also the tag `sb-wiki-link` was could never render, because of the way `HighlightStyle` works. Now every part of a wiki link will be tagged with `sb-wiki-link` (i.e. the link, the alias, the dimensions). Invalid and missing links will be styled separately in a later commit.
* [Minor] Adjust to new API
* [Minor] Small changes
* [Minor] Function and file renames
* [Major] Syscall adjusments
Change behavior of `getCurrentPath` to actually return what's now considered a `Path`. `getCurrentPage(Meta)` now also correctly returns for documents. We could consider a rename to get rid of the `page` association
* [Major] Rework `Client`
Mostly minor adjustments for the new API. Some major changes in `navigateWithinPage` and some unecessary checks removed now
* [Major] Errors on navigate
This now throws an error when the user tries to navigate to a link that is invalid
* [Major] Minor adjustments and remove some old bulk
This does the typicall adjustments to the new API. A thing to consider is that invalid links aren't indexed. Also removed old code about template and query stuff. And reused a regex instead of copy pasting it.
* [Minor] Cleanup editor ui
* [Minor] Adjust to new API
* [Minor] Adjust to new API and reduce ugly regex
* [Minor] New API
* [Minor] Rework link cm plugin
* [Major] Rework wiki links
A lot of code cleanup, reworked for new APIs and also introduces "invalid links"
* [Minor] Part of the editor ui rework
* [Major] Adjust to new API
This also removes the `looksLikePathWithExtension` check. I don't think it was necessary.
* [Minor] PArt of editor ui rewrite
* [Minor] Adjust to new API
* [Major] Adjust renderer to new API
Invalid links now link to `#`
* [Major] Rewrite navigator
This still needs major rework, currently in a "got it working" state
* [Minor] Adjust file name
* [Minor] Mistake during rebase
* [Minor] Navigate to end of header
* [Minor] Remove `tweakEditorDOM` and use proper CM extensions
* [Major] Heavily clean up the navigation code
* [Minor] Make `PageNavigator` closable again
* [Minor] Small fixes to reduce errors bubbling up
* [Minor] Show error message if navigate fails
* [Major] Remove legacy `navigate({ kind = ` syntax
This removes the old navigation syntax. It's still supported but the user will be warned then using it. I also added some validation to editor.navigate for user provided refs.
* [Minor] Make notifications errors
* [Minor] Don't fail if header isn't found
* [Minor] Typo
* [Major] Remove cleanPageRef
* [Minor] Small bug
* [Minor] Align behavior between render and editor
* [Major] Remove `PageRef`. Pretty sure it's obsolete
* [Major] Remove pos from header as it's an invalid ref
* [Minor] Align with original behavior
* [Minor] Get tests working again
* [Minor] check that indexPage is valid
* [Major] Rewrite `resolve.ts` file
* [Minor] More tests, more fixes
* [Minor] Don't just append .md this is weird
* [Minor] More edge cases
* [Minor] Version bumping hono somehow fixes the `/` case
* [Minor] Smaller TODOs
* [Major] We can be a littler looser on the restrictions
* [Major] Change header indexing, to index with pos
* [Minor] More fixes for headers
* [Minor] Rename for clarity
* [Minor] Change more regexes to named groups
* [Major] Inline content rewrite
* [Minor] Fix TODO
* [Minor] Bump index version
* [Major] New Space Primitive to check paths
* [Minor] Fix #1214
* [Minor] Fix #1169
* [Minor] Remove TODO
This check is probably not needed anymore. Unsure. May look into it later
* [Minor] small bug
* [Minor] Not a good rebase without me needing to fix it afterwards
* [Minor] Improve fallback for file upload
* [Minor] Some fixes on the for resolving
* [Minor] Removed doubled test case
* [Minor] Resolve #860
* [Minor] Turn flash notification into an error
* [Minor] Change handling of `.` paths
* [Minor] Show empty URL for index page
* [Minor] Push correct ref to history
* [Major] Capture mini editor events in capture phase
This fixes the issue were when pressing arrowup or arrowdown changed the cursor position inside the editor
* [Major] Add prefix to `FilterList`
This now fixes issues were if you had a prefixed page you con't properly search for it, because the search considered the prefix as part of the name
* [Minor] A little rigor for empty headers
* [Major] Fix #1404
* [Minor] `parseInt` returns `NaN` handle that
* [Minor] Use `fileName`
* [Minor] Fix comment
* [Minor] Fixes
* [Major] disallow `foo.png.md` and `/../`, etc. cases
* [Major] Change name of conflicted pages
* [Minor] Remove unecessary check
* [Minor] Remove some split code
* [Minor] Allow deletion of invalid files
* [Minor] Bug in the regex
* [Minor] Give some possibility of fixing incorrect names
* [Minor] Tiny bug with header completion
* [Major] Docs
* [Minor] Ignore errors for navigation inside of a page
This could be a problem when SB e.g. cached a scrollTop for a page, which, because e.g. the file is now deleted, doesn't exist anymore and thus CM throws an error, when trying to navigate
* Update conflicted copy regex in Maintenance.md
---------
Co-authored-by: Zef Hemel <zef@zef.me>
153 lines
4.8 KiB
TypeScript
153 lines
4.8 KiB
TypeScript
import { syntaxTree } from "@codemirror/language";
|
|
import { Decoration } from "@codemirror/view";
|
|
import type { Client } from "../client.ts";
|
|
import { decoratorStateField, isCursorInRange, LinkWidget } from "./util.ts";
|
|
import {
|
|
fileName,
|
|
isBuiltinPath,
|
|
} from "@silverbulletmd/silverbullet/lib/resolve";
|
|
import {
|
|
encodePageURI,
|
|
encodeRef,
|
|
getNameFromPath,
|
|
parseToRef,
|
|
} from "@silverbulletmd/silverbullet/lib/ref";
|
|
import type { ClickEvent } from "@silverbulletmd/silverbullet/type/client";
|
|
import { wikiLinkRegex } from "../markdown_parser/constants.ts";
|
|
|
|
/**
|
|
* Plugin to hide path prefix when the cursor is not inside.
|
|
*/
|
|
export function cleanWikiLinkPlugin(client: Client) {
|
|
return decoratorStateField((state) => {
|
|
const widgets: any[] = [];
|
|
// let parentRange: [number, number];
|
|
syntaxTree(state).iterate({
|
|
enter: ({ type, from, to }) => {
|
|
if (type.name !== "WikiLink") {
|
|
return;
|
|
}
|
|
|
|
const text = state.sliceDoc(from, to);
|
|
|
|
wikiLinkRegex.lastIndex = 0;
|
|
const match = wikiLinkRegex.exec(text);
|
|
if (!match || !match.groups) {
|
|
return;
|
|
}
|
|
|
|
const { leadingTrivia, stringRef, alias, trailingTrivia } =
|
|
match.groups;
|
|
|
|
const ref = parseToRef(stringRef);
|
|
|
|
let linkStatus: "file-missing" | "default" | "invalid" = "default";
|
|
|
|
if (!ref) {
|
|
linkStatus = "invalid";
|
|
} else if (ref.path === "" || isBuiltinPath(ref.path)) {
|
|
linkStatus = "default";
|
|
} else if (
|
|
Array.from(client.clientSystem.allKnownFiles)
|
|
.some((file) => file === ref.path)
|
|
) {
|
|
linkStatus = "default";
|
|
} else if (client.fullSyncCompleted) {
|
|
linkStatus = "file-missing";
|
|
}
|
|
|
|
let css = {
|
|
"file-missing": "sb-wiki-link-missing",
|
|
"invalid": "sb-wiki-link-invalid",
|
|
"default": "",
|
|
}[linkStatus];
|
|
|
|
if (isCursorInRange(state, [from, to])) {
|
|
// Only attach a CSS class, then get out
|
|
if (linkStatus !== "default") {
|
|
widgets.push(
|
|
Decoration.mark({
|
|
class: css,
|
|
}).range(from + leadingTrivia.length, to - trailingTrivia.length),
|
|
);
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
const cleanedPath = ref ? getNameFromPath(ref.path) : stringRef;
|
|
const helpText = {
|
|
"default": `Navigate to ${cleanedPath}`,
|
|
"file-missing": `Create ${cleanedPath}`,
|
|
"invalid": `Cannot create invalid file ${cleanedPath}`,
|
|
}[linkStatus];
|
|
|
|
let linkText = alias || stringRef;
|
|
|
|
// The `&& ref` is only there to make typescript happy
|
|
if (linkStatus === "default" && ref) {
|
|
const meta = client.ui.viewState.allPages.find((p) =>
|
|
parseToRef(p.ref)?.path === ref.path
|
|
);
|
|
|
|
const renderedRef = structuredClone(ref);
|
|
|
|
// We don't want to render the meta
|
|
renderedRef.meta = false;
|
|
// We also don't want to rendered the prefix of the path
|
|
renderedRef.path = fileName(renderedRef.path);
|
|
|
|
const prefix = (ref.details?.type === "position" ||
|
|
ref.details?.type === "linecolumn")
|
|
? ""
|
|
: (meta?.pageDecoration?.prefix ?? "");
|
|
|
|
linkText = alias || (prefix + encodeRef(renderedRef));
|
|
|
|
if (meta?.pageDecoration?.cssClasses) {
|
|
css += " sb-decorated-object " +
|
|
meta.pageDecoration.cssClasses
|
|
.join(" ")
|
|
.replaceAll(/[^a-zA-Z0-9-_ ]/g, "");
|
|
}
|
|
}
|
|
|
|
// And replace it with a widget
|
|
widgets.push(
|
|
Decoration.replace({
|
|
widget: new LinkWidget({
|
|
text: linkText,
|
|
title: helpText,
|
|
href: ref ? encodePageURI(encodeRef(ref)) : undefined,
|
|
cssClass: "sb-wiki-link " + css,
|
|
from,
|
|
callback: (e) => {
|
|
if (e.altKey) {
|
|
// Move cursor into the link
|
|
client.editorView.dispatch({
|
|
selection: { anchor: from + leadingTrivia.length },
|
|
});
|
|
client.focus();
|
|
return;
|
|
}
|
|
// Dispatch click event to navigate there without moving the cursor
|
|
const clickEvent: ClickEvent = {
|
|
page: client.currentName(),
|
|
ctrlKey: e.ctrlKey,
|
|
metaKey: e.metaKey,
|
|
altKey: e.altKey,
|
|
pos: from,
|
|
};
|
|
client.dispatchClickEvent(clickEvent).catch(
|
|
console.error,
|
|
);
|
|
},
|
|
}),
|
|
}).range(from, to),
|
|
);
|
|
},
|
|
});
|
|
return Decoration.set(widgets, true);
|
|
});
|
|
}
|