├── .editorconfig ├── .eslintignore ├── .eslintrc ├── .github └── workflows │ └── publish.yml ├── .gitignore ├── LICENSE ├── README.md ├── bin ├── prepack-script ├── run └── run.cmd ├── package-lock.json ├── package.json ├── src ├── command.ts ├── commands │ ├── bundle.ts │ └── serve.ts ├── index.ts ├── server.ts ├── utils.ts └── website-generation │ └── homepage.pug ├── test ├── commands │ ├── bundle.test.ts │ ├── hello.test.ts │ └── serve.test.ts ├── mocha.opts └── tsconfig.json ├── tsconfig.build.json └── tsconfig.json /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.md] 11 | trim_trailing_whitespace = false 12 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /lib 2 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "oclif", 4 | "oclif-typescript" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Node.js Package 2 | on: 3 | release: 4 | types: [created] 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v2 10 | # Setup .npmrc file to publish to npm 11 | - uses: actions/setup-node@v1 12 | with: 13 | node-version: '12.x' 14 | registry-url: 'https://registry.npmjs.org' 15 | - run: npm install 16 | - run: npm publish 17 | env: 18 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 19 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *-debug.log 2 | *-error.log 3 | /.nyc_output 4 | /dist 5 | /lib 6 | /tmp 7 | /yarn.lock 8 | node_modules 9 | 10 | # mac stuff 11 | .DS_Store -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | paperback-cli 2 | ============= 3 | 4 | Paperback CLI for common tools 5 | 6 | [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) 7 | [![Version](https://img.shields.io/npm/v/paperback-cli.svg)](https://npmjs.org/package/paperback-cli) 8 | [![Downloads/week](https://img.shields.io/npm/dw/paperback-cli.svg)](https://npmjs.org/package/paperback-cli) 9 | [![License](https://img.shields.io/npm/l/paperback-cli.svg)](https://github.com/FaizanDurrani/paperback-cli/blob/master/package.json) 10 | 11 | 12 | * [Usage](#usage) 13 | * [Commands](#commands) 14 | 15 | # Usage 16 | 17 | ```sh-session 18 | $ npm install -g paperback-cli 19 | $ paperback COMMAND 20 | running command... 21 | $ paperback (-v|--version|version) 22 | paperback-cli/1.3.3 darwin-x64 node-v15.3.0 23 | $ paperback --help [COMMAND] 24 | USAGE 25 | $ paperback COMMAND 26 | ... 27 | ``` 28 | 29 | # Commands 30 | 31 | * [`paperback bundle`](#paperback-bundle) 32 | * [`paperback help [COMMAND]`](#paperback-help-command) 33 | * [`paperback serve`](#paperback-serve) 34 | 35 | ## `paperback bundle` 36 | 37 | ``` 38 | USAGE 39 | $ paperback bundle 40 | 41 | OPTIONS 42 | -h, --help show CLI help 43 | --folder=folder Subfolder to output to 44 | ``` 45 | 46 | _See code: [src/commands/bundle.ts](https://github.com/FaizanDurrani/paperback-cli/blob/v1.3.3/src/commands/bundle.ts)_ 47 | 48 | ## `paperback help [COMMAND]` 49 | 50 | ``` 51 | USAGE 52 | $ paperback help [COMMAND] 53 | 54 | ARGUMENTS 55 | COMMAND command to show help for 56 | 57 | OPTIONS 58 | --all see all commands in CLI 59 | ``` 60 | 61 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_ 62 | 63 | ## `paperback serve` 64 | 65 | ``` 66 | USAGE 67 | $ paperback serve 68 | 69 | OPTIONS 70 | -h, --help show CLI help 71 | -p, --port=port [default: 8080] 72 | ``` 73 | 74 | _See code: [src/commands/serve.ts](https://github.com/FaizanDurrani/paperback-cli/blob/v1.3.3/src/commands/serve.ts)_ 75 | 76 | -------------------------------------------------------------------------------- /bin/prepack-script: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | /* 4 | * This script file is intended for post compilation processing 5 | * It is run at the end of `prepack` command 6 | */ 7 | 8 | const fs = require('fs') 9 | 10 | // Copy website-generation files to the lib folder 11 | fs.mkdirSync('lib/website-generation') 12 | fs.copyFileSync('src/website-generation/homepage.pug', 'lib/website-generation/homepage.pug') 13 | -------------------------------------------------------------------------------- /bin/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | require('@oclif/command').run() 4 | .then(require('@oclif/command/flush')) 5 | .catch(require('@oclif/errors/handle')) 6 | -------------------------------------------------------------------------------- /bin/run.cmd: -------------------------------------------------------------------------------- 1 | @echo off 2 | 3 | node "%~dp0\run" %* 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "paperback-cli", 3 | "description": "Paperback CLI for common tools", 4 | "version": "1.4.0", 5 | "author": "Faizan Durrani", 6 | "bin": { 7 | "paperback": "bin/run" 8 | }, 9 | "bugs": { 10 | "url": "https://github.com/FaizanDurrani/paperback-cli/issues" 11 | }, 12 | "devDependencies": { 13 | "@oclif/dev-cli": "^1.24.1", 14 | "@oclif/test": "^1.2.7", 15 | "@types/browserify": "^12.0.36", 16 | "@types/chai": "^4.2.14", 17 | "@types/google-protobuf": "^3.15.5", 18 | "@types/ip": "^1.1.0", 19 | "@types/mocha": "^5.2.7", 20 | "@types/node": "^10.17.56", 21 | "@types/vinyl-source-stream": "^0.0.30", 22 | "chai": "^4.2.0", 23 | "eslint": "^5.16.0", 24 | "eslint-config-oclif": "^3.1.0", 25 | "eslint-config-oclif-typescript": "^0.1.0", 26 | "globby": "^10.0.2", 27 | "mocha": "^9.1.1", 28 | "nyc": "^14.1.1", 29 | "ts-node": "^8.10.2", 30 | "typescript": "^3.9.7" 31 | }, 32 | "engines": { 33 | "node": ">=10.0.0" 34 | }, 35 | "files": [ 36 | "/bin", 37 | "/lib", 38 | "/npm-shrinkwrap.json", 39 | "/oclif.manifest.json" 40 | ], 41 | "homepage": "https://github.com/FaizanDurrani/paperback-cli#readme", 42 | "keywords": [ 43 | "oclif" 44 | ], 45 | "license": "GPL-3.0", 46 | "main": "index.js", 47 | "oclif": { 48 | "commands": "./lib/commands", 49 | "bin": "paperback", 50 | "plugins": [ 51 | "@oclif/plugin-help" 52 | ] 53 | }, 54 | "repository": { 55 | "type": "git", 56 | "url": "https://github.com/FaizanDurrani/paperback-cli.git" 57 | }, 58 | "scripts": { 59 | "postpack": "rm -f oclif.manifest.json", 60 | "posttest": "eslint . --ext .ts --config .eslintrc", 61 | "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme && node ./bin/prepack-script", 62 | "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"", 63 | "version": "oclif-dev readme && git add README.md" 64 | }, 65 | "types": "lib/index.d.ts", 66 | "dependencies": { 67 | "@grpc/grpc-js": "^1.3.7", 68 | "@oclif/command": "^1.8.0", 69 | "@oclif/config": "^1.17.0", 70 | "@oclif/plugin-help": "^3.2.0", 71 | "@types/listr": "^0.14.2", 72 | "@types/shelljs": "^0.8.8", 73 | "@types/update-notifier": "^5.0.0", 74 | "browserify": "^17.0.0", 75 | "chalk": "^2.4.2", 76 | "cli-ux": "^5.5.1", 77 | "google-protobuf": "^3.18.0", 78 | "grpc_tools_node_protoc_ts": "^5.3.2", 79 | "grpc-tools": "^1.11.2", 80 | "ip": "^1.1.5", 81 | "listr": "^0.14.3", 82 | "pug": "^3.0.1", 83 | "shelljs": "^0.8.4", 84 | "tsify": "^5.0.2", 85 | "tslib": "^1.14.1", 86 | "update-notifier": "^5.0.1", 87 | "vinyl-source-stream": "^2.0.0" 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /src/command.ts: -------------------------------------------------------------------------------- 1 | /* eslint-disable no-console */ 2 | import Command from '@oclif/command' 3 | import Utils from './utils' 4 | 5 | export default abstract class extends Command { 6 | log(message = '') { 7 | Utils.log(message) 8 | } 9 | 10 | time(label: string, format: string | undefined = undefined) { 11 | return Utils.time(label, format) 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/commands/bundle.ts: -------------------------------------------------------------------------------- 1 | /* eslint-disable no-console */ 2 | import {flags} from '@oclif/command' 3 | import Command from '../command' 4 | import * as path from 'path' 5 | import * as fs from 'fs' 6 | 7 | import * as browserify from 'browserify' 8 | import * as shelljs from 'shelljs' 9 | import Utils from '../utils' 10 | 11 | import * as updateNotifier from 'update-notifier' 12 | const pkg = require('../../package.json') 13 | 14 | // Homepage generation requirement 15 | const pug = require('pug') 16 | 17 | export default class Bundle extends Command { 18 | static description = 19 | 'Builds all the sources in the repository and generates a versioning file'; 20 | 21 | static flags = { 22 | help: flags.help({char: 'h'}), 23 | folder: flags.string({description: 'Subfolder to output to', required: false}), 24 | }; 25 | 26 | async run() { 27 | updateNotifier({pkg, updateCheckInterval: 0}).notify() 28 | const {flags} = this.parse(Bundle) 29 | 30 | this.log(`Working directory: ${process.cwd()}`) 31 | this.log() 32 | 33 | const execTime = this.time('Execution time', Utils.headingFormat) 34 | await this.bundleSources(flags.folder) 35 | 36 | const versionTime = this.time('Versioning File', Utils.headingFormat) 37 | await this.generateVersioningFile(flags.folder) 38 | versionTime.end() 39 | this.log() 40 | 41 | const homepageTime = this.time('Homepage Generation', Utils.headingFormat) 42 | await this.generateHomepage(flags.folder) 43 | homepageTime.end() 44 | this.log() 45 | 46 | execTime.end() 47 | } 48 | 49 | async generateVersioningFile(folder = '') { 50 | const jsonObject = { 51 | buildTime: new Date(), 52 | sources: [] as any[], 53 | } 54 | 55 | // joining path of directory 56 | const basePath = process.cwd() 57 | const directoryPath = path.join(basePath, 'bundles', folder) 58 | 59 | const promises = fs.readdirSync(directoryPath).map(async file => { 60 | try { 61 | const time = this.time(`- Generating ${file} Info`) 62 | const sourceInfo = await this.generateSourceInfo(file, directoryPath) 63 | jsonObject.sources.push(sourceInfo) 64 | time.end() 65 | } catch (error) { 66 | this.log(`- ${file} ${error}`) 67 | } 68 | }) 69 | 70 | await Promise.all(promises) 71 | 72 | // Write the JSON payload to file 73 | fs.writeFileSync( 74 | path.join(directoryPath, 'versioning.json'), 75 | JSON.stringify(jsonObject) 76 | ) 77 | } 78 | 79 | async generateSourceInfo(sourceId: string, directoryPath: string) { 80 | // Files starting with . should be ignored (hidden) - Also ignore the tests directory 81 | if (sourceId.startsWith('.') || sourceId.startsWith('tests')) { 82 | return Promise.resolve() 83 | } 84 | 85 | // If its a directory 86 | if (!fs.statSync(path.join(directoryPath, sourceId)).isDirectory()) { 87 | this.log('not a Directory, skipping ' + sourceId) 88 | return Promise.resolve() 89 | } 90 | 91 | const finalPath = path.join(directoryPath, sourceId, 'source.js') 92 | 93 | return new Promise((res, rej) => { 94 | const req = require(finalPath) 95 | 96 | const classInstance = req[`${sourceId}Info`] 97 | 98 | // make sure the icon is present in the includes folder. 99 | if (!fs.existsSync(path.join(directoryPath, sourceId, 'includes', classInstance.icon))) { 100 | rej(new Error('[ERROR] [' + sourceId + '] Icon must be inside the includes folder')) 101 | return 102 | } 103 | 104 | res({ 105 | id: sourceId, 106 | name: classInstance.name, 107 | author: classInstance.author, 108 | desc: classInstance.description, 109 | website: classInstance.authorWebsite, 110 | contentRating: classInstance.contentRating, 111 | version: classInstance.version, 112 | icon: classInstance.icon, 113 | tags: classInstance.sourceTags, 114 | websiteBaseURL: classInstance.websiteBaseURL, 115 | }) 116 | }) 117 | } 118 | 119 | async bundleSources(folder = '') { 120 | const basePath = process.cwd() 121 | 122 | // Make sure there isn't a built folder already 123 | Utils.deleteFolderRecursive(path.join(basePath, 'temp_build')) 124 | 125 | const transpileTime = this.time('Transpiling project', Utils.headingFormat) 126 | shelljs.exec('npx tsc --outDir temp_build') 127 | transpileTime.end() 128 | 129 | this.log() 130 | 131 | const bundleTime = this.time('Bundle time', Utils.headingFormat) 132 | const baseBundlesPath = path.join(basePath, 'bundles') 133 | const bundlesPath = path.join(baseBundlesPath, folder) 134 | 135 | Utils.deleteFolderRecursive(bundlesPath) 136 | 137 | fs.mkdirSync(bundlesPath, {recursive: true}) 138 | 139 | const directoryPath = path.join(basePath, 'temp_build') 140 | const promises: Promise[] = fs.readdirSync(directoryPath).map(async file => { 141 | const fileBundleTime = this.time(`- Building ${file}`) 142 | 143 | Utils.copyFolderRecursive( 144 | path.join(basePath, 'src', file, 'external'), 145 | path.join(directoryPath, file) 146 | ) 147 | 148 | await this.bundle(file, directoryPath, bundlesPath) 149 | 150 | Utils.copyFolderRecursive( 151 | path.join(basePath, 'src', file, 'includes'), 152 | path.join(bundlesPath, file) 153 | ) 154 | fileBundleTime.end() 155 | }) 156 | 157 | await Promise.all(promises) 158 | 159 | bundleTime.end() 160 | 161 | this.log() 162 | // Remove the build folder 163 | Utils.deleteFolderRecursive(path.join(basePath, 'temp_build')) 164 | } 165 | 166 | async bundle(file: string, sourceDir: string, destDir: string) { 167 | if (file === 'tests') { 168 | this.log('Tests directory, skipping') 169 | return Promise.resolve() 170 | } 171 | 172 | // If its a directory 173 | if (!fs.statSync(path.join(sourceDir, file)).isDirectory()) { 174 | this.log('Not a directory, skipping ' + file) 175 | return Promise.resolve() 176 | } 177 | 178 | const filePath = path.join(sourceDir, file, `/${file}.js`) 179 | 180 | if (!fs.existsSync(filePath)) { 181 | this.log("The file doesn't exist, skipping. " + file) 182 | return Promise.resolve() 183 | } 184 | 185 | const outputPath = path.join(destDir, file) 186 | if (!fs.existsSync(outputPath)) { 187 | fs.mkdirSync(outputPath) 188 | } 189 | 190 | return new Promise(res => { 191 | browserify([filePath], {standalone: 'Sources'}) 192 | .ignore('./node_modules/paperback-extensions-common/dist/APIWrapper.js') 193 | .external(['axios', 'cheerio', 'fs']) 194 | .bundle() 195 | .pipe( 196 | fs.createWriteStream(path.join(outputPath, 'source.js')).on('finish', () => { 197 | res() 198 | }) 199 | ) 200 | }) 201 | } 202 | 203 | async generateHomepage(folder = '') { 204 | /* 205 | * Generate a homepage for the repository based on the package.json file and the generated versioning.json 206 | * 207 | * Following fields must be registered in package.json: 208 | * { 209 | * repositoryName: "The repository name" 210 | * description: "The repository description" 211 | * } 212 | * The following fields can be used: 213 | * { 214 | * noAddToPaperbackButton: A boolean used to not generate the AddToPaperback button 215 | * repositoryLogo: "Custom logo path or URL" 216 | * baseURL: "Custom base URL for the repository" 217 | * } 218 | * The default baseURL will be deducted form GITHUB_REPOSITORY environment variable. 219 | * 220 | * See website-generation/homepage.pug file for more information on the generated homepage 221 | */ 222 | 223 | // joining path of directory 224 | const basePath = process.cwd() 225 | const directoryPath = path.join(basePath, 'bundles', folder) 226 | const packageFilePath = path.join(basePath, 'package.json') 227 | // homepage.pug file is added to the package during the prepack process 228 | const pugFilePath = path.join(__dirname, '../website-generation/homepage.pug') 229 | const versioningFilePath = path.join(directoryPath, 'versioning.json') 230 | 231 | // The homepage should only be generated if a package.json file exist at the root of the repo 232 | if (fs.existsSync(packageFilePath)) { 233 | this.log('- Generating the repository homepage') 234 | 235 | // We need data from package.json and versioning.json created previously 236 | const packageData = JSON.parse(fs.readFileSync(packageFilePath, 'utf8')) 237 | const extensionsData = JSON.parse(fs.readFileSync(versioningFilePath, 'utf8')) 238 | 239 | // Creation of the list of available extensions 240 | // [{name: sourceName, tags[]: []}] 241 | const extensionList: { name: any; tags: any }[] = [] 242 | 243 | extensionsData.sources.forEach((extension: { name: any; tags: any }) => { 244 | extensionList.push( 245 | { 246 | name: extension.name, 247 | tags: extension.tags, 248 | } 249 | ) 250 | }) 251 | 252 | // To be used by homepage.pug file, repositoryData must by of the format: 253 | /* 254 | { 255 | repositoryName: "", 256 | repositoryDescription: "", 257 | baseURL: "https://yourlinkhere", 258 | sources: [{name: sourceName, tags[]: []}] 259 | 260 | repositoryLogo: "url", 261 | noAddToPaperbackButton: true, 262 | } 263 | */ 264 | const repositoryData: {[id: string]: unknown} = {} 265 | 266 | repositoryData.repositoryName = packageData.repositoryName 267 | repositoryData.repositoryDescription = packageData.description 268 | repositoryData.sources = extensionList 269 | 270 | // The repository can register a custom base URL. If not, this file will try to deduct one from GITHUB_REPOSITORY 271 | if (packageData.baseURL === undefined) { 272 | const github_repository_environment_variable = process.env.GITHUB_REPOSITORY 273 | if (github_repository_environment_variable === undefined) { 274 | // If it's not possible to determine the baseURL, using noAddToPaperbackButton will mask the field from the homepage 275 | // The repository can force noAddToPaperbackButton to false by adding the field to package.json 276 | this.log('Both GITHUB_REPOSITORY and baseURL are not defined, setting noAddToPaperbackButton to true') 277 | repositoryData.baseURL = 'undefined' 278 | repositoryData.noAddToPaperbackButton = true 279 | } else { 280 | const split = github_repository_environment_variable.toLowerCase().split('/') 281 | // The capitalization of folder is important, using folder.toLowerCase() make a non working link 282 | this.log(`Using base URL deducted from GITHUB_REPOSITORY environment variable: https://${split[0]}.github.io/${split[1]}${(folder === '') ? '' : '/' + folder}`) 283 | repositoryData.baseURL = `https://${split[0]}.github.io/${split[1]}${(folder === '') ? '' : '/' + folder}` 284 | } 285 | } else { 286 | this.log(`Using custom baseURL: ${packageData.baseURL}`) 287 | repositoryData.baseURL = packageData.baseURL 288 | } 289 | 290 | if (packageData.noAddToPaperbackButton !== undefined) { 291 | this.log('Using noAddToPaperbackButton parameter') 292 | repositoryData.noAddToPaperbackButton = packageData.noAddToPaperbackButton 293 | } 294 | if (packageData.repositoryLogo !== undefined) { 295 | this.log('Using repositoryLogo parameter') 296 | repositoryData.repositoryLogo = packageData.repositoryLogo 297 | } 298 | 299 | // Compilation of the pug file which is available in website-generation folder 300 | const htmlCode = pug.compileFile(pugFilePath)( 301 | repositoryData 302 | ) 303 | 304 | fs.writeFileSync( 305 | path.join(directoryPath, 'index.html'), 306 | htmlCode 307 | ) 308 | } 309 | } 310 | } 311 | -------------------------------------------------------------------------------- /src/commands/serve.ts: -------------------------------------------------------------------------------- 1 | import {flags} from '@oclif/command' 2 | import Command from '../command' 3 | import Bundle from './bundle' 4 | import Server from '../server' 5 | import cli from 'cli-ux' 6 | import Utils from '../utils' 7 | import chalk from 'chalk' 8 | 9 | export default class Serve extends Command { 10 | static description = 'Build the sources and start a local server' 11 | 12 | static flags = { 13 | help: flags.help({char: 'h'}), 14 | port: flags.integer({char: 'p', default: 8080}), 15 | } 16 | 17 | async run() { 18 | const {flags} = this.parse(Serve) 19 | 20 | // eslint-disable-next-line no-console 21 | console.clear() 22 | 23 | this.log(chalk.underline.blue('Building Sources')) 24 | 25 | // Make sure the repo is bundled 26 | await Bundle.run([]) 27 | this.log() 28 | this.log(chalk.underline.blue('Starting Server on port ' + flags.port)) 29 | 30 | const server = new Server(flags.port) 31 | 32 | server.start() 33 | this.log() 34 | this.log(chalk`For a list of commands do {green h} or {green help}`) 35 | 36 | let stopServer = false 37 | while (!stopServer) { 38 | // eslint-disable-next-line no-await-in-loop 39 | const input = (await cli.prompt(Utils.prefixTime(''), {required: false}) as string)?.trim() ?? '' 40 | 41 | if (input === 'h' || input === 'help') { 42 | this.log(chalk.underline.bold('Help')) 43 | this.log(' h, help - Display this message') 44 | this.log(' s, stop - Stop the server') 45 | this.log(' r, restart - Restart the server, also rebuilds the sources') 46 | } 47 | 48 | if (input === 's' || input === 'stop') { 49 | stopServer = true 50 | } 51 | 52 | if (input === 'r' || input === 'restart') { 53 | server.stop() 54 | 55 | // eslint-disable-next-line no-console 56 | console.clear() 57 | 58 | this.log(chalk.underline.blue('Building Sources')) 59 | 60 | // Make sure the repo is bundled 61 | // eslint-disable-next-line no-await-in-loop 62 | await Bundle.run() 63 | this.log() 64 | this.log(chalk.underline.blue('Starting Server on port ' + flags.port)) 65 | 66 | server.start() 67 | this.log() 68 | this.log(chalk`For a list of commands do {green h} or {green help}`) 69 | } 70 | } 71 | 72 | // eslint-disable-next-line no-process-exit, unicorn/no-process-exit 73 | process.exit(0) 74 | } 75 | } 76 | '\b\u00127' 77 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export {run} from '@oclif/command' 2 | -------------------------------------------------------------------------------- /src/server.ts: -------------------------------------------------------------------------------- 1 | import * as http from 'http' 2 | import * as fs from 'fs' 3 | import * as path from 'path' 4 | import * as ip from 'ip' 5 | import Utils from './utils' 6 | import chalk from 'chalk' 7 | 8 | export default class Server { 9 | server?: http.Server 10 | 11 | port: number 12 | 13 | constructor(port: number) { 14 | this.port = port 15 | } 16 | 17 | start() { 18 | if (this.server) { 19 | Utils.error('Server already running') 20 | return 21 | } 22 | 23 | this.server = http.createServer(function (request, response) { 24 | Utils.log(`Request ${request.url}`) 25 | 26 | let filePath = './bundles' + request.url 27 | if (filePath === './') { 28 | filePath = './index.html' 29 | } 30 | 31 | const extname = String(path.extname(filePath)).toLowerCase() 32 | const mimeTypes: any = { 33 | '.html': 'text/html', 34 | '.js': 'text/javascript', 35 | '.css': 'text/css', 36 | '.json': 'application/json', 37 | '.png': 'image/png', 38 | '.jpg': 'image/jpg', 39 | '.gif': 'image/gif', 40 | '.svg': 'image/svg+xml', 41 | '.wav': 'audio/wav', 42 | '.mp4': 'video/mp4', 43 | '.woff': 'application/font-woff', 44 | '.ttf': 'application/font-ttf', 45 | '.eot': 'application/vnd.ms-fontobject', 46 | '.otf': 'application/font-otf', 47 | '.wasm': 'application/wasm', 48 | } 49 | 50 | const contentType = mimeTypes[extname] || 'application/octet-stream' 51 | 52 | fs.readFile(filePath, function (error, content) { 53 | if (error) { 54 | if (error.code === 'ENOENT') { 55 | response.writeHead(404) 56 | response.end('Page not found: ' + error.code + ' ..\n') 57 | } else { 58 | response.writeHead(500) 59 | response.end('Sorry, check with the site admin for error: ' + error.code + ' ..\n') 60 | } 61 | } else { 62 | response.writeHead(200, {'Content-Type': contentType}) 63 | response.end(content, 'utf-8') 64 | } 65 | }) 66 | }).listen(this.port) 67 | 68 | Utils.log(`Server running at ${chalk.green(`http://127.0.0.1:${this.port}/versioning.json`)}`) 69 | Utils.log(`Server running at ${chalk.green(`http://${ip.address()}:${this.port}/versioning.json`)}`) 70 | } 71 | 72 | stop() { 73 | if (this.server === undefined) { 74 | Utils.error('Server not running') 75 | return 76 | } 77 | 78 | this.server?.close() 79 | this.server = undefined 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /src/utils.ts: -------------------------------------------------------------------------------- 1 | import * as fs from 'fs' 2 | import * as path from 'path' 3 | import chalk from 'chalk' 4 | 5 | export default class Utils { 6 | static fixedWidth(number: number, width: number) { 7 | return (new Array(width).join('0') + number).substr(-width) 8 | } 9 | 10 | static prefixTime(message = '') { 11 | const date = new Date() 12 | 13 | const time = `${this.fixedWidth(date.getHours(), 2)}:${Utils.fixedWidth(date.getMinutes(), 2)}:${Utils.fixedWidth(date.getSeconds(), 2)}:${Utils.fixedWidth(date.getMilliseconds(), 4)}` 14 | return chalk`[{gray ${time}}] ${message}` 15 | } 16 | 17 | static log(message = '') { 18 | const cursorTo = (process.stdout as any).cursorTo 19 | if (cursorTo) { 20 | cursorTo(0) 21 | } 22 | process.stdout.write(this.prefixTime(message) + '\n') 23 | } 24 | 25 | static error(message = '') { 26 | this.log(chalk`{red ${message}}`) 27 | } 28 | 29 | static time(label: string, template = '$1') { 30 | const startTime = process.hrtime.bigint() 31 | 32 | return { 33 | end: () => { 34 | const hrend = process.hrtime.bigint() - startTime 35 | // eslint-disable-next-line new-cap 36 | this.log(`${template.replace('$1', label)}: ${chalk.green((hrend / BigInt(1000000)) + 'ms')}`) 37 | }, 38 | } 39 | } 40 | 41 | static headingFormat = chalk`{bold {red #} $1}` 42 | 43 | static deleteFolderRecursive(folderPath: string) { 44 | folderPath = folderPath.trim() 45 | if (folderPath.length === 0 || folderPath === '/') return 46 | 47 | if (fs.existsSync(folderPath)) { 48 | fs.readdirSync(folderPath).forEach(file => { 49 | const curPath = path.join(folderPath, file) 50 | if (fs.lstatSync(curPath).isDirectory()) { // recurse 51 | this.deleteFolderRecursive(curPath) 52 | } else { // delete file 53 | fs.unlinkSync(curPath) 54 | } 55 | }) 56 | fs.rmdirSync(folderPath) 57 | } 58 | } 59 | 60 | static copyFolderRecursive(source: string, target: string) { 61 | source = source.trim() 62 | if (source.length === 0 || source === '/') return 63 | 64 | target = target.trim() 65 | if (target.length === 0 || target === '/') return 66 | 67 | if (!fs.existsSync(source)) return 68 | 69 | let files = [] 70 | // check if folder needs to be created or integrated 71 | const targetFolder = path.join(target, path.basename(source)) 72 | if (!fs.existsSync(targetFolder)) { 73 | fs.mkdirSync(targetFolder) 74 | } 75 | 76 | // copy 77 | if (fs.lstatSync(source).isDirectory()) { 78 | files = fs.readdirSync(source) 79 | files.forEach(file => { 80 | const curSource = path.join(source, file) 81 | if (fs.lstatSync(curSource).isDirectory()) { 82 | this.copyFolderRecursive(curSource, targetFolder) 83 | } else { 84 | fs.copyFileSync(curSource, path.join(targetFolder, file)) 85 | } 86 | }) 87 | } 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /src/website-generation/homepage.pug: -------------------------------------------------------------------------------- 1 | //- 2 | This file generates a homepage for the extensions repository. 3 | It is intended to be processed by the gulp file of the repository. 4 | 5 | It needs the following variables: 6 | { 7 | "repositoryName": "Comic Repo", 8 | "repositoryDescription": "Some description here", 9 | "baseURL": "https://yourlinkhere", 10 | "sources": [{name: sourceName, tags[]: []}] 11 | } 12 | 13 | Two optional variables can be provided: 14 | { 15 | "repositoryLogo": "https://paperback.moe/icons/logo-alt.svg", 16 | "noAddToPaperbackButton": true, 17 | } 18 | 19 | The page contains a noindex meta tag. 20 | 21 | Can be tested with `pug -O ComicData.json -w . -o ./html -P` 22 | where ComicData.json contains information listed previously 23 | 24 | - var extensionsList = sources 25 | unless repositoryLogo 26 | //- 27 | If a custom repository logo was not defined, use Paperback default one. 28 | This will allow to update the default logo on all repositories easily 29 | - repositoryLogo = "https://paperback.moe/icons/logo-alt.svg" 30 | 31 | doctype html 32 | html(lang='en') 33 | head 34 | meta(name="robots" content="noindex") 35 | meta(charset="utf-8") 36 | link(rel="icon" href=repositoryLogo) 37 | title= repositoryName 38 | body 39 | header 40 | img(src=repositoryLogo, alt="Repository logo").icon 41 | h1= repositoryName 42 | p.pageDescription A Paperback extensions repository 43 | //- If the repository don't prevent its installation, render an "Add to Paperback" button 44 | unless noAddToPaperbackButton 45 | //- Generate the escaped URL allowing the app to install the repository 46 | a.addToPaperbackButton(href="paperback://addRepo?displayName=" + encodeURIComponent(repositoryName) + "&url=" + encodeURIComponent(baseURL)) Add to Paperback 47 | div.content 48 | p#repositoryDescription= repositoryDescription 49 | blockquote 50 | p A guide is available to learn everything about extensions repositories. 51 | p Check it here to learn how to add and use this repository in Paperback. 52 | //- If the repository don't prevent its installation, render help information and base URL component 53 | unless noAddToPaperbackButton 54 | blockquote 55 | p 56 | span On a Paperback installed device, press 57 | //- Generate the escaped URL allowing the app to install the repository 58 | a(href="paperback://addRepo?displayName=" + encodeURIComponent(repositoryName) + "&url=" + encodeURIComponent(baseURL)) Add to Paperback 59 | span or use the base URL to add this repository to the app. 60 | div.baseUrl 61 | p.title Base URL: 62 | p= baseURL 63 | dev.availableSources 64 | p.title Available Sources: 65 | div#listDiv 66 | ul 67 | each extension in extensionsList 68 | li 69 | //- Remove intext tags like (Country-Proof) 70 | = extension.name.replace(/[[|(][^(|[]+[\]|)]/g, "").trim() 71 | //- Add the source tags 72 | if extension.tags 73 | each tag in extension.tags 74 | span(class="el-tag el-tag--dark el-tag--mini el-tag--" + tag.type)= tag.text 75 | 76 | 77 | style. 78 | body 79 | { 80 | font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif; 81 | -moz-osx-font-smoothing: grayscale; 82 | color: #2c3e50; 83 | padding: 3.6rem 2rem 1.5rem; 84 | text-align: center; 85 | } 86 | .title 87 | { 88 | font-weight: 700; 89 | margin-bottom: 8px; 90 | } 91 | 92 | 93 | /* Header section */ 94 | .icon 95 | { 96 | max-height: 8rem; 97 | } 98 | h1 99 | { 100 | font-size: 1.7rem; 101 | margin: 1rem auto; 102 | } 103 | .pageDescription 104 | { 105 | max-width: 35rem; 106 | font-size: 1.3rem; 107 | line-height: 1.3; 108 | color: #6a8bad; 109 | margin: 1rem auto; 110 | } 111 | .addToPaperbackButton 112 | { 113 | display: inline-block; 114 | width: 10rem; 115 | line-height: 1.7; 116 | margin: .25rem; 117 | padding: .4rem; 118 | color: #fff; 119 | background-color: #2e84bf; 120 | border-bottom: 1px solid #2977ac; 121 | border-radius: 4px; 122 | transition: background-color .1s ease; 123 | } 124 | .addToPaperbackButton:hover 125 | { 126 | background-color: #3992cf; 127 | text-decoration: none; 128 | } 129 | 130 | 131 | /* Content section */ 132 | .content 133 | { 134 | margin: auto; 135 | max-width: 920px; 136 | text-align: left; 137 | } 138 | 139 | 140 | /* Blockquote section */ 141 | blockquote 142 | { 143 | font-size: 0.9rem; 144 | color: #999; 145 | border-left: .2rem solid #dfe2e5; 146 | margin: 1rem 0; 147 | padding: .25rem 0 .25rem 1rem; 148 | line-height: 1.6; 149 | } 150 | blockquote p 151 | { 152 | margin-top: 2px; 153 | margin-bottom: 2px; 154 | } 155 | /* Link */ 156 | a:hover { 157 | text-decoration: underline; 158 | } 159 | a { 160 | font-weight: 500; 161 | text-decoration: none; 162 | color: #2196f3; 163 | } 164 | 165 | 166 | /* Base URL section */ 167 | .baseUrl 168 | { 169 | background-color: #f0f4f8; 170 | border-radius: .4rem; 171 | padding: .1rem .1rem; 172 | } 173 | .baseUrl .title 174 | { 175 | font-weight: 700; 176 | } 177 | .baseUrl p 178 | { 179 | margin-left: 16px; 180 | } 181 | 182 | 183 | /* Available sources section */ 184 | ul 185 | { 186 | margin-top: 0px; 187 | } 188 | .el-tag { 189 | margin-left: 2px; 190 | margin-right: 2px; 191 | } 192 | #listDiv { 193 | line-height: 1.5; 194 | } 195 | 196 | 197 | /* Tags style */ 198 | /* 199 | * These styles are based on Element tags to match the website 200 | * https://element.eleme.io/#/en-US/component/tag 201 | */ 202 | .el-tag { 203 | margin-left: 4px; 204 | } 205 | .el-tag { 206 | background-color: #ecf5ff; 207 | display: inline-block; 208 | height: 32px; 209 | padding: 0 10px; 210 | line-height: 30px; 211 | font-size: 12px; 212 | color: #409eff; 213 | border: 1px solid #d9ecff; 214 | border-top-color: rgb(217, 236, 255); 215 | border-right-color: rgb(217, 236, 255); 216 | border-bottom-color: rgb(217, 236, 255); 217 | border-left-color: rgb(217, 236, 255); 218 | border-radius: 4px; 219 | box-sizing: border-box; 220 | white-space: nowrap; 221 | } 222 | .el-tag--dark, .el-tag--dark.is-hit { 223 | border-color: #409eff; 224 | } 225 | .el-tag--dark { 226 | background-color: #409eff; 227 | color: #fff; 228 | } 229 | .el-tag--mini { 230 | height: 20px; 231 | padding: 0 5px; 232 | line-height: 19px; 233 | } 234 | /* Tags types */ 235 | .el-tag--dark.el-tag--success { 236 | background-color: #67c23a; 237 | border-color: #67c23a; 238 | color: #fff; 239 | } 240 | .el-tag--dark.el-tag--info { 241 | background-color: #909399; 242 | border-color: #909399; 243 | color: #fff; 244 | } 245 | .el-tag--dark.el-tag--danger { 246 | background-color: #f56c6c; 247 | border-color: #f56c6c; 248 | color: #fff; 249 | } 250 | .el-tag--dark.el-tag--warning { 251 | background-color: #e6a23c; 252 | border-color: #e6a23c; 253 | color: #fff; 254 | } 255 | -------------------------------------------------------------------------------- /test/commands/bundle.test.ts: -------------------------------------------------------------------------------- 1 | import {expect, test} from '@oclif/test' 2 | 3 | describe('bundle', () => { 4 | test 5 | .stdout() 6 | .command(['bundle']) 7 | .it('runs hello', ctx => { 8 | expect(ctx.stdout).to.contain('hello world') 9 | }) 10 | 11 | test 12 | .stdout() 13 | .command(['bundle', '--name', 'jeff']) 14 | .it('runs hello --name jeff', ctx => { 15 | expect(ctx.stdout).to.contain('hello jeff') 16 | }) 17 | }) 18 | -------------------------------------------------------------------------------- /test/commands/hello.test.ts: -------------------------------------------------------------------------------- 1 | import {expect, test} from '@oclif/test' 2 | 3 | describe('hello', () => { 4 | test 5 | .stdout() 6 | .command(['hello']) 7 | .it('runs hello', ctx => { 8 | expect(ctx.stdout).to.contain('hello world') 9 | }) 10 | 11 | test 12 | .stdout() 13 | .command(['hello', '--name', 'jeff']) 14 | .it('runs hello --name jeff', ctx => { 15 | expect(ctx.stdout).to.contain('hello jeff') 16 | }) 17 | }) 18 | -------------------------------------------------------------------------------- /test/commands/serve.test.ts: -------------------------------------------------------------------------------- 1 | import {expect, test} from '@oclif/test' 2 | 3 | describe('serve', () => { 4 | test 5 | .stdout() 6 | .command(['serve']) 7 | .it('runs hello', ctx => { 8 | expect(ctx.stdout).to.contain('hello world') 9 | }) 10 | 11 | test 12 | .stdout() 13 | .command(['serve', '--name', 'jeff']) 14 | .it('runs hello --name jeff', ctx => { 15 | expect(ctx.stdout).to.contain('hello jeff') 16 | }) 17 | }) 18 | -------------------------------------------------------------------------------- /test/mocha.opts: -------------------------------------------------------------------------------- 1 | --require ts-node/register 2 | --watch-extensions ts 3 | --recursive 4 | --reporter spec 5 | --timeout 5000 6 | -------------------------------------------------------------------------------- /test/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tsconfig", 3 | "compilerOptions": { 4 | "noEmit": true 5 | }, 6 | "references": [ 7 | {"path": ".."} 8 | ] 9 | } 10 | -------------------------------------------------------------------------------- /tsconfig.build.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "tsconfig.json", 3 | "exclude": [ 4 | "src/tests/*" 5 | ] 6 | } -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "declaration": true, 4 | "importHelpers": true, 5 | "module": "commonjs", 6 | "outDir": "lib", 7 | "rootDir": "src", 8 | "strict": true, 9 | "target": "es2017" 10 | }, 11 | "include": [ 12 | "src/**/*" 13 | ], 14 | "exclude": [ 15 | "node_modules" 16 | ] 17 | } 18 | --------------------------------------------------------------------------------