Problem: Gosh packages are not documented.

Solution: create doc.go stubs.

README.md

@@ -1,5 +1,6 @@
 # Gosh
 
+[![GoDoc](https://godoc.org/gosh-lang.org/gosh?status.svg)](https://godoc.org/gosh-lang.org/gosh)
 [![Travis CI Build Status](https://travis-ci.org/gosh-lang/gosh.svg?branch=master)](https://travis-ci.org/gosh-lang/gosh)
 [![Code Coverage](https://codecov.io/gh/gosh-lang/gosh/branch/master/graph/badge.svg)](https://codecov.io/gh/gosh-lang/gosh)
 [![Go Report Card](https://goreportcard.com/badge/gosh-lang.org/gosh)](https://goreportcard.com/report/gosh-lang.org/gosh)

ast/ast.go

@@ -5,8 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-// Package ast declares the types used to represent syntax trees for Gosh packages.
-package ast // import "gosh-lang.org/gosh/ast"
+package ast
 
 import (
 	"fmt"

ast/doc.go

@@ -0,0 +1,9 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package ast declares the types used to represent syntax trees for Gosh packages.
+package ast // import "gosh-lang.org/gosh/ast"

ast/expressions.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package ast // import "gosh-lang.org/gosh/ast"
+package ast
 
 import (
 	"strings"

ast/statements.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package ast // import "gosh-lang.org/gosh/ast"
+package ast
 
 import (
 	"strings"

internal/gofuzz/corpus.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package gofuzz // import "gosh-lang.org/gosh/internal/gofuzz"
+package gofuzz
 
 import (
 	"crypto/sha1" //nolint:gosec // go-fuzz uses SHA1 for non-cryptographic hashing

internal/golden/golden.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package golden // import "gosh-lang.org/gosh/internal/golden"
+package golden
 
 import (
 	"fmt"

interpreter/benchmarks_test.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package interpreter // import "gosh-lang.org/gosh/interpreter"
+package interpreter
 
 import (
 	"context"

interpreter/doc.go

@@ -0,0 +1,9 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package interpreter implements Gosh interpreter.
+package interpreter // import "gosh-lang.org/gosh/interpreter"

interpreter/interpreter.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package interpreter // import "gosh-lang.org/gosh/interpreter"
+package interpreter
 
 import (
 	"context"

interpreter/interpreter_fuzz.go

@@ -7,7 +7,7 @@
 
 // +build gofuzz
 
-package interpreter // import "gosh-lang.org/gosh/interpreter"
+package interpreter
 
 import (
 	"context"

interpreter/interpreter_test.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package interpreter // import "gosh-lang.org/gosh/interpreter"
+package interpreter
 
 import (
 	"bytes"

main.go

@@ -5,7 +5,14 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package main
+// Package gosh implements gosh command.
+//  * https://godoc.org/gosh-lang.org/gosh/tokens
+//  * https://godoc.org/gosh-lang.org/gosh/scanner
+//  * https://godoc.org/gosh-lang.org/gosh/ast
+//  * https://godoc.org/gosh-lang.org/gosh/parser
+//  * https://godoc.org/gosh-lang.org/gosh/objects
+//  * https://godoc.org/gosh-lang.org/gosh/interpreter
+package main // import "gosh-lang.org/gosh"
 
 import (
 	"context"

main_test.go

@@ -0,0 +1,43 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package main
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"os"
+
+	"gosh-lang.org/gosh/interpreter"
+	"gosh-lang.org/gosh/objects"
+	"gosh-lang.org/gosh/parser"
+	"gosh-lang.org/gosh/scanner"
+)
+
+func Example() {
+	code := `println("Hello, world!")`
+
+	s, err := scanner.New(code, nil)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	p := parser.New(s, nil)
+	program := p.ParseProgram()
+	if p.Errors() != nil {
+		log.Fatal(p.Errors())
+	}
+
+	i := interpreter.New(nil)
+	scope := objects.NewScope(objects.Builtin(os.Stdout))
+	res := i.Eval(context.Background(), program, scope)
+	fmt.Println("Eval result:", res)
+	// Output:
+	// Hello, world!
+	// Eval result: <nil>
+}

misc/check_license.go

@@ -8,6 +8,7 @@
 // +build ignore
 
 // check_license checks that MPL license header in all files matches header in this file.
+
 package main
 
 import (

misc/run_fuzzer.go

@@ -8,6 +8,7 @@
 // +build ignore
 
 // run_fuzzer runs go-fuzz for the given package.
+
 package main
 
 import (

objects/builtin.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package objects // import "gosh-lang.org/gosh/objects"
+package objects
 
 import (
 	"fmt"

objects/doc.go

@@ -0,0 +1,9 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package objects declares the types used to represent runtime Gosh objects.
+package objects // import "gosh-lang.org/gosh/objects"

objects/objects.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package objects // import "gosh-lang.org/gosh/objects"
+package objects
 
 import (
 	"fmt"

objects/scope.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package objects // import "gosh-lang.org/gosh/objects"
+package objects
 
 // A Scope maintains the set of named language entities declared in the scope
 // and a link to the immediately surrounding (outer) scope.

objects/type.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package objects // import "gosh-lang.org/gosh/objects"
+package objects
 
 //go:generate stringer -type Type
 

parser/doc.go

@@ -0,0 +1,9 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package parser implements a parser for Gosh source files.
+package parser // import "gosh-lang.org/gosh/parser"

parser/error.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package parser // import "gosh-lang.org/gosh/parser"
+package parser
 
 // Error is a parser error.
 type Error struct {

parser/parser.go

@@ -5,8 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-// Package parser implements a parser for Gosh source files.
-package parser // import "gosh-lang.org/gosh/parser"
+package parser
 
 import (
 	"fmt"

parser/parser_fuzz.go

@@ -7,7 +7,7 @@
 
 // +build gofuzz
 
-package parser // import "gosh-lang.org/gosh/parser"
+package parser
 
 import (
 	"gosh-lang.org/gosh/scanner"

parser/parser_test.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package parser // import "gosh-lang.org/gosh/parser"
+package parser
 
 import (
 	"strings"

scanner/doc.go

@@ -0,0 +1,9 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package scanner implements a scanner for Gosh source text.
+package scanner // import "gosh-lang.org/gosh/scanner"

scanner/scanner.go

@@ -5,8 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-// Package scanner implements a scanner for Gosh source text.
-package scanner // import "gosh-lang.org/gosh/scanner"
+package scanner
 
 import (
 	"fmt"

scanner/scanner_fuzz.go

@@ -7,7 +7,7 @@
 
 // +build gofuzz
 
-package scanner // import "gosh-lang.org/gosh/scanner"
+package scanner
 
 import (
 	"fmt"

scanner/scanner_test.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package scanner // import "gosh-lang.org/gosh/scanner"
+package scanner
 
 import (
 	"strings"

tokens/doc.go

@@ -0,0 +1,9 @@
+// Gosh programming language.
+// Copyright (c) 2018 Alexey Palazhchenko and contributors.
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+// Package tokens declares constants representing the lexical tokens of the Gosh programming language.
+package tokens // import "gosh-lang.org/gosh/tokens"

tokens/tokens.go

@@ -5,8 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-// Package tokens defines constants representing the lexical tokens of the Gosh programming language.
-package tokens // import "gosh-lang.org/gosh/tokens"
+package tokens
 
 import (
 	"fmt"

tokens/type.go

@@ -5,7 +5,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
-package tokens // import "gosh-lang.org/gosh/tokens"
+package tokens
 
 import (
 	"fmt"