Expand AI detection and add the goboscript logo to Stage notes

.github/workflows/check.yml

@@ -7,7 +7,7 @@ jobs:
             - uses: actions/checkout@v4
             # TODO: remove this step and the script when stable cargo supports
             # registry.global-min-publish-age (stabilized in cargo 1.100).
-            - run: python3 tools/check-min-publish-age.py
+            - run: ./tools/check-min-publish-age.py
             - uses: actions-rust-lang/setup-rust-toolchain@v1
               with:
                   toolchain: "stable"

docs/configuration.md

@@ -96,11 +96,12 @@ stage_height = 480 # default is 360
 
 ## Notes
 
-Embeds the contents of a file as a comment inside the Stage.
+Add credits, instructions, or other project notes to the Stage using a text file.
 
 ```toml
 notes = "NOTES.md" # default is unset
 ```
 
-The comment is skipped if the file is missing or empty, and text longer than 8000
-characters is truncated.
+Notes appear in a Stage comment beneath the goboscript logo.
+The logo is included even when no notes are provided. Comments longer than
+8000 characters are shortened.

src/LOGO.txt

@@ -0,0 +1,9 @@
+⠀⠀⣀⣀⣀⡀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣤⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢾⣷⣾⡷⠀⠀⠀⠀⠀⠀⠀⢸⣿⡆⠀⠀⠀⠀
+⠀⣾⣿⠟⠻⣿⡇⠀⠀⠀⠀⠀⠀⠀⢸⣿⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣀⠀⠀⠀⠀⠀⣠⣴⣶⣶⡄⠀⠀⣀⣀⣀⡀⠀⣀⡀⠀⣀⡀⠙⠋⠀⢀⣤⣤⣤⣤⡄⢰⣶⣿⣷⣶⣶⠀⠀
+⢸⣿⠃⠀⠀⢻⣿⠀⣴⣾⡿⣿⣷⡄⢸⣿⣿⣿⣿⣦⡀⠀⠀⣰⣿⡿⣿⣷⣄⠀⠀⣾⣿⠟⠉⠛⠃⠀⣼⣿⠟⠛⠃⠀⣿⣇⣼⠟⠃⣿⡇⠸⣿⡟⠋⠉⠻⣿⣦⠀⣿⡏⠉⠁⠀⠀
+⢸⣿⠀⠀⠀⢸⣿⠀⣿⡏⠀⠈⢿⣿⢸⣿⠋⠀⠙⢿⣿⠀⢀⣿⡟⠀⠈⢻⣿⡆⠀⢿⣿⣦⣤⣤⡀⠀⣿⡏⠀⠀⠀⠀⢻⣿⠏⠀⠀⢿⣿⠀⣿⡇⠀⠀⠀⢹⣿⠀⣿⡇⠀⠀⠀⠀
+⢸⣿⡄⠀⠀⣸⣿⠀⣿⡇⠀⠀⢸⣿⢸⣿⡄⠀⠀⢸⣿⠀⢸⣿⡇⠀⠀⠀⣿⡇⠀⠀⠉⠉⠙⢿⣿⠀⣿⡇⠀⠀⠀⠀⢸⣿⠀⠀⠀⢸⣿⠀⣿⡇⠀⠀⠀⣼⣿⠀⣿⣇⠀⠀⠀⠀
+⠈⠿⣿⣿⣿⣿⣿⠀⣿⣷⡀⢀⣼⣿⠀⣿⣇⣀⣠⣿⣿⠀⠸⣿⣇⠀⠀⣰⣿⡇⢀⣤⣄⣀⣠⣾⡿⠀⣿⣧⣤⣴⣶⡆⢸⣿⠀⠀⠀⢸⣿⠀⣿⣧⣤⣴⣾⡿⠏⠀⢻⣿⣄⣀⣀⡀
+⠀⠀⠀⠀⣠⣿⡿⠀⠘⠿⠿⠿⠿⠃⠀⠛⠻⠿⠿⠟⠃⠀⠀⠻⢿⣿⣿⠿⠛⠀⠈⠛⠿⠿⠿⠛⠁⠀⠙⠛⠛⠛⠛⠁⠈⠉⠀⠀⠀⠈⠉⠀⣿⡟⠛⠋⠉⠀⠀⠀⠈⠛⠛⠛⠛⠃
+⣿⣷⣶⣿⡿⠟⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⣷⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
+⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠁⠀⠀

src/codegen.rs

@@ -1,3 +1,4 @@
+mod ai_detection;
 pub mod assets;
 pub mod build;
 mod cleanup;

src/codegen/ai_detection.rs

@@ -0,0 +1,177 @@
+use std::path::Path;
+
+use crate::vfs::VFS;
+
+// https://github.com/vercel/vercel/blob/main/packages/detect-agent/src/index.ts
+// https://github.com/sdairs/is-ai-agent/blob/main/src/lib.rs
+const AGENT_NONEMPTY_ENV_VARS: &[&str] = &[
+    "AMP_CURRENT_THREAD_ID",
+    "ANTIGRAVITY_AGENT",
+    "ANTIGRAVITY_PROJECT_ID",
+    "AUGMENT_AGENT",
+    "CLAUDECODE",
+    "CLAUDE_CODE",
+    "CLAUDE_CODE_ENTRYPOINT",
+    "CLAUDE_CODE_EXECPATH",
+    "CLAUDE_CODE_IS_COWORK",
+    "CLAUDE_CODE_SESSION_ID",
+    "CLINE_ACTIVE",
+    "CLINE_TASK_ID",
+    "CODEBUDDY",
+    "CODEBUDDY_PROJECT_DIR",
+    "CODEBUDDY_SESSION_ID",
+    "CODEX_CI",
+    "CODEX_ROOT",
+    "CODEX_SANDBOX",
+    "CODEX_SANDBOX_NETWORK_DISABLED",
+    "CODEX_THREAD_ID",
+    "COPILOT_AGENT",
+    "COPILOT_AGENT_JOB_ID",
+    "COPILOT_AGENT_SESSION_ID",
+    "COPILOT_CLI",
+    "CRUSH",
+    "CURSOR_AGENT",
+    "CURSOR_SANDBOX",
+    "CURSOR_TRACE_ID",
+    "FIREBENDER_TERMINAL",
+    "GEMINI_CLI",
+    "GOOSE_TERMINAL",
+    "IFLOW_CLI",
+    "KIRO_AGENT_PATH",
+    "OPENCODE",
+    "OPENCODE_APP_INFO",
+    "OPENCODE_BIN_PATH",
+    "OPENCODE_CLIENT",
+    "OPENCODE_MODES",
+    "OPENCODE_PID",
+    "OPENCODE_SERVER",
+    "OZ_RUN_ID",
+    "PI_CODING_AGENT",
+    "QWEN_CODE",
+    "ROO_CODE_TASK_ID",
+    "TRAE_AI_SHELL_ID",
+    "VECLI_DIR",
+    "VECLI_SANDBOX",
+];
+
+const AGENT_NONBLANK_ENV_VARS: &[&str] = &[
+    "CODEX_SESSION_ID",
+    "GROK_SESSION_ID",
+    "HERMES_SESSION_ID",
+    "JUNIE_SHIM_PATH",
+    "PI_SESSION_ID",
+];
+
+const AGENT_EXACT_ENV_VALUES: &[(&str, &str)] = &[
+    ("CLAUDE_CODE_CHILD_SESSION", "1"),
+    ("DSH_SHELL", "1"),
+    ("HERMES_AGENT", "true"),
+    ("KILO", "1"),
+    ("OPENCLAW_SHELL", "exec"),
+    ("VTCODE", "1"),
+];
+
+fn env_is_nonempty(names: &[&str], env: &impl Fn(&str) -> Option<String>) -> bool {
+    names
+        .iter()
+        .any(|name| env(name).is_some_and(|value| !value.is_empty()))
+}
+
+fn env_is_nonblank(names: &[&str], env: &impl Fn(&str) -> Option<String>) -> bool {
+    names
+        .iter()
+        .any(|name| env(name).is_some_and(|value| !value.trim().is_empty()))
+}
+
+fn env_equals(values: &[(&str, &str)], env: &impl Fn(&str) -> Option<String>) -> bool {
+    values
+        .iter()
+        .any(|(name, expected)| env(name).is_some_and(|value| value == *expected))
+}
+
+fn env_trimmed_equals(name: &str, expected: &str, env: &impl Fn(&str) -> Option<String>) -> bool {
+    env(name).is_some_and(|value| value.trim() == expected)
+}
+
+fn env_contains(names: &[&str], marker: &str, env: &impl Fn(&str) -> Option<String>) -> bool {
+    names
+        .iter()
+        .any(|name| env(name).is_some_and(|value| value.contains(marker)))
+}
+
+fn env_is_enabled(names: &[&str], env: &impl Fn(&str) -> Option<String>) -> bool {
+    names.iter().any(|name| {
+        env(name).is_some_and(|value| {
+            let value = value.trim();
+            !value.is_empty()
+                && !["0", "false", "no", "off"]
+                    .iter()
+                    .any(|disabled| value.eq_ignore_ascii_case(disabled))
+        })
+    })
+}
+
+pub(super) fn is_ai_project(fs: &mut dyn VFS, input: &Path) -> bool {
+    let env = |name: &str| std::env::var(name).ok();
+    let is_ai_env = env_is_nonempty(AGENT_NONEMPTY_ENV_VARS, &env)
+        || env_is_nonblank(AGENT_NONBLANK_ENV_VARS, &env)
+        || env_equals(AGENT_EXACT_ENV_VALUES, &env)
+        || env_is_enabled(&["AGENT", "AI_AGENT"], &env)
+        || env_trimmed_equals("CURSOR_EXTENSION_HOST_ROLE", "agent-exec", &env)
+        || env_contains(&["AWS_EXECUTION_ENV"], "AmazonQ-For-CLI", &env)
+        || (env_is_nonempty(&["AGENT_CONTEXT_OUT"], &env)
+            && env_is_nonempty(&["AGENT_DISPLAY_OUT"], &env))
+        || env_contains(&["PS1", "PROMPT_COMMAND"], "###PS1JSON###", &env);
+    let has_ai_instructions = [
+        "AGENTS.md",
+        "AGENTS.override.md",
+        "CLAUDE.md",
+        "GEMINI.md",
+        "CONVENTIONS.md",
+        ".aider.conf.yml",
+        ".cursorrules",
+        ".windsurfrules",
+        ".clinerules",
+        ".roorules",
+        ".github/copilot-instructions.md",
+        ".junie/AGENTS.md",
+        ".junie/playbook.md",
+        ".junie/guidelines.md",
+    ]
+    .iter()
+    .any(|name| fs.is_file(&input.join(name)))
+        || input.to_str().is_some_and(|input| {
+            let input = glob::Pattern::escape(input);
+            [
+                ".github/instructions/**/*.instructions.md",
+                ".cursor/rules/**/*.mdc",
+                ".devin/rules/**/*.md",
+                ".windsurf/rules/**/*.md",
+                ".clinerules/**/*.md",
+                ".cline/rules/**/*.md",
+                ".roo/rules/**/*",
+                ".roo/rules-*/**/*",
+                ".roorules-*",
+                ".continue/rules/**/*.md",
+                ".amazonq/rules/**/*.md",
+                ".junie/rules/*.md",
+                ".junie/guidelines/**/*",
+            ]
+            .iter()
+            .any(|pattern| {
+                fs.glob(Path::new(&input).join(pattern).to_str().unwrap())
+                    .is_ok_and(|paths| paths.iter().any(|path| fs.is_file(path)))
+            })
+        });
+    if is_ai_env && !has_ai_instructions {
+        create_agents_md(fs, input);
+    }
+    is_ai_env || has_ai_instructions
+}
+
+fn create_agents_md(fs: &mut dyn VFS, input: &Path) {
+    let _ = fs.create_new_file(
+        &input.join("AGENTS.md"),
+        b"See the [goboscript documentation](https://aspiz.uk/goboscript/docs).\n",
+    );
+}

src/codegen/build.rs

@@ -21,12 +21,8 @@ use zip::{
 
 use crate::{
     ast::{
-        ConstExpr,
         Project,
         Sprite,
-        Type,
-        Value,
-        Var,
     },
     codegen::{
         cleanup,
@@ -49,24 +45,6 @@ use crate::{
     visitor,
 };
 
-const AGENT_ENV_VARS: &[&str] = &[
-    "CLAUDECODE",
-    "CLAUDE_CODE_ENTRYPOINT",
-    "CODEX_SANDBOX",
-    "CODEX_ROOT",
-    "CODEX_THREAD_ID",
-    "CURSOR_AGENT",
-    "CURSOR_TRACE_ID",
-    "OPENCODE",
-    "GEMINI_CLI",
-];
-
-fn is_run_by_agent() -> bool {
-    AGENT_ENV_VARS
-        .iter()
-        .any(|name| std::env::var_os(name).is_some())
-}
-
 pub fn build_impl<T: Write + Seek>(
     fs: Rc<RefCell<dyn VFS>>,
     input: PathBuf,
@@ -171,19 +149,6 @@ pub fn build_impl<T: Write + Seek>(
     );
     visitor::pass3::visit_project(&mut project);
     visitor::pass4::visit_project(&mut project);
-    if is_run_by_agent() {
-        project.stage.vars.entry("AI=true".into()).or_insert(Var {
-            name: "AI=true".into(),
-            span: 0..0,
-            type_: Type::Value,
-            default: Some(ConstExpr::Value {
-                value: Value::String("".into()),
-                span: 0..0,
-            }),
-            is_cloud: false,
-            is_used: true,
-        });
-    }
     log::info!("{:#?}", project);
     let mut sb3 = Sb3::new(fs.clone(), input.clone());
     sb3.project(