chore: add comments for all packages (#350)

Co-authored-by: rick <[email protected]>

cmd/doc.go

@@ -0,0 +1,2 @@
+// Package cmd provides the CLI commands
+package cmd

pkg/common/doc.go

@@ -0,0 +1,2 @@
+// Package common provides some common functions for the whole project.
+package common

pkg/compress/doc.go

@@ -0,0 +1,2 @@
+// Package compress provides the compress and uncompress functions.
+package compress

pkg/doc.go

@@ -0,0 +1,3 @@
+// Package pkg provides the features to interal and external users.
+// All CLI related logics should not be in this package.
+package pkg

pkg/exec/doc.go

@@ -0,0 +1,3 @@
+// Package exec is the wrapper of os/exec package.
+// The main purpose of this package is to make unit test be easier.
+package exec

pkg/installer/doc.go

@@ -0,0 +1,2 @@
+// Package installer is the core part of the software package installation.
+package installer

pkg/log/doc.go

@@ -0,0 +1,3 @@
+// Package log provides the core logger functions.
+// Basically, this is a wrapper of log.Logger
+package log

pkg/net/doc.go

@@ -0,0 +1,2 @@
+// Package net provides the core download functions
+package net

pkg/os/apk/doc.go

@@ -0,0 +1,3 @@
+// Package apk provides the common functions to install a package via apk.
+// See also https://wiki.alpinelinux.org/wiki/Alpine_Package_Keeper.
+package apk

pkg/os/apt/doc.go

@@ -0,0 +1,3 @@
+// Package apt provides the common functions to install a package via apt.
+// See also https://en.wikipedia.org/wiki/APT_(software).
+package apt

pkg/os/brew/doc.go

@@ -0,0 +1,3 @@
+// Package brew provides the common functions to install a package via brew.
+// See also https://brew.sh/.
+package brew

pkg/os/core/doc.go

@@ -0,0 +1,2 @@
+// Package core provides the core structs about the os-related package manager.
+package core

pkg/os/dnf/doc.go

@@ -0,0 +1,3 @@
+// Package dnf provides the common function of dnf package manager.
+// See also https://en.wikipedia.org/wiki/DNF_(software).
+package dnf

pkg/os/doc.go

@@ -0,0 +1,3 @@
+// Package os provides a generic installer for all platforms.
+// See the different native packages in the sub-packages, such as: apt, apk, brew etc.
+package os

pkg/os/docker/doc.go

@@ -0,0 +1,2 @@
+// Package docker provides the way to install a package via docker CLI.
+package docker

pkg/os/fake/doc.go

@@ -0,0 +1,2 @@
+// Package fake provides functions for unit test.
+package fake

pkg/os/generic/doc.go

@@ -0,0 +1,4 @@
+// Package generic provides the generic packge installation.
+// It does not care about the real package mananger. Because
+// It will accept arbitrary command line.
+package generic

pkg/os/npm/doc.go

@@ -0,0 +1,3 @@
+// Package npm provides the common usage of npm.
+// See also https://www.npmjs.com/.
+package npm

pkg/os/snap/doc.go

@@ -0,0 +1,3 @@
+// Package snap provides the common usage of snap package manager.
+// See also https://snapcraft.io/.
+package snap

pkg/os/yum/doc.go

@@ -0,0 +1,3 @@
+// Package yum provides the common usage of yum package manager.
+// See also https://en.wikipedia.org/wiki/Yum_(software).
+package yum

pkg/version/doc.go

@@ -0,0 +1,2 @@
+// Package version provides the functions which related to version parse.
+package version