rm scripts update tools

Makefile

@@ -2,15 +2,20 @@ ROWS=15
 FILE="README.md"
 
 build:
-	./scripts/del-existing-rows.sh $(ROWS) $(FILE)
+	# Delete existing table if it exists
+	go run ./scripts format --rmtable --readme README.md
 
-	go run scripts/generate-table.go -path ./presentations -out scripts/data.csv -rows $(ROWS)
-	cat scripts/data.csv | go run moul.io/mdtable csv > scripts/table.md
+	# Generate new table
+	go run ./scripts -path ./presentations -out ./scripts/data.csv
+	cat ./scripts/data.csv | go run moul.io/mdtable csv > ./scripts/table.md
 	go run github.com/campoy/embedmd -w README.md
+
+	# Remove codeblocks from embedmd
+	go run ./scripts format --readme README.md
+
 	# Clean up
-	rm scripts/data.csv scripts/table.md
+	rm ./scripts/data.csv ./scripts/table.md
 
-	./scripts/del-codeblock.sh $(FILE)
 
 lint:
-	cd ./scripts && go run lint.go
+	go run ./scripts lint --readme README.md

presentations/2024-09-23--distributed-communities-morgan/metadata.yml

@@ -10,6 +10,6 @@ location: "Turin, Italy"
 # At which event the workshop took place, if any
 event: ""
 # Workshop slides link. If the link is local, only put the file name, without any other path parts.
-slides: "slides.reveal.pdf"
+slides: "https://gnolang.github.io/workshops/presentations/2024-09-23--distributed-communities/slides.html"
 # Workshop recording
 recording: ""

scripts/format.go

@@ -0,0 +1,66 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/gnolang/gno/tm2/pkg/commands"
+)
+
+func newFormatCmd(cfg *cfg) *commands.Command {
+	cmd := commands.NewCommand(
+		commands.Metadata{
+			Name:      "format",
+			ShortHelp: "remove codeblocks from the README table",
+		},
+		commands.NewEmptyConfig(),
+		func(_ context.Context, args []string) error {
+			return execFormat(cfg)
+		},
+	)
+	return cmd
+}
+
+// execFormat removes an existing table if rmTable is set, and removes the codeblock after table generation happened
+func execFormat(cfg *cfg) error {
+	read, err := os.ReadFile(cfg.readmePath)
+	if err != nil {
+		panic(err)
+	}
+
+	cts := string(read)
+	newContents := ""
+
+	// Called to remove the old table
+	if cfg.rmTable {
+		lines := strings.Split(cts, "\n")
+		newLines := make([]string, 0, len(lines))
+		for _, line := range lines {
+			if strings.Index(line, "|") != 0 {
+				newLines = append(newLines, line)
+			}
+		}
+
+		newContents = strings.Join(newLines, "\n")
+
+	} else {
+		// called to remove the codeblock
+		newContents = strings.Replace(cts, "```md", "", 1)
+		newContents = strings.Replace(newContents, "```", "", 1)
+	}
+
+	if cts == newContents {
+		fmt.Println("Nothing to format.")
+		return nil
+	}
+
+	err = os.WriteFile(cfg.readmePath, []byte(newContents), 0)
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println("Formatted README.md")
+	return nil
+}

scripts/lint.go

@@ -1,19 +1,31 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"slices"
 	"strings"
-)
 
-const (
-	presFolder = "../presentations"
-	readme     = "../README.md"
+	"github.com/gnolang/gno/tm2/pkg/commands"
 )
 
-func main() {
-	dirs, err := os.ReadDir(presFolder)
+func newLintCmd(cfg *cfg) *commands.Command {
+	cmd := commands.NewCommand(
+		commands.Metadata{
+			Name:      "lint",
+			ShortHelp: "lint the README table",
+		},
+		commands.NewEmptyConfig(),
+		func(_ context.Context, args []string) error {
+			return execLint(cfg)
+		},
+	)
+	return cmd
+}
+
+func execLint(cfg *cfg) error {
+	dirs, err := os.ReadDir(cfg.presentationsPath)
 	if err != nil {
 		panic(err)
 	}
@@ -31,18 +43,20 @@ func main() {
 	slices.Sort(dates)
 	slices.Reverse(dates)
 
-	rawContents, err := os.ReadFile(readme)
+	rawContents, err := os.ReadFile(cfg.readmePath)
 	if err != nil {
 		panic(err)
 	}
 
 	cts := string(rawContents)
 
-	for _, date := range dates[:15] {
+	for _, date := range dates {
 		if !strings.Contains(cts, date) {
-			panic("could not find latest item in README table - did you run `make build`?")
+			panic("could not find some items in README table - did you run `make build`?")
 		}
 	}
 
 	fmt.Println("All good!")
+
+	return nil
 }

scripts/generate-table.go → scripts/table-tool.go

@@ -16,8 +16,9 @@ import (
 
 type cfg struct {
 	presentationsPath string
-	outputPath        string
-	rows              int
+	csvOutPath        string
+	readmePath        string
+	rmTable           bool
 }
 
 type Metadata struct {
@@ -32,6 +33,8 @@ var (
 	csvHeader = []string{"Date", "Title", "Speakers", "Presentation", "Recording"}
 )
 
+const ghLink = "https://github.com/"
+
 func main() {
 	cfg := &cfg{}
 
@@ -45,6 +48,11 @@ func main() {
 			return execGen(cfg)
 		})
 
+	cmd.AddSubCommands(
+		newLintCmd(cfg),
+		newFormatCmd(cfg),
+	)
+
 	cmd.Execute(context.Background(), os.Args[1:])
 }
 
@@ -56,22 +64,29 @@ func (c *cfg) RegisterFlags(fs *flag.FlagSet) {
 		"path to dir to walk for presentations files",
 	)
 	fs.StringVar(
-		&c.outputPath,
+		&c.csvOutPath,
 		"out",
 		"./data.csv",
 		"output csv path, including .csv",
 	)
-	fs.IntVar(
-		&c.rows,
-		"rows",
-		15,
-		"number of rows to generate",
+	fs.StringVar(
+		&c.readmePath,
+		"readme",
+		"",
+		"path to the main README",
+	)
+
+	fs.BoolVar(
+		&c.rmTable,
+		"rmtable",
+		false,
+		"rm the table",
 	)
 }
 
 func execGen(cfg *cfg) error {
 	searchDir := cfg.presentationsPath
-	outputCSV := cfg.outputPath // todo check for err
+	outputCSV := cfg.csvOutPath // todo check for err
 
 	// Create the CSV file
 	csvFile, err := os.Create(outputCSV)
@@ -137,8 +152,7 @@ func execGen(cfg *cfg) error {
 	})
 
 	// Write sorted rows to the CSV file
-	// Generate only the last N rows of data
-	for _, r := range rows[:cfg.rows] {
+	for _, r := range rows {
 		err = writer.Write(r.Format())
 		if err != nil {
 			return err
@@ -173,7 +187,8 @@ func (m Metadata) Format() []string {
 func (m Metadata) parseSpeakers() string {
 	var speakers []string
 	for _, speaker := range m.Speakers {
-		speakers = append(speakers, "@"+speaker)
+		speaker = fmt.Sprintf("[@%s](%s%s)", speaker, ghLink, speaker)
+		speakers = append(speakers, speaker)
 	}
 
 	return strings.Join(speakers, ", ")