gantty:0.5.0 (#3289)

Author: John-Toohey

packages/preview/gantty/0.5.0/CHANGELOG.md

@@ -0,0 +1,89 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.0]
+
+### Added
+
+- Task dependencies under the `dependencies` field.
+- Drawers API to allow complete customization of various parts of the Gantt
+  chart. This decision was made because there are many different ways of drawing
+  dependencies (and, in fairness, many other parts of the Gantt chart) and
+  because it will integrate better with show/set rules when they are available
+  for custom elements.
+- The `drawers.default-drawer` dictionary containing the default drawer
+- An `x` field to intervals, tasks, milestones, and dependencies: to facilitate
+  adding custom descriptions for custom drawers.
+- Expose the following functions under the `util` namespace: `EPSILON`, `rects-intersect`,
+  `content-if-fits`, `task-anchor`, `task-anchor-line`, `task-anchor-sidebar`,
+  `id-level`, `styles-for-level`, `styles-for-id`, `foreach-task`, `task-start`,
+  `task-end`, `gantt-range`, `date-ratio`, `date-x-coord`, and `date-coord`.
+- Ability to provide a function to change how the sidebar items are styled.
+- Hide a milestone's date with `milestone.show-date`.
+
+### Changed
+
+- The `taskgroups` key is now `tasks`
+- The `tasks` key is now `subtasks`. All tasks can have subtasks.
+- Tasks are now drawn with rectangles, not lines.
+
+### Fixed
+
+- Poor normalization of the `today` milestone
+
+### Removed
+
+- The `style` key.
+- The `viewport-snap` key. Specify a `start` and `end` date instead.
+- Nameless tasks.
+- The `show-today` and `today-localized` keys. These should be configured on the
+  milestone drawer instead.
+
+## [0.4.0]
+
+### Added
+
+- The `intervals` field to task to allow for specifying multiple intervals in
+  which as task is valid.
+- You can now manually specify interviews for a taskgroup
+
+### Changed
+
+- `form-well` is now called `normalize-gantt`
+- The `normalize-gantt` function now parses all datetimes as well.
+- Update `cetz`
+
+### Fixed
+
+- Certain properties on `block` and `baseline` causing messed up gridlines
+
+## [0.3.0]
+
+### Added
+
+- The `today-localized` field to change the translation of "Today".
+- Documented the package.
+- The `create-header`, `create-custom-year-header`, `create-custom-month-header`,
+  `create-custom-day-header`, and `create-custom-week-header`.
+- The ability for anonymous taskgroups
+
+## [0.2.1]
+
+### Fixed
+
+- Days overrunning the header.
+
+## [0.2.0] - 2025-03-06
+
+### Added
+
+- Support for custom start end and dates.
+
+### Fixed
+
+- A floating point precision error causing milestones to fail to resolve.
+- A typo in the documentation.

packages/preview/gantty/0.5.0/LICENSE

@@ -0,0 +1,163 @@
+GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the terms
+and conditions of version 3 of the GNU General Public License, supplemented
+by the additional permissions listed below.
+
+   0. Additional Definitions.
+
+      
+
+As used herein, "this License" refers to version 3 of the GNU Lesser General
+Public License, and the "GNU GPL" refers to version 3 of the GNU General Public
+License.
+
+      
+
+"The Library" refers to a covered work governed by this License, other than
+an Application or a Combined Work as defined below.
+
+      
+
+An "Application" is any work that makes use of an interface provided by the
+Library, but which is not otherwise based on the Library. Defining a subclass
+of a class defined by the Library is deemed a mode of using an interface provided
+by the Library.
+
+      
+
+A "Combined Work" is a work produced by combining or linking an Application
+with the Library. The particular version of the Library with which the Combined
+Work was made is also called the "Linked Version".
+
+      
+
+The "Minimal Corresponding Source" for a Combined Work means the Corresponding
+Source for the Combined Work, excluding any source code for portions of the
+Combined Work that, considered in isolation, are based on the Application,
+and not on the Linked Version.
+
+      
+
+The "Corresponding Application Code" for a Combined Work means the object
+code and/or source code for the Application, including any data and utility
+programs needed for reproducing the Combined Work from the Application, but
+excluding the System Libraries of the Combined Work.
+
+   1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License without
+being bound by section 3 of the GNU GPL.
+
+   2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a facility
+refers to a function or data to be supplied by an Application that uses the
+facility (other than as an argument passed when the facility is invoked),
+then you may convey a copy of the modified version:
+
+a) under this License, provided that you make a good faith effort to ensure
+that, in the event an Application does not supply the function or data, the
+facility still operates, and performs whatever part of its purpose remains
+meaningful, or
+
+b) under the GNU GPL, with none of the additional permissions of this License
+applicable to that copy.
+
+   3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a header
+file that is part of the Library. You may convey such object code under terms
+of your choice, provided that, if the incorporated material is not limited
+to numerical parameters, data structure layouts and accessors, or small macros,
+inline functions and templates (ten or fewer lines in length), you do both
+of the following:
+
+a) Give prominent notice with each copy of the object code that the Library
+is used in it and that the Library and its use are covered by this License.
+
+b) Accompany the object code with a copy of the GNU GPL and this license document.
+
+   4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken together,
+effectively do not restrict modification of the portions of the Library contained
+in the Combined Work and reverse engineering for debugging such modifications,
+if you also do each of the following:
+
+a) Give prominent notice with each copy of the Combined Work that the Library
+is used in it and that the Library and its use are covered by this License.
+
+b) Accompany the Combined Work with a copy of the GNU GPL and this license
+document.
+
+c) For a Combined Work that displays copyright notices during execution, include
+the copyright notice for the Library among these notices, as well as a reference
+directing the user to the copies of the GNU GPL and this license document.
+
+      d) Do one of the following:
+
+0) Convey the Minimal Corresponding Source under the terms of this License,
+and the Corresponding Application Code in a form suitable for, and under terms
+that permit, the user to recombine or relink the Application with a modified
+version of the Linked Version to produce a modified Combined Work, in the
+manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
+
+1) Use a suitable shared library mechanism for linking with the Library. A
+suitable mechanism is one that (a) uses at run time a copy of the Library
+already present on the user's computer system, and (b) will operate properly
+with a modified version of the Library that is interface-compatible with the
+Linked Version.
+
+e) Provide Installation Information, but only if you would otherwise be required
+to provide such information under section 6 of the GNU GPL, and only to the
+extent that such information is necessary to install and execute a modified
+version of the Combined Work produced by recombining or relinking the Application
+with a modified version of the Linked Version. (If you use option 4d0, the
+Installation Information must accompany the Minimal Corresponding Source and
+Corresponding Application Code. If you use option 4d1, you must provide the
+Installation Information in the manner specified by section 6 of the GNU GPL
+for conveying Corresponding Source.)
+
+   5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library side
+by side in a single library together with other library facilities that are
+not Applications and are not covered by this License, and convey such a combined
+library under terms of your choice, if you do both of the following:
+
+a) Accompany the combined library with a copy of the same work based on the
+Library, uncombined with any other library facilities, conveyed under the
+terms of this License.
+
+b) Give prominent notice with the combined library that part of it is a work
+based on the Library, and explaining where to find the accompanying uncombined
+form of the same work.
+
+   6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions of the
+GNU Lesser General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to address
+new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library as you
+received it specifies that a certain numbered version of the GNU Lesser General
+Public License "or any later version" applies to it, you have the option of
+following the terms and conditions either of that published version or of
+any later version published by the Free Software Foundation. If the Library
+as you received it does not specify a version number of the GNU Lesser General
+Public License, you may choose any version of the GNU Lesser General Public
+License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide whether
+future versions of the GNU Lesser General Public License shall apply, that
+proxy's public statement of acceptance of any version is permanent authorization
+for you to choose that version for the Library.

packages/preview/gantty/0.5.0/README.md

@@ -0,0 +1,91 @@
+# Gantty
+
+Gantty is a typst library for creating Gantt charts using datetimes.
+
+View the manual [here](https://john_t.gitlab.io/typst-gantty/manual.pdf).
+
+## Features
+
+- Works with real dates.
+- Customizable styling.
+- Extensible to support multiple languages.
+
+## Why not typst-timeliney
+
+[Typst-timeliney](https://typst.app/universe/package/timeliney) is another
+excellent typst Gantt chart creator. The main differences between this library
+and typst-timeliney is that Gantty uses datetimes to work with real dates,
+whereas typst-timeliney works with coordinates. Look at the typst-timeliney
+documentation and decide which is more fitting for your use.
+
+## Examples
+
+![A Gantt chart](https://gitlab.com/john_t/typst-gantty/-/raw/master/example/gantt.svg)
+
+index.typ:
+
+```typst
+#import "@preview/gantty:0.5.0": gantt
+
+#gantt(yaml("gantt.yaml"))
+```
+
+Here, the orange is used to indicate a task completed late and the green is used
+to indicate a task that has been completed.
+
+gantt.yaml:
+
+```yaml
+show-today: true
+# Either month or day
+viewport-snap: day
+# Can include `year`, `month`, `week`, or `day`
+headers:
+  - month
+  - week
+# A start date. Not required.
+start: 2024-11-01
+# An end date. Not required.
+end: 2025-03-31
+taskgroups:
+  - name: Research
+    tasks:
+      - name: Read Statements
+        start: 2024-11-27
+        end: 2024-12-04
+        done: 2024-11-29
+  - name: Drafting
+    tasks:
+      - name: α draft
+        start: 2024-12-12
+        end: 2024-12-31
+      - name: β draft
+        start: 2024-12-31
+        end: 2025-01-31
+      - name: First draft
+        start: 2025-01-31
+        end: 2025-02-14
+      - name: γ draft
+        start: 2025-02-14
+        end: 2025-03-07
+      - name: Final Draft
+        start: 2025-03-07
+        end: 2025-03-24
+  - name: Production Log
+    tasks:
+        - name: Record initial ideas
+          start: 2024-11-27
+          end: 2024-12-04
+          done: 2024-12-08
+milestones:
+  - name: 1st Draft Hand In
+    date: 2025-02-14
+  - name: Final Hand In
+    date: 2025-03-24
+```
+
+## Styling
+
+Gantty is very customizable. Here is the `test/serious-depepdencies` example:
+
+![A Gantt chart with dependencies](https://gitlab.com/john_t/typst-gantty/-/raw/master/tests/serious-dependencies/ref/1.png)

packages/preview/gantty/0.5.0/src/datetime.typ

@@ -0,0 +1,47 @@
+/// Gets the length of the month in the datetime.
+///
+/// Note: this functions is made public only for niche usecases.
+/// In all likelihood if you are using this you are probably using
+/// `create-custom-header` instead of `create-custom-month-header`
+/// -> function
+#let month-length(
+  /// A datetime for specific month (only year and month are used).
+  /// -> datetime
+  datetime,
+) = {
+  let year = datetime.year()
+  let month = datetime.month()
+
+  let leap-year = (
+    (
+      (calc.rem(year, 4) == 0) and not (calc.rem(year, 100) == 0)
+    )
+      or calc.rem(year, 400) == 0
+  )
+
+  let feb = if leap-year {
+    29
+  } else {
+    28
+  }
+
+  (31, feb, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31).at(month - 1)
+}
+
+/// Parse an iso8601 datetime
+///
+/// Passes through actual datetime objects
+#let parse-datetime(s) = {
+  if type(s) == datetime {
+    s
+  } else {
+    datetime(year: int(s.slice(0, 4)), month: int(s.slice(5, 7)), day: int(
+      s.slice(8, 10),
+    ))
+  }
+}
+
+/// Gets the dat before the given datetime
+#let yesterday(dt) = {
+  dt - duration(days: 1)
+}