├── .gitattributes ├── .github ├── FUNDING.yml └── workflows │ ├── cachix.yml │ └── docs.yml ├── .gitignore ├── LICENSE ├── README.md ├── cmd ├── bundle.go ├── init.go ├── inspect.go ├── list.go ├── quit.go ├── request.go ├── root.go ├── run.go ├── toggle.go └── types.go ├── data ├── env.d.ts ├── gitignore ├── gtk3 │ ├── Bar.tsx │ └── app.ts ├── gtk4 │ ├── Bar.tsx │ └── app.ts ├── package.json ├── style.scss └── tsconfig.json ├── docs ├── .gitignore ├── .vitepress │ ├── config.ts │ └── theme │ │ └── index.ts ├── guide │ ├── astal-cli.md │ ├── bundling.md │ ├── example.md │ ├── init.md │ ├── install.md │ ├── migrate.md │ ├── nix.md │ ├── quick-start.md │ └── types.md ├── index.md ├── package-lock.json ├── package.json ├── vitepress.config.ts └── vitepress.theme.css ├── flake.lock ├── flake.nix ├── go.mod ├── go.sum ├── lib ├── array.go ├── astal.go ├── esbuild.go ├── os.go └── tsconfig.go ├── main.go ├── nix ├── bundle.nix ├── default.nix ├── hm-module.nix └── template │ └── flake.nix └── version /.gitattributes: -------------------------------------------------------------------------------- 1 | data/**/* linguist-vendored 2 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: aylur 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /.github/workflows/cachix.yml: -------------------------------------------------------------------------------- 1 | name: Binary Cache 2 | 3 | on: [push, pull_request, workflow_dispatch] 4 | jobs: 5 | nix: 6 | name: "Build" 7 | runs-on: ubuntu-latest 8 | steps: 9 | - name: Checkout 10 | uses: actions/checkout@v4 11 | with: 12 | submodules: recursive 13 | 14 | - uses: cachix/install-nix-action@v25 15 | - uses: DeterminateSystems/magic-nix-cache-action@main 16 | - uses: cachix/cachix-action@v12 17 | with: 18 | name: ags 19 | authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}" 20 | 21 | - name: Build ags 22 | run: | 23 | nix build --print-build-logs 24 | -------------------------------------------------------------------------------- /.github/workflows/docs.yml: -------------------------------------------------------------------------------- 1 | name: Deploy VitePress site 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | 7 | permissions: 8 | contents: read 9 | pages: write 10 | id-token: write 11 | 12 | jobs: 13 | build: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout 17 | uses: actions/checkout@v4 18 | with: 19 | fetch-depth: 0 # Not needed if lastUpdated is not enabled 20 | 21 | - name: Setup Node 22 | uses: actions/setup-node@v4 23 | with: 24 | node-version: 20 25 | 26 | - name: Setup Pages 27 | uses: actions/configure-pages@v4 28 | 29 | - name: Install dependencies 30 | run: npm ci 31 | working-directory: docs 32 | 33 | - name: Build with VitePress 34 | run: npm run build 35 | working-directory: docs 36 | 37 | - name: Upload artifact 38 | uses: actions/upload-pages-artifact@v3 39 | with: 40 | path: docs/dist 41 | 42 | deploy: 43 | environment: 44 | name: github-pages 45 | url: ${{ steps.deployment.outputs.page_url }} 46 | needs: build 47 | runs-on: ubuntu-latest 48 | name: Deploy 49 | steps: 50 | - name: Deploy to GitHub Pages 51 | id: deployment 52 | uses: actions/deploy-pages@v4 53 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | build/ 3 | dist/ 4 | result/ 5 | @girs/ 6 | -------------------------------------------------------------------------------- /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 | # AGS 2 | 3 | CLI around [Astal](https://github.com/aylur/astal) to scaffold and run projects. 4 | Astal is a set of libraries written in Vala/C that makes writing a Desktop Shell easy. 5 | It also has an accompanying JavaScript library which lets you write Desktop Shells in JSX running on GJS. 6 | GJS is a JavaScript runtime built on Firefox's SpiderMonkey JavaScript engine and the GNOME platform libraries, the same runtime [GNOME Shell](https://gitlab.gnome.org/GNOME/gnome-shell) runs on. 7 | 8 | ## Get started 9 | 10 | To get started read the [wiki](https://aylur.github.io/ags). 11 | 12 | > [!NOTE] 13 | > Wiki of the legacy v1 is still available on [aylur.github.io/ags-docs/](https://aylur.github.io/ags-docs/). 14 | -------------------------------------------------------------------------------- /cmd/bundle.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | "os" 6 | "path/filepath" 7 | 8 | "github.com/spf13/cobra" 9 | ) 10 | 11 | var ( 12 | defines []string 13 | usePackage bool 14 | gtkVersion int 15 | workingDir string 16 | ) 17 | 18 | var bundleCommand = &cobra.Command{ 19 | Use: "bundle [entryfile] [outfile]", 20 | Short: "Bundle an app", 21 | Example: ` bundle app.ts my-shell -d "DATADIR='/usr/share/my-shell'"`, 22 | Args: cobra.ExactArgs(2), 23 | Run: func(cmd *cobra.Command, args []string) { 24 | path, err := filepath.Abs(args[0]) 25 | if err != nil { 26 | lib.Err(err) 27 | } 28 | 29 | outfile, err := filepath.Abs(args[1]) 30 | if err != nil { 31 | lib.Err(err) 32 | } 33 | 34 | info, err := os.Stat(path) 35 | if err != nil { 36 | lib.Err(err) 37 | } 38 | 39 | opts := lib.BundleOpts{ 40 | Outfile: outfile, 41 | UsePackage: usePackage, 42 | Defines: defines, 43 | GtkVersion: gtkVersion, 44 | WorkingDirectory: workingDir, 45 | } 46 | 47 | if info.IsDir() { 48 | opts.Infile = getAppEntry(path) 49 | } else { 50 | opts.Infile = path 51 | } 52 | 53 | lib.Bundle(opts) 54 | }, 55 | } 56 | 57 | func init() { 58 | f := bundleCommand.Flags() 59 | f.StringVarP(&workingDir, "root", "r", "", "root directory of the project") 60 | f.StringArrayVarP(&defines, "define", "d", []string{}, "replace global identifiers with constant expressions") 61 | f.BoolVarP(&usePackage, "package", "p", false, "use astal package as defined in package.json") 62 | f.IntVar(>kVersion, "gtk", 3, "gtk version") 63 | f.MarkHidden("gtk") 64 | } 65 | -------------------------------------------------------------------------------- /cmd/init.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | "fmt" 6 | "os" 7 | "path/filepath" 8 | "strings" 9 | 10 | "github.com/spf13/cobra" 11 | ) 12 | 13 | var ( 14 | force bool 15 | initDirectory string 16 | ) 17 | 18 | var initCommand = &cobra.Command{ 19 | Use: "init", 20 | Short: "Initialize a project directory", 21 | Long: `Initialize a project directory by setting up files needed by TypeScript, 22 | generating types and setting up a basic bar example`, 23 | Args: cobra.NoArgs, 24 | Run: initConfig, 25 | } 26 | 27 | func init() { 28 | f := initCommand.Flags() 29 | 30 | f.IntVarP(>kVersion, "gtk", "g", 3, "gtk version to use") 31 | f.BoolVarP(&force, "force", "f", false, "override existing files") 32 | f.StringVarP(&initDirectory, "directory", "d", defaultConfigDir(), "target directory") 33 | } 34 | 35 | func getDataFile(name string) string { 36 | content, err := data.ReadFile("data/" + name) 37 | if err != nil { 38 | lib.Err(err) 39 | } 40 | return string(content) 41 | } 42 | 43 | // TODO: interactive init, to ask for 44 | // project dir 45 | // project name 46 | // gtk version 47 | // eslint 48 | // prettier or eslint stylistic 49 | func initConfig(cmd *cobra.Command, args []string) { 50 | gtk := "gtk3" 51 | if gtkVersion == 4 { 52 | gtk = "gtk4" 53 | } 54 | 55 | initDir, err := filepath.Abs(initDirectory) 56 | if err != nil { 57 | lib.Err(err) 58 | } 59 | if info, err := os.Stat(initDir); err == nil && info.IsDir() && !force { 60 | lib.Err("could not initialize: " + lib.Cyan(initDir) + " already exists") 61 | } 62 | 63 | tsconf := strings.ReplaceAll(getDataFile("tsconfig.json"), "@ASTAL_GJS@", astalGjs) 64 | tsconf = strings.ReplaceAll(tsconf, "@GTK_VERSION@", gtk) 65 | pkgjson := strings.ReplaceAll(getDataFile("package.json"), "@ASTAL_GJS@", astalGjs) 66 | 67 | lib.Mkdir(initDir + "/widget") 68 | lib.Mkdir(initDir + "/node_modules") 69 | 70 | lib.WriteFile(initDir+"/.gitignore", getDataFile("gitignore")) 71 | lib.WriteFile(initDir+"/tsconfig.json", tsconf) 72 | lib.WriteFile(initDir+"/package.json", pkgjson) 73 | lib.WriteFile(initDir+"/env.d.ts", getDataFile("env.d.ts")) 74 | lib.WriteFile(initDir+"/style.scss", getDataFile("style.scss")) 75 | lib.WriteFile(initDir+"/widget/Bar.tsx", getDataFile(gtk+"/Bar.tsx")) 76 | lib.WriteFile(initDir+"/app.ts", getDataFile(gtk+"/app.ts")) 77 | lib.Ln(astalGjs, initDir+"/node_modules/astal") 78 | 79 | genTypes(initDir, "*", false) 80 | fmt.Println(lib.Green("project ready") + " at " + lib.Cyan(initDir)) 81 | } 82 | -------------------------------------------------------------------------------- /cmd/inspect.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | 6 | "github.com/spf13/cobra" 7 | ) 8 | 9 | var inspectCommand = &cobra.Command{ 10 | Use: "inspect", 11 | Short: "Open up Gtk debug tool", 12 | Args: cobra.NoArgs, 13 | Run: func(cmd *cobra.Command, args []string) { 14 | instance, _ := cmd.Flags().GetString("instance") 15 | lib.Astal("--instance", instance, "--inspector") 16 | }, 17 | } 18 | 19 | func init() { 20 | lib.AddInstanceFlag(inspectCommand) 21 | } 22 | -------------------------------------------------------------------------------- /cmd/list.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | 6 | "github.com/spf13/cobra" 7 | ) 8 | 9 | var listCommand = &cobra.Command{ 10 | Use: "list", 11 | Short: "List running instances", 12 | Args: cobra.NoArgs, 13 | Run: func(cmd *cobra.Command, args []string) { 14 | lib.Astal("--list") 15 | }, 16 | } 17 | -------------------------------------------------------------------------------- /cmd/quit.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | 6 | "github.com/spf13/cobra" 7 | ) 8 | 9 | var quitCommand = &cobra.Command{ 10 | Use: "quit", 11 | Short: "Quit an instances", 12 | Args: cobra.NoArgs, 13 | Run: func(cmd *cobra.Command, args []string) { 14 | instance, _ := cmd.Flags().GetString("instance") 15 | lib.Astal("--quit", "--instance", instance) 16 | }, 17 | } 18 | 19 | func init() { 20 | lib.AddInstanceFlag(quitCommand) 21 | } 22 | -------------------------------------------------------------------------------- /cmd/request.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | 6 | "github.com/spf13/cobra" 7 | ) 8 | 9 | var reqCommand = &cobra.Command{ 10 | Use: "request [message]", 11 | Short: "Send a request to an instance", 12 | Args: cobra.ExactArgs(1), 13 | Run: func(cmd *cobra.Command, args []string) { 14 | instance, _ := cmd.Flags().GetString("instance") 15 | lib.Astal("--instance", instance, args[0]) 16 | }, 17 | } 18 | 19 | func init() { 20 | lib.AddInstanceFlag(reqCommand) 21 | } 22 | -------------------------------------------------------------------------------- /cmd/root.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "embed" 5 | "os" 6 | "path/filepath" 7 | 8 | "github.com/spf13/cobra" 9 | ) 10 | 11 | var ( 12 | version string 13 | data embed.FS 14 | gtk4LayerShell string 15 | astalGjs string 16 | tsForGir string 17 | ) 18 | 19 | var rootCmd = &cobra.Command{ 20 | Use: "ags", 21 | Short: "Scaffolding CLI tool for Astal+TypeScript projects.", 22 | Args: cobra.NoArgs, 23 | } 24 | 25 | type Variables struct { 26 | Version string 27 | Data embed.FS 28 | Gtk4LayerShell string 29 | AstalGjs string 30 | TsForGir string 31 | } 32 | 33 | func Initialize(vars Variables) { 34 | version = vars.Version 35 | data = vars.Data 36 | gtk4LayerShell = vars.Gtk4LayerShell 37 | astalGjs = vars.AstalGjs 38 | tsForGir = vars.TsForGir 39 | 40 | rootCmd.Version = version 41 | } 42 | 43 | func init() { 44 | rootCmd.CompletionOptions.HiddenDefaultCmd = true 45 | cobra.EnableCommandSorting = false 46 | 47 | rootCmd.AddCommand(runCommand) 48 | rootCmd.AddCommand(reqCommand) 49 | rootCmd.AddCommand(listCommand) 50 | rootCmd.AddCommand(inspectCommand) 51 | rootCmd.AddCommand(toggleCommand) 52 | rootCmd.AddCommand(quitCommand) 53 | rootCmd.AddCommand(typesCommand) 54 | rootCmd.AddCommand(bundleCommand) 55 | rootCmd.AddCommand(initCommand) 56 | } 57 | 58 | func Execute() { 59 | err := rootCmd.Execute() 60 | if err != nil { 61 | os.Exit(1) 62 | } 63 | 64 | help, _ := rootCmd.Flags().GetBool("help") 65 | ver, _ := rootCmd.Flags().GetBool("version") 66 | 67 | if help || ver { 68 | os.Exit(0) 69 | } 70 | } 71 | 72 | func defaultConfigDir() string { 73 | dotconf, _ := os.UserConfigDir() 74 | return filepath.Join(dotconf, "ags") 75 | } 76 | -------------------------------------------------------------------------------- /cmd/run.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | "fmt" 6 | "io" 7 | "os" 8 | "path/filepath" 9 | 10 | "github.com/spf13/cobra" 11 | ) 12 | 13 | var ( 14 | gtk4 bool 15 | targetDir string 16 | logFile string 17 | args []string 18 | ) 19 | 20 | var runCommand = &cobra.Command{ 21 | Use: "run [file]", 22 | Short: "Run an app", 23 | Example: " run app.ts --define DEBUG=true", 24 | Args: cobra.ArbitraryArgs, 25 | Run: func(cmd *cobra.Command, args []string) { 26 | if len(args) > 0 { 27 | path, err := filepath.Abs(args[0]) 28 | if err != nil { 29 | lib.Err(err) 30 | } 31 | 32 | info, err := os.Stat(path) 33 | if err != nil { 34 | lib.Err(err) 35 | } 36 | 37 | if info.IsDir() { 38 | run(getAppEntry(path), "") 39 | } else { 40 | run(path, "") 41 | } 42 | 43 | } else { 44 | run(getAppEntry(targetDir), targetDir) 45 | } 46 | }, 47 | } 48 | 49 | func init() { 50 | f := runCommand.Flags() 51 | f.BoolVar(>k4, "gtk4", false, "preload Gtk4LayerShell") 52 | f.StringVarP(&targetDir, "directory", "d", defaultConfigDir(), 53 | `directory to search for an "app" entry file 54 | when no positional argument is given 55 | `+"\b") 56 | 57 | f.StringSliceVar(&defines, "define", []string{}, "replace global identifiers with constant expressions") 58 | f.StringArrayVarP(&args, "arg", "a", []string{}, "cli args to pass to gjs") 59 | f.StringVar(&logFile, "log-file", "", "file to redirect the stdout of gjs to") 60 | f.BoolVarP(&usePackage, "package", "p", false, "use astal package as defined in package.json") 61 | f.MarkHidden("package") 62 | } 63 | 64 | func getOutfile() string { 65 | rundir, found := os.LookupEnv("XDG_RUNTIME_DIR") 66 | 67 | if !found { 68 | rundir = "/tmp" 69 | } 70 | 71 | return filepath.Join(rundir, "ags.js") 72 | } 73 | 74 | func getAppEntry(dir string) string { 75 | path, err := filepath.Abs(dir) 76 | if err != nil { 77 | lib.Err(err) 78 | } 79 | 80 | infile := filepath.Join(path, "app") 81 | valid := []string{"js", "ts", "jsx", "tsx"} 82 | 83 | app := lib.Some(valid, func(ext string) bool { 84 | _, err := os.Stat(infile + "." + ext) 85 | return !os.IsNotExist(err) 86 | }) 87 | 88 | if !app { 89 | msg := "no such file or directory: " + 90 | fmt.Sprintf("\"%s\"\n", lib.Cyan(dir+"/app")) + 91 | lib.Magenta("tip: ") + "valid names are: " 92 | for _, v := range valid { 93 | msg = msg + fmt.Sprintf(` "%s"`, lib.Cyan("app."+v)) 94 | } 95 | lib.Err(msg) 96 | } 97 | 98 | return infile 99 | } 100 | 101 | func logging() (io.Writer, io.Writer, *os.File) { 102 | if logFile == "" { 103 | return os.Stdout, os.Stderr, nil 104 | } 105 | 106 | lib.Mkdir(filepath.Dir(logFile)) 107 | file, err := os.OpenFile(logFile, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644) 108 | if err != nil { 109 | lib.Err(err) 110 | } 111 | 112 | return io.MultiWriter(os.Stdout, file), io.MultiWriter(os.Stderr, file), file 113 | } 114 | 115 | func run(infile string, rootdir string) { 116 | gtk := 3 117 | if gtk4 { 118 | gtk = 4 119 | } 120 | 121 | outfile := getOutfile() 122 | lib.Bundle(lib.BundleOpts{ 123 | Infile: infile, 124 | Outfile: outfile, 125 | Defines: defines, 126 | UsePackage: usePackage, 127 | GtkVersion: gtk, 128 | WorkingDirectory: rootdir, 129 | }) 130 | 131 | if gtk4 { 132 | os.Setenv("LD_PRELOAD", gtk4LayerShell) 133 | } 134 | 135 | args = append([]string{"-m", outfile}, args...) 136 | stdout, stderr, file := logging() 137 | gjs := lib.Exec("gjs", args...) 138 | gjs.Stdin = os.Stdin 139 | gjs.Dir = filepath.Dir(infile) 140 | 141 | gjs.Stdout = stdout 142 | gjs.Stderr = stderr 143 | 144 | // TODO: watch and restart 145 | if err := gjs.Run(); err != nil { 146 | lib.Err(err) 147 | } 148 | 149 | if file != nil { 150 | file.Close() 151 | } 152 | } 153 | -------------------------------------------------------------------------------- /cmd/toggle.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | 6 | "github.com/spf13/cobra" 7 | ) 8 | 9 | var toggleCommand = &cobra.Command{ 10 | Use: "toggle [name]", 11 | Short: "Toggle visibility of a Window", 12 | Args: cobra.ExactArgs(1), 13 | Run: func(cmd *cobra.Command, args []string) { 14 | instance, _ := cmd.Flags().GetString("instance") 15 | lib.Astal("--instance", instance, "--toggle-window", args[0]) 16 | }, 17 | } 18 | 19 | func init() { 20 | lib.AddInstanceFlag(toggleCommand) 21 | } 22 | -------------------------------------------------------------------------------- /cmd/types.go: -------------------------------------------------------------------------------- 1 | package cmd 2 | 3 | import ( 4 | "ags/lib" 5 | "fmt" 6 | "os" 7 | "os/exec" 8 | "path/filepath" 9 | "strings" 10 | "time" 11 | 12 | "github.com/spf13/cobra" 13 | ) 14 | 15 | var ( 16 | ignoreModules []string 17 | updatePkg bool 18 | verbose bool 19 | ) 20 | 21 | var typesCommand = &cobra.Command{ 22 | Use: "types [pattern]", 23 | Short: "Generate TypeScript types", 24 | Args: cobra.MaximumNArgs(1), 25 | Example: ` ags types Astal* --ignore Gtk3 --ignore Astal3`, 26 | Run: func(cmd *cobra.Command, args []string) { 27 | if updatePkg { 28 | lib.WriteFile(targetDir+"/tsconfig.json", lib.GetTsconfig(targetDir, 0)) 29 | lib.WriteFile(targetDir+"/package.json", lib.GetPackageJson(targetDir)) 30 | 31 | lib.Mkdir(targetDir + "/node_modules") 32 | lib.Rm(targetDir + "/node_modules/astal") 33 | lib.Ln(astalGjs, targetDir+"/node_modules/astal") 34 | 35 | envdts := targetDir + "/env.d.ts" 36 | if !lib.FileExists(envdts) { 37 | lib.WriteFile(envdts, getDataFile("env.d.ts")) 38 | } 39 | } 40 | 41 | if len(args) > 0 { 42 | genTypes(targetDir, args[0], verbose) 43 | } else { 44 | genTypes(targetDir, "*", verbose) 45 | } 46 | }, 47 | } 48 | 49 | func init() { 50 | f := typesCommand.Flags() 51 | 52 | f.BoolVarP(&verbose, "verbose", "v", false, "print ts-for-gir logs") 53 | f.BoolVarP(&updatePkg, "package", "p", false, "update package.json") 54 | f.StringVarP(&targetDir, "directory", "d", defaultConfigDir(), "target directory") 55 | f.StringArrayVarP(&ignoreModules, "ignore", "i", []string{}, "modules that should be ignored") 56 | 57 | f.BoolVar(&updatePkg, "tsconfig", false, "update package.json") 58 | f.MarkDeprecated("tsconfig", "use --package instead") 59 | f.MarkHidden("tsconfig") 60 | } 61 | 62 | func spinner(stopChan chan bool) { 63 | chars := []string{"⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷"} 64 | 65 | for { 66 | select { 67 | case <-stopChan: 68 | fmt.Print("\r\033[K") 69 | return 70 | default: 71 | for _, c := range chars { 72 | fmt.Printf("\r%s Generating types, this might take a while...", lib.Cyan(c)) 73 | time.Sleep(time.Second / 10) 74 | } 75 | } 76 | } 77 | } 78 | 79 | func hideCursor() { 80 | fmt.Print("\033[?25l") 81 | } 82 | 83 | func showCursor() { 84 | fmt.Print("\033[?25h") 85 | } 86 | 87 | func genTypes(configDir, pattern string, verbose bool) { 88 | lib.Mkdir(configDir) 89 | 90 | npx, err := exec.LookPath("npx") 91 | if err != nil { 92 | lib.Err(err) 93 | } 94 | 95 | flags := []string{ 96 | "-y", tsForGir, "generate", pattern, 97 | "--ignoreVersionConflicts", 98 | "--outdir", filepath.Join(configDir, "@girs"), 99 | } 100 | 101 | dataDirs := append([]string{ 102 | "/usr/local/share/gir-1.0", 103 | "/usr/share/gir-1.0", 104 | "/usr/share/*/gir-1.0", 105 | }, strings.Split(os.Getenv("EXTRA_GIR_DIRS"), ":")...) 106 | 107 | for _, path := range dataDirs { 108 | flags = append(flags, "-g", path) 109 | } 110 | 111 | hideCursor() 112 | 113 | cmd := exec.Command(npx, flags...) 114 | 115 | if verbose { 116 | fmt.Fprintln(os.Stderr, lib.Blue("executing: ")+strings.Join(cmd.Args, " ")) 117 | 118 | cmd.Stderr = os.Stderr 119 | cmd.Stdout = os.Stdout 120 | err = cmd.Run() 121 | } else { 122 | stopChan := make(chan bool) 123 | go spinner(stopChan) 124 | err = cmd.Run() 125 | stopChan <- true 126 | showCursor() 127 | } 128 | 129 | if err != nil { 130 | lib.Err("type generation failed, try running\n" + 131 | lib.Yellow(npx+" "+strings.Join(flags, " "))) 132 | } 133 | } 134 | -------------------------------------------------------------------------------- /data/env.d.ts: -------------------------------------------------------------------------------- 1 | declare const SRC: string 2 | 3 | declare module "inline:*" { 4 | const content: string 5 | export default content 6 | } 7 | 8 | declare module "*.scss" { 9 | const content: string 10 | export default content 11 | } 12 | 13 | declare module "*.blp" { 14 | const content: string 15 | export default content 16 | } 17 | 18 | declare module "*.css" { 19 | const content: string 20 | export default content 21 | } 22 | -------------------------------------------------------------------------------- /data/gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | @girs/ 3 | -------------------------------------------------------------------------------- /data/gtk3/Bar.tsx: -------------------------------------------------------------------------------- 1 | import { App, Astal, Gtk, Gdk } from "astal/gtk3" 2 | import { Variable } from "astal" 3 | 4 | const time = Variable("").poll(1000, "date") 5 | 6 | export default function Bar(gdkmonitor: Gdk.Monitor) { 7 | const { TOP, LEFT, RIGHT } = Astal.WindowAnchor 8 | 9 | return 15 | 16 | 22 | 23 | 29 | 30 | 31 | } 32 | -------------------------------------------------------------------------------- /data/gtk3/app.ts: -------------------------------------------------------------------------------- 1 | import { App } from "astal/gtk3" 2 | import style from "./style.scss" 3 | import Bar from "./widget/Bar" 4 | 5 | App.start({ 6 | css: style, 7 | main() { 8 | App.get_monitors().map(Bar) 9 | }, 10 | }) 11 | -------------------------------------------------------------------------------- /data/gtk4/Bar.tsx: -------------------------------------------------------------------------------- 1 | import { App, Astal, Gtk, Gdk } from "astal/gtk4" 2 | import { Variable } from "astal" 3 | 4 | const time = Variable("").poll(1000, "date") 5 | 6 | export default function Bar(gdkmonitor: Gdk.Monitor) { 7 | const { TOP, LEFT, RIGHT } = Astal.WindowAnchor 8 | 9 | return 16 | 17 | 24 | 25 | 29 | 34 | 35 | 36 | } 37 | -------------------------------------------------------------------------------- /data/gtk4/app.ts: -------------------------------------------------------------------------------- 1 | import { App } from "astal/gtk4" 2 | import style from "./style.scss" 3 | import Bar from "./widget/Bar" 4 | 5 | App.start({ 6 | css: style, 7 | main() { 8 | App.get_monitors().map(Bar) 9 | }, 10 | }) 11 | -------------------------------------------------------------------------------- /data/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "astal-shell", 3 | "dependencies": { 4 | "astal": "@ASTAL_GJS@" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /data/style.scss: -------------------------------------------------------------------------------- 1 | // https://gitlab.gnome.org/GNOME/gtk/-/blob/gtk-3-24/gtk/theme/Adwaita/_colors-public.scss 2 | $fg-color: #{"@theme_fg_color"}; 3 | $bg-color: #{"@theme_bg_color"}; 4 | 5 | window.Bar { 6 | background: transparent; 7 | color: $fg-color; 8 | font-weight: bold; 9 | 10 | >centerbox { 11 | background: $bg-color; 12 | border-radius: 10px; 13 | margin: 8px; 14 | } 15 | 16 | button { 17 | border-radius: 8px; 18 | margin: 2px; 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /data/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json.schemastore.org/tsconfig", 3 | "compilerOptions": { 4 | "experimentalDecorators": true, 5 | "strict": true, 6 | "target": "ES2022", 7 | "module": "ES2022", 8 | "moduleResolution": "Bundler", 9 | // "checkJs": true, 10 | // "allowJs": true, 11 | "jsx": "react-jsx", 12 | "jsxImportSource": "astal/@GTK_VERSION@", 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /docs/.gitignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | result/ 3 | .vitepress/cache/ 4 | node_modules/ 5 | npm-debug.log* 6 | -------------------------------------------------------------------------------- /docs/.vitepress/config.ts: -------------------------------------------------------------------------------- 1 | export { default } from "../vitepress.config" 2 | -------------------------------------------------------------------------------- /docs/.vitepress/theme/index.ts: -------------------------------------------------------------------------------- 1 | import DefaultTheme from "vitepress/theme" 2 | import "../../vitepress.theme.css" 3 | import "devicon/devicon.min.css" 4 | 5 | export default DefaultTheme 6 | -------------------------------------------------------------------------------- /docs/guide/astal-cli.md: -------------------------------------------------------------------------------- 1 | # Astal CLI 2 | 3 | AGS provides aliases for the [Astal CLI](https://aylur.github.io/astal/guide/typescript/cli-app). 4 | 5 | ## [Request](https://aylur.github.io/astal/guide/typescript/cli-app#messaging-from-cli) 6 | 7 | ```ts 8 | App.start({ 9 | requestHandler(request: string, res: (response: any) => void) { 10 | if (request == "say hi") { 11 | res("hi cli") 12 | } 13 | res("unknown command") 14 | }, 15 | }) 16 | ``` 17 | 18 | :::code-group 19 | 20 | ```sh [astal] 21 | astal say hi --instance astal 22 | # hi cli 23 | ``` 24 | 25 | ```sh [ags] 26 | ags request "say hi" --instance astal 27 | # hi cli 28 | ``` 29 | 30 | ::: 31 | 32 | ## List 33 | 34 | :::code-group 35 | 36 | ```sh [astal] 37 | astal --list 38 | ``` 39 | 40 | ```sh [ags] 41 | ags list 42 | ``` 43 | 44 | ::: 45 | 46 | ## [Opening the inspector](https://aylur.github.io/astal/guide/typescript/theming#inspector) 47 | 48 | :::code-group 49 | 50 | ```sh [astal] 51 | astal --inspector --instance astal 52 | ``` 53 | 54 | ```sh [ags] 55 | ags inspect --instance astal 56 | ``` 57 | 58 | ::: 59 | 60 | ## [Window toggling](https://aylur.github.io/astal/guide/typescript/cli-app#toggling-windows-by-their-name) 61 | 62 | :::code-group 63 | 64 | ```sh [astal] 65 | astal --toggle-window window-name --instance astal 66 | ``` 67 | 68 | ```sh [ags] 69 | ags toggle window-name --instance astal 70 | ``` 71 | 72 | ::: 73 | 74 | ## Quitting App 75 | 76 | :::code-group 77 | 78 | ```sh [astal] 79 | astal --quit --instance astal 80 | ``` 81 | 82 | ```sh [ags] 83 | ags quit --instance astal 84 | ``` 85 | 86 | ::: 87 | -------------------------------------------------------------------------------- /docs/guide/bundling.md: -------------------------------------------------------------------------------- 1 | # Bundling projects 2 | 3 | Bundling can be done with the `ags bundle` command. 4 | 5 | :::details 6 | Uses [esbuild](https://esbuild.github.io/) under the hood. 7 | ::: 8 | 9 | ```sh 10 | $ ags bundle --help 11 | 12 | Bundle an app 13 | 14 | Usage: 15 | ags bundle [entryfile] [outfile] [flags] 16 | 17 | Examples: 18 | bundle app.ts my-shell -d "DATADIR='/usr/share/my-shell'" 19 | 20 | Flags: 21 | -d, --define stringArray replace global identifiers with constant expressions 22 | -h, --help help for bundle 23 | -p, --package use astal package as defined in package.json 24 | -r, --root string root directory of the project 25 | ``` 26 | 27 | Currently there are 3 builtin plugins. 28 | 29 | - css: import `.css` will be inlined as a string 30 | - sass: importing `.scss` files will go through the sass transpiler and be inlined as a string that contains valid css using the `sass` executable found on `$PATH` 31 | :::code-group 32 | 33 | ```scss [style.scss] 34 | $color: white; 35 | 36 | selector { 37 | color: $color; 38 | } 39 | ``` 40 | 41 | ::: 42 | :::code-group 43 | 44 | ```ts [ app.ts] 45 | import style from "./style.scss" 46 | 47 | print(style) 48 | // selector { 49 | // color: white; 50 | // } 51 | ``` 52 | 53 | ::: 54 | 55 | - blp: importing `.blp` files will go through [blueprint](https://jwestman.pages.gitlab.gnome.org/blueprint-compiler/) and be inlined as a string that contains xml template definitions 56 | :::code-group 57 | 58 | ```blp [ ui.blp] 59 | using Gtk 4.0; 60 | 61 | Label { 62 | label: _("hello"); 63 | } 64 | ``` 65 | 66 | ::: 67 | :::code-group 68 | 69 | ```ts [ app.ts] 70 | import ui from "./ui.blp" 71 | 72 | print(ui) 73 | // 74 | // 75 | // 76 | // 77 | // hello 78 | // 79 | // 80 | ``` 81 | 82 | ::: 83 | 84 | - inline: importing with `inline:/path/to/file` will inline the contents of the file as a string 85 | :::code-group 86 | 87 | ```txt [data.txt] 88 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do. 89 | ``` 90 | 91 | ::: 92 | :::code-group 93 | 94 | ```ts [ app.ts] 95 | import data from "inline:./data.txt" 96 | 97 | print(ui) 98 | // Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do. 99 | ``` 100 | 101 | ::: 102 | 103 | AGS defines `SRC` which by default will point to the directory of `entryfile`. 104 | It can be overriden with `-d "SRC='/path/to/source'"` 105 | 106 | ```js 107 | #!/usr/bin/ags run 108 | App.start({ 109 | main() { 110 | print(`source dir is ${SRC}`) 111 | } 112 | }) 113 | ``` 114 | 115 | By default `ags bundle` will alias the `astal` package for the one defined 116 | at [installation](./install). 117 | 118 | This behavior can be altered by using the `--package` flag which will instead 119 | use the astal package as defined in `package.json`. 120 | 121 | ## Example 122 | 123 | :::code-group 124 | 125 | ```blp [Bar.blp] 126 | using Gtk 4.0; 127 | using Astal 4.0; 128 | 129 | template $Bar: Astal.Window { 130 | // bitfields currently don't work in blueprint 131 | // anchor: top | left | right; 132 | exclusivity: exclusive; 133 | 134 | CenterBox { 135 | center-widget: Label { 136 | label: "hello"; 137 | }; 138 | } 139 | } 140 | ``` 141 | 142 | ::: 143 | 144 | :::code-group 145 | 146 | ```ts [app.ts] 147 | #!/usr/bin/gjs -m 148 | import { register } from "astal/gobject" 149 | import { App, Astal } from "astal/gtk4" 150 | import Template from "./Bar.blp" 151 | 152 | const { TOP, LEFT, RIGHT } = Astal.WindowAnchor 153 | 154 | @register({ GTypeName: "Bar", Template }) 155 | class Bar extends Astal.Window { 156 | } 157 | 158 | App.start({ 159 | instanceName: "bar", 160 | main() { 161 | new Bar({ 162 | application: App, 163 | anchor: TOP | LEFT | RIGHT, 164 | visible: true, 165 | }) 166 | } 167 | }) 168 | ``` 169 | 170 | ::: 171 | 172 | ```sh 173 | ags bundle ./app.ts bar 174 | chmod +x ./bar 175 | 176 | ./bar 177 | ``` 178 | 179 | > [!NOTE] 180 | > On Nix this still has to be done in a derivation 181 | > as the bundled script is not wrapped. 182 | 183 | ## Distributing 184 | 185 | If you have no data files, you can use `ags bundle` 186 | and distribute its output JS file as an executable. 187 | Optionally use a build tool like meson to also declare its runtime dependencies. 188 | 189 | When you have data files that you cannot inline as a string, for example icons, 190 | a good practice would be to: 191 | 192 | 1. Install data files to a directory, usually `/usr/share/your-project` 193 | 2. Define it as `DATADIR` in `env.d.ts` and at bundle time with `--define` 194 | 3. In code you can refer to data files through this `DATADIR` variable 195 | 196 | :::code-group 197 | 198 | ```meson [meson.build] 199 | prefix = get_option('prefix') 200 | pkgdatadir = prefix / get_option('datadir') / meson.project_name() 201 | bindir = prefix / get_option('bindir') 202 | 203 | install_data( 204 | files('data/data.txt'), 205 | install_dir: pkgdatadir, 206 | ) 207 | 208 | custom_target( 209 | command: [ 210 | find_program('ags'), 211 | 'bundle', 212 | '--define', 'DATADIR="' + pkgdatadir + '"', 213 | '--root', meson.project_source_root(), 214 | meson.project_source_root() / 'app.ts', 215 | meson.project_name(), 216 | ], 217 | output: [meson.project_name()], 218 | input: files('app.ts'), 219 | install: true, 220 | install_dir: bindir, 221 | ) 222 | ``` 223 | 224 | ```ts [env.d.ts] 225 | declare const DATADIR: string 226 | ``` 227 | 228 | ```ts [app.ts] 229 | const data = `${DATADIR}/data.txt` 230 | ``` 231 | 232 | ::: 233 | 234 | > [!TIP] 235 | > On Nix you can use the [lib.bundle](./nix#bundle-and-devshell) function as well as meson. 236 | 237 | ## Notice for Gtk4 238 | 239 | [`gtk4-layer-shell` needs to be linked before wayland.](https://github.com/wmww/gtk4-layer-shell/issues/3#issuecomment-1502339477) 240 | When bundling a Gtk4 application you will have to use a wrapper to make it work. 241 | 242 | :::code-group 243 | 244 | ```bash [wrapper.sh] 245 | #!/bin/bash 246 | LD_PRELOAD="@LAYER_SHELL_LIBDIR@/libgtk4-layer-shell.so" @MAIN_PROGRAM@ $@ 247 | ``` 248 | 249 | ::: 250 | :::code-group 251 | 252 | ```meson [meson.build] 253 | pkgdatadir = get_option('prefix') / get_option('datadir') / meson.project_name() 254 | main = meson.project_name() + '.wrapped' 255 | 256 | custom_target( 257 | command: [ 258 | find_program('ags'), 259 | 'bundle', 260 | '--root', meson.project_source_root(), 261 | meson.project_source_root() / 'app.ts', 262 | main, 263 | ], 264 | output: main, 265 | input: files('app.ts'), 266 | install: true, 267 | install_dir: pkgdatadir, 268 | ) 269 | 270 | configure_file( 271 | input: files('wrapper.sh'), 272 | output: meson.project_name(), 273 | configuration: { 274 | 'MAIN_PROGRAM': pkgdatadir / main, 275 | 'LAYER_SHELL_LIBDIR': dependency('gtk4-layer-shell-0').get_variable('libdir'), 276 | }, 277 | install: true, 278 | install_dir: get_option('prefix') / get_option('bindir'), 279 | ) 280 | ``` 281 | 282 | ::: 283 | -------------------------------------------------------------------------------- /docs/guide/example.md: -------------------------------------------------------------------------------- 1 | # Dialog Example 2 | 3 | This example is meant to shown that `ags` can be used 4 | to create simple scripts without bundling. 5 | 6 | To see examples uses of `Astal` go to the [Astal website](https://aylur.github.io/astal/guide/typescript/examples). 7 | 8 | Simple dialog example to get a `no`/`yes` answer. 9 | 10 | ![2024-11-13_00-45-58](https://github.com/user-attachments/assets/73a20155-fa0e-4156-aff8-3a0d055abb9b) 11 | 12 | :::code-group 13 | 14 | ```tsx [dialog.ts] 15 | #!/usr/bin/env -S ags run 16 | import { App, Astal, Gtk, Gdk } from "astal/gtk3" 17 | 18 | const { TOP, BOTTOM, LEFT, RIGHT } = Astal.WindowAnchor 19 | const { IGNORE } = Astal.Exclusivity 20 | const { EXCLUSIVE } = Astal.Keymode 21 | const { CENTER } = Gtk.Align 22 | 23 | App.start({ 24 | instanceName: "tmp" + Date.now(), 25 | gtkTheme: "adw-gtk3-dark", 26 | css: /* css */` 27 | window { 28 | all: unset; 29 | background-color: alpha(black, 0.3); 30 | } 31 | 32 | window > box { 33 | margin: 10px; 34 | padding: 6px; 35 | box-shadow: 2px 3px 5px 0 alpha(black, 0.6); 36 | border-radius: 11px; 37 | background-color: #181818; 38 | color: white; 39 | min-width: 200px; 40 | } 41 | 42 | box > label { 43 | font-size: large; 44 | margin: 6px; 45 | } 46 | 47 | label.title { 48 | font-size: 1.4em; 49 | } 50 | 51 | .action { 52 | color: alpha(white, 0.8); 53 | } 54 | 55 | button { 56 | margin: 6px; 57 | } 58 | `, 59 | main: (action = "XYZ") => { 60 | function yes() { 61 | print("yes") 62 | App.quit() 63 | } 64 | 65 | function no() { 66 | print("no") 67 | App.quit() 68 | } 69 | 70 | function onKeyPress(_: Astal.Window, event: Gdk.Event) { 71 | if (event.get_keyval()[1] === Gdk.KEY_Escape) { 72 | no() 73 | } 74 | } 75 | 76 | 81 | 82 | 93 | 94 | } 95 | }) 96 | ``` 97 | 98 | ::: 99 | 100 | Then it can be used in any script. 101 | 102 | ```sh 103 | if [[ "$(./dialog.ts -a Shutdown)" == "yes" ]]; then 104 | shutdown now 105 | fi 106 | ``` 107 | 108 | > [!TIP] 109 | > If you are happy with the script and don't 110 | > plan to change it anymore [bundle](./bundling.md) it, 111 | > which will remove the dependency on AGS. 112 | -------------------------------------------------------------------------------- /docs/guide/init.md: -------------------------------------------------------------------------------- 1 | # Setting up a project 2 | 3 | You can initalize a project with the `init` command. 4 | 5 | ```sh 6 | $ ags init --help 7 | 8 | Initialize a project directory by setting up files needed by TypeScript, 9 | generating types and setting up a basic bar example 10 | 11 | Usage: 12 | ags init [flags] 13 | 14 | Flags: 15 | -d, --directory string target directory (default "~/.config/ags") 16 | -f, --force override existing files 17 | -g, --gtk int gtk version to use (default 3) 18 | -h, --help help for init 19 | 20 | ``` 21 | 22 | By default it will set it up at `$HOME/.config/ags`, 23 | but you can specify the target directory with the `-d` flag. 24 | 25 | It will generate the following files: 26 | 27 | ```txt 28 | . 29 | ├── @girs/ 30 | ├── node_modules/ 31 | │ └── astal 32 | ├── widget/ 33 | │ └── Bar.tsx 34 | ├── app.ts 35 | ├── env.d.ts 36 | ├── style.scss 37 | ├── package.json 38 | └── tsconfig.json 39 | ``` 40 | 41 | The `@girs` directory contains the generated types, which are 42 | created when running the `init` command or the `types` command. 43 | 44 | :::details Details on TypeScript. 45 | While `gjs` does not currently support Node.js project structures and its ecosystem 46 | the JavaScript tooling we are using relies on it. The `node_modules` directory 47 | contains the `astal` package, but its purpose is only to provide type information. 48 | The `package.json` is a file describing the project and `tsconfig.json` is a file 49 | containing settings for TypeScript. 50 | ::: 51 | 52 | > [!WARNING] 53 | > Since the runtime is `gjs`, very few packages will run from `npm`, 54 | since most depends on `node` features. 55 | 56 | The `env.d.ts` let's the type checker in your editor know about additional 57 | [features](./bundling) the `ags` bundler provides, for example the ability to inline files. 58 | This can be also be expanded for variables defined with the `--define` flag at bundling. 59 | 60 | `app.ts` is the entry point of the project which usually 61 | contains only an `App.start` call where you define [main](https://aylur.github.io/astal/guide/typescript/cli-app#entry-point) and [requestHandler](https://aylur.github.io/astal/guide/typescript/cli-app#messaging-from-cli), 62 | but can contain any other code. 63 | 64 | > [!TIP] 65 | > You could also name the entry file `app.tsx` and write any JSX there. 66 | 67 | > [!TIP] 68 | > You are not forced to use TypeScript. Adding `"allowJs": true` 69 | > in `tsconfig.json` and optionally `"checkJs": true` will allow 70 | > JavaScript, although it is very much recommended to TypeScript. 71 | 72 | ## Running projects 73 | 74 | `tsconfig.json`, `env.d.ts` and `@girs` are only significant for the LSP, 75 | they are not needed to run the project. 76 | 77 | > [!TIP] 78 | > You can also use `ags run` as a shebang line for simple scripts. 79 | > See an [simple dialog example](./example.md). 80 | 81 | > [!IMPORTANT] 82 | > When using Gtk4 you have to use `--gtk4` flag for [gtk4-layer-shell](https://github.com/wmww/gtk4-layer-shell/issues/3#issuecomment-1502339477). 83 | -------------------------------------------------------------------------------- /docs/guide/install.md: -------------------------------------------------------------------------------- 1 | # Installation 2 | 3 | ## Arch 4 | 5 | maintainer: [@kotontrion](https://github.com/kotontrion) 6 | 7 | ```sh 8 | yay -S aylurs-gtk-shell 9 | ``` 10 | 11 | ## Nix 12 | 13 | maintainer: [@Aylur](https://github.com/Aylur) 14 | 15 | Read more about it on the [nix page](./nix) 16 | 17 | ## From Source 18 | 19 | 1. Install [Astal](https://aylur.github.io/astal/guide/getting-started/installation) 20 | 21 | 2. Install the Astal js package 22 | 23 | ```sh 24 | git clone https://github.com/aylur/astal 25 | cd astal/lang/gjs 26 | meson setup --prefix /usr build 27 | meson install -C build 28 | ``` 29 | 30 | 2. Install AGS 31 | 32 | ```sh 33 | git clone https://github.com/aylur/ags.git 34 | cd ags 35 | 36 | go install -ldflags "\ 37 | -X 'main.gtk4LayerShell=$(pkg-config --variable=libdir gtk4-layer-shell-0)/libgtk4-layer-shell.so' \ 38 | -X 'main.astalGjs=$(pkg-config --variable=srcdir astal-gjs)'" 39 | ``` 40 | 41 | :::tip 42 | `go install` will install to `$GOPATH/bin/ags` or `$HOME/go/bin/ags`. 43 | You might wish to move the binary to more traditional linux directories. 44 | 45 | ```sh 46 | sudo mv $GOPATH/bin/ags /usr/bin/ags 47 | mv $GOPATH/bin/ags ~/.local/bin/ags 48 | ``` 49 | 50 | ::: 51 | -------------------------------------------------------------------------------- /docs/guide/migrate.md: -------------------------------------------------------------------------------- 1 | # Migrating from v1 2 | 3 | Ags was rewritten from scratch and unfortunately everything changed 4 | drastically, you will have to rewrite your projects from the ground up. 5 | 6 | You will have to go through the new wiki either way, but I'll highlight some 7 | of the changes you will have to make. 8 | 9 | ## Sticking to v1 10 | 11 | If you wish to stick to v1 you can clone the 12 | [last commit](https://github.com/Aylur/ags/releases/tag/v1.9.0) 13 | 14 | > [!NOTE] NixOS 15 | > On NixOS simply switch the flake input to `ags.url = "github:aylur/ags/v1"`. 16 | 17 | > [!NOTE] Arch 18 | > On Arch you can use the [v1 pkgbuild](https://github.com/kotontrion/PKGBUILDS/blob/main/agsv1/PKGBUILD) 19 | 20 | ## Entry Point 21 | 22 | Instead of a fixed `~/.config/ags/config.js` entry you can name the main file 23 | anything and specify it as an arg to `ags run `. 24 | 25 | If you wish to stick to having the source code in `~/.config/ags` then 26 | name the entry file `app.js`, `app.ts`, `app.jsx` or `app.tsx` which `ags run` will use by default. 27 | 28 | The entry point in code changed from `App.config` to `App.start` 29 | 30 | ```js 31 | App.config({ // [!code --:5] 32 | windows: [ 33 | // window instances 34 | ] 35 | }) 36 | import { App } from "astal/gtk3" // [!code ++:7] 37 | 38 | App.start({ 39 | main() { 40 | // any initialization code 41 | } 42 | }) 43 | ``` 44 | 45 | ## Instantiating widgets 46 | 47 | It is no longer recommend to create top level instances because scripts 48 | can run in [client mode](https://aylur.github.io/astal/guide/typescript/cli-app#client) 49 | and it is recommended to only execute code in either `main` or `client` callbacks. 50 | 51 | ```js 52 | const win = Widget.Window() // [!code --:5] 53 | 54 | App.config({ 55 | windows: [win] 56 | }) 57 | App.main({ // [!code ++:5] 58 | main() { 59 | new Widget.Window() 60 | } 61 | }) 62 | ``` 63 | 64 | ## Templating 65 | 66 | AGS now supports and recommends the usage of [JSX](https://aylur.github.io/astal/guide/typescript/first-widgets#creating-and-nesting-widgets). 67 | 68 | ```jsx 69 | const _ = Widget.Box({ // [!code --:6] 70 | vertical: true, 71 | children: [ 72 | Widget.Label("hello") 73 | ] 74 | }) 75 | const _ = // [!code ++:3] 76 | 78 | 79 | const _ = Widget.Box({ // [!code --:3] 80 | child: var.bind().as(v => MyWidget(v)) 81 | }) 82 | const _ = // [!code ++:3] 83 | {var(v => )} 84 | 85 | 86 | const _ = Widget.Box({ // [!code --:5] 87 | children: var.bind().as(v => [ 88 | MyWidget(v) 89 | ]) 90 | }) 91 | const _ = // [!code ++:5] 92 | {var(v => <> 93 | 94 | )} 95 | 96 | ``` 97 | 98 | ## Reactivity 99 | 100 | Reactivity is still done through `Binding` objects and widget constructors. 101 | API of [bindable](https://aylur.github.io/astal/guide/typescript/binding#subscribable-and-connectable-interface) objects are now defined. 102 | 103 | ```jsx 104 | const label = Variable("hello") 105 | 106 | Label({ // [!code --:3] 107 | label: label.bind().as(hello => `${hello} world`) 108 | }) 109 |