anki/ts/lib/proto.ts

// Copyright: Ankitects Pty Ltd and contributors
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html

import { anki } from "./backend_proto";
import Cards = anki.cards;
import DeckConfig = anki.deckconfig;
import Notetypes = anki.notetypes;
import Scheduler = anki.scheduler;
import Stats = anki.stats;
import Tags = anki.tags;
export { Stats, Cards, DeckConfig, Notetypes, Scheduler, Tags };
refactor protobuf handling for split/import In order to split backend.proto into a more manageable size, the protobuf handling needed to be updated. This took more time than I would have liked, as each language handles protobuf differently: - The Python Protobuf code ignores "package" directives, and relies solely on how the files are laid out on disk. While it would have been nice to keep the generated files in a private subpackage, Protobuf gets confused if the files are located in a location that does not match their original .proto layout, so the old approach of storing them in _backend/ will not work. They now clutter up pylib/anki instead. I'm rather annoyed by that, but alternatives seem to be having to add an extra level to the Protobuf path, making the other languages suffer, or trying to hack around the issue by munging sys.modules. - Protobufjs fails to expose packages if they don't start with a capital letter, despite the fact that lowercase packages are the norm in most languages :-( This required a patch to fix. - Rust was the easiest, as Prost is relatively straightforward compared to Google's tools. The Protobuf files are now stored in /proto/anki, with a separate package for each file. I've split backend.proto into a few files as a test, but the majority of that work is still to come. The Python Protobuf building is a bit of a hack at the moment, hard-coding "proto" as the top level folder, but it seems to get the job done for now. Also changed the workspace name, as there seems to be a number of Bazel repos moving away from the more awkward reverse DNS naming style. 2021-07-10 09:50:18 +02:00			`// Copyright: Ankitects Pty Ltd and contributors`
			`// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html`

			`import { anki } from "./backend_proto";`
split out cards and collection 2021-07-10 11:52:31 +02:00			`import Cards = anki.cards;`
split out decks, deckconfig, notes, notetypes 2021-07-10 12:44:22 +02:00			`import DeckConfig = anki.deckconfig;`
			`import Notetypes = anki.notetypes;`
split out sync, search, scheduler & config 2021-07-10 13:33:12 +02:00			`import Scheduler = anki.scheduler;`
split out remaining tags, stats, media and rendering 2021-07-10 13:58:34 +02:00			`import Stats = anki.stats;`
add basic tag completion to backend Matches should arrive in alphabetical order. Currently results are not capped (JS should be able to handle ~1k tags without too much hassle), and no reordering based on match location is done. Matches are substring based, and multiple can be provided, eg "foo::bar" will match "foof::baz::abbar". This is not hooked up properly on the frontend at the moment - updateSuggestions() seems to be missing the most recently typed character, and is not updating the list of completions half the time. 2021-09-08 09:22:30 +02:00			`import Tags = anki.tags;`
			`export { Stats, Cards, DeckConfig, Notetypes, Scheduler, Tags };`