Merge pull request #173 from maxmind/greg/eng-4369

ENG-4369: Update golangci-lint to 2.11.3 via mise

Author: horgh

.github/workflows/golangci-lint.yml .github/workflows/precious.yml.github/workflows/golangci-lint.yml renamed to .github/workflows/precious.yml

@@ -1,22 +1,24 @@
-name: golangci-lint
+name: precious
 
 on:
   push:
   pull_request:
   schedule:
-    - cron: "4 10 * * SUN"
+    - cron: '4 10 * * SUN'
 
 permissions: {}
 
 jobs:
-  golangci:
+  precious:
     name: lint
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # 9.2.0
+      - name: Setup mise
+        uses: jdx/mise-action@6d1e696aa24c1aa1bcc1adea0212707c71ab78a8 # v3.6.1
         with:
-          version: latest
+          cache: true
+      - name: Run precious lint
+        run: precious lint --all

.precious.toml

@@ -0,0 +1,30 @@
+exclude = [
+    ".git",
+]
+
+[commands.golangci-lint-fmt]
+type = "both"
+cmd = ["golangci-lint", "fmt"]
+lint-flags = "--diff"
+ok-exit-codes = 0
+invoke = "once"
+include = ["**/*.go"]
+
+[commands.golangci-lint]
+type = "both"
+cmd = ["golangci-lint", "run"]
+tidy-flags = ["--fix"]
+ok-exit-codes = 0
+ignore-stderr = ".*"
+invoke = "once"
+path-args = "dir"
+include = ["**/*.go"]
+
+[commands.prettier-markdown]
+type = "both"
+cmd = ["prettier", "--prose-wrap", "always"]
+lint-flags = ["--check"]
+tidy-flags = ["--write"]
+path-args = "absolute-file"
+include = "**/*.md"
+ok-exit-codes = 0

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "proseWrap": "always",
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false
+}

CHANGELOG.md

@@ -2,56 +2,54 @@
 
 ## 2.0.0 (2025-11-12)
 
-* **BREAKING CHANGE**: Networks with empty map or empty array data are now
-  skipped by default. This makes the output cleaner when working with
-  databases that use empty values for networks without meaningful data (e.g.,
-  public IPs in some databases). Use the new `-include-empty-values` flag to
-  include these networks in the output.
-* Added `-include-empty-values` flag to optionally include networks whose data
+- **BREAKING CHANGE**: Networks with empty map or empty array data are now
+  skipped by default. This makes the output cleaner when working with databases
+  that use empty values for networks without meaningful data (e.g., public IPs
+  in some databases). Use the new `-include-empty-values` flag to include these
+  networks in the output.
+- Added `-include-empty-values` flag to optionally include networks whose data
   is an empty map or empty array.
 
 ## 2.0.0-beta.2 (2025-03-11)
 
-* Fixes for the release scripts. No other changes.
+- Fixes for the release scripts. No other changes.
 
 ## 2.0.0-beta.1 (2025-03-11)
 
-* The default output format is now YAML. This was done to improve the
-  readability when using the tool as a standalone utility for doing lookups
-  in an MMDB database. Use the `-jsonl` flag to output as JSONL instead.
-* When outputting as JSON, we now use JSONL. There is one JSON object per
-  line.
-* The output format has been flattened. Each record that is output now
-  contains the following keys: `database_path`, `requested_lookup`,
-  `network`, and `record`. This allows for efficient streaming of large
-  lookups, makes the key naming more consistent, and reduces the depth of
-  the data structure.
-* You may now use a glob for the `-db` argument. If there are multiple
-  matches, it will be treated as if multiple `-db` arguments were provided.
-  Note that you must quote the parameter when using globs to prevent the
-  shell's globbing from interfering. See the [pattern syntax](https://pkg.go.dev/path#Match)
-* The following flags were added:
-  * `-include-networks-without-data` - include networks without any data in
-    the database in the output.
-  * `-include-build-time` - include the build time from the database's
-    metadata in the output.
-* This repo no longer provides a public Go API. It is only intended to be
-  used as a CLI program.
+- The default output format is now YAML. This was done to improve the
+  readability when using the tool as a standalone utility for doing lookups in
+  an MMDB database. Use the `-jsonl` flag to output as JSONL instead.
+- When outputting as JSON, we now use JSONL. There is one JSON object per line.
+- The output format has been flattened. Each record that is output now contains
+  the following keys: `database_path`, `requested_lookup`, `network`, and
+  `record`. This allows for efficient streaming of large lookups, makes the key
+  naming more consistent, and reduces the depth of the data structure.
+- You may now use a glob for the `-db` argument. If there are multiple matches,
+  it will be treated as if multiple `-db` arguments were provided. Note that you
+  must quote the parameter when using globs to prevent the shell's globbing from
+  interfering. See the [pattern syntax](https://pkg.go.dev/path#Match)
+- The following flags were added:
+  - `-include-networks-without-data` - include networks without any data in the
+    database in the output.
+  - `-include-build-time` - include the build time from the database's metadata
+    in the output.
+- This repo no longer provides a public Go API. It is only intended to be used
+  as a CLI program.
 
 ## 0.2.0 (2024-01-10)
 
-* Don't escape `&`, `<`, and `>` in JSON output
-* Skip aliased IPv6 networks by default
-* Build and test with Go 1.21
-* Remove deprecated use of ioutil and pkg/errors
-* Update dependencies
-* Update documentation
+- Don't escape `&`, `<`, and `>` in JSON output
+- Skip aliased IPv6 networks by default
+- Build and test with Go 1.21
+- Remove deprecated use of ioutil and pkg/errors
+- Update dependencies
+- Update documentation
 
 ## 0.1.1 (2020-02-18)
 
-* Fix release config
-* Add release instructions
+- Fix release config
+- Add release instructions
 
 ## 0.1.0 (2020-02-18)
 
-* Initial beta release
+- Initial beta release

README.dev.md

@@ -1,26 +1,26 @@
 # Prereqs
 
-* You must have the [GitHub CLI tool (gh)](https://cli.github.com/)
-  installed, in your path, and logged into an account that can
-  make GitHub releases on the repo.
-* Your environment also must have `bash`, `git` and `sed`  available.
+- You must have the [GitHub CLI tool (gh)](https://cli.github.com/) installed,
+  in your path, and logged into an account that can make GitHub releases on the
+  repo.
+- Your environment also must have `bash`, `git` and `sed` available.
 
 # Releasing
 
-* Review open issues and PRs to see if anything needs to be addressed
-  before release.
-* Create a branch e.g. `horgh/release` and switch to it.
-  * `main` is protected.
-* Set the release version and release date in `CHANGELOG.md`. Be sure
-  the version follows [Semantic Versionsing](https://semver.org/).
-  * Mention recent changes if needed.
-* Commit these changes.
-* Run `dev-bin/release.sh`.
-  * You might need to initialize/update submodules to successfully run tests,
+- Review open issues and PRs to see if anything needs to be addressed before
+  release.
+- Create a branch e.g. `horgh/release` and switch to it.
+  - `main` is protected.
+- Set the release version and release date in `CHANGELOG.md`. Be sure the
+  version follows [Semantic Versionsing](https://semver.org/).
+  - Mention recent changes if needed.
+- Commit these changes.
+- Run `dev-bin/release.sh`.
+  - You might need to initialize/update submodules to successfully run tests,
     eg. `git submodule update --init --recursive`.
-* Verify the release on the GitHub Releases page.
-* If everything goes well, the authorized releasers will receive an email
-  to review the pending deployment. If you are an authorized releaser,
-  you will need to approve the release deployment run. If you are not,
-  you will have to wait for an authorized releaser to do so.
-* Make a PR and get it merged.
+- Verify the release on the GitHub Releases page.
+- If everything goes well, the authorized releasers will receive an email to
+  review the pending deployment. If you are an authorized releaser, you will
+  need to approve the release deployment run. If you are not, you will have to
+  wait for an authorized releaser to do so.
+- Make a PR and get it merged.