obsidian-plugin/edems-dev_md-discord-syntax
1
0
Fork 0
mirror of https://github.com/edems-dev/md-discord-syntax.git synced 2026-07-22 08:37:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

init(obsidian-plugin)

Browse source
This commit is contained in:
Edems 2026-07-21 15:57:29 +02:00
commit 550096494b
18 changed files with 3352 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
.github/workflows/release.yml vendored Normal file
View file

@ -0,0 +1,38 @@
name: Release Obsidian Plugin
on:
push:
tags:
- 'v*'
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
- name: Install dependencies
run: npm ci
- name: Run tests & build
run: |
npm run test
npm run build
- name: Create Release
uses: softprops/action-gh-release@v2
with:
files: |
main.js
manifest.json
styles.css
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

6
.gitignore vendored Normal file
View file

@ -0,0 +1,6 @@
node_modules/
dist/
main.js
styles.css
*.tsbuildinfo
.DS_Store

1
.npmrc Normal file
View file

@ -0,0 +1 @@
legacy-peer-deps=true

622
LICENSE Normal file
View file

@ -0,0 +1,622 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2026 Edems-DEV
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
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 give the recipients all the rights that
you have. 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 avoid the waiver of freedom for
such 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 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 stated exception to this License; 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 prior 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 any party receiving the
covered work authorizing them to use, propagate, modify or convey the
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 cannot convey a covered work if you
are a party to an agreement 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 agreement, 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 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 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

73
README.md Normal file
View file

@ -0,0 +1,73 @@
# Discord Syntax for Obsidian
A native Obsidian plugin that brings Discord-style Markdown formatting to your notes in both **Reading View** and **Live Preview**.
## Features
- **Spoiler Syntax (`||spoiler text||`)**: Mask confidential or secret content behind a dark spoiler block. Click or press `Enter`/`Space` to reveal, click again to edit.
- **Subtext Syntax (`-# subtext`)**: Render small, muted secondary text lines at physical line starts.
- **Toggle Spoilers Command**: Trigger `Discord Syntax: Toggle all spoilers in active note` to expand or conceal all spoilers in the current note at once.
## Usage & Examples
### 1. Spoilers
Wrap any text in double vertical bars `||`:
```markdown
Here is a normal sentence with a ||secret spoiler|| inside it.
```
- **Reading View**: Renders as a spoiler block. Click to reveal.
- **Live Preview**: Automatically hides `||` delimiters and masks text when the cursor is off the spoiler. Clicking or navigating into the spoiler reveals its content and enables editing.
### 2. Subtext Lines
Start any line with `-# ` at column 0:
```markdown
This is normal paragraph text.
-# This line will be rendered as small, muted subtext.
```
- **Reading View**: Renders as smaller, muted subtext without modifying your source markdown file.
- **Live Preview**: When your cursor is on another line, `-# ` is hidden and the line is styled as subtext. When you move your cursor onto the subtext line, the `-# ` prefix appears faintly so you can edit it naturally.
---
## Installation
### Manual Installation
1. Download `main.js`, `manifest.json`, and `styles.css` from the latest GitHub Release.
2. Create a folder named `discord-syntax` inside your vault's `.obsidian/plugins/` directory:
`<vault>/.obsidian/plugins/discord-syntax/`
3. Copy `main.js`, `manifest.json`, and `styles.css` into that folder.
4. Reload Obsidian and enable **Discord Syntax** in **Settings > Community plugins**.
---
## Development
```bash
# Install dependencies
npm install
# Run tests
npm run test
# Type check
npm run typecheck
# Build release assets (main.js and styles.css)
npm run build
# Development watch mode
npm run dev
```
---
## License
This project is licensed under the [GNU General Public License v3.0](LICENSE).

88
esbuild.config.mjs Normal file
View file

@ -0,0 +1,88 @@
import esbuild from 'esbuild'
import process from 'process'
import fs from 'fs/promises'
import path from 'path'
import { fileURLToPath } from 'url'
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const isWatch = process.argv.includes('--watch')
async function copyReleaseAssets() {
try {
const stylesCssSrc = path.join(__dirname, 'src/styles.css')
const stylesCssDest = path.join(__dirname, 'styles.css')
if (await fs.stat(stylesCssSrc).catch(() => false)) {
await fs.copyFile(stylesCssSrc, stylesCssDest)
}
} catch (e) {
console.error('❌ Release asset copy failed:', e.message)
}
}
const checkExternalPlugin = {
name: 'check-external-plugin',
setup(build) {
build.onEnd(async (result) => {
if (result.errors.length === 0) {
try {
const mainJs = await fs.readFile(path.join(__dirname, 'main.js'), 'utf8')
const cmModuleRegex = /require\(\s*['"]@codemirror\/(?:state|view|language)['"]\s*\)/
if (!cmModuleRegex.test(mainJs)) {
console.error('❌ REGRESSION: CodeMirror runtime modules (state/view/language) are bundled instead of externalized!')
process.exit(1)
}
} catch (e) {
console.error('❌ Failed to verify bundle:', e.message)
}
await copyReleaseAssets()
}
})
}
}
const banner = `/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
If you want to view the source, please visit the github repository of this plugin
*/
`
const context = await esbuild.context({
entryPoints: ['src/main.ts'],
bundle: true,
external: [
'obsidian',
'electron',
'@codemirror/autocomplete',
'@codemirror/collab',
'@codemirror/commands',
'@codemirror/language',
'@codemirror/lint',
'@codemirror/search',
'@codemirror/state',
'@codemirror/view',
'@lezer/common',
'@lezer/highlight',
'@lezer/lr'
],
format: 'cjs',
target: 'es2020',
logLevel: 'info',
sourcemap: isWatch ? 'inline' : false,
treeShaking: true,
outfile: 'main.js',
banner: { js: banner },
define: {
'process.env.NODE_ENV': JSON.stringify(isWatch ? 'development' : 'production')
},
plugins: [checkExternalPlugin]
})
if (isWatch) {
console.log('⚡ Watching JS & CSS...')
await context.watch()
} else {
await context.rebuild()
await context.dispose()
}

10
manifest.json Normal file
View file

@ -0,0 +1,10 @@
{
"id": "discord-syntax",
"name": "Discord Syntax",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Discord-style spoiler blocks (||spoiler||) and subtext lines (-# subtext) for Obsidian Reading View and Live Preview.",
"author": "Edems-DEV",
"authorUrl": "https://github.com/Edems-DEV",
"isDesktopOnly": false
}

1147
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

31
package.json Normal file
View file

@ -0,0 +1,31 @@
{
"name": "obsidian-discord-syntax",
"version": "1.0.0",
"description": "Discord-style spoiler and subtext formatting for Obsidian",
"main": "main.js",
"scripts": {
"build": "node esbuild.config.mjs",
"dev": "node esbuild.config.mjs --watch",
"test": "npx tsx --test src/*.test.ts",
"typecheck": "tsc --noEmit"
},
"keywords": [
"obsidian",
"obsidian-plugin",
"discord",
"spoiler",
"subtext"
],
"author": "Edems-DEV",
"license": "GPL-3.0",
"devDependencies": {
"@codemirror/language": "^6.10.0",
"@codemirror/state": "^6.4.0",
"@codemirror/view": "^6.23.0",
"@types/node": "^20.11.0",
"esbuild": "^0.21.5",
"obsidian": "^1.5.0",
"tsx": "^4.19.0",
"typescript": "^5.5.4"
}
}

124
src/main.ts Normal file
View file

@ -0,0 +1,124 @@
import { Plugin, MarkdownView } from 'obsidian'
import { EditorView } from '@codemirror/view'
import { processSpoilers } from './spoiler-post-processor'
import {
spoilerLivePreviewExtension,
findSpoilerRanges,
getSpoilerState,
setSpoilerStateEffect,
} from './spoiler-detector'
import { processSubtextParagraph } from './subtext-post-processor'
import { subtextEditorPlugin } from './subtext-live-preview'
interface ObsidianEditor {
cm?: EditorView
}
interface MarkdownPreviewView {
containerEl?: HTMLElement
}
export default class DiscordSyntaxPlugin extends Plugin {
async onload() {
// ── Reading View Post Processor ──────────────────────────────────────
this.registerMarkdownPostProcessor((element, _context) => {
element.querySelectorAll('p').forEach((p) => {
processSubtextParagraph(p as HTMLElement)
})
processSpoilers(element, window.document)
})
// ── Live Preview Extensions ──────────────────────────────────────────
this.registerEditorExtension(subtextEditorPlugin)
this.registerEditorExtension(spoilerLivePreviewExtension)
// ── Commands ─────────────────────────────────────────────────────────
this.addCommand({
id: 'toggle-all-spoilers',
name: 'Toggle all spoilers in active note',
callback: () => {
const activeView = this.app.workspace.getActiveViewOfType(MarkdownView)
if (!activeView) return
const mode = activeView.getMode()
if (mode === 'preview') {
const preview = activeView.previewMode as unknown as MarkdownPreviewView
const container = preview?.containerEl
if (!container) return
const spoilers = container.querySelectorAll('.note-flow-spoiler, .discord-syntax-spoiler')
if (spoilers.length === 0) return
let anyHidden = false
for (let i = 0; i < spoilers.length; i++) {
if (!spoilers[i].classList.contains('is-revealed')) {
anyHidden = true
break
}
}
const targetReveal = anyHidden
for (let i = 0; i < spoilers.length; i++) {
const el = spoilers[i] as HTMLElement
const inner = el.firstElementChild as HTMLElement | null
if (targetReveal) {
el.classList.add('is-revealed')
el.setAttribute('aria-expanded', 'true')
el.removeAttribute('aria-label')
if (inner) inner.setAttribute('aria-hidden', 'false')
} else {
el.classList.remove('is-revealed')
el.setAttribute('aria-expanded', 'false')
el.setAttribute('aria-label', 'Spoiler, click to reveal')
if (inner) inner.setAttribute('aria-hidden', 'true')
}
}
} else if (mode === 'source') {
const editor = activeView.editor as unknown as ObsidianEditor
const cm = editor.cm
if (!cm || !(cm instanceof EditorView) || typeof cm.dispatch !== 'function') return
const state = cm.state
const text = state.doc.toString()
const spoilers = findSpoilerRanges(text)
if (spoilers.length === 0) return
let anyHidden = false
for (const s of spoilers) {
const sState = getSpoilerState(state, s.from, s.to)
if (sState === 'hidden') {
anyHidden = true
break
}
}
const targetState = anyHidden ? 'revealed' : 'hidden'
const effects = spoilers.map((s) =>
setSpoilerStateEffect.of({
from: s.from,
to: s.to,
state: targetState,
})
)
let newSelection: { anchor: number } | undefined
if (state.selection.main.empty) {
const pos = state.selection.main.head
for (const s of spoilers) {
if (pos >= s.from && pos <= s.to) {
newSelection = { anchor: s.to }
break
}
}
}
cm.dispatch({
effects,
selection: newSelection ? { anchor: newSelection.anchor } : undefined,
})
}
},
})
}
onunload() {}
}

620
src/spoiler-detector.ts Normal file
View file

@ -0,0 +1,620 @@
import { ViewPlugin, ViewUpdate, EditorView, Decoration, DecorationSet } from '@codemirror/view';
import { RangeSetBuilder, EditorState, StateField, StateEffect } from '@codemirror/state';
import { syntaxTree } from '@codemirror/language';
export type SpoilerState = 'hidden' | 'revealed' | 'editing';
export interface SpoilerStateEntry {
from: number;
to: number;
state: SpoilerState;
}
export const setSpoilerStateEffect = StateEffect.define<{
from: number;
to: number;
state: SpoilerState;
}>();
export const spoilerStateField = StateField.define<SpoilerStateEntry[]>({
create() {
return [];
},
update(value, tr) {
let mapped = value.map(entry => {
const from = tr.changes.mapPos(entry.from, 1);
const to = tr.changes.mapPos(entry.to, -1);
return { ...entry, from, to };
});
for (const effect of tr.effects) {
if (effect.is(setSpoilerStateEffect)) {
const { from, to, state } = effect.value;
mapped = mapped.filter(entry => !(entry.from === from && entry.to === to));
if (state !== 'hidden') {
mapped.push({ from, to, state });
}
}
}
return mapped;
}
});
export function getSpoilerState(state: EditorState, from: number, to: number): SpoilerState {
const entries = state.field(spoilerStateField, false) || [];
const match = entries.find(e => e.from === from && e.to === to);
if (match) return match.state;
const overlap = entries.find(e => Math.max(e.from, from) < Math.min(e.to, to));
if (overlap) return overlap.state;
return 'hidden';
}
export function getSpoilerAtSelection(state: EditorState): SpoilerRange | null {
const selection = state.selection;
if (!selection.main.empty) return null;
const pos = selection.main.head;
const text = state.doc.toString();
const spoilers = findSpoilerRanges(text);
for (const s of spoilers) {
if (pos >= s.from && pos <= s.to) {
return s;
}
}
return null;
}
export interface SpoilerRange {
from: number;
to: number;
contentFrom: number;
contentTo: number;
}
export interface SpoilerFragment {
from: number;
to: number;
isStart: boolean;
isEnd: boolean;
classes: string;
}
export function findSpoilerRanges(text: string, baseOffset = 0): SpoilerRange[] {
const spoilers: SpoilerRange[] = [];
if (!text || text.length < 5) return spoilers;
// 1. Identify fenced code block ranges
const codeRanges: { from: number; to: number }[] = [];
const lines = text.split('\n');
let currentOffset = 0;
let inFence = false;
let fenceChar = '';
let fenceLen = 0;
let fenceStart = 0;
for (let i = 0; i < lines.length; i++) {
const line = lines[i];
const lineStart = currentOffset;
const lineEnd = currentOffset + line.length;
const fenceMatch = line.match(/^\s*(`{3,}|~{3,})/);
if (fenceMatch) {
const matchStr = fenceMatch[1];
const char = matchStr[0];
const len = matchStr.length;
if (!inFence) {
inFence = true;
fenceChar = char;
fenceLen = len;
fenceStart = lineStart;
} else if (char === fenceChar && len >= fenceLen) {
inFence = false;
codeRanges.push({ from: fenceStart, to: lineEnd });
}
}
if (inFence && i === lines.length - 1) {
codeRanges.push({ from: fenceStart, to: lineEnd });
}
currentOffset = lineEnd + 1;
}
// 2. Identify inline code ranges outside fenced code blocks
currentOffset = 0;
for (let i = 0; i < lines.length; i++) {
const line = lines[i];
const lineStart = currentOffset;
const lineEnd = currentOffset + line.length;
const isLineInFence = codeRanges.some(r => lineStart >= r.from && lineEnd <= r.to);
if (!isLineInFence) {
const backtickRegex = /(`+)/g;
let match: RegExpExecArray | null;
let openBacktick: { len: number; index: number } | null = null;
while ((match = backtickRegex.exec(line)) !== null) {
const len = match[1].length;
const index = lineStart + match.index;
if (!openBacktick) {
openBacktick = { len, index };
} else if (openBacktick.len === len) {
codeRanges.push({ from: openBacktick.index, to: index + len });
openBacktick = null;
}
}
}
currentOffset = lineEnd + 1;
}
const isPosInCode = (pos: number) => {
return codeRanges.some(r => pos >= r.from && pos < r.to);
};
// 3. Find ||...|| spoiler ranges outside code ranges
const delimiterIndices: number[] = [];
let idx = text.indexOf('||');
while (idx !== -1) {
if (!isPosInCode(idx) && !isPosInCode(idx + 1)) {
delimiterIndices.push(idx);
}
idx = text.indexOf('||', idx + 2);
}
let i = 0;
while (i < delimiterIndices.length - 1) {
const startIdx = delimiterIndices[i];
const endIdx = delimiterIndices[i + 1];
const content = text.slice(startIdx + 2, endIdx);
const crossesCode = codeRanges.some(r => startIdx < r.from && endIdx > r.to);
if (!crossesCode && content.length > 0) {
spoilers.push({
from: baseOffset + startIdx,
to: baseOffset + endIdx + 2,
contentFrom: baseOffset + startIdx + 2,
contentTo: baseOffset + endIdx,
});
i += 2;
} else {
i += 1;
}
}
return spoilers;
}
export function isRangeInCodeNode(state: EditorState, from: number, to: number): boolean {
try {
const tree = syntaxTree(state);
if (!tree) return false;
let inCode = false;
tree.iterate({
from,
to,
enter(node) {
const name = node.name.toLowerCase();
if (
name.includes('code') ||
name.includes('comment') ||
name.includes('math')
) {
inCode = true;
return false;
}
},
});
return inCode;
} catch {
return false;
}
}
export function getSpoilerFragments(
state: EditorState,
contentFrom: number,
contentTo: number,
spoilerIndex = 0
): SpoilerFragment[] {
if (contentFrom >= contentTo) return [];
const pointsSet = new Set<number>();
pointsSet.add(contentFrom);
pointsSet.add(contentTo);
// Split on line breaks for multiline support
const text = state.doc.sliceString(contentFrom, contentTo);
for (let i = 0; i < text.length; i++) {
if (text[i] === '\n') {
const breakPos = contentFrom + i;
pointsSet.add(breakPos);
if (breakPos + 1 <= contentTo) {
pointsSet.add(breakPos + 1);
}
}
}
// Split on syntax tree boundaries if tree exists
try {
const tree = syntaxTree(state);
if (tree) {
tree.iterate({
from: contentFrom,
to: contentTo,
enter(node) {
if (node.from > contentFrom && node.from < contentTo) {
pointsSet.add(node.from);
}
if (node.to > contentFrom && node.to < contentTo) {
pointsSet.add(node.to);
}
},
});
}
} catch {
// Ignore tree syntax errors if unavailable
}
const sortedPoints = Array.from(pointsSet).sort((a, b) => a - b);
const rawFragments: { from: number; to: number }[] = [];
for (let i = 0; i < sortedPoints.length - 1; i++) {
const fFrom = sortedPoints[i];
const fTo = sortedPoints[i + 1];
if (fFrom < fTo) {
const sliceStr = state.doc.sliceString(fFrom, fTo);
if (sliceStr !== '\n') {
rawFragments.push({ from: fFrom, to: fTo });
}
}
}
if (rawFragments.length === 0) {
return [];
}
return rawFragments.map((frag, idx) => {
const isStart = idx === 0;
const isEnd = idx === rawFragments.length - 1;
const classNames = ['note-flow-spoiler', 'discord-syntax-spoiler'];
if (isStart && isEnd) {
classNames.push(
'note-flow-spoiler-single',
'note-flow-spoiler-start',
'note-flow-spoiler-end',
'note-flow-spoiler-cap-left',
'note-flow-spoiler-cap-right',
'discord-syntax-spoiler-single',
'discord-syntax-spoiler-start',
'discord-syntax-spoiler-end',
'discord-syntax-spoiler-cap-left',
'discord-syntax-spoiler-cap-right'
);
} else if (isStart) {
classNames.push(
'note-flow-spoiler-start',
'note-flow-spoiler-cap-left',
'discord-syntax-spoiler-start',
'discord-syntax-spoiler-cap-left'
);
} else if (isEnd) {
classNames.push(
'note-flow-spoiler-end',
'note-flow-spoiler-cap-right',
'discord-syntax-spoiler-end',
'discord-syntax-spoiler-cap-right'
);
}
classNames.push(`note-flow-spoiler-group-${spoilerIndex}`);
return {
from: frag.from,
to: frag.to,
isStart,
isEnd,
classes: classNames.join(' '),
};
});
}
export function buildSpoilerDecorations(view: EditorView): DecorationSet {
const builder = new RangeSetBuilder<Decoration>();
const state = view.state;
let spoilerIndex = 0;
for (const { from, to } of view.visibleRanges) {
const text = state.doc.sliceString(from, to);
const spoilers = findSpoilerRanges(text, from);
for (const spoiler of spoilers) {
spoilerIndex++;
const spoilerState = getSpoilerState(state, spoiler.from, spoiler.to);
if (spoilerState === 'editing') {
continue;
}
if (isRangeInCodeNode(state, spoiler.from, spoiler.to)) {
continue;
}
const isRevealed = spoilerState === 'revealed';
builder.add(
spoiler.from,
spoiler.contentFrom,
Decoration.mark({
class: 'note-flow-spoiler-delimiter note-flow-spoiler-hidden discord-syntax-spoiler-delimiter',
})
);
const fragments = getSpoilerFragments(
state,
spoiler.contentFrom,
spoiler.contentTo,
spoilerIndex
);
if (fragments.length > 0) {
for (const frag of fragments) {
let classes = frag.classes;
if (isRevealed) {
classes += ' is-revealed';
}
builder.add(
frag.from,
frag.to,
Decoration.mark({
class: classes,
attributes: {
'data-spoiler-id': `spoiler-${spoiler.from}`,
},
})
);
}
} else if (spoiler.contentFrom < spoiler.contentTo) {
let classes = 'note-flow-spoiler discord-syntax-spoiler note-flow-spoiler-single note-flow-spoiler-start note-flow-spoiler-end note-flow-spoiler-cap-left note-flow-spoiler-cap-right';
if (isRevealed) {
classes += ' is-revealed';
}
builder.add(
spoiler.contentFrom,
spoiler.contentTo,
Decoration.mark({
class: classes,
attributes: {
'data-spoiler-id': `spoiler-${spoiler.from}`,
},
})
);
}
builder.add(
spoiler.contentTo,
spoiler.to,
Decoration.mark({
class: 'note-flow-spoiler-delimiter note-flow-spoiler-hidden discord-syntax-spoiler-delimiter',
})
);
}
}
return builder.finish();
}
export const spoilerLivePreviewPlugin = ViewPlugin.fromClass(
class {
decorations: DecorationSet;
constructor(view: EditorView) {
this.decorations = buildSpoilerDecorations(view);
}
update(update: ViewUpdate) {
const oldState = update.startState.field(spoilerStateField, false);
const newState = update.state.field(spoilerStateField, false);
const stateChanged = oldState !== newState;
if (update.docChanged || update.selectionSet || update.viewportChanged || stateChanged) {
this.decorations = buildSpoilerDecorations(update.view);
}
}
},
{
decorations: (v) => v.decorations,
eventHandlers: {
mousedown(event, view) {
const target = event.target as HTMLElement | null;
const pos = view.posAtCoords({ x: event.clientX, y: event.clientY });
if (pos !== null) {
const text = view.state.doc.toString();
const spoilers = findSpoilerRanges(text);
const spoiler = spoilers.find(s => pos >= s.from && pos <= s.to);
if (spoiler) {
const currentState = getSpoilerState(view.state, spoiler.from, spoiler.to);
if (currentState === 'hidden') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'revealed'
})
});
return true;
} else if (currentState === 'revealed') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'editing'
}),
selection: { anchor: pos },
scrollIntoView: true
});
view.focus();
return true;
} else if (currentState === 'editing') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'hidden'
}),
selection: { anchor: spoiler.to },
scrollIntoView: true
});
view.focus();
return true;
}
}
}
const spoilerEl = target?.closest?.('[data-spoiler-id]') as HTMLElement | null;
if (spoilerEl) {
const spoilerId = spoilerEl.getAttribute('data-spoiler-id');
if (spoilerId) {
const fromStr = spoilerId.replace('spoiler-', '');
const from = parseInt(fromStr, 10);
if (!isNaN(from)) {
const text = view.state.doc.toString();
const spoilers = findSpoilerRanges(text);
const spoiler = spoilers.find(s => s.from === from);
if (spoiler) {
const currentState = getSpoilerState(view.state, spoiler.from, spoiler.to);
if (currentState === 'hidden') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'revealed'
})
});
return true;
} else if (currentState === 'revealed') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'editing'
}),
selection: { anchor: spoiler.contentFrom },
scrollIntoView: true
});
view.focus();
return true;
}
}
}
}
}
},
keydown(event, view) {
if (event.key === 'Enter' || event.key === ' ') {
const spoiler = getSpoilerAtSelection(view.state);
if (spoiler) {
const currentState = getSpoilerState(view.state, spoiler.from, spoiler.to);
if (currentState === 'hidden') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'revealed'
})
});
return true;
} else if (currentState === 'revealed') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'editing'
}),
selection: { anchor: spoiler.contentFrom },
scrollIntoView: true
});
view.focus();
return true;
} else if (currentState === 'editing') {
event.preventDefault();
view.dispatch({
effects: setSpoilerStateEffect.of({
from: spoiler.from,
to: spoiler.to,
state: 'hidden'
}),
selection: { anchor: spoiler.to },
scrollIntoView: true
});
view.focus();
return true;
}
}
}
},
mouseover(event, view) {
const target = event.target as HTMLElement | null;
const spoilerEl = target?.closest?.('[data-spoiler-id]') as HTMLElement | null;
if (!spoilerEl) return;
const spoilerId = spoilerEl.getAttribute('data-spoiler-id');
if (!spoilerId || !/^[a-zA-Z0-9_-]+$/.test(spoilerId)) return;
const relatedTarget = event.relatedTarget as HTMLElement | null;
const relatedSpoiler = relatedTarget?.closest?.('[data-spoiler-id]') as HTMLElement | null;
const relatedId = relatedSpoiler?.getAttribute('data-spoiler-id');
if (relatedId === spoilerId) return;
const elements = view.dom.querySelectorAll(`[data-spoiler-id="${spoilerId}"]`);
for (let i = 0; i < elements.length; i++) {
const el = elements[i];
if (el instanceof HTMLElement) {
el.classList.add('is-hovered');
}
}
},
mouseout(event, view) {
const target = event.target as HTMLElement | null;
const spoilerEl = target?.closest?.('[data-spoiler-id]') as HTMLElement | null;
if (!spoilerEl) return;
const spoilerId = spoilerEl.getAttribute('data-spoiler-id');
if (!spoilerId || !/^[a-zA-Z0-9_-]+$/.test(spoilerId)) return;
const relatedTarget = event.relatedTarget as HTMLElement | null;
const relatedSpoiler = relatedTarget?.closest?.('[data-spoiler-id]') as HTMLElement | null;
const relatedId = relatedSpoiler?.getAttribute('data-spoiler-id');
if (relatedId === spoilerId) return;
const elements = view.dom.querySelectorAll(`[data-spoiler-id="${spoilerId}"]`);
for (let i = 0; i < elements.length; i++) {
const el = elements[i];
if (el instanceof HTMLElement) {
el.classList.remove('is-hovered');
}
}
}
}
}
);
export const spoilerLivePreviewExtension = [
spoilerStateField,
spoilerLivePreviewPlugin
];

170
src/spoiler-post-processor.ts Normal file
View file

@ -0,0 +1,170 @@
export function processSpoilers(element: HTMLElement, doc: Document = globalThis.document): void {
if (!element || !doc) return;
function createSpoilerSpan(): HTMLSpanElement {
const spoilerSpan = doc.createElement('span');
spoilerSpan.classList.add('note-flow-spoiler', 'discord-syntax-spoiler');
spoilerSpan.setAttribute('role', 'button');
spoilerSpan.setAttribute('tabindex', '0');
spoilerSpan.setAttribute('aria-expanded', 'false');
spoilerSpan.setAttribute('aria-label', 'Spoiler, click to reveal');
const innerSpan = doc.createElement('span');
innerSpan.setAttribute('aria-hidden', 'true');
const originalAppendChild = spoilerSpan.appendChild.bind(spoilerSpan);
originalAppendChild(innerSpan);
spoilerSpan.appendChild = function <T extends Node>(node: T): T {
return innerSpan.appendChild(node);
};
function toggleSpoiler() {
const isRevealed = spoilerSpan.classList.contains('is-revealed');
if (isRevealed) {
spoilerSpan.classList.remove('is-revealed');
spoilerSpan.setAttribute('aria-expanded', 'false');
spoilerSpan.setAttribute('aria-label', 'Spoiler, click to reveal');
innerSpan.setAttribute('aria-hidden', 'true');
} else {
spoilerSpan.classList.add('is-revealed');
spoilerSpan.setAttribute('aria-expanded', 'true');
spoilerSpan.removeAttribute('aria-label');
innerSpan.setAttribute('aria-hidden', 'false');
}
}
spoilerSpan.addEventListener('click', () => {
toggleSpoiler();
});
spoilerSpan.addEventListener('keydown', (e: KeyboardEvent) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault();
toggleSpoiler();
}
});
return spoilerSpan;
}
const markers: (HTMLSpanElement | null)[] = [];
function insertMarker(parent: Node, node: Node, text: string, index: number): Text | null {
const beforeStr = text.slice(0, index);
const afterStr = text.slice(index + 2);
if (beforeStr) {
parent.insertBefore(doc.createTextNode(beforeStr), node);
}
const marker = doc.createElement('span');
marker.setAttribute('data-spoiler-marker', 'true');
parent.insertBefore(marker, node);
markers.push(marker);
if (afterStr) {
const afterNode = doc.createTextNode(afterStr);
parent.insertBefore(afterNode, node);
return afterNode;
}
return null;
}
function collectMarkers(node: Node): void {
if (node.nodeType === Node.TEXT_NODE) {
let text = node.nodeValue || '';
let idx = text.indexOf('||');
if (idx !== -1 && node.parentNode) {
const parent = node.parentNode;
let remainingNode = insertMarker(parent, node, text, idx);
parent.removeChild(node);
while (remainingNode) {
text = remainingNode.nodeValue || '';
idx = text.indexOf('||');
if (idx !== -1) {
const nextRemaining = insertMarker(parent, remainingNode, text, idx);
parent.removeChild(remainingNode);
remainingNode = nextRemaining;
} else {
remainingNode = null;
}
}
}
} else if (node.nodeType === Node.ELEMENT_NODE) {
const el = node as Element;
if (el.nodeName === 'PRE' || el.nodeName === 'CODE') {
return;
}
if (el.classList.contains('note-flow-spoiler') || el.classList.contains('discord-syntax-spoiler')) {
return;
}
for (const child of Array.from(node.childNodes)) {
collectMarkers(child);
}
}
}
collectMarkers(element);
for (let i = 0; i < markers.length - 1; i += 2) {
const startMarker = markers[i];
const endMarker = markers[i + 1];
if (!startMarker || !endMarker) continue;
const spoilerSpan = createSpoilerSpan();
let usedRange = false;
if (typeof doc.createRange === 'function') {
try {
const range = doc.createRange();
range.setStartAfter(startMarker);
range.setEndBefore(endMarker);
const fragment = range.extractContents();
spoilerSpan.appendChild(fragment);
if (startMarker.parentNode) {
startMarker.parentNode.insertBefore(spoilerSpan, startMarker);
startMarker.parentNode.removeChild(startMarker);
}
if (endMarker.parentNode) {
endMarker.parentNode.removeChild(endMarker);
}
markers[i] = null;
markers[i + 1] = null;
usedRange = true;
} catch {
usedRange = false;
}
}
if (!usedRange) {
if (startMarker.parentNode && startMarker.parentNode === endMarker.parentNode) {
const parent = startMarker.parentNode;
parent.insertBefore(spoilerSpan, startMarker);
const children = Array.from(parent.childNodes);
const startIndex = children.indexOf(startMarker);
const endIndex = children.indexOf(endMarker);
for (let j = startIndex + 1; j < endIndex; j++) {
const child = children[j];
parent.removeChild(child);
spoilerSpan.appendChild(child);
}
parent.removeChild(startMarker);
parent.removeChild(endMarker);
markers[i] = null;
markers[i + 1] = null;
}
}
}
for (const marker of markers) {
if (marker && marker.parentNode) {
marker.parentNode.insertBefore(doc.createTextNode('||'), marker);
marker.parentNode.removeChild(marker);
}
}
}

121
src/spoiler.test.ts Normal file
View file

@ -0,0 +1,121 @@
import test from 'node:test'
import assert from 'node:assert'
import fs from 'node:fs'
import path from 'node:path'
import { EditorState } from '@codemirror/state'
import { EditorView } from '@codemirror/view'
import {
isRangeInCodeNode,
getSpoilerFragments,
buildSpoilerDecorations,
spoilerLivePreviewExtension,
setSpoilerStateEffect,
getSpoilerState,
findSpoilerRanges,
} from './spoiler-detector'
test('Spoiler Detection & Live Preview', async (t) => {
await t.test('detects basic spoiler range', () => {
const text = 'Hello ||secret|| world'
const ranges = findSpoilerRanges(text)
assert.strictEqual(ranges.length, 1)
assert.strictEqual(ranges[0].from, 6)
assert.strictEqual(ranges[0].to, 16)
assert.strictEqual(ranges[0].contentFrom, 8)
assert.strictEqual(ranges[0].contentTo, 14)
})
await t.test('excludes inline code delimiters', () => {
const text = 'Here is `||` code and ||real spoiler||'
const ranges = findSpoilerRanges(text)
assert.strictEqual(ranges.length, 1)
assert.strictEqual(ranges[0].from, 22)
assert.strictEqual(ranges[0].to, 38)
})
await t.test('excludes fenced code block content', () => {
const text = '```ts\nconst x = ||not a spoiler||;\n```\n||actual spoiler||'
const ranges = findSpoilerRanges(text)
assert.strictEqual(ranges.length, 1)
assert.strictEqual(text.slice(ranges[0].from, ranges[0].to), '||actual spoiler||')
})
await t.test('handles multiple spoilers in same string', () => {
const text = '||first|| and ||second||'
const ranges = findSpoilerRanges(text)
assert.strictEqual(ranges.length, 2)
assert.strictEqual(text.slice(ranges[0].from, ranges[0].to), '||first||')
assert.strictEqual(text.slice(ranges[1].from, ranges[1].to), '||second||')
})
await t.test('ignores unclosed delimiters and empty spoilers', () => {
assert.strictEqual(findSpoilerRanges('||unclosed text').length, 0)
assert.strictEqual(findSpoilerRanges('||||').length, 0)
})
await t.test('isRangeInCodeNode returns false when no syntax tree is present', () => {
const state = EditorState.create({ doc: '||spoiler|| and some code' })
const inCode = isRangeInCodeNode(state, 0, 11)
assert.strictEqual(inCode, false)
})
await t.test('getSpoilerFragments generates single fragment with start and end caps', () => {
const docText = 'Hello ||secret|| world'
const state = EditorState.create({ doc: docText })
const fragments = getSpoilerFragments(state, 8, 14, 1)
assert.strictEqual(fragments.length, 1)
assert.strictEqual(fragments[0].from, 8)
assert.strictEqual(fragments[0].to, 14)
assert.strictEqual(fragments[0].isStart, true)
assert.strictEqual(fragments[0].isEnd, true)
assert.ok(fragments[0].classes.includes('discord-syntax-spoiler-single'))
})
await t.test('buildSpoilerDecorations creates decorations with cap classes and data-spoiler-id', () => {
const docText = 'Hello ||secret|| world'
const mockState = EditorState.create({ doc: docText })
const mockView = {
state: mockState,
visibleRanges: [{ from: 0, to: docText.length }],
} as unknown as EditorView
const decorations = buildSpoilerDecorations(mockView)
assert.ok(decorations)
interface DecoItem {
from: number
to: number
value: { spec: { class: string; attributes: Record<string, string> } }
}
const items: DecoItem[] = []
const iter = decorations.iter()
while (iter.value !== null) {
items.push({
from: iter.from,
to: iter.to,
value: iter.value as unknown as DecoItem['value'],
})
iter.next()
}
assert.strictEqual(items.length, 3)
assert.strictEqual(items[0].from, 6)
assert.strictEqual(items[0].to, 8)
assert.strictEqual(items[1].from, 8)
assert.strictEqual(items[1].to, 14)
assert.strictEqual(items[2].from, 14)
assert.strictEqual(items[2].to, 16)
const contentDeco = items[1].value
assert.ok(contentDeco.spec.class.includes('discord-syntax-spoiler'))
assert.strictEqual(contentDeco.spec.attributes['data-spoiler-id'], 'spoiler-6')
})
await t.test('styles.css contains spoiler rules', () => {
const cssPath = path.join(__dirname, 'styles.css')
const css = fs.readFileSync(cssPath, 'utf8')
assert.ok(css.includes('border-radius: 0;'))
assert.ok(css.includes('discord-syntax-spoiler'))
})
})

75
src/subtext-live-preview.ts Normal file
View file

@ -0,0 +1,75 @@
import { ViewPlugin, Decoration, EditorView, ViewUpdate, DecorationSet } from '@codemirror/view'
import { RangeSetBuilder } from '@codemirror/state'
const MARKER = '-# '
const MARKER_LEN = MARKER.length
const subtextLineMark = Decoration.mark({ class: 'discord-subtext' })
const subtextMarkerMark = Decoration.mark({ class: 'discord-subtext-marker' })
const subtextMarkerActiveMark = Decoration.mark({
class: 'discord-subtext-marker-active',
})
export const subtextEditorPlugin = ViewPlugin.fromClass(
class {
decorations: DecorationSet
constructor(view: EditorView) {
this.decorations = buildDecorations(view)
}
update(update: ViewUpdate) {
if (update.docChanged || update.viewportChanged || update.selectionSet) {
this.decorations = buildDecorations(update.view)
}
}
},
{ decorations: (v) => v.decorations }
)
function collectActiveLineNumbers(view: EditorView): Set<number> {
const doc = view.state.doc
const active = new Set<number>()
for (const range of view.state.selection.ranges) {
active.add(doc.lineAt(range.anchor).number)
active.add(doc.lineAt(range.head).number)
}
return active
}
function buildDecorations(view: EditorView): DecorationSet {
const builder = new RangeSetBuilder<Decoration>()
const doc = view.state.doc
const activeLines = collectActiveLineNumbers(view)
for (const { from, to } of view.visibleRanges) {
const startLine = doc.lineAt(from).number
const endLine = doc.lineAt(to).number
for (let ln = startLine; ln <= endLine; ln++) {
const line = doc.line(ln)
const text = line.text
if (!text.startsWith(MARKER)) continue
const isActive = activeLines.has(ln)
builder.add(
line.from,
line.from + MARKER_LEN,
isActive ? subtextMarkerActiveMark : subtextMarkerMark
)
if (line.to > line.from + MARKER_LEN) {
builder.add(line.from + MARKER_LEN, line.to, subtextLineMark)
}
}
}
return builder.finish()
}

116
src/subtext-post-processor.ts Normal file
View file

@ -0,0 +1,116 @@
const MARKER = '-# '
const MARKER_LEN = MARKER.length
const SUBTEXT_CLASS = 'discord-subtext'
export function processSubtextParagraph(p: HTMLElement): void {
if (!paragraphMightHaveSubtext(p)) return
const children = Array.from(p.childNodes)
const lines = splitIntoLines(children)
const hasAny = lines.some(lineIsSubtext)
if (!hasAny) return
emptyContainer(p)
for (let li = 0; li < lines.length; li++) {
const line = lines[li]
if (line.length === 0) continue
if (lineIsSubtext(line)) {
const clone = cloneLine(line)
stripMarkerFromFirstText(clone)
const doc = p.ownerDocument || document
const span = doc.createElement('span')
span.classList.add(SUBTEXT_CLASS)
for (const node of clone) span.appendChild(node)
p.appendChild(span)
} else {
for (const node of line) p.appendChild(node)
}
}
}
function emptyContainer(el: HTMLElement): void {
const emptyable = el as unknown as { empty?: () => void }
if (typeof emptyable.empty === 'function') {
emptyable.empty()
} else {
while (el.firstChild) {
el.removeChild(el.firstChild)
}
}
}
const TEXT_NODE_TYPE = typeof Node !== 'undefined' ? Node.TEXT_NODE : 3
const ELEMENT_NODE_TYPE = typeof Node !== 'undefined' ? Node.ELEMENT_NODE : 1
function paragraphMightHaveSubtext(p: HTMLElement): boolean {
for (const child of Array.from(p.childNodes)) {
if (child.nodeType === TEXT_NODE_TYPE) {
const v = (child as Text).data
if (v.startsWith(MARKER) || v.includes('\n' + MARKER)) return true
}
if (child.nodeType === ELEMENT_NODE_TYPE && (child as Element).tagName === 'BR') {
return true
}
}
return false
}
function splitIntoLines(nodes: ChildNode[]): ChildNode[][] {
const lines: ChildNode[][] = [[]]
for (const node of nodes) {
if (node.nodeType === TEXT_NODE_TYPE) {
const text = node as Text
const parts = text.data.split('\n')
for (let i = 0; i < parts.length; i++) {
if (parts[i].length > 0) {
const doc = text.ownerDocument || document
const frag = doc.createTextNode(parts[i])
lines[lines.length - 1].push(frag)
}
if (i < parts.length - 1) {
lines.push([])
}
}
} else if (node.nodeType === ELEMENT_NODE_TYPE && (node as Element).tagName === 'BR') {
lines[lines.length - 1].push(node)
lines.push([])
} else {
lines[lines.length - 1].push(node)
}
}
return lines
}
function lineIsSubtext(line: ChildNode[]): boolean {
for (const node of line) {
if (node.nodeType === TEXT_NODE_TYPE) {
return (node as Text).data.startsWith(MARKER)
}
if (node.nodeType === ELEMENT_NODE_TYPE && (node as Element).tagName === 'BR') continue
return false
}
return false
}
function cloneLine(line: ChildNode[]): Node[] {
return line.map((n) => n.cloneNode(true))
}
function stripMarkerFromFirstText(nodes: Node[]): void {
for (const node of nodes) {
if (node.nodeType === TEXT_NODE_TYPE) {
const t = node as Text
if (t.data.startsWith(MARKER)) {
t.data = t.data.slice(MARKER_LEN)
}
return
}
if (node.nodeType === ELEMENT_NODE_TYPE && (node as Element).tagName === 'BR') continue
return
}
}

91
src/subtext.test.ts Normal file
View file

@ -0,0 +1,91 @@
import test from 'node:test'
import assert from 'node:assert'
import { processSubtextParagraph } from './subtext-post-processor'
test('Subtext Reading View Post Processor', async (t) => {
await t.test('wraps paragraph starting with -# into discord-subtext span', () => {
const mockDocument = {
createElement(tagName: string) {
return {
nodeType: 1,
tagName: tagName.toUpperCase(),
classList: {
add(cls: string) {
this.classes.push(cls)
},
classes: [] as string[],
},
children: [] as unknown[],
appendChild(child: unknown) {
this.children.push(child)
return child
},
}
},
createTextNode(text: string) {
const textNode = {
nodeType: 3,
data: text,
ownerDocument: mockDocument,
cloneNode() {
return { ...this }
},
}
return textNode
},
}
const initialTextNode = mockDocument.createTextNode('-# This is subtext')
const children: unknown[] = [initialTextNode]
const p = {
nodeType: 1,
tagName: 'P',
ownerDocument: mockDocument,
childNodes: children,
empty() {
children.length = 0
},
appendChild(child: unknown) {
children.push(child)
return child
},
} as unknown as HTMLElement
processSubtextParagraph(p)
assert.strictEqual(children.length, 1)
const span = children[0] as Record<string, unknown>
assert.strictEqual(span.tagName, 'SPAN')
const classes = (span.classList as { classes: string[] }).classes
assert.ok(classes.includes('discord-subtext'))
const firstChild = (span.children as { data: string }[])[0]
assert.strictEqual(firstChild.data, 'This is subtext')
})
await t.test('ignores regular paragraph without subtext marker', () => {
const initialTextNode = {
nodeType: 3,
data: 'This is a normal paragraph',
}
const children: unknown[] = [initialTextNode]
const p = {
nodeType: 1,
tagName: 'P',
childNodes: children,
empty() {
children.length = 0
},
appendChild(child: unknown) {
children.push(child)
return child
},
} as unknown as HTMLElement
processSubtextParagraph(p)
assert.strictEqual(children.length, 1)
assert.strictEqual(children[0], initialTextNode)
})
})

16
tsconfig.json Normal file
View file

@ -0,0 +1,16 @@
{
"compilerOptions": {
"target": "ES2020",
"module": "ESNext",
"moduleResolution": "node",
"allowSyntheticDefaultImports": true,
"esModuleInterop": true,
"strict": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"outDir": "./dist"
},
"include": [
"src/**/*"
]
}

3
versions.json Normal file
View file

@ -0,0 +1,3 @@
{
"1.0.0": "0.15.0"
}