Skip to content

Commit 060cb45

Browse files
mxclmxcl
committedJan 9, 2025··
.some(ts)
·
v0.10.1latest
1 parent 1ce91f3 commit 060cb45

File tree

7 files changed

+601
-0
lines changed

7 files changed

+601
-0
lines changed
 

‎.github/workflows/cd.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: cd
2+
3+
on:
4+
release:
5+
types:
6+
- published
7+
8+
concurrency:
9+
group: cd/${{ github.event.release.tag_name }}
10+
cancel-in-progress: true
11+
12+
jobs:
13+
retag:
14+
permissions:
15+
contents: write
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
- uses: fischerscode/tagger@v0
20+
with:
21+
prefix: v
22+
- run: |
23+
git tag -f latest
24+
git push origin latest --force
25+
26+
publish:
27+
permissions:
28+
pages: write
29+
id-token: write
30+
contents: write
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/checkout@v4
34+
35+
- name: gather prefix-less version string
36+
run: |
37+
V=${{ github.event.release.tag_name }}
38+
V=${V:1}
39+
echo "V=$V" >> $GITHUB_ENV
40+
41+
- run: |
42+
sed -i -E "s/\"pkgm 0\\.0\\.0\\+dev\"/\"pkgm $V\"/g" pkgm.ts
43+
mv pkgm.ts pkgm
44+
tar czf pkgm-$V.tgz pkgm
45+
46+
- uses: pkgxdev/setup@v2
47+
- name: verify `pkgm --version`
48+
run: test "$(./pkgm --version)" = "pkgm $V"
49+
50+
- run:
51+
gh release upload --clobber ${{ github.event.release.tag_name }} pkgm-$V.tgz
52+
env:
53+
GITHUB_TOKEN: ${{ github.token }}
54+
55+
- run: |
56+
mkdir out
57+
mv pkgm out/pkgm.ts
58+
echo $V > out/version.txt
59+
60+
- uses: actions/configure-pages@v4
61+
- uses: actions/upload-pages-artifact@v3
62+
with:
63+
path: out/
64+
- uses: actions/deploy-pages@v4

‎.github/workflows/ci.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
concurrency:
10+
group: ${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
lint:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: denolib/setup-deno@v2
19+
with:
20+
deno-version: v2.x
21+
- run: deno fmt --check .
22+
- run: deno lint .
23+
- run: deno check ./pkgm.ts

‎.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"deno.enable": true
3+
}

‎LICENSE.txt

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2022–23 pkgx inc.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# `pkgm`
2+
3+
Install `pkgx` packages to `/usr/local`.
4+
5+
> [!WARNING] `pkgm` is new software. Please report any issues you encounter and
6+
> try it out in parallel with your current package manager.
7+
8+
## Usage
9+
10+
```sh
11+
$ pkgm install git
12+
# ^^ installs latest git
13+
14+
$ pkgm install git@2.41
15+
# ^^ installs git^2.41 or switches out the installed git to 2.41
16+
17+
$ pkgm uninstall git
18+
19+
$ pkgm list
20+
# ^^ lists what is installed
21+
22+
$ pkgm outdated
23+
# ^^ lists outdated installations
24+
25+
$ pkgm update
26+
# ^^ updates installed packages to latest versions
27+
28+
$ pkgm pin git
29+
# ^^ prevents the installed git from being updated
30+
31+
$ pkgm install git@2.43 --pin
32+
# installs and pins git^2.43
33+
34+
$ pkgm stub git
35+
# uninstalls git and installs stubs into bin instead
36+
# see docs below for more info
37+
```
38+
39+
> [!NOTE]
40+
>
41+
> Commands call `sudo` as needed.
42+
43+
> [!TIP]
44+
>
45+
> - `pkgm i` is an alias for `pkgm install`
46+
> - `pkgm rm` is an alias for `pkgm uninstall`
47+
> - `pkgm ls` is an alias for `pkgm list`
48+
> - `pkgm up` is an alias for `pkgm update`
49+
50+
## Installation
51+
52+
```sh
53+
sh <(curl https://pkgx.sh)
54+
```
55+
56+
## Uninstallation
57+
58+
```sh
59+
sudo rm /usr/local/bin/pkgm /usr/local/bin/pkgx
60+
```
61+
62+
# Intricacies
63+
64+
1. Packages are installed via `pkgx` to `~/.pkgx`
65+
2. We then `sudo` hard-link them to `/usr/local/pkgs`
66+
3. We then symlink the hard-links to `/usr/local`
67+
68+
# Advantages Over Homebrew
69+
70+
- Blazingly fast
71+
- Install specific versions of any pkg
72+
- You install by executable name—thus you _don’t have to do a search first_
73+
- Installed packages are installed as `root`
74+
75+
# `pkgm stub`
76+
77+
For larger packages or packages with large dependency trees, installing packages
78+
pollutes your system with hundreds of files. To avoid this, you can install a
79+
stub instead.
80+
81+
Stubs are tiny shell scripts that invoke the tool via `pkgx` instead. Generally
82+
this works well. Sometimes it does not however hence it just an option.

‎pkgm.ts

+227
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
#!/usr/bin/env -S pkgx deno^2.1 run --ext=ts --allow-run=pkgx,/usr/bin/sudo --allow-env=PKGX_DIR,HOME --allow-read=/usr/local/pkgs
2+
import { dirname, fromFileUrl, join } from "jsr:@std/path";
3+
import { ensureDir, existsSync } from "jsr:@std/fs";
4+
import { parse as parse_args } from "jsr:@std/flags";
5+
import * as semver from "jsr:@std/semver";
6+
7+
const parsedArgs = parse_args(Deno.args, {
8+
alias: {
9+
v: "version",
10+
h: "help",
11+
p: "pin",
12+
},
13+
boolean: ["help", "version", "pin"],
14+
});
15+
16+
if (parsedArgs.help) {
17+
const status = await new Deno.Command("pkgx", {
18+
args: ["gh", "repo", "view", "pkgxdev/pkgm"],
19+
clearEnv: true,
20+
env: {
21+
"PATH": "/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin",
22+
"HOME": Deno.env.get("HOME")!,
23+
},
24+
}).spawn().status;
25+
Deno.exit(status.code);
26+
} else if (parsedArgs.version) {
27+
console.log("pkgm 0.0.0+dev");
28+
} else {
29+
const args = parsedArgs._.map((x) => `${x}`).slice(1);
30+
31+
switch (parsedArgs._[0]) {
32+
case "install":
33+
case "i":
34+
await install(args);
35+
break;
36+
case "uninstall":
37+
case "rm":
38+
case "list":
39+
case "ls":
40+
case "up":
41+
case "update":
42+
case "pin":
43+
case "outdated":
44+
case "stub":
45+
console.error("%cunimplemented. soz. U EARLY.", "color: red");
46+
Deno.exit(1);
47+
break;
48+
case "sudo-install": {
49+
const [pkgx_dir, ...paths] = args;
50+
await sudo_install(pkgx_dir, paths);
51+
break;
52+
}
53+
default:
54+
console.error("invalid usage");
55+
Deno.exit(2);
56+
}
57+
}
58+
59+
async function install(args: string[]) {
60+
if (args.length === 0) {
61+
console.error("no packages specified");
62+
Deno.exit(1);
63+
}
64+
65+
args = args.map((x) => `+${x}`);
66+
67+
const env: Record<string, string> = {
68+
"PATH": "/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin",
69+
};
70+
const set = (key: string) => {
71+
const x = Deno.env.get(key);
72+
if (x) env[key] = x;
73+
};
74+
set("HOME");
75+
set("PKGX_DIR");
76+
77+
const proc = new Deno.Command("pkgx", {
78+
args: [...args, "--json"],
79+
stdout: "piped",
80+
env,
81+
clearEnv: true,
82+
})
83+
.spawn();
84+
85+
let status = await proc.status;
86+
87+
if (!status.success) {
88+
Deno.exit(status.code);
89+
}
90+
91+
const out = await proc.output();
92+
const json = JSON.parse(new TextDecoder().decode(out.stdout));
93+
// deno-lint-ignore no-explicit-any
94+
const pkg_prefixes = json.pkgs.map((x: any) => `${x.project}/v${x.version}`);
95+
96+
const to_install = [];
97+
for (const prefix of pkg_prefixes) {
98+
if (!existsSync(join("/usr/local/pkgs", prefix))) {
99+
to_install.push(prefix);
100+
}
101+
}
102+
103+
if (to_install.length === 0) {
104+
console.error("pkgs already installed");
105+
Deno.exit(0);
106+
}
107+
108+
const self = fromFileUrl(import.meta.url);
109+
const pkgx_dir = Deno.env.get("PKGX_DIR") || `${Deno.env.get("HOME")}/.pkgx`;
110+
111+
status = await new Deno.Command("/usr/bin/sudo", {
112+
args: [
113+
"pkgx",
114+
"deno^2.1",
115+
"run",
116+
"--ext=ts",
117+
"--allow-write", // cannot be qualified ∵ `Deno.link()` requires full access for some reason
118+
`--allow-read`, // same ^^ 😕
119+
self,
120+
"sudo-install",
121+
pkgx_dir,
122+
...to_install,
123+
],
124+
env,
125+
clearEnv: true,
126+
})
127+
.spawn().status;
128+
129+
Deno.exit(status.code);
130+
}
131+
132+
async function sudo_install(pkgx_dir: string, pkg_prefixes: string[]) {
133+
const dst = "/usr/local";
134+
for (const pkg_prefix of pkg_prefixes) {
135+
// create /usr/local/pkgs/${prefix}
136+
await mirror_directory("/usr/local/pkgs", pkgx_dir, pkg_prefix);
137+
// symlink /usr/local/pkgs/${prefix} to /usr/local
138+
await symlink(join("/usr/local/pkgs", pkg_prefix), dst);
139+
// create v1, etc. symlinks
140+
await create_v_symlinks(join("/usr/local/pkgs", pkg_prefix));
141+
}
142+
}
143+
144+
async function mirror_directory(dst: string, src: string, prefix: string) {
145+
await processEntry(join(src, prefix), join(dst, prefix));
146+
147+
async function processEntry(sourcePath: string, targetPath: string) {
148+
const fileInfo = await Deno.lstat(sourcePath);
149+
150+
if (fileInfo.isDirectory) {
151+
// Create the target directory
152+
await ensureDir(targetPath);
153+
154+
// Recursively process the contents of the directory
155+
for await (const entry of Deno.readDir(sourcePath)) {
156+
const entrySourcePath = join(sourcePath, entry.name);
157+
const entryTargetPath = join(targetPath, entry.name);
158+
await processEntry(entrySourcePath, entryTargetPath);
159+
}
160+
} else if (fileInfo.isFile) {
161+
// Create a hard link for files
162+
await Deno.link(sourcePath, targetPath);
163+
} else if (fileInfo.isSymlink) {
164+
// Recreate symlink in the target directory
165+
const linkTarget = await Deno.readLink(sourcePath);
166+
await Deno.symlink(linkTarget, targetPath);
167+
} else {
168+
throw new Error(`unsupported file type at: ${sourcePath}`);
169+
}
170+
}
171+
}
172+
173+
async function symlink(src: string, dst: string) {
174+
await processEntry(src, dst);
175+
176+
async function processEntry(sourcePath: string, targetPath: string) {
177+
const fileInfo = await Deno.lstat(sourcePath);
178+
179+
if (fileInfo.isDirectory) {
180+
// Create the target directory
181+
await ensureDir(targetPath);
182+
183+
// Recursively process the contents of the directory
184+
for await (const entry of Deno.readDir(sourcePath)) {
185+
const entrySourcePath = join(sourcePath, entry.name);
186+
const entryTargetPath = join(targetPath, entry.name);
187+
await processEntry(entrySourcePath, entryTargetPath);
188+
}
189+
} else {
190+
await Deno.symlink(sourcePath, targetPath);
191+
}
192+
}
193+
}
194+
195+
//FIXME we only do major as that's typically all pkgs need, but like we should do better
196+
async function create_v_symlinks(prefix: string) {
197+
const shelf = dirname(prefix);
198+
199+
const versions = [];
200+
for await (const entry of Deno.readDir(shelf)) {
201+
if (
202+
entry.isDirectory && !entry.isSymlink && entry.name.startsWith("v") &&
203+
entry.name != "var"
204+
) {
205+
try {
206+
versions.push(semver.parse(entry.name));
207+
} catch {
208+
//ignore
209+
}
210+
}
211+
}
212+
213+
// collect an Record of versions per major version
214+
const major_versions: Record<number, semver.SemVer> = {};
215+
for (const version of versions) {
216+
if (
217+
major_versions[version.major] === undefined ||
218+
semver.greaterThan(version, major_versions[version.major])
219+
) {
220+
major_versions[version.major] = version;
221+
}
222+
}
223+
224+
for (const [key, value] of Object.entries(major_versions)) {
225+
await Deno.symlink(`v${semver.format(value)}`, join(shelf, `v${key}`));
226+
}
227+
}

‎pkgx.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dependencies: deno^2

0 commit comments

Comments
 (0)
Please sign in to comment.