gofumpt and note-type.apkg docs

Author: Talha Altinel

.gitignore

@@ -1,3 +1,4 @@
 *.mp3
 .idea/
-.code/
+.code/
+main

.golangci.yaml

@@ -103,6 +103,7 @@ formatters:
     - gci
     - gofmt
     - goimports
+    - gofumpt
   settings:
     gci:
       sections:

README.md

@@ -11,17 +11,21 @@ the goddess of the thieves, helps you steal translation speeches from the G-dadd
 
 <img src="https://github.com/user-attachments/assets/d1d344c9-f36b-4cf7-af70-f162f93ea9f0" width="400" alt="goddess-of-thieves">
 
+## Installation
+
+### Grab Binaries
+
+You can find the binaries through GitHub [releases](https://github.com/mrwormhole/laverna/releases/).
+
 ### Install Via Go
 
 ```shell
   go install github.com/mrwormhole/laverna@latest
 ```
 
-### Grab Binaries
-
-You can find binaries through GitHub releases.
+## Sample Usage
 
-### Sample Usage
+### Basic
 
 Let's create example CSV
 
@@ -49,32 +53,48 @@ or you could do YAML
 Running below command will generate audios in the same directory.
 
 ```shell
-  laverna -file example.csv
+  laverna run -file example.csv
 ```
 
 or
 
 ```shell
-  laverna -file example.yaml 
+  laverna run -file example.yaml 
 ```
 
-### Shell Completions
+### Anki
 
-Output shell completion script for bash, zsh, fish, or Powershell.
-Source the output to enable completion.
+Make sure you have note type installed for Anki. Here is the [note type](./note-type.apkg), when you imported it, you will see "Cloze Multi Choice Audio" note type in your `Anki > Tools > Manage Note Types`. Then you can proceed with the below Anki CSV format.
+
+```csv
+Text,HelperText,TextA,TextB,TextC,TextD
+ฉันชอบ{{c1::ฟัง}}เพลง,I like to listen to music,ฟัง,เล่น,ดู,อ่าน
+```
+
+```shell
+  laverna anki --profile Talha --voice th --file ./testdata/anki-th-example.csv
+```
+
+Now you will see a new result as below CSV file, all of your media is generated and inserted into Anki, however in order to create a deck in Anki, you need to import CSV below. And carefully choose comma delimiter with note type "Cloze Multi Choice Audio"
 
-#### Bash
+```csv
+Text,HelperText,TextA,TextB,TextC,TextD,AudioA,AudioB,AudioC,AudioD,AudioAnswer
+ฉันชอบ{{c1::ฟัง}}เพลง,I like to listen to music,ฟัง,เล่น,ดู,อ่าน,[sound:a.mp3],[sound:b.mp3],[sound:c.mp3],[sound:d.mp3],[sound:e.mp3]
+```
+
+![anki-front-card](https://github.com/user-attachments/assets/fbc19bd1-0d74-4659-b9a0-2e40e9e8d4cf)
 
-source <(laverna completion bash)
+![anki-back-card](https://github.com/user-attachments/assets/6cca4cfc-237a-493f-8306-0972278231fa)
 
-#### Zsh
+## Shell Completions
 
-source <(laverna completion zsh)
+Output shell completion script for bash, zsh, fish, or Powershell.
+Source the output to enable completion.
 
-#### Fish
+### Bash / Zsh
 
-laverna completion fish > ~/.config/fish/completions/laverna.fish
+```source <(laverna completion bash)``` or ```source <(laverna completion zsh)```
 
-#### Powershell
+### Fish
 
-Output the script to path/to/autocomplete/laverna.ps1 an run it.
+```laverna completion fish > ~/.config/fish/completions/laverna.fish```

anki/runner.go

@@ -80,7 +80,7 @@ func NewRunner(profile string, opts ...RunnerOption) (*Runner, error) {
 		fp := filepath.Join(path, filename)
 
 		// ensure directory exists
-		if err := os.MkdirAll(path, 0750); err != nil {
+		if err := os.MkdirAll(path, 0o750); err != nil {
 			return fmt.Errorf("failed to make directory(%q): %w", path, err)
 		}
 
@@ -92,7 +92,7 @@ func NewRunner(profile string, opts ...RunnerOption) (*Runner, error) {
 			return fmt.Errorf("failed to check file(%q): %w", fp, err)
 		}
 
-		return os.WriteFile(fp, audio, 0600)
+		return os.WriteFile(fp, audio, 0o600)
 	}
 	r.save = saveFile
 
@@ -239,9 +239,7 @@ func (r *Runner) Run(ctx context.Context, reader io.Reader, c RunConfig) error {
 	if err != nil {
 		return fmt.Errorf("os.Create(%q): %w", c.OutFilename, err)
 	}
-	defer func() {
-		_ = outFile.Close()
-	}()
+	defer func() { _ = outFile.Close() }()
 
 	if err := WriteCSVRecords(outFile, records, c.StripCSVHeader, c.Shuffle); err != nil {
 		return fmt.Errorf("WriteCSVRecords(%q): %w", outFile.Name(), err)

commands.go

@@ -55,9 +55,7 @@ func ankiCmd(ctx context.Context, filename string, maxWorkers int, profile strin
 	if err != nil {
 		return fmt.Errorf("failed to open file(%q): %v", filename, err)
 	}
-	defer func() {
-		_ = f.Close()
-	}()
+	defer func() { _ = f.Close() }()
 
 	runner, err := anki.NewRunner(profile, anki.WithMaxWorkers(maxWorkers))
 	if err != nil {

note-type.apkg

@@ -26,7 +26,7 @@ func NewRunner(opts ...RunnerOption) *Runner {
 		client:     http.DefaultClient,
 		maxWorkers: runtime.GOMAXPROCS(0),
 		save: func(filename string, audio []byte) error {
-			return os.WriteFile(filename+".mp3", audio, 0600)
+			return os.WriteFile(filename+".mp3", audio, 0o600)
 		},
 	}
 

synthesize/runner.go

@@ -32,7 +32,7 @@ func TestBatchRunner(t *testing.T) {
 				{Text: "test2", Voice: EnglishVoice},
 			},
 			saveFn: func(text string, audio []byte) error {
-				return os.WriteFile(filepath.Join(temp, text+".mp3"), audio, 0600)
+				return os.WriteFile(filepath.Join(temp, text+".mp3"), audio, 0o600)
 			},
 			wantAudios: []string{
 				filepath.Join(temp, "test1.mp3"),