feat: init

Author: CC11001100

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -0,0 +1,112 @@
+# asciinema parser 
+
+# 一、这是什么？解决了什么问题？
+
+这个网站[https://asciinema.org/](https://asciinema.org/)是一个命令行录屏分享网站，它定义了一套`Ascii Cast`格式的文件来存储录屏内容，这个库就是用来解析`Ascii Cast`文件的，支持[v1](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md)和[v2](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md)两个版本。
+
+# 二、 API代码示例
+
+## 2.1 检查录屏文件是哪个版本
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	asciinema_parser "github.com/golang-infrastructure/go-asciinema-parser"
+)
+
+func main() {
+
+	asciiCastV2String := `{"version": 2, "width": 80, "height": 24, "timestamp": 1504467315, "title": "Demo", "env": {"TERM": "xterm-256color", "SHELL": "/bin/zsh"}}
+[0.248848, "o", "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n"]
+[1.001376, "o", "That was ok\rThis is better."]
+[2.143733, "o", " "]
+[6.541828, "o", "Bye!"]`
+
+	// 识别版本
+	version, err := asciinema_parser.DetectVersion(context.Background(), asciiCastV2String)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(version) // Output: 2
+
+}
+```
+
+## 2.2 解析V1格式的录屏软件
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	asciinema_parser "github.com/golang-infrastructure/go-asciinema-parser"
+)
+
+func main() {
+
+	asciiCastV1String := `{
+  "version": 1,
+  "width": 80,
+  "height": 24,
+  "duration": 1.515658,
+  "command": "/bin/zsh",
+  "title": "",
+  "env": {
+    "TERM": "xterm-256color",
+    "SHELL": "/bin/zsh"
+  },
+  "stdout": [
+    [
+      0.248848,
+      "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n"
+    ],
+    [
+      1.001376,
+      "I am \rThis is on the next line."
+    ]
+  ]
+}`
+
+	v1, err := asciinema_parser.ParseV1(context.Background(), []byte(asciiCastV1String))
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(fmt.Sprintf("%v", v1))
+
+}
+```
+
+## 2.3 解析V2格式的录屏软件
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	asciinema_parser "github.com/golang-infrastructure/go-asciinema-parser"
+)
+
+func main() {
+
+	asciiCastV2String := `{"version": 2, "width": 80, "height": 24, "timestamp": 1504467315, "title": "Demo", "env": {"TERM": "xterm-256color", "SHELL": "/bin/zsh"}}
+[0.248848, "o", "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n"]
+[1.001376, "o", "That was ok\rThis is better."]
+[2.143733, "o", " "]
+[6.541828, "o", "Bye!"]`
+
+	v2, err := asciinema_parser.ParseV2(context.Background(), []byte(asciiCastV2String))
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(fmt.Sprintf("%v", v2))
+
+}
+```
+
+
+

ascii_cast_v1.go

@@ -0,0 +1,69 @@
+package asciinema_parser
+
+import (
+	"fmt"
+)
+
+// ------------------------------------------------- --------------------------------------------------------------------
+
+// AsciiCastV1 v1格式的规范文档： https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md
+type AsciiCastV1 struct {
+	Version Version `json:"version"`
+
+	Width        uint              `json:"width" yaml:"width" mapstructure:"width"`
+	Height       uint              `json:"height" yaml:"height" mapstructure:"height"`
+	Duration     float64           `json:"duration" yaml:"duration" mapstructure:"duration"`
+	Command      string            `json:"command" yaml:"command" mapstructure:"command"`
+	Title        string            `json:"title" yaml:"title" mapstructure:"title"`
+	Env          map[string]string `json:"env" yaml:"env" mapstructure:"env"`
+	StdoutFrames []Frame           `json:"stdout" yaml:"stdout" mapstructure:"stdout"`
+}
+
+func (x *AsciiCastV1) Check() error {
+
+	if x.Version != Version1 {
+		return fmt.Errorf("AsciiCast version %v is not equals 1", x.Version)
+	}
+
+	return nil
+}
+
+// ------------------------------------------------- --------------------------------------------------------------------
+
+type Frame []any
+
+func (x Frame) GetDelayE() (float64, error) {
+	if len(x) > 0 {
+		v, ok := x[0].(float64)
+		if !ok {
+			return 0, fmt.Errorf("cast %s to float failed", x[0])
+		}
+		return v, nil
+	} else {
+		return 0, nil
+	}
+}
+
+func (x Frame) GetDelay() float64 {
+	v, _ := x.GetDelayE()
+	return v
+}
+
+func (x Frame) GetDataE() (string, error) {
+	if len(x) > 1 {
+		v, ok := x[1].(string)
+		if !ok {
+			return "", fmt.Errorf("cast %s to string failed", x[0])
+		}
+		return v, nil
+	} else {
+		return "", nil
+	}
+}
+
+func (x Frame) GetData() string {
+	v, _ := x.GetDataE()
+	return v
+}
+
+// ------------------------------------------------- --------------------------------------------------------------------

ascii_cast_v2.go

@@ -0,0 +1,110 @@
+package asciinema_parser
+
+import (
+	"fmt"
+	"strings"
+	"time"
+)
+
+// 格式规范文档： https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md
+type AsciiCastV2 struct {
+
+	// 表示文件的格式版本
+	Version Version `json:"version" yaml:"version" mapstructure:"version"`
+
+	// 屏幕的宽度，但是是列
+	Width uint `json:"width" yaml:"width" mapstructure:"width"`
+
+	// 屏幕的高度，但是是行
+	Height uint `json:"height" yaml:"height" mapstructure:"height"`
+
+	// 录制开始时间
+	Timestamp uint64 `json:"timestamp" yaml:"timestamp" mapstructure:"timestamp"`
+	time      time.Time
+
+	// 录制持续时间
+	Duration float64 `json:"duration" yaml:"duration" mapstructure:"duration"`
+
+	Command string `json:"command" yaml:"command" mapstructure:"command"`
+
+	Title string `json:"title" yaml:"title" mapstructure:"title"`
+
+	Theme *Theme `json:"theme" yaml:"theme" mapstructure:"theme"`
+
+	//
+	IdleTimeLimit float64 `json:"idle_time_limit" yaml:"idle_time_limit" mapstructure:"idle_time_limit"`
+
+	// 相关环境变量
+	EnvMap map[string]string `json:"env" yaml:"env" mapstructure:"env"`
+
+	EventStream []*Event `json:"event_stream" yaml:"event_stream" mapstructure:"event_stream"`
+}
+
+func (x *AsciiCastV2) GetTime() time.Time {
+	if x.time.IsZero() {
+		x.time = time.Unix(int64(x.Timestamp), 0)
+	}
+	return x.time
+}
+
+// ------------------------------------------------- --------------------------------------------------------------------
+
+// Theme 可以设置一个初始化的主题
+type Theme struct {
+
+	// 主题的前景色
+	FrontColor string `json:"fg" yaml:"fg" mapstructure:"fg"`
+
+	// 主题的背景色
+	BackgroundColor string `json:"bg" yaml:"bg" mapstructure:"bg"`
+
+	// 8或者16个颜色的调色板
+	Palette string `json:"palette" yaml:"palette" mapstructure:"palette"`
+}
+
+// ------------------------------------------------- --------------------------------------------------------------------
+
+type EventType string
+
+const (
+	EventTypeUnknown = ""
+	EventTypeOutput  = "o"
+	EventTypeInput   = "i"
+)
+
+func ParseEventType(eventType string) (EventType, error) {
+	switch strings.ToLower(eventType) {
+	case EventTypeOutput:
+		return EventTypeOutput, nil
+	case EventTypeInput:
+		return EventTypeInput, nil
+	default:
+		return EventTypeUnknown, fmt.Errorf("value %s is not a valid event type", eventType)
+	}
+}
+
+// ------------------------------------------------- --------------------------------------------------------------------
+
+// Event 事件流中的某一个事件
+type Event struct {
+	cast *AsciiCastV2
+
+	// 时间发生的时间距开始时间的偏移
+	Delay float64 `json:"delay" yaml:"delay" mapstructure:"delay"`
+
+	// 事件的类型，v2的话是有output和input
+	EventType EventType `json:"event_type" yaml:"event_type" mapstructure:"event_type"`
+
+	// 事件的数据，通常是显示的内容
+	EventData string `json:"event_data" yaml:"event_data" mapstructure:"event_data"`
+}
+
+func (x *Event) GetEventTime() time.Time {
+	return x.cast.GetTime().Add(time.Millisecond * time.Duration(x.Delay*1000))
+}
+
+func (x *Event) GetAsciiCast() *AsciiCastV2 {
+	return x.cast
+}
+
+// ------------------------------------------------- --------------------------------------------------------------------

examples/detect_version/main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	asciinema_parser "github.com/golang-infrastructure/go-asciinema-parser"
+)
+
+func main() {
+
+	asciiCastV2String := `{"version": 2, "width": 80, "height": 24, "timestamp": 1504467315, "title": "Demo", "env": {"TERM": "xterm-256color", "SHELL": "/bin/zsh"}}
+[0.248848, "o", "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n"]
+[1.001376, "o", "That was ok\rThis is better."]
+[2.143733, "o", " "]
+[6.541828, "o", "Bye!"]`
+
+	// 识别版本
+	version, err := asciinema_parser.DetectVersion(context.Background(), asciiCastV2String)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(version) // Output: 2
+
+}

examples/parse_v1/main.go

@@ -0,0 +1,40 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	asciinema_parser "github.com/golang-infrastructure/go-asciinema-parser"
+)
+
+func main() {
+
+	asciiCastV1String := `{
+  "version": 1,
+  "width": 80,
+  "height": 24,
+  "duration": 1.515658,
+  "command": "/bin/zsh",
+  "title": "",
+  "env": {
+    "TERM": "xterm-256color",
+    "SHELL": "/bin/zsh"
+  },
+  "stdout": [
+    [
+      0.248848,
+      "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n"
+    ],
+    [
+      1.001376,
+      "I am \rThis is on the next line."
+    ]
+  ]
+}`
+
+	v1, err := asciinema_parser.ParseV1(context.Background(), []byte(asciiCastV1String))
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(fmt.Sprintf("%v", v1))
+
+}

examples/parse_v2/main.go

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	asciinema_parser "github.com/golang-infrastructure/go-asciinema-parser"
+)
+
+func main() {
+
+	asciiCastV2String := `{"version": 2, "width": 80, "height": 24, "timestamp": 1504467315, "title": "Demo", "env": {"TERM": "xterm-256color", "SHELL": "/bin/zsh"}}
+[0.248848, "o", "\u001b[1;31mHello \u001b[32mWorld!\u001b[0m\n"]
+[1.001376, "o", "That was ok\rThis is better."]
+[2.143733, "o", " "]
+[6.541828, "o", "Bye!"]`
+
+	v2, err := asciinema_parser.ParseV2(context.Background(), []byte(asciiCastV2String))
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(fmt.Sprintf("%v", v2))
+
+}