Go code organization (in a nutshell)

Starting a Go project with the right code organization means no time lost in case you wanted to publish your modules in a public repository.

Even not considering publishing, keeping the source code properly organized will help you and your teammates to quickly find those needed resources.

The next schema shows the officially recommended way of organizing Go code.

In a nutshell:

Every Go source code file (extension .go) must define the package to which its contents (types, functions, ...) belongs to
All the source files in the same subdirectory belongs to the same package
A module contains a set of packages, stored in subdirectories of the modules' root directoy.
A module defines its packages in a file named go.mod
Optionally a module can be published in a repository (as for instance github).

Each package can be imported to a Go project as <repository>/<module>/package
The whole module becomes publicly available as <repository>/<module>

Comentarios

Entradas populares de este blog

Linting C# in Visual Studio Code

Though very usual in programming environments as Javascript/Typescript, linting , or analyzing code for enforcing a set of coding style rules, is not usually present in the .NET based environments. Rule enforcing is really useful when working on team shared codebases in order to keep them coherent, what in last term reduces both development times and coding errors. A linting example Maybe a practical example would be helpful for explaining what linting is to the newcomers (feel free to go on if you aren't). Let's imagine you are a new member in a C# development team that has well established set of coding style rules. Instead (or apart) of putting them in a document, they've adopted a tool that checks these rules during the code building process. Your first code is such ambitious as this: namespace HelloWorld { using System; public class Program { p...

ESlint: Ignore unused underscore variables

Some naming conventions promote the use of the underscore character (" _ ") for those variables that must be declared but are not being used. One common case is that in which a function signature contains some variables that will not be used, as for instance the Express error handlers: app.use(function(err, req, res, next) { console.error(err.stack); res.status(500).send('Something broke!'); }); In the above example only the arguments err and res are being used, though all four must be defined in the handler signature. Thus, following the naming convention of using underscores for those unused variables, we could recode it as: app.use(function(err, _, res, __) { console.error(err.stack); res.status(500).send('Something broke!'); }); Though it makes the function more readable, it comes with a problem if using ESlint: it will blame by declaring unused variables. error '_' is defined but never used error '__' is define...

Using Bitbucket app passwords with git on MacOS (OSX)

Learn how Bitbucket passwords are stored by git on MacOS.

The Modern Programmer

Buscar este blog