demotape 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 793dee695198e8d635ab95172a62cd5d33e9d9b8bd78fa8f3d47bce6e603d883
-  data.tar.gz: 6e093f2323f214a496ce865433be0ef1424ecbdbe7fe82ca616f3c616e330dd6
+  metadata.gz: b7a68e716ef2ec6d5115371bc0e836e25cbe4e19b20e2c3d7d514b4909dafa6a
+  data.tar.gz: 989fb3ed0c2ad24c30dbedcf706d6d4b51475e58796bfd1dfd8bef6ca6710a7c
 SHA512:
-  metadata.gz: 4e82b9896b78c5deaea1dc9bb30c8f5128523fb0b92f7a455cd83faa1f267f82767dc35c120b9d8b5a318ee1f80133d18005d7fcd9582ea5b9f14d78668a27fc
-  data.tar.gz: 497ab24e25dda78d06aea04aa0349f6cfb3cf83d56b97608c011cc79953ab83b3bb53ff995e797514bc4845db2b5d2e8a5620786b68e7d0254178c281b961688
+  metadata.gz: 58bc92cd8ce53899ddcd6a56e24113697987b1ae6b9ea71edf5c05e3a1f1560c412c66c4306a67cc3f13769169fdd1fa2c591fbbdca4d09ccd27a54c5deb69b3
+  data.tar.gz: 18f8f3cd2420a788b527677da604aa0b68bdd9aa99755981a01e378a3fdb7592c4582916969b9814714daec45b40832afb481e06ce1b7d0b01a7d22c9e6d0889

data/.github/workflows/ruby-tests.yml

@@ -24,7 +24,7 @@ jobs:
           - Gemfile
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - uses: actions/cache@v4
         with:

data/.gitignore

@@ -13,3 +13,11 @@
 examples/themes/*.mp4
 /themes.json
 *.sw*
+*.vsix
+
+# Tree-sitter
+editors/zed/tree-sitter/node_modules/
+editors/zed/tree-sitter/build/
+editors/zed/tree-sitter/*.node
+editors/zed/grammars/demotape
+editors/zed/tree-sitter/examples

data/CHANGELOG.md

@@ -11,6 +11,12 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.4
+
+- [Fixed] Fix how Thor handle defaults for arrays.
+- [Fixed] Fix reading tapes from stdin.
+- [Fixed] Fix `demotape help run` to expand to `_run`.
+
 ## v0.0.3
 
 - [Changed] Re-implemented parser.

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to demotape
+# Contributing to Demo Tape
 
 👍🎉 First off, thanks for taking the time to contribute! 🎉👍
 
@@ -32,7 +32,7 @@ by [opening an issue on Github](https://github.com/fnando/demotape/issues).
 When you're ready to make your pull request, follow checklist below to make sure
 your contribution is according to how this project works.
 
-1. [Fork](https://help.github.com/forking/) demotape
+1. [Fork](https://help.github.com/forking/) Demo Tape
 2. Create a topic branch - `git checkout -b my_branch`
 3. Make your changes using [descriptive commit messages](#commit-messages)
 4. Update CHANGELOG.md describing your changes by adding an entry to the

data/README.md

@@ -1,11 +1,11 @@
-# demotape
+# Demo Tape
 
 [![Tests](https://github.com/fnando/demotape/workflows/ruby-tests/badge.svg)](https://github.com/fnando/demotape)
 [![Gem](https://img.shields.io/gem/v/demotape.svg)](https://rubygems.org/gems/demotape)
 [![Gem](https://img.shields.io/gem/dt/demotape.svg)](https://rubygems.org/gems/demotape)
 [![MIT License](https://img.shields.io/:License-MIT-blue.svg)](https://tldrlegal.com/license/mit-license)
 
-![DemoTape in action!](https://github.com/fnando/demotape/raw/main/examples/fastfetch.gif)
+![Demo Tape in action!](https://github.com/fnando/demotape/raw/main/examples/fastfetch.gif)
 
 Record terminal sessions from your CLI tools
 
@@ -26,9 +26,18 @@ Or add the following line to your project's Gemfile:
 gem "demotape"
 ```
 
+### Editor Integration
+
+Demo Tape has extensions for several editors to provide syntax highlighting and
+snippets.
+
+- Sublime Text: https://github.com/fnando/sublime-demotape/
+- VSCode: https://marketplace.visualstudio.com/items?itemName=fnando.demotape
+- vim: https://github.com/fnando/demotape/blob/main/editors/vim/README.md
+
 ### Shell Completion
 
-DemoTape supports shell completion for Bash, Zsh, Fish, and PowerShell. To set
+Demo Tape supports shell completion for Bash, Zsh, Fish, and PowerShell. To set
 up completion for your shell:
 
 **Bash:**
@@ -73,7 +82,7 @@ demotape completion --shell=powershell | Out-String | Invoke-Expression
 
 ## Usage
 
-Run a DemoTape script:
+Run a Demo Tape script:
 
 ```console
 $ demotape run path/to/script.tape
@@ -109,12 +118,12 @@ $ echo "Type 'echo \"it works with stdin too\"'\nEnter\nSleep 5" | \
 ### Examples
 
 The [`examples/`](https://github.com/fnando/demotape/tree/main/examples) folder
-contains several DemoTape scripts showcasing different features. There you'll
+contains several Demo Tape scripts showcasing different features. There you'll
 also find the generated output files (videos, GIFs, and screenshots).
 
-## DemoTape Syntax
+## Demo Tape Syntax
 
-DemoTape scripts (`.tape` files) consist of a series of commands, one per line.
+Demo Tape scripts (`.tape` files) consist of a series of commands, one per line.
 Each command performs an action in the terminal recording, such as typing text,
 pressing keys, waiting, or configuring the recording session.
 
@@ -579,7 +588,7 @@ Set padding 20
 # Start recording
 Sleep 1
 
-Type "echo 'Hello, DemoTape!'"
+Type "echo 'Hello, Demo Tape!'"
 Enter
 Sleep 500ms
 
@@ -639,7 +648,7 @@ quirks and adding some extra features.
 > [!WARNING]
 >
 > The syntax is not fully compatible with vhs. Although some commands are
-> similar, there are many differences. Please refer to the DemoTape syntax
+> similar, there are many differences. Please refer to the Demo Tape syntax
 > documentation above.
 
 ## Maintainer
@@ -663,6 +672,6 @@ found at https://github.com/fnando/demotape/blob/main/LICENSE.md.
 
 ## Code of Conduct
 
-Everyone interacting in the demotape project's codebases, issue trackers, chat
+Everyone interacting in the Demo Tape project's codebases, issue trackers, chat
 rooms and mailing lists is expected to follow the
 [code of conduct](https://github.com/fnando/demotape/blob/main/CODE_OF_CONDUCT.md).

data/editors/sublime-text/DemoTape.sublime-syntax

@@ -1,6 +1,6 @@
 %YAML 1.2
 ---
-name: DemoTape
+name: Demo Tape
 file_extensions:
   - tape
 scope: source.demotape

data/editors/vim/ftdetect/demotape.vim

@@ -1,2 +1,2 @@
-" Detect DemoTape files
+" Detect Demo Tape files
 au BufRead,BufNewFile *.tape set filetype=demotape

data/editors/vim/syntax/demotape.vim

@@ -1,5 +1,5 @@
 " Vim syntax file
-" Language: DemoTape
+" Language: Demo Tape
 " Maintainer: Nando Vieira
 " Latest Revision: 2024-11-12
 

data/editors/vscode/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2025 Nando Vieira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/editors/vscode/README.md

@@ -1,9 +1,19 @@
-# DemoTape VSCode Extension
+# Demo Tape VSCode Extension
 
-Syntax highlighting for DemoTape (`.tape`) files in Visual Studio Code.
+Syntax highlighting for [Demo Tape](https://github.com/fnando/demotape)
+(`.tape`) files in Visual Studio Code.
 
 ## Installation
 
+### Marketplace
+
+1. Open Visual Studio Code
+2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS)
+3. Search for
+   [DemoTape](https://marketplace.visualstudio.com/items?itemName=fnando.demotape)
+
+### Manual Installation
+
 Copy this directory to your VSCode extensions folder:
 
 - **Windows**: `%USERPROFILE%\.vscode\extensions\demotape`

data/editors/vscode/RELEASE_PROCESS.md

@@ -0,0 +1,10 @@
+# Release Process
+
+1. Bump up the version on `package.json`
+2. [Publish the extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension).
+
+```bash
+npm install -g @vscode/vsce
+vsce package
+vsce publish --pat $MICROSOFT_VSCODE_API_KEY
+```

data/editors/vscode/demotape.tmLanguage.json

@@ -1,9 +1,13 @@
 {
   "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
-  "name": "DemoTape",
+  "name": "Demo Tape",
   "scopeName": "source.demotape",
   "fileTypes": ["tape"],
-  "patterns": [{ "include": "#comments" }, { "include": "#blocks" }, { "include": "#commands" }],
+  "patterns": [
+    { "include": "#comments" },
+    { "include": "#blocks" },
+    { "include": "#commands" }
+  ],
   "repository": {
     "blocks": {
       "patterns": [
@@ -19,10 +23,7 @@
           "endCaptures": {
             "1": { "name": "keyword.control.demotape" }
           },
-          "patterns": [
-            { "include": "#comments" },
-            { "include": "#commands" }
-          ]
+          "patterns": [{ "include": "#comments" }, { "include": "#commands" }]
         }
       ]
     },

data/editors/vscode/package.json

@@ -1,12 +1,23 @@
 {
   "name": "demotape",
-  "displayName": "DemoTape",
+  "displayName": "Demo Tape",
   "description": "Syntax highlighting for DemoTape (.tape) files",
-  "version": "0.1.0",
+  "version": "0.0.2",
   "publisher": "fnando",
+  "icon": "icon.png",
+  "license": "MIT",
+  "publisher": "fnando",
+  "repository": {
+    "url": "https://github.com/fnando/demotape"
+  },
   "engines": {
     "vscode": "^1.50.0"
   },
+  "files": [
+    "*.json",
+    "*.png",
+    "*.md"
+  ],
   "categories": [
     "Programming Languages"
   ],
@@ -14,8 +25,13 @@
     "languages": [
       {
         "id": "demotape",
-        "aliases": ["DemoTape", "demotape"],
-        "extensions": [".tape"],
+        "aliases": [
+          "DemoTape",
+          "demotape"
+        ],
+        "extensions": [
+          ".tape"
+        ],
         "configuration": "./language-configuration.json"
       }
     ],

data/editors/zed/extension.toml

@@ -0,0 +1,12 @@
+id = "demotape"
+name = "Demo Tape"
+description = "Syntax highlighting for Demo Tape terminal recording scripts"
+version = "0.0.1"
+schema_version = 1
+authors = ["Nando Vieira <me@fnando.com>"]
+repository = "https://github.com/fnando/demotape"
+
+[grammars.demotape]
+repository = "https://github.com/fnando/demotape"
+rev = "main"
+path = "editors/zed/tree-sitter"

data/editors/zed/languages/demotape/config.toml

@@ -0,0 +1,11 @@
+name = "Demo Tape"
+grammar = "demotape"
+path_suffixes = ["tape"]
+line_comments = ["# "]
+brackets = [
+  { start = "\"", end = "\"", close = true, newline = false },
+  { start = "'", end = "'", close = true, newline = false },
+  { start = "(", end = ")", close = true, newline = true },
+  { start = "[", end = "]", close = true, newline = true },
+  { start = "{", end = "}", close = true, newline = true },
+]

data/editors/zed/languages/demotape/highlights.scm

@@ -0,0 +1,70 @@
+; Comments
+(comment) @comment
+
+; Command keywords - using string literals
+"Type" @keyword
+"TypeFile" @keyword
+"Run" @keyword
+"WaitUntil" @keyword
+"Set" @keyword
+"Output" @keyword
+"Copy" @keyword
+"Send" @keyword
+"Include" @keyword
+"Screenshot" @keyword
+"Wait" @keyword
+"Sleep" @keyword
+"Require" @keyword
+"Group" @keyword
+"do" @keyword
+"end" @keyword
+
+; Command keywords - simple commands (just the literal)
+(paste_command) @keyword
+(pause_command) @keyword
+(resume_command) @keyword
+(clear_command) @keyword
+
+
+; Group blocks
+(group_block
+  name: (identifier) @function)
+(group_invocation
+  group: (identifier) @function)
+
+; Keys
+(special_key) @constant
+(modifier_key) @constant
+(letter_key) @constant
+
+; Operators
+"@" @operator
+"+" @operator
+"," @punctuation.delimiter
+
+; Strings
+(string) @string
+(escape_sequence) @string.escape
+(unquoted_string) @string
+
+; Regex
+(regex) @string.regex
+
+; Numbers and durations
+(number) @number
+(duration) @number
+
+; Booleans
+(boolean) @boolean
+
+; Set options
+(set_command
+  option: (set_option) @constant)
+
+; Identifiers
+(identifier) @variable
+
+; Force highlight for problematic words with higher priority
+((set_option) @constant
+  (#match? @constant "^(height|margin)$")
+  (#set! "priority" 200))

data/editors/zed/package-lock.json

@@ -0,0 +1,6 @@
+{
+  "name": "zed",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {}
+}

data/editors/zed/tree-sitter/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "tree-sitter-demotape"
+description = "demotape grammar for the tree-sitter parsing library"
+version = "0.0.1"
+keywords = ["incremental", "parsing", "demotape"]
+categories = ["parsing", "text-editors"]
+repository = "https://github.com/tree-sitter/tree-sitter-demotape"
+edition = "2018"
+license = "MIT"
+
+build = "bindings/rust/build.rs"
+include = [
+  "bindings/rust/*",
+  "grammar.js",
+  "queries/*",
+  "src/*",
+]
+
+[lib]
+path = "bindings/rust/lib.rs"
+
+[dependencies]
+tree-sitter = "~0.20.10"
+
+[build-dependencies]
+cc = "1.0"

data/editors/zed/tree-sitter/binding.gyp

@@ -0,0 +1,19 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_demotape_binding",
+      "include_dirs": [
+        "<!(node -e \"require('nan')\")",
+        "src"
+      ],
+      "sources": [
+        "bindings/node/binding.cc",
+        "src/parser.c",
+        # If your language uses an external scanner, add it here.
+      ],
+      "cflags_c": [
+        "-std=c99",
+      ]
+    }
+  ]
+}

data/editors/zed/tree-sitter/bindings/node/binding.cc

@@ -0,0 +1,28 @@
+#include "tree_sitter/parser.h"
+#include <node.h>
+#include "nan.h"
+
+using namespace v8;
+
+extern "C" TSLanguage * tree_sitter_demotape();
+
+namespace {
+
+NAN_METHOD(New) {}
+
+void Init(Local<Object> exports, Local<Object> module) {
+  Local<FunctionTemplate> tpl = Nan::New<FunctionTemplate>(New);
+  tpl->SetClassName(Nan::New("Language").ToLocalChecked());
+  tpl->InstanceTemplate()->SetInternalFieldCount(1);
+
+  Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
+  Local<Object> instance = constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
+  Nan::SetInternalFieldPointer(instance, 0, tree_sitter_demotape());
+
+  Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("demotape").ToLocalChecked());
+  Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
+}
+
+NODE_MODULE(tree_sitter_demotape_binding, Init)
+
+}  // namespace

data/editors/zed/tree-sitter/bindings/node/index.js

@@ -0,0 +1,19 @@
+try {
+  module.exports = require("../../build/Release/tree_sitter_demotape_binding");
+} catch (error1) {
+  if (error1.code !== 'MODULE_NOT_FOUND') {
+    throw error1;
+  }
+  try {
+    module.exports = require("../../build/Debug/tree_sitter_demotape_binding");
+  } catch (error2) {
+    if (error2.code !== 'MODULE_NOT_FOUND') {
+      throw error2;
+    }
+    throw error1
+  }
+}
+
+try {
+  module.exports.nodeTypeInfo = require("../../src/node-types.json");
+} catch (_) {}

data/editors/zed/tree-sitter/bindings/rust/build.rs

@@ -0,0 +1,40 @@
+fn main() {
+    let src_dir = std::path::Path::new("src");
+
+    let mut c_config = cc::Build::new();
+    c_config.include(&src_dir);
+    c_config
+        .flag_if_supported("-Wno-unused-parameter")
+        .flag_if_supported("-Wno-unused-but-set-variable")
+        .flag_if_supported("-Wno-trigraphs");
+    let parser_path = src_dir.join("parser.c");
+    c_config.file(&parser_path);
+
+    // If your language uses an external scanner written in C,
+    // then include this block of code:
+
+    /*
+    let scanner_path = src_dir.join("scanner.c");
+    c_config.file(&scanner_path);
+    println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
+    */
+
+    c_config.compile("parser");
+    println!("cargo:rerun-if-changed={}", parser_path.to_str().unwrap());
+
+    // If your language uses an external scanner written in C++,
+    // then include this block of code:
+
+    /*
+    let mut cpp_config = cc::Build::new();
+    cpp_config.cpp(true);
+    cpp_config.include(&src_dir);
+    cpp_config
+        .flag_if_supported("-Wno-unused-parameter")
+        .flag_if_supported("-Wno-unused-but-set-variable");
+    let scanner_path = src_dir.join("scanner.cc");
+    cpp_config.file(&scanner_path);
+    cpp_config.compile("scanner");
+    println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
+    */
+}

data/editors/zed/tree-sitter/bindings/rust/lib.rs

@@ -0,0 +1,52 @@
+//! This crate provides demotape language support for the [tree-sitter][] parsing library.
+//!
+//! Typically, you will use the [language][language func] function to add this language to a
+//! tree-sitter [Parser][], and then use the parser to parse some code:
+//!
+//! ```
+//! let code = "";
+//! let mut parser = tree_sitter::Parser::new();
+//! parser.set_language(tree_sitter_demotape::language()).expect("Error loading demotape grammar");
+//! let tree = parser.parse(code, None).unwrap();
+//! ```
+//!
+//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
+//! [language func]: fn.language.html
+//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
+//! [tree-sitter]: https://tree-sitter.github.io/
+
+use tree_sitter::Language;
+
+extern "C" {
+    fn tree_sitter_demotape() -> Language;
+}
+
+/// Get the tree-sitter [Language][] for this grammar.
+///
+/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
+pub fn language() -> Language {
+    unsafe { tree_sitter_demotape() }
+}
+
+/// The content of the [`node-types.json`][] file for this grammar.
+///
+/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
+pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");
+
+// Uncomment these to include any queries that this grammar contains
+
+// pub const HIGHLIGHTS_QUERY: &'static str = include_str!("../../queries/highlights.scm");
+// pub const INJECTIONS_QUERY: &'static str = include_str!("../../queries/injections.scm");
+// pub const LOCALS_QUERY: &'static str = include_str!("../../queries/locals.scm");
+// pub const TAGS_QUERY: &'static str = include_str!("../../queries/tags.scm");
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_can_load_grammar() {
+        let mut parser = tree_sitter::Parser::new();
+        parser
+            .set_language(super::language())
+            .expect("Error loading demotape language");
+    }
+}