Skip to content

Commit 881d99a

Browse files
DenisGorbachevDenisGorbachev
committed
fix: README
1 parent c81d18c commit 881d99a

File tree

8 files changed

+182
-129
lines changed

8 files changed

+182
-129
lines changed

‎.github/workflows/ci.yml

+13-24
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,21 @@ jobs:
1919
- nightly
2020
timeout-minutes: 45
2121
steps:
22-
-
23-
uses: actions/checkout@v4
24-
-
25-
uses: dtolnay/rust-toolchain@stable
22+
- uses: actions/checkout@v4
23+
- uses: jdx/mise-action@v2
24+
with:
25+
version: 2025.1.14
26+
- name: Remove rust from mise
27+
run: |
28+
# a different rust version will be installed in the next step
29+
mise rm rust
30+
- uses: dtolnay/rust-toolchain@stable
2631
with:
2732
toolchain: ${{ matrix.rust }}
2833
components: clippy, rustfmt
29-
-
30-
uses: taiki-e/install-action@nextest
31-
-
32-
uses: actions/setup-node@v4
33-
with:
34-
node-version: lts/Iron # 20
35-
-
36-
uses: denoland/setup-deno@v1
37-
with:
38-
deno-version: v1.45.x
39-
-
40-
run: ./install.sh
41-
-
42-
uses: Swatinem/[email protected]
43-
-
44-
run: lefthook run --force pre-commit
45-
-
46-
run: cargo hack test --feature-powerset
47-
-
48-
name: Validate PR commits with commitlint
34+
- uses: Swatinem/[email protected]
35+
- run: lefthook run --force pre-commit
36+
- run: cargo hack test --feature-powerset
37+
- name: Validate PR commits with commitlint
4938
if: github.event_name == 'pull_request'
5039
run: commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose

‎Justfile

-33
This file was deleted.

‎README.ts

+62-26
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
#!/usr/bin/env -S deno run --allow-read --allow-run=bash,git,cargo --allow-env --allow-sys
1+
#!/usr/bin/env -S deno run --allow-read --allow-run=bash,git,cargo --allow-net=docs.rs:443 --allow-env --allow-sys
22

33
import * as zx from "npm:zx"
4-
import { z, ZodSchema } from "https://deno.land/x/[email protected]/mod.ts"
5-
import { assertEquals } from "https://jsr.io/@std/assert/1.0.0/equals.ts"
6-
import { assert } from "https://jsr.io/@std/assert/1.0.0/assert.ts"
4+
import { z, ZodSchema, ZodTypeDef } from "https://deno.land/x/[email protected]/mod.ts"
5+
import { assert, assertEquals } from "jsr:@std/[email protected]"
76

8-
const CargoToml = z.object({
7+
const CargoTomlSchema = z.object({
98
package: z.object({
109
name: z.string().min(1),
1110
description: z.string().min(1),
1211
repository: z.string().url().min(1),
1312
metadata: z.object({
1413
details: z.object({
15-
title: z.string().min(1),
16-
tagline: z.string(),
17-
summary: z.string(),
18-
}),
19-
}),
14+
title: z.string().min(1).optional(),
15+
tagline: z.string().optional(),
16+
summary: z.string().optional(),
17+
peers: z.array(z.string()).default([]).describe("Packages that should be installed alongside this package")
18+
}).default({}),
19+
}).default({}),
2020
}),
2121
})
2222

23-
type CargoToml = z.infer<typeof CargoToml>
23+
type CargoToml = z.infer<typeof CargoTomlSchema>
2424

2525
const CargoMetadataSchema = z.object({
2626
packages: z.array(z.object({
@@ -33,31 +33,70 @@ const CargoMetadataSchema = z.object({
3333

3434
type CargoMetadata = z.infer<typeof CargoMetadataSchema>
3535

36-
const Repo = z.object({
36+
const RepoSchema = z.object({
3737
url: z.string().url(),
3838
})
3939

40-
type Repo = z.infer<typeof Repo>
40+
type Repo = z.infer<typeof RepoSchema>
4141

42-
const $ = zx.$({
43-
cwd: import.meta.dirname,
42+
const BadgeSchema = z.object({
43+
name: z.string().min(1),
44+
image: z.string().url(),
45+
url: z.string().url(),
4446
})
4547

46-
const parse = <T>(schema: ZodSchema<T>, input: zx.ProcessOutput) => schema.parse(JSON.parse(input.stdout))
47-
const renderMarkdownList = (items: string[]) => items.map((bin) => `* ${bin}`).join("\n")
48+
type Badge = z.infer<typeof BadgeSchema>
49+
50+
const badge = (name: string, image: string, url: string): Badge => BadgeSchema.parse({name, url, image})
51+
52+
const dirname = import.meta.dirname;
53+
if (!dirname) throw new Error("Cannot determine the current script dirname")
4854

49-
const theCargoToml: CargoToml = parse(CargoToml, await $`yj -t < Cargo.toml`)
50-
const { package: { name, metadata: { details: { title } } } } = theCargoToml
55+
const $ = zx.$({ cwd: dirname })
56+
57+
// deno-lint-ignore no-explicit-any
58+
const parse = <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(schema: ZodSchema<Output, Def, Input>, input: zx.ProcessOutput) => schema.parse(JSON.parse(input.stdout))
59+
60+
const theCargoToml: CargoToml = parse(CargoTomlSchema, await $`yj -t < Cargo.toml`)
61+
const { package: { name, description, metadata: { details } } }= theCargoToml
62+
const title = details.title || description
63+
const peers = details.peers
5164
const theCargoMetadata: CargoMetadata = parse(CargoMetadataSchema, await $`cargo metadata --format-version 1`)
5265
const thePackageMetadata = theCargoMetadata.packages.find((p) => p.name == name)
5366
assert(thePackageMetadata, "Could not find package metadata")
5467
const target = thePackageMetadata.targets[0]
5568
assert(target, "Could not find package first target")
56-
const doc = await $`cargo doc2readme --template README.jl --target-name ${target.name} --out -`
57-
const repo: Repo = parse(Repo, await $`gh repo view --json url`)
69+
const docsUrl = `https://docs.rs/${name}`
70+
71+
// launch multiple promises in parallel
72+
const doc2ReadmePromise = $`cargo doc2readme --template README.jl --target-name ${target.name} --out -`
73+
const ghRepoPromise = $`gh repo view --json url`
74+
const docsUrlPromise = fetch(docsUrl, {method:"HEAD"})
5875

76+
const doc = await doc2ReadmePromise
77+
const docStr = doc.stdout.trim();
78+
79+
const repo: Repo = parse(RepoSchema, await ghRepoPromise)
5980
assertEquals(repo.url, theCargoToml.package.repository)
6081

82+
const docsUrlHead = await docsUrlPromise
83+
const docsUrlIs200 = docsUrlHead.status === 200
84+
85+
const badges: Badge[] = [
86+
badge("Build", `${repo.url}/actions/workflows/ci.yml/badge.svg`, repo.url)
87+
]
88+
if (docsUrlIs200) {
89+
badges.push(badge("Documentation", `https://docs.rs/${name}/badge.svg`, docsUrl))
90+
}
91+
const badgesStr = badges.map(({name, image, url}) => `[![${name}](${image})](${url})`).join("\n");
92+
93+
const titleSection = [
94+
badgesStr,
95+
docStr
96+
].filter(s => s.length)
97+
98+
const cargoAddPackages = [name, ...peers];
99+
61100
const autogenerated = `
62101
<!-- DO NOT EDIT -->
63102
<!-- This file is automatically generated by README.ts. -->
@@ -69,15 +108,12 @@ ${autogenerated}
69108
70109
# ${title}
71110
72-
[![Build](${repo.url}/actions/workflows/ci.yml/badge.svg)](${repo.url})
73-
[![Documentation](https://docs.rs/${name}/badge.svg)](https://docs.rs/${name})
74-
75-
${doc.stdout.trim()}
111+
${titleSection.join("\n\n")}
76112
77113
## Installation
78114
79115
\`\`\`shell
80-
cargo add ${name}
116+
cargo add ${cargoAddPackages.join(" ")}
81117
\`\`\`
82118
83119
## Gratitude

‎commitlint.config.mjs

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
const severity = {
2-
disable: 0,
3-
warn: 1,
4-
error: 2,
5-
}
1+
const disable = 0
2+
const warn = 1
3+
const error = 2
64

75
export default {
86
extends: ['@commitlint/config-conventional'],
97
rules: {
108
'type-enum': [
11-
severity.error,
9+
error,
1210
'always',
1311
[
1412
'build',
@@ -26,5 +24,6 @@ export default {
2624
'test',
2725
],
2826
],
27+
'subject-case': [disable]
2928
},
3029
}

‎deno.lock

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎install.sh

-20
This file was deleted.

‎lefthook.yml

+21-20
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,29 @@ assert_lefthook_installed: true
22
pre-commit:
33
parallel: true
44
commands:
5-
generate-readme:
5+
gen:readme:
66
run: |
77
set -eu
8-
./README.ts > README.md
9-
remark --ignore-path .gitignore --quiet --frail --no-stdout README.md # run remark again because README.md has changed
10-
git add README.md # add README.md manually instead of using `stage_fixed` because it may not have been staged
11-
format:
12-
run: cargo fmt --all
8+
mise run gen:readme
9+
# run remark again because README.md has changed
10+
mise run remark README.md
11+
# add README.md manually instead of using `stage_fixed` because it may not have been staged
12+
git add README.md
13+
fmt:
14+
run: mise run fmt
15+
stage_fixed: true
16+
lint:code:
17+
run: mise run lint:code
18+
lint:docs:
19+
run: mise run lint:docs
20+
lint:deps:
21+
run: mise run lint:deps
22+
test:code:
23+
run: mise run test:code --no-fail-fast
24+
sort:deps:
25+
run: mise run sort:deps
1326
stage_fixed: true
14-
lint-code:
15-
run: cargo clippy --all-targets --all-features -- -D warnings
16-
test-code:
17-
run: cargo nextest run --no-fail-fast
18-
lint-docs:
19-
run: remark --ignore-path .gitignore --quiet --frail --no-stdout .
20-
test-docs:
21-
run: cargo test --doc
22-
sort-deps:
23-
run: cargo sort
24-
lint-deps:
25-
run: cargo machete --with-metadata
2627
commit-msg:
2728
commands:
28-
"lint commit message":
29-
run: commitlint --edit "$1"
29+
commitlint:
30+
run: mise exec -- commitlint --edit "$1"

0 commit comments

Comments
 (0)