aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuben Beltran del Rio <jj@r.bdr.sh>2025-12-12 18:12:06 +0100
committerRuben Beltran del Rio <jj@r.bdr.sh>2025-12-13 21:21:32 +0100
commitcd3d83d8a852d98e934ebc13b067e0971e30a995 (patch)
treeaf5b73b35c7d5c1da63ad59353ff29c0786ec762
parent80aefd27ffc19a948c74f2418a2a5bf5f95a6868 (diff)
Improve docs, and match API of other parsers
-rw-r--r--LICENSE661
-rw-r--r--README.md239
-rw-r--r--benchmark/index.js13
-rw-r--r--package.json8
-rw-r--r--src/index.js218
-rw-r--r--test/example.wmap4
-rw-r--r--test/parser.test.js222
7 files changed, 973 insertions, 392 deletions
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..07d102f
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,661 @@
+GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ 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.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are 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.
+
+ 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.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ 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 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 work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero 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 Affero 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 Affero 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 Affero 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.
+
+ wmap-parser-js, Javascript wmap wardley map file parser.
+ Copyright (C) 2025 Ruben Beltran del Rio
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ 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 AGPL, see
+<https://www.gnu.org/licenses/>.
diff --git a/README.md b/README.md
index 1d90963..1ca023c 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,28 @@
-# wmap-parser
+# wmap-parser-js
-A high-performance JavaScript parser for wmap formatted Wardley Map files.
+A pure-javascript parser for `wmap` formatted Wardley Map files.
## Features
-- **Zero dependencies** (dev dependencies only for testing and benchmarking)
-- **High performance** state machine parser
-- **TypeScript-friendly** with comprehensive JSDoc type definitions
-- **Cross-platform** line ending support (LF, CRLF, CR)
-- **Robust** error handling - invalid lines are gracefully ignored
+* No dependencies.
+* Pure JavaScript, browser and runtime friendly.
+* Free software.
+* Reasonably fast.
## Installation
+Install with your favorite package manager.
+
```bash
-npm install wmap-parser
+pnpm add wmap-parser
```
-Or with pnpm:
+```bash
+yarn add wmap-parser
+```
```bash
-pnpm add wmap-parser
+npm install wmap-parser
```
## Usage
@@ -46,21 +49,25 @@ Cup -> Hot Water
[Evolution] Tea + 0.1
`;
-const map = await parse(wmapSource);
+const map = parse(wmapSource);
+
+console.log(map.components);
+// [
+// { label: 'Tea', coordinates: [0.9, 0.5], shape: 'circle' },
+// { label: 'Cup', coordinates: [0.8, 0.4], shape: 'circle' },
+// ...
+// ]
-console.log(map.entities);
+console.log(map.dependencies);
// [
-// { type: 'stage', number: 'i', value: 0.25 },
-// { type: 'stage', number: 'ii', value: 0.5 },
-// { type: 'component', label: 'Tea', coordinates: [0.9, 0.5], shape: 'circle' },
-// { type: 'dependency', from: 'Tea', to: 'Cup', isDirected: true },
+// { from: 'Tea', to: 'Cup', isDirected: true },
// ...
// ]
```
## API
-### `parse(source: string): Promise<Map>`
+### `parse(source: string): Map`
Parses a wmap formatted string and returns a Map object.
@@ -72,209 +79,45 @@ Parses a wmap formatted string and returns a Map object.
- `Promise<Map>`: A promise that resolves to a Map object
-### Type Definitions
-
-#### Map
-
-```typescript
-{
- entities: Entity[]
-}
-```
-
-#### Entity
-
-Union type of: `Component | Dependency | Note | Stage | Group | Inertia | Evolution`
-
-#### Component
-
-```typescript
-{
- type: "component";
- label: string;
- coordinates: [number, number];
- shape: string | null; // 'x' | 'square' | 'triangle' | 'circle' | null
-}
-```
-
-#### Dependency
-
-```typescript
-{
- type: "dependency";
- from: string;
- to: string;
- isDirected: boolean; // true for ->, false for --
-}
-```
-
-#### Note
-
-```typescript
-{
- type: "note";
- coordinates: [number, number];
- text: string;
-}
-```
-
-#### Stage
-
-```typescript
-{
- type: "stage";
- number: string; // 'i' | 'ii' | 'iii' | 'iv'
- value: number;
-}
-```
-
-#### Group
-
-```typescript
-{
- type: 'group'
- vertices: string[]
-}
-```
-
-#### Inertia
-
-```typescript
-{
- type: "inertia";
- vertex: string;
-}
-```
-
-#### Evolution
-
-```typescript
-{
- type: "evolution";
- vertex: string;
- isPositive: boolean;
- value: number;
-}
-```
+For mor comprehensive type definitions, check the JSDoc comments inside.
## Format Specification
-The wmap format supports the following entity types:
-
-### Components (Vertices)
+See [The map website](https://map.tranquil.systems) for more information on the
+format.
-```
-ComponentName (x, y)
-ComponentName (x, y) [Shape]
-```
-
-- Coordinates are decimal numbers (0-100 range typical)
-- Optional shape: `x`, `Square`, `Triangle`, or `Circle` (case-insensitive)
+## Reasonably Fast
-### Dependencies (Edges)
+Benchmarked on an M1 Pro mac. A map with around 120 entities parses in 16µs.
+While a larger map with slightly under 2000 entities does so in 447µs.
-```
-Source -> Target # Directed dependency
-Source -- Target # Undirected dependency
-```
-
-### Notes
-
-```
-[Note] (x, y) Note text content
-```
-
-### Stages
-
-```
-[I] 0.25
-[II] 0.5
-[III] 0.75
-[IV] 1.0
-```
-
-- Stage numbers: `I`, `II`, `III`, or `IV` (case-insensitive)
-
-### Groups
-
-```
-[Group] Component1, Component2, Component3
-```
-
-### Inertia
-
-```
-[Inertia] ComponentName
-```
-
-### Evolution
-
-```
-[Evolution] ComponentName + 0.5
-[Evolution] ComponentName - 0.3
-```
-
-See the [formal EBNF specification](doc/wmap-spec.ebnf) for complete grammar details.
-
-## Performance
-
-The parser uses a character-by-character state machine approach for optimal performance:
-
-- **No regex overhead** - direct character comparisons
-- **Minimal allocations** - efficient string operations
-- **Single-pass parsing** - each line processed once
-- **Cache-friendly** - sequential memory access
-
-Benchmark on a typical map with ~120 entities:
-
-- **~50,000+ operations/second**
-- **~0.02ms average parse time**
-
-Run benchmarks yourself:
+You can run the benchmarks by using:
```bash
-npm run benchmark
+make benchmark
```
-## Error Handling
-
-The parser is designed to be fault-tolerant:
-
-- Invalid lines are silently ignored
-- Partial entities are not added to the result
-- Empty lines and whitespace are handled gracefully
-- Different line endings (LF, CRLF, CR) are all supported
-
## Development
+This project uses a Makefile to run all commands. This is to keep the
+commands uniform with the other wmap-parser projects.
+
### Running Tests
```bash
-npm test
+make test
```
-Tests use Node's built-in test runner (`node:test`) with no external dependencies.
-
-### Running Benchmarks
+Or to see coverage
```bash
-npm run benchmark
+make coverage
```
-## License
-
-AGPL-v3
-
-## Contributing
-
-This is a focused, performance-oriented parser. Contributions should maintain:
-
-- Zero runtime dependencies
-- High performance characteristics
-- Simple, readable code
-- Comprehensive test coverage
-
## See Also
- [wmap specification](doc/wmap-spec.ebnf) - Formal grammar
+- [wmap specification](https://git.sr.ht:~rbdr/wmap-parser-rust) - Rust wmap-parser
+- [wmap specification](https://git.sr.ht:~rbdr/wmap-parser-c) - ANSI C wmap-parser
+- [wmap specification](https://git.sr.ht:~rbdr/wmap-parser-swift) - Swift wmap-parser
- [Wardley Maps](https://wardleymaps.com/) - Learn about Wardley Mapping
diff --git a/benchmark/index.js b/benchmark/index.js
index e2bae6d..f2e280c 100644
--- a/benchmark/index.js
+++ b/benchmark/index.js
@@ -8,12 +8,13 @@ const hugeSource = await readFile("test/huge.wmap", "utf-8");
const bench = new Bench({ name: "Parsing Benchmark", time: 1000 });
-bench.add("Example map", () => {
- parse(exampleSource);
-})
-.add("Huge map", () => {
- parse(hugeSource);
-});
+bench
+ .add("Example map", () => {
+ parse(exampleSource);
+ })
+ .add("Huge map", () => {
+ parse(hugeSource);
+ });
await bench.run();
diff --git a/package.json b/package.json
index ac191a3..99af0c1 100644
--- a/package.json
+++ b/package.json
@@ -4,11 +4,9 @@
"description": "Parser for wmap formatted Wardley Map files.",
"type": "module",
"main": "src/index.js",
- "scripts": {
- "benchmark": "node benchmark/index.js"
- },
- "keywords": [],
- "author": "",
+ "scripts": {},
+ "keywords": ["Wardley Maps", "Wardley", "wmap", "Wardley Mapping"],
+ "author": "Rubén Beltrán del Río <wmap.parser@r.bdr.sh>",
"license": "AGPL-v3",
"packageManager": "pnpm@10.12.1",
"devDependencies": {
diff --git a/src/index.js b/src/index.js
index f705f5a..729db76 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,12 +1,13 @@
/**
* A parsed wardley map.
* @typedef {Object} Map
- * @property {Entity[]} entities - The list of parsed entities
- */
-
-/**
- * Any of the potential entities in the map.
- * @typedef {Component|Dependency|Note|Stage|Group|Inertia|Evolution} Entity
+ * @property {Component[]} components - List of components
+ * @property {Dependency[]} dependencies - List of dependencies
+ * @property {Note[]} notes - List of notes
+ * @property {Stage[]} stages - List of stages
+ * @property {Group[]} groups - List of groups
+ * @property {Inertia[]} inertias - List of inertias
+ * @property {Evolution[]} evolutions - List of evolutions
*/
/**
@@ -17,7 +18,6 @@
/**
* A component in the map.
* @typedef {Object} Component
- * @property {'component'} type - Entity type
* @property {string} label - Component label
* @property {[number, number]} coordinates - X and Y coordinates
* @property {Shape} shape - Shape of the component
@@ -26,7 +26,6 @@
/**
* A dependency between two components.
* @typedef {Object} Dependency
- * @property {'dependency'} type - Entity type
* @property {string} from - Source component label
* @property {string} to - Target component label
* @property {boolean} isDirected - Whether the dependency is directed (->) or undirected (--)
@@ -35,7 +34,6 @@
/**
* A note.
* @typedef {Object} Note
- * @property {'note'} type - Entity type
* @property {[number, number]} coordinates - X and Y coordinates
* @property {string} text - Note text content
*/
@@ -43,7 +41,6 @@
/**
* An override for the width of an evolution stage.
* @typedef {Object} Stage
- * @property {'stage'} type - Entity type
* @property {string} stage - Stage number (i, ii, iii, iv)
* @property {number} value - Stage value
*/
@@ -51,63 +48,112 @@
/**
* A group of components.
* @typedef {Object} Group
- * @property {'group'} type - Entity type
* @property {string[]} components - Array of component labels in the group
*/
/**
* Inertia associated with a component.
* @typedef {Object} Inertia
- * @property {'inertia'} type - Entity type
* @property {string} component - Component label with inertia
*/
/**
* Evolution associated with a component.
* @typedef {Object} Evolution
- * @property {'evolution'} type - Entity type
* @property {string} component - Component label
* @property {number} value - Evolution value
*/
-/**
- * Helper: Check if character is whitespace
- */
-function isWhitespace(character) {
- return character === " " || character === "\t";
-}
+/* CONSTANTS ******************************************************************/
-/**
- * Helper: Check if character is a digit or dot
- */
-function isDigitOrDot(character) {
- return (character >= "0" && character <= "9") || character === ".";
-}
+const kLineSplitter = /\r\n|\r|\n/;
+
+/* PUBLIC API *****************************************************************/
/**
* wmap format Wardley Map parser.
* @param {string} source - The wmap source code to parse
- * @returns {Map} - Parsed map with entities
+ * @returns {Map} - Parsed map with separate arrays for each entity type
*/
export function parse(source) {
- const entities = [];
- const lines = source.split(/\r\n|\r|\n/);
+ const components = [];
+ const dependencies = [];
+ const notes = [];
+ const stages = [];
+ const groups = [];
+ const inertias = [];
+ const evolutions = [];
+ const lines = source.split(kLineSplitter);
for (const rawLine of lines) {
const line = rawLine.trim();
if (!line) continue;
const entity = parseLine(line);
- if (entity) {
- entities.push(entity);
+ if (!entity) continue;
+
+ switch (entity.type) {
+ case "component":
+ components.push({
+ label: entity.label,
+ coordinates: entity.coordinates,
+ shape: entity.shape,
+ });
+ break;
+ case "dependency":
+ dependencies.push({
+ from: entity.from,
+ to: entity.to,
+ isDirected: entity.isDirected,
+ });
+ break;
+ case "note":
+ notes.push({
+ coordinates: entity.coordinates,
+ text: entity.text,
+ });
+ break;
+ case "stage":
+ stages.push({
+ stage: entity.stage,
+ value: entity.value,
+ });
+ break;
+ case "group":
+ groups.push({
+ components: entity.components,
+ });
+ break;
+ case "inertia":
+ inertias.push({
+ component: entity.component,
+ });
+ break;
+ case "evolution":
+ evolutions.push({
+ component: entity.component,
+ value: entity.value,
+ });
+ break;
}
}
- return { entities };
+ return {
+ components,
+ dependencies,
+ notes,
+ stages,
+ groups,
+ inertias,
+ evolutions,
+ };
}
+/* PARSERS ********************************************************************/
+
/**
- * Parse a line
+ * Routes a line to either the keyword parser, or the component / dependency
+ * parser.
*/
function parseLine(line) {
const length = line.length;
@@ -125,41 +171,24 @@ function parseLine(line) {
}
/**
- * Parse entities that start with keywords in brackets: [Stage], [Note], [Group], [Inertia], [Evolution]
+ * Parse any entity that start with keywords in brackets: [Stage], [Note],
+ * [Group], [Inertia], [Evolution].
*/
function parseKeywordEntity(line, start, length) {
- let i = start + 1; // skip '['
+ // Read after [...
+ let i = start + 1;
const keywordStart = i;
- // Read until ']'
+ // ...but before ]
while (i < length && line[i] !== "]") i++;
if (i >= length) return null;
const keyword = line.substring(keywordStart, i).trim().toLowerCase();
- i++; // skip ']'
- // Skip whitespace after ']'
+ // Skip ] and whitespace
+ i++;
while (i < length && isWhitespace(line[i])) i++;
- // Stage: [I|II|III|IV] stage
- if (
- keyword === "i" ||
- keyword === "ii" ||
- keyword === "iii" ||
- keyword === "iv"
- ) {
- const numStart = i;
- while (i < length && isDigitOrDot(line[i])) i++;
- if (i > numStart) {
- return {
- type: "stage",
- stage: keyword,
- value: parseFloat(line.substring(numStart, i)),
- };
- }
- return null;
- }
-
// Note: [Note] (x, y) text
if (keyword === "note") {
// Expect '('
@@ -206,8 +235,8 @@ function parseKeywordEntity(line, start, length) {
const components = line
.substring(i)
.split(",")
- .map(v => v.trim())
- .filter(v => v);
+ .map((v) => v.trim())
+ .filter((v) => v);
return components.length > 0 ? { type: "group", components } : null;
}
@@ -226,7 +255,10 @@ function parseKeywordEntity(line, start, length) {
for (let j = i; j < length; j++) {
if (line[j] === "+" || line[j] === "-") {
// Make sure it's not part of a dependency arrow
- if (j + 1 < length && (line[j + 1] === ">" || line[j + 1] === "-"))
+ if (
+ j + 1 < length &&
+ (line[j + 1] === ">" || line[j + 1] === "-")
+ )
continue;
indexOfSign = j;
signCharacter = line[j];
@@ -241,18 +273,41 @@ function parseKeywordEntity(line, start, length) {
// Read number after sign
let indexOfNumber = indexOfSign + 1;
- while (indexOfNumber < length && isWhitespace(line[indexOfNumber])) indexOfNumber++;
- const numStart = indexOfNumber;
- while (indexOfNumber < length && isDigitOrDot(line[indexOfNumber])) indexOfNumber++;
- if (indexOfNumber === numStart) return null;
+ while (indexOfNumber < length && isWhitespace(line[indexOfNumber]))
+ indexOfNumber++;
+ const startOfNumber = indexOfNumber;
+ while (indexOfNumber < length && isDigitOrDot(line[indexOfNumber]))
+ indexOfNumber++;
+ if (indexOfNumber === startOfNumber) return null;
return {
type: "evolution",
component,
- value: (signCharacter === "+" ? 1 : -1) * parseFloat(line.substring(numStart, indexOfNumber)),
+ value:
+ (signCharacter === "+" ? 1 : -1) *
+ parseFloat(line.substring(startOfNumber, indexOfNumber)),
};
}
+ // Stage: [I|II|III|IV] stage
+ // Least common. Max 4 in a file.
+ if (
+ keyword === "i" ||
+ keyword === "ii" ||
+ keyword === "iii" ||
+ keyword === "iv"
+ ) {
+ const startOfNumber = i;
+ while (i < length && isDigitOrDot(line[i])) i++;
+ if (i > startOfNumber) {
+ return {
+ type: "stage",
+ stage: keyword,
+ value: parseFloat(line.substring(startOfNumber, i)),
+ };
+ }
+ }
+
return null;
}
@@ -260,13 +315,15 @@ function parseKeywordEntity(line, start, length) {
* Parse component or dependency
*/
function parseComponentOrDependency(line, length) {
- // Use indexOf to quickly find potential dependency arrows and parentheses
const indexOfArrow = line.indexOf("->");
const indexOfDash = line.indexOf("--");
const indexOfParenthesis = line.indexOf("(");
- // Check for directed dependency (->)
- if (indexOfArrow !== -1 && (indexOfParenthesis === -1 || indexOfArrow < indexOfParenthesis)) {
+ // Directed dependency
+ if (
+ indexOfArrow !== -1 &&
+ (indexOfParenthesis === -1 || indexOfArrow < indexOfParenthesis)
+ ) {
const from = line.substring(0, indexOfArrow).trim();
const to = line.substring(indexOfArrow + 2).trim();
if (from && to) {
@@ -280,8 +337,11 @@ function parseComponentOrDependency(line, length) {
return null;
}
- // Check for undirected dependency (--)
- if (indexOfDash !== -1 && (indexOfParenthesis === -1 || indexOfDash < indexOfParenthesis)) {
+ // Undirected dependency
+ if (
+ indexOfDash !== -1 &&
+ (indexOfParenthesis === -1 || indexOfDash < indexOfParenthesis)
+ ) {
const from = line.substring(0, indexOfDash).trim();
const to = line.substring(indexOfDash + 2).trim();
if (from && to) {
@@ -295,7 +355,7 @@ function parseComponentOrDependency(line, length) {
return null;
}
- // Check for component (opening parenthesis)
+ // Component
if (indexOfParenthesis > 0) {
return parseComponent(line, indexOfParenthesis, length);
}
@@ -304,7 +364,7 @@ function parseComponentOrDependency(line, length) {
}
/**
- * Parse component starting from the opening parenthesis
+ * Parse a component.
*/
function parseComponent(line, indexOfParenthesis, length) {
const label = line.substring(0, indexOfParenthesis).trim();
@@ -355,3 +415,19 @@ function parseComponent(line, indexOfParenthesis, length) {
shape,
};
}
+
+/* HELPER FUNCTIONS ***********************************************************/
+
+/**
+ * Helper: Check if character is whitespace
+ */
+function isWhitespace(character) {
+ return character === " " || character === "\t";
+}
+
+/**
+ * Helper: Check if character is a digit or dot
+ */
+function isDigitOrDot(character) {
+ return (character >= "0" && character <= "9") || character === ".";
+}
diff --git a/test/example.wmap b/test/example.wmap
index a238ab1..f090da2 100644
--- a/test/example.wmap
+++ b/test/example.wmap
@@ -59,7 +59,7 @@ OK.
This map so far is fst. asdasd asda
-Holy shit, this is still indeed fast. But everything flashes as I type! This is now happening so fast
+Holy moly, this is still indeed fast. But everything flashes as I type! This is now happening so fast
Hello my old friend.
@@ -119,4 +119,4 @@ test2asdasa asdasd asd
[Note] (5, 35) Notes also influence the placement of\n labels.
[Group] Tailor2, Tailor7, Tailor11, Tailor12, Tailor10, Anchor, Tinker
-[Group] Tailor3, Tailor5, Tailor14pr \ No newline at end of file
+[Group] Tailor3, Tailor5, Tailor14pr
diff --git a/test/parser.test.js b/test/parser.test.js
index 13ddd72..db0f02a 100644
--- a/test/parser.test.js
+++ b/test/parser.test.js
@@ -8,43 +8,47 @@ describe("wmap parser", () => {
const source = "Dominoes (0.9, 0.5)";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "component");
- assert.strictEqual(result.entities[0].label, "Dominoes");
- assert.deepStrictEqual(result.entities[0].coordinates, [0.9, 0.5]);
- assert.strictEqual(result.entities[0].shape, "circle");
+ assert.strictEqual(result.components.length, 1);
+ assert.strictEqual(result.components[0].label, "Dominoes");
+ assert.deepStrictEqual(
+ result.components[0].coordinates,
+ [0.9, 0.5],
+ );
+ assert.strictEqual(result.components[0].shape, "circle");
});
it("should parse a component with shape", async () => {
const source = "Database (0.33, 0.81) [Square]";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "component");
- assert.strictEqual(result.entities[0].label, "Database");
- assert.deepStrictEqual(result.entities[0].coordinates, [0.33, 0.81]);
- assert.strictEqual(result.entities[0].shape, "square");
+ assert.strictEqual(result.components.length, 1);
+ assert.strictEqual(result.components[0].label, "Database");
+ assert.deepStrictEqual(
+ result.components[0].coordinates,
+ [0.33, 0.81],
+ );
+ assert.strictEqual(result.components[0].shape, "square");
});
it("should parse component with x shape", async () => {
const source = "API (0.5, 0.6) [x]";
const result = parse(source);
- assert.strictEqual(result.entities[0].shape, "x");
+ assert.strictEqual(result.components[0].shape, "x");
});
it("should parse component with triangle shape", async () => {
const source = "Service (0.4, 0.7) [Triangle]";
const result = parse(source);
- assert.strictEqual(result.entities[0].shape, "triangle");
+ assert.strictEqual(result.components[0].shape, "triangle");
});
it("should parse component with circle shape", async () => {
const source = "Process (0.2, 0.9) [CIRCLE]";
const result = parse(source);
- assert.strictEqual(result.entities[0].shape, "circle");
+ assert.strictEqual(result.components[0].shape, "circle");
});
it("should handle decimal numbers", async () => {
@@ -52,7 +56,7 @@ describe("wmap parser", () => {
const result = parse(source);
assert.deepStrictEqual(
- result.entities[0].coordinates,
+ result.components[0].coordinates,
[0.5, 0.123],
);
});
@@ -61,30 +65,33 @@ describe("wmap parser", () => {
const source = "Item (1, 0)";
const result = parse(source);
- assert.deepStrictEqual(result.entities[0].coordinates, [1, 0]);
+ assert.deepStrictEqual(result.components[0].coordinates, [1, 0]);
});
it("should preserve case in component labels", async () => {
const source = "RubberGaskets (0.5, 0.5)";
const result = parse(source);
- assert.strictEqual(result.entities[0].label, "RubberGaskets");
+ assert.strictEqual(result.components[0].label, "RubberGaskets");
});
it("should handle component labels with spaces", async () => {
const source = "Big Lawnmowers (0.5, 0.5)";
const result = parse(source);
- assert.strictEqual(result.entities[0].label, "Big Lawnmowers");
+ assert.strictEqual(result.components[0].label, "Big Lawnmowers");
});
it("should handle whitespace around tokens", async () => {
const source = " Outer Space ( 0.9 , 0.5 ) [ Square ] ";
const result = parse(source);
- assert.strictEqual(result.entities[0].label, "Outer Space");
- assert.deepStrictEqual(result.entities[0].coordinates, [0.9, 0.5]);
- assert.strictEqual(result.entities[0].shape, "square");
+ assert.strictEqual(result.components[0].label, "Outer Space");
+ assert.deepStrictEqual(
+ result.components[0].coordinates,
+ [0.9, 0.5],
+ );
+ assert.strictEqual(result.components[0].shape, "square");
});
});
@@ -93,37 +100,38 @@ describe("wmap parser", () => {
const source = "Smoke -- Fire";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "dependency");
- assert.strictEqual(result.entities[0].from, "Smoke");
- assert.strictEqual(result.entities[0].to, "Fire");
- assert.strictEqual(result.entities[0].isDirected, false);
+ assert.strictEqual(result.dependencies.length, 1);
+ assert.strictEqual(result.dependencies[0].from, "Smoke");
+ assert.strictEqual(result.dependencies[0].to, "Fire");
+ assert.strictEqual(result.dependencies[0].isDirected, false);
});
it("should parse directed dependency", async () => {
const source = "Cool Thing -> Different Cool Thing";
const result = parse(source);
- assert.strictEqual(result.entities[0].type, "dependency");
- assert.strictEqual(result.entities[0].from, "Cool Thing");
- assert.strictEqual(result.entities[0].to, "Different Cool Thing");
- assert.strictEqual(result.entities[0].isDirected, true);
+ assert.strictEqual(result.dependencies[0].from, "Cool Thing");
+ assert.strictEqual(
+ result.dependencies[0].to,
+ "Different Cool Thing",
+ );
+ assert.strictEqual(result.dependencies[0].isDirected, true);
});
it("should preserve case in dependency labels", async () => {
const source = "SaRcAsM -> Seriousness.";
const result = parse(source);
- assert.strictEqual(result.entities[0].from, "SaRcAsM");
- assert.strictEqual(result.entities[0].to, "Seriousness.");
+ assert.strictEqual(result.dependencies[0].from, "SaRcAsM");
+ assert.strictEqual(result.dependencies[0].to, "Seriousness.");
});
it("should ignore whitespace in dependencies", async () => {
const source = " loose --TIGHT";
const result = parse(source);
- assert.strictEqual(result.entities[0].from, "loose");
- assert.strictEqual(result.entities[0].to, "TIGHT");
+ assert.strictEqual(result.dependencies[0].from, "loose");
+ assert.strictEqual(result.dependencies[0].to, "TIGHT");
});
});
@@ -132,31 +140,30 @@ describe("wmap parser", () => {
const source = "[Note] (0.5, 0.5) This is a note";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "note");
- assert.deepStrictEqual(result.entities[0].coordinates, [0.5, 0.5]);
- assert.strictEqual(result.entities[0].text, "This is a note");
+ assert.strictEqual(result.notes.length, 1);
+ assert.deepStrictEqual(result.notes[0].coordinates, [0.5, 0.5]);
+ assert.strictEqual(result.notes[0].text, "This is a note");
});
it("should handle case insensitive note keyword", async () => {
const source = "[note] (0.1, 0.2) Text";
const result = parse(source);
- assert.strictEqual(result.entities[0].type, "note");
+ assert.strictEqual(result.notes.length, 1);
});
it("should preserve case in note text", async () => {
const source = "[NOTE] (0.77, 0.19) Important NOTE";
const result = parse(source);
- assert.strictEqual(result.entities[0].text, "Important NOTE");
+ assert.strictEqual(result.notes[0].text, "Important NOTE");
});
it("should handle empty note text", async () => {
const source = "[Note] (0.5, 0.5) ";
const result = parse(source);
- assert.strictEqual(result.entities[0].text, "");
+ assert.strictEqual(result.notes[0].text, "");
});
});
@@ -165,41 +172,40 @@ describe("wmap parser", () => {
const source = "[I] 0.25";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "stage");
- assert.strictEqual(result.entities[0].stage, "i");
- assert.strictEqual(result.entities[0].value, 0.25);
+ assert.strictEqual(result.stages.length, 1);
+ assert.strictEqual(result.stages[0].stage, "i");
+ assert.strictEqual(result.stages[0].value, 0.25);
});
it("should parse stage II", async () => {
const source = "[ii] 0.5";
const result = parse(source);
- assert.strictEqual(result.entities[0].stage, "ii");
- assert.strictEqual(result.entities[0].value, 0.5);
+ assert.strictEqual(result.stages[0].stage, "ii");
+ assert.strictEqual(result.stages[0].value, 0.5);
});
it("should parse stage III", async () => {
const source = "[III] 0.75";
const result = parse(source);
- assert.strictEqual(result.entities[0].stage, "iii");
- assert.strictEqual(result.entities[0].value, 0.75);
+ assert.strictEqual(result.stages[0].stage, "iii");
+ assert.strictEqual(result.stages[0].value, 0.75);
});
it("should parse stage IV", async () => {
const source = "[Iv] 1.0";
const result = parse(source);
- assert.strictEqual(result.entities[0].stage, "iv");
- assert.strictEqual(result.entities[0].value, 1.0);
+ assert.strictEqual(result.stages[0].stage, "iv");
+ assert.strictEqual(result.stages[0].value, 1.0);
});
it("should handle decimal stage values", async () => {
const source = "[I] .333";
const result = parse(source);
- assert.strictEqual(result.entities[0].value, 0.333);
+ assert.strictEqual(result.stages[0].value, 0.333);
});
});
@@ -208,16 +214,15 @@ describe("wmap parser", () => {
const source = "[Group] Lonely";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "group");
- assert.deepStrictEqual(result.entities[0].components, ["Lonely"]);
+ assert.strictEqual(result.groups.length, 1);
+ assert.deepStrictEqual(result.groups[0].components, ["Lonely"]);
});
it("should parse a group with multiple components", async () => {
const source = "[Group] Huey, Dewey, Louie";
const result = parse(source);
- assert.deepStrictEqual(result.entities[0].components, [
+ assert.deepStrictEqual(result.groups[0].components, [
"Huey",
"Dewey",
"Louie",
@@ -228,24 +233,25 @@ describe("wmap parser", () => {
const source = "[group] Salt, Pepper";
const result = parse(source);
- assert.strictEqual(result.entities[0].type, "group");
+ assert.strictEqual(result.groups.length, 1);
});
it("should preserve case in group component labels", async () => {
const source = "[GROUP] XML, LaTeX";
const result = parse(source);
- assert.deepStrictEqual(result.entities[0].components, [
+ assert.deepStrictEqual(result.groups[0].components, [
"XML",
"LaTeX",
]);
});
it("should handle whitespace around commas", async () => {
- const source = "[Group] sky, is large, emperor";
+ const source =
+ "[Group] sky, is large, emperor";
const result = parse(source);
- assert.deepStrictEqual(result.entities[0].components, [
+ assert.deepStrictEqual(result.groups[0].components, [
"sky",
"is large",
"emperor",
@@ -258,23 +264,22 @@ describe("wmap parser", () => {
const source = "[Inertia] Print Media";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "inertia");
- assert.strictEqual(result.entities[0].component, "Print Media");
+ assert.strictEqual(result.inertias.length, 1);
+ assert.strictEqual(result.inertias[0].component, "Print Media");
});
it("should handle case insensitive inertia keyword", async () => {
const source = "[inertia] Yes";
const result = parse(source);
- assert.strictEqual(result.entities[0].type, "inertia");
+ assert.strictEqual(result.inertias.length, 1);
});
it("should preserve case in inertia component label", async () => {
const source = "[INERTIA] SpOnGeBoB";
const result = parse(source);
- assert.strictEqual(result.entities[0].component, "SpOnGeBoB");
+ assert.strictEqual(result.inertias[0].component, "SpOnGeBoB");
});
});
@@ -283,38 +288,37 @@ describe("wmap parser", () => {
const source = "[Evolution] Nanomachines + 0.5";
const result = parse(source);
- assert.strictEqual(result.entities.length, 1);
- assert.strictEqual(result.entities[0].type, "evolution");
- assert.strictEqual(result.entities[0].component, "Nanomachines");
- assert.strictEqual(result.entities[0].value, 0.5);
+ assert.strictEqual(result.evolutions.length, 1);
+ assert.strictEqual(result.evolutions[0].component, "Nanomachines");
+ assert.strictEqual(result.evolutions[0].value, 0.5);
});
it("should parse evolution with negative sign", async () => {
const source = "[Evolution] FOXDIE - 0.3";
const result = parse(source);
- assert.strictEqual(result.entities[0].value, -0.3);
+ assert.strictEqual(result.evolutions[0].value, -0.3);
});
it("should handle case insensitive evolution keyword", async () => {
const source = "[evolution] tamales + 0.73";
const result = parse(source);
- assert.strictEqual(result.entities[0].type, "evolution");
+ assert.strictEqual(result.evolutions.length, 1);
});
it("should preserve case in evolution component label", async () => {
const source = "[EVOLUTION] iMac - 0.2";
const result = parse(source);
- assert.strictEqual(result.entities[0].component, "iMac");
+ assert.strictEqual(result.evolutions[0].component, "iMac");
});
it("should handle decimal evolution values", async () => {
const source = "[Evolution] Numerals + .75";
const result = parse(source);
- assert.strictEqual(result.entities[0].value, 0.75);
+ assert.strictEqual(result.evolutions[0].value, 0.75);
});
});
@@ -325,31 +329,29 @@ Bucket (0.8, 0.4) [x]
Water -> Bucket`;
const result = parse(source);
- assert.strictEqual(result.entities.length, 3);
- assert.strictEqual(result.entities[0].type, "component");
- assert.strictEqual(result.entities[1].type, "component");
- assert.strictEqual(result.entities[2].type, "dependency");
+ assert.strictEqual(result.components.length, 2);
+ assert.strictEqual(result.dependencies.length, 1);
});
it("should handle different line endings (LF)", async () => {
const source = "Penguins (0.9, 0.5)\nI Use Arch BTW (0.8, 0.4)";
const result = parse(source);
- assert.strictEqual(result.entities.length, 2);
+ assert.strictEqual(result.components.length, 2);
});
it("should handle different line endings (CRLF)", async () => {
const source = "Clippy (0.9, 0.5)\r\nSpace Cadet (0.8, 0.4)";
const result = parse(source);
- assert.strictEqual(result.entities.length, 2);
+ assert.strictEqual(result.components.length, 2);
});
it("should handle different line endings (CR)", async () => {
const source = "SE/30 (0.9, 0.5)\rPerforma (0.8, 0.4)";
const result = parse(source);
- assert.strictEqual(result.entities.length, 2);
+ assert.strictEqual(result.components.length, 2);
});
it("should handle empty lines", async () => {
@@ -358,21 +360,23 @@ Water -> Bucket`;
The Abyss (0.8, 0.4)`;
const result = parse(source);
- assert.strictEqual(result.entities.length, 2);
+ assert.strictEqual(result.components.length, 2);
});
it("should ignore invalid lines", async () => {
const source = `Hello (0.9, 0.5)
Oh No
It's OK (0.8, 0.4)
-NO IT ISN'T
+[ijole] NO IT ISN'T
+A--
+B->
Hello -> It's OK`;
const result = parse(source);
- assert.strictEqual(result.entities.length, 3);
- assert.strictEqual(result.entities[0].label, "Hello");
- assert.strictEqual(result.entities[1].label, "It's OK");
- assert.strictEqual(result.entities[2].type, "dependency");
+ assert.strictEqual(result.components.length, 2);
+ assert.strictEqual(result.components[0].label, "Hello");
+ assert.strictEqual(result.components[1].label, "It's OK");
+ assert.strictEqual(result.dependencies.length, 1);
});
});
@@ -381,21 +385,27 @@ Hello -> It's OK`;
const source = "";
const result = parse(source);
- assert.strictEqual(result.entities.length, 0);
+ assert.strictEqual(result.components.length, 0);
+ assert.strictEqual(result.dependencies.length, 0);
+ assert.strictEqual(result.notes.length, 0);
+ assert.strictEqual(result.stages.length, 0);
+ assert.strictEqual(result.groups.length, 0);
+ assert.strictEqual(result.inertias.length, 0);
+ assert.strictEqual(result.evolutions.length, 0);
});
it("should handle only whitespace", async () => {
const source = " \n \n ";
const result = parse(source);
- assert.strictEqual(result.entities.length, 0);
+ assert.strictEqual(result.components.length, 0);
});
it("should handle only invalid lines", async () => {
const source = "invalid\nstill invalid";
const result = parse(source);
- assert.strictEqual(result.entities.length, 0);
+ assert.strictEqual(result.components.length, 0);
});
it("should handle complex component labels", async () => {
@@ -403,7 +413,7 @@ Hello -> It's OK`;
const result = parse(source);
assert.strictEqual(
- result.entities[0].label,
+ result.components[0].label,
"My Sü'per Complex Label 123",
);
});
@@ -433,30 +443,22 @@ Kettle -> Hot Water
const result = parse(source);
- // 4 stages + 4 components + 3 dependencies + 1 note + 1 group + 1 inertia + 1 evolution = 15
- assert.strictEqual(result.entities.length, 15);
-
- assert.strictEqual(result.entities[0].type, "stage");
- assert.strictEqual(result.entities[1].type, "stage");
- assert.strictEqual(result.entities[2].type, "stage");
- assert.strictEqual(result.entities[3].type, "stage");
-
- assert.strictEqual(result.entities[4].type, "component");
- assert.strictEqual(result.entities[4].label, "Tea");
- assert.strictEqual(result.entities[4].shape, "circle");
-
- assert.strictEqual(result.entities[8].type, "dependency");
- assert.strictEqual(result.entities[8].from, "Tea");
- assert.strictEqual(result.entities[8].to, "Cup");
-
- assert.strictEqual(result.entities[11].type, "note");
+ // 4 stages + 4 components + 3 dependencies + 1 note + 1 group + 1 inertia + 1 evolution
+ assert.strictEqual(result.stages.length, 4);
+ assert.strictEqual(result.components.length, 4);
+ assert.strictEqual(result.dependencies.length, 3);
+ assert.strictEqual(result.notes.length, 1);
+ assert.strictEqual(result.groups.length, 1);
+ assert.strictEqual(result.inertias.length, 1);
+ assert.strictEqual(result.evolutions.length, 1);
- assert.strictEqual(result.entities[12].type, "group");
- assert.strictEqual(result.entities[12].components.length, 3);
+ assert.strictEqual(result.components[0].label, "Tea");
+ assert.strictEqual(result.components[0].shape, "circle");
- assert.strictEqual(result.entities[13].type, "inertia");
+ assert.strictEqual(result.dependencies[0].from, "Tea");
+ assert.strictEqual(result.dependencies[0].to, "Cup");
- assert.strictEqual(result.entities[14].type, "evolution");
+ assert.strictEqual(result.groups[0].components.length, 3);
});
});
});