pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2024-10-05 15:07:49 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the new TODO/hyperlink services

Browse Source
This commit is contained in:
Andrew Dupont 2024-01-13 20:39:33 -08:00
parent 6069a59804
commit 09184d959f
2 changed files with 57 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
packages/language-hyperlink/lib/main.js
View File

@ -1,12 +1,36 @@
const HYPERLINK_PATTERN = /\bhttps?:/
module.exports = {
provideHyperlinkInjection() {
return {
// Private: Test whether a Tree-sitter node's text contains any tokens
// that would benefit from a hyperlink injection.
//
// Useful if you want to call {GrammarRegistry::addInjectionPoint}
// yourself and want to use this logic in a `language` callback.
//
// * `node` A Tree-sitter tree node.
test(node) {
return HYPERLINK_PATTERN.test(node.text);
},
// Private: specify one or more types of syntax nodes for a given grammar
// that may embed the hyperlink grammar.
//
// * `scopeName` The {String} ID of the parent language.
// * `options` An {Object} with the following keys:
// * `types` An {Array} or {String} indicating the type or types of
// Tree-sitter tree nodes that may receive injections.
// * `language` (optional) A {Function} that may be called to add extra
// logic for determining which language should be used in an
// injection. If present, will be called before the default logic.
// If it returns `undefined`, the default logic will apply. If it
// returns a {String} or `null`, the default logic will be preempted.
// * `content` (optional) A {Function} that will be used to determine
// which of the injection node's children, if any, will be injected
// into. The default `content` callback is one that returns the
// original node.
addInjectionPoint(scopeName, options) {
let types = options.types;
if (!Array.isArray(types)) types = [types];
@ -19,7 +43,8 @@ module.exports = {
let result = options.language(node);
if (result !== undefined) return result;
}
return HYPERLINK_PATTERN.test(node.text) ? 'hyperlink' : undefined;
return HYPERLINK_PATTERN.test(node.text) ?
'hyperlink' : undefined;
},
content(node) {
return options.content ? options.content(node) : node;

38
packages/language-todo/lib/main.js
View File

@ -1,24 +1,48 @@
const TODO_PATTERN = /\b(TODO|FIXME|CHANGED|XXX|IDEA|HACK|NOTE|REVIEW|NB|BUG|QUESTION|COMBAK|TEMP|DEBUG|OPTIMIZE|WARNING)\b/;
module.exports = {
provideTodoInjection() {
return {
// Private: Test whether a Tree-sitter node's text contains any tokens
// that would benefit from a TODO injection.
//
// Useful if you want to call {GrammarRegistry::addInjectionPoint}
// yourself and want to use this logic in a `language` callback.
//
// * `node` A Tree-sitter tree node.
test(node) {
return TODO_PATTERN.test(node.text);
},
// TODO: Ideal would be to have one `language-todo` injection for the
// whole document responsible for highlighting TODOs in all comments, but
// performance needs to be better than it is now for that to be possible.
// Injecting into individual nodes results in less time parsing during
// buffer modification, but _lots_ of language layers.
// Private: specify one or more types of syntax nodes for a given grammar
// that may embed the TODO grammar.
//
// Compromise is to test the content first and then only inject a layer
// for `language-todo` when we know it'll be needed.
// * `scopeName` The {String} ID of the parent language.
// * `options` An {Object} with the following keys:
// * `types` An {Array} or {String} indicating the type or types of
// Tree-sitter tree nodes that may receive injections.
// * `language` (optional) A {Function} that may be called to add extra
// logic for determining which language should be used in an
// injection. If present, will be called before the default logic.
// If it returns `undefined`, the default logic will apply. If it
// returns a {String} or `null`, the default logic will be preempted.
// * `content` (optional) A {Function} that will be used to determine
// which of the injection node's children, if any, will be injected
// into. The default `content` callback is one that returns the
// original node.
addInjectionPoint(scopeName, options) {
let types = options.types;
if (!Array.isArray(types)) types = [types];
// TODO: Ideal would be to have one `language-todo` injection for the
// whole document responsible for highlighting TODOs in all comments,
// but performance needs to be better than it is now for that to be
// possible. Injecting into individual nodes results in less time
// parsing during buffer modification, but _lots_ of language layers.
//
// Compromise is to test the content first and then only inject a layer
// for `language-todo` when we know it'll be needed.
for (let type of types) {
atom.grammars.addInjectionPoint(scopeName, {
type,