Artifact [74214a6875]

Artifact 74214a6875c0833272eeeffd19796f6dd035c3bb5454e3dd708256b6c1d229cb:

• File cmd/quarry/seed.go — part of check-in [c5b6d979e2] at 2026-08-18 11:33:34 on branch trunk — repo.add: seed a new repository's first check-in

  A repository with no check-ins has an unborn trunk, so the timeline, the file tree and every clone instruction have nothing to point at. Optional README, license (MIT or BSD-2) and .zitignore give it a born trunk, which is why GitHub offers the same three at creation.

  The copyright line is left as <copyright holder> rather than filled with the account name: a copyright naming the wrong person is worse than one that is visibly unfinished, and an account is a login, not a legal entity. Seeding is refused on a clone, which arrives with its own history, and paths are checked against the repository root before anything is written. (user: dmestas, size: 4416) [annotate] [blame] [check-ins using]

package main

import (
	"fmt"
	"strings"
	"time"
)

// seedFiles builds the initial contents of a new repository.
//
// The set is deliberately small — README, a license, an ignore file —
// because these are the three things a repository is judged incomplete
// without, and every one of them is a file the author will otherwise
// write by hand in the first five minutes.
func seedFiles(name, description, license string, ignore bool) map[string]string {
	out := map[string]string{}
	out["README.md"] = readme(name, description)
	if body, ok := licenseText(license, time.Now().UTC().Year()); ok {
		out["LICENSE"] = body
	}
	if ignore {
		out[".zitignore"] = zitignore
	}
	return out
}

func readme(name, description string) string {
	var b strings.Builder
	fmt.Fprintf(&b, "# %s\n", name)
	if description != "" {
		fmt.Fprintf(&b, "\n%s\n", description)
	}
	return b.String()
}

// licenses are the short, universally recognised ones. Deliberately not
// a catalogue: a forge offering forty licenses is asking a question its
// user cannot answer, and the answer for anything unusual is to commit
// the text yourself.
//
// The placeholder is left as a placeholder rather than filled with the
// account name. A copyright line naming the wrong person is worse than
// one that is visibly unfinished, and quarry does not know who holds
// the copyright — the account is a login, not a legal entity.
func licenseText(kind string, year int) (string, bool) {
	holder := "<copyright holder>"
	switch strings.ToLower(kind) {
	case "mit":
		return fmt.Sprintf(mitLicense, year, holder), true
	case "bsd-2", "bsd-2-clause":
		return fmt.Sprintf(bsd2License, year, holder), true
	case "", "none":
		return "", false
	}
	return "", false
}

// knownLicenses is what the surfaces offer; kept beside licenseText so
// the list and the implementation cannot drift.
var knownLicenses = []string{"mit", "bsd-2"}

const zitignore = `# Build output and local scratch.
zig-out/
.zig-cache/
target/
node_modules/
*.o
*.a
.DS_Store
`

const mitLicense = `MIT License

Copyright (c) %d %s

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
`

const bsd2License = `BSD 2-Clause License

Copyright (c) %d %s

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
`