├── .github └── workflows │ └── actions.yml ├── .gitignore ├── Eask ├── LICENSE ├── README.org ├── js-comint.el └── test ├── capf-tests.el ├── common.el ├── company-tests.el └── unit-tests.el /.github/workflows/actions.yml: -------------------------------------------------------------------------------- 1 | name: Run tests across emacs versions 2 | on: [push, pull_request] 3 | jobs: 4 | test-emacs-versions: 5 | strategy: 6 | matrix: 7 | emacs-version: [28, 29] 8 | runs-on: ubuntu-latest 9 | container: silex/emacs:${{matrix.emacs-version}}-ci-eask 10 | steps: 11 | - name: Check out repository code 12 | uses: actions/checkout@v4 13 | - uses: actions/setup-node@v4 14 | with: 15 | node-version: 20 16 | - name: Install test dependencies 17 | run: eask install-deps --dev 18 | - name: Run tests 19 | run: eask run script test 20 | lint: 21 | runs-on: ubuntu-latest 22 | container: silex/emacs:29-ci-eask 23 | steps: 24 | - name: Check out repository code 25 | uses: actions/checkout@v4 26 | - name: Install test dependencies 27 | run: eask install-deps --dev 28 | - name: Run linters 29 | run: eask lint declare --strict 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | .eask 3 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | (package "js-comint" 2 | "1.2.0" 3 | "JavaScript interpreter in window.") 4 | 5 | (website-url "https://github.com/redguardtoo/js-comint") 6 | (keywords "javascript" "node" "inferior-mode" "convenience") 7 | 8 | (package-file "js-comint.el") 9 | 10 | (script "test" "eask test ert test/*tests.el") 11 | 12 | (source "gnu") 13 | (source "melpa") 14 | 15 | (depends-on "emacs" "28.1") 16 | 17 | (development 18 | (depends-on "el-mock") 19 | (depends-on "nvm") 20 | (depends-on "company") 21 | (depends-on "ert-async")) 22 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * js-comint.el (v1.2.0) 2 | Run a JavaScript interpreter in an inferior process window 3 | 4 | The first release, [[http://js-comint-el.sourceforge.net/][js-comint 0.0.1, is hosted on sourceforge]] but it has not been updated for five years. 5 | 6 | * Features 7 | - Can select node.js versions using [[https://github.com/rejeep/nvm.el][nvm.el]] 8 | - Use [[https://nodejs.org][node.js]] by default. 9 | - When loading file, detect what API to be used automatically 10 | - Based on js-comint hosted on http://js-comint-el.sourceforge.net/ 11 | 12 | * Installation 13 | ** Direct download of js-comint.el 14 | Place the js-comint.el somewhere say "~/mylisp/". 15 | 16 | Insert below code to "~/.emacs.d/init.el", 17 | #+BEGIN_SRC elisp 18 | (add-to-list 'load-path "~/mylisp/") 19 | (require 'js-comint) 20 | #+END_SRC 21 | 22 | ** Using [[http://www.emacswiki.org/emacs/ELPA][ELPA]] 23 | Insert below code to "~/.emacs.d/init.el", 24 | #+BEGIN_SRC elisp 25 | (require 'package) 26 | (package-initialize) 27 | (add-to-list 'package-archives 28 | '("melpa" . "http://melpa.org/packages/")) 29 | (package-install 'js-comint) 30 | (require 'js-comint) 31 | #+END_SRC 32 | 33 | ** Using [[https://github.com/cask/cask][Cask]] 34 | Add js-comint to your Cask file: 35 | #+BEGIN_SRC elisp 36 | (depends-on "js-comint") 37 | #+END_SRC 38 | 39 | ** Windows 40 | On window, you may need below setup: 41 | #+begin_src elisp 42 | (setq js-comint-program-command "C:/Program Files/nodejs/node.exe") 43 | #+end_src 44 | * Usage 45 | After installation, do `M-x run-js` to create a comint buffer with the JavaScript interpreter. 46 | 47 | Please note the directory =node_modules= is *automatically* searched and appended into environment variable `NODE_PATH'. So you can use third party javascript without setup. For example, after =npm install --save moment=, run below command in js-comint shell, 48 | #+begin_src javascript 49 | require('moment')().format('YYYY-MM-DD'); 50 | #+end_src 51 | 52 | You can =M-x js-clear= before =M-x js-send-buffer= to get clean output. 53 | 54 | In order to get cleaner output when using NodeJS, I suggest add below setup into =.emacs=, 55 | #+begin_src elisp 56 | (defun inferior-js-mode-hook-setup () 57 | (add-hook 'comint-output-filter-functions 'js-comint-process-output)) 58 | (add-hook 'inferior-js-mode-hook 'inferior-js-mode-hook-setup t) 59 | #+end_src 60 | * Customization 61 | You can set the `js-comint-program-command' string and the `js-comint-program-arguments' list to the executable that runs the JS interpreter and the arguments to pass to it respectively. 62 | 63 | E.g., the default is: 64 | #+BEGIN_SRC elisp 65 | ;; You can also customize `js-comint-drop-regexp' to filter output 66 | (setq js-comint-program-command "node") 67 | (setq js-comint-program-arguments '("--interactive")) 68 | #+END_SRC 69 | 70 | Note that in the example above, the version of node that is picked up will be the first found in `exec-path'. 71 | 72 | But you could use Rhino or SpiderMonkey or whatever you want. 73 | E.g. to set up the Rhino JAR downloaded from https://github.com/mozilla/rhino, do 74 | 75 | #+BEGIN_SRC elisp 76 | (setq js-comint-program-command "java") 77 | (setq js-comint-program-arguments '("-jar" "/absolute/path/to/rhino/js.jar")) 78 | #+END_SRC 79 | 80 | If you have nvm, you can select the versions of node.js installed and run them. This is done thanks to =nvm.el=. =nvm.el= is optional. So you need *manually* install it. 81 | 82 | To enable nvm support, run 83 | #+BEGIN_SRC elisp 84 | (js-do-use-nvm) 85 | #+END_SRC 86 | 87 | The first time you start the JS interpreter with run-js, you will be asked to select a version of node.js. If you want to change version of node js, run ~(js-select-node-version)~. 88 | 89 | You can add the following couple of lines to your .emacs/init file to take advantage of key bindings for sending things to the JavaScript REPL: 90 | 91 | #+BEGIN_SRC elisp 92 | ; Remap Elisp's eval-last-sexp (C-x C-e) to eval JavaScript 93 | (define-key js-mode-map [remap eval-last-sexp] #'js-comint-send-last-sexp)) 94 | (define-key js-mode-map (kbd "C-c b") 'js-send-buffer)) 95 | #+END_SRC 96 | -------------------------------------------------------------------------------- /js-comint.el: -------------------------------------------------------------------------------- 1 | ;;; js-comint.el --- JavaScript interpreter in window. -*- lexical-binding: t -*- 2 | 3 | ;;; Copyright (C) 2008 Paul Huff 4 | ;;; Copyright (C) 2015 Stefano Mazzucco 5 | ;;; Copyright (C) 2016-2020 Chen Bin 6 | 7 | ;;; Author: Paul Huff , Stefano Mazzucco 8 | ;;; Maintainer: Chen Bin 9 | ;;; Created: 15 Feb 2014 10 | ;;; Version: 1.2.0 11 | ;;; URL: https://github.com/redguardtoo/js-comint 12 | ;;; Package-Requires: ((emacs "28.1")) 13 | ;;; Keywords: javascript, node, inferior-mode, convenience 14 | 15 | ;; This file is NOT part of GNU Emacs. 16 | 17 | ;;; License: 18 | 19 | ;; This program is free software; you can redistribute it and/or 20 | ;; modify it under the terms of the GNU General Public License as 21 | ;; published by the Free Software Foundation; either version 3, or 22 | ;; at your option any later version. 23 | 24 | ;; js-comint.el is distributed in the hope that it will be useful, but 25 | ;; WITHOUT ANY WARRANTY; without even the implied warranty of 26 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 27 | ;; General Public License for more details. 28 | 29 | ;; You should have received a copy of the GNU General Public License 30 | ;; along with GNU Emacs; see the file COPYING, or type `C-h C-c'. If 31 | ;; not, write to the Free Software Foundation at this address: 32 | 33 | ;; Free Software Foundation 34 | ;; 51 Franklin Street, Fifth Floor 35 | ;; Boston, MA 02110-1301 36 | ;; USA 37 | 38 | ;;; Commentary: 39 | 40 | ;; This program is a comint mode for Emacs which allows you to run a 41 | ;; compatible javascript repl like Node.js/Spidermonkey/Rhino inside Emacs. 42 | ;; It also defines a few functions for sending javascript input to it 43 | ;; quickly. 44 | 45 | ;; Usage: 46 | ;; Put js-comint.el in your load path 47 | ;; Add (require 'js-comint) to your .emacs or ~/.emacs.d/init.el 48 | ;; 49 | ;; Optionally, set the `js-comint-program-command' string 50 | ;; and the `js-comint-program-arguments' list to the executable that runs 51 | ;; the JS interpreter and the arguments to pass to it respectively. 52 | ;; For example, on windows you might need below setup: 53 | ;; (setq js-comint-program-command "C:/Program Files/nodejs/node.exe") 54 | ;; 55 | ;; After setup, do: `M-x js-comint-repl' 56 | ;; Away you go. 57 | ;; `node_modules' is *automatically* searched and appended into environment 58 | ;; variable `NODE_PATH'. So 3rd party javascript is usable out of box. 59 | 60 | ;; If you have nvm, you can select the versions of node.js installed and run 61 | ;; them. This is done thanks to nvm.el. 62 | ;; Please note nvm.el is optional. So you need *manually* install it. 63 | ;; To enable nvm support, run `js-do-use-nvm'. 64 | ;; The first time you start the JS interpreter with `js-comint-repl', you will 65 | ;;be asked to select a version of Node.js 66 | ;; If you want to change version of node js, run `js-comint-select-node-version' 67 | ;; 68 | ;; `js-comint-clear' clears the content of REPL. 69 | ;; 70 | ;; You may get cleaner output by following setup (highly recommended): 71 | ;; 72 | ;; Output matching `js-comint-drop-regexp' will be dropped silently 73 | ;; 74 | ;; You can add the following lines to your .emacs to take advantage of 75 | ;; cool keybindings for sending things to the javascript interpreter inside 76 | ;; of Steve Yegge's most excellent js2-mode. 77 | ;; 78 | ;; (add-hook 'js2-mode-hook 79 | ;; (lambda () 80 | ;; (local-set-key (kbd "C-x C-e") 'js-send-last-sexp) 81 | ;; (local-set-key (kbd "C-c b") 'js-send-buffer))) 82 | 83 | ;;; Code: 84 | 85 | (require 'js) 86 | (require 'comint) 87 | (require 'ansi-color) 88 | (require 'cl-lib) 89 | 90 | (defgroup js-comint nil 91 | "Run a javascript process in a buffer." 92 | :group 'js-comint) 93 | 94 | (defcustom js-comint-program-command "node" 95 | "JavaScript interpreter." 96 | :type 'string 97 | :group 'js-comint) 98 | 99 | (defcustom js-comint-set-env-when-startup t 100 | "Set environment variable NODE_PATH automatically during startup." 101 | :type 'boolean 102 | :group 'js-comint) 103 | 104 | (defvar js-comint-module-paths '() 105 | "List of modules paths which could be used by NodeJS to search modules.") 106 | 107 | (defvar js-comint-drop-regexp 108 | "\\(\x1b\\[[0-9]+[GJK]\\|^[ \t]*undefined[\r\n]+\\)" 109 | "Regex to silence matching output.") 110 | 111 | (defcustom js-comint-program-arguments '() 112 | "List of command line arguments passed to the JavaScript interpreter." 113 | :type '(list string) 114 | :group 'js-comint) 115 | 116 | (defcustom js-comint-prompt "> " 117 | "Prompt used in `js-comint-mode'." 118 | :group 'js-comint 119 | :type 'string) 120 | 121 | (defcustom js-comint-mode-hook nil 122 | "*Hook for customizing js-comint mode." 123 | :type 'hook 124 | :group 'js-comint) 125 | 126 | (defcustom js-use-nvm nil 127 | "When t, use NVM. Requires nvm.el." 128 | :type 'boolean 129 | :group 'js-comint) 130 | 131 | (defvar js-comint-buffer "Javascript REPL" 132 | "Name of the inferior JavaScript buffer.") 133 | 134 | ;; process.stdout.columns should be set. 135 | ;; but process.stdout.columns in Emacs is infinity because Emacs returns 0 as winsize.ws_col. 136 | ;; The completion candidates won't be displayed if process.stdout.columns is infinity. 137 | ;; see also `handleGroup` function in readline.js 138 | (defvar js-comint-code-format 139 | (concat 140 | "process.stdout.columns = %d;" 141 | "require('repl').start({ 142 | \"prompt\": '%s', 143 | \"ignoreUndefined\": true, 144 | \"preview\": true, 145 | \"replMode\": require('repl')['REPL_MODE_' + '%s'.toUpperCase()] 146 | })")) 147 | 148 | (defvar js-nvm-current-version nil 149 | "Current version of node for js-comint. 150 | Either nil or a list (VERSION-STRING PATH).") 151 | 152 | (declare-function nvm--installed-versions "nvm.el" ()) 153 | (declare-function nvm--find-exact-version-for "nvm.el" (short)) 154 | 155 | ;; company.el declarations 156 | (defvar company-backends) 157 | (declare-function company-begin-backend "company.el" (backend &optional callback)) 158 | (declare-function company-in-string-or-comment "company.el" nil) 159 | 160 | (defun js-comint-list-nvm-versions (prompt) 161 | "List all available node versions from nvm prompting the user with PROMPT. 162 | Return a string representing the node version." 163 | (let ((candidates (sort (mapcar 'car (nvm--installed-versions)) 'string<))) 164 | (completing-read prompt 165 | candidates nil t nil 166 | nil 167 | (car candidates)))) 168 | 169 | ;;;###autoload 170 | (defun js-do-use-nvm () 171 | "Enable nvm." 172 | (setq js-use-nvm t)) 173 | 174 | ;;;###autoload 175 | (defun js-comint-select-node-version (&optional version) 176 | "Use a given VERSION of node from nvm." 177 | (interactive) 178 | (require 'nvm) 179 | (setq js-use-nvm t) ;; NOTE: js-use-nvm could probably be deprecated 180 | (unless version 181 | (let* ((old-js-nvm (car js-nvm-current-version)) 182 | (prompt (if old-js-nvm 183 | (format "Node version (current %s): " old-js-nvm) 184 | "Node version: "))) 185 | (setq version (js-comint-list-nvm-versions prompt)))) 186 | 187 | (setq js-nvm-current-version (nvm--find-exact-version-for version) 188 | js-comint-program-command (format "%s/bin/node" (cadr js-nvm-current-version)))) 189 | 190 | (defun js-comint-guess-load-file-cmd (filename) 191 | "Create Node file loading command for FILENAME." 192 | (concat "require(\"" filename "\")\n")) 193 | 194 | (defun js-comint-quit-or-cancel () 195 | "Send ^C to Javascript REPL." 196 | (interactive) 197 | (process-send-string (js-comint-get-process) "\x03")) 198 | 199 | (defun js-comint--path-sep () 200 | "Separator of file path." 201 | (if (eq system-type 'windows-nt) ";" ":")) 202 | 203 | (defun js-comint--suggest-module-path () 204 | "Path to node_modules in parent dirs, or nil if none exists." 205 | (when-let ((dir (locate-dominating-file default-directory "node_modules"))) 206 | (expand-file-name "node_modules" dir))) 207 | 208 | (defun js-comint-get-process () 209 | "Get repl process." 210 | (and js-comint-buffer 211 | (get-process js-comint-buffer))) 212 | 213 | ;;;###autoload 214 | (defun js-comint-add-module-path () 215 | "Add a directory to `js-comint-module-paths'." 216 | (interactive) 217 | (let ((dir (read-directory-name "Module path:" 218 | (js-comint--suggest-module-path)))) 219 | (when dir 220 | (add-to-list 'js-comint-module-paths (file-truename dir)) 221 | (message "\"%s\" added to `js-comint-module-paths'" dir)))) 222 | 223 | ;;;###autoload 224 | (defun js-comint-delete-module-path () 225 | "Delete a directory from `js-comint-module-paths'." 226 | (interactive) 227 | (cond 228 | ((not js-comint-module-paths) 229 | (message "`js-comint-module-paths' is empty.")) 230 | (t 231 | (let* ((dir (ido-completing-read "Directory to delete: " 232 | js-comint-module-paths))) 233 | (when dir 234 | (setq js-comint-module-paths 235 | (delete dir js-comint-module-paths)) 236 | (message "\"%s\" delete from `js-comint-module-paths'" dir)))))) 237 | 238 | ;;;; Completions: 239 | (defun js-comint--process-completion-output (completion prefix) 240 | "Format COMPLETION string as a list of candidates. 241 | PREFIX is the original completion prefix string." 242 | (let* ((completion (replace-regexp-in-string "\\[[[:digit:]]+[[:alpha:]]+" "" completion)) 243 | (completion-lines (split-string completion " \n" 't)) 244 | ;; in a single completion the node REPL optionally prints type information in a comment 245 | (completion-lines (seq-remove (apply-partially #'string-prefix-p "//") 246 | completion-lines)) 247 | (completion-tokens (seq-mapcat (lambda (x) (split-string x nil 't)) completion-lines)) 248 | (trimmed-prompt (string-trim js-comint-prompt)) 249 | (completion-res (seq-remove (lambda (x) (or (equal x prefix) 250 | (equal x trimmed-prompt) 251 | (equal x "..."))) 252 | completion-tokens))) 253 | completion-res)) 254 | 255 | (defvar-local js-comint--completion-callbacks nil 256 | "List of pending callbacks. 257 | Each should be a plist with last-prompt-start, input-string, type, 258 | function. See `js-comint--set-completion-callback'.") 259 | 260 | (defvar-local js-comint--completion-buffer nil 261 | "Buffer for completion output.") 262 | 263 | (defun js-comint--clear-completion-state () 264 | "Clear stored partial completions." 265 | (when js-comint--completion-buffer 266 | (with-current-buffer js-comint--completion-buffer 267 | (erase-buffer)))) 268 | 269 | (defun js-comint--callback-active-p (callback) 270 | "Non-nil if CALLBACK should be used given current prompt location and input." 271 | (and 272 | (equal 273 | ;; marker for the prompt active when callback was created 274 | (plist-get callback :last-prompt-start) 275 | ;; start prompt marker, must be in comint buffer 276 | (car comint-last-prompt)) 277 | ;; check input-string 278 | (or 279 | ;; "clear" callbacks always fire 280 | (equal 'clear (plist-get callback :type)) 281 | ;; otherwise, if inputs are different, then not active 282 | (equal (js-comint--current-input) (plist-get callback :input-string))))) 283 | 284 | (defun js-comint--async-output-filter (output) 285 | "Dispatches callbacks listening for comint OUTPUT." 286 | (cond 287 | ((null js-comint--completion-callbacks) 288 | output) 289 | ;; Assuming most recent callbacks are at head of the list 290 | ;; If the head is not active, then discard all in the list 291 | ((not (js-comint--callback-active-p (car js-comint--completion-callbacks))) 292 | (prog1 output 293 | (js-comint--clear-completion-state) 294 | (setq js-comint--completion-callbacks nil))) 295 | (t 296 | (prog1 "" 297 | ;; first write output to completion-buffer 298 | (unless (bufferp js-comint--completion-buffer) 299 | (setq js-comint--completion-buffer (generate-new-buffer " *js-comint completion*" t))) 300 | (with-current-buffer js-comint--completion-buffer 301 | (goto-char (point-max)) 302 | (insert output)) 303 | ;; call only the active ones, discard others 304 | (let ((active-callbacks (seq-filter 305 | #'js-comint--callback-active-p 306 | js-comint--completion-callbacks))) 307 | ;; Some callbacks may add further callbacks during their execution. 308 | ;; Re-add any pending callbacks to avoid overwriting new callbacks. 309 | (setq js-comint--completion-callbacks nil) 310 | (dolist (cb active-callbacks) 311 | ;; if the callback exits with non-nil or signals, remove it 312 | (unless (condition-case err 313 | (funcall (plist-get cb :function)) 314 | (t (prog1 t 315 | (message "Error in callback %s" (cdr err))))) 316 | (push cb js-comint--completion-callbacks)))) 317 | (if js-comint--completion-callbacks 318 | (accept-process-output (js-comint-get-process) 0.4) 319 | ;; otherwise reset 320 | (js-comint--clear-completion-state)))))) 321 | 322 | (defun js-comint--completion-looking-back-p (regexp) 323 | "Call `looking-back' with REGEXP on `js-comint--completion-buffer'." 324 | (with-current-buffer js-comint--completion-buffer 325 | (goto-char (point-max)) 326 | (looking-back regexp (line-beginning-position)))) 327 | 328 | (defun js-comint--set-completion-callback (callback type) 329 | "Add CALLBACK to listen for completion output. 330 | TYPE is a symbol describing the callback, either \"clear\" or \"completion\"." 331 | (push `(:last-prompt-start 332 | ,(car comint-last-prompt) 333 | :input-string 334 | ,(js-comint--current-input) 335 | :type 336 | ,type 337 | :function 338 | ,callback) 339 | js-comint--completion-callbacks)) 340 | 341 | (defun js-comint--complete-substring (input-string) 342 | "Given a full line in INPUT-STRING return the substring to complete." 343 | (if-let ((match (string-match-p "[[:space:](\\[{;]\\([[:word:].]*\\)$" input-string))) 344 | (string-trim (substring-no-properties input-string (1+ match))) 345 | input-string)) 346 | 347 | (defun js-comint--get-completion-async (input-string callback) 348 | "Complete INPUT-STRING and register CALLBACK to recieve completion output." 349 | (js-comint--clear-completion-state) 350 | (js-comint--set-completion-callback 351 | ;; callback closure 352 | (let (tab-sent ;; flag tracking repeat tabs: Array\t => \t 353 | check-sent ;; flag tracking whether check has been sent 354 | finished) ;; flag tracking if 'callback' has been called, referred to by inner closures 355 | (lambda () 356 | (cond 357 | ;; case: exact match to input-string in output 358 | ((and (not (string-empty-p input-string)) 359 | (js-comint--completion-looking-back-p (regexp-quote input-string))) 360 | ;; Completions like "Array." need a second tab after the response 361 | (cond 362 | ((and (string-suffix-p "." input-string) 363 | (not tab-sent)) 364 | (prog1 nil ;; do not remove callback 365 | (setq tab-sent 't) 366 | ;; When completing "Array." this will get a list of props 367 | (process-send-string (js-comint-get-process) "\t") 368 | ;; When the completion does not exist, e.g. "foo." there is no response to this tab 369 | ;; Instead, schedule a callback that produces a prompt, e.g. "> foo." 370 | ;; This might happen after completion is finished, either by other input or clearing, 371 | ;; so check to avoid adding garbage output. 372 | (run-at-time 1 nil (lambda () (unless (or finished (not js-comint--completion-callbacks)) 373 | (process-send-string (js-comint-get-process) " \b")))))) 374 | ;; Output may sometimes be staggered "Arr|ay" so the completion appears stepwise 375 | ((not check-sent) 376 | (prog1 nil ;; do not remove callback 377 | (setq check-sent 't) 378 | ;; This "wiggles" the cursor making node repeat the prompt with current input 379 | (process-send-string (js-comint-get-process) " \b"))) 380 | ;; Otherwise there was no match (after retry). 381 | ;; The wiggle should cause a prompt to be echoed, so this case likely does not occur. 382 | ;; Probably useful to keep for edge cases though. 383 | ('t 384 | (prog1 't ;; remove callback 385 | (unwind-protect 386 | (funcall callback nil) 387 | (js-comint--clear-input-async)))))) 388 | ;; case: found a control character (usually part of a prompt) 389 | ((or check-sent 390 | (js-comint--completion-looking-back-p "\\[[[:digit:]]+[AJG]$")) 391 | (setq finished 't) 392 | (let* ((completion-output (with-current-buffer js-comint--completion-buffer 393 | (buffer-string))) 394 | (completion-res (js-comint--process-completion-output 395 | completion-output 396 | input-string))) 397 | (unwind-protect 398 | (funcall callback completion-res) 399 | (js-comint--clear-input-async)) 400 | 't)) 401 | ;; all other cases 402 | ('t 403 | ;; expect that the callback will be removed 404 | nil)))) 405 | 'completion) 406 | 407 | ;; Need to send 2x tabs to trigger completion when there is no input 408 | ;; 1st tab usually does common prefix 409 | (when (string-empty-p input-string) 410 | (process-send-string 411 | (js-comint-get-process) 412 | "\t")) 413 | 414 | (process-send-string 415 | (js-comint-get-process) 416 | (format "%s\t" input-string))) 417 | 418 | (defun js-comint--clear-input-async () 419 | "Clear input already sent to the REPL. 420 | This is used specifically to remove input used to trigger completion." 421 | (js-comint--set-completion-callback 422 | (lambda () 423 | ;; mask output until the REPL echoes a prompt 424 | (js-comint--completion-looking-back-p (concat js-comint-prompt "\\[[[:digit:]]+[AG]$"))) 425 | 'clear) 426 | 427 | (process-send-string 428 | (js-comint-get-process) 429 | ;; this is the symbol for "cut" 430 | "")) 431 | 432 | (defun js-comint--current-input () 433 | "Return current comint input relative to point. 434 | Nil if point is before the current prompt." 435 | (let ((pmark (process-mark (js-comint-get-process)))) 436 | (when (>= (point) (marker-position pmark)) 437 | (buffer-substring pmark (point))))) 438 | 439 | (defun js-comint--should-complete () 440 | "Non-nil if completion should be attempted on text before point." 441 | (let* ((parse (syntax-ppss)) 442 | (string-or-comment (or (nth 3 parse) (nth 4 parse) (nth 7 parse)))) 443 | (cond 444 | (string-or-comment 445 | nil) 446 | ((looking-back "\\." (line-beginning-position)) 447 | 't) 448 | ((looking-back "[[:punct:][:space:]]" (line-beginning-position)) 449 | nil) 450 | (t 451 | 't)))) 452 | 453 | ;;;###autoload 454 | (defun company-js-comint (command &optional arg &rest _ignored) 455 | "Wraps node REPL completion for company." 456 | (interactive (list 'interactive)) 457 | (cl-case command 458 | ((interactive) 459 | (company-begin-backend 'company-js-comint)) 460 | ((prefix) 461 | (when (equal major-mode 'js-comint-mode) 462 | (if (js-comint--should-complete) 463 | (js-comint--complete-substring (js-comint--current-input)) 464 | 'stop))) 465 | ((candidates) 466 | (cons :async (apply-partially #'js-comint--get-completion-async arg))))) 467 | 468 | (with-eval-after-load 'company 469 | (cl-pushnew #'company-js-comint company-backends)) 470 | 471 | ;; loosely follows cape-company-to-capf 472 | (defun js-comint--capf () 473 | "Convert `company-js-comint' function to a completion-at-point-function." 474 | (when-let ((_ (js-comint--should-complete)) 475 | (initial-input (js-comint--complete-substring (js-comint--current-input)))) 476 | (let* ((end (point)) 477 | (beg (- end (length initial-input))) 478 | restore-props) 479 | (list beg end 480 | (completion-table-dynamic 481 | (lambda (input) 482 | (let ((cands 'js-comint--waiting)) 483 | (js-comint--get-completion-async input (lambda (arg) (setq cands arg))) 484 | ;; Force synchronization, not interruptible! We use polling 485 | ;; here and ignore pending input since we don't use 486 | ;; `sit-for'. This is the same method used by Company itself. 487 | (while (eq cands 'js-comint--waiting) 488 | (sleep-for 0.01)) 489 | ;; The candidate string including text properties should be 490 | ;; restored in the :exit-function 491 | (setq restore-props cands) 492 | (cons (apply-partially #'string-prefix-p input) cands))) 493 | t) 494 | :exclusive 'no 495 | :exit-function (lambda (x _status) 496 | ;; Restore the candidate string including 497 | ;; properties if restore-props is non-nil. See 498 | ;; the comment above. 499 | (setq x (or (car (member x restore-props)) x)) 500 | nil))))) 501 | 502 | ;;;###autoload 503 | (defun js-comint-save-setup () 504 | "Save current setup to \".dir-locals.el\"." 505 | (interactive) 506 | (let* (sexp 507 | (root (read-directory-name "Where to create .dir-locals.el: " 508 | default-directory)) 509 | (file (concat (file-name-as-directory root) 510 | ".dir-locals.el"))) 511 | (cond 512 | (js-comint-module-paths 513 | (setq sexp (list (list nil (cons 'js-comint-module-paths js-comint-module-paths)))) 514 | (with-temp-buffer 515 | (insert (format "%S" sexp)) 516 | (write-file file) 517 | (message "%s created." file))) 518 | (t 519 | (message "Nothing to save. `js-comint-module-paths' is empty."))))) 520 | 521 | ;;;###autoload 522 | (defun js-comint-reset-repl () 523 | "Kill existing REPL process if possible. 524 | Create a new Javascript REPL process." 525 | (interactive) 526 | (when (js-comint-get-process) 527 | (process-send-string (js-comint-get-process) ".exit\n") 528 | ;; wait the process to be killed 529 | (sit-for 1)) 530 | (js-comint-start-or-switch-to-repl)) 531 | 532 | (defun js-comint-filter-output (_string) 533 | "Filter extra escape sequences from last output." 534 | (let ((beg (or comint-last-output-start 535 | (point-min-marker))) 536 | (end (process-mark (get-buffer-process (current-buffer))))) 537 | (save-excursion 538 | (goto-char beg) 539 | ;; Remove ansi escape sequences used in readline.js 540 | (while (re-search-forward js-comint-drop-regexp end t) 541 | (replace-match ""))))) 542 | 543 | (defun js-comint-get-buffer-name () 544 | "Get repl buffer name." 545 | (format "*%s*" js-comint-buffer)) 546 | 547 | (defun js-comint-get-buffer () 548 | "Get rpl buffer." 549 | (and js-comint-buffer 550 | (get-buffer (js-comint-get-buffer-name)))) 551 | 552 | ;;;###autoload 553 | (defun js-comint-clear () 554 | "Clear the Javascript REPL." 555 | (interactive) 556 | (let* ((buf (js-comint-get-buffer) ) 557 | (old-buf (current-buffer))) 558 | (save-excursion 559 | (cond 560 | ((buffer-live-p buf) 561 | (switch-to-buffer buf) 562 | (erase-buffer) 563 | (switch-to-buffer old-buf) 564 | (message "Javascript REPL cleared.")) 565 | (t 566 | (error "Javascript REPL buffer doesn't exist!")))))) 567 | (defalias 'js-clear 'js-comint-clear) 568 | 569 | 570 | ;;;###autoload 571 | (defun js-comint-start-or-switch-to-repl () 572 | "Start a new repl or switch to existing repl." 573 | (interactive) 574 | (if (js-comint-get-process) 575 | (pop-to-buffer (js-comint-get-buffer)) 576 | (let* ((node-path (getenv "NODE_PATH")) 577 | ;; The path to a local node_modules 578 | (node-modules-path (and js-comint-set-env-when-startup 579 | (js-comint--suggest-module-path))) 580 | (all-paths-list (flatten-list (list node-path 581 | node-modules-path 582 | js-comint-module-paths))) 583 | (all-paths-list (seq-remove 'string-empty-p all-paths-list)) 584 | (local-node-path (string-join all-paths-list (js-comint--path-sep))) 585 | (js-comint-code (format js-comint-code-format 586 | (window-width) 587 | js-comint-prompt 588 | (or (getenv "NODE_REPL_MODE") "sloppy"))) 589 | ;; NOTE: it's recommended not to use NODE_PATH 590 | (environment `("TERM=emacs" 591 | "NODE_NO_READLINE=1" 592 | ,(format "NODE_PATH=%s" local-node-path)))) 593 | (pop-to-buffer 594 | (apply 'make-comint js-comint-buffer "env" nil 595 | `(,@environment ,js-comint-program-command ,@js-comint-program-arguments "-e" ,js-comint-code))) 596 | (js-comint-mode)))) 597 | 598 | ;;;###autoload 599 | (defun js-comint-repl (&optional cmd) 600 | "Start a NodeJS REPL process. 601 | Optional CMD will override `js-comint-program-command' and 602 | `js-comint-program-arguments', as well as any nvm setting. 603 | 604 | When called interactively use a universal prefix to 605 | set CMD." 606 | (interactive 607 | (when current-prefix-arg 608 | (list 609 | (read-string "Run js: " 610 | (string-join 611 | (cons js-comint-program-command 612 | js-comint-program-arguments) 613 | " "))))) 614 | (if cmd 615 | (let ((cmd-parts (split-string cmd))) 616 | (setq js-comint-program-arguments (cdr cmd-parts) 617 | js-comint-program-command (car cmd-parts)) 618 | (when js-nvm-current-version 619 | (message "nvm node version overridden, reset with M-x js-comint-select-node-version") 620 | (setq js-use-nvm nil))) 621 | (when (and js-use-nvm 622 | (not js-nvm-current-version)) 623 | (js-comint-select-node-version))) 624 | 625 | (js-comint-start-or-switch-to-repl)) 626 | 627 | (defalias 'run-js 'js-comint-repl) 628 | 629 | (defun js-comint-send-string (str) 630 | "Send STR to repl." 631 | (let ((lines (split-string str "\n"))) 632 | (if (= (length lines) 1) 633 | (comint-send-string (js-comint-get-process) 634 | (concat str "\n")) 635 | (comint-send-string (js-comint-get-process) 636 | (concat ".editor" "\n" str "\n")) 637 | (process-send-eof (js-comint-get-process))))) 638 | 639 | ;;;###autoload 640 | (defun js-comint-send-region () 641 | "Send the current region to the inferior Javascript process. 642 | If no region selected, you could manually input javascript expression." 643 | (interactive) 644 | (let* ((str (if (region-active-p) 645 | (buffer-substring-no-properties (region-beginning) (region-end)) 646 | (read-string "input js expression: ")))) 647 | (js-comint-send-string str))) 648 | 649 | ;;;###autoload 650 | (defalias 'js-send-region 'js-comint-send-region) 651 | 652 | ;;;###autoload 653 | (defun js-comint-send-last-sexp () 654 | "Send the previous sexp to the inferior Javascript process." 655 | (interactive) 656 | (let* ((b (save-excursion 657 | (backward-sexp) 658 | (move-beginning-of-line nil) 659 | (point))) 660 | (e (if (and (boundp 'evil-mode) 661 | evil-mode 662 | (eq evil-state 'normal)) 663 | (+ 1 (point)) 664 | (point))) 665 | (str (buffer-substring-no-properties b e))) 666 | (js-comint-send-string str))) 667 | 668 | ;;;###autoload 669 | (defalias 'js-send-last-sexp 'js-comint-send-last-sexp) 670 | 671 | ;;;###autoload 672 | (defun js-comint-send-buffer () 673 | "Send the buffer to the inferior Javascript process." 674 | (interactive) 675 | (js-comint-send-string 676 | (buffer-substring-no-properties (point-min) 677 | (point-max)))) 678 | 679 | ;;;###autoload 680 | (defalias 'js-send-buffer 'js-comint-send-buffer) 681 | 682 | ;;;###autoload 683 | (defun js-comint-load-file (file) 684 | "Load FILE into the javascript interpreter." 685 | (interactive "f") 686 | (let ((file (expand-file-name file))) 687 | (js-comint-repl) 688 | (comint-send-string (js-comint-get-process) (js-comint-guess-load-file-cmd file)))) 689 | 690 | ;;;###autoload 691 | (defalias 'js-load-file 'js-comint-load-file) 692 | 693 | (defalias 'switch-to-js 'js-comint-start-or-switch-to-repl) 694 | 695 | (defvar js-comint-mode-map 696 | (let ((map (make-sparse-keymap))) 697 | (define-key map (kbd "C-c C-c") 'js-comint-quit-or-cancel) 698 | map)) 699 | 700 | (defun js-comint-unload-function () 701 | "Cleanup mode settings." 702 | (when company-backends 703 | (setq company-backends 704 | (delete #'company-js-comint company-backends)))) 705 | 706 | (defun js-comint--cleanup () 707 | "Runs after comint buffer is killed." 708 | (when js-comint--completion-buffer 709 | (kill-buffer js-comint--completion-buffer))) 710 | 711 | ;;;###autoload 712 | (define-derived-mode js-comint-mode comint-mode "Javascript REPL" 713 | :group 'js-comint 714 | :syntax-table js-mode-syntax-table 715 | (setq-local font-lock-defaults (list js--font-lock-keywords)) 716 | ;; No echo 717 | (setq comint-process-echoes t) 718 | ;; Ignore duplicates 719 | (setq comint-input-ignoredups t) 720 | (add-hook 'comint-output-filter-functions 'js-comint-filter-output nil t) 721 | (add-hook 'comint-preoutput-filter-functions #'js-comint--async-output-filter nil t) 722 | (add-hook 'kill-buffer-hook #'js-comint--cleanup nil t) 723 | (unless (featurep 'company) 724 | (add-hook 'completion-at-point-functions #'js-comint--capf nil t)) 725 | (process-put (js-comint-get-process) 726 | 'adjust-window-size-function (lambda (_process _windows) ())) 727 | (use-local-map js-comint-mode-map) 728 | (ansi-color-for-comint-mode-on)) 729 | 730 | (provide 'js-comint) 731 | ;;; js-comint.el ends here 732 | -------------------------------------------------------------------------------- /test/capf-tests.el: -------------------------------------------------------------------------------- 1 | ;; -*- lexical-binding: t -*- 2 | 3 | (require 'js-comint) 4 | (require 'ert) 5 | (require 'ert-async) 6 | 7 | (load-file "./test/common.el") 8 | 9 | ;;; Integration tests for native completion 10 | 11 | ;; quick fix for eask bug that improperly fails tests which use minibuffer 12 | ;; see https://github.com/emacs-eask/cli/pull/286 13 | ;; can be removed once fix is available in CI images 14 | (when (advice-member-p 'eask-test-ert--message 'message) 15 | (message "override advice") 16 | (define-advice message (:before-until (&rest args)) 17 | (not (car args)))) 18 | 19 | (ert-deftest js-comint/test-capf-init () 20 | "When company is not loaded should use CAPF." 21 | (when (featurep 'company) 22 | (unload-feature 'company 't)) 23 | (with-new-js-comint-buffer 24 | (should-not (equal completion-at-point-functions 25 | (default-value 'completion-at-point-functions))))) 26 | 27 | (ert-deftest js-comint/test-capf-unique-result () 28 | "Completing with a unique result. 29 | E.g. Arr => Array, or conso => console." 30 | (when (featurep 'company) 31 | (unload-feature 'company 't)) 32 | (with-new-js-comint-buffer 33 | (sit-for 1) 34 | (insert "Arra") 35 | (completion-at-point) 36 | (should (looking-back "Array")))) 37 | 38 | ;; note that completion-at-point does not seem to work for an empty prompt 39 | 40 | (ert-deftest js-comint/test-capf-complete-props () 41 | "Completing props of an object. 42 | E.g. should complete \"Array.\" to all properties." 43 | (when (featurep 'company) 44 | (unload-feature 'company 't)) 45 | (with-new-js-comint-buffer 46 | (sit-for 1) 47 | (insert "Array.") 48 | (completion-at-point) 49 | (with-selected-window (get-buffer-window "*Completions*") 50 | (next-completion 1) 51 | (choose-completion)) 52 | (should (looking-back "Array.__proto__")))) 53 | 54 | (ert-deftest js-comint/test-capf-complete-long-line () 55 | "Completing part of a line. 56 | E.g. 'if (true) { console.'" 57 | (when (featurep 'company) 58 | (unload-feature 'company 't)) 59 | (with-new-js-comint-buffer 60 | (sit-for 1) 61 | (insert "if (true) { console.") 62 | (completion-at-point) 63 | (with-selected-window (get-buffer-window "*Completions*") 64 | (next-completion 1) 65 | (choose-completion)) 66 | (should (looking-back "console.__proto__")))) 67 | 68 | (ert-deftest-async js-comint/test-capf-no-props (done) 69 | "Completing a string with trailing dot should not hang." 70 | (when (featurep 'company) 71 | (unload-feature 'company 't)) 72 | (with-new-js-comint-buffer 73 | (sit-for 1) 74 | (insert "foo.") 75 | (should-not (completion-at-point)) 76 | ;; detects if completion-at-point hangs 77 | (funcall done))) 78 | -------------------------------------------------------------------------------- /test/common.el: -------------------------------------------------------------------------------- 1 | ;; -*- lexical-binding: t -*- 2 | 3 | (require 'js-comint) 4 | (require 'ert) 5 | 6 | (defmacro with-new-js-comint-buffer (&rest body) 7 | "Run BODY with a fresh js-comint as current buffer and exit after." 8 | (declare (indent 0) (debug t)) 9 | `(progn 10 | (when (js-comint-get-process) 11 | (kill-process (js-comint-get-process))) 12 | (sleep-for 0.2) 13 | (kill-matching-buffers (js-comint-get-buffer-name) nil t) 14 | (run-js) 15 | (unwind-protect 16 | (with-current-buffer (js-comint-get-buffer) 17 | (font-lock-mode -1) 18 | (sit-for 1) ;; prevent race condition on start 19 | ,@body) 20 | (when (js-comint-get-process) 21 | (kill-process (js-comint-get-process))) 22 | (sleep-for 0.2) 23 | (kill-matching-buffers (js-comint-get-buffer-name) nil t)))) 24 | 25 | (defun js-comint-test-output-matches (input regex) 26 | "Verify that sending INPUT yields output that matches REGEX." 27 | (with-new-js-comint-buffer 28 | (js-comint-send-string input) 29 | (sit-for 1) 30 | (let ((output (buffer-substring-no-properties 31 | comint-last-input-end 32 | (car comint-last-prompt)))) 33 | (should (string-match-p regex output))))) 34 | -------------------------------------------------------------------------------- /test/company-tests.el: -------------------------------------------------------------------------------- 1 | ;; -*- lexical-binding: t -*- 2 | 3 | (require 'js-comint) 4 | (require 'ert) 5 | (require 'company) 6 | 7 | (load-file "./test/common.el") 8 | 9 | ;;; Company Integration Tests 10 | 11 | ;; sanity check: node should interpret ^U 12 | (ert-deftest js-comint--clear-input-async/test-integration () 13 | "Tests whether clear works in a live comint." 14 | (with-new-js-comint-buffer 15 | (process-send-string (get-buffer-process (current-buffer)) "5") 16 | (js-comint--clear-input-async) 17 | (comint-send-input) 18 | (let ((output (buffer-substring-no-properties 19 | comint-last-input-end 20 | (car comint-last-prompt)))) 21 | ;; if it fails, node will see 5^U and fail, or see just 5 and echo it 22 | (should (string-empty-p output))))) 23 | 24 | (ert-deftest js-comint/test-dumb-term () 25 | "TERM env var should not be dumb." 26 | (js-comint-test-output-matches "process.env['TERM']" "emacs")) 27 | 28 | (ert-deftest js-comint/test-company-global () 29 | "Tests completion with an empty prompt." 30 | (with-new-js-comint-buffer 31 | (company-mode) 32 | (sit-for 1) 33 | (company-manual-begin) 34 | ;; register callback to see globals 35 | (company-complete-selection) 36 | (should (looking-back "AbortController")))) 37 | 38 | (ert-deftest js-comint/test-company-unique-result () 39 | "Completing with a unique result. 40 | E.g. Arr => Array, or conso => console." 41 | (with-new-js-comint-buffer 42 | (company-mode) 43 | (setq company-async-timeout 5) 44 | (sit-for 1) 45 | (insert "Arra") 46 | (company-complete) 47 | (should (looking-back "Array")))) 48 | 49 | (ert-deftest js-comint/test-company-complete-props () 50 | "Completing props of an object. 51 | E.g. should complete \"Array.\" to all properties." 52 | (with-new-js-comint-buffer 53 | (company-mode) 54 | (sit-for 1) 55 | (insert "Array.") 56 | (company-manual-begin) 57 | (company-complete-selection) 58 | (should (looking-back "Array.__proto__")))) 59 | 60 | (ert-deftest js-comint/test-company-complete-long-line () 61 | "Completing part of a line. 62 | E.g. 'if (true) { console.'" 63 | (with-new-js-comint-buffer 64 | (company-mode) 65 | (sit-for 1) 66 | (insert "if (true) { console.") 67 | (company-manual-begin) 68 | (company-complete-selection) 69 | (should (looking-back "console.__proto__")))) 70 | 71 | (ert-deftest js-comint/test-company-quick-typing () 72 | "When completion is triggered while one is already running." 73 | (with-new-js-comint-buffer 74 | (company-mode) 75 | (sit-for 1) 76 | (insert "scrog.") 77 | (company-manual-begin) 78 | (insert "foo") 79 | (company-manual-begin) 80 | (should (looking-back "scrog.foo")))) 81 | -------------------------------------------------------------------------------- /test/unit-tests.el: -------------------------------------------------------------------------------- 1 | ;; -*- lexical-binding: t -*- 2 | 3 | (require 'js-comint) 4 | (require 'ert) 5 | (require 'el-mock) 6 | (require 'ert-async) 7 | 8 | (load-file "./test/common.el") 9 | 10 | (ert-deftest js-comint-test-multiline-dotchain-line-start-dos () 11 | "Test multiline statement with dots at beginning of lines, with 12 | DOS line separators." 13 | (js-comint-test-output-matches 14 | "[1, 2, 3]\r 15 | .map((it) => it + 1)\r 16 | .filter((it) => it > 0)\r 17 | .reduce((prev, curr) => prev + curr, 0);\r 18 | " 19 | ;; output 20 | "^9$")) 21 | 22 | (ert-deftest js-comint-test-multiline-dotchain-line-end () 23 | "Test multiline statement with dots at end of lines." 24 | (js-comint-test-output-matches 25 | "[1, 2, 3]. 26 | map((it) => it + 1). 27 | filter((it) => it > 0). 28 | reduce((prev, curr) => prev + curr, 0);" 29 | ;; output 30 | "^9$")) 31 | 32 | (ert-deftest js-comint-start-or-switch-to-repl/test-no-modules () 33 | "Should preserve node_path when nothing is set." 34 | (let ((original js-comint-module-paths) 35 | (original-set-env js-comint-set-env-when-startup) 36 | (original-env (getenv "NODE_PATH"))) 37 | (unwind-protect 38 | (progn 39 | (setq js-comint-module-paths nil 40 | js-comint-set-env-when-startup nil) 41 | (setenv "NODE_PATH" "/foo/bar") 42 | (js-comint-test-output-matches "process.env['NODE_PATH'];" 43 | "/foo/bar")) 44 | (setq js-comint-module-paths original 45 | js-comint-set-env-when-startup original-set-env) 46 | (setenv "NODE_PATH" original-env)))) 47 | 48 | (ert-deftest js-comint-start-or-switch-to-repl/test-global-set () 49 | "Should include the value of `js-comint-node-modules' if set." 50 | (let ((original js-comint-module-paths) 51 | (original-set-env js-comint-set-env-when-startup) 52 | (original-env (getenv "NODE_PATH"))) 53 | (unwind-protect 54 | (progn 55 | (setq js-comint-module-paths '("/baz/xyz") 56 | js-comint-set-env-when-startup nil) 57 | (setenv "NODE_PATH" "/foo/bar") 58 | (js-comint-test-output-matches "process.env['NODE_PATH'];" 59 | (concat "/foo/bar" (js-comint--path-sep) "/baz/xyz"))) 60 | (setq js-comint-module-paths original 61 | js-comint-set-env-when-startup original-set-env) 62 | (setenv "NODE_PATH" original-env)))) 63 | 64 | (ert-deftest js-comint-start-or-switch-to-repl/test-local () 65 | "Should include the optional node-modules-path." 66 | (let ((original js-comint-module-paths) 67 | (original-set-env js-comint-set-env-when-startup) 68 | (original-env (getenv "NODE_PATH")) 69 | (original-suggest (symbol-function 'js-comint--suggest-module-path))) 70 | (unwind-protect 71 | (progn 72 | (fset 'js-comint--suggest-module-path (lambda () "/baz/xyz")) 73 | (setq js-comint-module-paths '() 74 | js-comint-set-env-when-startup 't) 75 | (setenv "NODE_PATH" "/foo/bar") 76 | (js-comint-test-output-matches "process.env['NODE_PATH'];" 77 | (concat "/foo/bar" (js-comint--path-sep) "/baz/xyz"))) 78 | (setq js-comint-module-paths original 79 | js-comint-set-env-when-startup original-set-env) 80 | (setenv "NODE_PATH" original-env) 81 | (fset 'js-comint--suggest-module-path original-suggest)))) 82 | 83 | (ert-deftest js-comint/test-strict-mode () 84 | "When NODE_REPL_MODE=strict should use strict mode." 85 | (with-environment-variables (("NODE_REPL_MODE" "strict")) 86 | ;; global variables are not allowed in strict mode 87 | (js-comint-test-output-matches "foo = 5;" "Uncaught ReferenceError.*"))) 88 | 89 | (ert-deftest js-comint-select-node-version/test-no-nvm () 90 | "Should error if nvm is missing." 91 | (let ((original-command-value js-comint-program-command)) 92 | (with-mock 93 | (mock (require 'nvm) => (error "Cannot open nvm")) 94 | (should-error (js-comint-select-node-version)) 95 | (should-not js-use-nvm) 96 | (should (equal js-comint-program-command 97 | original-command-value))))) 98 | 99 | (ert-deftest js-comint-select-node-version/test-with-arg () 100 | "Should set program-command when called non-interactively." 101 | (let ((original-command-value js-comint-program-command) 102 | (original-use-jvm-value js-use-nvm) 103 | (original-nvm-version js-nvm-current-version)) 104 | (unwind-protect 105 | (with-mock 106 | (mock (require 'nvm)) 107 | (mock (nvm--find-exact-version-for "foo") => '("foo-1.2" "some_path")) 108 | (js-comint-select-node-version "foo") 109 | (should js-use-nvm) 110 | (should (equal js-comint-program-command 111 | "some_path/bin/node")) 112 | (should (equal js-nvm-current-version 113 | '("foo-1.2" "some_path")))) 114 | (setq js-comint-program-command original-command-value 115 | js-use-nvm original-use-jvm-value 116 | js-nvm-current-version original-nvm-version)))) 117 | 118 | (ert-deftest js-comint-select-node-version/test-optional-arg () 119 | "Should set program-command when called with no arg." 120 | (let ((original-command-value js-comint-program-command) 121 | (original-use-jvm-value js-use-nvm) 122 | (original-nvm-version js-nvm-current-version)) 123 | (unwind-protect 124 | (with-mock 125 | (mock (require 'nvm)) 126 | (mock (js-comint-list-nvm-versions *) => "foo") 127 | (mock (nvm--find-exact-version-for "foo") => '("foo-1.2" "some_path")) 128 | (js-comint-select-node-version) 129 | (should (equal js-comint-program-command 130 | "some_path/bin/node"))) 131 | (setq js-comint-program-command original-command-value 132 | js-use-nvm original-use-jvm-value 133 | js-nvm-current-version original-nvm-version)))) 134 | 135 | (ert-deftest js-comint--current-input/test () 136 | "Tests default behavior." 137 | (with-new-js-comint-buffer 138 | (insert "Array") 139 | (should (equal (js-comint--current-input) "Array")) 140 | (comint-send-input) 141 | (should (equal (js-comint--current-input) "")) 142 | (goto-char (point-min)) 143 | (should (equal (js-comint--current-input) nil)))) 144 | 145 | (ert-deftest js-comint--complete-substring/test-semi-colon () 146 | "Should break at semi-colons." 147 | (should (equal (js-comint--complete-substring "foo; bar") 148 | "bar"))) 149 | 150 | (ert-deftest js-comint--complete-substring/test-brackets () 151 | "Should break at opening brackets." 152 | (should (equal (js-comint--complete-substring "if(tru") 153 | "tru"))) 154 | 155 | (ert-deftest js-comint--complete-substring/test-words () 156 | "Should break at words." 157 | (should (equal (js-comint--complete-substring "for (let i of myObject.pro") 158 | "myObject.pro"))) 159 | 160 | (ert-deftest js-comint--complete-substring/test-braces () 161 | "Should break at opening braces." 162 | (should (equal (js-comint--complete-substring "if (true) { cons") 163 | "cons"))) 164 | 165 | (ert-deftest js-comint--should-complete/test () 166 | "Tests default behavior." 167 | (with-new-js-comint-buffer 168 | (insert "Arr") 169 | (should (js-comint--should-complete)) 170 | (comint-kill-input) 171 | 172 | (insert "Array.") 173 | (should (js-comint--should-complete)) 174 | (comint-kill-input) 175 | 176 | ;; empty line 177 | (should (js-comint--should-complete)) 178 | 179 | (insert "// a comment") 180 | (should-not (js-comint--should-complete)) 181 | (comint-kill-input) 182 | 183 | (insert "\"foo") 184 | (should-not (js-comint--should-complete)) 185 | (comint-kill-input) 186 | 187 | (insert "[1,2,") 188 | (should-not (js-comint--should-complete)) 189 | (comint-kill-input) 190 | 191 | (insert "foo() ") 192 | (should-not (js-comint--should-complete)) 193 | (comint-kill-input))) 194 | 195 | (ert-deftest js-comint--process-completion-output/test-globals () 196 | "Completing an empty string." 197 | (should 198 | (equal 199 | (js-comint--process-completion-output 200 | " 201 | AbortController AbortSignal AggregateError Array 202 | 203 | constructor 204 | 205 | > " 206 | "") 207 | '("AbortController" 208 | "AbortSignal" 209 | "AggregateError" 210 | "Array" 211 | "constructor")))) 212 | 213 | (ert-deftest js-comint--process-completion-output/test-single-completion () 214 | "Completion of \"Arr\" yields a single result and type info." 215 | (should (equal (js-comint--process-completion-output 216 | "Array 217 | // [Function: Array]" 218 | "Arr") 219 | '("Array")))) 220 | 221 | (ert-deftest js-comint--process-completion-output/test-method-completion () 222 | "Completion of object properties should give list of properties prefixed with name." 223 | (should 224 | (equal 225 | (js-comint--process-completion-output 226 | "Array. 227 | Array.__proto__ Array.hasOwnProperty Array.isPrototypeOf Array.propertyIsEnumerable Array.toLocaleString 228 | Array.valueOf 229 | 230 | > Array." 231 | "Array.") 232 | '("Array.__proto__" 233 | "Array.hasOwnProperty" 234 | "Array.isPrototypeOf" 235 | "Array.propertyIsEnumerable" 236 | "Array.toLocaleString" 237 | "Array.valueOf")))) 238 | 239 | (ert-deftest js-comint--process-completion-output/test-multiline-prefix () 240 | "Completion when there is a '...' prefix." 241 | (should 242 | (equal 243 | (js-comint--process-completion-output 244 | "Array. 245 | Array.__proto__ Array.hasOwnProperty Array.isPrototypeOf Array.propertyIsEnumerable Array.toLocaleString 246 | Array.valueOf 247 | 248 | ... Array." 249 | "Array.") 250 | '("Array.__proto__" 251 | "Array.hasOwnProperty" 252 | "Array.isPrototypeOf" 253 | "Array.propertyIsEnumerable" 254 | "Array.toLocaleString" 255 | "Array.valueOf")))) 256 | 257 | (ert-deftest js-comint--async-output-filter/test-no-callbacks () 258 | "Output should be kept when no callbacks are active." 259 | (with-temp-buffer 260 | (should (equal (js-comint--async-output-filter "foo") 261 | "foo")) 262 | ;; should be the same when old callbacks are used 263 | (with-mock 264 | (mock (js-comint--callback-active-p *) => nil) 265 | (setq js-comint--completion-buffer nil 266 | js-comint--completion-callbacks (list ())) 267 | (should (equal (js-comint--async-output-filter "foo") 268 | "foo")) 269 | ;; callbacks should be cleared too 270 | (should-not js-comint--completion-callbacks)))) 271 | 272 | (ert-deftest js-comint--async-output-filter/test-discard () 273 | "Output should be discarded when completion callback is active." 274 | (with-temp-buffer 275 | ;; function ignore always returns nil, so it is never cleared 276 | (setq js-comint--completion-callbacks (list '(:function ignore))) 277 | (with-mock 278 | (stub js-comint--callback-active-p => 't) 279 | (dolist (output '("foo" "bar" "")) 280 | (should (string-empty-p (js-comint--async-output-filter output))))) 281 | ;; text should be in completion buffer 282 | (should (equal (with-current-buffer js-comint--completion-buffer (buffer-string)) 283 | "foobar")) 284 | (should (equal js-comint--completion-callbacks 285 | (list '(:function ignore)))))) 286 | 287 | (ert-deftest js-comint--async-output-filter/test-callback-error () 288 | "Callback should be removed if it signals an error." 289 | (with-temp-buffer 290 | (setq js-comint--completion-callbacks 291 | (list (list :function (lambda () (error "This should be caught!"))))) 292 | (with-mock 293 | (stub js-comint--callback-active-p => 't) 294 | (dolist (output '("foo" "bar" "")) 295 | (js-comint--async-output-filter output))) 296 | ;; callback should be removed 297 | (should-not js-comint--completion-callbacks))) 298 | 299 | (ert-deftest js-comint--async-output-filter/test-callback-chain () 300 | "Callbacks should be able to add further callbacks." 301 | (with-temp-buffer 302 | (setq js-comint--completion-callbacks 303 | (list (list :function (lambda () 304 | (push '(:function foo) js-comint--completion-callbacks) 305 | 't)))) 306 | (with-mock 307 | (stub js-comint--callback-active-p => 't) 308 | (should (string-empty-p (js-comint--async-output-filter "foo")))) 309 | ;; new callback should be added 310 | (should (equal js-comint--completion-callbacks 311 | (list '(:function foo)))))) 312 | 313 | (ert-deftest js-comint--clear-input-async/test () 314 | "Should send correct clear command and complete on expected response." 315 | (with-temp-buffer 316 | (setq js-comint--completion-callbacks 317 | (list '(:function always))) 318 | (with-mock 319 | (stub js-comint--callback-active-p => 't) 320 | (stub js-comint--current-input => "") 321 | (mock (process-send-string * "")) 322 | (js-comint--async-output-filter "foo") 323 | ;; node input is "foo" 324 | ;; completion buffer is empty as there are no active callbacks 325 | (js-comint--clear-input-async) 326 | ;; term sends a prompt 327 | (should (string-empty-p (js-comint--async-output-filter "> "))) 328 | ;; buffer should be empty and no active callbacks 329 | (should (js-comint--completion-looking-back-p "^$")) 330 | (should-not js-comint--completion-callbacks)))) 331 | 332 | (ert-deftest-async js-comint--async-output-filter/test-no-completion (done) 333 | "Output should be saved until string match, then fail." 334 | (with-mock 335 | (stub js-comint--callback-active-p => 't) 336 | (stub js-comint--current-input => "foo") 337 | ;; 1 - complete foo 338 | ;; 2 - finished test " \b" 339 | ;; 3 - clear "" 340 | (mock (process-send-string * *) :times 3) 341 | (with-temp-buffer 342 | (js-comint--get-completion-async "foo" 343 | (lambda (arg) 344 | ;; callback should be called with nil 345 | (funcall done (when arg 346 | (format "expected %s to be nil" arg))))) 347 | (dolist (output '("f" "oo" ;; output in chunks 348 | " > foo" ;; response to " \b" 349 | )) 350 | (should (string-empty-p (js-comint--async-output-filter output)))) 351 | ;; clear should be called 352 | (should (equal (plist-get (car js-comint--completion-callbacks) :type) 353 | 'clear))))) 354 | 355 | (ert-deftest-async js-comint--async-output-filter/test-stale-callback (done) 356 | "Callback should not be called if input has changed." 357 | (with-new-js-comint-buffer 358 | (with-mock 359 | ;; input is "Array" when callback is set 360 | (mock (js-comint--current-input) => "Array") 361 | (js-comint--get-completion-async "Array" 362 | (lambda (arg) 363 | ;; callback should be called with nil or not called 364 | (funcall done (when arg 365 | (format "expected %s to be nil" arg)))))) 366 | ;; bump output, input is now "" 367 | (js-comint--async-output-filter "") 368 | ;; async-output-filter should discard the previous callback as it doesn't apply 369 | (funcall done (when js-comint--completion-callbacks 370 | (format "expected %s to be nil" js-comint--completion-callbacks))))) 371 | 372 | (ert-deftest-async js-comint--get-completion-async/test-prop-completion-fail (done) 373 | "When completion fails on something that looks like an object don't hang." 374 | (with-mock 375 | (stub js-comint--callback-active-p => 't) 376 | (stub js-comint--current-input => "scrog.") 377 | ;; 1 - complete 378 | ;; 2 - send another \t 379 | ;; 3 - finished test " \b" 380 | ;; 4 - clear 381 | (mock (process-send-string * *) :times 4) 382 | (with-temp-buffer 383 | (js-comint--get-completion-async "scrog." 384 | (lambda (arg) 385 | ;; callback should be called with nil 386 | (funcall done (when arg 387 | (format "expected %s to be nil" arg))))) 388 | (dolist (output '("s" "crog.")) 389 | (should (string-empty-p (js-comint--async-output-filter output)))) 390 | ;; no response to repeat \t 391 | ;; after some delay, send answer to wiggle 392 | (sleep-for 2) 393 | (should (string-empty-p (js-comint--async-output-filter " > scrog.")))))) 394 | 395 | (ert-deftest js-comint--get-completion-async/test-user-callback-error () 396 | "Should clear even if supplied callback errors." 397 | (with-mock 398 | (stub js-comint--callback-active-p => 't) 399 | (stub js-comint--current-input => "foo") 400 | (stub process-send-string) 401 | (with-temp-buffer 402 | ;; callback errors 403 | (js-comint--get-completion-async "foo" 404 | (lambda (arg) (error "Broken user callback"))) 405 | ;; after output the erroring callback is called with nil 406 | (dolist (output '("f" "oo" 407 | " > foo" ;; response to " \b" 408 | )) 409 | (should (string-empty-p (js-comint--async-output-filter output)))) 410 | ;; clear should be called 411 | (should (equal (plist-get (car js-comint--completion-callbacks) :type) 412 | 'clear))))) 413 | 414 | (ert-deftest js-comint--get-completion-async/test-user-callback-error-2 () 415 | "Should clear even if supplied callback errors (multiple completions)." 416 | (with-mock 417 | (stub js-comint--callback-active-p => 't) 418 | (stub js-comint--current-input => "foo") 419 | (stub process-send-string) 420 | (with-temp-buffer 421 | ;; callback errors 422 | (js-comint--get-completion-async "foo" 423 | (lambda (arg) (error "Broken user callback"))) 424 | ;; after output the erroring callback is called with nil 425 | (dolist (output '("foo bar baz \n> foo")) 426 | (should (string-empty-p (js-comint--async-output-filter output)))) 427 | ;; clear should be called 428 | (should (equal (plist-get (car js-comint--completion-callbacks) :type) 429 | 'clear))))) 430 | 431 | (ert-deftest-async js-comint--get-completion-async/test-prop-completion (done) 432 | "When completing object properties, send another tab to get completion." 433 | (with-mock 434 | (stub js-comint--callback-active-p => 't) 435 | (stub js-comint--current-input => "Array.") 436 | (mock (process-send-string * *) :times 3) 437 | (with-temp-buffer 438 | ;; callback should be called with ("foo" "bar" "baz") 439 | (js-comint--get-completion-async "Array." 440 | (lambda (arg) 441 | (if (equal arg '("foo" "bar" "baz")) 442 | (funcall done) 443 | (funcall done (format "error %s should be '(\"foo\" \"bar\" \"baz\")" arg))))) 444 | ;; after the second tab get completion suggestions 445 | (dolist (output '("A" "rray." " foo bar baz \n> Array.")) 446 | (should (string-empty-p (js-comint--async-output-filter output)))) 447 | ;; clear should be called 448 | (should (equal (plist-get (car js-comint--completion-callbacks) :type) 449 | 'clear))))) 450 | --------------------------------------------------------------------------------