From 7ad48953a4d9470d2f4fe89343c0b09bff410c58 Mon Sep 17 00:00:00 2001 From: Alan Pearce Date: Thu, 2 May 2024 13:55:48 +0200 Subject: chore: initial commit --- .editorconfig | 19 ++++++ .envrc.sample | 11 ++++ .gitignore | 29 ++++++++ .golangci.yaml | 23 +++++++ LICENSE | 19 ++++++ README.md | 35 ++++++++++ default.nix | 68 +++++++++++++++++++ go.mod | 3 + gomod2nix.toml | 3 + justfile | 16 +++++ nix/sources.json | 38 +++++++++++ nix/sources.nix | 198 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ serve/main.go | 5 ++ shell.nix | 33 ++++++++++ 14 files changed, 500 insertions(+) create mode 100644 .editorconfig create mode 100644 .envrc.sample create mode 100644 .gitignore create mode 100644 .golangci.yaml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 default.nix create mode 100644 go.mod create mode 100644 gomod2nix.toml create mode 100644 justfile create mode 100644 nix/sources.json create mode 100644 nix/sources.nix create mode 100644 serve/main.go create mode 100644 shell.nix diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..13a6a6f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,19 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[{justfile,go.mod,go.sum,*.go,.gitmodules}] +indent_style = tab + +[*.yaml] +indent_size = 4 + +[*.md] +indent_size = 4 +trim_trailing_whitespace = false diff --git a/.envrc.sample b/.envrc.sample new file mode 100644 index 0000000..dc0051f --- /dev/null +++ b/.envrc.sample @@ -0,0 +1,11 @@ +#!/usr/bin/env bash +# the shebang is ignored, but nice for editors + +layout go + +if type -P lorri &>/dev/null; then + eval "$(lorri direnv)" +else + echo 'while direnv evaluated .envrc, could not find the command "lorri" [https://github.com/nix-community/lorri]' + use nix +fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2368a38 --- /dev/null +++ b/.gitignore @@ -0,0 +1,29 @@ +# Allowlisting gitignore template for GO projects prevents us +# from adding various unwanted local files, such as generated +# files, developer configurations or IDE-specific files etc. +# +# Recommended: Go.AllowList.gitignore + +# Ignore everything +* + +# But not these files... +!/.gitignore +!/.editorconfig +!/.envrc.sample + +!/README.md +!/LICENSE +!/justfile + +!/nix +!*.nix + +!/.golangci.yaml +!/go.sum +!/go.mod +!/gomod2nix.toml +!*.go + +# ...even if they are in subdirectories +!*/ diff --git a/.golangci.yaml b/.golangci.yaml new file mode 100644 index 0000000..4567686 --- /dev/null +++ b/.golangci.yaml @@ -0,0 +1,23 @@ +--- +# yamllint disable-line rule:line-length +# yaml-language-server: $schema=https://golangci-lint.run/jsonschema/golangci.jsonschema.json +linters: + fast: false + enable: + - gocritic + - godox + - gosec + - grouper + - lll + - nilerr + - nilnil + - nlreturn + - noctx + - nosprintfhostport + - paralleltest + - prealloc + - reassign + - revive + - sloglint + - unconvert + - wrapcheck diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..edbe912 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2024 Alan Pearce + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e6cf90d --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Searchix + +## Development + +### Pre-requisites + +- [Nix (the package manager)](https://nixos.org/download/) +- Optional: + - [cachix](https://docs.cachix.org/installation#installation) + - [lorri](https://github.com/nix-community/lorri) + - [direnv](https://direnv.net/) + +### Setup + +1. Optional: use cachix to avoid building some tools + + ```shell-session + cachix use pre-commit-hooks + ``` + +2. Start a nix shell (this will take some time) + + ```shell-session + nix-shell + ``` + +3. Optional: install and set up lorri and use `lorri shell` instead of `nix-shell` + +4. Optional: install direnv, integrate it with your shell and then run + + ```shell-session + ln -s .envrc.sample .envrc + ``` + + Now `nix-shell` or `lorri shell` will be run for you automatically when you `cd` into this directory. diff --git a/default.nix b/default.nix new file mode 100644 index 0000000..0697abc --- /dev/null +++ b/default.nix @@ -0,0 +1,68 @@ +let + sources = import ./nix/sources.nix; +in +{ pkgs ? ( + import sources.nixpkgs { + overlays = [ + (import "${sources.gomod2nix}/overlay.nix") + ]; + } + ) +}: { + searchix = pkgs.buildGoApplication { + pname = "searchix"; + version = "0.1"; + pwd = ./.; + src = ./.; + modules = ./gomod2nix.toml; + }; + + pre-commit-check = (import sources.git-hooks).run { + src = ./.; + hooks = { + gotest.enable = true; + golangci-lint.enable = true; + staticcheck.enable = true; + + statix.enable = true; + deadnix = { + enable = true; + excludes = [ "./nix" ]; + }; + nixpkgs-fmt.enable = true; + + convco.enable = true; + + check-case-conflicts.enable = true; + check-symlinks.enable = true; + editorconfig-checker.enable = true; + prettier = { + enable = true; + types_or = [ "plain-text" "yaml" ]; + settings = { + check = true; + }; + }; + + yamllint = { + enable = true; + }; + go-mod-tidy = { + enable = true; + name = "go-mod-tidy"; + description = "Run `go mod tidy`"; + types_or = [ "go" "go-mod" ]; + entry = "${pkgs.go}/bin/go mod tidy"; + pass_filenames = false; + }; + gomod2nix = { + enable = true; + name = "gomod2nix"; + description = "Import go.mod updates to nix"; + types_or = [ "go-sum" ]; + entry = "${pkgs.gomod2nix}/bin/gomod2nix"; + pass_filenames = false; + }; + }; + }; +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..dcd2a6c --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module searchix + +go 1.22.2 diff --git a/gomod2nix.toml b/gomod2nix.toml new file mode 100644 index 0000000..43cd4cf --- /dev/null +++ b/gomod2nix.toml @@ -0,0 +1,3 @@ +schema = 3 + +[mod] diff --git a/justfile b/justfile new file mode 100644 index 0000000..8054509 --- /dev/null +++ b/justfile @@ -0,0 +1,16 @@ +default: + @just --list --justfile {{ justfile() }} --unsorted + +checkformat: + gofmt -d . + goimports -d . + +format: + gofmt -w . + goimports -w . + +fix: + go fix . + +precommit: + nix-build -A pre-commit-check diff --git a/nix/sources.json b/nix/sources.json new file mode 100644 index 0000000..1f2d396 --- /dev/null +++ b/nix/sources.json @@ -0,0 +1,38 @@ +{ + "git-hooks": { + "branch": "master", + "description": "Seamless integration of https://pre-commit.com git hooks with Nix.", + "homepage": "", + "owner": "cachix", + "repo": "git-hooks.nix", + "rev": "2849da033884f54822af194400f8dff435ada242", + "sha256": "0ag90l0hrkhm02mkmm8yf3fnjjawv99czc7bp0szzgknps0xrzxb", + "type": "tarball", + "url": "https://github.com/cachix/git-hooks.nix/archive/2849da033884f54822af194400f8dff435ada242.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + }, + "gomod2nix": { + "branch": "master", + "description": "Convert applications using Go modules to Nix expressions [maintainer=@adisbladis]", + "homepage": "", + "owner": "nix-community", + "repo": "gomod2nix", + "rev": "872b63ddd28f318489c929d25f1f0a3c6039c971", + "sha256": "1wh9rlhg2w42fsavh7wxvmw42l7m5wg290gnp571dq0qcr1z7kg1", + "type": "tarball", + "url": "https://github.com/nix-community/gomod2nix/archive/872b63ddd28f318489c929d25f1f0a3c6039c971.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + }, + "nixpkgs": { + "branch": "nixos-unstable", + "description": "Nix Packages collection", + "homepage": null, + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "58a1abdbae3217ca6b702f03d3b35125d88a2994", + "sha256": "05rpyikxpjf15nrzggrx4m0kjkjcmpyhm714nfrbhsp5cp1x1m4r", + "type": "tarball", + "url": "https://github.com/NixOS/nixpkgs/archive/58a1abdbae3217ca6b702f03d3b35125d88a2994.tar.gz", + "url_template": "https://github.com///archive/.tar.gz" + } +} diff --git a/nix/sources.nix b/nix/sources.nix new file mode 100644 index 0000000..fe3dadf --- /dev/null +++ b/nix/sources.nix @@ -0,0 +1,198 @@ +# This file has been generated by Niv. + +let + + # + # The fetchers. fetch_ fetches specs of type . + # + + fetch_file = pkgs: name: spec: + let + name' = sanitizeName name + "-src"; + in + if spec.builtin or true then + builtins_fetchurl { inherit (spec) url sha256; name = name'; } + else + pkgs.fetchurl { inherit (spec) url sha256; name = name'; }; + + fetch_tarball = pkgs: name: spec: + let + name' = sanitizeName name + "-src"; + in + if spec.builtin or true then + builtins_fetchTarball { name = name'; inherit (spec) url sha256; } + else + pkgs.fetchzip { name = name'; inherit (spec) url sha256; }; + + fetch_git = name: spec: + let + ref = + spec.ref or ( + if spec ? branch then "refs/heads/${spec.branch}" else + if spec ? tag then "refs/tags/${spec.tag}" else + abort "In git source '${name}': Please specify `ref`, `tag` or `branch`!" + ); + submodules = spec.submodules or false; + submoduleArg = + let + nixSupportsSubmodules = builtins.compareVersions builtins.nixVersion "2.4" >= 0; + emptyArgWithWarning = + if submodules + then + builtins.trace + ( + "The niv input \"${name}\" uses submodules " + + "but your nix's (${builtins.nixVersion}) builtins.fetchGit " + + "does not support them" + ) + { } + else { }; + in + if nixSupportsSubmodules + then { inherit submodules; } + else emptyArgWithWarning; + in + builtins.fetchGit + ({ url = spec.repo; inherit (spec) rev; inherit ref; } // submoduleArg); + + fetch_local = spec: spec.path; + + fetch_builtin-tarball = name: throw + ''[${name}] The niv type "builtin-tarball" is deprecated. You should instead use `builtin = true`. + $ niv modify ${name} -a type=tarball -a builtin=true''; + + fetch_builtin-url = name: throw + ''[${name}] The niv type "builtin-url" will soon be deprecated. You should instead use `builtin = true`. + $ niv modify ${name} -a type=file -a builtin=true''; + + # + # Various helpers + # + + # https://github.com/NixOS/nixpkgs/pull/83241/files#diff-c6f540a4f3bfa4b0e8b6bafd4cd54e8bR695 + sanitizeName = name: + ( + concatMapStrings (s: if builtins.isList s then "-" else s) + ( + builtins.split "[^[:alnum:]+._?=-]+" + ((x: builtins.elemAt (builtins.match "\\.*(.*)" x) 0) name) + ) + ); + + # The set of packages used when specs are fetched using non-builtins. + mkPkgs = sources: system: + let + sourcesNixpkgs = + import (builtins_fetchTarball { inherit (sources.nixpkgs) url sha256; }) { inherit system; }; + hasNixpkgsPath = builtins.any (x: x.prefix == "nixpkgs") builtins.nixPath; + hasThisAsNixpkgsPath = == ./.; + in + if builtins.hasAttr "nixpkgs" sources + then sourcesNixpkgs + else if hasNixpkgsPath && ! hasThisAsNixpkgsPath then + import { } + else + abort + '' + Please specify either (through -I or NIX_PATH=nixpkgs=...) or + add a package called "nixpkgs" to your sources.json. + ''; + + # The actual fetching function. + fetch = pkgs: name: spec: + + if ! builtins.hasAttr "type" spec then + abort "ERROR: niv spec ${name} does not have a 'type' attribute" + else if spec.type == "file" then fetch_file pkgs name spec + else if spec.type == "tarball" then fetch_tarball pkgs name spec + else if spec.type == "git" then fetch_git name spec + else if spec.type == "local" then fetch_local spec + else if spec.type == "builtin-tarball" then fetch_builtin-tarball name + else if spec.type == "builtin-url" then fetch_builtin-url name + else + abort "ERROR: niv spec ${name} has unknown type ${builtins.toJSON spec.type}"; + + # If the environment variable NIV_OVERRIDE_${name} is set, then use + # the path directly as opposed to the fetched source. + replace = name: drv: + let + saneName = stringAsChars (c: if (builtins.match "[a-zA-Z0-9]" c) == null then "_" else c) name; + ersatz = builtins.getEnv "NIV_OVERRIDE_${saneName}"; + in + if ersatz == "" then drv else + # this turns the string into an actual Nix path (for both absolute and + # relative paths) + if builtins.substring 0 1 ersatz == "/" then /. + ersatz else /. + builtins.getEnv "PWD" + "/${ersatz}"; + + # Ports of functions for older nix versions + + # a Nix version of mapAttrs if the built-in doesn't exist + mapAttrs = builtins.mapAttrs or ( + f: set: with builtins; + listToAttrs (map (attr: { name = attr; value = f attr set.${attr}; }) (attrNames set)) + ); + + # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/lists.nix#L295 + range = first: last: if first > last then [ ] else builtins.genList (n: first + n) (last - first + 1); + + # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L257 + stringToCharacters = s: map (p: builtins.substring p 1 s) (range 0 (builtins.stringLength s - 1)); + + # https://github.com/NixOS/nixpkgs/blob/0258808f5744ca980b9a1f24fe0b1e6f0fecee9c/lib/strings.nix#L269 + stringAsChars = f: s: concatStrings (map f (stringToCharacters s)); + concatMapStrings = f: list: concatStrings (map f list); + concatStrings = builtins.concatStringsSep ""; + + # https://github.com/NixOS/nixpkgs/blob/8a9f58a375c401b96da862d969f66429def1d118/lib/attrsets.nix#L331 + optionalAttrs = cond: as: if cond then as else { }; + + # fetchTarball version that is compatible between all the versions of Nix + builtins_fetchTarball = { url, name ? null, sha256 }@attrs: + let + inherit (builtins) lessThan nixVersion fetchTarball; + in + if lessThan nixVersion "1.12" then + fetchTarball ({ inherit url; } // (optionalAttrs (name != null) { inherit name; })) + else + fetchTarball attrs; + + # fetchurl version that is compatible between all the versions of Nix + builtins_fetchurl = { url, name ? null, sha256 }@attrs: + let + inherit (builtins) lessThan nixVersion fetchurl; + in + if lessThan nixVersion "1.12" then + fetchurl ({ inherit url; } // (optionalAttrs (name != null) { inherit name; })) + else + fetchurl attrs; + + # Create the final "sources" from the config + mkSources = config: + mapAttrs + ( + name: spec: + if builtins.hasAttr "outPath" spec + then + abort + "The values in sources.json should not have an 'outPath' attribute" + else + spec // { outPath = replace name (fetch config.pkgs name spec); } + ) + config.sources; + + # The "config" used by the fetchers + mkConfig = + { sourcesFile ? if builtins.pathExists ./sources.json then ./sources.json else null + , sources ? if sourcesFile == null then { } else builtins.fromJSON (builtins.readFile sourcesFile) + , system ? builtins.currentSystem + , pkgs ? mkPkgs sources system + }: rec { + # The sources, i.e. the attribute set of spec name to spec + inherit sources; + + # The "pkgs" (evaluated nixpkgs) to use for e.g. non-builtin fetchers + inherit pkgs; + }; + +in +mkSources (mkConfig { }) // { __functor = _: settings: mkSources (mkConfig settings); } diff --git a/serve/main.go b/serve/main.go new file mode 100644 index 0000000..7905807 --- /dev/null +++ b/serve/main.go @@ -0,0 +1,5 @@ +package main + +func main() { + +} diff --git a/shell.nix b/shell.nix new file mode 100644 index 0000000..ae73c6b --- /dev/null +++ b/shell.nix @@ -0,0 +1,33 @@ +{ pkgs ? ( + let + sources = import ./nix/sources.nix; + in + import sources.nixpkgs { + overlays = [ + (import "${sources.gomod2nix}/overlay.nix") + ]; + } + ) +}: + +let + goEnv = pkgs.mkGoEnv { pwd = ./.; }; + searchix = import ./default.nix { + inherit pkgs; + }; +in +pkgs.mkShell { + packages = with pkgs; [ + goEnv + + gomod2nix + niv + nixpkgs-lint + + bun + ]; + shellHook = '' + ${searchix.pre-commit-check.shellHook} + ''; + buildInputs = searchix.pre-commit-check.enabledPackages; +} -- cgit 1.4.1