lunar

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 26, 2022 License: MIT Imports: 8 Imported by: 0

README

lunar

lunar 是一个命令行下的阴历阳历查询转换工具。

安装

Homebrew
brew tap xwjdsh/tap
brew install xwjdsh/tap/lunar
Go

仅支持 go1.16 及以上版本

if go_version == 1.16.x

go get -u github.com/xwjdsh/lunar/cmd/lunar

else

go install github.com/xwjdsh/lunar/cmd/lunar
Manual

从 releases 下载对应的可执行文件并将其放到 PATH 环境变量对应的路径中。

使用

> lunar -h
NAME:
   lunar - lunar is a command line tool for conversion between Gregorian calendar and lunar calendar.(1901~2100)

USAGE:
   lunar [global options] command [command options] [arguments...]

COMMANDS:
   alias, a        Show alias date info
   solar-term, st  Get solar term info
   config, c       Display config
   help, h         Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --format value, -f value  Output date format (default: "2006-01-02")
   --config value, -c value  Custom config path (default: "$HOME/.config/lunar/lunar.yml")
   --year value, -y value    Target year (default: $THIS_YEAR)
   --reverse, -r             Reverse mode, query date by lunar date (default: false)
   --help, -h                show help (default: false)
阳历转阴历
> # lunar -y 2022       # 指定年份，月日为今日
> # lunar -y 2022 0701  # 指定年月日
> lunar                 # 不带参数年月日为今日
阳历 阴历 星期 距今 节气 别名 标签
2022-01-26 2021-12-24 星期三 今天
阴历转阳历
> # lunar -r -y 2022      # 查询阴历，指定年份
> # lunar -r -y 2022 0701 # 查询阴历，指定年月日
> lunar -r                # 查询阴历，不带参数年月日为阴历今日
阳历 阴历 星期 距今 节气 别名 标签
2022-02-26 2022-01-26 星期六 还有 31 天
自定义配置别名
> # lunar config -d                            # 显示默认配置，默认加入了一些常见节日的别名
> lunar config -d > ~/.config/lunar/lunar.yml  # 导出默认配置，自定义修改
> # lunar config                               # 显示当前配置

例如修改为如下，

aliases:
    - name: xx的生日
      disable: false
      date:
        year: 0
        month: 5
        day: 7
      is_lunar_date: true
      leap_month_limit: 0
      tags:
        - birthday
阳历 阴历 星期 距今 节气 别名 标签
2022-06-05 2022-05-07 星期日 还有 130 天 xx的生日 birthday
查询别名
> # lunar a 春节 中秋   # 查询指定别名
> # lunar -y 2022 a    # 指定年份
> lunar a              # 列出所有别名日期
阳历 阴历 星期 距今 节气 别名 标签
2022-01-01 2021-11-29 星期六 已过去 25 天 元旦 holiday
2022-01-10 2021-12-08 星期一 已过去 16 天 腊八
2022-02-01 2022-01-01 星期二 还有 6 天 春节 holiday
2022-02-15 2022-01-15 星期二 还有 20 天 元宵
2022-04-04 2022-03-04 星期一 还有 68 天 清明 holiday
2022-05-01 2022-04-01 星期日 还有 95 天 劳动 holiday
2022-06-03 2022-05-05 星期五 还有 128 天 端午 holiday
2022-08-04 2022-07-07 星期四 还有 190 天 七夕
2022-08-12 2022-07-15 星期五 还有 198 天 中元
2022-09-10 2022-08-15 星期六 还有 227 天 中秋 holiday
2022-10-01 2022-09-06 星期六 还有 248 天 国庆 holiday
2022-10-04 2022-09-09 星期二 还有 251 天 重阳
2022-12-30 2022-12-08 星期五 还有 338 天 腊八
查询标签
> lunar a -t birthday # 查询自定义标签
> lunar a -t holiday  # 查询标签
阳历 阴历 星期 距今 节气 别名 标签
2022-01-01 2021-11-29 星期六 已过去 25 天 元旦 holiday
2022-02-01 2022-01-01 星期二 还有 6 天 春节 holiday
2022-04-04 2022-03-04 星期一 还有 68 天 清明 holiday
2022-05-01 2022-04-01 星期日 还有 95 天 劳动 holiday
2022-06-03 2022-05-05 星期五 还有 128 天 端午 holiday
2022-09-10 2022-08-15 星期六 还有 227 天 中秋 holiday
2022-10-01 2022-09-06 星期六 还有 248 天 国庆 holiday
查询节气
> # lunar st 冬至    # 查询指定节气
> # lunar -y 2022 st # 指定年份
> lunar st           # 查询所有节气
阳历 阴历 星期 距今 节气 别名 标签
2022-02-04 2022-01-04 星期五 还有 9 天 立春
2022-02-19 2022-01-19 星期六 还有 24 天 雨水
2022-03-05 2022-02-03 星期六 还有 38 天 驚蟄
2022-03-20 2022-02-18 星期日 还有 53 天 春分
2022-04-05 2022-03-05 星期二 还有 69 天 清明
2022-04-20 2022-03-20 星期三 还有 84 天 穀雨
2022-05-05 2022-04-05 星期四 还有 99 天 立夏
2022-05-21 2022-04-21 星期六 还有 115 天 小滿
2022-06-06 2022-05-08 星期一 还有 131 天 芒種
2022-06-21 2022-05-23 星期二 还有 146 天 夏至
2022-07-07 2022-06-09 星期四 还有 162 天 小暑
2022-07-23 2022-06-25 星期六 还有 178 天 大暑
2022-08-07 2022-07-10 星期日 还有 193 天 立秋
2022-08-23 2022-07-26 星期二 还有 209 天 處暑
2022-09-07 2022-08-12 星期三 还有 224 天 白露
2022-09-23 2022-08-28 星期五 还有 240 天 秋分
2022-10-08 2022-09-13 星期六 还有 255 天 寒露
2022-10-23 2022-09-28 星期日 还有 270 天 霜降
2022-11-07 2022-10-14 星期一 还有 285 天 立冬
2022-11-22 2022-10-29 星期二 还有 300 天 小雪
2022-12-07 2022-11-14 星期三 还有 315 天 大雪
2022-12-22 2022-11-29 星期四 还有 330 天 冬至
2023-01-05 2022-12-14 星期四 还有 344 天 小寒
2023-01-20 2022-12-29 星期五 还有 359 天 大寒

协议

MIT License

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrNotFound date not found error
	ErrNotFound = errors.New("lunar: date not found")
)

Functions

This section is empty.

Types

type Date 

type Date config.Date

Date date

func DateByTime 

func DateByTime(t time.Time) Date

DateByTime returns a Date by time

func NewDate 

func NewDate(y, m, d int) Date

NewDate returns a new Date

func (Date) IsLunarDate 

func (d Date) IsLunarDate() bool

IsLunarDate implement DateType interface

func (Date) String 

func (d Date) String() string

func (Date) Time 

func (d Date) Time() time.Time

Time date to time

type DateType 

type DateType interface {
	IsLunarDate() bool
}

DateType abstract date type, Date or LunarDate

type Handler 

type Handler struct {
	// contains filtered or unexported fields
}

Handler handle date query logic

func New 

func New() *Handler

New returns a new Handler

func (*Handler) Calendar 

func (h *Handler) Calendar(dt DateType) (*Result, error)

Calendar query date

func (*Handler) GetSolarTerms 

func (h *Handler) GetSolarTerms(year int, names ...string) ([]*Result, error)

GetSolarTerms query date by solar terms

type LunarDate 

type LunarDate struct {
	Date
	IsLeapMonth bool
}

LunarDate lunar date

func NewLunarDate 

func NewLunarDate(d Date, isLeapMonth bool) LunarDate

NewLunarDate returns a new LunarDate

func (LunarDate) IsLunarDate 

func (d LunarDate) IsLunarDate() bool

IsLunarDate implement DateType api

type Result 

type Result struct {
	Date       Date
	LunarDate  LunarDate
	Weekday    time.Weekday
	WeekdayRaw string
	SolarTerm  string
}

Result calendar query result

func Calendar 

func Calendar(dt DateType) (*Result, error)

Calendar query date

func GetSolarTerms 

func GetSolarTerms(year int, names ...string) ([]*Result, error)

GetSolarTerms query date by solar terms

Source Files

View all Source files

Directories

Path Synopsis
cmd
lunar

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.