@shortlink-org/portolan 0.1.0

package/internal/commands/taskfile.go

@@ -0,0 +1,101 @@
+package commands
+
+import (
+	"strings"
+
+	"gopkg.in/yaml.v3"
+
+	"github.com/shortlink-org/portolan/catalog"
+)
+
+// readTaskfile lists the tasks of a Taskfile, in the order the file lists
+// them. A task marked `internal` is not one `task --list` offers and is not
+// one here. `desc` is the doc, and `summary` stands in when there is no desc.
+// The cmds are the body; a cmd that calls another task is written as the
+// runner would show it.
+func readTaskfile(file, src string) ([]catalog.Command, []string) {
+	var doc yaml.Node
+	if err := yaml.Unmarshal([]byte(src), &doc); err != nil {
+		return nil, []string{file + ": not YAML, so no tasks were read: " + err.Error()}
+	}
+	root := doc.Content
+	if len(root) == 0 || root[0].Kind != yaml.MappingNode {
+		return nil, nil
+	}
+	tasks := mappingValue(root[0], "tasks")
+	if tasks == nil || tasks.Kind != yaml.MappingNode {
+		return nil, nil
+	}
+
+	var out []catalog.Command
+	for i := 0; i+1 < len(tasks.Content); i += 2 {
+		key, value := tasks.Content[i], tasks.Content[i+1]
+		name := key.Value
+		if !typeable(name) {
+			continue
+		}
+		cmd := catalog.Command{
+			Runner: "task",
+			Name:   name,
+			Run:    "task " + name,
+			Source: at(file, key.Line),
+		}
+		switch value.Kind {
+		case yaml.ScalarNode:
+			cmd.Body = value.Value
+		case yaml.SequenceNode:
+			cmd.Body = strings.Join(cmdLines(value), "\n")
+		case yaml.MappingNode:
+			if internal := mappingValue(value, "internal"); internal != nil && internal.Value == "true" {
+				continue
+			}
+			if desc := mappingValue(value, "desc"); desc != nil {
+				cmd.Doc = strings.TrimSpace(desc.Value)
+			} else if summary := mappingValue(value, "summary"); summary != nil {
+				cmd.Doc = strings.TrimSpace(summary.Value)
+			}
+			if cmds := mappingValue(value, "cmds"); cmds != nil {
+				cmd.Body = strings.Join(cmdLines(cmds), "\n")
+			} else if single := mappingValue(value, "cmd"); single != nil {
+				cmd.Body = single.Value
+			}
+		}
+		out = append(out, cmd)
+	}
+
+	return out, nil
+}
+
+func mappingValue(node *yaml.Node, key string) *yaml.Node {
+	if node == nil || node.Kind != yaml.MappingNode {
+		return nil
+	}
+	for i := 0; i+1 < len(node.Content); i += 2 {
+		if node.Content[i].Value == key {
+			return node.Content[i+1]
+		}
+	}
+
+	return nil
+}
+
+func cmdLines(node *yaml.Node) []string {
+	var lines []string
+	if node.Kind == yaml.ScalarNode {
+		return []string{strings.TrimSpace(node.Value)}
+	}
+	for _, item := range node.Content {
+		switch item.Kind {
+		case yaml.ScalarNode:
+			lines = append(lines, strings.TrimSpace(item.Value))
+		case yaml.MappingNode:
+			if cmd := mappingValue(item, "cmd"); cmd != nil {
+				lines = append(lines, strings.TrimSpace(cmd.Value))
+			} else if task := mappingValue(item, "task"); task != nil {
+				lines = append(lines, "task "+task.Value)
+			}
+		}
+	}
+
+	return lines
+}

package/internal/commands/testdata/estate/.cargo/config.toml

@@ -0,0 +1,7 @@
+[build]
+rustflags = ["-D", "warnings"]
+
+[alias]
+xtask = "run --package xtask --"
+gen = { cmd = "run --package xtask -- gen" }
+_secret = "test --release"

package/internal/commands/testdata/estate/Makefile

@@ -0,0 +1,33 @@
+# The stubs are generated from the contracts vendored in this tree.
+GRPC := internal/transport/grpc
+BIN ?= bin/pricing
+
+.PHONY: help
+help: ## List the targets
+	@grep -E '^[a-z].*##' $(MAKEFILE_LIST)
+
+.PHONY: gen build
+gen: ## Regenerate the gRPC stubs
+	buf generate $(GRPC)/quote/proto -o $(GRPC)/quote/gen
+	buf generate $(GRPC)/price_list/proto -o $(GRPC)/price_list/gen
+
+# Compiles every package. Nothing is installed.
+build:
+	go build ./...
+
+test lint: build
+	go test ./...
+
+_internal:
+	@true
+
+$(BIN): build
+	cp out $(BIN)
+
+%.pb.go: %.proto
+	protoc $<
+
+ifeq ($(CI),1)
+ci: test
+	@echo done
+endif

package/internal/commands/testdata/estate/Taskfile.yml

@@ -0,0 +1,21 @@
+version: "3"
+
+tasks:
+  default:
+    cmds:
+      - task: build
+  build:
+    desc: Compile the binary
+    cmds:
+      - go build -o bin/svc ./cmd/svc
+  migrate:
+    summary: Apply pending migrations
+    cmd: goose up
+  _shared:
+    cmds:
+      - echo hidden
+  lint:
+    internal: true
+    cmds:
+      - golangci-lint run
+  fmt: gofmt -w .

package/internal/commands/testdata/estate/build.gradle.kts

@@ -0,0 +1,21 @@
+plugins {
+    id("org.springframework.boot") version "4.1.1"
+    application
+}
+
+tasks.register<Exec>("generateProto") {
+    description = "Regenerate the gRPC stubs"
+    commandLine("buf", "generate")
+}
+
+tasks.register("_shared") {
+    doLast { println("hidden") }
+}
+
+val smokeTest by tasks.registering(Test::class) {
+    description = "Run the tests that need the compose stack"
+}
+
+task legacyTask {
+    doLast { println("old syntax") }
+}

package/internal/commands/testdata/estate/justfile

@@ -0,0 +1,20 @@
+set shell := ["bash", "-cu"]
+port := "8080"
+
+alias t := test
+
+# Run the service against the compose stack
+dev:
+    docker compose up -d
+    cargo run
+
+[doc("Run the tests, unit and integration")]
+test *args:
+    cargo test {{args}}
+
+[private]
+release:
+    cargo build --release
+
+_setup:
+    rustup default stable

package/internal/commands/testdata/estate/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "cart",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "prebuild": "rimraf dist",
+    "start": "node dist/main.js",
+    "test": "vitest run",
+    "build:watch": "tsc -w",
+    "generate": "npm run generate:api && npm run generate:auth",
+    "generate:api": "openapi-typescript openapi.yaml -o types.ts"
+  },
+  "dependencies": {}
+}

package/internal/commands/testdata/estate/pom.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+  <groupId>org.portolan.payments</groupId>
+  <artifactId>ledger</artifactId>
+  <packaging>jar</packaging>
+  <dependencies>
+    <dependency>
+      <artifactId>flyway-maven-plugin</artifactId>
+    </dependency>
+  </dependencies>
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <artifactId>jib-maven-plugin</artifactId>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+    <plugins>
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+      </plugin>
+      <plugin>
+        <artifactId>protobuf-maven-plugin</artifactId>
+      </plugin>
+    </plugins>
+  </build>
+</project>

package/internal/commands/testdata/estate/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "billing"
+version = "0.1.0"
+
+[project.scripts]
+billing = "billing.cli:main"
+
+[tool.poe.tasks]
+test = "pytest"
+lint = ["ruff", "check", "."]
+serve = { cmd = "python manage.py runserver", help = "Run the dev server" }
+_hidden = "echo no"
+
+[tool.poe.tasks.migrate]
+help = "Apply pending migrations"
+cmd = "python manage.py migrate"
+
+[tool.poe.tasks.check]
+sequence = ["lint", "test"]
+
+[tool.pdm.scripts]
+pre_test = "echo before"
+test = "pytest -x"
+
+[tool.pdm.scripts.worker]
+shell = "celery -A billing worker"
+help = "Run the celery worker"

package/internal/commands/testdata/estate/xtask/src/main.rs

@@ -0,0 +1,27 @@
+use clap::{Parser, Subcommand};
+
+#[derive(Parser)]
+struct Cli {
+    #[command(subcommand)]
+    command: Command,
+}
+
+#[derive(Subcommand)]
+enum Command {
+    /// Regenerate the gRPC stubs from the vendored protos
+    Gen,
+    /// Run fmt, clippy and the tests the way CI does
+    Ci { #[arg(long)] fix: bool },
+    #[command(about = "Build the release artefacts")]
+    Dist(DistArgs),
+}
+
+fn main() {
+    let arg = std::env::args().nth(1);
+    match arg.as_deref() {
+        Some("gen") => gen(),
+        // Run the benchmarks against the compose stack
+        Some("bench") | Some("perf") => bench(),
+        _ => usage(),
+    }
+}

package/internal/commands/testdata/golden/commands.json

@@ -0,0 +1,305 @@
+[
+  {
+    "runner": "make",
+    "name": "help",
+    "run": "make help",
+    "doc": "List the targets",
+    "body": "@grep -E '^[a-z].*##' $(MAKEFILE_LIST)",
+    "source": "testdata/estate/Makefile:6"
+  },
+  {
+    "runner": "make",
+    "name": "gen",
+    "run": "make gen",
+    "doc": "Regenerate the gRPC stubs",
+    "body": "buf generate $(GRPC)/quote/proto -o $(GRPC)/quote/gen\nbuf generate $(GRPC)/price_list/proto -o $(GRPC)/price_list/gen",
+    "source": "testdata/estate/Makefile:10"
+  },
+  {
+    "runner": "make",
+    "name": "build",
+    "run": "make build",
+    "doc": "Compiles every package. Nothing is installed.",
+    "body": "go build ./...",
+    "source": "testdata/estate/Makefile:15"
+  },
+  {
+    "runner": "make",
+    "name": "test",
+    "run": "make test",
+    "body": "go test ./...",
+    "source": "testdata/estate/Makefile:18"
+  },
+  {
+    "runner": "make",
+    "name": "lint",
+    "run": "make lint",
+    "body": "go test ./...",
+    "source": "testdata/estate/Makefile:18"
+  },
+  {
+    "runner": "make",
+    "name": "ci",
+    "run": "make ci",
+    "body": "@echo done",
+    "source": "testdata/estate/Makefile:31"
+  },
+  {
+    "runner": "just",
+    "name": "dev",
+    "run": "just dev",
+    "doc": "Run the service against the compose stack",
+    "body": "docker compose up -d\ncargo run",
+    "source": "testdata/estate/justfile:7"
+  },
+  {
+    "runner": "just",
+    "name": "test",
+    "run": "just test",
+    "doc": "Run the tests, unit and integration",
+    "body": "cargo test {{args}}",
+    "source": "testdata/estate/justfile:12"
+  },
+  {
+    "runner": "task",
+    "name": "default",
+    "run": "task default",
+    "body": "task build",
+    "source": "testdata/estate/Taskfile.yml:4"
+  },
+  {
+    "runner": "task",
+    "name": "build",
+    "run": "task build",
+    "doc": "Compile the binary",
+    "body": "go build -o bin/svc ./cmd/svc",
+    "source": "testdata/estate/Taskfile.yml:7"
+  },
+  {
+    "runner": "task",
+    "name": "migrate",
+    "run": "task migrate",
+    "doc": "Apply pending migrations",
+    "body": "goose up",
+    "source": "testdata/estate/Taskfile.yml:11"
+  },
+  {
+    "runner": "task",
+    "name": "fmt",
+    "run": "task fmt",
+    "body": "gofmt -w .",
+    "source": "testdata/estate/Taskfile.yml:21"
+  },
+  {
+    "runner": "npm",
+    "name": "build",
+    "run": "npm run build",
+    "body": "tsc -p tsconfig.build.json",
+    "source": "testdata/estate/package.json:4"
+  },
+  {
+    "runner": "npm",
+    "name": "start",
+    "run": "npm start",
+    "body": "node dist/main.js",
+    "source": "testdata/estate/package.json:6"
+  },
+  {
+    "runner": "npm",
+    "name": "test",
+    "run": "npm test",
+    "body": "vitest run",
+    "source": "testdata/estate/package.json:7"
+  },
+  {
+    "runner": "npm",
+    "name": "build:watch",
+    "run": "npm run build:watch",
+    "body": "tsc -w",
+    "source": "testdata/estate/package.json:8"
+  },
+  {
+    "runner": "npm",
+    "name": "generate",
+    "run": "npm run generate",
+    "body": "npm run generate:api \u0026\u0026 npm run generate:auth",
+    "source": "testdata/estate/package.json:9"
+  },
+  {
+    "runner": "npm",
+    "name": "generate:api",
+    "run": "npm run generate:api",
+    "body": "openapi-typescript openapi.yaml -o types.ts",
+    "source": "testdata/estate/package.json:10"
+  },
+  {
+    "runner": "poe",
+    "name": "test",
+    "run": "poe test",
+    "body": "pytest",
+    "source": "testdata/estate/pyproject.toml:9"
+  },
+  {
+    "runner": "poe",
+    "name": "lint",
+    "run": "poe lint",
+    "body": "ruff check .",
+    "source": "testdata/estate/pyproject.toml:10"
+  },
+  {
+    "runner": "poe",
+    "name": "serve",
+    "run": "poe serve",
+    "doc": "Run the dev server",
+    "body": "python manage.py runserver",
+    "source": "testdata/estate/pyproject.toml:11"
+  },
+  {
+    "runner": "poe",
+    "name": "migrate",
+    "run": "poe migrate",
+    "doc": "Apply pending migrations",
+    "body": "python manage.py migrate",
+    "source": "testdata/estate/pyproject.toml:14"
+  },
+  {
+    "runner": "poe",
+    "name": "check",
+    "run": "poe check",
+    "body": "lint\ntest",
+    "source": "testdata/estate/pyproject.toml:18"
+  },
+  {
+    "runner": "pdm",
+    "name": "test",
+    "run": "pdm run test",
+    "body": "pytest -x",
+    "source": "testdata/estate/pyproject.toml:23"
+  },
+  {
+    "runner": "pdm",
+    "name": "worker",
+    "run": "pdm run worker",
+    "doc": "Run the celery worker",
+    "body": "celery -A billing worker",
+    "source": "testdata/estate/pyproject.toml:25"
+  },
+  {
+    "runner": "mvn",
+    "name": "test",
+    "run": "mvn test",
+    "doc": "Run the tests (lifecycle phase)",
+    "source": "testdata/estate/pom.xml:5"
+  },
+  {
+    "runner": "mvn",
+    "name": "package",
+    "run": "mvn package",
+    "doc": "Build the artifact (lifecycle phase)",
+    "source": "testdata/estate/pom.xml:5"
+  },
+  {
+    "runner": "mvn",
+    "name": "spring-boot:run",
+    "run": "mvn spring-boot:run",
+    "doc": "Run the application",
+    "source": "testdata/estate/pom.xml:22"
+  },
+  {
+    "runner": "gradle",
+    "name": "build",
+    "run": "gradle build",
+    "doc": "Assemble and test the project",
+    "source": "testdata/estate/build.gradle.kts"
+  },
+  {
+    "runner": "gradle",
+    "name": "test",
+    "run": "gradle test",
+    "doc": "Run the tests",
+    "source": "testdata/estate/build.gradle.kts"
+  },
+  {
+    "runner": "gradle",
+    "name": "run",
+    "run": "gradle run",
+    "doc": "Run the application",
+    "source": "testdata/estate/build.gradle.kts:3"
+  },
+  {
+    "runner": "gradle",
+    "name": "bootRun",
+    "run": "gradle bootRun",
+    "doc": "Run the Spring Boot application",
+    "source": "testdata/estate/build.gradle.kts:2"
+  },
+  {
+    "runner": "gradle",
+    "name": "generateProto",
+    "run": "gradle generateProto",
+    "doc": "Regenerate the gRPC stubs",
+    "source": "testdata/estate/build.gradle.kts:6"
+  },
+  {
+    "runner": "gradle",
+    "name": "smokeTest",
+    "run": "gradle smokeTest",
+    "doc": "Run the tests that need the compose stack",
+    "source": "testdata/estate/build.gradle.kts:15"
+  },
+  {
+    "runner": "gradle",
+    "name": "legacyTask",
+    "run": "gradle legacyTask",
+    "source": "testdata/estate/build.gradle.kts:19"
+  },
+  {
+    "runner": "cargo",
+    "name": "xtask",
+    "run": "cargo xtask",
+    "body": "run --package xtask --",
+    "source": "testdata/estate/.cargo/config.toml:5"
+  },
+  {
+    "runner": "cargo",
+    "name": "xtask gen",
+    "run": "cargo xtask gen",
+    "doc": "Regenerate the gRPC stubs from the vendored protos",
+    "source": "testdata/estate/xtask/src/main.rs:12"
+  },
+  {
+    "runner": "cargo",
+    "name": "xtask ci",
+    "run": "cargo xtask ci",
+    "doc": "Run fmt, clippy and the tests the way CI does",
+    "source": "testdata/estate/xtask/src/main.rs:14"
+  },
+  {
+    "runner": "cargo",
+    "name": "xtask dist",
+    "run": "cargo xtask dist",
+    "doc": "Build the release artefacts",
+    "source": "testdata/estate/xtask/src/main.rs:16"
+  },
+  {
+    "runner": "cargo",
+    "name": "xtask bench",
+    "run": "cargo xtask bench",
+    "doc": "Run the benchmarks against the compose stack",
+    "source": "testdata/estate/xtask/src/main.rs:24"
+  },
+  {
+    "runner": "cargo",
+    "name": "xtask perf",
+    "run": "cargo xtask perf",
+    "doc": "Run the benchmarks against the compose stack",
+    "source": "testdata/estate/xtask/src/main.rs:24"
+  },
+  {
+    "runner": "cargo",
+    "name": "gen",
+    "run": "cargo gen",
+    "body": "run --package xtask -- gen",
+    "source": "testdata/estate/.cargo/config.toml:6"
+  }
+]