├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── chips
└── spawn
├── README.md
├── Setup.hs
├── app
└── Main.hs
├── integration.sh
├── integration
├── Dockerfile
├── build.fish
├── chips_initial_run.txt
├── chips_second_run_tail.txt
├── config.fish
├── default.plugin.yaml
├── fish_prompt.fish
├── install.txt
├── plugin.yaml
├── removed.build.fish
├── removed.yaml
└── test.sh
├── package.yaml
├── src
├── Chips.hs
├── Config.hs
├── File.hs
├── Git.hs
├── Lib.hs
├── SelfUpdate.hs
├── Spawn.hs
├── Utility.hs
├── gnulinux
│ └── Platform.hs
└── osx
│ └── Platform.hs
├── stack.yaml
└── test
└── Spec.hs
/.gitignore:
--------------------------------------------------------------------------------
1 | /.stack-work
2 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Change Log
2 |
3 | ## 1.1.2 - 2017-01-16
4 |
5 | ### Fixed
6 |
7 | - [#28], Follow-up to support the version of fish included in Ubuntu 14.04 LTS in config.fish.
8 |
9 | ## 1.1.1 - 2016-11-09
10 |
11 | ### Fixed
12 |
13 | - [#23], The chips executable after self-update will now have the `+x` permission.
14 | - [#26], Executing chips with command line arguments will not cause shell exit anymore.
15 | - [#25], Now works with the version of fish included in Ubuntu 14.04 LTS.
16 |
17 | ## 1.1.0 - 2016-10-02
18 |
19 | ### Added
20 |
21 | - Automatic self update
22 | - Support for plugins with "functions"
23 | - Integration testing with Docker
24 | - Theme uninstall
25 |
26 | ### Fixed
27 |
28 | - Failure when `$HOME` and `/tmp` were not in the same disk.
29 | - [#18], Failure when config.fish is missing
30 | - [`358fe7c3`], Hang due to GitHub request burst (added request intervals)
31 | - Misbehavior when chips is run offline
32 |
33 | ## 1.0.0 - 2016-04-01
34 |
35 | - Initial release.
36 |
37 | [#28]: https://github.com/xtendo-org/chips/pull/28
38 | [#26]: https://github.com/xtendo-org/chips/issues/26
39 | [#25]: https://github.com/xtendo-org/chips/pull/25
40 | [#23]: https://github.com/xtendo-org/chips/issues/23
41 | [#18]: https://github.com/xtendo-org/chips/pull/18
42 | [`358fe7c3`]: https://github.com/xtendo-org/chips/commit/358fe7c3
43 |
--------------------------------------------------------------------------------
/LICENSE/chips:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/LICENSE/spawn:
--------------------------------------------------------------------------------
1 | spawn: A tiny Haskell library for concurrent computations
2 | https://hackage.haskell.org/package/spawn
3 |
4 | Copyright (c) Keegan McAllister 2010, 2011
5 |
6 | All rights reserved.
7 |
8 | Redistribution and use in source and binary forms, with or without
9 | modification, are permitted provided that the following conditions
10 | are met:
11 | 1. Redistributions of source code must retain the above copyright
12 | notice, this list of conditions and the following disclaimer.
13 | 2. Redistributions in binary form must reproduce the above copyright
14 | notice, this list of conditions and the following disclaimer in the
15 | documentation and/or other materials provided with the distribution.
16 | 3. Neither the name of the author nor the names of his contributors
17 | may be used to endorse or promote products derived from this software
18 | without specific prior written permission.
19 |
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 | DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY
24 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27 | ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # [chips]
2 |
3 | A plugin manager for [fish].
4 |
5 | ## Features
6 |
7 | - (supposed to be) Fast. Compiled to the native machine code. Parallel installation/upgrade of plugins.
8 | - Minimally invasive to your `config.fish`: Adding one line is sufficient.
9 | - Minimum overhead to the fish shell itself. The amount of fish script to be loaded for chips to work is extremely little.
10 | - Minimum installation cost: No dependency except `git` and `curl`. chips is a single statically-compiled binary executable file.
11 | - Uninstallation is easy: Remove chips, `~/.config/chips`, and the line in `config.fish`, and you're clean as if you never installed chips at all.
12 |
13 | ## Installation
14 |
15 | Current version: **chips 1.1.2** (2017-01-16)
16 |
17 | ### GNU/Linux (x64)
18 |
19 | Assuming `~/.local/bin` is in your `$PATH`:
20 |
21 | ```fish
22 | curl -Lo ~/.local/bin/chips --create-dirs \
23 | https://github.com/xtendo-org/chips/releases/download/1.1.2/chips_gnulinux \
24 | ; and chmod +x ~/.local/bin/chips
25 | ```
26 |
27 | ### OS X (or macOS)
28 |
29 | Assuming `~/.local/bin` is in your `$PATH`:
30 |
31 | ```fish
32 | curl -Lo ~/.local/bin/chips --create-dirs \
33 | https://github.com/xtendo-org/chips/releases/download/1.1.2/chips_osx \
34 | ; and chmod +x ~/.local/bin/chips
35 | ```
36 |
37 | ### Installation the hard way: Build from source
38 |
39 | Use [Stack].
40 |
41 | ```fish
42 | git clone --depth=1 https://github.com/xtendo-org/chips
43 | cd chips
44 | stack install
45 | ```
46 |
47 | ## Usage
48 |
49 | 1. Run `chips`. This will create `~/.config/chips/plugin.yaml` with the default template.
50 | 1. Edit `plugin.yaml` to include your desired plugins. For example, consider [fish-sensible] or [shellder].
51 | 1. Run `chips; exec fish`.
52 |
53 | After this, any time you make changes to `plugin.yaml` or want to update plugins, run `chips` again.
54 |
55 | ## Supported features
56 |
57 | - Sourcing `init.fish` of plugins
58 | - Installing themes: Plugins that contain `fish_prompt.fish` or `fish_right_prompt.fish`
59 | - `functions` provided by plugins
60 |
61 | ## To do
62 |
63 | - Completely purging unused plugins
64 | - Files under `completions`
65 |
66 | ## Officially recommended plugins
67 |
68 | - [fish-sensible]
69 | - [shellder]
70 | - [cgitc]
71 |
72 | ## License
73 |
74 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
75 |
76 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
77 |
78 | You should have received a copy of the GNU General Public License along with this program. If not, see .
79 |
80 | ## FAQ
81 |
82 | ### Why not fisherman?
83 |
84 | chips is not written by someone who abuses DMCA takedown to bully other free software projects. In fact, OMF getting shot down was the first motivation to write chips.
85 |
86 | [chips]: https://en.wikipedia.org/wiki/Fish_and_chips
87 | [fish]: https://fishshell.com/
88 | [Stack]: http://haskellstack.org/
89 | [fish-sensible]: https://github.com/simnalamburt/fish-sensible
90 | [shellder]: https://github.com/simnalamburt/shellder
91 | [cgitc]: https://github.com/simnalamburt/cgitc
92 |
--------------------------------------------------------------------------------
/Setup.hs:
--------------------------------------------------------------------------------
1 | import Distribution.Simple
2 | main = defaultMain
3 |
--------------------------------------------------------------------------------
/app/Main.hs:
--------------------------------------------------------------------------------
1 | module Main where
2 |
3 | import Lib
4 |
5 | main :: IO ()
6 | main = app
7 |
--------------------------------------------------------------------------------
/integration.sh:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | bold=$(tput bold)
3 | normal=$(tput sgr0)
4 |
5 | echo "$bold>>> Preparing integration test$normal"
6 | stack install > /dev/null || exit 1
7 | docker build -t xtendo-org/chips integration > /dev/null || exit 1
8 | cp ~/.local/bin/chips ./integration
9 |
10 | echo "$bold>>> Test start$normal"
11 | docker run -a stdout -t --name chips-integration-test -v $(pwd $(dirname $0))/integration:/home/user/integration xtendo-org/chips /usr/bin/bash /home/user/integration/test.sh
12 | rm ./integration/chips
13 | docker stop chips-integration-test > /dev/null
14 | docker rm chips-integration-test > /dev/null
15 |
16 | export RESULT=$(cat ./integration/result.txt)
17 | rm ./integration/result.txt
18 | if test "$RESULT" = "success"; then
19 | echo "$bold>>> Test success$normal"
20 | exit 0
21 | else
22 | echo "$bold>>> Test fail$normal"
23 | exit 1
24 | fi
25 |
--------------------------------------------------------------------------------
/integration/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM centos:7
2 | MAINTAINER XT
3 |
4 | RUN yum install -y git
5 | RUN curl -Lo /etc/yum.repos.d/shells:fish:release:2.repo http://download.opensuse.org/repositories/shells:fish:release:2/CentOS_7/shells:fish:release:2.repo
6 | RUN yum install -y fish
7 |
8 | # create user
9 | RUN useradd -m user
10 | RUN chsh -s /usr/bin/fish user
11 | USER user
12 | WORKDIR /home/user
13 |
--------------------------------------------------------------------------------
/integration/build.fish:
--------------------------------------------------------------------------------
1 | function chips; "/home/user/integration/chips" $argv; exec fish; end
2 | . /home/user/.config/chips/dist/fish-sensible/init.fish
3 |
--------------------------------------------------------------------------------
/integration/chips_initial_run.txt:
--------------------------------------------------------------------------------
1 | chips: fish plugin manager
2 | version 1.1.2
3 | chips has just created the default configuration at:
4 | /home/user/.config/chips/plugin.yaml
5 | Please edit the file and run chips again.
6 |
--------------------------------------------------------------------------------
/integration/chips_second_run_tail.txt:
--------------------------------------------------------------------------------
1 | Copied shellder/fish_prompt.fish to /home/user/.config/fish/functions/fish_prompt.fish
2 | Build result saved at /home/user/.config/chips/build.fish
3 | chips is already up to date.
4 |
--------------------------------------------------------------------------------
/integration/config.fish:
--------------------------------------------------------------------------------
1 | # chips
2 | if [ -e ~/.config/chips/build.fish ] ; . ~/.config/chips/build.fish ; end
3 |
--------------------------------------------------------------------------------
/integration/default.plugin.yaml:
--------------------------------------------------------------------------------
1 | git:
2 | # Add Git clone URLs for fish plugins here.
3 | # For example, uncomment below to enable the fish-sensible plugin.
4 | # - https://github.com/simnalamburt/fish-sensible
5 | github:
6 | # Add GitHub repositories for fish plugins here.
7 | # For example, uncomment below to enable the fish-sensible plugin.
8 | # - simnalamburt/fish-sensible
9 |
--------------------------------------------------------------------------------
/integration/fish_prompt.fish:
--------------------------------------------------------------------------------
1 | # Set these options in your config.fish (if you want to :])
2 | #
3 | # set -g theme_display_user yes
4 | # set -g theme_hostname never
5 | # set -g theme_hostname always
6 | # set -g default_user your_normal_user
7 |
8 |
9 |
10 | # Backward compatibility
11 | #
12 | # Note: Do not depend on these behavior. These can be removed in anytime by the
13 | # author in the name of code readability.
14 | if set -q theme_hide_hostname
15 | # Existing $theme_hostname will always override $theme_hide_hostname
16 | if not set -q theme_hostname
17 | if [ "theme_hide_hostname" = "yes" ]
18 | set -g theme_hostname never
19 | end
20 | if [ "theme_hide_hostname" = "no" ]
21 | set -g theme_hostname always
22 | end
23 | end
24 | end
25 |
26 |
27 | #
28 | # Segments functions
29 | #
30 | set -g current_bg NONE
31 | set -g segment_separator \uE0B0
32 |
33 | function prompt_segment -d "Function to draw a segment"
34 | set -l bg
35 | set -l fg
36 | if [ -n "$argv[1]" ]
37 | set bg $argv[1]
38 | else
39 | set bg normal
40 | end
41 | if [ -n "$argv[2]" ]
42 | set fg $argv[2]
43 | else
44 | set fg normal
45 | end
46 | if [ "$current_bg" != 'NONE' -a "$argv[1]" != "$current_bg" ]
47 | set_color -b $bg
48 | set_color $current_bg
49 | echo -n "$segment_separator "
50 | set_color -b $bg
51 | set_color $fg
52 | else
53 | set_color -b $bg
54 | set_color $fg
55 | echo -n " "
56 | end
57 | set current_bg $argv[1]
58 | if [ -n "$argv[3]" ]
59 | echo -n -s $argv[3] " "
60 | end
61 | end
62 |
63 | function prompt_finish -d "Close open segments"
64 | if [ -n $current_bg ]
65 | set_color -b normal
66 | set_color $current_bg
67 | echo -n "$segment_separator "
68 | end
69 | set_color normal
70 | set -g current_bg NONE
71 | end
72 |
73 |
74 | #
75 | # Components
76 | #
77 | function prompt_virtual_env -d "Display Python virtual environment"
78 | if test "$VIRTUAL_ENV"
79 | prompt_segment white black (basename $VIRTUAL_ENV)
80 | end
81 | end
82 |
83 |
84 | function prompt_user -d "Display current user if different from $default_user"
85 | set -l BG 444444
86 | set -l FG BCBCBC
87 |
88 | if [ "$theme_display_user" = "yes" ]
89 | if [ "$USER" != "$default_user" -o -n "$SSH_CLIENT" ]
90 | set USER (whoami)
91 | get_hostname
92 | if [ $HOSTNAME_PROMPT ]
93 | set USER_PROMPT $USER@$HOSTNAME_PROMPT
94 | else
95 | set USER_PROMPT $USER
96 | end
97 | prompt_segment $BG $FG $USER_PROMPT
98 | end
99 | else
100 | get_hostname
101 | if [ $HOSTNAME_PROMPT ]
102 | prompt_segment $BG $FG $HOSTNAME_PROMPT
103 | end
104 | end
105 | end
106 |
107 | function get_hostname -d "Set current hostname to prompt variable $HOSTNAME_PROMPT if connected via SSH"
108 | set -g HOSTNAME_PROMPT ""
109 | if [ "$theme_hostname" = "always" -o \( "$theme_hostname" != "never" -a -n "$SSH_CLIENT" \) ]
110 | set -g HOSTNAME_PROMPT (hostname)
111 | end
112 | end
113 |
114 |
115 | function prompt_dir -d "Display the current directory"
116 | prompt_segment 1C1C1C FFFFFF (prompt_pwd)
117 | end
118 |
119 |
120 | function prompt_hg -d "Display mercurial state"
121 | set -l branch
122 | set -l state
123 | if command hg id >/dev/null 2>&1
124 | if command hg prompt >/dev/null 2>&1
125 | set branch (command hg prompt "{branch}")
126 | set state (command hg prompt "{status}")
127 | set branch_symbol \uE0A0
128 | if [ "$state" = "!" ]
129 | prompt_segment red white "$branch_symbol $branch ±"
130 | else if [ "$state" = "?" ]
131 | prompt_segment yellow black "$branch_symbol $branch ±"
132 | else
133 | prompt_segment green black "$branch_symbol $branch"
134 | end
135 | end
136 | end
137 | end
138 |
139 |
140 | function prompt_git -d "Display the current git state"
141 | set -l ref
142 | if command git rev-parse --is-inside-work-tree >/dev/null 2>&1
143 | set ref (command git symbolic-ref HEAD 2> /dev/null)
144 | if [ $status -gt 0 ]
145 | set -l branch (command git show-ref --head -s --abbrev |head -n1 2> /dev/null)
146 | set ref "➦ $branch "
147 | end
148 | set branch_symbol \uE0A0
149 | set -l branch (echo $ref | sed "s-refs/heads/-$branch_symbol -")
150 |
151 | set -l BG PROMPT
152 | set -l dirty (command git status --porcelain --ignore-submodules=dirty 2> /dev/null)
153 | if [ "$dirty" = "" ]
154 | set BG green
155 | set PROMPT "$branch"
156 | else
157 | set BG yellow
158 | set dirty ''
159 |
160 | # Check if there's any commit in the repo
161 | set -l empty 0
162 | git rev-parse --quiet --verify HEAD > /dev/null ^&1; or set empty 1
163 |
164 | set -l target
165 | if [ $empty = 1 ]
166 | # The repo is empty
167 | set target '4b825dc642cb6eb9a060e54bf8d69288fbee4904'
168 | else
169 | # The repo is not emtpy
170 | set target 'HEAD'
171 |
172 | # Check for unstaged change only when the repo is not empty
173 | set -l unstaged 0
174 | git diff --no-ext-diff --ignore-submodules=dirty --quiet --exit-code; or set unstaged 1
175 | if [ $unstaged = 1 ]; set dirty $dirty'●'; end
176 | end
177 |
178 | # Check for staged change
179 | set -l staged 0
180 | git diff-index --cached --quiet --exit-code --ignore-submodules=dirty $target; or set staged 1
181 | if [ $staged = 1 ]; set dirty $dirty'✚'; end
182 |
183 | # Check for dirty
184 | if [ "$dirty" = "" ]
185 | set PROMPT "$branch"
186 | else
187 | set PROMPT "$branch $dirty"
188 | end
189 | end
190 | prompt_segment $BG black $PROMPT
191 | end
192 | end
193 |
194 |
195 | function prompt_svn -d "Display the current svn state"
196 | set -l ref
197 | if command svn ls . >/dev/null 2>&1
198 | set branch (svn_get_branch)
199 | set branch_symbol \uE0A0
200 | set revision (svn_get_revision)
201 | prompt_segment green black "$branch_symbol $branch:$revision"
202 | end
203 | end
204 |
205 | function svn_get_branch -d "get the current branch name"
206 | svn info 2> /dev/null | awk -F/ \
207 | '/^URL:/ { \
208 | for (i=0; i<=NF; i++) { \
209 | if ($i == "branches" || $i == "tags" ) { \
210 | print $(i+1); \
211 | break;\
212 | }; \
213 | if ($i == "trunk") { print $i; break; } \
214 | } \
215 | }'
216 | end
217 |
218 | function svn_get_revision -d "get the current revision number"
219 | svn info 2> /dev/null | sed -n 's/Revision:\ //p'
220 | end
221 |
222 |
223 | function prompt_status -d "the symbols for a non zero exit status, root and background jobs"
224 | if [ $RETVAL -ne 0 ]
225 | prompt_segment black red "✘"
226 | end
227 |
228 | # if superuser (uid == 0)
229 | set -l uid (id -u $USER)
230 | if [ $uid -eq 0 ]
231 | prompt_segment black yellow "⚡"
232 | end
233 |
234 | # Jobs display
235 | if [ (jobs -l | wc -l) -gt 0 ]
236 | prompt_segment black cyan "⚙"
237 | end
238 | end
239 |
240 | # `type -q` equivalent for fish<2.0.0
241 | function available -a name -d "Check if a function or program is available."
242 | type "$name" ^/dev/null >&2
243 | end
244 |
245 |
246 | #
247 | # Prompt
248 | #
249 | function fish_prompt
250 | set -g RETVAL $status
251 | prompt_status
252 | prompt_virtual_env
253 | prompt_user
254 | prompt_dir
255 | available hg; and prompt_hg
256 | available git; and prompt_git
257 | available svn; and prompt_svn
258 | prompt_finish
259 | end
260 |
--------------------------------------------------------------------------------
/integration/install.txt:
--------------------------------------------------------------------------------
1 | chips: fish plugin manager
2 | version 1.1.2
3 |
--------------------------------------------------------------------------------
/integration/plugin.yaml:
--------------------------------------------------------------------------------
1 | git:
2 | - https://github.com/simnalamburt/fish-sensible
3 | github:
4 | - simnalamburt/shellder
5 | - xtendo-org/friendly-engine
6 |
--------------------------------------------------------------------------------
/integration/removed.build.fish:
--------------------------------------------------------------------------------
1 | function chips; "/home/user/integration/chips" $argv; exec fish; end
2 |
--------------------------------------------------------------------------------
/integration/removed.yaml:
--------------------------------------------------------------------------------
1 | github:
2 | - xtendo-org/friendly-engine
3 |
--------------------------------------------------------------------------------
/integration/test.sh:
--------------------------------------------------------------------------------
1 | red='\e[31m'
2 | green='\e[32m'
3 | normal=$(tput sgr0)
4 |
5 | function _die {
6 | echo 'fail' > ./result.txt
7 | exit 1
8 | }
9 | function _assert {
10 | set -e
11 | export TMP=$1
12 | shift
13 | "$@" && echo -e "$green[ OK ]$normal "$TMP || (echo "$red[Fail]$normal "$TMP; _die)
14 | set +e
15 | }
16 |
17 | cd /home/user/integration
18 |
19 | echo "Scenario: Run chips without configuration"
20 | ./chips > ~/chips_initial_run.txt
21 | _assert "Run message" diff chips_initial_run.txt ~/chips_initial_run.txt
22 | _assert "plugin.yaml" diff default.plugin.yaml ~/.config/chips/plugin.yaml
23 |
24 | echo "Scenario: Run chips with configuration"
25 | cp plugin.yaml ~/.config/chips/plugin.yaml
26 | ./chips > ~/chips_config_run.txt
27 | head -n 2 ~/chips_config_run.txt > ~/chips_config_run_head.txt
28 | tail -n 3 ~/chips_config_run.txt > ~/chips_config_run_tail.txt
29 |
30 | _assert "Run message (1) header" diff install.txt ~/chips_config_run_head.txt
31 | _assert "Run message (2) Installing shellder..." grep -q ^Installing\ shellder...\$ ~/chips_config_run.txt
32 | _assert "Run message (3) Installing fish-sensible..." grep -q ^Installing\ fish-sensible...\$ ~/chips_config_run.txt
33 | _assert "Run message (4) Installing friendly-engine..." grep -q ^Installing\ friendly-engine...\$ ~/chips_config_run.txt
34 | _assert "Run message (5) Installed shellder." grep -q ^Installed\ shellder.\$ ~/chips_config_run.txt
35 | _assert "Run message (6) Installed fish-sensible." grep -q ^Installed\ fish-sensible.\$ ~/chips_config_run.txt
36 | _assert "Run message (7) Installed friendly-engine." grep -q ^Installed\ friendly-engine.\$ ~/chips_config_run.txt
37 | _assert "Run message (8) footer" diff chips_second_run_tail.txt ~/chips_config_run_tail.txt
38 |
39 | _assert "build.fish" diff build.fish ~/.config/chips/build.fish
40 | _assert "config.fish" diff config.fish ~/.config/fish/config.fish
41 | _assert "fish_prompt.fish" diff fish_prompt.fish ~/.config/fish/functions/fish_prompt.fish
42 |
43 | echo "Scenario: Uninstall plugins"
44 | cp removed.yaml ~/.config/chips/plugin.yaml
45 | ./chips > ~/chips_uninstall_run.txt
46 | _assert "No plugin in build.fish" diff removed.build.fish ~/.config/chips/build.fish
47 | _assert "fish_prompt.fish is removed" test ! -e ~/.config/fish/functions/fish_prompt.fish
48 |
49 | echo "success" > ./result.txt
50 |
--------------------------------------------------------------------------------
/package.yaml:
--------------------------------------------------------------------------------
1 | name: chips
2 | version: 1.1.2
3 | synopsis: A plugin manager for the fish shell
4 | description: Please see README.md
5 | category: Shell
6 | author: XT
7 | maintainer: e@xtendo.org
8 | copyright: 2015 XT et al.
9 | license: GPL-3
10 | license-file: LICENSE/chips
11 | github: xtendo-org/chips
12 | extra-source-files:
13 | - README.md
14 | - src/gnulinux/Platform.hs
15 | - src/osx/Platform.hs
16 | default-extensions:
17 | - TemplateHaskell
18 | - OverloadedStrings
19 | library:
20 | source-dirs: src
21 | default-extensions:
22 | - LambdaCase
23 | - MultiWayIf
24 | - RecordWildCards
25 | exposed-modules:
26 | - Lib
27 | - Utility
28 | - Platform
29 | - SelfUpdate
30 | - Config
31 | - Git
32 | - Spawn
33 | - Chips
34 | dependencies:
35 | - aeson
36 | - base
37 | - base64-bytestring
38 | - bytestring
39 | - cmdargs
40 | - rawfilepath
41 | - semver
42 | - template-haskell
43 | - text
44 | - unix
45 | - yaml
46 | when:
47 | - condition: os(linux)
48 | source-dirs: src/gnulinux
49 | - condition: os(osx)
50 | source-dirs: src/osx
51 | executables:
52 | chips:
53 | main: Main.hs
54 | source-dirs: app
55 | dependencies:
56 | - chips
57 | - base
58 | when:
59 | - condition: os(linux)
60 | ghc-options:
61 | - -Wall
62 | - -static
63 | - -threaded
64 | - -rtsopts
65 | # - -optl-pthread
66 | # - -optc-static
67 | # - -optl-static
68 | - condition: os(osx)
69 | ghc-options:
70 | - -Wall
71 | - -static
72 | - -threaded
73 | - -rtsopts
74 | tests:
75 | chips-test:
76 | main: Spec.hs
77 | source-dirs: test
78 | default-extensions:
79 | - LambdaCase
80 | - MultiWayIf
81 | - RecordWildCards
82 | ghc-options:
83 | - -threaded
84 | - -rtsopts
85 | - -with-rtsopts=-N
86 | dependencies:
87 | - hspec >=2.2.2 && <3
88 | - text >=1.2.2 && <2
89 | - chips
90 | - base
91 |
--------------------------------------------------------------------------------
/src/Chips.hs:
--------------------------------------------------------------------------------
1 | -- chips-specific codes
2 | module Chips where
3 |
4 | import Paths_chips
5 | import Data.Version
6 | import qualified Data.SemVer as SV
7 |
8 | import Data.List
9 |
10 | import Data.ByteString (ByteString)
11 | import qualified Data.ByteString.Builder as B
12 |
13 | import Utility
14 |
15 | chipsVer :: ByteString
16 | chipsVer = toByteString $
17 | mconcat $ intersperse "." $ map B.intDec $ versionBranch version
18 |
19 | chipsSemVer :: SV.Version
20 | chipsSemVer =
21 | $(let
22 | x : y : z : _ = versionBranch version
23 | in
24 | [| SV.version x y z [] [] |]
25 | )
26 |
--------------------------------------------------------------------------------
/src/Config.hs:
--------------------------------------------------------------------------------
1 | module Config
2 | ( decode
3 | , encode
4 | , Config(..)
5 | , templateConfig
6 | , gitURLs
7 | ) where
8 |
9 | import Data.Maybe
10 | import Data.Text (Text)
11 |
12 | import System.Exit
13 |
14 | import Data.Aeson.TH
15 | import qualified Data.Yaml as Y
16 |
17 | templateConfig :: Text
18 | templateConfig = "\
19 | \git:\n\
20 | \# Add Git clone URLs for fish plugins here.\n\
21 | \# For example, uncomment below to enable the fish-sensible plugin.\n\
22 | \# - https://github.com/simnalamburt/fish-sensible\n\
23 | \github:\n\
24 | \# Add GitHub repositories for fish plugins here.\n\
25 | \# For example, uncomment below to enable the fish-sensible plugin.\n\
26 | \# - simnalamburt/fish-sensible\n"
27 |
28 | data Config = Config
29 | { git :: Maybe [Text]
30 | , github :: Maybe [Text]
31 | }
32 | deriving Show -- DEBUG
33 |
34 | deriveJSON defaultOptions ''Config
35 |
36 | decode :: FilePath -> IO Config
37 | decode path = Y.decodeFileEither path >>=
38 | either (\ err -> die (errMsg ++ Y.prettyPrintParseException err)) return
39 | where
40 | errMsg = "Failed parsing " ++ path ++ ":\n"
41 |
42 | encode :: FilePath -> Config -> IO ()
43 | encode = Y.encodeFile
44 |
45 | gitURLs :: Config -> [Text]
46 | gitURLs (Config mgits mgithubs) = gits ++ githubURLs
47 | where
48 | gits = fromMaybe [] mgits
49 | githubs = fromMaybe [] mgithubs
50 | githubURLs = ["https://github.com/" <> url | url <- githubs]
51 |
--------------------------------------------------------------------------------
/src/File.hs:
--------------------------------------------------------------------------------
1 | module File
2 | ( basename
3 | , copyFile
4 | ) where
5 |
6 | import Control.Monad
7 | import Control.Exception
8 |
9 | import System.IO
10 |
11 | import Foreign.Marshal.Alloc (allocaBytes)
12 | import System.Posix.ByteString
13 |
14 | import qualified Data.ByteString as B
15 |
16 | copyFile :: RawFilePath -> RawFilePath -> IO ()
17 | copyFile srcPath tgtPath = do
18 | bracket ropen hClose $ \ hi ->
19 | bracket topen hClose $ \ ho ->
20 | allocaBytes bufferSize $ copyContents hi ho
21 | rename tmpPath tgtPath
22 | where
23 | ropen = openFd srcPath ReadOnly defaultFlags >>= fdToHandle
24 | topen = createFile tmpPath stdFileMode >>= fdToHandle
25 | tmpPath = tgtPath <> ".copyFile.tmp"
26 | copyContents hi ho buffer = do
27 | count <- hGetBuf hi buffer bufferSize
28 | when (count > 0) $ do
29 | hPutBuf ho buffer count
30 | copyContents hi ho buffer
31 |
32 | -- Buffer size for file copy
33 | bufferSize :: Int
34 | bufferSize = 4096
35 |
36 | defaultFlags :: OpenFileFlags
37 | defaultFlags = OpenFileFlags
38 | { append = False
39 | , creat = Just stdFileMode
40 | , exclusive = False
41 | , noctty = True
42 | , nonBlock = False
43 | , trunc = False
44 | , nofollow = False
45 | , cloexec = False
46 | , directory = False
47 | , sync = False
48 | }
49 |
50 | basename :: RawFilePath -> RawFilePath
51 | basename = snd . B.spanEnd (0x2F /=)
52 |
--------------------------------------------------------------------------------
/src/Git.hs:
--------------------------------------------------------------------------------
1 | module Git
2 | ( gitDir
3 | ) where
4 |
5 | import Data.Char
6 | import Data.Text (Text)
7 | import qualified Data.Text as T
8 |
9 | gitDir :: Text -> Maybe Text
10 | gitDir repoURL = if T.length s7 < 2 || T.head s7 == '/'
11 | then Nothing
12 | else Just s7
13 | where
14 | -- s1: repoURL with its scheme dropped.
15 | s1Broken = snd $ T.breakOn "://" repoURL
16 | s1 = if T.null s1Broken then repoURL else T.drop (T.length "://") s1Broken
17 | s2Taken = T.dropWhileEnd (/= '@') $ T.takeWhile (not . isPathSeparator) s1
18 | -- s2: s1 with the auth part dropped. Dropping the auth part is greedy:
19 | -- will drop until the last '@' before a path separator.
20 | s2 = T.drop (T.length s2Taken) s1
21 | -- s3: s2 with spaces and path separators at the end dropped.
22 | s3 = T.dropWhileEnd (\c -> c == ' ' || isPathSeparator c) s2
23 | -- s4: s3 with the ".git" at the end dropped, and more path separators
24 | -- dropped (if they are there).
25 | s4 = if ".git" `T.isSuffixOf` s3
26 | then T.dropWhileEnd isPathSeparator $ T.dropEnd (T.length ".git") s3
27 | else s3
28 | -- s5: if '/' is not in s4 AND ':' is in s4 AND the last part separated by
29 | -- ':' is all digits, it must be considered a port number for Git's
30 | -- backwards compatibility. Drop the colon and the port number.
31 | s5Digitless = T.dropWhileEnd isDigit s4
32 | s5 = if and
33 | [ not ('/' `isIn` s4)
34 | , ':' `isIn` s4
35 | , not (T.null s5Digitless)
36 | , T.last s5Digitless == ':'
37 | ]
38 | then T.init s5Digitless
39 | else s4
40 | -- s6: Find the last component of s5. ':' is also considered a separator.
41 | s6 = T.takeWhileEnd (\c -> not (isPathSeparator c) && c /= ':') s5
42 | -- s7: Drop ".bundle" or ".git"
43 | s7
44 | | ".git" `T.isSuffixOf` s6 = T.dropEnd (T.length ".git") s6
45 | | ".bundle" `T.isSuffixOf` s6 = T.dropEnd (T.length ".bundle") s6
46 | | otherwise = s6
47 |
48 | -- utility
49 |
50 | isIn :: Char -> Text -> Bool
51 | isIn c = T.any (c ==)
52 |
53 | -- TODO(XT): We can probably do better than this
54 | isPathSeparator :: Char -> Bool
55 | isPathSeparator = ('/' ==)
56 |
--------------------------------------------------------------------------------
/src/Lib.hs:
--------------------------------------------------------------------------------
1 | module Lib
2 | ( app
3 | ) where
4 |
5 | import Data.Maybe
6 | import Control.Monad
7 |
8 | import Data.Text (Text)
9 | import qualified Data.Text as T
10 | import qualified Data.Text.Encoding as T
11 | import qualified Data.Text.IO as T
12 | import Data.ByteString (ByteString)
13 | import qualified Data.ByteString.RawFilePath as B
14 | import Data.ByteString.Builder (Builder)
15 | import qualified Data.ByteString.Builder as B hiding (writeFile)
16 | import qualified Data.ByteString.Base64.URL as B64
17 |
18 | import System.Exit
19 | import System.IO
20 | import System.Environment (getExecutablePath)
21 | import System.IO.Error
22 |
23 | import System.Posix.Directory.ByteString (changeWorkingDirectory)
24 |
25 | import RawFilePath.Directory
26 |
27 | import Chips
28 | import File
29 | import Git
30 | import Platform
31 | import RawFilePath
32 | import SelfUpdate
33 | import Spawn
34 | import Utility
35 | import qualified Config as C
36 |
37 |
38 | data Plugin = Plugin
39 | { plugInit :: Maybe RawFilePath
40 | , plugPrompt :: Maybe RawFilePath
41 | , plugRight :: Maybe RawFilePath
42 | , plugFnc :: Maybe RawFilePath
43 | , plugCpl :: Maybe RawFilePath
44 | }
45 |
46 | -- Session configuration container. In other words,
47 | -- things that are set up in the beginning of execution and hardly change
48 | data Session = Session
49 | { fishPath :: RawFilePath
50 | , chipsPath :: RawFilePath
51 | , chipsConf :: C.Config
52 | , binPath :: RawFilePath
53 | }
54 |
55 | -- main execution functions
56 |
57 | app :: IO ()
58 | app = do
59 | bPutStr greetMsg
60 | fPath <- getAppDirectory "fish"
61 | cPath <- getAppDirectory "chips"
62 | execPath <- (byteString <$> getExecutablePath) >>= \ p ->
63 | if "/ghc" `B.isSuffixOf` p
64 | then (<> "/.local/bin/chips") <$> getHomeForce
65 | else return p
66 | let yamlPath = cPath <> "/plugin.yaml"
67 | doesFileExist yamlPath >>= \ yamlExists -> if yamlExists then do
68 | conf <- C.decode (T.unpack $ T.decodeUtf8 yamlPath)
69 | runSync Session
70 | { chipsPath = cPath
71 | , chipsConf = conf
72 | , fishPath = fPath
73 | , binPath = execPath
74 | }
75 | else do
76 | createDirectoryIfMissing True cPath
77 | T.writeFile (T.unpack $ T.decodeUtf8 yamlPath) C.templateConfig
78 | lPutStr
79 | [ "chips has just created the default configuration at:\n "
80 | , B.byteString yamlPath
81 | , "\nPlease edit the file and run chips again.\n"
82 | ]
83 | where
84 | getAppDirectory appName = fmap (\ x -> x <> "/.config/" <> appName) getHomeForce
85 | getHomeForce = fmap (fromMaybe (error "can't find $HOME?!")) getHomeDirectory
86 |
87 | runSync :: Session -> IO ()
88 | runSync Session{..} = do
89 | pluginsExist <- doesDirectoryExist pluginsDir
90 | unless pluginsExist $ createDirectoryIfMissing True pluginsDir
91 | changeWorkingDirectory pluginsDir
92 |
93 | -- Begin updating chips itself
94 | waitUpdate <- spawn $ do
95 | bPutStr "Checking update for chips...\n"
96 | checkUpdate "xtendo-org/chips" >>= \case
97 | AlreadyUpToDate -> return $ Left "chips is already up to date.\n"
98 | ExecutionFail err -> return $ Left $
99 | "chips self-update fail: " <> err
100 | UpdateNeeded tag -> return $ Right tag
101 |
102 | -- Concurrently deal with each entry of plugin.yaml
103 | plugResults <- fmap catMaybes $
104 | iParMapIO 50000 (dealPlug pluginsExist) $ C.gitURLs chipsConf
105 |
106 | -- Register or unregister themes
107 | createDirectoryIfMissing True functionsDir
108 | maybe (tryRemoveFile fishPromptPath) (`copyFileReport` fishPromptPath) $
109 | listToMaybe $ mapMaybe plugPrompt plugResults
110 | maybe (tryRemoveFile fishRightPath) (`copyFileReport` fishRightPath) $
111 | listToMaybe $ mapMaybe plugRight plugResults
112 |
113 | -- Create build.fish for plugins with init.fish
114 | B.withFile buildPath WriteMode $ \h -> B.hPutBuilder h $ mconcat $
115 | [ "function chips; \""
116 | , B.byteString binPath
117 | , "\" $argv; exec fish; end\n"
118 | ]
119 | <> map sourceInit (mapMaybe plugInit plugResults)
120 | lPutStr ["Build result saved at ", B.byteString buildPath, "\n"]
121 |
122 | -- Functions
123 | forM_ (mapMaybe plugFnc plugResults) $ \srcDir -> do
124 | files <- getDirectoryFilesRecursive srcDir
125 | forM_ files $ \path ->
126 | path `copyFileReport` (functionsDir <> "/" <> basename path)
127 |
128 | -- Add build.fish to config.fish
129 | tryIOError (B.readFile configFishPath) >>= \case
130 | Left e -> if isDoesNotExistError e
131 | then B.writeFile configFishPath chipsLineInConfig
132 | else ioError e
133 | Right configFish -> unless (sourceLine `B.isInfixOf` configFish) $ do
134 | B.appendFile configFishPath $ "\n" <> chipsLineInConfig
135 | lPutStr ["Added to ", B.byteString configFishPath, "\n"]
136 |
137 | -- Finish updating chips itself
138 | waitUpdate >>= \case
139 | Right tag -> do
140 | bPutStr "Updating chips itself...\n"
141 | updateResult <- runUpdate
142 | "xtendo-org/chips" tag ("chips_" <> platform) binPath
143 | case updateResult of
144 | Right _ -> lPutStr
145 | ["chips is updated to ", B.byteString tag, "\n"]
146 | Left e -> B.putStr e
147 | Left e -> B.putStr e
148 |
149 | where
150 | configFishPath = fishPath <> "/config.fish"
151 | pluginsDir = chipsPath <> "/dist"
152 | buildPath :: RawFilePath
153 | buildPath = chipsPath <> "/build.fish"
154 | functionsDir = fishPath <> "/functions"
155 | fishPromptPath = functionsDir <> "/fish_prompt.fish"
156 | fishRightPath = functionsDir <> "/fish_right_prompt.fish"
157 | sourceInit initPath = mconcat
158 | [ ". "
159 | , B.byteString $ pluginsDir <> "/" <> initPath
160 | , "\n"
161 | ]
162 | copyFileReport :: RawFilePath -> RawFilePath -> IO ()
163 | copyFileReport x y = x `copyFile` y >>
164 | lPutStr ["Copied ", B.byteString x, " to ", B.byteString y, "\n"]
165 |
166 |
167 | -- Take a Git URL, figure out what to do (install or upgrade), and do it.
168 | dealPlug :: Bool -> Text -> IO (Maybe Plugin)
169 | dealPlug pluginsExist url = do
170 | plugDirExists <- if not pluginsExist
171 | then return False
172 | else doesDirectoryExist dir
173 | if plugDirExists then do
174 | lPutStr ["Checking update for ", bDir, "...\n"]
175 | fetchResult <- callProcess $ proc "git" ["-C", dir, "fetch", "origin"]
176 | if fetchResult == ExitSuccess then do
177 | local <- readProcess "git" ["-C", dir, "rev-parse", "@{0}"]
178 | remote <- readProcess "git" ["-C", dir, "rev-parse", "@{u}"]
179 | if local == remote
180 | then lPutStr [bDir, " is already up to date.\n"] >> successWork
181 | else do
182 | resetResult <- callProcess $ proc "git"
183 | ["-C", dir, "reset", "--hard", "origin/master"]
184 | if resetResult == ExitSuccess
185 | then lPutStr [bDir, " is updated.\n"] >> successWork
186 | else lPutStr ["Failed updating ", bDir, "\n"] >> successWork
187 | else do
188 | lPutStr ["Failed checking update for ", bDir, ".\n"]
189 | -- Yes, checking update has failed, but the plugin still needs to
190 | -- be sourced! We run successWork anyway.
191 | successWork
192 | else do
193 | lPutStr ["Installing ", bDir, "...\n"]
194 | cloneResult <- callProcess $ proc "git"
195 | ["clone", "--depth=1", T.encodeUtf8 url, dir]
196 | if cloneResult == ExitSuccess then
197 | lPutStr ["Installed ", bDir, ".\n"] >> successWork
198 | else
199 | lPutStr ["Failed installing ", bDir, ".\n"] >> return Nothing
200 |
201 | where
202 | dir :: RawFilePath
203 | dir = maybe (B64.encode $ T.encodeUtf8 url) T.encodeUtf8 (gitDir url)
204 | bDir :: Builder
205 | bDir = B.byteString dir
206 | initFishPath = dir <> "/init.fish"
207 | promptPath = dir <> "/fish_prompt.fish"
208 | rightPath = dir <> "/fish_right_prompt.fish"
209 | fncPath = dir <> "/functions"
210 | cplPath = dir <> "/completions"
211 | successWork = do
212 | initExists <- doesFileExist initFishPath
213 | promptExists <- doesFileExist promptPath
214 | rightExists <- doesFileExist rightPath
215 | fncExists <- doesDirectoryExist fncPath
216 | cplExists <- doesDirectoryExist cplPath
217 | return $ Just Plugin
218 | { plugInit = if initExists then Just initFishPath else Nothing
219 | , plugPrompt = if promptExists then Just promptPath else Nothing
220 | , plugRight = if rightExists then Just rightPath else Nothing
221 | , plugFnc = if fncExists then Just fncPath else Nothing
222 | , plugCpl = if cplExists then Just cplPath else Nothing
223 | }
224 | readProcess cmd args = do
225 | (_, printed, _) <- readProcessWithExitCode $ proc cmd args
226 | return printed
227 |
228 | -- constant
229 |
230 | greetMsg :: Builder
231 | greetMsg = mconcat
232 | ["chips: fish plugin manager\nversion ", B.byteString chipsVer, "\n"]
233 |
234 | chipsLineInConfig :: ByteString
235 | chipsLineInConfig = "# chips" <> sourceLine
236 |
237 | sourceLine :: ByteString
238 | sourceLine = "\n\
239 | \if [ -e ~/.config/chips/build.fish ] ;\
240 | \ . ~/.config/chips/build.fish ; end\n"
241 |
--------------------------------------------------------------------------------
/src/SelfUpdate.hs:
--------------------------------------------------------------------------------
1 | module SelfUpdate
2 | ( checkUpdate
3 | , runUpdate
4 | , CheckResult(..)
5 | ) where
6 |
7 | import Control.Exception
8 |
9 | import Data.Maybe
10 | import Data.ByteString (ByteString)
11 | import qualified Data.ByteString.Char8 as B
12 | import qualified Data.Text.Encoding as T
13 | import Data.SemVer
14 |
15 | import System.Exit
16 | import System.IO
17 | import System.Posix.ByteString
18 |
19 | import Chips
20 | import RawFilePath.Process
21 |
22 | data CheckResult
23 | = ExecutionFail ByteString
24 | | AlreadyUpToDate
25 | | UpdateNeeded ByteString
26 | deriving Show -- debug
27 |
28 | msgRedirectParseFail :: ByteString
29 | msgRedirectParseFail = "\
30 | \failed parsing the GitHub releases page. \
31 | \Perhaps you need to manually upgrade.\n"
32 |
33 | -- Update the binary executable file itself.
34 | checkUpdate :: ByteString -> IO CheckResult
35 | checkUpdate repo = getLatest >>= \case
36 | Right redirectRsp -> return $ versionCmp $ searchTag redirectRsp
37 | Left err -> return $ ExecutionFail err
38 | where
39 | searchTag = B.takeWhile (\ c -> c /= '\r' && c /= '\n') .
40 | B.drop (B.length locationHeader) .
41 | snd . B.breakSubstring locationHeader
42 | versionCmp r
43 | | r == "" = ExecutionFail msgRedirectParseFail
44 | | r == chipsVer = AlreadyUpToDate
45 | | otherwise = mtag r
46 | mtag tagB = fromMaybe (ExecutionFail msgRedirectParseFail) $ do
47 | tag <- eitherToMaybe (T.decodeUtf8' tagB)
48 | targetSemVer <- eitherToMaybe (fromText tag)
49 | return $ if chipsSemVer < targetSemVer
50 | then UpdateNeeded tagB else AlreadyUpToDate
51 | eitherToMaybe :: Either e a -> Maybe a
52 | eitherToMaybe = either (const Nothing) Just
53 | locationHeader =
54 | "\nLocation: https://github.com/" <> repo <> "/releases/tag/"
55 | getLatest = do
56 | (code, normalMsg, errMsg) <- readProcessWithExitCode $ proc "curl"
57 | [ "-D", "-", "-o", "/dev/null"
58 | , "https://github.com/" <> repo <> "/releases/latest"
59 | ]
60 | case code of
61 | ExitSuccess -> return $ Right normalMsg
62 | _ -> return $ Left errMsg
63 |
64 | runUpdate
65 | :: ByteString -> ByteString -> ByteString -> RawFilePath
66 | -> IO (Either ByteString ByteString)
67 | runUpdate repo tag assetName path = getAsset >>= \case
68 | Right bin -> bracket topen hClose $ \ h -> do
69 | B.hPut h bin
70 | hClose h
71 | rename tmpPath path
72 | return $ Right tag
73 | Left err -> return $ Left err
74 | where
75 | getAsset = do
76 | (code, asset, errMsg) <- readProcessWithExitCode $
77 | proc "curl" ["-L", assetURL]
78 | case code of
79 | ExitSuccess -> return $ Right asset
80 | _ -> return $ Left errMsg
81 | topen = createFile tmpPath ownerExecuteMode >>= fdToHandle
82 | tmpPath = path <> ".copyFile.tmp"
83 | assetURL :: ByteString
84 | assetURL = mconcat
85 | [ "https://github.com/" <> repo <> "/releases/download/"
86 | , tag
87 | , "/"
88 | , assetName
89 | ]
90 |
--------------------------------------------------------------------------------
/src/Spawn.hs:
--------------------------------------------------------------------------------
1 | module Spawn
2 | ( spawn
3 | , Result
4 | , spawnTry
5 | , parMapIO
6 | , iParMapIO
7 | ) where
8 |
9 | import Control.Concurrent
10 | import Control.Exception
11 |
12 | type Result a = Either SomeException a
13 |
14 | spawnTry :: IO a -> IO (IO (Result a))
15 | spawnTry m = do
16 | v <- newEmptyMVar
17 | _ <- mask $ \restore -> forkIO (try (restore m) >>= putMVar v)
18 | return (readMVar v)
19 |
20 | spawn :: IO a -> IO (IO a)
21 | spawn m = do
22 | r <- spawnTry m
23 | return (r >>= either throwIO return)
24 |
25 | parMapIO :: (a -> IO b) -> [a] -> IO [b]
26 | parMapIO f xs = mapM (spawn . f) xs >>= sequence
27 |
28 | -- Parallel mapIO with interval. Instead of bursting out all threads at once,
29 | -- this function will let one by one, each sleeping for a different span of
30 | -- time, to avoid resource burst and hitting the rate limit.
31 | iParMapIO :: Int -> (a -> IO b) -> [a] -> IO [b]
32 | iParMapIO
33 | interval -- The interval
34 | f -- The IO action
35 | xs -- The list of arguments to be passed to each thread
36 | = mapM (spawn . delay f) (zip xs [interval, interval * 2 ..]) >>= sequence
37 | where
38 | delay action (arg, wait) = threadDelay wait *> action arg
39 |
--------------------------------------------------------------------------------
/src/Utility.hs:
--------------------------------------------------------------------------------
1 | module Utility where
2 |
3 | import Data.ByteString (ByteString)
4 | import Data.ByteString.Lazy as LB (toStrict)
5 | import Data.ByteString.Builder (Builder)
6 | import qualified Data.ByteString.Builder as B
7 |
8 | import System.IO
9 |
10 | bPutStr :: Builder -> IO ()
11 | bPutStr = B.hPutBuilder stdout
12 |
13 | lPutStr :: [Builder] -> IO ()
14 | lPutStr = bPutStr . mconcat
15 |
16 | toByteString :: Builder -> ByteString
17 | toByteString = LB.toStrict . B.toLazyByteString
18 |
19 | byteString :: String -> ByteString
20 | byteString = toByteString . B.stringUtf8
21 |
--------------------------------------------------------------------------------
/src/gnulinux/Platform.hs:
--------------------------------------------------------------------------------
1 | module Platform where
2 |
3 | import Data.ByteString (ByteString)
4 |
5 | platform :: ByteString
6 | platform = "gnulinux"
7 |
--------------------------------------------------------------------------------
/src/osx/Platform.hs:
--------------------------------------------------------------------------------
1 | module Platform where
2 |
3 | import Data.ByteString (ByteString)
4 |
5 | platform :: ByteString
6 | platform = "osx"
7 |
--------------------------------------------------------------------------------
/stack.yaml:
--------------------------------------------------------------------------------
1 | flags: {}
2 | extra-package-dbs: []
3 | packages:
4 | - '.'
5 | extra-deps: []
6 | resolver: nightly-2023-09-03
7 |
--------------------------------------------------------------------------------
/test/Spec.hs:
--------------------------------------------------------------------------------
1 | import qualified Data.Text as T
2 |
3 | import Test.Hspec
4 |
5 | import Git
6 |
7 | main :: IO ()
8 | main = hspec $ do
9 | describe "Git.gitDir" $ do
10 | testGitDir "/foo/bar:2222.git" "2222"
11 | testGitDir "git@github.com:kinoru/chips.git" "chips"
12 | testGitDir "https://github.com/kinoru/chips.git" "chips"
13 | testGitDir "git://multiple@auth@kinoru/chips.git/ " "chips"
14 | where
15 | testGitDir repo dir = it
16 | (T.unpack $ mconcat ["returns ", dir, " from ", repo]) $
17 | gitDir repo `shouldBe` Just dir
18 |
--------------------------------------------------------------------------------