energy/cmd/internal/project/project.go

//----------------------------------------
//
// Copyright © yanghy. All Rights Reserved.
//
// Licensed under Apache License Version 2.0, January 2004
//
// https://www.apache.org/licenses/LICENSE-2.0
//
//----------------------------------------

package project

import (
	"encoding/json"
	"github.com/energye/energy/v2/cmd/internal/consts"
	"github.com/energye/golcl/energy/tools"
	"os"
	"path/filepath"
	"runtime"
	"strings"
)

// Project holds the data related to a ENERGY project
type Project struct {
	Clean          bool   `json:"-"`              // 清空配置重新生成
	Name           string `json:"name"`           // 应用名称
	ProjectPath    string `json:"projectPath"`    // 项目目录
	FrameworkPath  string `json:"frameworkPath"`  // 框架目录 未指定时使用环境变量 ENERGY_HOME
	AssetsDir      string `json:"assetsDir"`      // 构建配置所在目录 未指定使用田默认内置配置
	OutputFilename string `json:"outputFilename"` // 输出安装包文件名
	Info           Info   `json:"info"`           // 应用信息
	Author         Author `json:"author"`         // 作者信息
}

func (m *Project) setDefaults() {
	if m.Name == "" {
		m.Name = "energyapp"
	}
	if m.ProjectPath == "" {
		m.ProjectPath, _ = os.Getwd()
	}
	if m.FrameworkPath == "" {
		m.FrameworkPath = os.Getenv(consts.EnergyHomeKey)
	}
	if !tools.IsExist(m.FrameworkPath) {
		panic("energy framework directory does not exist: " + m.FrameworkPath)
	}
	if m.AssetsDir == "" {
		m.AssetsDir = "assets"
	}
	if m.OutputFilename == "" {
		m.OutputFilename = m.Name
	}
	if m.Author.Name == "" {
		m.Author.Name = "yanghy"
	}
	if m.Author.Email == "" {
		m.Author.Email = "snxamdf@126.com"
	}
	if m.Info.CompanyName == "" {
		m.Info.CompanyName = m.Name
	}
	if m.Info.ProductName == "" {
		m.Info.ProductName = m.Name
	}
	if m.Info.ProductVersion == "" {
		m.Info.ProductVersion = "1.0.0"
	}
	if m.Info.Copyright == nil {
		v := "Copyright........."
		m.Info.Copyright = &v
	}
	if m.Info.FileDescription == nil {
		v := "Built using ENERGY (https://github.com/energye/energy)"
		m.Info.FileDescription = &v
	}
	switch runtime.GOOS {
	case "windows":
		if !strings.HasSuffix(m.OutputFilename, ".exe") {
			m.OutputFilename += ".exe"
		}
	case "darwin", "linux":
		m.OutputFilename = strings.TrimSuffix(m.OutputFilename, ".exe")
	}

}

type Info struct {
	Icon            string      `json:"icon"`            //应用图标
	CompanyName     string      `json:"companyName"`     //公司名称
	ProductName     string      `json:"productName"`     //产品名称
	FileVersion     string      `json:"FileVersion"`     //文件版本
	ProductVersion  string      `json:"productVersion"`  //产品版本
	Copyright       *string     `json:"copyright"`       //版权
	Comments        *string     `json:"comments"`        //exe详情描述
	FileDescription *string     `json:"fileDescription"` //描述
	InstallPack     InstallPack `json:"installPack"`     // windows nsis 安装包
}

func (m *Info) FromSlash() *Info {
	m.Icon = filepath.FromSlash(m.Icon)
	m.InstallPack = *m.InstallPack.FromSlash()
	return m
}

func (m *Info) ToSlash() *Info {
	m.Icon = filepath.ToSlash(m.Icon)
	m.InstallPack = *m.InstallPack.ToSlash()
	return m
}

func (m *InstallPack) FromSlash() *InstallPack {
	m.Icon = filepath.FromSlash(m.Icon)
	m.UnIcon = filepath.FromSlash(m.UnIcon)
	for i, as := range m.Assets {
		m.Assets[i] = filepath.FromSlash(as)
	}
	return m
}

func (m *InstallPack) ToSlash() *InstallPack {
	m.Icon = filepath.ToSlash(m.Icon)
	m.UnIcon = filepath.ToSlash(m.UnIcon)
	for i, as := range m.Assets {
		m.Assets[i] = filepath.ToSlash(as)
	}
	return m
}

// InstallPack windows NSIS
type InstallPack struct {
	Icon                  string   `json:"icon"`                  //安装包图标
	Assets                []string `json:"assets"`                //打包的资源目录、或文件 ["/to/path/file.txt", "/to/dir/*.*", "/to/dir"]
	UnIcon                string   `json:"unIcon"`                //安装包卸载图标
	License               string   `json:"license"`               //安装包授权信息,(license.txt)文件路径
	Language              string   `json:"language"`              //安装包语言, 中文: SimpChinese, 英文: English, 语言在 NSIS_HOME/Contrib/Language files
	RequestExecutionLevel string   `json:"requestExecutionLevel"` // admin or ""
}

type Author struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

//  APP项目配置转换到Project
func parse(projectData []byte) (*Project, error) {
	m := &Project{}
	err := json.Unmarshal(projectData, m)
	if err != nil {
		return nil, err
	}
	m.setDefaults()
	return m, nil
}

// NewProject 创建项目对象, 根据energy.json配置
func NewProject(projectPath string) (*Project, error) {
	if projectPath == "" {
		projectPath, _ = os.Getwd()
	}
	config := filepath.Join(projectPath, consts.EnergyProjectConfig)
	rawBytes, err := os.ReadFile(config)
	if err != nil {
		return nil, err
	}
	m, err := parse(rawBytes)
	if err != nil {
		return nil, err
	}
	if m.ProjectPath == "" {
		m.ProjectPath = projectPath
	}
	m.ProjectPath = filepath.FromSlash(m.ProjectPath)
	return m, nil
}