obsidian-plugin/trevware_obsidian-sidebar-highlights
1
0
Fork 0
mirror of https://github.com/trevware/obsidian-sidebar-highlights.git synced 2026-07-22 05:51:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up obsolete comments and add GitHub release workflow

Browse source
This commit is contained in:
Trevor 2025-06-04 16:28:47 -04:00
parent 0c5f95a9be
commit b62800933e
10 changed files with 7698 additions and 212 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

675
LICENSE
View file

@ -1,5 +1,674 @@
Copyright (C) 2020-2025 by Dynalist Inc.
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

141
README.md
View file

@ -1,94 +1,79 @@
# Obsidian Sample Plugin
# Highlights Sidebar
This is a sample plugin for Obsidian (https://obsidian.md).
A sidebar plugin for Obsidian that helps you view and manage text highlights, comments, and collections across your vault.
This project uses TypeScript to provide type checking and documentation.
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
## Features
This sample plugin demonstrates some of the basic functionality the plugin API can do.
- Adds a ribbon icon, which shows a Notice when clicked.
- Adds a command "Open Sample Modal" which opens a Modal.
- Adds a plugin setting tab to the settings page.
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
- **Create highlights** from selected text using `==highlighted text==` syntax
- **Sidebar view** showing all highlights from the current file
- **Search and filter** highlights by text content
- **Color coding** with 5 different highlight colors
- **Comments system** using footnotes (e.g., `==text==[^comment]`)
- **Collections** to organize highlights across multiple files
- **Tag support** for categorizing highlights
- **Dynamic commands** for viewing highlights in specific collections
## First time developing plugins?
## Usage
Quick starting guide for new plugin devs:
### Creating Highlights
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
1. **Select text** in any markdown file
2. **Right-click** and choose "Create highlight" from the context menu
3. Or use the command palette: `Ctrl/Cmd + P` → "Toggle highlight"
4. Or manually type: `==your highlighted text==`
## Releasing new releases
### Using the Sidebar
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
1. Click the **highlighter icon** in the ribbon to open the sidebar
2. The sidebar shows all highlights from the currently active file
3. **Click any highlight** to jump directly to its location in the document
4. Use the **All Notes tab** to view highlights from across your entire vault
5. **Group highlights** by Color, Comments, Folder, Parent, Collection or Filename using the grouping buttons
6. **Filter by tags** using the tag filter dropdown to show only highlights with specific tags
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
### Adding Comments
## Adding your plugin to the community plugin list
Add footnotes immediately after highlights to create comments:
```markdown
==Important text==[^1]
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
## How to use
- Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
## Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Improve code quality with eslint (optional)
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint`
- To use eslint to analyze this project use this command:
- `eslint main.ts`
- eslint will then create a report with suggestions for code improvement by file and line number.
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
- `eslint .\src\`
## Funding URL
You can include funding URLs where people who use your plugin can financially support it.
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
```json
{
"fundingUrl": "https://buymeacoffee.com"
}
[^1]: This is my comment about the highlighted text
```
If you have multiple URLs, you can also do:
You can also click the **comment button** on any highlight in the sidebar and select "Add Comment" to create footnotes automatically at the highlight's location.
```json
{
"fundingUrl": {
"Buy Me a Coffee": "https://buymeacoffee.com",
"GitHub Sponsor": "https://github.com/sponsors",
"Patreon": "https://www.patreon.com/"
}
}
```
### Working with Collections
## API Documentation
1. Switch to the **Collections tab** in the sidebar
2. Click **"New Collection"** to create a collection
3. Add highlights to collections using the collection button on each highlight
4. View collection contents by clicking on any collection card
5. Jump to collections by using the command palette
See https://github.com/obsidianmd/obsidian-api
### Color Coding
- Change highlight colors using the color picker in each highlight card
- 5 colors available: Gold, Red, Teal, Blue, and Green
- Colors help categorize and organize your highlights
## Installation
1. Download the plugin files
2. Place them in your `.obsidian/plugins/obsidian-highlights-sidebar/` folder
3. Enable the plugin in Obsidian's Community Plugins settings
## Commands
- **Toggle**: Open/close the sidebar
- **Go to "Collection"**: Jumps to that specific collection
## Important Notes
- **Manual removal**: For now, highlights and comments must be manually removed from your markdown files by deleting the `==` syntax and footnotes.
- **Collection commands**: If a collection is deleted, the command to jump to that specific collection will remain in the command palette **until reload.** However, it will show (deleted) next to the name of a collection prior to reloading.
## Support
For issues or feature requests, please visit the plugin's repository.
If you find this plugin helpful, consider [buying me a coffee](https://buymeacoffee.com/trevware) ☕

959
main.ts
View file

@ -1,134 +1,853 @@
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting } from 'obsidian';
// main.ts
import { App, Editor, MarkdownView, Modal, Notice, Plugin, PluginSettingTab, Setting, TFile, TAbstractFile, WorkspaceLeaf, ItemView, Menu, debounce, setIcon } from 'obsidian';
import { HighlightsSidebarView } from './src/views/sidebar-view';
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
mySetting: string;
export interface Highlight {
id: string;
text: string;
tags: string[];
line: number;
startOffset: number;
endOffset: number;
filePath: string;
footnoteCount?: number;
footnoteContents?: string[];
color?: string;
collectionIds?: string[]; // Add collection support
createdAt?: number; // Timestamp when highlight was created
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: 'default'
export interface Collection {
id: string;
name: string;
description?: string; // Add optional description field
highlightIds: string[];
createdAt: number;
}
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
async onload() {
await this.loadSettings();
// This creates an icon in the left ribbon.
const ribbonIconEl = this.addRibbonIcon('dice', 'Sample Plugin', (evt: MouseEvent) => {
// Called when the user clicks the icon.
new Notice('This is a notice!');
});
// Perform additional things with the ribbon
ribbonIconEl.addClass('my-plugin-ribbon-class');
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
const statusBarItemEl = this.addStatusBarItem();
statusBarItemEl.setText('Status Bar Text');
// This adds a simple command that can be triggered anywhere
this.addCommand({
id: 'open-sample-modal-simple',
name: 'Open sample modal (simple)',
callback: () => {
new SampleModal(this.app).open();
}
});
// This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
id: 'sample-editor-command',
name: 'Sample editor command',
editorCallback: (editor: Editor, view: MarkdownView) => {
console.log(editor.getSelection());
editor.replaceSelection('Sample Editor Command');
}
});
// This adds a complex command that can check whether the current state of the app allows execution of the command
this.addCommand({
id: 'open-sample-modal-complex',
name: 'Open sample modal (complex)',
checkCallback: (checking: boolean) => {
// Conditions to check
const markdownView = this.app.workspace.getActiveViewOfType(MarkdownView);
if (markdownView) {
// If checking is true, we're simply "checking" if the command can be run.
// If checking is false, then we want to actually perform the operation.
if (!checking) {
new SampleModal(this.app).open();
}
// This command will only show up in Command Palette when the check function returns true
return true;
}
}
});
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
// Using this function will automatically remove the event listener when this plugin is disabled.
this.registerDomEvent(document, 'click', (evt: MouseEvent) => {
console.log('click', evt);
});
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
this.registerInterval(window.setInterval(() => console.log('setInterval'), 5 * 60 * 1000));
}
onunload() {
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async saveSettings() {
await this.saveData(this.settings);
}
interface CommentPluginSettings {
highlightColor: string;
sidebarPosition: 'left' | 'right';
autoOpenSidebar: boolean;
highlights: { [filePath: string]: Highlight[] };
collections: { [id: string]: Collection }; // Add collections to settings
groupingMode: 'none' | 'color' | 'comments-asc' | 'comments-desc' | 'tag' | 'parent' | 'collection' | 'filename' | 'date-created-asc' | 'date-created-desc'; // Add grouping mode persistence
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
}
onOpen() {
const {contentEl} = this;
contentEl.setText('Woah!');
}
onClose() {
const {contentEl} = this;
contentEl.empty();
}
const DEFAULT_SETTINGS: CommentPluginSettings = {
highlightColor: '#ffd700',
sidebarPosition: 'right',
autoOpenSidebar: true,
highlights: {},
collections: {}, // Initialize empty collections
groupingMode: 'none' // Default grouping mode
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
const VIEW_TYPE_HIGHLIGHTS = 'highlights-sidebar';
constructor(app: App, plugin: MyPlugin) {
super(app, plugin);
this.plugin = plugin;
}
export default class HighlightCommentsPlugin extends Plugin {
settings: CommentPluginSettings;
highlights: Map<string, Highlight[]> = new Map();
collections: Map<string, Collection> = new Map();
collectionsManager: CollectionsManager;
private sidebarView: HighlightsSidebarView | null = null;
private detectHighlightsTimeout: NodeJS.Timeout | null = null;
public selectedHighlightId: string | null = null;
private collectionCommands: Set<string> = new Set(); // Track registered collection commands
public deletedCollectionNames: Map<string, string> = new Map(); // Track names of deleted collections
display(): void {
const {containerEl} = this;
async onload() {
await this.loadSettings();
this.highlights = new Map(Object.entries(this.settings.highlights || {}));
this.collections = new Map(Object.entries(this.settings.collections || {}));
this.collectionsManager = new CollectionsManager(this);
this.registerView(
VIEW_TYPE_HIGHLIGHTS,
(leaf) => {
this.sidebarView = new HighlightsSidebarView(leaf, this);
return this.sidebarView;
}
);
containerEl.empty();
this.addRibbonIcon('highlighter', 'Open Highlights', () => {
this.activateView();
});
new Setting(containerEl)
.setName('Setting #1')
.setDesc('It\'s a secret')
.addText(text => text
.setPlaceholder('Enter your secret')
.setValue(this.plugin.settings.mySetting)
.onChange(async (value) => {
this.plugin.settings.mySetting = value;
await this.plugin.saveSettings();
}));
}
this.addCommand({
id: 'create-highlight',
name: 'Create highlight from selection',
editorCallback: (editor: Editor) => {
this.createHighlight(editor);
}
});
this.addCommand({
id: 'open-highlights-sidebar',
name: 'Toggle',
callback: () => {
this.toggleView();
}
});
this.registerEvent(
this.app.workspace.on('editor-menu', (menu, editor, view) => {
if (editor.getSelection()) {
menu.addItem((item) => {
item
.setTitle('Create highlight')
.setIcon('highlighter')
.onClick(() => {
this.createHighlight(editor);
});
});
}
})
);
this.registerEvent(
this.app.workspace.on('file-open', (file) => {
if (file) {
this.loadHighlightsFromFile(file);
} else {
this.highlights.clear();
this.selectedHighlightId = null;
this.refreshSidebar();
}
})
);
this.registerEvent(
this.app.workspace.on('editor-change', (editor, view) => {
if (view instanceof MarkdownView) {
this.debounceDetectMarkdownHighlights(editor, view);
}
})
);
this.registerEvent(
this.app.vault.on('create', (file) => {
if (file instanceof TFile && file.extension === 'md') {
this.handleFileCreate(file);
}
})
);
this.registerEvent(
this.app.vault.on('rename', (file, oldPath) => {
if (file instanceof TFile && file.extension === 'md') {
this.handleFileRename(file, oldPath);
}
})
);
this.registerEvent(
this.app.vault.on('delete', (file) => {
if (file instanceof TFile && file.extension === 'md') {
this.handleFileDelete(file);
}
})
);
this.addSettingTab(new HighlightSettingTab(this.app, this));
this.addStyles();
// Register collection commands
this.registerCollectionCommands();
// Scan all files for highlights after workspace is ready
this.app.workspace.onLayoutReady(() => {
this.scanAllFilesForHighlights();
if (this.settings.autoOpenSidebar) {
this.activateView();
}
});
}
onunload() {
// Cleanup is mostly automatic due to using registerEvent() and addCommand()
// But we can explicitly clean up the sidebar view if needed
// The sidebar view's onClose() method will handle its own cleanup
// Obsidian automatically handles:
// - Registered events (this.registerEvent)
// - Registered commands (this.addCommand)
// - Settings tab removal
// - View unregistration
// Only manual cleanup needed is for any direct DOM listeners or intervals
// which we don't currently have in the main plugin file
console.log('Highlight Comments plugin unloaded');
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
}
async saveSettings() {
// Save highlights and collections to settings before saving
this.settings.highlights = Object.fromEntries(this.highlights);
this.settings.collections = Object.fromEntries(this.collections);
await this.saveData(this.settings);
this.updateStyles();
}
addStyles() {
const style = document.createElement('style');
style.id = 'highlight-comments-plugin-styles';
// Set CSS custom property for highlight color
document.documentElement.style.setProperty('--highlight-color', this.settings.highlightColor);
document.head.appendChild(style);
}
updateStyles() {
// Update CSS custom property when settings change
document.documentElement.style.setProperty('--highlight-color', this.settings.highlightColor);
}
removeStyles() {
const style = document.getElementById('highlight-comments-plugin-styles');
if (style) {
style.remove();
}
// Clean up CSS custom property
document.documentElement.style.removeProperty('--highlight-color');
}
async activateView() {
const { workspace } = this.app;
let leaf: WorkspaceLeaf | null = null;
const leaves = workspace.getLeavesOfType(VIEW_TYPE_HIGHLIGHTS);
if (leaves.length > 0) {
leaf = leaves[0];
} else {
leaf = this.settings.sidebarPosition === 'left'
? workspace.getLeftLeaf(false)
: workspace.getRightLeaf(false);
await leaf?.setViewState({ type: VIEW_TYPE_HIGHLIGHTS, active: true });
}
if (leaf) {
workspace.revealLeaf(leaf);
}
}
async toggleView() {
const { workspace } = this.app;
const leaves = workspace.getLeavesOfType(VIEW_TYPE_HIGHLIGHTS);
if (leaves.length > 0) {
// Sidebar is open, close it
leaves.forEach(leaf => leaf.detach());
} else {
// Sidebar is closed, open it
await this.activateView();
}
}
async createHighlight(editor: Editor) {
const selection = editor.getSelection();
if (!selection) {
new Notice('Please select some text first');
return;
}
const file = this.app.workspace.getActiveFile();
if (!file) {
new Notice('No active file');
return;
}
const fromCursor = editor.getCursor('from');
const toCursor = editor.getCursor('to');
const fromOffset = editor.posToOffset(fromCursor);
const toOffset = editor.posToOffset(toCursor);
const highlightId = this.generateId();
const highlight: Highlight = {
id: highlightId,
text: selection,
tags: [],
line: fromCursor.line,
startOffset: fromOffset,
endOffset: toOffset,
filePath: file.path,
createdAt: Date.now(),
};
const fileHighlights = this.highlights.get(file.path) || [];
fileHighlights.push(highlight);
this.highlights.set(file.path, fileHighlights);
const highlightedText = `==${selection}==`;
editor.replaceSelection(highlightedText);
this.refreshSidebar();
new Notice('Highlight created');
if (this.settings.autoOpenSidebar) {
const leaves = this.app.workspace.getLeavesOfType(VIEW_TYPE_HIGHLIGHTS);
if (leaves.length === 0) { // Only activate if not already open/visible
this.activateView();
}
}
}
refreshSidebar() {
if (this.sidebarView) {
this.sidebarView.refresh();
}
}
// Register dynamic commands for collections
public registerCollectionCommands() {
// Register commands for all existing collections
for (const collection of this.collections.values()) {
const commandId = `go-to-collection-${collection.id}`;
// Always register/re-register to update the name if it changed
this.addCommand({
id: commandId,
name: `Go to ${collection.name}`,
callback: () => {
this.goToCollection(collection.id);
}
});
this.collectionCommands.add(commandId);
}
}
// Update commands for deleted collections to show "(deleted)" in the name
public updateDeletedCollectionCommands() {
// Get all currently existing collection IDs
const existingCollectionIds = new Set(Array.from(this.collections.keys()));
// Find commands for collections that no longer exist
const deletedCommands = Array.from(this.collectionCommands).filter(commandId => {
const collectionId = commandId.replace('go-to-collection-', '');
return !existingCollectionIds.has(collectionId);
});
// Re-register deleted collection commands with updated names
for (const commandId of deletedCommands) {
const collectionId = commandId.replace('go-to-collection-', '');
const deletedCollectionName = this.deletedCollectionNames.get(collectionId) || 'Collection';
this.addCommand({
id: commandId,
name: `Go to ${deletedCollectionName} (deleted)`,
callback: () => {
new Notice(`Collection "${deletedCollectionName}" has been deleted`);
}
});
}
}
// Unregister all collection commands
private unregisterCollectionCommands() {
// Note: Obsidian doesn't provide a direct way to unregister commands
// Commands are automatically cleaned up when the plugin is unloaded
// We'll track them and they'll be replaced when registerCollectionCommands is called
this.collectionCommands.clear();
}
// Navigate to a specific collection in the sidebar
private async goToCollection(collectionId: string) {
// First, make sure the sidebar is open
await this.activateView();
// Then navigate to the collection
if (this.sidebarView) {
this.sidebarView.navigateToCollection(collectionId);
}
}
updateHighlight(highlightId: string, updates: Partial<Highlight>, filePath?: string) {
let determinedFilePath = filePath;
let fileHighlightsList: Highlight[] | undefined;
if (determinedFilePath) {
fileHighlightsList = this.highlights.get(determinedFilePath);
} else {
// If no filePath is provided, attempt to find the highlight by ID across all files.
// This assumes highlight IDs are globally unique if filePath is omitted.
for (const [path, highlightsInFile] of this.highlights) {
if (highlightsInFile.some(h => h.id === highlightId)) {
determinedFilePath = path;
fileHighlightsList = highlightsInFile;
break;
}
}
}
// If still no path after searching, and filePath was not initially provided,
// fallback to active file to maintain some compatibility if a caller truly doesn't know the path.
if (!determinedFilePath && !filePath) {
const activeFile = this.app.workspace.getActiveFile();
if (activeFile) {
determinedFilePath = activeFile.path;
fileHighlightsList = this.highlights.get(determinedFilePath);
}
}
if (!determinedFilePath || !fileHighlightsList) {
console.error(`Cannot update highlight ${highlightId}: File path "${determinedFilePath}" invalid or highlight list not found.`);
return;
}
const highlightIndex = fileHighlightsList.findIndex(h => h.id === highlightId);
if (highlightIndex !== -1) {
const updatedHighlight = { ...fileHighlightsList[highlightIndex], ...updates };
// Create a new array for the highlights of the specific file to ensure reactivity
const newFileHighlightsList = [...fileHighlightsList];
newFileHighlightsList[highlightIndex] = updatedHighlight;
this.highlights.set(determinedFilePath, newFileHighlightsList);
this.saveSettings();
this.refreshSidebar();
} else {
console.warn(`Highlight ${highlightId} not found in file ${determinedFilePath} for update.`);
}
}
async loadHighlightsFromFile(file: TFile) {
const content = await this.app.vault.read(file);
// Clear any selection from previous file
this.selectedHighlightId = null;
// detectAndStoreMarkdownHighlights will call refreshSidebar if changes are detected
this.detectAndStoreMarkdownHighlights(content, file);
// Always refresh sidebar when file changes, even if no highlights detected
this.refreshSidebar();
}
debounceDetectMarkdownHighlights(editor: Editor, view: MarkdownView) {
if (this.detectHighlightsTimeout) {
clearTimeout(this.detectHighlightsTimeout);
}
this.detectHighlightsTimeout = setTimeout(() => {
this.detectMarkdownHighlights(editor, view);
}, 1000);
}
async detectMarkdownHighlights(editor: Editor, view: MarkdownView) {
const file = view.file;
if (!file) return;
const content = editor.getValue();
this.detectAndStoreMarkdownHighlights(content, file);
}
private async scanAllFilesForHighlights() {
const markdownFiles = this.app.vault.getMarkdownFiles();
const existingFilePaths = new Set(markdownFiles.map(file => file.path));
let hasChanges = false;
// First, clean up highlights for files that no longer exist
for (const filePath of this.highlights.keys()) {
if (!existingFilePaths.has(filePath)) {
console.log(`Cleaning up highlights for deleted file: ${filePath}`);
this.highlights.delete(filePath);
hasChanges = true;
}
}
// Clean up orphaned highlight IDs from collections
for (const collection of this.collections.values()) {
const originalLength = collection.highlightIds.length;
collection.highlightIds = collection.highlightIds.filter(highlightId => {
// Check if this highlight still exists in any file
for (const [filePath, fileHighlights] of this.highlights) {
if (fileHighlights.some(h => h.id === highlightId)) {
return true; // Keep this highlight ID
}
}
console.log(`Removing orphaned highlight ${highlightId} from collection ${collection.name}`);
return false; // Remove this highlight ID
});
if (collection.highlightIds.length !== originalLength) {
hasChanges = true;
}
}
// Now scan existing files for highlights
for (const file of markdownFiles) {
try {
const content = await this.app.vault.read(file);
const oldHighlights = this.highlights.get(file.path) || [];
this.detectAndStoreMarkdownHighlights(content, file, false); // Don't refresh sidebar for each file
const newHighlights = this.highlights.get(file.path) || [];
// Check if any highlights were found or changed (more thorough than just count)
const oldHighlightsJSON = JSON.stringify(oldHighlights.map(h => ({id: h.id, text: h.text, start: h.startOffset, end: h.endOffset, footnotes: h.footnoteCount})));
const newHighlightsJSON = JSON.stringify(newHighlights.map(h => ({id: h.id, text: h.text, start: h.startOffset, end: h.endOffset, footnotes: h.footnoteCount})));
if (oldHighlightsJSON !== newHighlightsJSON) {
hasChanges = true;
if (newHighlights.length > oldHighlights.length) {
console.log(`Found ${newHighlights.length - oldHighlights.length} new highlights in ${file.path}`);
}
}
} catch (error) {
console.warn(`Failed to scan file ${file.path} for highlights:`, error);
}
}
// Save settings and refresh sidebar only once after scanning all files
if (hasChanges) {
console.log('Highlights changed during scan, saving settings and refreshing sidebar');
await this.saveSettings();
this.refreshSidebar();
}
}
detectAndStoreMarkdownHighlights(content: string, file: TFile, shouldRefresh: boolean = true) {
const markdownHighlightRegex = /==(.*?)==/g;
const newHighlights: Highlight[] = [];
let match;
const existingHighlightsForFile = this.highlights.get(file.path) || [];
const existingByTextAndOrder = new Map<string, {highlights: Highlight[], count: number}>();
existingHighlightsForFile.forEach(h => {
if (!existingByTextAndOrder.has(h.text)) {
existingByTextAndOrder.set(h.text, {highlights: [], count: 0});
}
existingByTextAndOrder.get(h.text)!.highlights.push(h);
});
// Extract all footnotes from the content
const footnoteMap = this.extractFootnotes(content);
while ((match = markdownHighlightRegex.exec(content)) !== null) {
const [, highlightText] = match;
const entry = existingByTextAndOrder.get(highlightText);
let existingHighlight: Highlight | undefined = undefined;
if (entry && entry.count < entry.highlights.length) {
existingHighlight = entry.highlights[entry.count];
entry.count++;
}
// Calculate line number from offset
const lineNumber = content.substring(0, match.index).split('\n').length - 1;
// Count footnotes immediately after the highlight (no spaces between footnotes)
const afterHighlight = content.substring(match.index + match[0].length);
const footnoteMatches = afterHighlight.match(/^(\[\^\w+\])+/);
// Extract footnote contents and filter out empty ones
let footnoteContents: string[] = [];
if (footnoteMatches) {
const footnoteRefs = footnoteMatches[0].match(/\[\^(\w+)\]/g) || [];
footnoteRefs.forEach(ref => {
const key = ref.slice(2, -1); // Remove [^ and ]
if (footnoteMap.has(key)) {
const fnContent = footnoteMap.get(key)!.trim();
if (fnContent) { // Only add non-empty content
footnoteContents.push(fnContent);
}
}
});
}
const footnoteCount = footnoteContents.length; // Count only non-empty footnotes
if (existingHighlight) {
newHighlights.push({
...existingHighlight,
line: lineNumber,
startOffset: match.index,
endOffset: match.index + match[0].length,
filePath: file.path, // ensure filePath is current
footnoteCount: footnoteCount,
footnoteContents: footnoteContents
});
} else {
newHighlights.push({
id: this.generateId(),
text: highlightText,
tags: [],
line: lineNumber,
startOffset: match.index,
endOffset: match.index + match[0].length,
filePath: file.path,
footnoteCount: footnoteCount,
footnoteContents: footnoteContents,
createdAt: Date.now()
});
}
}
// Check for actual changes before updating and refreshing
const oldHighlightsJSON = JSON.stringify(existingHighlightsForFile.map(h => ({id: h.id, start: h.startOffset, end: h.endOffset, text: h.text, footnotes: h.footnoteCount, contents: h.footnoteContents?.filter(c => c.trim() !== ''), color: h.color})));
const newHighlightsJSON = JSON.stringify(newHighlights.map(h => ({id: h.id, start: h.startOffset, end: h.endOffset, text: h.text, footnotes: h.footnoteCount, contents: h.footnoteContents?.filter(c => c.trim() !== ''), color: h.color})));
if (oldHighlightsJSON !== newHighlightsJSON) {
this.highlights.set(file.path, newHighlights);
if (shouldRefresh) {
this.saveSettings(); // Save to disk after detecting changes
this.refreshSidebar();
}
}
}
private extractFootnotes(content: string): Map<string, string> {
const footnoteMap = new Map<string, string>();
const footnoteRegex = /^\[\^(\w+)\]:\s*(.+)$/gm;
let match;
while ((match = footnoteRegex.exec(content)) !== null) {
const [, key, content] = match;
footnoteMap.set(key, content.trim());
}
return footnoteMap;
}
private async handleFileCreate(file: TFile) {
console.log(`New file created: ${file.path}`);
try {
// Read the content of the newly created file
const content = await this.app.vault.read(file);
// Scan for existing highlights in the new file
this.detectAndStoreMarkdownHighlights(content, file, false); // Don't refresh sidebar for each scan
// Get the highlights found
const highlights = this.highlights.get(file.path);
if (highlights && highlights.length > 0) {
console.log(`Found ${highlights.length} existing highlights in newly created file: ${file.path}`);
// Save settings and refresh sidebar since we found highlights
await this.saveSettings();
this.refreshSidebar();
}
} catch (error) {
console.warn(`Failed to scan newly created file ${file.path} for highlights:`, error);
}
}
async handleFileRename(file: TFile, oldPath: string) {
const oldHighlights = this.highlights.get(oldPath);
if (oldHighlights && oldHighlights.length > 0) {
// Update file paths in highlights
const updatedHighlights = oldHighlights.map(highlight => ({
...highlight,
filePath: file.path
}));
// Remove old path and add new path
this.highlights.delete(oldPath);
this.highlights.set(file.path, updatedHighlights);
// Save settings and refresh sidebar
await this.saveSettings();
this.refreshSidebar();
}
}
private handleFileDelete(file: TFile) {
console.log(`File deleted: ${file.path}`);
// Remove highlights for the deleted file
if (this.highlights.has(file.path)) {
console.log(`Removing ${this.highlights.get(file.path)?.length || 0} highlights for deleted file: ${file.path}`);
// Get the highlight IDs that will be removed
const deletedHighlightIds = new Set(
(this.highlights.get(file.path) || []).map(h => h.id)
);
// Remove the file's highlights
this.highlights.delete(file.path);
// Clean up collection references to these specific highlights
let collectionsModified = false;
for (const collection of this.collections.values()) {
const originalLength = collection.highlightIds.length;
collection.highlightIds = collection.highlightIds.filter(
highlightId => !deletedHighlightIds.has(highlightId)
);
if (collection.highlightIds.length !== originalLength) {
console.log(`Removed ${originalLength - collection.highlightIds.length} highlights from collection: ${collection.name}`);
collectionsModified = true;
}
}
this.saveSettings();
this.refreshSidebar();
if (collectionsModified) {
console.log('Collections were modified due to file deletion');
}
} else {
console.log(`No highlights found for deleted file: ${file.path}`);
}
}
getCurrentFileHighlights(): Highlight[] {
const file = this.app.workspace.getActiveFile();
return file ? this.highlights.get(file.path) || [] : [];
}
generateId(): string {
return Math.random().toString(36).substr(2, 9);
}
}
class HighlightSettingTab extends PluginSettingTab {
plugin: HighlightCommentsPlugin;
constructor(app: App, plugin: HighlightCommentsPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const { containerEl } = this;
containerEl.empty();
containerEl.createEl('h2', { text: 'Highlights Sidebar' });
containerEl.createEl('p', {
text: 'This plugin has no options to configure.',
attr: { style: 'color: var(--text-muted); margin-top: 16px;' }
});
}
}
class CollectionsManager {
private plugin: HighlightCommentsPlugin;
constructor(plugin: HighlightCommentsPlugin) {
this.plugin = plugin;
}
createCollection(name: string, description?: string): Collection {
const collection: Collection = {
id: this.plugin.generateId(),
name,
description,
highlightIds: [],
createdAt: Date.now()
};
this.plugin.collections.set(collection.id, collection);
this.plugin.saveSettings();
// Update dynamic commands after creating collection
this.plugin.registerCollectionCommands();
return collection;
}
deleteCollection(collectionId: string) {
// Store the collection name before deleting it
const collection = this.plugin.collections.get(collectionId);
if (collection) {
this.plugin.deletedCollectionNames.set(collectionId, collection.name);
}
this.plugin.collections.delete(collectionId);
this.plugin.saveSettings();
// Update dynamic commands to mark deleted collections
this.plugin.updateDeletedCollectionCommands();
}
async deleteCollectionWithConfirmation(collectionId: string): Promise<boolean> {
const collection = this.plugin.collections.get(collectionId);
if (!collection) return false;
const confirmed = confirm(`Are you sure you want to delete "${collection.name}"?`);
if (confirmed) {
this.deleteCollection(collectionId);
return true;
}
return false;
}
addHighlightToCollection(collectionId: string, highlightId: string) {
const collection = this.plugin.collections.get(collectionId);
if (collection && !collection.highlightIds.includes(highlightId)) {
collection.highlightIds.push(highlightId);
this.plugin.saveSettings();
}
}
removeHighlightFromCollection(collectionId: string, highlightId: string) {
const collection = this.plugin.collections.get(collectionId);
if (collection) {
collection.highlightIds = collection.highlightIds.filter(id => id !== highlightId);
this.plugin.saveSettings();
}
}
getAllCollections(): Collection[] {
return Array.from(this.plugin.collections.values());
}
getCollection(collectionId: string): Collection | undefined {
return this.plugin.collections.get(collectionId);
}
getCollectionStats(collectionId: string): { highlightCount: number; fileCount: number } {
const collection = this.plugin.collections.get(collectionId);
if (!collection) return { highlightCount: 0, fileCount: 0 };
const uniqueFiles = new Set<string>();
let highlightCount = 0;
for (const highlightId of collection.highlightIds) {
// Find the highlight across all files
for (const [filePath, highlights] of this.plugin.highlights) {
const highlight = highlights.find(h => h.id === highlightId);
if (highlight) {
uniqueFiles.add(filePath);
highlightCount++;
break; // Found the highlight, no need to check other files
}
}
}
return {
highlightCount,
fileCount: uniqueFiles.size
};
}
getHighlightsInCollection(collectionId: string): Highlight[] {
const collection = this.plugin.collections.get(collectionId);
if (!collection) return [];
const highlights: Highlight[] = [];
for (const highlightId of collection.highlightIds) {
// Find the highlight across all files
for (const [filePath, fileHighlights] of this.plugin.highlights) {
const highlight = fileHighlights.find(h => h.id === highlightId);
if (highlight) {
highlights.push(highlight);
break; // Found the highlight, no need to check other files
}
}
}
return highlights;
}
getHighlightCollectionCount(highlightId: string): number {
let collectionCount = 0;
for (const collection of this.plugin.collections.values()) {
if (collection.highlightIds.includes(highlightId)) {
collectionCount++;
}
}
return collectionCount;
}
}
export { CollectionsManager };

12
manifest.json
View file

@ -1,11 +1,11 @@
{
"id": "sample-plugin",
"name": "Sample Plugin",
"id": "obsidian-highlights-sidebar",
"name": "Highlights Sidebar",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Demonstrates some of the capabilities of the Obsidian API.",
"minAppVersion": "1.8.10",
"description": "A sidebar plugin for viewing and managing text highlights, highlight comments and highlight collections.",
"author": "Obsidian",
"authorUrl": "https://obsidian.md",
"fundingUrl": "https://obsidian.md/pricing",
"authorUrl": "https://www.linkedin.com/in/trevortarakjian/",
"fundingUrl": "https://buymeacoffee.com/trevware",
"isDesktopOnly": false
}

2397
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

237
src/managers/dropdown-manager.ts Normal file
View file

@ -0,0 +1,237 @@
import { setIcon } from 'obsidian';
export interface DropdownItem {
id?: string;
text: string;
icon?: string;
checked?: boolean;
className?: string;
onClick: () => void;
}
export interface DropdownOptions {
className?: string;
position: 'below' | 'above';
}
export class DropdownManager {
private activeDropdown: HTMLElement | null = null;
private documentClickHandlers: Array<(e: MouseEvent) => void> = [];
private isOpen: boolean = false;
private checkboxElements: Map<string, { element: HTMLElement, checkDiv: HTMLElement }> = new Map();
private activeItems: DropdownItem[] = [];
isDropdownOpen(): boolean {
return this.isOpen;
}
closeActiveDropdown(): void {
if (this.activeDropdown && this.activeDropdown.parentNode) {
this.activeDropdown.parentNode.removeChild(this.activeDropdown);
}
this.activeDropdown = null;
this.isOpen = false;
this.checkboxElements.clear();
this.activeItems = [];
// Clean up event listeners
this.documentClickHandlers.forEach(handler => {
document.removeEventListener('click', handler);
});
this.documentClickHandlers = [];
}
showDropdown(
triggerElement: HTMLElement,
items: DropdownItem[],
options: DropdownOptions = { position: 'below' }
): void {
// Close existing dropdown if open
if (this.isOpen) {
this.closeActiveDropdown();
return;
}
const buttonRect = triggerElement.getBoundingClientRect();
// Create dropdown
const dropdown = document.createElement('div');
dropdown.className = `menu highlights-dropdown-menu ${options.className || ''}`;
dropdown.classList.add('dropdown-positioned');
this.activeDropdown = dropdown;
this.isOpen = true;
this.activeItems = [...items]; // Store copy of items
// Add items
items.forEach((item, index) => {
const element = document.createElement('div');
element.className = `menu-item ${item.className || 'highlights-dropdown-item'}`;
if (item.checked !== undefined) {
// Add checkbox for checkable items
const checkDiv = document.createElement('div');
checkDiv.className = 'highlights-dropdown-check';
if (item.checked) {
setIcon(checkDiv, 'check');
element.classList.add('is-checked');
}
element.appendChild(checkDiv);
// Store reference for updates - use index if no ID
const itemKey = item.id || `item-${index}`;
this.checkboxElements.set(itemKey, { element, checkDiv });
} else if (item.icon) {
// Add icon for non-checkable items
const iconDiv = document.createElement('div');
iconDiv.className = 'menu-item-icon';
setIcon(iconDiv, item.icon);
element.appendChild(iconDiv);
}
const label = document.createElement('span');
label.textContent = item.text;
element.appendChild(label);
element.addEventListener('click', (e) => {
e.preventDefault();
e.stopPropagation();
// Call the original onClick
item.onClick();
// Update checkbox state if this is a checkable item
if (item.checked !== undefined) {
const itemKey = item.id || `item-${index}`;
const newCheckedState = !item.checked;
// Update the stored item state
this.activeItems[index].checked = newCheckedState;
// Update visual state
this.updateCheckboxState(itemKey, newCheckedState);
// Check if we should close the dropdown
this.checkShouldAutoClose();
}
});
dropdown.appendChild(element);
});
// Add to document temporarily to measure
document.body.appendChild(dropdown);
// Get dropdown dimensions
const dropdownRect = dropdown.getBoundingClientRect();
const dropdownHeight = dropdownRect.height;
const dropdownWidth = dropdownRect.width;
// Calculate available space
const viewportHeight = window.innerHeight;
const viewportWidth = window.innerWidth;
const spaceBelow = viewportHeight - buttonRect.bottom;
const spaceAbove = buttonRect.top;
// Determine optimal position
let top: number;
let left: number;
// Check if dropdown fits below the button (with 8px buffer)
if (spaceBelow >= dropdownHeight + 8) {
// Position below
top = buttonRect.bottom + 4;
} else if (spaceAbove >= dropdownHeight + 8) {
// Position above
top = buttonRect.top - dropdownHeight - 4;
} else {
// Not enough space in either direction, choose the side with more space
if (spaceBelow > spaceAbove) {
// Position below but constrain height
top = buttonRect.bottom + 4;
dropdown.style.maxHeight = `${spaceBelow - 8}px`;
dropdown.style.overflowY = 'auto';
} else {
// Position above but constrain height
top = 8; // Leave 8px from top of viewport
dropdown.style.maxHeight = `${buttonRect.top - 12}px`;
dropdown.style.overflowY = 'auto';
}
}
// Check horizontal positioning
left = buttonRect.left;
if (left + dropdownWidth > viewportWidth - 8) {
// Dropdown would go off right edge, align right edge with button right edge
left = Math.max(8, buttonRect.right - dropdownWidth);
}
// Position dropdown
dropdown.style.setProperty('--dropdown-left', `${left}px`);
dropdown.style.setProperty('--dropdown-top', `${top}px`);
dropdown.style.setProperty('--dropdown-right', `${buttonRect.right}px`);
dropdown.style.setProperty('--dropdown-button-top', `${buttonRect.top}px`);
// Set up click outside handler
const closeHandler = (e: MouseEvent) => {
if (!dropdown.contains(e.target as Node) && !triggerElement.contains(e.target as Node)) {
this.closeActiveDropdown();
}
};
this.documentClickHandlers.push(closeHandler);
setTimeout(() => {
document.addEventListener('click', closeHandler);
}, 100);
}
private updateCheckboxState(itemKey: string, checked: boolean): void {
const checkboxInfo = this.checkboxElements.get(itemKey);
if (!checkboxInfo) return;
const { element, checkDiv } = checkboxInfo;
if (checked) {
setIcon(checkDiv, 'check');
element.classList.add('is-checked');
} else {
checkDiv.innerHTML = '';
element.classList.remove('is-checked');
}
}
private checkShouldAutoClose(): void {
// Check if any checkable items are still checked
const hasCheckedItems = this.activeItems.some(item =>
item.checked !== undefined && item.checked === true
);
// Close dropdown if no items are checked
if (!hasCheckedItems) {
setTimeout(() => {
this.closeActiveDropdown();
}, 100);
}
}
updateAllCheckboxStates(newStates: { [key: string]: boolean }): void {
// Update stored item states
this.activeItems.forEach((item, index) => {
if (item.checked !== undefined) {
const itemKey = item.id || `item-${index}`;
if (newStates.hasOwnProperty(itemKey)) {
item.checked = newStates[itemKey];
this.updateCheckboxState(itemKey, newStates[itemKey]);
}
}
});
// Check if dropdown should close
this.checkShouldAutoClose();
}
cleanup(): void {
this.closeActiveDropdown();
}
}

176
src/modals/collection-modals.ts Normal file
View file

@ -0,0 +1,176 @@
import { Modal, Setting, App, Notice } from 'obsidian';
import type { Collection } from '../../main';
export class NewCollectionModal extends Modal {
private nameInput: HTMLInputElement;
private descriptionInput: HTMLInputElement;
private onSubmit: (name: string, description: string) => void;
constructor(app: App, onSubmit: (name: string, description: string) => void) {
super(app);
this.onSubmit = onSubmit;
}
onOpen() {
const { contentEl } = this;
contentEl.empty();
contentEl.createEl('h3', { text: 'Create a New Collection' });
new Setting(contentEl)
.setName('Collection Name')
.setDesc('The name of your collection (Required)')
.addText(text => {
this.nameInput = text.inputEl;
text.setPlaceholder('Important Highlights')
.onChange(value => {
// Enable/disable submit based on name presence
const submitBtn = contentEl.querySelector('.mod-cta') as HTMLButtonElement;
if (submitBtn) {
submitBtn.disabled = !value.trim();
}
});
// Focus the name input
setTimeout(() => text.inputEl.focus(), 100);
});
new Setting(contentEl)
.setName('Collection Description')
.setDesc('Provide more context about the collection (Optional)')
.addText(text => {
this.descriptionInput = text.inputEl;
text.setPlaceholder('Research, etc.');
});
// Buttons
const buttonContainer = contentEl.createDiv({ cls: 'modal-button-container' });
const cancelBtn = buttonContainer.createEl('button', { text: 'Cancel' });
cancelBtn.addEventListener('click', () => this.close());
const submitBtn = buttonContainer.createEl('button', {
text: 'Create Collection',
cls: 'mod-cta'
});
submitBtn.disabled = true; // Start disabled
submitBtn.addEventListener('click', () => this.handleSubmit());
// Handle Enter key
contentEl.addEventListener('keydown', (e) => {
if (e.key === 'Enter' && (e.ctrlKey || e.metaKey)) {
this.handleSubmit();
} else if (e.key === 'Escape') {
this.close();
}
});
}
private handleSubmit() {
const name = this.nameInput.value.trim();
const description = this.descriptionInput.value.trim();
if (!name) {
new Notice('Collection name is required');
this.nameInput.focus();
return;
}
this.onSubmit(name, description);
this.close();
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
export class EditCollectionModal extends Modal {
private nameInput: HTMLInputElement;
private descriptionInput: HTMLInputElement;
private onSubmit: (name: string, description: string) => void;
private collection: Collection;
constructor(app: App, collection: Collection, onSubmit: (name: string, description: string) => void) {
super(app);
this.collection = collection;
this.onSubmit = onSubmit;
}
onOpen() {
const { contentEl } = this;
contentEl.empty();
contentEl.createEl('h3', { text: 'Edit Collection' });
new Setting(contentEl)
.setName('Collection Name')
.setDesc('The name of your collection (Required)')
.addText(text => {
this.nameInput = text.inputEl;
text.setPlaceholder('Important Highlights')
.setValue(this.collection.name)
.onChange(value => {
// Enable/disable submit based on name presence
const submitBtn = contentEl.querySelector('.mod-cta') as HTMLButtonElement;
if (submitBtn) {
submitBtn.disabled = !value.trim();
}
});
// Focus the name input
setTimeout(() => {
text.inputEl.focus();
text.inputEl.select();
}, 100);
});
new Setting(contentEl)
.setName('Collection Description')
.setDesc('Provide more context about the collection (Optional)')
.addText(text => {
this.descriptionInput = text.inputEl;
text.setPlaceholder('Research, etc.')
.setValue(this.collection.description || '');
});
// Buttons
const buttonContainer = contentEl.createDiv({ cls: 'modal-button-container' });
const cancelBtn = buttonContainer.createEl('button', { text: 'Cancel' });
cancelBtn.addEventListener('click', () => this.close());
const submitBtn = buttonContainer.createEl('button', {
text: 'Save Changes',
cls: 'mod-cta'
});
submitBtn.addEventListener('click', () => this.handleSubmit());
// Handle Enter key
contentEl.addEventListener('keydown', (e) => {
if (e.key === 'Enter' && (e.ctrlKey || e.metaKey)) {
this.handleSubmit();
} else if (e.key === 'Escape') {
this.close();
}
});
}
private handleSubmit() {
const name = this.nameInput.value.trim();
const description = this.descriptionInput.value.trim();
if (!name) {
new Notice('Collection name is required');
this.nameInput.focus();
return;
}
this.onSubmit(name, description);
this.close();
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}

365
src/renderers/highlight-renderer.ts Normal file
View file

@ -0,0 +1,365 @@
import { setIcon } from 'obsidian';
import type { Highlight } from '../../main';
import type HighlightCommentsPlugin from '../../main';
export interface HighlightRenderOptions {
searchTerm?: string;
showFilename?: boolean;
isCommentsVisible?: boolean;
isColorPickerVisible?: boolean;
onCommentToggle?: (highlightId: string) => void;
onCollectionsMenu?: (event: MouseEvent, highlight: Highlight) => void;
onColorPickerToggle?: (highlightId: string) => void;
onColorChange?: (highlight: Highlight, color: string) => void;
onHighlightClick?: (highlight: Highlight) => void;
onAddComment?: (highlight: Highlight) => void;
onCommentClick?: (highlight: Highlight, commentIndex: number) => void;
onTagClick?: (tag: string) => void;
onFileNameClick?: (filePath: string) => void;
}
export class HighlightRenderer {
constructor(private plugin: HighlightCommentsPlugin) {}
createHighlightItem(
container: HTMLElement,
highlight: Highlight,
options: HighlightRenderOptions = {}
): HTMLElement {
const item = container.createDiv({
cls: `highlight-item-card${this.plugin.selectedHighlightId === highlight.id ? ' selected' : ''}`,
attr: { 'data-highlight-id': highlight.id }
});
this.applyHighlightStyling(item, highlight);
this.createHoverColorPicker(item, highlight, options);
this.createQuoteSection(item, highlight, options);
this.createActionsSection(item, highlight, options);
this.createCommentsSection(item, highlight, options);
this.createColorPickerSection(item, highlight, options);
return item;
}
private applyHighlightStyling(item: HTMLElement, highlight: Highlight): void {
const highlightColor = highlight.color || this.plugin.settings.highlightColor;
item.style.setProperty('--highlight-border-color', highlightColor);
if (this.plugin.selectedHighlightId === highlight.id) {
item.style.setProperty('--highlight-selection-color', highlightColor);
item.classList.add('highlight-selected');
}
}
private createQuoteSection(item: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
const quoteEl = item.createDiv({ cls: 'highlight-quote' });
const renderedText = this.renderMarkdown(highlight.text);
quoteEl.innerHTML = renderedText;
if (options.searchTerm && options.searchTerm.length > 0) {
this.highlightSearchMatches(quoteEl, options.searchTerm);
}
this.addTagsToQuote(quoteEl, highlight, options);
quoteEl.addEventListener('click', () => {
options.onHighlightClick?.(highlight);
});
}
private addTagsToQuote(quoteEl: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
const tags = this.extractTagsFromHighlight(highlight);
if (tags.length > 0) {
const tagsContainer = quoteEl.createDiv({ cls: 'highlight-tags' });
tags.forEach(tag => {
const tagEl = tagsContainer.createEl('span', {
cls: 'highlight-tag',
text: tag
});
tagEl.addEventListener('click', (event) => {
event.stopPropagation();
options.onTagClick?.(tag);
});
});
}
}
private createActionsSection(item: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
const actions = item.createDiv({ cls: 'highlight-actions' });
const infoContainer = actions.createDiv();
this.addFileNameInfo(infoContainer, highlight, options);
this.addStatsInfo(infoContainer, highlight, options);
this.addActionButtons(actions, highlight, options);
this.addTimestamp(actions, highlight);
}
private addFileNameInfo(infoContainer: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
if (options.showFilename) {
const fileName = highlight.filePath.split('/').pop()?.replace(/\.md$/, '') || highlight.filePath;
const fileNameEl = infoContainer.createEl('small', {
cls: 'highlight-filename',
text: fileName,
attr: { title: highlight.filePath }
});
fileNameEl.addEventListener('click', (event) => {
event.stopPropagation();
options.onFileNameClick?.(highlight.filePath);
});
}
}
private addStatsInfo(infoContainer: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
const lineNumber = highlight.line >= 0 ? highlight.line + 1 : 'Unknown';
const infoLineContainer = infoContainer.createEl('small', { cls: 'highlight-info-line' });
// Line number section
this.createInfoItem(infoLineContainer, 'text', `${lineNumber}`, 'highlight-line-info');
// Comment count section
const validFootnoteCount = highlight.footnoteContents?.filter(c => c.trim() !== '').length || 0;
const commentContainer = this.createInfoItem(
infoLineContainer,
'message-square',
`${validFootnoteCount}`,
'highlight-line-info highlight-comment-stat clickable'
);
commentContainer.addEventListener('click', (event) => {
event.stopPropagation();
options.onCommentToggle?.(highlight.id);
});
// Collection count section
const collectionCount = this.plugin.collectionsManager.getHighlightCollectionCount(highlight.id);
const collectionContainer = this.createInfoItem(
infoLineContainer,
'folder-open',
`${collectionCount}`,
'highlight-line-info highlight-collection-stat clickable'
);
collectionContainer.addEventListener('click', (event) => {
event.stopPropagation();
options.onCollectionsMenu?.(event, highlight);
});
}
private createInfoItem(container: HTMLElement, iconName: string, text: string, className: string): HTMLElement {
const itemContainer = container.createDiv({ cls: className });
const icon = itemContainer.createDiv({ cls: iconName === 'message-square' ? 'comment-icon' : 'line-icon' });
setIcon(icon, iconName);
itemContainer.createSpan({ text });
return itemContainer;
}
private addActionButtons(actions: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
const buttonContainer = actions.createDiv({ cls: 'comment-buttons' });
}
private addTimestamp(actions: HTMLElement, highlight: Highlight): void {
if (highlight.createdAt) {
const timestamp = new Date(highlight.createdAt);
const timeString = timestamp.toLocaleString();
const timestampEl = actions.createEl('small', {
cls: 'highlight-timestamp',
text: timeString,
attr: { title: `Created: ${timeString}` }
});
}
}
private createCommentsSection(item: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
if (!options.isCommentsVisible) return;
const commentsContainer = item.createDiv({ cls: 'highlight-comments' });
// Add existing comments
const validFootnoteContents = highlight.footnoteContents?.filter(c => c.trim() !== '') || [];
if (validFootnoteContents.length > 0) {
validFootnoteContents.forEach((content, index) => {
const commentDiv = commentsContainer.createDiv({ cls: 'highlight-comment' });
const renderedComment = this.renderMarkdown(content);
commentDiv.innerHTML = renderedComment;
commentDiv.addEventListener('click', (event) => {
event.stopPropagation();
options.onCommentClick?.(highlight, index);
});
});
}
// Add "Add Comment" line
this.createAddCommentLine(commentsContainer, highlight, options);
}
private createAddCommentLine(commentsContainer: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
const addCommentLine = commentsContainer.createDiv({
cls: 'highlight-add-comment-line'
});
const plusIcon = addCommentLine.createDiv({ cls: 'highlight-add-comment-icon' });
setIcon(plusIcon, 'plus');
addCommentLine.createSpan({ text: 'Add Comment' });
addCommentLine.addEventListener('click', (event) => {
event.stopPropagation();
options.onAddComment?.(highlight);
});
}
private createColorPickerSection(item: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
if (!options.isColorPickerVisible) return;
const colorPickerContainer = item.createDiv({ cls: 'highlight-color-picker' });
const colorOptionsContainer = colorPickerContainer.createDiv({ cls: 'color-picker-options' });
const colors = ['#ffd700', '#ff6b6b', '#4ecdc4', '#45b7d1', '#96ceb4'];
colors.forEach(color => {
const colorOption = colorOptionsContainer.createDiv({
cls: 'color-option',
attr: { 'data-color': color }
});
colorOption.addEventListener('click', (event) => {
event.stopPropagation();
options.onColorChange?.(highlight, color);
});
});
}
private highlightSearchMatches(element: HTMLElement, searchTerm: string): void {
if (!searchTerm) return;
const escapedSearchTerm = searchTerm.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
const regex = new RegExp(escapedSearchTerm, 'gi');
const walker = document.createTreeWalker(element, NodeFilter.SHOW_TEXT, null);
let node;
const nodesToProcess: Text[] = [];
while (node = walker.nextNode()) {
if (node.nodeValue && node.nodeValue.trim() !== '' &&
!(node.parentElement && node.parentElement.classList.contains('search-term-highlight'))) {
nodesToProcess.push(node as Text);
}
}
nodesToProcess.forEach(textNode => {
const text = textNode.nodeValue!;
const newNodes: Node[] = [];
let lastIndex = 0;
let match;
while ((match = regex.exec(text)) !== null) {
if (match.index > lastIndex) {
newNodes.push(document.createTextNode(text.substring(lastIndex, match.index)));
}
const span = document.createElement('span');
span.className = 'search-term-highlight';
span.textContent = match[0];
newNodes.push(span);
lastIndex = regex.lastIndex;
}
if (lastIndex < text.length) {
newNodes.push(document.createTextNode(text.substring(lastIndex)));
}
if (newNodes.length > 0 && textNode.parentNode) {
newNodes.forEach(newNode => textNode.parentNode!.insertBefore(newNode, textNode));
textNode.parentNode!.removeChild(textNode);
}
});
}
private renderMarkdown(text: string): string {
let escaped = text
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;')
.replace(/'/g, '&#x27;');
return escaped
.replace(/\*\*(.*?)\*\*/g, '<strong>$1</strong>')
.replace(/__(.*?)__/g, '<strong>$1</strong>')
.replace(/(?<!\*)\*([^*]+?)\*(?!\*)/g, '<em>$1</em>')
.replace(/(?<!_)_([^_]+?)_(?!_)/g, '<em>$1</em>')
.replace(/`([^`]+?)`/g, '<code>$1</code>')
.replace(/~~(.*?)~~/g, '<del>$1</del>')
.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '<a href="$2" target="_blank">$1</a>');
}
private extractTagsFromHighlight(highlight: Highlight): string[] {
const tags: string[] = [];
if (highlight.footnoteContents) {
for (const content of highlight.footnoteContents) {
if (content.trim() !== '') {
const tagMatches = content.match(/#[\w-]+/g);
if (tagMatches) {
tagMatches.forEach(tag => {
const tagName = tag.substring(1);
if (!tags.includes(tagName)) {
tags.push(tagName);
}
});
}
}
}
}
return tags;
}
private createHoverColorPicker(item: HTMLElement, highlight: Highlight, options: HighlightRenderOptions): void {
// Create a hover zone for the left border area
const hoverZone = item.createDiv({ cls: 'highlight-border-hover-zone' });
const hoverColorPicker = item.createDiv({ cls: 'hover-color-picker' });
const colorOptionsContainer = hoverColorPicker.createDiv({ cls: 'hover-color-options' });
const colors = ['#ffd700', '#ff6b6b', '#4ecdc4', '#45b7d1', '#96ceb4'];
colors.forEach((color, index) => {
const colorOption = colorOptionsContainer.createDiv({
cls: 'hover-color-option',
attr: {
'data-color': color,
'style': `--option-index: ${index}`
}
});
colorOption.addEventListener('click', (event) => {
event.stopPropagation();
options.onColorChange?.(highlight, color);
});
});
// Add hover events only to the left border hover zone
let hoverTimeout: NodeJS.Timeout;
const showColorPicker = () => {
hoverTimeout = setTimeout(() => {
hoverColorPicker.classList.add('visible');
}, 500); // Longer delay as requested
};
const hideColorPicker = () => {
clearTimeout(hoverTimeout);
hoverColorPicker.classList.remove('visible');
};
// Hover zone events
hoverZone.addEventListener('mouseenter', showColorPicker);
hoverZone.addEventListener('mouseleave', hideColorPicker);
// Color picker events (keep visible when hovering over the picker itself)
hoverColorPicker.addEventListener('mouseenter', () => {
clearTimeout(hoverTimeout);
hoverColorPicker.classList.add('visible');
});
hoverColorPicker.addEventListener('mouseleave', hideColorPicker);
}
}

1815
src/views/sidebar-view.ts Normal file
View file

File diff suppressed because it is too large Load diff

1133
styles.css
View file

File diff suppressed because it is too large Load diff