Your advanced code editor is loading.

This code implements import-boss, a tool that enforces import restrictions in a Go repository. It uses a .import-restrictions file (YAML) in each package directory to define rules that govern imports within the repository.

Key components:

• loadPkgs function: Loads Go packages from the given patterns and checks for errors during parsing.
• massage function: Renames test packages to include the original package name and handles test files, ensuring consistent package names.
• ImportBoss struct:
• incomingImports: Stores direct imports for each package.
• transitiveIncomingImports: Stores the transitive closure of direct imports, indicating all packages that indirectly import a given package.
• newBoss function: Creates an ImportBoss instance, populating the import maps.
• Verify function: Iterates through loaded packages, verifies import restrictions against rules defined in .import-restrictions files, and reports any violations.
• packageDir function: Determines the directory of a package based on Go files or ignored files.
• FileFormat struct: Represents a .import-restrictions file, containing Rules and InverseRules.
• Rule struct: Defines an import restriction rule, including:
• SelectorRegexp: Regex pattern to match import paths.
• AllowedPrefixes: List of allowed prefixes for matched imports.
• ForbiddenPrefixes: List of forbidden prefixes for matched imports.
• Transitive: Boolean flag indicating whether the rule applies to transitive imports.
• Disposition enum: Represents the allowed/forbidden status of a dependency.
• Evaluate function: Evaluates a rule against a given import path to determine its allowed/forbidden status.
• recursiveRead function: Recursively reads .import-restrictions files from the current directory to the module root.
• readFile function: Reads and unmarshals a .import-restrictions file.
• isGoModRoot function: Checks for the presence of go.mod file to identify the module root.
• removeLastDir function: Removes the last directory from a path.
• verifyRules function: Checks direct and transitive imports of a package against defined rules.
• uniq function: Removes duplicate strings from multiple slices.
• hasPathPrefix function: Checks if a path has a given prefix.
• transitiveImports function: Returns direct and transitive imports for a given package.
• dfsImports function: Performs a depth-first search to collect transitive imports.
• verifyInverseRules function: Checks that all packages that import a given package are allowed to do so based on the inverse rules defined in .import-restrictions.
• transitiveClosure function: Computes the transitive closure of a directed graph using Warshall’s algorithm.

Key features:

• Import Restriction Enforcement: The tool enforces import restrictions defined in .import-restrictions files.
• Direct and Transitive Import Analysis: It checks both direct and transitive imports against rules.
• Inverse Rule Support: It verifies that all packages importing a specific package are allowed to do so.
• Recursive File Reading: It reads rules from .import-restrictions files recursively up to the module root.
• Package Filtering and Handling: It filters out test packages and handles cases where a package may have both source files and test files.
• Error Reporting: It provides detailed error messages indicating violations of import restrictions.

Overall, import-boss is a useful tool for maintaining consistent and controlled import practices within a Go repository. It helps enforce import restrictions, promotes modularity, and reduces potential dependencies on unexpected or forbidden packages.