├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── test.yml ├── .gitignore ├── .npmrc ├── cli.js ├── fixtures └── test.png ├── index.js ├── lib ├── index.js └── install.js ├── license ├── package.json ├── readme.md ├── test.js └── vendor ├── freebsd └── x64 │ └── pngquant ├── linux ├── x64 │ └── pngquant └── x86 │ └── pngquant ├── macos └── pngquant ├── source └── pngquant.tar.gz └── win └── pngquant.exe /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: test 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} on ${{ matrix.os }} 8 | runs-on: ${{ matrix.os }} 9 | strategy: 10 | matrix: 11 | node-version: 12 | - 22 13 | - 18 14 | os: 15 | - ubuntu-latest 16 | - macos-latest 17 | - windows-latest 18 | steps: 19 | - uses: actions/checkout@v4 20 | - if: contains(matrix.os, 'ubuntu') 21 | run: sudo apt-get install libimagequant-dev 22 | - if: contains(matrix.os, 'macos') 23 | run: brew install libimagequant 24 | - uses: actions/setup-node@v4 25 | with: 26 | node-version: ${{ matrix.node-version }} 27 | - run: npm install 28 | - run: npm test 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | vendor/pngquant* 3 | vendor/share* 4 | yarn.lock 5 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import process from 'node:process'; 3 | import {execa} from 'execa'; 4 | import pngquant from './index.js'; 5 | 6 | execa(pngquant, process.argv.slice(2), {stdio: 'inherit'}); 7 | -------------------------------------------------------------------------------- /fixtures/test.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/fixtures/test.png -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import lib from './lib/index.js'; 2 | 3 | export default lib.path(); 4 | -------------------------------------------------------------------------------- /lib/index.js: -------------------------------------------------------------------------------- 1 | import fs from 'node:fs'; 2 | import process from 'node:process'; 3 | import {fileURLToPath} from 'node:url'; 4 | import BinWrapper from 'bin-wrapper'; 5 | 6 | const package_ = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url))); 7 | const url = `https://raw.githubusercontent.com/imagemin/pngquant-bin/v${package_.version}/vendor/`; 8 | 9 | const binaryWrapper = new BinWrapper() 10 | .src(`${url}macos/pngquant`, 'darwin') 11 | .src(`${url}linux/x86/pngquant`, 'linux', 'x86') 12 | .src(`${url}linux/x64/pngquant`, 'linux', 'x64') 13 | .src(`${url}freebsd/x64/pngquant`, 'freebsd', 'x64') 14 | .src(`${url}win/pngquant.exe`, 'win32') 15 | .dest(fileURLToPath(new URL('../vendor', import.meta.url))) 16 | .use(process.platform === 'win32' ? 'pngquant.exe' : 'pngquant'); 17 | 18 | export default binaryWrapper; 19 | -------------------------------------------------------------------------------- /lib/install.js: -------------------------------------------------------------------------------- 1 | import process from 'node:process'; 2 | import {fileURLToPath} from 'node:url'; 3 | import binBuild from 'bin-build'; 4 | import bin from './index.js'; 5 | 6 | try { 7 | await bin.run(['--version']); 8 | console.log('pngquant pre-build test passed successfully'); 9 | } catch (error) { 10 | console.warn(error.message); 11 | console.warn('pngquant pre-build test failed'); 12 | console.info('compiling from source'); 13 | 14 | try { 15 | const source = fileURLToPath(new URL('../vendor/source/pngquant.tar.gz', import.meta.url)); 16 | 17 | await binBuild.file(source, [ 18 | 'rm ./INSTALL', 19 | `./configure --prefix="${bin.dest()}"`, 20 | `make install BINPREFIX="${bin.dest()}"`, 21 | ]); 22 | 23 | console.log('pngquant built successfully'); 24 | } catch (error) { 25 | console.error(error.stack); 26 | 27 | // eslint-disable-next-line unicorn/no-process-exit 28 | process.exit(1); 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | pngquant and libimagequant are derived from code by Jef Poskanzer and Greg Roelofs 2 | licensed under pngquant's original licenses (near the end of this file), 3 | and contain extensive changes and additions by Kornel Lesiński. Node.js wrapper is implemented by Imagemin team. 4 | licensed under GPL v3 or later. 5 | 6 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 7 | 8 | pngquant © 2009-2018 by Kornel Lesiński. 9 | pngquant-bin © Imagemin 10 | 11 | GNU GENERAL PUBLIC LICENSE 12 | Version 3, 29 June 2007 13 | 14 | Copyright (C) 2007 Free Software Foundation, Inc. 15 | Everyone is permitted to copy and distribute verbatim copies 16 | of this license document, but changing it is not allowed. 17 | 18 | Preamble 19 | 20 | The GNU General Public License is a free, copyleft license for 21 | software and other kinds of works. 22 | 23 | The licenses for most software and other practical works are designed 24 | to take away your freedom to share and change the works. By contrast, 25 | the GNU General Public License is intended to guarantee your freedom to 26 | share and change all versions of a program--to make sure it remains free 27 | software for all its users. We, the Free Software Foundation, use the 28 | GNU General Public License for most of our software; it applies also to 29 | any other work released this way by its authors. You can apply it to 30 | your programs, too. 31 | 32 | When we speak of free software, we are referring to freedom, not 33 | price. Our General Public Licenses are designed to make sure that you 34 | have the freedom to distribute copies of free software (and charge for 35 | them if you wish), that you receive source code or can get it if you 36 | want it, that you can change the software or use pieces of it in new 37 | free programs, and that you know you can do these things. 38 | 39 | To protect your rights, we need to prevent others from denying you 40 | these rights or asking you to surrender the rights. Therefore, you have 41 | certain responsibilities if you distribute copies of the software, or if 42 | you modify it: responsibilities to respect the freedom of others. 43 | 44 | For example, if you distribute copies of such a program, whether 45 | gratis or for a fee, you must pass on to the recipients the same 46 | freedoms that you received. You must make sure that they, too, receive 47 | or can get the source code. And you must show them these terms so they 48 | know their rights. 49 | 50 | Developers that use the GNU GPL protect your rights with two steps: 51 | (1) assert copyright on the software, and (2) offer you this License 52 | giving you legal permission to copy, distribute and/or modify it. 53 | 54 | For the developers' and authors' protection, the GPL clearly explains 55 | that there is no warranty for this free software. For both users' and 56 | authors' sake, the GPL requires that modified versions be marked as 57 | changed, so that their problems will not be attributed erroneously to 58 | authors of previous versions. 59 | 60 | Some devices are designed to deny users access to install or run 61 | modified versions of the software inside them, although the manufacturer 62 | can do so. This is fundamentally incompatible with the aim of 63 | protecting users' freedom to change the software. The systematic 64 | pattern of such abuse occurs in the area of products for individuals to 65 | use, which is precisely where it is most unacceptable. Therefore, we 66 | have designed this version of the GPL to prohibit the practice for those 67 | products. If such problems arise substantially in other domains, we 68 | stand ready to extend this provision to those domains in future versions 69 | of the GPL, as needed to protect the freedom of users. 70 | 71 | Finally, every program is threatened constantly by software patents. 72 | States should not allow patents to restrict development and use of 73 | software on general-purpose computers, but in those that do, we wish to 74 | avoid the special danger that patents applied to a free program could 75 | make it effectively proprietary. To prevent this, the GPL assures that 76 | patents cannot be used to render the program non-free. 77 | 78 | The precise terms and conditions for copying, distribution and 79 | modification follow. 80 | 81 | TERMS AND CONDITIONS 82 | 83 | 0. Definitions. 84 | 85 | "This License" refers to version 3 of the GNU General Public License. 86 | 87 | "Copyright" also means copyright-like laws that apply to other kinds of 88 | works, such as semiconductor masks. 89 | 90 | "The Program" refers to any copyrightable work licensed under this 91 | License. Each licensee is addressed as "you". "Licensees" and 92 | "recipients" may be individuals or organizations. 93 | 94 | To "modify" a work means to copy from or adapt all or part of the work 95 | in a fashion requiring copyright permission, other than the making of an 96 | exact copy. The resulting work is called a "modified version" of the 97 | earlier work or a work "based on" the earlier work. 98 | 99 | A "covered work" means either the unmodified Program or a work based 100 | on the Program. 101 | 102 | To "propagate" a work means to do anything with it that, without 103 | permission, would make you directly or secondarily liable for 104 | infringement under applicable copyright law, except executing it on a 105 | computer or modifying a private copy. Propagation includes copying, 106 | distribution (with or without modification), making available to the 107 | public, and in some countries other activities as well. 108 | 109 | To "convey" a work means any kind of propagation that enables other 110 | parties to make or receive copies. Mere interaction with a user through 111 | a computer network, with no transfer of a copy, is not conveying. 112 | 113 | An interactive user interface displays "Appropriate Legal Notices" 114 | to the extent that it includes a convenient and prominently visible 115 | feature that (1) displays an appropriate copyright notice, and (2) 116 | tells the user that there is no warranty for the work (except to the 117 | extent that warranties are provided), that licensees may convey the 118 | work under this License, and how to view a copy of this License. If 119 | the interface presents a list of user commands or options, such as a 120 | menu, a prominent item in the list meets this criterion. 121 | 122 | 1. Source Code. 123 | 124 | The "source code" for a work means the preferred form of the work 125 | for making modifications to it. "Object code" means any non-source 126 | form of a work. 127 | 128 | A "Standard Interface" means an interface that either is an official 129 | standard defined by a recognized standards body, or, in the case of 130 | interfaces specified for a particular programming language, one that 131 | is widely used among developers working in that language. 132 | 133 | The "System Libraries" of an executable work include anything, other 134 | than the work as a whole, that (a) is included in the normal form of 135 | packaging a Major Component, but which is not part of that Major 136 | Component, and (b) serves only to enable use of the work with that 137 | Major Component, or to implement a Standard Interface for which an 138 | implementation is available to the public in source code form. A 139 | "Major Component", in this context, means a major essential component 140 | (kernel, window system, and so on) of the specific operating system 141 | (if any) on which the executable work runs, or a compiler used to 142 | produce the work, or an object code interpreter used to run it. 143 | 144 | The "Corresponding Source" for a work in object code form means all 145 | the source code needed to generate, install, and (for an executable 146 | work) run the object code and to modify the work, including scripts to 147 | control those activities. However, it does not include the work's 148 | System Libraries, or general-purpose tools or generally available free 149 | programs which are used unmodified in performing those activities but 150 | which are not part of the work. For example, Corresponding Source 151 | includes interface definition files associated with source files for 152 | the work, and the source code for shared libraries and dynamically 153 | linked subprograms that the work is specifically designed to require, 154 | such as by intimate data communication or control flow between those 155 | subprograms and other parts of the work. 156 | 157 | The Corresponding Source need not include anything that users 158 | can regenerate automatically from other parts of the Corresponding 159 | Source. 160 | 161 | The Corresponding Source for a work in source code form is that 162 | same work. 163 | 164 | 2. Basic Permissions. 165 | 166 | All rights granted under this License are granted for the term of 167 | copyright on the Program, and are irrevocable provided the stated 168 | conditions are met. This License explicitly affirms your unlimited 169 | permission to run the unmodified Program. The output from running a 170 | covered work is covered by this License only if the output, given its 171 | content, constitutes a covered work. This License acknowledges your 172 | rights of fair use or other equivalent, as provided by copyright law. 173 | 174 | You may make, run and propagate covered works that you do not 175 | convey, without conditions so long as your license otherwise remains 176 | in force. You may convey covered works to others for the sole purpose 177 | of having them make modifications exclusively for you, or provide you 178 | with facilities for running those works, provided that you comply with 179 | the terms of this License in conveying all material for which you do 180 | not control copyright. Those thus making or running the covered works 181 | for you must do so exclusively on your behalf, under your direction 182 | and control, on terms that prohibit them from making any copies of 183 | your copyrighted material outside their relationship with you. 184 | 185 | Conveying under any other circumstances is permitted solely under 186 | the conditions stated below. Sublicensing is not allowed; section 10 187 | makes it unnecessary. 188 | 189 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 190 | 191 | No covered work shall be deemed part of an effective technological 192 | measure under any applicable law fulfilling obligations under article 193 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 194 | similar laws prohibiting or restricting circumvention of such 195 | measures. 196 | 197 | When you convey a covered work, you waive any legal power to forbid 198 | circumvention of technological measures to the extent such circumvention 199 | is effected by exercising rights under this License with respect to 200 | the covered work, and you disclaim any intention to limit operation or 201 | modification of the work as a means of enforcing, against the work's 202 | users, your or third parties' legal rights to forbid circumvention of 203 | technological measures. 204 | 205 | 4. Conveying Verbatim Copies. 206 | 207 | You may convey verbatim copies of the Program's source code as you 208 | receive it, in any medium, provided that you conspicuously and 209 | appropriately publish on each copy an appropriate copyright notice; 210 | keep intact all notices stating that this License and any 211 | non-permissive terms added in accord with section 7 apply to the code; 212 | keep intact all notices of the absence of any warranty; and give all 213 | recipients a copy of this License along with the Program. 214 | 215 | You may charge any price or no price for each copy that you convey, 216 | and you may offer support or warranty protection for a fee. 217 | 218 | 5. Conveying Modified Source Versions. 219 | 220 | You may convey a work based on the Program, or the modifications to 221 | produce it from the Program, in the form of source code under the 222 | terms of section 4, provided that you also meet all of these conditions: 223 | 224 | a) The work must carry prominent notices stating that you modified 225 | it, and giving a relevant date. 226 | 227 | b) The work must carry prominent notices stating that it is 228 | released under this License and any conditions added under section 229 | 7. This requirement modifies the requirement in section 4 to 230 | "keep intact all notices". 231 | 232 | c) You must license the entire work, as a whole, under this 233 | License to anyone who comes into possession of a copy. This 234 | License will therefore apply, along with any applicable section 7 235 | additional terms, to the whole of the work, and all its parts, 236 | regardless of how they are packaged. This License gives no 237 | permission to license the work in any other way, but it does not 238 | invalidate such permission if you have separately received it. 239 | 240 | d) If the work has interactive user interfaces, each must display 241 | Appropriate Legal Notices; however, if the Program has interactive 242 | interfaces that do not display Appropriate Legal Notices, your 243 | work need not make them do so. 244 | 245 | A compilation of a covered work with other separate and independent 246 | works, which are not by their nature extensions of the covered work, 247 | and which are not combined with it such as to form a larger program, 248 | in or on a volume of a storage or distribution medium, is called an 249 | "aggregate" if the compilation and its resulting copyright are not 250 | used to limit the access or legal rights of the compilation's users 251 | beyond what the individual works permit. Inclusion of a covered work 252 | in an aggregate does not cause this License to apply to the other 253 | parts of the aggregate. 254 | 255 | 6. Conveying Non-Source Forms. 256 | 257 | You may convey a covered work in object code form under the terms 258 | of sections 4 and 5, provided that you also convey the 259 | machine-readable Corresponding Source under the terms of this License, 260 | in one of these ways: 261 | 262 | a) Convey the object code in, or embodied in, a physical product 263 | (including a physical distribution medium), accompanied by the 264 | Corresponding Source fixed on a durable physical medium 265 | customarily used for software interchange. 266 | 267 | b) Convey the object code in, or embodied in, a physical product 268 | (including a physical distribution medium), accompanied by a 269 | written offer, valid for at least three years and valid for as 270 | long as you offer spare parts or customer support for that product 271 | model, to give anyone who possesses the object code either (1) a 272 | copy of the Corresponding Source for all the software in the 273 | product that is covered by this License, on a durable physical 274 | medium customarily used for software interchange, for a price no 275 | more than your reasonable cost of physically performing this 276 | conveying of source, or (2) access to copy the 277 | Corresponding Source from a network server at no charge. 278 | 279 | c) Convey individual copies of the object code with a copy of the 280 | written offer to provide the Corresponding Source. This 281 | alternative is allowed only occasionally and noncommercially, and 282 | only if you received the object code with such an offer, in accord 283 | with subsection 6b. 284 | 285 | d) Convey the object code by offering access from a designated 286 | place (gratis or for a charge), and offer equivalent access to the 287 | Corresponding Source in the same way through the same place at no 288 | further charge. You need not require recipients to copy the 289 | Corresponding Source along with the object code. If the place to 290 | copy the object code is a network server, the Corresponding Source 291 | may be on a different server (operated by you or a third party) 292 | that supports equivalent copying facilities, provided you maintain 293 | clear directions next to the object code saying where to find the 294 | Corresponding Source. Regardless of what server hosts the 295 | Corresponding Source, you remain obligated to ensure that it is 296 | available for as long as needed to satisfy these requirements. 297 | 298 | e) Convey the object code using peer-to-peer transmission, provided 299 | you inform other peers where the object code and Corresponding 300 | Source of the work are being offered to the general public at no 301 | charge under subsection 6d. 302 | 303 | A separable portion of the object code, whose source code is excluded 304 | from the Corresponding Source as a System Library, need not be 305 | included in conveying the object code work. 306 | 307 | A "User Product" is either (1) a "consumer product", which means any 308 | tangible personal property which is normally used for personal, family, 309 | or household purposes, or (2) anything designed or sold for incorporation 310 | into a dwelling. In determining whether a product is a consumer product, 311 | doubtful cases shall be resolved in favor of coverage. For a particular 312 | product received by a particular user, "normally used" refers to a 313 | typical or common use of that class of product, regardless of the status 314 | of the particular user or of the way in which the particular user 315 | actually uses, or expects or is expected to use, the product. A product 316 | is a consumer product regardless of whether the product has substantial 317 | commercial, industrial or non-consumer uses, unless such uses represent 318 | the only significant mode of use of the product. 319 | 320 | "Installation Information" for a User Product means any methods, 321 | procedures, authorization keys, or other information required to install 322 | and execute modified versions of a covered work in that User Product from 323 | a modified version of its Corresponding Source. The information must 324 | suffice to ensure that the continued functioning of the modified object 325 | code is in no case prevented or interfered with solely because 326 | modification has been made. 327 | 328 | If you convey an object code work under this section in, or with, or 329 | specifically for use in, a User Product, and the conveying occurs as 330 | part of a transaction in which the right of possession and use of the 331 | User Product is transferred to the recipient in perpetuity or for a 332 | fixed term (regardless of how the transaction is characterized), the 333 | Corresponding Source conveyed under this section must be accompanied 334 | by the Installation Information. But this requirement does not apply 335 | if neither you nor any third party retains the ability to install 336 | modified object code on the User Product (for example, the work has 337 | been installed in ROM). 338 | 339 | The requirement to provide Installation Information does not include a 340 | requirement to continue to provide support service, warranty, or updates 341 | for a work that has been modified or installed by the recipient, or for 342 | the User Product in which it has been modified or installed. Access to a 343 | network may be denied when the modification itself materially and 344 | adversely affects the operation of the network or violates the rules and 345 | protocols for communication across the network. 346 | 347 | Corresponding Source conveyed, and Installation Information provided, 348 | in accord with this section must be in a format that is publicly 349 | documented (and with an implementation available to the public in 350 | source code form), and must require no special password or key for 351 | unpacking, reading or copying. 352 | 353 | 7. Additional Terms. 354 | 355 | "Additional permissions" are terms that supplement the terms of this 356 | License by making exceptions from one or more of its conditions. 357 | Additional permissions that are applicable to the entire Program shall 358 | be treated as though they were included in this License, to the extent 359 | that they are valid under applicable law. If additional permissions 360 | apply only to part of the Program, that part may be used separately 361 | under those permissions, but the entire Program remains governed by 362 | this License without regard to the additional permissions. 363 | 364 | When you convey a copy of a covered work, you may at your option 365 | remove any additional permissions from that copy, or from any part of 366 | it. (Additional permissions may be written to require their own 367 | removal in certain cases when you modify the work.) You may place 368 | additional permissions on material, added by you to a covered work, 369 | for which you have or can give appropriate copyright permission. 370 | 371 | Notwithstanding any other provision of this License, for material you 372 | add to a covered work, you may (if authorized by the copyright holders of 373 | that material) supplement the terms of this License with terms: 374 | 375 | a) Disclaiming warranty or limiting liability differently from the 376 | terms of sections 15 and 16 of this License; or 377 | 378 | b) Requiring preservation of specified reasonable legal notices or 379 | author attributions in that material or in the Appropriate Legal 380 | Notices displayed by works containing it; or 381 | 382 | c) Prohibiting misrepresentation of the origin of that material, or 383 | requiring that modified versions of such material be marked in 384 | reasonable ways as different from the original version; or 385 | 386 | d) Limiting the use for publicity purposes of names of licensors or 387 | authors of the material; or 388 | 389 | e) Declining to grant rights under trademark law for use of some 390 | trade names, trademarks, or service marks; or 391 | 392 | f) Requiring indemnification of licensors and authors of that 393 | material by anyone who conveys the material (or modified versions of 394 | it) with contractual assumptions of liability to the recipient, for 395 | any liability that these contractual assumptions directly impose on 396 | those licensors and authors. 397 | 398 | All other non-permissive additional terms are considered "further 399 | restrictions" within the meaning of section 10. If the Program as you 400 | received it, or any part of it, contains a notice stating that it is 401 | governed by this License along with a term that is a further 402 | restriction, you may remove that term. If a license document contains 403 | a further restriction but permits relicensing or conveying under this 404 | License, you may add to a covered work material governed by the terms 405 | of that license document, provided that the further restriction does 406 | not survive such relicensing or conveying. 407 | 408 | If you add terms to a covered work in accord with this section, you 409 | must place, in the relevant source files, a statement of the 410 | additional terms that apply to those files, or a notice indicating 411 | where to find the applicable terms. 412 | 413 | Additional terms, permissive or non-permissive, may be stated in the 414 | form of a separately written license, or stated as exceptions; 415 | the above requirements apply either way. 416 | 417 | 8. Termination. 418 | 419 | You may not propagate or modify a covered work except as expressly 420 | provided under this License. Any attempt otherwise to propagate or 421 | modify it is void, and will automatically terminate your rights under 422 | this License (including any patent licenses granted under the third 423 | paragraph of section 11). 424 | 425 | However, if you cease all violation of this License, then your 426 | license from a particular copyright holder is reinstated (a) 427 | provisionally, unless and until the copyright holder explicitly and 428 | finally terminates your license, and (b) permanently, if the copyright 429 | holder fails to notify you of the violation by some reasonable means 430 | prior to 60 days after the cessation. 431 | 432 | Moreover, your license from a particular copyright holder is 433 | reinstated permanently if the copyright holder notifies you of the 434 | violation by some reasonable means, this is the first time you have 435 | received notice of violation of this License (for any work) from that 436 | copyright holder, and you cure the violation prior to 30 days after 437 | your receipt of the notice. 438 | 439 | Termination of your rights under this section does not terminate the 440 | licenses of parties who have received copies or rights from you under 441 | this License. If your rights have been terminated and not permanently 442 | reinstated, you do not qualify to receive new licenses for the same 443 | material under section 10. 444 | 445 | 9. Acceptance Not Required for Having Copies. 446 | 447 | You are not required to accept this License in order to receive or 448 | run a copy of the Program. Ancillary propagation of a covered work 449 | occurring solely as a consequence of using peer-to-peer transmission 450 | to receive a copy likewise does not require acceptance. However, 451 | nothing other than this License grants you permission to propagate or 452 | modify any covered work. These actions infringe copyright if you do 453 | not accept this License. Therefore, by modifying or propagating a 454 | covered work, you indicate your acceptance of this License to do so. 455 | 456 | 10. Automatic Licensing of Downstream Recipients. 457 | 458 | Each time you convey a covered work, the recipient automatically 459 | receives a license from the original licensors, to run, modify and 460 | propagate that work, subject to this License. You are not responsible 461 | for enforcing compliance by third parties with this License. 462 | 463 | An "entity transaction" is a transaction transferring control of an 464 | organization, or substantially all assets of one, or subdividing an 465 | organization, or merging organizations. If propagation of a covered 466 | work results from an entity transaction, each party to that 467 | transaction who receives a copy of the work also receives whatever 468 | licenses to the work the party's predecessor in interest had or could 469 | give under the previous paragraph, plus a right to possession of the 470 | Corresponding Source of the work from the predecessor in interest, if 471 | the predecessor has it or can get it with reasonable efforts. 472 | 473 | You may not impose any further restrictions on the exercise of the 474 | rights granted or affirmed under this License. For example, you may 475 | not impose a license fee, royalty, or other charge for exercise of 476 | rights granted under this License, and you may not initiate litigation 477 | (including a cross-claim or counterclaim in a lawsuit) alleging that 478 | any patent claim is infringed by making, using, selling, offering for 479 | sale, or importing the Program or any portion of it. 480 | 481 | 11. Patents. 482 | 483 | A "contributor" is a copyright holder who authorizes use under this 484 | License of the Program or a work on which the Program is based. The 485 | work thus licensed is called the contributor's "contributor version". 486 | 487 | A contributor's "essential patent claims" are all patent claims 488 | owned or controlled by the contributor, whether already acquired or 489 | hereafter acquired, that would be infringed by some manner, permitted 490 | by this License, of making, using, or selling its contributor version, 491 | but do not include claims that would be infringed only as a 492 | consequence of further modification of the contributor version. For 493 | purposes of this definition, "control" includes the right to grant 494 | patent sublicenses in a manner consistent with the requirements of 495 | this License. 496 | 497 | Each contributor grants you a non-exclusive, worldwide, royalty-free 498 | patent license under the contributor's essential patent claims, to 499 | make, use, sell, offer for sale, import and otherwise run, modify and 500 | propagate the contents of its contributor version. 501 | 502 | In the following three paragraphs, a "patent license" is any express 503 | agreement or commitment, however denominated, not to enforce a patent 504 | (such as an express permission to practice a patent or covenant not to 505 | sue for patent infringement). To "grant" such a patent license to a 506 | party means to make such an agreement or commitment not to enforce a 507 | patent against the party. 508 | 509 | If you convey a covered work, knowingly relying on a patent license, 510 | and the Corresponding Source of the work is not available for anyone 511 | to copy, free of charge and under the terms of this License, through a 512 | publicly available network server or other readily accessible means, 513 | then you must either (1) cause the Corresponding Source to be so 514 | available, or (2) arrange to deprive yourself of the benefit of the 515 | patent license for this particular work, or (3) arrange, in a manner 516 | consistent with the requirements of this License, to extend the patent 517 | license to downstream recipients. "Knowingly relying" means you have 518 | actual knowledge that, but for the patent license, your conveying the 519 | covered work in a country, or your recipient's use of the covered work 520 | in a country, would infringe one or more identifiable patents in that 521 | country that you have reason to believe are valid. 522 | 523 | If, pursuant to or in connection with a single transaction or 524 | arrangement, you convey, or propagate by procuring conveyance of, a 525 | covered work, and grant a patent license to some of the parties 526 | receiving the covered work authorizing them to use, propagate, modify 527 | or convey a specific copy of the covered work, then the patent license 528 | you grant is automatically extended to all recipients of the covered 529 | work and works based on it. 530 | 531 | A patent license is "discriminatory" if it does not include within 532 | the scope of its coverage, prohibits the exercise of, or is 533 | conditioned on the non-exercise of one or more of the rights that are 534 | specifically granted under this License. You may not convey a covered 535 | work if you are a party to an arrangement with a third party that is 536 | in the business of distributing software, under which you make payment 537 | to the third party based on the extent of your activity of conveying 538 | the work, and under which the third party grants, to any of the 539 | parties who would receive the covered work from you, a discriminatory 540 | patent license (a) in connection with copies of the covered work 541 | conveyed by you (or copies made from those copies), or (b) primarily 542 | for and in connection with specific products or compilations that 543 | contain the covered work, unless you entered into that arrangement, 544 | or that patent license was granted, prior to 28 March 2007. 545 | 546 | Nothing in this License shall be construed as excluding or limiting 547 | any implied license or other defenses to infringement that may 548 | otherwise be available to you under applicable patent law. 549 | 550 | 12. No Surrender of Others' Freedom. 551 | 552 | If conditions are imposed on you (whether by court order, agreement or 553 | otherwise) that contradict the conditions of this License, they do not 554 | excuse you from the conditions of this License. If you cannot convey a 555 | covered work so as to satisfy simultaneously your obligations under this 556 | License and any other pertinent obligations, then as a consequence you may 557 | not convey it at all. For example, if you agree to terms that obligate you 558 | to collect a royalty for further conveying from those to whom you convey 559 | the Program, the only way you could satisfy both those terms and this 560 | License would be to refrain entirely from conveying the Program. 561 | 562 | 13. Use with the GNU Affero General Public License. 563 | 564 | Notwithstanding any other provision of this License, you have 565 | permission to link or combine any covered work with a work licensed 566 | under version 3 of the GNU Affero General Public License into a single 567 | combined work, and to convey the resulting work. The terms of this 568 | License will continue to apply to the part which is the covered work, 569 | but the special requirements of the GNU Affero General Public License, 570 | section 13, concerning interaction through a network will apply to the 571 | combination as such. 572 | 573 | 14. Revised Versions of this License. 574 | 575 | The Free Software Foundation may publish revised and/or new versions of 576 | the GNU General Public License from time to time. Such new versions will 577 | be similar in spirit to the present version, but may differ in detail to 578 | address new problems or concerns. 579 | 580 | Each version is given a distinguishing version number. If the 581 | Program specifies that a certain numbered version of the GNU General 582 | Public License "or any later version" applies to it, you have the 583 | option of following the terms and conditions either of that numbered 584 | version or of any later version published by the Free Software 585 | Foundation. If the Program does not specify a version number of the 586 | GNU General Public License, you may choose any version ever published 587 | by the Free Software Foundation. 588 | 589 | If the Program specifies that a proxy can decide which future 590 | versions of the GNU General Public License can be used, that proxy's 591 | public statement of acceptance of a version permanently authorizes you 592 | to choose that version for the Program. 593 | 594 | Later license versions may give you additional or different 595 | permissions. However, no additional obligations are imposed on any 596 | author or copyright holder as a result of your choosing to follow a 597 | later version. 598 | 599 | 15. Disclaimer of Warranty. 600 | 601 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 602 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 603 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 604 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 605 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 606 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 607 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 608 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 609 | 610 | 16. Limitation of Liability. 611 | 612 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 613 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 614 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 615 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 616 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 617 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 618 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 619 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 620 | SUCH DAMAGES. 621 | 622 | 17. Interpretation of Sections 15 and 16. 623 | 624 | If the disclaimer of warranty and limitation of liability provided 625 | above cannot be given local legal effect according to their terms, 626 | reviewing courts shall apply local law that most closely approximates 627 | an absolute waiver of all civil liability in connection with the 628 | Program, unless a warranty or assumption of liability accompanies a 629 | copy of the Program in return for a fee. 630 | 631 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 632 | 633 | The quantization and dithering code in pngquant is lifted from Jef Poskanzer's 634 | 'ppmquant', part of his wonderful PBMPLUS tool suite. 635 | 636 | Greg Roelofs hacked it into a (in his words) "slightly cheesy" 'pamquant' back 637 | in 1997 (see http://pobox.com/~newt/greg_rgba.html) and finally he ripped out 638 | the cheesy file-I/O parts and replaced them with nice PNG code in December 639 | 2000. The PNG reading and writing code is a merged and slightly simplified 640 | version of readpng, readpng2, and writepng from his book "PNG: The Definitive 641 | Guide." 642 | In 2014 Greg has relicensed the code under the simplified BSD license. 643 | 644 | Note that both licenses are basically BSD-like; that is, use the code however 645 | you like, as long as you acknowledge its origins. 646 | 647 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 648 | 649 | pngquant.c: 650 | 651 | © 1989, 1991 by Jef Poskanzer. 652 | 653 | Permission to use, copy, modify, and distribute this software and its 654 | documentation for any purpose and without fee is hereby granted, provided 655 | that the above copyright notice appear in all copies and that both that 656 | copyright notice and this permission notice appear in supporting 657 | documentation. This software is provided "as is" without express or 658 | implied warranty. 659 | 660 | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 661 | 662 | pngquant.c and rwpng.c/h: 663 | 664 | © 1997-2002 by Greg Roelofs; based on an idea by Stefan Schneider. 665 | 666 | All rights reserved. 667 | 668 | Redistribution and use in source and binary forms, with or without modification, 669 | are permitted provided that the following conditions are met: 670 | 671 | 1. Redistributions of source code must retain the above copyright notice, 672 | this list of conditions and the following disclaimer. 673 | 674 | 2. Redistributions in binary form must reproduce the above copyright notice, 675 | this list of conditions and the following disclaimer in the documentation 676 | and/or other materials provided with the distribution. 677 | 678 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 679 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 680 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 681 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 682 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 683 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 684 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 685 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 686 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 687 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 688 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "pngquant-bin", 3 | "version": "9.0.0", 4 | "description": "`pngquant` wrapper that makes it seamlessly available as a local dependency", 5 | "license": "GPL-3.0+", 6 | "repository": "imagemin/pngquant-bin", 7 | "type": "module", 8 | "exports": "./index.js", 9 | "bin": { 10 | "pngquant": "cli.js" 11 | }, 12 | "engines": { 13 | "node": ">=18" 14 | }, 15 | "scripts": { 16 | "postinstall": "node lib/install.js", 17 | "test": "xo && ava --timeout=120s" 18 | }, 19 | "files": [ 20 | "cli.js", 21 | "index.js", 22 | "lib", 23 | "vendor/source" 24 | ], 25 | "keywords": [ 26 | "imagemin", 27 | "compress", 28 | "image", 29 | "minify", 30 | "optimize", 31 | "png", 32 | "pngquant" 33 | ], 34 | "dependencies": { 35 | "bin-build": "^3.0.0", 36 | "bin-wrapper": "^4.0.1", 37 | "execa": "^8.0.1" 38 | }, 39 | "devDependencies": { 40 | "ava": "^6.1.2", 41 | "bin-check": "^4.0.1", 42 | "compare-size": "^3.0.0", 43 | "tempy": "^3.0.0", 44 | "xo": "^0.58.0" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # pngquant-bin ![GitHub Actions Status](https://github.com/imagemin/pngquant-bin/workflows/test/badge.svg?branch=main) 2 | 3 | > [`pngquant`](https://github.com/kornelski/pngquant) is a PNG compressor that significantly reduces file sizes by converting images to a more efficient 8-bit PNG format 4 | 5 | You probably want [`imagemin-pngquant`](https://github.com/imagemin/imagemin-pngquant) instead. 6 | 7 | ## Install 8 | 9 | ```sh 10 | npm install pngquant-bin 11 | ``` 12 | 13 | Make sure you have the correct version of [libimagequant](https://github.com/ImageOptim/libimagequant). 14 | 15 | ```sh 16 | # via Homebrew for macOS 17 | brew install libimagequant 18 | 19 | # via apt-get for Debian distributions 20 | sudo apt-get install libimagequant-dev 21 | ``` 22 | 23 | ## Usage 24 | 25 | ```js 26 | import {execFile} from 'node:child_process'; 27 | import pngquant from 'pngquant-bin'; 28 | 29 | execFile(pngquant, ['-o', 'output.png', 'input.png'], error => { 30 | console.log('Image minified!'); 31 | }); 32 | ``` 33 | 34 | ## CLI 35 | 36 | ```sh 37 | npm install --global pngquant-bin 38 | ``` 39 | 40 | ```sh 41 | pngquant --help 42 | ``` 43 | 44 | ## Updating pre-compiled binaries 45 | 46 | The Linux binaries are statically linked so they should work on all Linux distributions. To recompile them: 47 | 48 | 1. `sudo apt-get install libpng-dev` 49 | 2. `./configure CFLAGS=-static && make && cp pngquant pngquant-64` 50 | 3. Repeat the above commands, but in a 32-bin docker container started with: docker run -ti -v `pwd`:/source i386/debian:9.3 bash 51 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import fs from 'node:fs'; 2 | import path from 'node:path'; 3 | import process from 'node:process'; 4 | import {fileURLToPath} from 'node:url'; 5 | import test from 'ava'; 6 | import {execa} from 'execa'; 7 | import {temporaryDirectory} from 'tempy'; 8 | import binCheck from 'bin-check'; 9 | import binBuild from 'bin-build'; 10 | import compareSize from 'compare-size'; 11 | import pngquant from './index.js'; 12 | 13 | test('rebuild the pngquant binaries', async t => { 14 | // Skip the test on Windows 15 | if (process.platform === 'win32') { 16 | t.pass(); 17 | return; 18 | } 19 | 20 | const temporary = temporaryDirectory(); 21 | const source = fileURLToPath(new URL('vendor/source/pngquant.tar.gz', import.meta.url)); 22 | 23 | await binBuild.file(source, [ 24 | 'rm ./INSTALL', 25 | `./configure --prefix="${temporary}"`, 26 | `make install BINPREFIX="${temporary}"`, 27 | ]); 28 | 29 | t.true(fs.existsSync(path.join(temporary, 'pngquant'))); 30 | }); 31 | 32 | test('verify binary', async t => { 33 | t.true(await binCheck(pngquant, ['--version'])); 34 | }); 35 | 36 | test('minify a png', async t => { 37 | const temporary = temporaryDirectory(); 38 | const source = fileURLToPath(new URL('fixtures/test.png', import.meta.url)); 39 | const destination = path.join(temporary, 'test.png'); 40 | const arguments_ = [ 41 | '-o', 42 | destination, 43 | source, 44 | ]; 45 | 46 | await execa(pngquant, arguments_); 47 | const result = await compareSize(source, destination); 48 | 49 | t.true(result[destination] < result[source]); 50 | }); 51 | -------------------------------------------------------------------------------- /vendor/freebsd/x64/pngquant: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/vendor/freebsd/x64/pngquant -------------------------------------------------------------------------------- /vendor/linux/x64/pngquant: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/vendor/linux/x64/pngquant -------------------------------------------------------------------------------- /vendor/linux/x86/pngquant: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/vendor/linux/x86/pngquant -------------------------------------------------------------------------------- /vendor/macos/pngquant: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/vendor/macos/pngquant -------------------------------------------------------------------------------- /vendor/source/pngquant.tar.gz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/vendor/source/pngquant.tar.gz -------------------------------------------------------------------------------- /vendor/win/pngquant.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/imagemin/pngquant-bin/5a823f9f6fa30af532ce47e3881b41103995ea44/vendor/win/pngquant.exe --------------------------------------------------------------------------------