...

Source file src/edge-infra.dev/pkg/tools/vset/doc.go

Documentation: edge-infra.dev/pkg/tools/vset

     1  // The vset package is used to configure a VSCode user's settings.json to the
     2  // guidelines set by their team or organization.
     3  // It is recommended to run vset through its just command "just vset".
     4  //
     5  // The vset package starts by validating the path given by vset's just command,
     6  // which comes from the directory the justfile resides in. Once valid, that path
     7  // is updated to point to the .vscode directory and settings.json, which is then
     8  // passed to Configurator() in the Configure interface.
     9  // Configurator() guides settings.json through the configuration process. Each
    10  // part of the settings map, which corresponds to a field in settings.json, is
    11  // updated to reflect the appropriate configurations. By only updating explicitly
    12  // defined parts of the map, extra settings present in settings.json are left unaltered.
    13  // Settings.json is then rewritten and the program exits.
    14  package vset
    15  

View as plain text