Lint pony-doc and pony-lsp in CI

pony-lint was already linting its own source in CI. This extends
that to pony-doc and pony-lsp so all three tools are held to the
same standard.

Adds lint-pony-doc and lint-pony-lsp Makefile targets and wires
them into pr-tools.yml and ponyc-tier3.yml. Fixes all lint
violations in both tools: file renames to match principal types,
line-length wrapping, docstring formatting, blank-line spacing,
call-argument formatting, exhaustive-match annotations, hard-tab
removal, and public docstrings. Test fixtures in
pony-lsp/test/error_workspace/ are excluded via .ignore since they
contain intentional compile errors.

Author: SeanTAllen

.github/workflows/ponyc-tier3.yml

@@ -156,7 +156,6 @@ jobs:
           gmake test-pony-doc config=debug
           gmake test-pony-lint config=debug
           gmake test-pony-lsp config=debug
-          gmake lint-pony-lint config=debug
           gmake configure config=release
           gmake build config=release
           gmake test-ci-core config=release
@@ -273,7 +272,6 @@ jobs:
           gmake test-pony-doc config=debug
           gmake test-pony-lint config=debug
           gmake test-pony-lsp config=debug
-          gmake lint-pony-lint config=debug
           gmake configure config=release
           gmake build config=release
           gmake test-ci-core config=release
@@ -500,7 +498,6 @@ jobs:
           gmake test-pony-doc config=debug
           gmake test-pony-lint config=debug
           gmake test-pony-lsp config=debug
-          gmake lint-pony-lint config=debug
           gmake configure config=release
           gmake build config=release
           gmake test-ci-core config=release

.github/workflows/pr-tools.yml

@@ -52,6 +52,10 @@ jobs:
         run: make test-pony-lsp config=debug
       - name: Lint pony-lint
         run: make lint-pony-lint config=debug
+      - name: Lint pony-doc
+        run: make lint-pony-doc config=debug
+      - name: Lint pony-lsp
+        run: make lint-pony-lsp config=debug
 
   macos:
     if: github.event.pull_request.draft == false

Makefile

@@ -275,6 +275,12 @@ test-pony-lint: all
 lint-pony-lint: all
 	$(SILENT)cd '$(outDir)' && PONYPATH=.:$(PONYPATH) ./ponyc --path ../../tools/lib/ponylang/pony_compiler/ -b pony-lint-ci ../../tools/pony-lint && echo Built `pwd`/pony-lint-ci && PONYPATH=../../tools/lib/ponylang/pony_compiler:$(PONYPATH) ./pony-lint-ci ../../tools/pony-lint/
 
+lint-pony-doc: all
+	$(SILENT)cd '$(outDir)' && PONYPATH=.:$(PONYPATH) ./ponyc --path ../../tools/lib/ponylang/pony_compiler/ -b pony-lint-ci ../../tools/pony-lint && echo Built `pwd`/pony-lint-ci && PONYPATH=../../tools/lib/ponylang/pony_compiler:$(PONYPATH) ./pony-lint-ci ../../tools/pony-doc/
+
+lint-pony-lsp: all
+	$(SILENT)cd '$(outDir)' && PONYPATH=.:$(PONYPATH) ./ponyc --path ../../tools/lib/ponylang/pony_compiler/ -b pony-lint-ci ../../tools/pony-lint && echo Built `pwd`/pony-lint-ci && PONYPATH=../../tools/lib/ponylang/pony_compiler:$(PONYPATH) ./pony-lint-ci ../../tools/pony-lsp/
+
 test-pony-compiler: all
 	$(SILENT)cd '$(outDir)' && PONYPATH=.:$(PONYPATH) ./ponyc --path ../../tools/lib/ponylang/pony_compiler/ -b pony-compiler-tests ../../tools/lib/ponylang/pony_compiler/tests && echo Build `pwd`/pony-compiler-tests && PONYPATH=../../tools/lib/ponylang/pony_compiler:../../packages:$(PONYPATH) ./pony-compiler-tests --sequential
 

tools/pony-doc/_assets.pony

@@ -17,11 +17,20 @@ primitive _TypeExtractor
     match type_ast.id()
     | ast.TokenIds.tk_nominal() => _nominal(type_ast, package_map)
     | ast.TokenIds.tk_typeparamref() => _type_param_ref(type_ast)
-    | ast.TokenIds.tk_uniontype() => _type_list(type_ast, package_map,
+    | ast.TokenIds.tk_uniontype() =>
+      _type_list(
+        type_ast,
+        package_map,
         {(types) => DocUnion(types) })
-    | ast.TokenIds.tk_isecttype() => _type_list(type_ast, package_map,
+    | ast.TokenIds.tk_isecttype() =>
+      _type_list(
+        type_ast,
+        package_map,
         {(types) => DocIntersection(types) })
-    | ast.TokenIds.tk_tupletype() => _type_list(type_ast, package_map,
+    | ast.TokenIds.tk_tupletype() =>
+      _type_list(
+        type_ast,
+        package_map,
         {(types) => DocTuple(types) })
     | ast.TokenIds.tk_arrow() => _arrow(type_ast, package_map)
     | ast.TokenIds.tk_thistype() => DocThis
@@ -93,8 +102,14 @@ primitive _TypeExtractor
         Filter.is_private(raw_name),
         Filter.is_internal(raw_name))
     else
-      DocNominal("unknown", "", recover val Array[DocType] end,
-        None, None, false, false)
+      DocNominal(
+        "unknown",
+        "",
+        recover val Array[DocType] end,
+        None,
+        None,
+        false,
+        false)
     end
 
   fun _type_param_ref(type_ast: ast.AST box): DocTypeParamRef =>
@@ -126,7 +141,10 @@ primitive _TypeExtractor
     builder: {(Array[DocType] val): DocType} val)
     : DocType
   =>
-    """Extracts child types and wraps them via the builder function."""
+    """
+    Extracts child types and wraps them via the builder
+    function.
+    """
     let result: Array[DocType] iso = recover iso Array[DocType] end
     for child in type_ast.children() do
       result.push(apply(child, package_map))

tools/pony-doc/_type_extractor.pony

@@ -12,6 +12,9 @@ primitive _Unreachable
   fun apply(loc: SourceLoc = __loc): None =>
     let url = "https://github.com/ponylang/ponyc/issues"
     let fmt = "Unreachable at %s:%zu\nPlease report: " + url + "\n"
-    @fprintf(@pony_os_stderr(), fmt.cstring(),
-      loc.file().cstring(), loc.line())
+    @fprintf(
+      @pony_os_stderr(),
+      fmt.cstring(),
+      loc.file().cstring(),
+      loc.line())
     @exit(1)

tools/pony-doc/_mort.pony tools/pony-doc/_unreachable.ponytools/pony-doc/_mort.pony renamed to tools/pony-doc/_unreachable.pony

@@ -1,9 +1,16 @@
 use "files"
 
 trait Backend
-  """Generates documentation output from a `DocProgram` IR."""
+  """
+  Generates documentation output from a `DocProgram` IR.
+  """
   fun generate(
     program: DocProgram box,
     output_dir: FilePath,
     include_private: Bool)
     ?
+  =>
+    """
+    Generate documentation for the given program.
+    """
+    None

tools/pony-doc/backend.pony

@@ -55,28 +55,38 @@ class val DocTypeParamRef
     ephemeral = ephemeral'
 
 class val DocUnion
-  """A union type (e.g., `(String | None)`)."""
+  """
+  A union type (e.g., `(String | None)`).
+  """
   let types: Array[DocType] val
 
   new val create(types': Array[DocType] val) =>
     types = types'
 
 class val DocIntersection
-  """An intersection type (e.g., `(Stringable & Hashable)`)."""
+  """
+  An intersection type
+  (e.g., `(Stringable & Hashable)`).
+  """
   let types: Array[DocType] val
 
   new val create(types': Array[DocType] val) =>
     types = types'
 
 class val DocTuple
-  """A tuple type (e.g., `(String, U32)`)."""
+  """
+  A tuple type (e.g., `(String, U32)`).
+  """
   let types: Array[DocType] val
 
   new val create(types': Array[DocType] val) =>
     types = types'
 
 class val DocArrow
-  """An arrow (viewpoint adaptation) type (e.g., `this->T`)."""
+  """
+  An arrow (viewpoint adaptation) type
+  (e.g., `this->T`).
+  """
   let left: DocType
   let right: DocType
 
@@ -85,7 +95,9 @@ class val DocArrow
     right = right'
 
 class val DocThis
-  """The `this` type literal."""
+  """
+  The `this` type literal.
+  """
   new val create() => None
 
 class val DocCapability

tools/pony-doc/doc_type.pony

@@ -1,5 +1,8 @@
 class val DocProgram
-  """Top-level IR node representing an entire compiled Pony program."""
+  """
+  Top-level IR node representing an entire compiled
+  Pony program.
+  """
   let name: String
   let packages: Array[DocPackage] val
 
@@ -8,7 +11,10 @@ class val DocProgram
     packages = packages'
 
 class val DocPackage
-  """A Pony package with its documented types and source files."""
+  """
+  A Pony package with its documented types and source
+  files.
+  """
   let qualified_name: String
   let doc_string: (String | None)
   let public_types: Array[DocEntity] val
@@ -84,7 +90,10 @@ class val DocEntity
     source = source'
 
 class val DocMethod
-  """A documented method (constructor, function, or behaviour)."""
+  """
+  A documented method (constructor, function, or
+  behaviour).
+  """
   let kind: MethodKind
   let name: String
   let cap: (String | None)
@@ -117,7 +126,10 @@ class val DocMethod
     source = source'
 
 class val DocField
-  """A documented field (var, let, or embed). Only public fields are collected."""
+  """
+  A documented field (var, let, or embed). Only public
+  fields are collected.
+  """
   let kind: FieldKind
   let name: String
   let field_type: DocType
@@ -138,7 +150,10 @@ class val DocField
     source = source'
 
 class val DocParam
-  """A method parameter with its type and optional default value."""
+  """
+  A method parameter with its type and optional default
+  value.
+  """
   let name: String
   let param_type: DocType
   let default_value: (String | None)
@@ -153,7 +168,10 @@ class val DocParam
     default_value = default_value'
 
 class val DocTypeParam
-  """A type parameter with optional constraint and default type."""
+  """
+  A type parameter with optional constraint and default
+  type.
+  """
   let name: String
   let constraint: (DocType | None)
   let default_type: (DocType | None)

tools/pony-doc/doc_types.pony

@@ -12,42 +12,59 @@ type EntityKind is
   | EntityTypeAlias )
 
 primitive EntityClass
-  """Represents a Pony `class` declaration."""
+  """
+  Represents a Pony `class` declaration.
+  """
   fun string(): String => "class"
   fun keyword(): String => "class"
 
 primitive EntityActor
-  """Represents a Pony `actor` declaration."""
+  """
+  Represents a Pony `actor` declaration.
+  """
   fun string(): String => "actor"
   fun keyword(): String => "actor"
 
 primitive EntityTrait
-  """Represents a Pony `trait` declaration."""
+  """
+  Represents a Pony `trait` declaration.
+  """
   fun string(): String => "trait"
   fun keyword(): String => "trait"
 
 primitive EntityInterface
-  """Represents a Pony `interface` declaration."""
+  """
+  Represents a Pony `interface` declaration.
+  """
   fun string(): String => "interface"
   fun keyword(): String => "interface"
 
 primitive EntityPrimitive
-  """Represents a Pony `primitive` declaration."""
+  """
+  Represents a Pony `primitive` declaration.
+  """
   fun string(): String => "primitive"
   fun keyword(): String => "primitive"
 
 primitive EntityStruct
-  """Represents a Pony `struct` declaration."""
+  """
+  Represents a Pony `struct` declaration.
+  """
   fun string(): String => "struct"
   fun keyword(): String => "struct"
 
 primitive EntityTypeAlias
-  """Represents a Pony `type` alias declaration."""
+  """
+  Represents a Pony `type` alias declaration.
+  """
   fun string(): String => "type"
   fun keyword(): String => "type"
 
 primitive EntityKindBuilder
-  """Maps a pony_compiler TokenId to the corresponding EntityKind."""
+  """
+  Maps a pony_compiler TokenId to the corresponding
+  EntityKind.
+  """
   fun apply(id: ast.TokenId): EntityKind ? =>
     match id
     | ast.TokenIds.tk_class() => EntityClass