Zig lint improvements (#7683)

* don't require comments on init+deinit

* ignore re-exports

* typo

* predicate-quantifier does not exist

Signed-off-by: Anton-4 <[email protected]>

Author: Anton-4

.github/workflows/ci_manager.yml

@@ -27,19 +27,18 @@ jobs:
               - 'build.zig'
               - 'build.zig.zon'
               - '.github/workflows/ci_zig.yml'
-              - 'ci/zig-lints.sh'
+              - 'ci/zig_lints.sh'
       - uses: dorny/paths-filter@v3
         id: other_filter
         with:
-          predicate-quantifier: 'every'
           filters: |
             other_than_zig:
               - '**/*'
               - '!src/**'
               - '!build.zig'
               - '!build.zig.zon'
               - '!.github/workflows/ci_zig.yml'
-              - '!ci/zig-lints.sh'
+              - '!ci/zig_lints.sh'
 
   call-zig-workflow:
     needs: check-changes

ci/zig_lints.sh

@@ -12,7 +12,12 @@ while read -r file; do
     errors=$(awk '
         /^pub / {
             if (prev !~ /^\/\/\//) {
-                print FILENAME ":" FNR ": pub declaration without doc comment `///`"
+                # Skip doc comment requirements for init, deinit, and @import
+                if ($0 !~ /pub.*fn init\(/ && 
+                    $0 !~ /pub.*fn deinit/ && 
+                    $0 !~ /pub.*@import/) {
+                    print FILENAME ":" FNR ": pub declaration without doc comment `///`"
+                }
             }
         }
         { prev = $0 }

src/base.zig

@@ -4,20 +4,14 @@ const std = @import("std");
 const parse = @import("check/parse.zig");
 const module_work = @import("base/module_work.zig");
 
-/// re-export the S-expression helpers
 pub const sexpr = @import("base/sexpr.zig");
-/// re-export Ident
 pub const Ident = @import("base/Ident.zig");
-/// re-export Region
 pub const Region = @import("base/Region.zig");
-/// re-export Package
 pub const Package = @import("base/Package.zig");
-/// re-export ModuleEnv
 pub const ModuleEnv = @import("base/ModuleEnv.zig");
-/// re-export ModuleImport
 pub const ModuleImport = @import("base/ModuleImport.zig");
-/// re-export StringLiteral
 pub const StringLiteral = @import("base/StringLiteral.zig");
+
 /// re-export ModuleWork
 pub const ModuleWork = module_work.ModuleWork;
 /// re-export ModuleWorkIdx

src/build/lift_functions/IR.zig

@@ -21,7 +21,6 @@ typed_patterns: Pattern.Typed.List,
 typed_idents: TypedIdent.List,
 when_branches: WhenBranch.List,
 
-/// todo
 pub fn init(env: *base.ModuleEnv) Self {
     return Self{
         .env = env,

src/build/lower_statements/IR.zig

@@ -18,7 +18,6 @@ stmts: Stmt.List,
 idents_with_layouts: IdentWithLayout.List,
 list_literal_elems: ListLiteralElem.List,
 
-/// todo
 pub fn init(env: *base.ModuleEnv) Self {
     return Self{
         .env = env,
@@ -32,7 +31,6 @@ pub fn init(env: *base.ModuleEnv) Self {
     };
 }
 
-/// todo
 pub fn deinit(self: *Self) void {
     self.procedures.deinit(self.env.gpa);
     self.constants.deinit(self.env.gpa);

src/build/reference_count/IR.zig

@@ -18,7 +18,6 @@ stmts: Stmt.List,
 idents_with_layouts: IdentWithLayout.List,
 list_literal_elems: ListLiteralElem.List,
 
-/// todo
 pub fn init(env: *base.ModuleEnv) Self {
     return Self{
         .env = env,
@@ -32,7 +31,6 @@ pub fn init(env: *base.ModuleEnv) Self {
     };
 }
 
-/// todo
 pub fn deinit(self: *Self) void {
     self.procedures.deinit(self.env.gpa);
     self.constants.deinit(self.env.gpa);

src/build/solve_functions.zig

@@ -25,14 +25,14 @@ pub const FunctionSet = struct {
 pub const IR = struct {
     env: *base.ModuleEnv,
     function_sets: FunctionSet.List,
-    /// todo
+
     pub fn init(env: *base.ModuleEnv) IR {
         return IR{
             .env = env,
             .function_sets = .{},
         };
     }
-    /// todo
+
     pub fn deinit(self: *IR) void {
         self.function_sets.deinit(self.env.gpa);
     }

src/build/specialize_functions/IR.zig

@@ -21,7 +21,6 @@ typed_patterns: Pattern.Typed.List,
 typed_idents: TypedIdent.List,
 when_branches: WhenBranch.List,
 
-/// todo
 pub fn init(env: *base.ModuleEnv) Self {
     return Self{
         .env = env,
@@ -37,7 +36,6 @@ pub fn init(env: *base.ModuleEnv) Self {
     };
 }
 
-/// todo
 pub fn deinit(self: *Self) void {
     self.exposed_values.deinit(self.env.gpa);
     self.exposed_functions.deinit(self.env.gpa);

src/build/specialize_types/IR.zig

@@ -21,7 +21,6 @@ typed_patterns: Pattern.Typed.List,
 typed_idents: TypedIdent.List,
 when_branches: WhenBranch.List,
 
-/// todo
 pub fn init(env: *base.ModuleEnv) Self {
     return Self{
         .env = env,
@@ -37,7 +36,6 @@ pub fn init(env: *base.ModuleEnv) Self {
     };
 }
 
-/// todo
 pub fn deinit(self: *Self) void {
     self.exposed_values.deinit(self.env.gpa);
     self.exposed_functions.deinit(self.env.gpa);

src/check/parse/Parser.zig

@@ -35,7 +35,6 @@ pub fn init(tokens: TokenizedBuffer) Parser {
     };
 }
 
-/// deninit the parser memory
 pub fn deinit(parser: *Parser) void {
     parser.scratch_nodes.deinit(parser.gpa);
     parser.diagnostics.deinit(parser.gpa);

src/check/resolve_imports/IR.zig

@@ -41,7 +41,6 @@ pub fn init(env: *base.ModuleEnv) Self {
     };
 }
 
-/// deinitialise the IR's memory
 pub fn deinit(self: *Self) void {
     self.regions.deinit(self.env.gpa);
     self.exprs.deinit(self.env.gpa);

src/collections.zig

@@ -1,9 +1,8 @@
 /// Utilities for managing collections.
 pub const utils = @import("collections/utils.zig");
 
-/// re-export the SafeList
 pub const SafeList = @import("collections/safe_list.zig").SafeList;
-/// re-export the SafeMultiList
+
 pub const SafeMultiList = @import("collections/safe_list.zig").SafeMultiList;
-/// re-export the SmallStringInterner
+
 pub const SmallStringInterner = @import("collections/SmallStringInterner.zig");

src/types.zig

@@ -1,7 +1,5 @@
-/// re-export the number primitive types
 pub const num = @import("types/num.zig");
 
-/// re-export the Type primitive
 pub const Type = @import("types/type.zig").Type;
 
 // todo -- we probably don't need this anymmore.. remove in follow-up PR