3 Commits

Author SHA1 Message Date
f352ae44e1 Outline what the first version of the upgrade script should do 2026-02-02 20:03:19 -05:00
341db4f821 Add dependency duplication check between app and framework
Adds check-deps.ts which ensures backend/package.json doesn't duplicate
any dependencies already provided by backend/diachron/package.json.
Integrated into backend/check.sh.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-02 19:47:05 -05:00
eabec3816b Add bootstrap.sh script
It's meant to be used to bootstrap new projects.  It could probably be curled
and piped through bash although this has not been tested yet.
2026-02-02 19:42:59 -05:00
7 changed files with 119 additions and 1 deletions

66
backend/check-deps.ts Normal file
View File

@@ -0,0 +1,66 @@
import { readFileSync } from "node:fs";
import { dirname, join } from "node:path";
import { fileURLToPath } from "node:url";
const __dirname = dirname(fileURLToPath(import.meta.url));
interface PackageJson {
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
}
function readPackageJson(path: string): PackageJson {
const content = readFileSync(path, "utf-8");
return JSON.parse(content);
}
function getAllDependencyNames(pkg: PackageJson): Set<string> {
const names = new Set<string>();
for (const name of Object.keys(pkg.dependencies ?? {})) {
names.add(name);
}
for (const name of Object.keys(pkg.devDependencies ?? {})) {
names.add(name);
}
return names;
}
const diachronPkgPath = join(__dirname, "diachron", "package.json");
const backendPkgPath = join(__dirname, "package.json");
const diachronPkg = readPackageJson(diachronPkgPath);
const backendPkg = readPackageJson(backendPkgPath);
const diachronDeps = getAllDependencyNames(diachronPkg);
const backendDeps = getAllDependencyNames(backendPkg);
const duplicates: string[] = [];
for (const dep of diachronDeps) {
if (backendDeps.has(dep)) {
duplicates.push(dep);
}
}
if (duplicates.length > 0) {
console.error("Error: Duplicate dependencies found.");
console.error("");
console.error(
"The following dependencies exist in both backend/package.json and backend/diachron/package.json:",
);
console.error("");
for (const dep of duplicates.sort()) {
console.error(` - ${dep}`);
}
console.error("");
console.error(
"Dependencies in backend/diachron/package.json are provided by the framework",
);
console.error(
"and must not be duplicated in backend/package.json. Remove them from",
);
console.error("backend/package.json to fix this error.");
process.exit(1);
}
console.log("No duplicate dependencies found.");

View File

@@ -11,4 +11,5 @@ out_dir="$check_dir/out"
source "$check_dir"/../diachron/shims/common source "$check_dir"/../diachron/shims/common
source "$check_dir"/../diachron/shims/node.common source "$check_dir"/../diachron/shims/node.common
$ROOT/cmd tsx "$check_dir/check-deps.ts"
$ROOT/cmd pnpm tsc --outDir "$out_dir" $ROOT/cmd pnpm tsc --outDir "$out_dir"

View File

@@ -10,5 +10,5 @@
"types": ["node"], "types": ["node"],
"outDir": "out" "outDir": "out"
}, },
"exclude": ["**/*.spec.ts", "**/*.test.ts"] "exclude": ["**/*.spec.ts", "**/*.test.ts", "check-deps.ts"]
} }

11
diachron/common.d/check-deps Executable file
View File

@@ -0,0 +1,11 @@
#!/bin/bash
set -eu
DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
ROOT="$DIR/../.."
cd "$ROOT/backend"
"$ROOT/cmd" tsx check-deps.ts "$@"

View File

@@ -0,0 +1 @@
../common.d/check-deps

1
diachron/mgmt.d/check-deps Symbolic link
View File

@@ -0,0 +1 @@
../common.d/check-deps

38
upgrade.sh Normal file
View File

@@ -0,0 +1,38 @@
#!/bin/bash
# shellcheck disable=SC2002
set -eu
set -o pipefail
IFS=$'\n\t'
# print useful message on failure
trap 's=$?; echo >&2 "$0: Error on line "$LINENO": $BASH_COMMAND"; exit $s' ERR
# shellcheck disable=SC2034
DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cd "$DIR"
# - Check if the file .diachron-version exists; save its value in a variable
# named old_diachron_version
# - Check if the repository is dirty; if there are any files that git knows
# about that have been changed but not committed, abort with a message
# - Get the current commit and store it in a variable
# - Perform a two checkouts of
# https://gitea.philologue.net/philologue/diachron, each in its own
# temporary directory. We'll call one "old" and one "new"
# - In old, check out $old_diachron_version; in our working application
# directory, delete all of the files in file-list using git rm
# - In new, check out whatever was passed as argv[1]
# - Copy all of the files in file-list to the working application and stage
# them with git add
# - Commit
# - Should we run sync.sh or should we advise the user to run sync.sh?