@adamhl8/configs 0.35.0 → 0.37.0

package/README.md

@@ -139,6 +139,21 @@ extends:
 
 `lefthook install` (the base justfile's `prepare` recipe runs it) sets up the hooks.
 
+### gitignore
+
+git has no include mechanism for `.gitignore`, so shared entries are synced into the project's `.gitignore`. The base justfile's `prepare` recipe runs the `adamhl8-gitignore` bin, which keeps the shared list at the top of the file above a marker line: the first run prepends it, later runs replace everything above the marker with the current shared list, so changes propagate on package updates:
+
+```gitignore
+node_modules/
+dist/
+# The above patterns are managed by @adamhl8/configs. Anything manually added above this line will be replaced.
+
+# project-specific entries go below the marker
+.env.local
+```
+
+Everything below the marker is left untouched. The sync can also be run manually by running `adamhl8-gitignore`.
+
 ## GitHub Actions
 
 This repo hosts three reusable workflows you can call from other projects instead of copy/pasting them. The calling project must use `nub`, have a `justfile` that imports the base justfile (see [just](#just)), and have a commitlint config (e.g. via these configs). The workflows install just themselves.
@@ -213,6 +228,6 @@ Configure these on each repo that uses the workflows (Settings -> Secrets and va
 
 ## Notes
 
-The `prepare` script is `"prepare": "just prepare"`, which runs the base justfile's `prepare` recipe (`lefthook install`).
+The `prepare` script is `"prepare": "just prepare"`, which runs the base justfile's `prepare` recipe (`lefthook install` and the `.gitignore` sync).
 
 nub installs `package.json` bin executables into the local `node_modules/.bin`. This means that we can run something like `adamhl8-cliff` directly instead of doing `src/adamhl8-cliff/index.ts`. That's why this repo overrides the `prepare` recipe to also run `tsdown`. Those executables need to be available.

package/dist/adamhl8-gitignore/index

@@ -0,0 +1,19 @@
+#!/usr/bin/env nub
+import fs from "node:fs";
+import path from "node:path";
+//#region src/adamhl8-gitignore/index.ts
+const GITIGNORE_BASE_PATH = path.resolve(import.meta.dirname, "../configs/gitignore.base");
+const END_MARKER = "# The above patterns are managed by @adamhl8/configs. Anything manually added above this line will be replaced.";
+/** Rebuilds the managed region above the marker, keeping what's below it (the whole file when there's no marker). */
+const mergeGitignore = (currentContent, blockBody) => {
+	const block = [blockBody, END_MARKER].filter(Boolean).join("\n");
+	const existingContent = (currentContent.split(END_MARKER).at(-1) ?? "").trim();
+	return existingContent ? `${block}\n\n${existingContent}\n` : `${block}\n`;
+};
+const gitignorePath = ".gitignore";
+const blockBody = fs.readFileSync(GITIGNORE_BASE_PATH, "utf8").trim();
+const currentContent = fs.existsSync(gitignorePath) ? fs.readFileSync(gitignorePath, "utf8") : "";
+const merged = mergeGitignore(currentContent, blockBody);
+if (merged !== currentContent) fs.writeFileSync(gitignorePath, merged);
+//#endregion
+export {};

package/dist/configs/gitignore.base

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+.terraform
+.terraform.lock.hcl

package/dist/configs/justfile.base.just

@@ -14,13 +14,13 @@ run-when(cmd, condition) := f"if {{condition}}; then echo {{style("command", cmd
 prepare: _prepare
 _prepare:
     lefthook install
+    adamhl8-gitignore
 
 bump-deps: _bump-deps
 _bump-deps:
     nub update -L
-    rm -f lock.yaml
+    rm -f nub.lock
     nub i --no-frozen-lockfile
-    oxfmt lock.yaml
 
 tofu-check: _tofu-check
 _tofu-check:

package/dist/tofu/github/repo_settings.tofu

@@ -2,15 +2,24 @@ data "local_file" "package_json" {
   filename = "${path.root}/package.json"
 }
 
+data "github_user" "current" {
+  username = ""
+}
+
 locals {
   package_json = jsondecode(data.local_file.package_json.content)
+  repo_url     = "github.com/${data.github_user.current.login}/${var.repo_name}"
+  # a homepage pointing at the repo itself is redundant
+  homepage_url = try(strcontains(local.package_json.homepage, local.repo_url) ? null : local.package_json.homepage, null)
 }
 
+
+
 resource "github_repository" "current" {
   name         = var.repo_name
   description  = local.package_json.description
   visibility   = var.repo_settings.visibility
-  homepage_url = var.repo_settings.homepage_url
+  homepage_url = local.homepage_url
   topics       = try(local.package_json.keywords, [])
 
   allow_merge_commit          = false

package/dist/tofu/github/variables.tofu

@@ -6,8 +6,7 @@ variable "repo_name" {
 variable "repo_settings" {
   description = "The GitHub repository settings"
   type = object({
-    visibility   = string
-    homepage_url = optional(string, null)
+    visibility = string
   })
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamhl8/configs",
-  "version": "0.35.0",
+  "version": "0.37.0",
   "description": "My shared configs for TS projects",
   "homepage": "https://github.com/adamhl8/configs",
   "bugs": {
@@ -17,7 +17,8 @@
     "url": "git+https://github.com/adamhl8/configs.git"
   },
   "bin": {
-    "adamhl8-cliff": "./dist/adamhl8-cliff/index"
+    "adamhl8-cliff": "./dist/adamhl8-cliff/index",
+    "adamhl8-gitignore": "./dist/adamhl8-gitignore/index"
   },
   "files": [
     "./dist/"
@@ -120,5 +121,12 @@
     "vitest": {
       "optional": true
     }
+  },
+  "devEngines": {
+    "packageManager": {
+      "name": "nub",
+      "version": "^0.4.4",
+      "onFail": "warn"
+    }
   }
 }