Merge pull request #42 from Kristina-Pianykh/support-multiple-formats

Add support for code snippets for more file formats

Author: corylanou

.github/workflows/hype.yml

@@ -11,7 +11,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          ref: ${{ github.head_ref }}
+          ref: ${{github.event.pull_request.head.ref}}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
       - name: Set up Go
         uses: actions/setup-go@v4
         with:

README.md

@@ -422,7 +422,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          ref: ${{ github.head_ref }}
+          ref: ${{github.event.pull_request.head.ref}}
+          repository: ${{github.event.pull_request.head.repo.full_name}}
       - name: Set up Go
         uses: actions/setup-go@v4
         with:

snippet.go

@@ -125,12 +125,17 @@ func (sm *Snippets) init() {
 
 		if sm.rules == nil {
 			sm.rules = map[string]string{
-				".go":   "// %s",
-				".html": "<!-- %s -->",
-				".js":   "// %s",
-				".md":   "<!-- %s -->",
-				".rb":   "# %s",
-				".ts":   "// %s",
+				".go":    "// %s",
+				".html":  "<!-- %s -->",
+				".js":    "// %s",
+				".md":    "<!-- %s -->",
+				".rb":    "# %s",
+				".ts":    "// %s",
+				".sh":    "# %s",
+				".yaml":  "# %s",
+				".yml":   "# %s",
+				".env":   "# %s",
+				".envrc": "# %s",
 			}
 		}
 	})

snippet_test.go

@@ -27,6 +27,11 @@ func Test_Parse_Snippets(t *testing.T) {
 	const rbexp = "def goodbye\n  puts \"Goodbye, World!\"\nend"
 	const jsexp = "function goodbye() {\n    console.log('Goodbye, World!');\n}"
 	const htmlexp = "<p>Goodbye World</p>"
+	const yamlexp = "address:\n  street: 123 Main St\n  city: Springfield\n  zip: 12345"
+	const ymlexp = "address:\n  street: 123 Main St\n  city: Springfield\n  zip: 12345"
+	const shexp = "echo \"Goodbye, World!\""
+	const envexp = "GOODBYE=\"goodbye\""
+	const envrcexp = "export GOODBYE=\"goodbye\""
 
 	table := []struct {
 		path  string
@@ -39,6 +44,11 @@ func Test_Parse_Snippets(t *testing.T) {
 		{path: "snippets.rb", lang: "rb", start: 7, end: 11, exp: rbexp},
 		{path: "snippets.js", lang: "js", start: 7, end: 11, exp: jsexp},
 		{path: "snippets.html", lang: "html", start: 16, end: 18, exp: htmlexp},
+		{path: "snippets.yaml", lang: "yaml", start: 5, end: 10, exp: yamlexp},
+		{path: "snippets.yml", lang: "yml", start: 5, end: 10, exp: ymlexp},
+		{path: "snippets.sh", lang: "sh", start: 3, end: 5, exp: shexp},
+		{path: "snippets.env", lang: "env", start: 1, end: 3, exp: envexp},
+		{path: ".envrc", lang: "envrc", start: 1, end: 3, exp: envrcexp},
 	}
 
 	for _, tc := range table {

testdata/json/document.json

@@ -262,12 +262,17 @@
   "section_id": 1,
   "snippets": {
     "rules": {
+      ".env": "# %s",
+      ".envrc": "# %s",
       ".go": "// %s",
       ".html": "\u003c!-- %s --\u003e",
       ".js": "// %s",
       ".md": "\u003c!-- %s --\u003e",
       ".rb": "# %s",
-      ".ts": "// %s"
+      ".sh": "# %s",
+      ".ts": "// %s",
+      ".yaml": "# %s",
+      ".yml": "# %s"
     },
     "snippets": {
       "src/main.ts": {
@@ -292,4 +297,4 @@
   },
   "title": "Hello",
   "type": "hype.Document"
-}
+}

testdata/snippets/.envrc

@@ -0,0 +1,6 @@
+# snippet: goodbye
+export GOODBYE="goodbye"
+# snippet: goodbye
+# snippet: hello
+export HELLO="hello"
+# snippet: hello

testdata/snippets/snippets.env

@@ -0,0 +1,6 @@
+# snippet: goodbye
+GOODBYE="goodbye"
+# snippet: goodbye
+# snippet: hello
+HELLO="hello"
+# snippet: hello

testdata/snippets/snippets.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+# snippet: goodbye
+echo "Goodbye, World!"
+# snippet: goodbye
+
+# snippet: hello
+echo "Hello, World!"
+# snippet: hello

testdata/snippets/snippets.yaml

@@ -0,0 +1,17 @@
+---
+name: Jane Doe
+age: 30
+isEmployed: true
+# snippet: goodbye
+address:
+  street: 123 Main St
+  city: Springfield
+  zip: 12345
+# snippet: goodbye
+pets:
+  - type: dog
+    name: Rex
+# snippet: hello
+  - type: cat
+    name: Whiskers
+# snippet: hello

testdata/snippets/snippets.yml

@@ -0,0 +1,17 @@
+---
+name: Jane Doe
+age: 30
+isEmployed: true
+# snippet: goodbye
+address:
+  street: 123 Main St
+  city: Springfield
+  zip: 12345
+# snippet: goodbye
+pets:
+  - type: dog
+    name: Rex
+# snippet: hello
+  - type: cat
+    name: Whiskers
+# snippet: hello