Skip to content

Commit af2910d

Browse files
laurmaedjelaurmaedje
committed
More guidelines
1 parent c63995d commit af2910d

File tree

5 files changed

+244
-16
lines changed

5 files changed

+244
-16
lines changed

‎LICENSE

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎README.md

+33-11
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,37 @@ You must always specify the full package version.
66
## Package format
77
A package is a collection of Typst files and assets that can be imported as a
88
unit. A `typst.toml` manifest with metadata is required at the root of a
9-
package. The manifest format is as follows:
9+
package. An example manifest could look like this:
1010

1111
```toml
1212
[package]
1313
name = "example"
1414
version = "0.1.0"
15-
entrypoint = "lib.typ"
15+
authors = ["The Typst Project Developers"]
16+
license = "Unlicense"
1617
description = "An example package."
18+
entrypoint = "lib.typ"
1719
```
1820

1921
Keys:
2022
- `name`: The package's identifier in its namespace.
2123
- `version`: The package's version as a full major-minor-patch triple.
2224
Package versioning should follow [SemVer].
25+
- `authors`: A list of the package's authors.
26+
- `license`: The package's license. Must contain a valid SPDX-2 expression
27+
describing one or multiple [OSI-approved][OSI] licenses.
28+
- `description`: A short description of the package.
2329
- `entrypoint`: The path to the main Typst file that is evaluated when the
2430
package is imported.
25-
- `description`: A short description of the package.
2631

27-
Packages always live in folders named as `{name}-{version}`. The name and
28-
version in the folder name and manifest must match.
32+
Although all keys are required for submission into this repository, only `name`,
33+
`version`, and `entrypoint` are required by the compiler and thus for local
34+
packages.
2935

30-
Paths in a package are local to that package. Absolute paths start in the
31-
package root while relative paths are relative to the file they are used in.
36+
Packages always live in folders named as `{name}-{version}`. The name and
37+
version in the folder name and manifest must match. Paths in a package are local
38+
to that package. Absolute paths start in the package root while relative paths
39+
are relative to the file they are used in.
3240

3341
## Published packages
3442
This repository contains a collection of published packages. Due to its early
@@ -44,13 +52,20 @@ detailed below:
4452
- **Naming:** Names should not include the word "typst" (as it is redundant).
4553
They should also not be merely descriptive to create level grounds for
4654
everybody (e.g. not just `slides`).
47-
- **Documentation:** Packages should contain a `README.md` file documenting (at
48-
least briefly) what the package does and what definitions it exports.
55+
- **Functionality:** Packages should conceivably be useful to other users
56+
and should expose their capabilities in a reasonable fashion.
57+
- **Documentation:** Packages must contain a `README.md` file documenting (at
58+
least briefly) what the package does and all definitions intended for
59+
usage by downstream users.
60+
- **License:** Packages must be licensed under the terms of an
61+
[OSI-approved][OSI] license. In addition to specifying the license in the
62+
TOML manifest, a package must either contain a `LICENSE` file or link to one
63+
in its `README.md`.
4964
- **Size:** Packages should not contain large files or a large number of files.
5065
This will be judged on a case-by-case basis, but if it needs more than ten
5166
files, it should be well-motivated.
52-
- **License:** Packages must be licensed under the terms of an OSI-approved
53-
license.
67+
- **Security:** Packages must not attempt to exploit the compiler or packaging
68+
implementation, in particular not to exfiltrate user data.
5469
- **Safety:** Names and package contents must be safe for work.
5570

5671
This list may be extended over time as improvements/issues to the process are
@@ -92,4 +107,11 @@ system packages is `local`:
92107
Note that future iterations of Typst's package management may change/break this
93108
local setup.
94109

110+
111+
## License
112+
The infrastructure around the package repository is licensed under the terms of
113+
the Apache-2.0 license. Packages in `packages/` are licensed under their
114+
respective license.
115+
95116
[SemVer]: https://semver.org/lang/de/
117+
[OSI]: https://opensource.org/licenses/

‎bundler/src/main.rs

+8-4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ fn process_package(path: &Path) -> anyhow::Result<IndexEntry> {
4343
Ok(IndexEntry {
4444
name: package.name,
4545
version: package.version,
46+
license: package.license,
4647
description: package.description,
4748
})
4849
}
@@ -95,23 +96,26 @@ fn write_archive(info: &PackageInfo, buf: &[u8]) -> anyhow::Result<()> {
9596

9697
/// A parsed package manifest.
9798
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
98-
pub struct PackageManifest {
99+
struct PackageManifest {
99100
package: PackageInfo,
100101
}
101102

102103
/// The `package` key in the manifest.
103104
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
104-
pub struct PackageInfo {
105+
struct PackageInfo {
105106
name: String,
106107
version: String,
107-
entrypoint: String,
108+
authors: Vec<String>,
109+
license: String,
108110
description: String,
111+
entrypoint: String,
109112
}
110113

111114
/// An entry in the package index.
112115
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
113-
pub struct IndexEntry {
116+
struct IndexEntry {
114117
name: String,
115118
version: String,
119+
license: String,
116120
description: String,
117121
}

‎packages/preview/example-0.1.0/LICENSE

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <http://unlicense.org/>

‎packages/preview/example-0.1.0/typst.toml

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[package]
22
name = "example"
33
version = "0.1.0"
4-
entrypoint = "lib.typ"
4+
authors = ["The Typst Project Developers"]
5+
license = "Unlicense"
56
description = "An example package."
7+
entrypoint = "lib.typ"

0 commit comments

Comments
 (0)