fixup! build: Integrate with vscode

Author: jimmidyson

.github/workflows/checks.yml

@@ -211,6 +211,7 @@ jobs:
         run: devbox run -- make pre-commit
         env:
           SKIP: no-commit-to-branch,golangci-lint,actionlint-system
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   lint-test-helm:
     runs-on: ubuntu-24.04

.golangci-kal.yml

@@ -23,6 +23,7 @@ linters:
     - govet
     - importas
     - ineffassign
+    - kubeapilinter
     - lll
     - misspell
     - nolintlint
@@ -74,8 +75,55 @@ linters:
         - github.com/onsi/gomega
     testifylint:
       enable-all: true
+    custom:
+      kubeapilinter:
+        type: module
+        description: KAL is the Kube-API-Linter and lints Kube like APIs based on API conventions and best practices.
+        settings:
+          linters:
+            enable:
+              # - "commentstart" # Ensure comments start with the serialized version of the field name.
+              # - "conditions" # Ensure conditions have the correct json tags and markers.
+              - "duplicatemarkers" # Ensure there are no exact duplicate markers. for types and fields.
+              - "integers" # Ensure only int32 and int64 are used for integers.
+              - "jsontags" # Ensure every field has a json tag.
+              - "maxlength" # Ensure all strings and arrays have maximum lengths/maximum items.
+              - "nobools" # Bools do not evolve over time, should use enums instead.
+              - "nofloats" # Ensure floats are not used.
+              # - "nomaps" # Ensure maps are not used.
+              # - "nophase" # Ensure phases are not used, as they are not extensible.
+              - "optionalfields" # Ensure that all fields marked as optional adhere to being pointers and
+                                 # having the `omitempty` value in their `json` tag where appropriate.
+              - "optionalorrequired" # Every field should be marked as `+optional` or `+required`.
+              - "requiredfields" # Required fields should not be pointers, and should not have `omitempty`.
+              # - "ssatags" # Ensure array fields have the appropriate listType markers
+              # - "statusoptional" # Ensure all first children within status should be optional.
+              # - "statussubresource" # All root objects that have a `status` field should have a status subresource.
+              - "uniquemarkers" # Ensure that types and fields do not contain more than a single definition of a marker that should only be present once.
+
+            # Linters below this line are disabled, pending conversation on how and when to enable them.
+            disable:
+            - "*" # We will manually enable new linters after understanding the impact. Disable all by default.
+          lintersConfig:
+            optionalfields:
+              pointers:
+                preference: WhenRequired # Always | WhenRequired # Whether to always require pointers, or only when required. Defaults to `Always`.
+            jsontags:
+              jsonTagRegex: "^[a-z][a-z0-9-]*(?:[A-Z][a-z0-9]*)*$" # The default regex is appropriate for our use case.
+            optionalorrequired:
+              preferredOptionalMarker: kubebuilder:validation:Optional # The preferred optional marker to use, fixes will suggest to use this marker. Defaults to `optional`.
+              preferredRequiredMarker: kubebuilder:validation:Required # The preferred required marker to use, fixes will suggest to use this marker. Defaults to `required`.
   exclusions:
-    generated: lax
+    generated: strict
+    paths:
+      # Ignore generated files.
+      - zz_generated.*\.go$
+      # Ignore external API packages.
+      - external/
+      # Ignore test files.
+      - '.+_test\.go$'
+      # Ignore aggregate types.
+      - 'aggregate_types\.go$'
     presets:
       - comments
       - common-false-positives
@@ -103,11 +151,36 @@ linters:
           - gocritic
         path: internal/test/envtest
         text: 'hugeParam: input is heavy'
-    paths:
-      - external
-      - third_party$
-      - builtin$
-      - examples$
+
+      # START kube-api-linter rules
+      - path: ".*"
+        text: "optionalorrequired: embedded field  must be marked as kubebuilder:validation:Optional or kubebuilder:validation:Required"
+        linters:
+          - kubeapilinter
+
+      # kube-api-linter does not handle formats correctly yet.
+      - path: '/addon_types\.go$'
+        text: "maxlength: field (Start|End) must have a maximum length, add kubebuilder:validation:MaxLength marker"
+        linters:
+          - kubeapilinter
+      - path: '/common_types\.go$'
+        text: "maxlength: field Address must have a maximum length, add kubebuilder:validation:MaxLength marker"
+        linters:
+          - kubeapilinter
+
+      # kube-api-linter does not handle patterns correctly yet.
+      - path: '/aws_(clusterconfig|node)_types\.go$'
+        text: "maxlength: field (ID|IAMInstanceProfile|InstanceType|Org) must have a maximum length, add kubebuilder:validation:MaxLength marker"
+        linters:
+          - kubeapilinter
+      - path: '/(nutanix_)?(clusterconfig)_types\.go$'
+        text: "maxlength: field (URL|Tag) must have a maximum length, add kubebuilder:validation:MaxLength marker"
+        linters:
+          - kubeapilinter
+      - path-except: "^/api/"
+        linters:
+          - kubeapilinter
+      # END kube-api-linter rules
 formatters:
   enable:
     - gci

.golangci.yml

@@ -15,18 +15,17 @@ repos:
     language: system
     files: "(.*\\.go|go.mod|go.sum|go.mk)$"
     pass_filenames: false
+  - id: check-coredns-versions
+    name: check-coredns-versions
+    entry: make coredns.sync
+    language: system
+    files: "^api/versions/coredns.go$"
   - id: golangci-lint
     name: golangci-lint
     entry: make lint
     language: system
     files: "(.*\\.go|go.mod|go.sum|go.mk)$"
     pass_filenames: false
-  - id: kube-api-linter
-    name: kube-api-linter
-    entry: make lint-kube-api
-    language: system
-    files: "((^api/(.*\\.go|go.mod|go.sum))|go.mk)$"
-    pass_filenames: false
   - id: chart-docs
     name: chart-docs
     entry: make chart-docs
@@ -69,11 +68,6 @@ repos:
     language: system
     files: "^devbox.(yaml|lock)$"
     pass_filenames: false
-  - id: check-coredns-versions
-    name: check-coredns-versions
-    entry: make coredns.sync
-    language: system
-    files: "^api/versions/coredns.go$"
 - repo: https://github.com/tekwizely/pre-commit-golang
   rev: v1.0.0-rc.1
   hooks:

.pre-commit-config.yaml

@@ -284,7 +284,7 @@ type StorageClassConfig struct {
 
 	// If the storage class should allow volume expanding
 	// +kubebuilder:validation:Optional
-	AllowExpansion bool `json:"allowExpansion,omitempty"` //nolint:kubeapilinter,lll // Leave as bool for backward compatibility and this comment makes it a long line.
+	AllowExpansion bool `json:"allowExpansion,omitempty"`
 }
 
 type CSICredentials struct {

api/v1alpha1/addon_types.go

@@ -35,7 +35,7 @@ type NutanixPrismCentralEndpointSpec struct {
 
 	// use insecure connection to Prism Central endpoint
 	// +kubebuilder:validation:Optional
-	Insecure bool `json:"insecure,omitempty"` //nolint:kubeapilinter // Leave as bool for backward compatibility.
+	Insecure bool `json:"insecure,omitempty"`
 
 	// A base64 PEM encoded x509 cert for the RootCA that was used to create
 	// the certificate for a Prism Central that uses certificates that were issued by a non-publicly trusted RootCA.

api/v1alpha1/nutanix_clusterconfig_types.go

@@ -854,50 +854,50 @@
       }
     },
     "golangci-lint@latest": {
-      "last_modified": "2025-07-04T02:32:11Z",
-      "resolved": "github:NixOS/nixpkgs/472908faa934435cf781ae8fac77291af3d137d3#golangci-lint",
+      "last_modified": "2025-07-18T03:30:42Z",
+      "resolved": "github:NixOS/nixpkgs/e821e03193486359aa942372be2d9c1f377b7a18#golangci-lint",
       "source": "devbox-search",
-      "version": "2.2.1",
+      "version": "2.2.2",
       "systems": {
         "aarch64-darwin": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/y34ymr5fc4nywh487v49djqzplqy8nih-golangci-lint-2.2.1",
+              "path": "/nix/store/00sy2bp921ax5cxphxz0ifgax6i97mx7-golangci-lint-2.2.2",
               "default": true
             }
           ],
-          "store_path": "/nix/store/y34ymr5fc4nywh487v49djqzplqy8nih-golangci-lint-2.2.1"
+          "store_path": "/nix/store/00sy2bp921ax5cxphxz0ifgax6i97mx7-golangci-lint-2.2.2"
         },
         "aarch64-linux": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/yvlh8x7mmlg7j8vqbzjslngipvkgfgdc-golangci-lint-2.2.1",
+              "path": "/nix/store/gvay3vc5ll70dfryiy6qa16w3ybagiq7-golangci-lint-2.2.2",
               "default": true
             }
           ],
-          "store_path": "/nix/store/yvlh8x7mmlg7j8vqbzjslngipvkgfgdc-golangci-lint-2.2.1"
+          "store_path": "/nix/store/gvay3vc5ll70dfryiy6qa16w3ybagiq7-golangci-lint-2.2.2"
         },
         "x86_64-darwin": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/zji7s77vyb0l2gpnz1nsa7al4w83rjw6-golangci-lint-2.2.1",
+              "path": "/nix/store/9pxfg0y3hiaf08vnzk2fs4qh76r2kd22-golangci-lint-2.2.2",
               "default": true
             }
           ],
-          "store_path": "/nix/store/zji7s77vyb0l2gpnz1nsa7al4w83rjw6-golangci-lint-2.2.1"
+          "store_path": "/nix/store/9pxfg0y3hiaf08vnzk2fs4qh76r2kd22-golangci-lint-2.2.2"
         },
         "x86_64-linux": {
           "outputs": [
             {
               "name": "out",
-              "path": "/nix/store/p1144qggxazwz6791avlf6cqzyvkh8cv-golangci-lint-2.2.1",
+              "path": "/nix/store/z0d7708yc7d0z6nj0mwalbi6hf79yj68-golangci-lint-2.2.2",
               "default": true
             }
           ],
-          "store_path": "/nix/store/p1144qggxazwz6791avlf6cqzyvkh8cv-golangci-lint-2.2.1"
+          "store_path": "/nix/store/z0d7708yc7d0z6nj0mwalbi6hf79yj68-golangci-lint-2.2.2"
         }
       }
     },

api/versions/coredns.go

@@ -0,0 +1,36 @@
++++
+title = "Linting"
+icon = "fa-solid fa-magnifying-glass"
++++
+
+This project uses [`golangci-lint`][golangci-lint] to both lint and format the CAREN sourcecode. `golangci-lint` is
+installed via devbox, just as every other development tool that this project uses. The `golangci-lint` configuration
+includes a custom linter, [`kube-api-linter`][kube-api-linter], integrated as a `golangci-lint` [module plugin].
+
+## Installing `golangci-lint` with KAL
+
+To install the customized linter binary into `hack/tools/golangci-lint-kube-api-linter`, run:
+
+```bash
+make hack/tools/golangci-lint-kube-api-linter
+```
+
+## Integrating with vscode
+
+One the customized linter has been installed above, `vscode` can be configured to run this linter. Add the followin
+configuration to `.vscode/settings.json`:
+
+```json
+  "go.lintTool": "golangci-lint",
+  "go.lintFlags": ["--path-mode=abs"],
+  "go.formatTool": "custom",
+  "go.alternateTools": {
+    "customFormatter": "golangci-lint",
+    "golangci-lint": "${workspaceFolder}/hack/tools/golangci-lint-kube-api-linter"
+  },
+  "go.formatFlags": ["fmt", "--stdin"]
+```
+
+[golangci-lint]: https://golangci-lint.run/
+[kube-api-linter]: https://github.com/kubernetes-sigs/kube-api-linter/
+[module plugin]: https://golangci-lint.run/plugins/module-plugins/

devbox.lock

@@ -1,7 +1,7 @@
 # Copyright 2025 Nutanix. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-version: v2.2.1
+version: v2.2.2
 name: golangci-lint-kube-api-linter
 plugins:
 - module: 'sigs.k8s.io/kube-api-linter'