5e0a761b87
(for upgrading users, please see the notes at the bottom) Bazel brought a lot of nice things to the table, such as rebuilds based on content changes instead of modification times, caching of build products, detection of incorrect build rules via a sandbox, and so on. Rewriting the build in Bazel was also an opportunity to improve on the Makefile-based build we had prior, which was pretty poor: most dependencies were external or not pinned, and the build graph was poorly defined and mostly serialized. It was not uncommon for fresh checkouts to fail due to floating dependencies, or for things to break when trying to switch to an older commit. For day-to-day development, I think Bazel served us reasonably well - we could generally switch between branches while being confident that builds would be correct and reasonably fast, and not require full rebuilds (except on Windows, where the lack of a sandbox and the TS rules would cause build breakages when TS files were renamed/removed). Bazel achieves that reliability by defining rules for each programming language that define how source files should be turned into outputs. For the rules to work with Bazel's sandboxing approach, they often have to reimplement or partially bypass the standard tools that each programming language provides. The Rust rules call Rust's compiler directly for example, instead of using Cargo, and the Python rules extract each PyPi package into a separate folder that gets added to sys.path. These separate language rules allow proper declaration of inputs and outputs, and offer some advantages such as caching of build products and fine-grained dependency installation. But they also bring some downsides: - The rules don't always support use-cases/platforms that the standard language tools do, meaning they need to be patched to be used. I've had to contribute a number of patches to the Rust, Python and JS rules to unblock various issues. - The dependencies we use with each language sometimes make assumptions that do not hold in Bazel, meaning they either need to be pinned or patched, or the language rules need to be adjusted to accommodate them. I was hopeful that after the initial setup work, things would be relatively smooth-sailing. Unfortunately, that has not proved to be the case. Things frequently broke when dependencies or the language rules were updated, and I began to get frustrated at the amount of Anki development time I was instead spending on build system upkeep. It's now about 2 years since switching to Bazel, and I think it's time to cut losses, and switch to something else that's a better fit. The new build system is based on a small build tool called Ninja, and some custom Rust code in build/. This means that to build Anki, Bazel is no longer required, but Ninja and Rust need to be installed on your system. Python and Node toolchains are automatically downloaded like in Bazel. This new build system should result in faster builds in some cases: - Because we're using cargo to build now, Rust builds are able to take advantage of pipelining and incremental debug builds, which we didn't have with Bazel. It's also easier to override the default linker on Linux/macOS, which can further improve speeds. - External Rust crates are now built with opt=1, which improves performance of debug builds. - Esbuild is now used to transpile TypeScript, instead of invoking the TypeScript compiler. This results in faster builds, by deferring typechecking to test/check time, and by allowing more work to happen in parallel. As an example of the differences, when testing with the mold linker on Linux, adding a new message to tags.proto (which triggers a recompile of the bulk of the Rust and TypeScript code) results in a compile that goes from about 22s on Bazel to about 7s in the new system. With the standard linker, it's about 9s. Some other changes of note: - Our Rust workspace now uses cargo-hakari to ensure all packages agree on available features, preventing unnecessary rebuilds. - pylib/anki is now a PEP420 implicit namespace, avoiding the need to merge source files and generated files into a single folder for running. By telling VSCode about the extra search path, code completion now works with generated files without needing to symlink them into the source folder. - qt/aqt can't use PEP420 as it's difficult to get rid of aqt/__init__.py. Instead, the generated files are now placed in a separate _aqt package that's added to the path. - ts/lib is now exposed as @tslib, so the source code and generated code can be provided under the same namespace without a merging step. - MyPy and PyLint are now invoked once for the entire codebase. - dprint will be used to format TypeScript/json files in the future instead of the slower prettier (currently turned off to avoid causing conflicts). It can automatically defer to prettier when formatting Svelte files. - svelte-check is now used for typechecking our Svelte code, which revealed a few typing issues that went undetected with the old system. - The Jest unit tests now work on Windows as well. If you're upgrading from Bazel, updated usage instructions are in docs/development.md and docs/build.md. A summary of the changes: - please remove node_modules and .bazel - install rustup (https://rustup.rs/) - install rsync if not already installed (on windows, use pacman - see docs/windows.md) - install Ninja (unzip from https://github.com/ninja-build/ninja/releases/tag/v1.11.1 and place on your path, or from your distro/homebrew if it's 1.10+) - update .vscode/settings.json from .vscode.dist
392 lines
12 KiB
TypeScript
392 lines
12 KiB
TypeScript
// Copyright: Ankitects Pty Ltd and contributors
|
|
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
import { getRange, getSelection } from "@tslib/cross-browser";
|
|
import { asyncNoop } from "@tslib/functional";
|
|
import { registerPackage } from "@tslib/runtime-require";
|
|
import type { Readable } from "svelte/store";
|
|
import { derived, get } from "svelte/store";
|
|
|
|
import type { Matcher } from "../domlib/find-above";
|
|
import { findClosest } from "../domlib/find-above";
|
|
import type { SurroundFormat } from "../domlib/surround";
|
|
import { boolMatcher, reformat, surround, unsurround } from "../domlib/surround";
|
|
import type { TriggerItem } from "../sveltelib/handler-list";
|
|
import type { InputHandlerAPI } from "../sveltelib/input-handler";
|
|
|
|
function isValid<T>(value: T | undefined): value is T {
|
|
return Boolean(value);
|
|
}
|
|
|
|
function isSurroundedInner(
|
|
range: AbstractRange,
|
|
base: HTMLElement,
|
|
matcher: Matcher,
|
|
): boolean {
|
|
return Boolean(
|
|
findClosest(range.startContainer, base, matcher)
|
|
|| findClosest(range.endContainer, base, matcher),
|
|
);
|
|
}
|
|
|
|
function surroundAndSelect<T>(
|
|
matches: boolean,
|
|
range: Range,
|
|
base: HTMLElement,
|
|
format: SurroundFormat<T>,
|
|
selection: Selection,
|
|
): void {
|
|
const surroundedRange = matches
|
|
? unsurround(range, base, format)
|
|
: surround(range, base, format);
|
|
|
|
selection.removeAllRanges();
|
|
selection.addRange(surroundedRange);
|
|
}
|
|
|
|
function removeFormats(
|
|
range: Range,
|
|
base: Element,
|
|
formats: SurroundFormat[],
|
|
reformats: SurroundFormat[] = [],
|
|
): Range {
|
|
let surroundRange = range;
|
|
|
|
for (const format of formats) {
|
|
surroundRange = unsurround(surroundRange, base, format);
|
|
}
|
|
|
|
for (const format of reformats) {
|
|
surroundRange = reformat(surroundRange, base, format);
|
|
}
|
|
|
|
return surroundRange;
|
|
}
|
|
|
|
export interface SurroundedAPI {
|
|
element: Promise<HTMLElement>;
|
|
inputHandler: InputHandlerAPI;
|
|
}
|
|
|
|
/**
|
|
* After calling disable, using any of the surrounding methods will throw an
|
|
* exception. Make sure to set the input before trying to use them again.
|
|
*/
|
|
export class Surrounder<T = unknown> {
|
|
#api?: SurroundedAPI;
|
|
|
|
#triggers: Map<string, TriggerItem<{ event: InputEvent; text: Text }>> = new Map();
|
|
#formats: Map<string, SurroundFormat<T>> = new Map();
|
|
|
|
active: Readable<boolean>;
|
|
|
|
private constructor(apiStore: Readable<SurroundedAPI | null>) {
|
|
this.active = derived(apiStore, (api) => Boolean(api));
|
|
|
|
apiStore.subscribe((api: SurroundedAPI | null): void => {
|
|
if (api) {
|
|
this.#api = api;
|
|
|
|
for (const key of this.#formats.keys()) {
|
|
this.#triggers.set(
|
|
key,
|
|
api.inputHandler.insertText.trigger({ once: true }),
|
|
);
|
|
}
|
|
} else {
|
|
this.#api = undefined;
|
|
|
|
for (const [key, trigger] of this.#triggers) {
|
|
trigger.off();
|
|
this.#triggers.delete(key);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
static make<T>(apiStore: Readable<SurroundedAPI | null>): Surrounder<T> {
|
|
return new Surrounder(apiStore);
|
|
}
|
|
|
|
#getBaseElement(): Promise<HTMLElement> {
|
|
if (!this.#api) {
|
|
throw new Error("Surrounder: No api set");
|
|
}
|
|
|
|
return this.#api.element;
|
|
}
|
|
|
|
#toggleTrigger<T>(
|
|
base: HTMLElement,
|
|
selection: Selection,
|
|
matcher: Matcher,
|
|
format: SurroundFormat<T>,
|
|
trigger: TriggerItem<{ event: InputEvent; text: Text }>,
|
|
exclusive: SurroundFormat<T>[] = [],
|
|
): void {
|
|
if (get(trigger.active)) {
|
|
trigger.off();
|
|
} else {
|
|
trigger.on(async ({ text }) => {
|
|
const range = new Range();
|
|
range.selectNode(text);
|
|
|
|
const matches = Boolean(findClosest(text, base, matcher));
|
|
const clearedRange = removeFormats(range, base, exclusive);
|
|
surroundAndSelect(matches, clearedRange, base, format, selection);
|
|
selection.collapseToEnd();
|
|
});
|
|
}
|
|
}
|
|
|
|
#toggleTriggerOverwrite<T>(
|
|
base: HTMLElement,
|
|
selection: Selection,
|
|
format: SurroundFormat<T>,
|
|
trigger: TriggerItem<{ event: InputEvent; text: Text }>,
|
|
exclusive: SurroundFormat<T>[] = [],
|
|
): void {
|
|
trigger.on(async ({ text }) => {
|
|
const range = new Range();
|
|
range.selectNode(text);
|
|
|
|
const clearedRange = removeFormats(range, base, exclusive);
|
|
const surroundedRange = surround(clearedRange, base, format);
|
|
selection.removeAllRanges();
|
|
selection.addRange(surroundedRange);
|
|
selection.collapseToEnd();
|
|
});
|
|
}
|
|
|
|
#toggleTriggerRemove<T>(
|
|
base: HTMLElement,
|
|
selection: Selection,
|
|
formats: {
|
|
format: SurroundFormat<T>;
|
|
trigger: TriggerItem<{ event: InputEvent; text: Text }>;
|
|
}[],
|
|
reformat: SurroundFormat<T>[] = [],
|
|
): void {
|
|
const remainingFormats = formats
|
|
.filter(({ trigger }) => {
|
|
if (get(trigger.active)) {
|
|
// Deactivate active triggers for active formats.
|
|
trigger.off();
|
|
return false;
|
|
}
|
|
|
|
// Otherwise you are within the format. This is why we activate
|
|
// the trigger, so that the active button is set to inactive.
|
|
// We still need to remove the format however.
|
|
trigger.on(asyncNoop);
|
|
return true;
|
|
})
|
|
.map(({ format }) => format);
|
|
|
|
// Use an anonymous insertText handler instead of some trigger associated with a name
|
|
this.#api!.inputHandler.insertText.on(
|
|
async ({ text }) => {
|
|
const range = new Range();
|
|
range.selectNode(text);
|
|
|
|
const clearedRange = removeFormats(
|
|
range,
|
|
base,
|
|
remainingFormats,
|
|
reformat,
|
|
);
|
|
selection.removeAllRanges();
|
|
selection.addRange(clearedRange);
|
|
selection.collapseToEnd();
|
|
},
|
|
{ once: true },
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Check if a surround format under the given key is registered.
|
|
*/
|
|
hasFormat(key: string): boolean {
|
|
return this.#formats.has(key);
|
|
}
|
|
|
|
/**
|
|
* Register a surround format under a certain key.
|
|
* This name is then used with the surround functions to actually apply or
|
|
* remove the given format.
|
|
*/
|
|
registerFormat(key: string, format: SurroundFormat<T>): () => void {
|
|
this.#formats.set(key, format);
|
|
|
|
if (this.#api) {
|
|
this.#triggers.set(
|
|
key,
|
|
this.#api.inputHandler.insertText.trigger({ once: true }),
|
|
);
|
|
}
|
|
|
|
return () => this.#formats.delete(key);
|
|
}
|
|
|
|
/**
|
|
* Update a surround format under a specific key.
|
|
*/
|
|
updateFormat(
|
|
key: string,
|
|
update: (format: SurroundFormat<T>) => SurroundFormat<T>,
|
|
): void {
|
|
this.#formats.set(key, update(this.#formats.get(key)!));
|
|
}
|
|
|
|
/**
|
|
* Use the surround command on the current range of the input.
|
|
* If the range is already surrounded, it will unsurround instead.
|
|
*/
|
|
async surround(formatName: string, exclusiveNames: string[] = []): Promise<void> {
|
|
const base = await this.#getBaseElement();
|
|
const selection = getSelection(base)!;
|
|
const range = getRange(selection);
|
|
const format = this.#formats.get(formatName);
|
|
const trigger = this.#triggers.get(formatName);
|
|
|
|
if (!format || !range || !trigger) {
|
|
return;
|
|
}
|
|
|
|
const matcher = boolMatcher(format);
|
|
|
|
const exclusives = exclusiveNames
|
|
.map((name) => this.#formats.get(name))
|
|
.filter(isValid);
|
|
|
|
if (range.collapsed) {
|
|
return this.#toggleTrigger(
|
|
base,
|
|
selection,
|
|
matcher,
|
|
format,
|
|
trigger,
|
|
exclusives,
|
|
);
|
|
}
|
|
|
|
const clearedRange = removeFormats(range, base, exclusives);
|
|
const matches = isSurroundedInner(clearedRange, base, matcher);
|
|
surroundAndSelect(matches, clearedRange, base, format, selection);
|
|
}
|
|
|
|
/**
|
|
* Use the surround command on the current range of the input.
|
|
* If the range is already surrounded, it will overwrite the format.
|
|
* This might be better suited if the surrounding is parameterized (like
|
|
* text color).
|
|
*/
|
|
async overwriteSurround(
|
|
formatName: string,
|
|
exclusiveNames: string[] = [],
|
|
): Promise<void> {
|
|
const base = await this.#getBaseElement();
|
|
const selection = getSelection(base)!;
|
|
const range = getRange(selection);
|
|
const format = this.#formats.get(formatName);
|
|
const trigger = this.#triggers.get(formatName);
|
|
|
|
if (!format || !range || !trigger) {
|
|
return;
|
|
}
|
|
|
|
const exclusives = exclusiveNames
|
|
.map((name) => this.#formats.get(name))
|
|
.filter(isValid);
|
|
|
|
if (range.collapsed) {
|
|
return this.#toggleTriggerOverwrite(
|
|
base,
|
|
selection,
|
|
format,
|
|
trigger,
|
|
exclusives,
|
|
);
|
|
}
|
|
|
|
const clearedRange = removeFormats(range, base, exclusives);
|
|
const surroundedRange = surround(clearedRange, base, format);
|
|
selection.removeAllRanges();
|
|
selection.addRange(surroundedRange);
|
|
}
|
|
|
|
/**
|
|
* Check if the current selection is surrounded. A selection will count as
|
|
* provided if either the start or the end boundary point are within the
|
|
* provided format, OR if a surround trigger is active (surround on next
|
|
* text insert).
|
|
*/
|
|
async isSurrounded(formatName: string): Promise<boolean> {
|
|
const base = await this.#getBaseElement();
|
|
const selection = getSelection(base)!;
|
|
const range = getRange(selection);
|
|
const format = this.#formats.get(formatName);
|
|
const trigger = this.#triggers.get(formatName);
|
|
|
|
if (!range || !format || !trigger) {
|
|
return false;
|
|
}
|
|
|
|
const isSurrounded = isSurroundedInner(range, base, boolMatcher(format));
|
|
return get(trigger.active) ? !isSurrounded : isSurrounded;
|
|
}
|
|
|
|
/**
|
|
* Clear/Reformat the provided formats in the current range.
|
|
*/
|
|
async remove(formatNames: string[], reformatNames: string[] = []): Promise<void> {
|
|
const base = await this.#getBaseElement();
|
|
const selection = getSelection(base)!;
|
|
const range = getRange(selection);
|
|
|
|
if (!range) {
|
|
return;
|
|
}
|
|
|
|
const activeFormats = formatNames
|
|
.map((name: string) => ({
|
|
name,
|
|
format: this.#formats.get(name)!,
|
|
trigger: this.#triggers.get(name)!,
|
|
}))
|
|
.filter(({ format, trigger }): boolean => {
|
|
if (!format || !trigger) {
|
|
return false;
|
|
}
|
|
|
|
const isSurrounded = isSurroundedInner(
|
|
range,
|
|
base,
|
|
boolMatcher(format),
|
|
);
|
|
return get(trigger.active) ? !isSurrounded : isSurrounded;
|
|
});
|
|
|
|
const reformats = reformatNames
|
|
.map((name) => this.#formats.get(name))
|
|
.filter(isValid);
|
|
|
|
if (range.collapsed) {
|
|
return this.#toggleTriggerRemove(base, selection, activeFormats, reformats);
|
|
}
|
|
|
|
const surroundedRange = removeFormats(
|
|
range,
|
|
base,
|
|
activeFormats.map(({ format }) => format),
|
|
reformats,
|
|
);
|
|
selection.removeAllRanges();
|
|
selection.addRange(surroundedRange);
|
|
}
|
|
}
|
|
|
|
registerPackage("anki/surround", {
|
|
Surrounder,
|
|
});
|