Merge remote-tracking branch 'repoconf-rust-public-lib-template/main'

Author: DenisGorbachev

.repoconf/data/init-removed-files

@@ -0,0 +1 @@
+README.md

.repoconf/data/managed-files

@@ -0,0 +1,9 @@
+.github/workflows/ci.yml
+.gitignore
+commitlint.config.mjs
+deno.json
+lefthook.yml
+mise.toml
+README.ts
+rustfmt.toml
+CLAUDE.md

.repoconf/hooks/post-init.sh

@@ -0,0 +1,55 @@
+#!/usr/bin/env -S usage bash
+#USAGE flag "-n --name <name>" help="Package name (if this flag is not provided, then the package name is inferred from the directory name)"
+#USAGE arg "<dir>"
+
+set -xeuo pipefail
+
+dir=$(realpath "${usage_dir:?}")
+name_new_default="${usage_name:-$(basename "$dir")}"
+cargo_toml="$dir/Cargo.toml"
+#mise_toml="$dir/mise.toml"
+
+read -r -p "Rust package name (default: $name_new_default): " name_new
+read -r -p "Rust package description: " description
+read -r -p "Rust package title (default: same as description): " title
+
+if [[ -z $name_new ]]; then
+  name_new=$name_new_default
+fi
+
+if [[ -z $title ]]; then
+  title=$description
+fi
+
+(cd "$dir" && mise trust)
+(cd "$dir" && mise install)
+
+name_old=$(taplo get -f "$cargo_toml" "package.name")
+name_old_snake_case=$(ccase --to snake "$name_old")
+name_new_snake_case=$(ccase --to snake "$name_new")
+repo_url=$(cd "$dir" && gh repo view --json url | jq -r .url)
+
+tomli set -f "$cargo_toml" "package.name" "$name_new" | sponge "$cargo_toml"
+tomli set -f "$cargo_toml" "package.repository" "$repo_url" | sponge "$cargo_toml"
+tomli set -f "$cargo_toml" "package.homepage" "$repo_url" | sponge "$cargo_toml"
+tomli set -f "$cargo_toml" "package.description" "$description" | sponge "$cargo_toml"
+tomli set -f "$cargo_toml" "package.metadata.details.title" "$title" | sponge "$cargo_toml"
+tomli delete --if-exists -f "$cargo_toml" "package.metadata.details.readme.generate" | sponge "$cargo_toml"
+
+while IFS= read -r file; do
+  rm "$dir/$file"
+done < "$dir/.repoconf/data/init-removed-files"
+
+# rg exits with status code = 1 if it doesn't find any files, so we need to disable & re-enable "set -e"
+set +e
+rg --files-with-matches "$name_old_snake_case" "$dir" | xargs gsed -i "s/\b$name_old_snake_case\b/$name_new_snake_case/g"
+set -e
+
+(cd "$dir" && mise exec "npm:lefthook" -- lefthook install)
+
+(cd "$dir" && mise run build)
+
+(cd "$dir" && mise run test)
+
+# remove .repoconf just before the final commit, in the same line
+(cd "$dir" && rm -r "$dir/.repoconf" && git add . && git commit -a -m "chore: update package details")

CLAUDE.md

@@ -0,0 +1,18 @@
+# Guidelines
+
+## General
+
+* Read `Cargo.toml` before executing any tasks
+* Don't create git commits
+
+## Commands
+
+Always use `mise run ...` commands to run the tests / lints.
+
+* Run tests: `mise run test` (use this instead of `cargo test`)
+* Run specific test: `mise run test <test_file_path>` (use this instead of `cargo test`)
+* Format code: `mise run fmt` (use this instead of `cargo fmt`)
+* Lint code: `mise run lint` (use this instead of `cargo clippy`)
+* Check types: `mise run check` (use this instead of `cargo check`)
+
+Always execute `mise run fmt` after completing your task.

README.md

@@ -36,6 +36,6 @@ Like the project? [⭐ Star this repo](https://github.com/DenisGorbachev/url-mac
 
 ## License
 
-[Apache License 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option.
+[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).
 
-Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be licensed as above, without any additional terms or conditions.

README.ts

@@ -6,6 +6,7 @@ import { z, ZodSchema, ZodTypeDef } from "https://deno.land/x/[email protected]/mod.ts
 import { assert, assertEquals } from "jsr:@std/[email protected]"
 import { toSnakeCase } from "jsr:@std/[email protected]"
 import { parseArgs } from "jsr:@std/[email protected]"
+import { parse as parseToml } from "jsr:@std/[email protected]"
 
 export const args = parseArgs(Deno.args, {
     string: ["output"],
@@ -19,6 +20,7 @@ const CargoTomlSchema = z.object({
         name: z.string().min(1),
         description: z.string().min(1),
         repository: z.string().url().min(1),
+        license: z.string().optional(),
         metadata: z.object({
             details: z.object({
                 title: z.string().min(1).optional(),
@@ -84,13 +86,33 @@ const stub = <T>(message = "Implement me"): T => {
     throw new Error(message)
 }
 
+/**
+ * Examples:
+ *
+ * `normalizeGitRemoteUrl("[email protected]:DenisGorbachev/rust-private-template.git") == "https://github.com/DenisGorbachev/rust-private-template"`
+ *
+ * @param url
+ */
+const normalizeGitRemoteUrl = (url: string) => {
+    // Handle GitHub SSH format: git@github.com:username/repo.git
+    const sshMatch = url.match(/^git@github\.com:([^/]+)\/([^/]+?)\.git$/)
+    if (sshMatch) {
+        const [, username, repo] = sshMatch
+        return `https://github.com/${username}/${repo}`
+    }
+    
+    // Return original if not a GitHub SSH URL
+    return url
+}
+
 const dirname = import.meta.dirname
 if (!dirname) throw new Error("Cannot determine the current script dirname")
 
 const $ = zx.$({ cwd: dirname })
 
+const parseProcessOutput = (input: zx.ProcessOutput) => JSON.parse(input.stdout)
 // deno-lint-ignore no-explicit-any
-const parse = <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(schema: ZodSchema<Output, Def, Input>, input: zx.ProcessOutput) => schema.parse(JSON.parse(input.stdout))
+const parse = <Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output>(schema: ZodSchema<Output, Def, Input>, input: zx.ProcessOutput) => schema.parse(parseProcessOutput(input))
 const nail = (str: string) => {
     const spacesAtStart = str.match(/^\n(\s+)/)
     if (spacesAtStart?.[1]) {
@@ -100,19 +122,28 @@ const nail = (str: string) => {
     }
 }
 
-const cargoTomlPromise = $`yj -t < Cargo.toml`;
-const cargoMetadataPromise = $`cargo metadata --format-version 1`;
-const ghRepoPromise = $`gh repo view --json url`
-
-const theCargoToml: CargoToml = parse(CargoTomlSchema, await cargoTomlPromise)
-const theCargoMetadata: CargoMetadata = parse(CargoMetadataSchema, await cargoMetadataPromise)
-const { package: { name, description, metadata: { details: {title: titleExplicit, peers, readme: {generate}} } } } = theCargoToml
+const theCargoTomlText = await Deno.readTextFile(`${dirname}/Cargo.toml`);
+// deno-lint-ignore no-explicit-any
+const theCargoTomlRaw = parseToml(theCargoTomlText) as any
 
 // If README generation is manually disabled in the Cargo.toml, just exit successfully
-if (!generate) {
+if (theCargoTomlRaw.package?.metadata?.details?.readme?.generate === false) {
     Deno.exit(0)
 }
 
+// launch multiple promises in parallel
+const cargoMetadataPromise = $`cargo metadata --format-version 1`;
+const originUrlPromise = $`git remote get-url origin`
+
+const theCargoMetadataRaw = JSON.parse((await cargoMetadataPromise).stdout)
+
+const theCargoToml = CargoTomlSchema.parse(theCargoTomlRaw)
+const theCargoMetadata = CargoMetadataSchema.parse(theCargoMetadataRaw)
+const theOriginUrl = normalizeGitRemoteUrl((await originUrlPromise).stdout.trim());
+
+assertEquals(theOriginUrl, theCargoToml.package.repository)
+
+const { package: { name, description, license, metadata: { details: {title: titleExplicit, peers} } } } = theCargoToml
 const title = titleExplicit || description
 const _libTargetName = toSnakeCase(name)
 const thePackageMetadata = theCargoMetadata.packages.find((p) => p.name == name)
@@ -144,28 +175,35 @@ const doc2readmeRender = async (target: string) => {
     return $`cargo doc2readme --template ${templatePath} --target-name ${target} --out -`
 }
 
-// launch multiple promises in parallel
 const doc2ReadmePromise = doc2readmeRender(primaryTarget.name)
 const docsUrlPromise = fetch(docsUrl, { method: "HEAD" })
 const helpPromise = primaryBinTarget ? $`cargo run --quiet --bin ${primaryBinTarget.name} -- --help` : undefined
 
 const doc = await doc2ReadmePromise
 const docStr = doc.stdout.trim()
 
-const repo: Repo = parse(RepoSchema, await ghRepoPromise)
-assertEquals(repo.url, theCargoToml.package.repository)
-
 const docsUrlHead = await docsUrlPromise
 const docsUrlIs200 = docsUrlHead.status === 200
 
 const badges: Badge[] = [
-    badge("Build", `${repo.url}/actions/workflows/ci.yml/badge.svg`, repo.url),
+    badge("Build", `${theCargoToml.package.repository}/actions/workflows/ci.yml/badge.svg`, theCargoToml.package.repository),
 ]
 if (docsUrlIs200) {
     badges.push(badge("Documentation", `https://docs.rs/${name}/badge.svg`, docsUrl))
 }
 const badgesStr = badges.map(({ name, image, url }) => `[![${name}](${image})](${url})`).join("\n")
 
+const licenseNameFileMap: Record<string, string> = {
+    "Apache-2.0": "LICENSE-APACHE",
+    "MIT": "LICENSE-MIT"
+}
+const getLicenseFile = (name: string) => {
+    const file = licenseNameFileMap[name];
+    if (file === undefined) throw new Error(`licenseNameFileMap is missing the following key: \`${name}\``)
+    return file
+}
+const licenseNames = license ? license.split("OR").map(name => name.trim()) : []
+
 const renderMarkdownList = (items: string[]) => items.map((bin) => `* ${bin}`).join("\n")
 const renderShellCode = (code: string) => `\`\`\`shell\n${code}\n\`\`\``
 
@@ -198,16 +236,24 @@ if (secondaryBinTargets.length) {
     const secondaryBinTargetsNames = secondaryBinTargets.map((t) => t.name)
     pushSection(sections, "Additional binaries", renderMarkdownList(secondaryBinTargetsNames.map((bin) => `\`${bin}\``)))
 }
-pushSection(sections, "Gratitude", `Like the project? [⭐ Star this repo](${repo.url}) on GitHub!`)
-pushSection(
-    sections,
-    "License",
-    `
-[Apache License 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option.
-
-Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+pushSection(sections, "Gratitude", `Like the project? [⭐ Star this repo](${theCargoToml.package.repository}) on GitHub!`)
+
+if (licenseNames.length) {
+    const licenseLinks = licenseNames.map(name => {
+        const file = getLicenseFile(name)
+        return `[${name}](${file})`
+    })
+    pushSection(
+      sections,
+      "License",
+      `
+${licenseLinks.join(" or ")}.
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be licensed as above, without any additional terms or conditions.
 `.trim(),
-)
+    )
+}
+
 
 const body = renderNonEmptySections(sections)
 

mise.toml

@@ -17,7 +17,6 @@ cargo-binstall = "1.10.15"
 "cargo:cargo-hack" = "0.6.33"
 "cargo:cargo-machete" = "0.7.0"
 "cargo:cargo-nextest" = "0.9.72"
-"aqua:sclevine/yj" = "5.1.0"
 
 [tasks."build"]
 run = "cargo build"
@@ -26,7 +25,7 @@ run = "cargo build"
 run = "cargo fmt --all"
 
 [tasks."lint"]
-depends = ["lint:code", "lint:docs"]
+depends = ["lint:code", "lint:docs", "lint:deps"]
 
 [tasks."test"]
 depends = ["test:code", "test:docs"]
@@ -41,14 +40,27 @@ run = "mise run remark ."
 run = "cargo machete --with-metadata"
 
 [tasks."test:code"]
-run = "cargo nextest run"
+run = "cargo nextest run --all-features"
 
 [tasks."test:docs"]
 run = "cargo test --doc"
 
 [tasks."sort:deps"]
 run = "cargo sort"
 
+[tasks."check"]
+run = "cargo check --all-targets --all-features"
+
+[tasks."fix"]
+depends = ["fix:code", "fix:docs"]
+
+[tasks."fix:code"]
+env = { __CARGO_FIX_YOLO = 'yeah' }
+run = "cargo clippy --fix --allow-dirty --allow-staged"
+
+[tasks."fix:deps"]
+run = "cargo machete --with-metadata --fix"
+
 [tasks."watch"]
 run = """
 #!/usr/bin/env bash
@@ -59,17 +71,8 @@ CMD_NO_WHITESPACE="$(echo -e "${CMD_RAW}" | sed -e 's/^[[:space:]]*//' -e 's/[[:
 cargo watch --clear --watch "$PWD" --exec "$CMD_NO_WHITESPACE" "$@"
 """
 
-[tasks."check"]
-run = "cargo check --all-targets"
-
-[tasks."fix"]
-env = { __CARGO_FIX_YOLO = 'yeah' }
-run = "cargo clippy --fix --allow-dirty --allow-staged"
-
 [tasks."gen:readme"]
 run = "./README.ts --output README.md"
-sources = ["README.ts"]
-outputs = ["README.md"]
 
 [tasks."remark"]
 run = """