├── .github └── workflows │ └── test.yml ├── .gitignore ├── Eask ├── LICENSE ├── Makefile ├── README.md ├── examples └── sonarlint-example.gif ├── fixtures ├── compile_commands.json ├── javascript-sample.js ├── sample.cpp ├── sample.go ├── sample.html ├── sample.java ├── sample.php ├── sample.py ├── sample.ts ├── sample.xml └── secrets.java ├── images └── SonarLint_icon.svg ├── lsp-sonarlint.el └── test ├── lsp-sonarlint-integration-test.el └── trivial-test.el /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | 9 | concurrency: 10 | group: ${{ github.workflow }}-${{ github.ref }} 11 | cancel-in-progress: true 12 | 13 | jobs: 14 | test: 15 | runs-on: ${{ matrix.os }} 16 | continue-on-error: ${{ matrix.experimental }} 17 | strategy: 18 | fail-fast: false 19 | matrix: 20 | os: [ubuntu-latest, macos-latest] 21 | emacs-version: 22 | - 28.2 23 | - 29.4 24 | - 30.1 25 | experimental: [false] 26 | # TODO: enable once emacs snapshot version is fixed 27 | # For some reason takes too long to run, see 28 | # github.com/emacs-lsp/lsp-sonarlint/pull/25#issuecomment-2226929636 29 | # include: 30 | # - os: ubuntu-latest 31 | # emacs-version: snapshot 32 | # experimental: true 33 | # - os: macos-latest 34 | # emacs-version: snapshot 35 | # experimental: true 36 | # see https://github.com/emacs-eask/cli/issues/224 37 | # - os: windows-latest 38 | # emacs-version: snapshot 39 | # experimental: true 40 | 41 | steps: 42 | - uses: actions/checkout@v3 43 | 44 | - name: Setup Java # SonarLint runs on Java. 45 | uses: actions/setup-java@v3 46 | with: 47 | distribution: 'temurin' 48 | java-version: 11 49 | 50 | - name: Setup NodeJS # for JS and TS analyzer 51 | uses: actions/setup-node@v3 52 | with: 53 | node-version: 18 54 | 55 | - uses: jcs090218/setup-emacs@master 56 | with: 57 | version: ${{ matrix.emacs-version }} 58 | 59 | - uses: emacs-eask/setup-eask@master 60 | with: 61 | version: 'snapshot' 62 | 63 | - name: Run tests 64 | run: 65 | make ci 66 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ignore these directories 2 | /.git 3 | /recipes 4 | /_test 5 | /video 6 | 7 | # ignore generated files 8 | *.elc 9 | 10 | # eask packages 11 | .eask/ 12 | dist/ 13 | 14 | # packaging 15 | *-autoloads.el 16 | *-pkg.el 17 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "lsp-sonarlint" 4 | "0.0.1" 5 | "Emacs SonarLint lsp client") 6 | 7 | (website-url "https://github.com/emacs-lsp/lsp-sonarlint") 8 | (keywords "languages" "tools" "php" "javascript" "typescript" "go" "xml" "html" "java" "python") 9 | 10 | (package-file "lsp-sonarlint.el") 11 | 12 | (files "languages" "languages/*/*.el" "server" "server/*") 13 | 14 | (script "test" "echo \"Error: no test specified\" && exit 1") 15 | 16 | (source 'gnu) 17 | (source 'melpa) 18 | 19 | (depends-on "emacs" "28.1") 20 | (depends-on "dash" "2.12.0") 21 | (depends-on "lsp-mode" "6.3") 22 | (depends-on "ht" "2.3") 23 | 24 | (development 25 | (depends-on "ert")) 26 | 27 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 28 | -------------------------------------------------------------------------------- /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 | lsp-sonarlint 635 | Copyright (C) 2020 Fermin 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 | lsp-sonarlint Copyright (C) 2020 Fermin 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | SHELL := /usr/bin/env bash 2 | 3 | EMACS ?= emacs 4 | EASK ?= eask 5 | 6 | TEST-FILES := $(shell ls test/*.el) 7 | 8 | .PHONY: clean checkdoc lint package install compile download-sonarlint test 9 | 10 | ci: clean package install compile download-sonarlint test 11 | 12 | package: 13 | @echo "Packaging..." 14 | $(EASK) package 15 | 16 | install: 17 | @echo "Installing..." 18 | $(EASK) install-deps --dev 19 | 20 | compile: 21 | @echo "Compiling..." 22 | $(EASK) compile 23 | 24 | download-sonarlint: 25 | @echo "Downloading SonarLint..." 26 | $(EASK) eval '(progn (require (quote lsp-sonarlint)) (lsp-sonarlint-download))' 27 | 28 | test: 29 | @echo "Testing..." 30 | $(EASK) test ert $(TEST-FILES) 31 | 32 | clean: 33 | $(EASK) clean all 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SonarLint for Emacs 2 | ![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg) 3 | [![MELPA](https://melpa.org/packages/lsp-sonarlint-badge.svg)](https://melpa.org/#/lsp-sonarlint) 4 | [![MELPA Stable](https://stable.melpa.org/packages/lsp-sonarlint-badge.svg)](https://stable.melpa.org/#/lsp-sonarlint) 5 | 6 | 7 | SonarLint™ is a free IDE extension that lets you fix coding issues before they exist! 8 | 9 | Like a spell checker,it highlights Bugs and Security Vulnerabilities as you write code, with clear remediation guidance so you can fix them before the code is even committed. 10 | 11 | In Emacs supports analysis of JavaScript, TypeScript, Python, Java, HTML, PHP, C/C++, 12 | Go, and XML out of the box! 13 | 14 | :warning: This is not an official [SonarSource](https://www.sonarsource.com/) extension 15 | 16 | ![Flycheck gif](https://gitlab.com/sasanidas/lsp-sonarlint/-/raw/master/examples/sonarlint-example.gif "Flycheck gif") 17 | 18 | ## How it works 19 | 20 | lsp-sonarlint relies on the [official vscode extension](https://github.com/SonarSource/sonarlint-vscode/), which is downloaded and unzipped. 21 | 22 | The official VSCode extension typically contains : 23 | - A language server (written in java) 24 | - A Java runtime 25 | - Analysers for 10+ languages 26 | - A VSCode front-end 27 | 28 | lsp-sonarlint is emacs's equivalent of the VSCode front-end, but only 29 | implements the base feature set, i.e linting and rules viewing. 30 | 31 | ## Requirements 32 | 33 | - emacs >= 25 34 | - [lsp-mode](https://github.com/emacs-lsp/lsp-mode) 35 | - [ht](https://github.com/Wilfred/ht.el) 36 | - [dash](https://github.com/magnars/dash.el) 37 | 38 | To analyze JavaScript and TypeScript, SonarLint will also need Node.js. 39 | 40 | To analyse C/C++ projects, SonarLint's CFamily analyzer will need both a working compiler and a 41 | compile_commands.json which is typically generated by [cmake](https://github.com/rizsotto/Bear) or [bear](https://github.com/rizsotto/Bear). 42 | 43 | ## Installation 44 | 45 | ## Source 46 | Download and include the main file lsp-sonarlint.el. 47 | 48 | ### Melpa 49 | You can then run the following commands to install lsp-sonarlint: 50 | 51 | ``` 52 | M-x package-refresh-contents RET (to refresh your package database) 53 | M-x package-install RET lsp-sonarlint RET (to install and compile `lsp-sonarlint` and its dependencies) 54 | ``` 55 | 56 | ## Usage 57 | The language server relies on java plugins to properly analyze the selected language source code. 58 | 59 | By default all are enabled, but you can specify the ones you want. 60 | 61 | ``` lisp 62 | (use-package lsp-sonarlint 63 | :custom 64 | ;; Allow sonarlint to download and unzip the official VSCode extension 65 | ;; If nil, you'll have to do that yourself. See also `lsp-sonarlint-download' 66 | ;; `lsp-sonarlint-download-url' and `lsp-sonarlint-download-dir' 67 | (lsp-sonarlint-auto-download t) 68 | 69 | ;; Choose which analyzers you want enabled. By default all are enabled 70 | ;; See command `lsp-sonarlint-available-analyzers' for the full list. 71 | (lsp-sonarlint-enabled-analyzers '("java" "cfamily" "python" "text"))) 72 | ``` 73 | 74 | > [!WARNING] 75 | > On windows, lsp-sonarlint may encounter [this issue](https://github.com/emacs-lsp/lsp-mode/issues/3022) while unzipping the VSCode extension. If you do, try the following : 76 | ```elisp 77 | (setq lsp-unzip-script lsp-ext-pwsh-script) 78 | ``` 79 | 80 | ## Static Analysis Rules 81 | 82 | Out of the box, SonarLint automatically checks your code against the following rules: 83 | 84 | - [JavaScript rules](https://rules.sonarsource.com/javascript) 85 | - [TypeScript rules](https://rules.sonarsource.com/typescript) 86 | - [Python rules](https://rules.sonarsource.com/python) 87 | - [Java rules](https://rules.sonarsource.com/java) 88 | - [HTML rules](https://rules.sonarsource.com/html) 89 | - [PHP rules](https://rules.sonarsource.com/php) 90 | - [XML rules](https://rules.sonarsource.com/xml) 91 | - [Go rules](https://rules.sonarsource.com/go) 92 | - [C rules](https://rules.sonarsource.com/c) 93 | - [C++ rules](https://rules.sonarsource.com/cpp) 94 | - [Bidi (bidirectional unicode characters)](https://rules.sonarsource.com/text/) + [Secrets](https://rules.sonarsource.com/secrets/) 95 | 96 | ## Supported settings 97 | 98 | * `lsp-sonarlint-auto-download` - Set to t to enable auto-downloading of VSCode's extension on startup. 99 | * `lsp-sonarlint-download-url` - Specify another URL for the VSCode extension. 100 | * `lsp-sonarlint-download-dir` - Specify where VSCode's extension will be downloaded and unzipped. 101 | * `lsp-sonarlint-use-system-jre` - If t, use the system Java runtime instead of the bundled one. 102 | * `lsp-sonarlint-enabled-analyzers` - List of analyzers to enable. Defaults to 'all for all analyzers. 103 | * `lsp-sonarlint-modes-enabled` - List of major modes where the lsp server will activate. 104 | * `lsp-sonarlint-disable-telemetry` - Disable telemetry option (disabled by default). 105 | * `lsp-sonarlint-test-file-pattern` - Regex to find test file, most rules are not evaluated on test files. 106 | * `lsp-sonarlint-show-analyzer-logs` - Show analyzer logs. 107 | * `lsp-sonarlint-verbose-logs` - Make SonarLint logs verbose. 108 | * `lsp-sonarlint-cfamily-compilation-commands-path` - Path to compile_commands.json for C/C++ analysis. 109 | 110 | ### Available commands 111 | * `lsp-sonarlint-download` - Download the VSCode extension and unzip it. Called automatically 112 | if `lsp-sonarlint-auto-download`is set to t 113 | * `lsp-sonarlint-available-analyzers` - List all available analyzers provided by the downloaded VSCode extension. 114 | 115 | ### Plugins additional info 116 | 117 | For most analyzers, lsp-sonarlint provides variables describing additional 118 | info. 119 | 120 | * `lsp-sonarlint-LANGUAGE-doc-url` - Sonarsource official plugin documentation 121 | * `lsp-sonarlint-LANGUAGE-repository-url` - Plugin source code 122 | 123 | ### Plugins not tested yet 124 | Currently, sonarlint's vscode extension also provides omnisharp and Infrastructure As Code (IAC) 125 | analyzers. They have not been tested yet, you may expect some additional configuration 126 | to make them work. 127 | You'll at least need to add the major-modes to `lsp-sonarlint-modes-enabled'. 128 | 129 | Feel free to try them out and provide feedback. 130 | 131 | ## Data and telemetry 132 | 133 | This extension collects anonymous usage data and sends it to SonarSource. 134 | 135 | Collection of telemetry is controlled via the setting: `lsp-sonarlint-disable-telemetry`, it is disable by default. 136 | 137 | Click [here](https://github.com/SonarSource/sonarlint-vscode/blob/master/telemetry-sample.md) to see a sample of the data that are collected. 138 | 139 | ## Additional packages 140 | 141 | * [lsp-ui](https://github.com/emacs-lsp/lsp-ui) : Flycheck, documentation and code actions support. 142 | * [company-capf](https://github.com/company-mode/company-mode) : Completion backend support. 143 | * [treemacs](https://github.com/Alexander-Miller/treemacs) : Project viewer. 144 | * [lsp-treemacs](https://github.com/emacs-lsp/lsp-treemacs) : `lsp-mode` GUI controls implemented using treemacs. 145 | 146 | ## Development 147 | 148 | ### Prerequisites 149 | 150 | You will need `make` and [`eask`](https://emacs-eask.github.io/) to run `lsp-sonarlint` tests. 151 | See also (Requirements)(#requirements) section. 152 | 153 | If you do not have `eask` installed, you can install it locally with: 154 | 155 | ``` shell 156 | npm install @emacs-eask/cli 157 | export EASK="$PWD/node_modules/@emacs-eask/cli/eask" 158 | ``` 159 | 160 | Or globally with: 161 | 162 | ``` shell 163 | npm install -g @emacs-eask/cli 164 | ``` 165 | 166 | ### Testing 167 | 168 | We use [Emacs ERT](https://www.gnu.org/software/emacs/manual/html_node/ert/) for testing. 169 | You can run tests with: 170 | 171 | ``` shell 172 | make package 173 | make install 174 | make compile 175 | make download-sonarlint 176 | make test 177 | ``` 178 | 179 | #### Interactive Testing 180 | 181 | You can also run the tests one-by-one interactively. 182 | 183 | Open a test file from tests/*.el in Emacs. 184 | Evaluate the file contents (`eval-buffer`) to load test definitions into the session. 185 | Run `ert` command to run all or selected tests. 186 | To run the integration tests, you will have to shut down all your lsp workspaces 187 | to ensure consistent starting state. 188 | 189 | Check out `*lsp-log*`, `*lsp-log: sonarlint:NNNNNNNN*`, `*sonarlint*`, `*sonarlint:stderr*` 190 | for logs when troubleshooting a test. 191 | 192 | You can start with test/trivial-test.el to check that your testing harness works. 193 | 194 | ## Contributions 195 | 196 | Contributions are very much welcome. 197 | 198 | #### Copyright 199 | 200 | SONARLINT and SONARSOURCE are trademarks of SonarSource SA. 201 | All other trademarks and copyrights are the property of their respective owners. 202 | -------------------------------------------------------------------------------- /examples/sonarlint-example.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/emacs-lsp/lsp-sonarlint/44c596f2b4019aaf22e7be926db0ce73a2f0a0b1/examples/sonarlint-example.gif -------------------------------------------------------------------------------- /fixtures/compile_commands.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "directory": ".", 4 | "command": "c++ sample.cpp", 5 | "file": "sample.cpp", 6 | "output": "dummy" 7 | } 8 | ] 9 | -------------------------------------------------------------------------------- /fixtures/javascript-sample.js: -------------------------------------------------------------------------------- 1 | function f1() { 2 | // TODO: FIXME here 3 | return 18; 4 | } 5 | -------------------------------------------------------------------------------- /fixtures/sample.cpp: -------------------------------------------------------------------------------- 1 | int g(int& val) 2 | { 3 | return val; 4 | } 5 | -------------------------------------------------------------------------------- /fixtures/sample.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import "fmt" 4 | // TODO: to be done, really 5 | func main() { 6 | fmt.Println("Hello, World!") 7 | } 8 | -------------------------------------------------------------------------------- /fixtures/sample.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /fixtures/sample.java: -------------------------------------------------------------------------------- 1 | class HelloWorld { 2 | // TODO: flag this comment 3 | public static void main(String[] args) { 4 | System.out.println("Hello, World!"); 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /fixtures/sample.php: -------------------------------------------------------------------------------- 1 | 5 | -------------------------------------------------------------------------------- /fixtures/sample.py: -------------------------------------------------------------------------------- 1 | 2 | # TODO: why not do this todo now? 3 | if true or false: 4 | break 5 | -------------------------------------------------------------------------------- /fixtures/sample.ts: -------------------------------------------------------------------------------- 1 | function f1() { 2 | // TODO: FIXME here 3 | return 18; 4 | } 5 | -------------------------------------------------------------------------------- /fixtures/sample.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Hello, World! 5 | 6 | -------------------------------------------------------------------------------- /fixtures/secrets.java: -------------------------------------------------------------------------------- 1 | public class S6290 { 2 | public static final String KEY = "AKIAIGKECZXA7AEIJLMQ"; 3 | public static final String AWS_SESSION_TOKEN = "IQoJb3JpZ2luX2VjEKL//////////wEaDGV1LWNlbnRyYWwtMSJHMEUCIQDFlDUEvUa6slxlkKKn8zbLkN/j1f7lKJdXJ03PQ5T5ZwIgDYlshciO8nyfnmjUfFy4I2+rEuPHBexsvfBo3MlCdgQqugMISxAAGgw4NTk4OTY2NzUzMDYiDFKPV7D/QmnqFWRYpiqXAypJf6TksPZXImVpIUU0Yj0uJhNN0o/HcO8hfQ4BXuCvpm1DOiVsH6VXMxgNdpGTWr8CjNpEt/eYwSk6MAVPOtjg5+lY2qoGJrUuxwhiKe+BquVM17h0giZ18h1B4ozDGkfxA/vGSJa/qBznF0yEpLE+fJoesGe4ZpATs8oUN94/XkrL/eYzXsW3ZD1ZX66QzmSFHhgTJc24d9bezGjR32fEJD/dBm9La+7wpc4+jrXCmt6yxHox0gCuGrSagcJfPh9pVYneM81fnD/S7Kicb1Pw8MiChfqW0hao1twr4wMgp9N3JlYQNK3fZKbMU/qlvoKTz8D0Joa4elSp4rU4reVUsujCXVE95PDyj4LD3IDXHF5SAd/23/M/IucMRyeWlRE4pCtry68ENpojXr0tdyyVs8XSkgCGgup/BqDTkBnEBD+V5hOIrHJv5rJ6KpaxEZG0ozUJdaUpCseSSKK4Jn7liqVqF5EzOOXelqTAACcJmILKQHqke8n3imNs72oi8tu1N+oqbFp60K9whtLDm0JZSavpmRDkMODb8/4FOusBHFYZCuxMUmotN9Dkzp4InT7kJdKZ/kr61SMhU4hj7vTdjhcRHItO2P+jR7+38kQLDR4O1HR1XkHzLMwDvDwZULeOl6afS1ZpbO8XpePHaaLnEqJeZ8BpnfwBEiylK3HGzGAP7WcAgFlMO9AEqoGnnbUBFcL+IYnZ3JFPy0sGsrH4cOC8Gxy2icQKrGpdIyMqGjb2hZsSc1S4njGpK0AlCEKrAjzpr6SzPSwLnFtAJpztHbgb9Z7D2jdsjugQYdFwi6/9GKOI/slKqt5/vb7dLnSyeAY+jTaoveUZf6D5yM8PCKrvw5/k+A1XJw=="; 4 | public static final String AWS_SECRET_ACCESS_KEY = "kHeUAwnSUizTWpSbyGAz4f+As5LshPIjvtpswqGb"; 5 | } 6 | -------------------------------------------------------------------------------- /images/SonarLint_icon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 28 | 29 | -------------------------------------------------------------------------------- /lsp-sonarlint.el: -------------------------------------------------------------------------------- 1 | ;;; lsp-sonarlint.el --- Emacs SonarLint lsp client -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2020 Fermin Munoz 4 | 5 | ;; Author: Fermin MF 6 | ;; Created: 13 Jun 2020 7 | ;; Version: 0.0.1 8 | ;; Keywords: languages, tools, php, javascript, typescript, go, xml, html, java, python 9 | ;; URL: https://github.com/emacs-lsp/lsp-sonarlint 10 | ;; Package-Requires: ((emacs "28.1") (dash "2.12.0") (lsp-mode "6.3") (ht "2.3")) 11 | ;; License: GPL-3.0-or-later 12 | 13 | ;; This program is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation, either version 3 of the License, or 16 | ;; (at your option) any later version. 17 | 18 | ;; This program is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; You should have received a copy of the GNU General Public License 24 | ;; along with this program. If not, see . 25 | 26 | ;;; Commentary: 27 | ;; SonarLint LSP extensions for GNU Emacs, add support for the majority of sonarlint languages 28 | ;; including: php, javascript, typescript, html, python and java. 29 | 30 | ;; This is NOT an official SonarLint extension. 31 | 32 | 33 | ;;; Code: 34 | 35 | (require 'lsp-mode) 36 | (require 'dash) 37 | (require 'cus-edit) 38 | (require 'ht) 39 | (require 'shr) 40 | 41 | (defgroup lsp-sonarlint nil 42 | "SonarLint lsp server group" 43 | :group 'lsp-mode 44 | :link '(url-link "https://github.com/emacs-lsp/lsp-sonarlint") 45 | :package-version '(lsp-mode . "6.4")) 46 | 47 | (defcustom lsp-sonarlint-download-url 48 | (format "https://github.com/SonarSource/sonarlint-vscode/releases/download/4.6.0%%2B76435/sonarlint-vscode-%s-4.6.0.vsix" 49 | (pcase system-type 50 | ('gnu/linux "linux-x64") 51 | ('darwin 52 | (pcase (lsp-resolve-value lsp--system-arch) 53 | ('x64 "darwin-x64") 54 | ('arm64 "darwin-arm64"))) 55 | ('windows-nt "win32-x64"))) 56 | "Official SonarLint VSCode extension (vsix). 57 | It contains the necessary language server and analyzers." 58 | :type 'string) 59 | 60 | (defcustom lsp-sonarlint-download-dir 61 | (concat (file-name-directory load-file-name) "sonarlint-vscode") 62 | "Location where VSCode's sonarlint extension should be found. 63 | If absent, it will be downloaded from github and unzipped there." 64 | :group 'lsp-sonarlint 65 | :type 'directory) 66 | 67 | (defcustom lsp-sonarlint-modes-enabled '(php-mode 68 | go-mode 69 | html-mode 70 | web-mode 71 | js-mode 72 | js2-mode 73 | rjsx-mode 74 | typescript-mode 75 | typescript-tsx-mode 76 | python-mode 77 | c-mode 78 | c++-mode 79 | c-or-c++-mode 80 | c-ts-mode 81 | c++-ts-mode 82 | c-or-c++-ts-mode 83 | java-mode 84 | xml-mode 85 | nxml-mode) 86 | "List of major modes that enable SonarLint backend for LSP mode." 87 | :group 'lsp-sonarlint 88 | :type 'file) 89 | 90 | (defcustom lsp-sonarlint-disable-telemetry t 91 | "Disable sending anonymous usage statistics to SonarSource. 92 | To see a sample of the data that are collected 93 | https://github.com/SonarSource/sonarlint-vscode/blob/master/telemetry-sample.md." 94 | :group 'lsp-sonarlint 95 | :type 'boolean) 96 | 97 | (defcustom lsp-sonarlint-test-file-pattern "{**/test/**,**/*test*,**/*Test*}" 98 | "Files whose name match java global are considered as test files by analyzers. 99 | Most rules are not evaluated on test files. 100 | Example: `{**/test/**,**/*test*,**/*Test*}`" 101 | :group 'lsp-sonarlint 102 | :type 'string) 103 | 104 | (defcustom lsp-sonarlint-show-analyzer-logs nil 105 | "Show analyzer's logs in the SonarLint output." 106 | :group 'lsp-sonarlint 107 | :type 'boolean) 108 | 109 | (defcustom lsp-sonarlint-verbose-logs nil 110 | "Enable verbose logging of the SonarLint language server." 111 | :group 'lsp-sonarlint 112 | :type 'boolean) 113 | 114 | (defcustom lsp-sonarlint-vmargs "" 115 | "Extra JVM arguments used to launch the SonarLint LSP. 116 | e.g. `-Xmx1024m`." 117 | :group 'lsp-sonarlint 118 | :type 'string) 119 | 120 | (defcustom lsp-sonarlint-cfamily-compile-commands-path 121 | "${workspaceFolder}/compile_commands.json" 122 | "Location of the compile_commands.json file. 123 | It is needed in C/C++ to provide your compilation options." 124 | :group 'lsp-sonarlint 125 | :type 'file) 126 | 127 | (defconst lsp-sonarlint-go-doc-url "https://www.sonarsource.com/go/" 128 | "Documentation sonarsource URL.") 129 | 130 | (defconst lsp-sonarlint-go-repository-url "https://github.com/SonarSource/slang/" 131 | "Official sonarlint code extension repository.") 132 | 133 | (defconst lsp-sonarlint-html-doc-url "https://www.sonarsource.com/html/" 134 | "Documentation sonarsource URL.") 135 | 136 | (defconst lsp-sonarlint-html-repository-url "https://github.com/SonarSource/sonar-html" 137 | "Official sonarlint code extension repository.") 138 | 139 | (defconst lsp-sonarlint-java-doc-url "https://www.sonarsource.com/java/" 140 | "Documentation sonarsource URL.") 141 | 142 | (defconst lsp-sonarlint-java-repository-url "https://github.com/SonarSource/sonar-java" 143 | "Official sonarlint code extension repository.") 144 | 145 | (defconst lsp-sonarlint-c-doc-url "https://www.sonarsource.com/c" 146 | "Documentation sonarsource URL.") 147 | 148 | (defconst lsp-sonarlint-c++-doc-url "https://www.sonarsource.com/cpp" 149 | "Documentation sonarsource URL.") 150 | 151 | (defconst lsp-sonarlint-javascript-doc-url "https://www.sonarsource.com/js/" 152 | "Documentation sonarsource URL.") 153 | 154 | (defconst lsp-sonarlint-javascript-repository-url "https://github.com/SonarSource/SonarJS" 155 | "Official sonarlint code extension repository.") 156 | 157 | (defconst lsp-sonarlint-php-doc-url "https://www.sonarsource.com/php/" 158 | "Documentation sonarsource URL.") 159 | 160 | (defconst lsp-sonarlint-php-repository-url "https://github.com/SonarSource/sonar-php" 161 | "Official sonarlint code extension repository.") 162 | 163 | (defconst lsp-sonarlint-python-doc-url "https://www.sonarsource.com/python/" 164 | "Documentation sonarsource URL.") 165 | 166 | (defconst lsp-sonarlint-python-repository-url "https://github.com/SonarSource/sonar-python" 167 | "Official sonarlint code extension repository.") 168 | 169 | (defconst lsp-sonarlint-text-doc-url "https://www.sonarsource.com/" 170 | "Documentation sonarsource URL.") 171 | 172 | (defconst lsp-sonarlint-text-repository-url "https://github.com/SonarSource/sonar-text" 173 | "Official sonarlint code extension repository.") 174 | 175 | (defconst lsp-sonarlint-typescript-doc-url "https://www.sonarsource.com/ts/" 176 | "Documentation sonarsource URL.") 177 | 178 | (defconst lsp-sonarlint-typescript-repository-url "https://github.com/SonarSource/SonarJS" 179 | "Official sonarlint code extension repository.") 180 | 181 | (defconst lsp-sonarlint-xml-doc-url "https://www.sonarsource.com/xml/" 182 | "Documentation sonarsource URL.") 183 | 184 | (defconst lsp-sonarlint-xml-repository-url "https://github.com/SonarSource/sonar-xml" 185 | "Official sonarlint code extension repository.") 186 | 187 | (defun lsp-sonarlint-download() 188 | "Download the VSCode extension and unzips it. 189 | 190 | Follows the customizable variables : `lsp-sonarlint-download-url' and 191 | `lsp-sonarlint-download-dir'" 192 | (interactive) 193 | (let* ((dest-dir (file-name-directory lsp-sonarlint-download-dir)) 194 | (vsix-path (concat dest-dir "sonarlint.zip"))) 195 | (unless (file-exists-p lsp-sonarlint-download-dir) 196 | (unless (file-exists-p vsix-path) 197 | (url-copy-file lsp-sonarlint-download-url vsix-path)) 198 | (lsp-unzip vsix-path lsp-sonarlint-download-dir) 199 | (if (file-exists-p lsp-sonarlint-download-dir) 200 | (progn 201 | (delete-file vsix-path) 202 | (message "Sonarlint : successfully downloaded to %s" lsp-sonarlint-download-dir)) 203 | 204 | ;; For unzip issues on windows, see https://github.com/emacs-lsp/lsp-mode/issues/3022 205 | (warn "Could not unzip the VSCode extension, Either :\n\ 206 | - Set `lsp-unzip-script' properly : on windows set it to `lsp-ext-pwsh-script'\n\ 207 | - Download manually `lsp-sonarlint-download-url', unzip it, move it to `lsp-sonarlint-download-dir'"))))) 208 | 209 | (defcustom lsp-sonarlint-auto-download 210 | nil 211 | "If non nil, the analyzers will be downloaded at startup if needed. 212 | See also `lsp-sonarlint-download-dir' and `lsp-sonarlint-download-url'." 213 | :group 'lsp-sonarlint 214 | :set (lambda (sym auto-download) ; Trigger download when set to non-nil 215 | (set sym auto-download) 216 | (when auto-download 217 | (lsp-sonarlint-download))) 218 | :group 'lsp-sonarlint 219 | :type 'boolean) 220 | 221 | (defcustom lsp-sonarlint-use-system-jre 222 | nil 223 | "Use the system java runtime instead of the one bundled in VSCode's extension." 224 | :group 'lsp-sonarlint 225 | :type 'boolean) 226 | 227 | (defcustom lsp-sonarlint-enabled-analyzers 228 | 'all 229 | "Specify which analyzers you want to enable. 230 | - Use the \\='all symbol to enable all analyzers. 231 | - Use a list of analyzer names if you only need a subset. In this case, 232 | use `lsp-sonarlint-available-analyzers' to list available analyzers." 233 | :group 'lsp-sonarlint 234 | :type '(choice (const :tag "All analyzers" all) 235 | (const :tag "No analyzer" nil) 236 | (repeat :tag "A subset (see `lsp-sonarlint-available-analyzers')" string))) 237 | 238 | (defun lsp-sonarlint--extract-analyzer-name(analyzer-path) 239 | "Extracts the analyzer name from ANALYZER-PATH" 240 | (replace-regexp-in-string "sonar\\(lint\\)?" "" (file-name-base analyzer-path))) 241 | 242 | (defun lsp-sonarlint-available-analyzers() 243 | "Return a list of the available analyzers." 244 | (interactive) 245 | (let* ((root-dir lsp-sonarlint-download-dir) 246 | (plugin-dir (concat root-dir "/extension/analyzers")) 247 | (plugin-paths (directory-files plugin-dir t ".jar")) 248 | (plugin-names (mapcar #'lsp-sonarlint--extract-analyzer-name plugin-paths))) 249 | (message "Analyzers found in %s : %s" plugin-dir plugin-names) 250 | plugin-names)) 251 | 252 | (defun lsp-sonarlint--check-enabled-analyzer(analyzer) 253 | "Return t if ANALYZER is enabled. 254 | See `lsp-sonarlint-available-analyzers' and `lsp-sonarlint-enabled-analyzers'" 255 | (let* ((analyzer-name (lsp-sonarlint--extract-analyzer-name analyzer))) 256 | (pcase lsp-sonarlint-enabled-analyzers 257 | ('all t) 258 | (_ (seq-contains-p lsp-sonarlint-enabled-analyzers analyzer-name))))) 259 | 260 | (defun lsp-sonarlint-server-start-fun() 261 | "Start lsp-sonarlint in stdio mode." 262 | ;; This will signal an error if `lsp-sonarlint-download-dir' is not a dir 263 | ;; or if the java executable is not found there. 264 | ;; Thus, it also serves as a check for the presence of SonarLint LSP server. 265 | (let* ((root-dir lsp-sonarlint-download-dir) 266 | (bundled-java-path (car (directory-files-recursively root-dir "java\\(.exe\\)?$"))) 267 | (java-path (if lsp-sonarlint-use-system-jre "java" bundled-java-path)) 268 | (jar-path (concat root-dir "/extension/server/sonarlint-ls.jar")) 269 | (analyzer-dir (concat root-dir "/extension/analyzers")) 270 | (analyzer-paths (directory-files analyzer-dir t ".jar")) 271 | (enabled-analyzers (seq-filter #'lsp-sonarlint--check-enabled-analyzer analyzer-paths))) 272 | (unless java-path 273 | (warn "lsp-sonarlint : java is required and was not found on your system" :error)) 274 | (-concat (list java-path "-jar" jar-path "-stdio" "-analyzers") enabled-analyzers))) 275 | 276 | (defun lsp-sonarlint--code-action-open-rule (_workspace params) 277 | "Create a buffer with rendered rule from PARAMS text in it. 278 | Extracts the title ahd htmlDescription, and renders the HTML in a 279 | temporary buffer." 280 | (with-temp-buffer 281 | (let* ((rule-title (format "

%s

" (ht-get params "name"))) 282 | (rule-summary (format "%s
" (ht-get params "htmlDescription"))) 283 | (rule-body-array (ht-get params "htmlDescriptionTabs"))) 284 | (insert rule-title) 285 | (insert rule-summary) 286 | (insert "\n") 287 | (seq-doseq (rule-body rule-body-array) 288 | (let ((rule-body-title (format "

%s

" (ht-get rule-body "title"))) 289 | (rule-body-content (format "%s
" (ht-get (ht-get rule-body "ruleDescriptionTabNonContextual") "htmlContent")))) 290 | (insert rule-body-title) 291 | (insert "\n") 292 | (insert rule-body-content)))) 293 | (shr-render-buffer (current-buffer)))) 294 | 295 | (defun lsp-sonarlint--analyze-folder(dirname) 296 | "Return t if DIRNAME should be analyzed. 297 | i.e folders starting with '.' will be ignored" 298 | (not (string= (substring (file-name-base dirname) 0 1) "."))) 299 | 300 | (defun lsp-sonarlint--invalid-file-name-encoding(file-path) 301 | "Return t if the file-path is not encodable as UTF-8. 302 | This is important since emacs does not support non UTF-8 json serialization, 303 | so a stray accentuated character encoded in a legacy filename in 8859-1 304 | will raise an error for the whole project." 305 | (cl-some (lambda (ch) 306 | (not (encode-coding-char ch 'utf-8 'unicode))) 307 | file-path)) 308 | 309 | (defun lsp-sonarlint--list-files-in-folder (workspace _params) 310 | "Respond to a listFilesInFolder request. 311 | List all files of interest in WORKSPACE's directory. 312 | See `lsp-sonarlint-analyze-folder' to see which files are ignored." 313 | (let* ((root-dir (lsp--workspace-root workspace)) 314 | (files (directory-files-recursively root-dir ".*" nil 'lsp-sonarlint--analyze-folder)) 315 | (utf8-filenames (cl-remove-if #'lsp-sonarlint--invalid-file-name-encoding files))) 316 | (lsp-ht 317 | ("foundFiles" 318 | (apply 'vector 319 | (mapcar (lambda(file) 320 | (lsp-ht 321 | ("fileName" (file-name-nondirectory file)) 322 | ("filePath" file))) 323 | utf8-filenames)))))) 324 | 325 | (defvar lsp-sonarlint--action-handlers '()) 326 | 327 | (lsp-register-custom-settings 328 | '(("sonarlint.disableTelemetry" lsp-sonarlint-disable-telemetry) 329 | ("sonarlint.testFilePattern" lsp-sonarlint-test-file-pattern) 330 | ("sonarlint.pathToCompileCommands" lsp-sonarlint-cfamily-compile-commands-path) 331 | ("sonarlint.output.showAnalyzerLogs" lsp-sonarlint-show-analyzer-logs) 332 | ("sonarlint.output.verboseLogs" lsp-sonarlint-verbose-logs) 333 | ("sonarlint.ls.vmargs" lsp-sonarlint-vmargs))) 334 | 335 | (defvar lsp-sonarlint--request-handlers 336 | (lsp-ht 337 | ;; Check whether the file should be analyzed or not 338 | ;; This is typically to check if an open file is in an active workspace or not 339 | ;; Let's assume here that the file should be analyzed 340 | ("sonarlint/shouldAnalyseFile" (lambda (&rest _) 341 | (lsp-ht 342 | ("shouldBeAnalysed" t)))) 343 | ;; Sonarlint sends those before to ask if you want to display a notification 344 | ;; On what your environement is missing. e.g If you have an old version of nodejs. 345 | ("sonarlint/canShowMissingRequirementsNotification" (lambda (&rest _) t)) 346 | ;; For some reason, sonarlint requests the list of files in the folder 347 | ;; VSCode's extension seems to send everything, even the .git folder. 348 | ;; Here we give anything stored inside of the root directory, except 349 | ;; hidden folders (in the unix sense, those which start with '.') 350 | ("sonarlint/listFilesInFolder" #'lsp-sonarlint--list-files-in-folder) 351 | ;; Sonarlint VSCode extension has a setting to specify a glob pattern 352 | ;; of files to be excluded from analysis. 353 | ;; We do not support this option at the moment, do not filter anything. 354 | ("sonarlint/filterOutExcludedFiles" (lambda (_ params) params)) 355 | ;; Check if the file is ignored by Source Control Manager (a.k.e. VCS, version control system). 356 | ;; I think this is related to .gitignore and similar files. 357 | ;; Probably safe to assume as a first step that you don't care, and want your diagnostics. 358 | ;; TODO: implement a proper check here. 359 | ("sonarlint/isIgnoredByScm" #'ignore) 360 | ;; Probably only relevant to the java analyzer. 361 | ;; Some additional java configuration for the project. 362 | ;; TODO: implement 363 | ("sonarlint/getJavaConfig" #'ignore)) 364 | 365 | "SonarLint-specific request handlers. 366 | See REQUEST-HANDLERS in lsp--client in lsp-mode." 367 | ) 368 | 369 | (defvar lsp-sonarlint--notification-handlers 370 | (lsp-ht 371 | ;; Security Hotspots are a special kind of issue that have particular 372 | ;; interface on SonarCloud, SonarQube, and in SonarLint. See 373 | ;; https://docs.sonarcloud.io/digging-deeper/security-hotspots/ I presume 374 | ;; the PARAMS contain a list of issues of this category, similar to the 375 | ;; normal issues. 376 | ;; TODO: display them, perhaps optionally, as they could be noisy sometimes, 377 | ;; especially without the possibility to "review" them once and forever. 378 | ("sonarlint/publishSecurityHotspots" #'ignore) 379 | ;; Sonarlint sends this to suggest the connected mode, and sends along 380 | ;; your previous sonar projects. Connected mode is not currently implemented here. 381 | ("sonarlint/suggestConnection" #'ignore) 382 | ;; Not sure what this is for. Testing of SonarLint itself? 383 | ("sonarlint/readyForTests" #'ignore) 384 | ;; Sent by cfamily for analysis of C/C++ files. Sonar requires your 385 | ;; build commands specified in a compile_commands.json 386 | ("sonarlint/needCompilationDatabase" (lambda(&rest _) 387 | (warn "Sonar could not find your compile_commands.json, please check `lsp-sonarlint-cfamily-compile-commands-path'"))) 388 | ;; This is probably just to raise awareness of the new kind of issues: 389 | ;; secrets. That'd be too booring to implement. Hopefully, the user is 390 | ;; paying attention and will notice anyway. 391 | ("sonarlint/showNotificationForFirstSecretsIssue" #'ignore) 392 | ("sonarlint/showRuleDescription" #'lsp-sonarlint--code-action-open-rule)) 393 | 394 | "SonarLint-specific notification handlers. 395 | See NOTIFICATION-HANDLERS in lsp--client in lsp-mode.") 396 | 397 | (lsp-register-client 398 | (make-lsp-client 399 | :new-connection (lsp-stdio-connection #'lsp-sonarlint-server-start-fun) 400 | :major-modes lsp-sonarlint-modes-enabled 401 | :priority -1 402 | :request-handlers lsp-sonarlint--request-handlers 403 | :notification-handlers lsp-sonarlint--notification-handlers 404 | :multi-root t 405 | :add-on? t 406 | :server-id 'sonarlint 407 | :action-handlers (ht<-alist lsp-sonarlint--action-handlers) 408 | :initialization-options (lambda () 409 | (list 410 | :productKey "emacs" 411 | :productName "Emacs")) 412 | :initialized-fn (lambda (workspace) 413 | (with-lsp-workspace workspace 414 | (lsp--set-configuration 415 | (lsp-configuration-section "sonarlint")))))) 416 | 417 | (provide 'lsp-sonarlint) 418 | ;;; lsp-sonarlint.el ends here 419 | -------------------------------------------------------------------------------- /test/lsp-sonarlint-integration-test.el: -------------------------------------------------------------------------------- 1 | ;;; integration.el --- Integration tests for SonarLint LSP client -*- lexical-binding: t; -*- 2 | ;;; 3 | ;; Author: Arseniy Zaostrovnykh 4 | ;; Created: 10 Jun 2023 5 | ;; Version: 0.0.1 6 | ;; License: GPL-3.0-or-later 7 | ;; 8 | ;; This program is free software; you can redistribute it and/or modify 9 | ;; it under the terms of the GNU General Public License as published by 10 | ;; the Free Software Foundation, either version 3 of the License, or 11 | ;; (at your option) any later version. 12 | 13 | ;; This program is distributed in the hope that it will be useful, 14 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ;; GNU General Public License for more details. 17 | 18 | ;; You should have received a copy of the GNU General Public License 19 | ;; along with this program. If not, see . 20 | ;; Package-Requires: ((emacs "27.2")) 21 | 22 | ;;; Commentary: 23 | ;; Tests for the integration of the LSP mode and SonarLint language server 24 | ;; through lsp-sonarlint package. 25 | 26 | ;;; Code: 27 | 28 | (require 'lsp-mode) 29 | (require 'lsp-sonarlint) 30 | 31 | (ert-deftest lsp-sonarlint-plugin-downloaded () 32 | "Check whether you have downloaded SonarLint. 33 | 34 | This is a prerequisite for all the integration tests. If this 35 | test fails, you need to download the SonarLint plugin using 36 | 37 | make download-sonarlint" 38 | (should (file-exists-p (concat lsp-sonarlint-download-dir "/extension/server/sonarlint-ls.jar")))) 39 | 40 | (defun lsp-sonarlint--wait-for (predicate hook timeout) 41 | "Register PREDICATE to run on HOOK, and wait until it returns t. 42 | If that does not occur before TIMEOUT, throw an error." 43 | (let ((done nil)) 44 | (cl-flet ((setter (lambda (&rest args) (when (apply predicate args) 45 | (setq done t))))) 46 | (unwind-protect 47 | (progn 48 | (add-hook hook #'setter) 49 | (with-timeout (timeout (error "Timed out waiting for %s" hook)) 50 | (while (not done) (accept-process-output nil 0.1)))) 51 | (remove-hook hook #'setter))))) 52 | 53 | (defun lsp-sonarlint--any-alive-workspaces-p () 54 | "Whether there are any LSP workspaces present in the session." 55 | (< 0 (hash-table-count (lsp-session-folder->servers (lsp-session))))) 56 | 57 | (defun lsp-sonarlint--wait-for-workspaces-to-die (timeout) 58 | "Wait until there are no more active LSP workspaces in the session. 59 | If that does not happen within TIMEOUT, throw an error." 60 | (with-timeout (timeout (error "Timed out waiting for the workspace to shutdown")) 61 | (while (lsp-sonarlint--any-alive-workspaces-p) 62 | (accept-process-output nil 0.1)))) 63 | 64 | (defun lsp-sonarlint--exec-with-diags (file diag-consumer major-mode) 65 | "Execute DIAG-CONSUMER in the buffer holding FILE. 66 | DIAG-CONSUMER is executed once LSP has some diagnostics for the file, 67 | in the LSP-enabled buffer. 68 | DIAG-CONSUMER must accept 1 argument - the list of diagnostics. 69 | It can perform further interaction with LSP, e.g., execute code actions. 70 | The MAJOR-MODE triggering the analysis matters, because the cfamily analyzer 71 | only works for specific textDocument/didOpen:languageId." 72 | ;; It is important to start from a clean slate. 73 | ;; If lsp-mode runs any servers already, the test might fall into a race condition, 74 | ;; when a server was requested to stop, but did not quite shut down yet, 75 | ;; lsp-mode might reopen the connection with the new FILE, thus communicating with the 76 | ;; end-of-life server. This puts lsp-mode into a buggy state - it is a race condition in lsp-mode 77 | (should (null (lsp-sonarlint--any-alive-workspaces-p))) 78 | (let ((lsp-enabled-clients '(sonarlint)) 79 | (lsp-keep-workspace-alive nil) 80 | (dir (file-name-directory file)) 81 | (lsp-enable-snippet nil) 82 | received-warnings) 83 | (let ((buf (find-file-noselect file)) 84 | (diagnostics-updated nil) 85 | (register-warning (lambda (&rest w) (when (equal (car w) 'lsp-mode) 86 | (push (cadr w) received-warnings))))) 87 | (unwind-protect 88 | (progn 89 | (advice-add 'display-warning :before register-warning) 90 | (lsp-workspace-folders-add dir) 91 | (with-current-buffer buf 92 | (funcall major-mode) 93 | (lsp) 94 | (lsp-sonarlint--wait-for 95 | (lambda () 96 | (when-let ((stats (lsp-diagnostics-stats-for file))) 97 | (when (< 0 (seq-reduce '+ stats 0)) 98 | (setq diagnostics-updated (gethash file (lsp-diagnostics t)))))) 99 | 'lsp-diagnostics-updated-hook 100 | 40) 101 | (should (null received-warnings)) 102 | (funcall diag-consumer diagnostics-updated))) 103 | (kill-buffer buf) 104 | (lsp-workspace-folders-remove dir) 105 | (advice-remove 'display-warning register-warning) 106 | (lsp-sonarlint--wait-for-workspaces-to-die 10))))) 107 | 108 | (defun lsp-sonarlint--get-codes-of-issues (issues) 109 | "Extract the code of each of ISSUES." 110 | (sort (mapcar (lambda (issue) (gethash "code" issue)) issues) #'string-lessp)) 111 | 112 | 113 | (defun lsp-sonarlint--fixtures-dir () 114 | "Directory of the test fixtures for these tests." 115 | (concat 116 | (file-name-directory 117 | (directory-file-name (file-name-directory (symbol-file #'lsp-sonarlint--fixtures-dir)))) 118 | "fixtures/")) 119 | 120 | (defun lsp-sonarlint--sample-file (fname) 121 | "Get the full path of the sample file FNAME." 122 | (concat (lsp-sonarlint--fixtures-dir) fname)) 123 | 124 | (defun lsp-sonarlint--get-all-issue-codes (sample-filename &optional major-mode) 125 | "Get all SonarLint issue-codes for given SAMPLE-FILENAME. 126 | This functions takes some time to wait for the LSP mode to init 127 | and get the issues from the server. 128 | MAJOR-MODE specifies the major mode enabled to trigger the analysis. 129 | Some analyzers like cfamily require specific major-modes. 130 | If nil, use python-mode by default." 131 | (lsp-sonarlint--exec-with-diags 132 | (lsp-sonarlint--sample-file sample-filename) 133 | (lambda (diags) 134 | (lsp-sonarlint--get-codes-of-issues diags)) 135 | (if major-mode major-mode 'python-mode))) 136 | 137 | (ert-deftest lsp-sonarlint-lsp-mode-detects-abscent-plugin () 138 | "Check that LSP mode detects the absence of the SonarLint plugin." 139 | (let ((lsp-sonarlint-download-dir (lsp-sonarlint--sample-file "")) 140 | (lsp-sonarlint-use-system-jre t) 141 | (filename (lsp-sonarlint--sample-file "sample.py"))) 142 | (should (null (lsp-sonarlint--any-alive-workspaces-p))) 143 | (let ((lsp-enabled-clients '(sonarlint)) 144 | (lsp-keep-workspace-alive nil) 145 | (dir (file-name-directory filename)) 146 | (lsp-enable-snippet nil)) 147 | (let ((buf (find-file-noselect filename))) 148 | (unwind-protect 149 | (progn 150 | (lsp-workspace-folders-add dir) 151 | (with-current-buffer buf 152 | (python-mode) 153 | (should (string-match-p 154 | "do not have automatic installation: sonarlint" 155 | (lsp))))) 156 | (kill-buffer buf) 157 | (lsp-workspace-folders-remove dir) 158 | (lsp-sonarlint--wait-for-workspaces-to-die 10)))))) 159 | 160 | (ert-deftest lsp-sonarlint-python-reports-issues () 161 | "Check that LSP can get Python SonarLint issues for a Python file." 162 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.py") 163 | '("python:S1135" "python:S1716")))) 164 | 165 | (ert-deftest lsp-sonarlint-java-reports-issues () 166 | "Check that LSP can get Java SonarLint issues for a Java file." 167 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.java") 168 | '("java:S106" "java:S1135" "java:S1220")))) 169 | 170 | (ert-deftest lsp-sonarlint-html-reports-issues () 171 | "Check that LSP can get HTML SonarLint issues for an HTML file." 172 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.html") 173 | '("Web:S1135")))) 174 | 175 | ;; javascript-sample.js must have a distinct name from sample.ts, 176 | ;; otherwise the javascript/typescript plugin gets confused. 177 | (ert-deftest lsp-sonarlint-js-reports-issues () 178 | "Check that LSP can get JavaScript SonarLint issues for a JavaScript file." 179 | (should (equal (lsp-sonarlint--get-all-issue-codes "javascript-sample.js") 180 | '("javascript:S1134" "javascript:S1135")))) 181 | 182 | (ert-deftest lsp-sonarlint-ts-reports-issues () 183 | "Check that LSP can get TypeScript SonarLint issues for a TypeScript file." 184 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.ts") 185 | '("typescript:S1134" "typescript:S1135")))) 186 | 187 | (ert-deftest lsp-sonarlint-php-reports-issues () 188 | "Check that LSP can get PHP SonarLint issues for a PHP file." 189 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.php") 190 | '("php:S1135" "php:S1780")))) 191 | 192 | (ert-deftest lsp-sonarlint-xml-reports-issues () 193 | "Check that LSP can get XML SonarLint issues for a XML file." 194 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.xml") 195 | '("xml:S1135")))) 196 | 197 | ;; "text" plugin detects secrets and bidirectional unicode characters 198 | (ert-deftest lsp-sonarlint-text-reports-issues () 199 | "Check that LSP can detect Secrets with SonarLint." 200 | (let ((lsp-sonarlint-enabled-analyzers '("text"))) 201 | (should (equal (lsp-sonarlint--get-all-issue-codes "secrets.java") 202 | '("secrets:S6290" "secrets:S6290" "secrets:S6290"))))) 203 | 204 | (ert-deftest lsp-sonarlint-go-reports-issues () 205 | "Check that LSP can get go SonarLint issues for a go file." 206 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.go") 207 | '("go:S1135")))) 208 | 209 | (defun lsp-sonarlint--read-file (fname) 210 | "Read the contents of the file FNAME." 211 | (with-temp-buffer 212 | (insert-file-contents (lsp-sonarlint--sample-file fname)) 213 | (buffer-string))) 214 | 215 | (ert-deftest lsp-sonarlint--c++-compiler-available () 216 | "Check that the C++ compiler used for tests is available." 217 | (let ((comp-db (lsp-sonarlint--read-file "compile_commands.json"))) 218 | (should (string-match "command\": \"\\(.*\\) sample.cpp" comp-db)) 219 | (let ((compiler (match-string 1 comp-db))) 220 | (should (executable-find compiler))))) 221 | 222 | (ert-deftest lsp-sonarlint-c++-reports-issues () 223 | "Check that LSP can get go SonarLint issues for a C++ file." 224 | ;; TODO: fix for MacOS 225 | (unless (eq system-type 'darwin) 226 | (should (equal (lsp-sonarlint--get-all-issue-codes "sample.cpp" 'c++-mode) 227 | '("cpp:S995"))))) 228 | 229 | (defun lsp-sonarlint--find-descr-action-at-point () 230 | "Find the `get rule description' code action for the issue at point." 231 | (seq-find (lambda (action) (string-match-p "description" (gethash "title" action))) 232 | (lsp-code-actions-at-point))) 233 | 234 | (defun lsp-sonarlint--buf-has-rule-descr-p (buf) 235 | "Check whether the given buffer contains a rule description." 236 | (with-current-buffer buf 237 | (save-excursion 238 | (goto-char (point-min)) 239 | (message "buffer %s : %s" (current-buffer) 240 | (search-forward "Noncompliant" nil t))) 241 | (save-excursion 242 | (goto-char (point-min)) 243 | (search-forward "Noncompliant" nil t)))) 244 | 245 | (defun lsp-sonarlint--go-to-first-diag (diags) 246 | "Move point to the location within the first diagnostic of DIAGS." 247 | (let* ((first-diagnostic (car diags)) 248 | (diag-range (gethash "start" (gethash "range" first-diagnostic))) 249 | (diag-line (gethash "line" diag-range)) 250 | (diag-col (gethash "character" diag-range))) 251 | (goto-char (point-min)) 252 | (forward-line diag-line) 253 | (forward-char diag-col))) 254 | 255 | (ert-deftest lsp-sonarlint-display-rule-descr-test () 256 | "Check whether you can display rule description for a SonarLint issue." 257 | (lsp-sonarlint--exec-with-diags 258 | (lsp-sonarlint--sample-file "sample.py") 259 | (lambda (diags) 260 | (lsp-sonarlint--go-to-first-diag diags) 261 | (let ((descr-action (lsp-sonarlint--find-descr-action-at-point))) 262 | (let ((description-opened nil)) 263 | (cl-flet ((check-opened-buffer (buf) 264 | (when (lsp-sonarlint--buf-has-rule-descr-p buf) 265 | (setq description-opened t)))) 266 | (unwind-protect 267 | (progn 268 | (advice-add 'shr-render-buffer :before #'check-opened-buffer) 269 | (with-timeout (8 (error "Timeout waiting for rule description")) 270 | (while (not description-opened) 271 | ;; Repeat the request multiple times because SonarLint 272 | ;; might get distracted with other requests and "forget" to 273 | ;; respond 274 | (lsp-execute-code-action descr-action) 275 | (message "still waiting") 276 | (sit-for 0.3))) 277 | (should description-opened)) 278 | (advice-remove 'shr-render-buffer #'check-opened-buffer)))))) 279 | 'python-mode)) 280 | 281 | ;;; integration.el ends here 282 | -------------------------------------------------------------------------------- /test/trivial-test.el: -------------------------------------------------------------------------------- 1 | (ert-deftest trivial-test-to-make-sure-testing-framework-works () 2 | "Check whether the testing framework itself can accept a passing test." 3 | (should (equal (+ 1 1) 2))) 4 | --------------------------------------------------------------------------------