mirror of
https://github.com/tiennm99/noitu.git
synced 2026-10-11 12:28:54 +00:00
tiennm99
0a5c5b06fe
Replace the pinned 2018 undertheseanlp wordlist with kaikki.org's current wiktextract export of the Vietnamese Wiktionary, read with --kaikki. The same authors and website, eight years fresher: 34,813 words instead of 26,845, with every graph metric up and bot game length unchanged. The export is fetched fresh for every build and is not pinned, by the owner's decision: kaikki keeps no dated snapshots, so a checksum would break weekly. The builder therefore hashes the file as it streams it and records source_sha256, source_rows and source_fetched_at in meta; the fetch downloads to a .part name and renames on success; a truncated or non-JSON body fails the build, and the --min-words floor rises to 30,000. DICT_SHA256 and verify-dict are gone; the Makefile, Dockerfile and the builder's URL constant are held in agreement by a test. Current Wiktionary text is CC BY-SA 4.0, so the data licence returns to 4.0: data/LICENSE is restored, and NOTICE, ATTRIBUTION, README, the image docs and the in-game footer credit Wiktionary tiếng Việt's contributors and wiktextract/kaikki.org. builder_version becomes 3 for the changed meta contract.
109 lines
4.4 KiB
Makefile
109 lines
4.4 KiB
Makefile
# noitu — build targets.
|
|
#
|
|
# Every target has a raw equivalent documented in README.md, so contributors
|
|
# without `make` (notably on Windows) are never blocked.
|
|
|
|
# kaikki.org re-exports Wiktionary tiếng Việt about weekly and keeps no dated
|
|
# snapshots, so this is fetched fresh and unpinned by design: the builder
|
|
# records the SHA-256 of what it read in the database's meta table. The URL
|
|
# stays percent-encoded — the path has a space in it.
|
|
DICT_URL := https://kaikki.org/viwiktionary/Ti%E1%BA%BFng%20Vi%E1%BB%87t/kaikki.org-dictionary-Ti%E1%BA%BFngVi%E1%BB%87t.jsonl
|
|
DICT_SRC := data/kaikki-viwiktionary-vi.jsonl
|
|
DICT_OUT := data/noitu.db
|
|
FIXTURE_WORDS := testdata/fixture-words.txt
|
|
FIXTURE_DB := data/fixture.db
|
|
SERVER_BIN := noitu-server
|
|
|
|
.PHONY: help fetch-dict dict fixture-dict proto proto-check server web web-dev test test-go test-web test-e2e run clean
|
|
|
|
help:
|
|
@echo "fetch-dict download the current upstream wordlist (~62 MB) into data/"
|
|
@echo "dict derive $(DICT_OUT) from $(DICT_SRC)"
|
|
@echo "fixture-dict build the small test dictionary — no download needed"
|
|
@echo "proto regenerate the Go and JS wire types from proto/"
|
|
@echo "proto-check lint the schema and verify the committed output is in sync"
|
|
@echo "server build the Go server binary"
|
|
@echo "web build the SvelteKit frontend"
|
|
@echo "web-dev run the frontend dev server, proxying /ws to a local server"
|
|
@echo "test run all tests"
|
|
@echo "test-e2e run the Playwright suite against the fixture dictionary"
|
|
@echo "run build and run the server locally"
|
|
@echo "clean remove build artifacts (keeps downloaded dictionary)"
|
|
|
|
# Fetches whatever kaikki currently serves. -f so an HTTP error fails here
|
|
# rather than as a JSON parse error later; no resume flag, because resuming a
|
|
# file that may have changed underneath would splice two exports together;
|
|
# downloaded to a .part name and renamed only on success, so an interrupted
|
|
# fetch never leaves a truncated file for the next `make dict` to consume.
|
|
fetch-dict:
|
|
@mkdir -p data
|
|
curl -fL -o $(DICT_SRC).part $(DICT_URL) && mv $(DICT_SRC).part $(DICT_SRC)
|
|
@echo "downloaded $(DICT_SRC)"
|
|
|
|
$(DICT_SRC):
|
|
@echo "$(DICT_SRC) not found — run 'make fetch-dict' first" >&2
|
|
@exit 1
|
|
|
|
dict: $(DICT_SRC)
|
|
cd server && go run ./cmd/build-dictionary --kaikki ../$(DICT_SRC) --out ../$(DICT_OUT)
|
|
|
|
# The dictionary tests, end-to-end runs and CI all play against. Built from a
|
|
# checked-in word list through the same pipeline as the real one, so nothing
|
|
# has to download anything to get a working database.
|
|
$(FIXTURE_DB): $(FIXTURE_WORDS)
|
|
cd server && go run ./cmd/build-dictionary --words ../$(FIXTURE_WORDS) --out ../$(FIXTURE_DB) --min-words 150
|
|
|
|
fixture-dict: $(FIXTURE_DB)
|
|
|
|
# Regenerates both targets from proto/noitu/v1/game.proto. Needs `buf`; the
|
|
# two code generators come from server/go.mod's tool directive and
|
|
# web/package.json, so there is nothing to install globally. Generated code is
|
|
# committed, so building and running the project never requires this target.
|
|
proto: web/node_modules
|
|
buf generate
|
|
|
|
# What CI runs: the schema is well-formed, and the committed generated trees
|
|
# match what the schema currently produces.
|
|
# --intent-to-add makes a newly emitted file visible: git diff alone ignores
|
|
# untracked files and would call an incomplete committed tree clean.
|
|
proto-check: proto
|
|
buf lint
|
|
git add --intent-to-add -- server/gen web/src/lib/proto
|
|
git diff --exit-code -- server/gen web/src/lib/proto
|
|
|
|
web/node_modules: web/package.json web/package-lock.json
|
|
cd web && npm ci
|
|
@touch web/node_modules
|
|
|
|
server:
|
|
cd server && CGO_ENABLED=0 go build -o ../$(SERVER_BIN) ./cmd/noitu-server
|
|
|
|
web: web/node_modules
|
|
cd web && npm run build
|
|
|
|
# Vite serves the UI and proxies /ws to the Go binary on :8080, so the client
|
|
# resolves its socket from its own origin in dev exactly as it does in
|
|
# production. Run `make run` alongside this.
|
|
web-dev: web/node_modules
|
|
cd web && npm run dev
|
|
|
|
test: test-go test-web
|
|
|
|
test-go:
|
|
cd server && go vet ./... && go test ./... -race
|
|
|
|
# npm test builds before it runs: the bundle check reads the built output, and
|
|
# a stale build would let it pass over code that no longer exists.
|
|
test-web: web/node_modules
|
|
cd web && npm run check && npm test
|
|
|
|
test-e2e: web/node_modules $(FIXTURE_DB) server
|
|
cd web && npm run test:e2e
|
|
|
|
run: server
|
|
./$(SERVER_BIN)
|
|
|
|
clean:
|
|
rm -f $(SERVER_BIN) $(SERVER_BIN).exe $(DICT_OUT) $(FIXTURE_DB)
|
|
rm -rf web/build web/.svelte-kit
|