agent-context 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c3555039c6fe5ae6c08d31a01b7ad69fdbc37d5dc13ddedbd9066fbd42a202
-  data.tar.gz: 496c8d37bc994834ca49328976f53cedef923c1aafd76073eac1218e27322579
+  metadata.gz: f5e443b38ea46b98fbee27a14ea918b63a619d9318a54884877f142224038d3d
+  data.tar.gz: f750d6fad191556113a782cc1a66616f529b80d689f2226be3d27a87dba82725
 SHA512:
-  metadata.gz: 35e2df052388b0bc29c373ec4fb287ed595cb4de3aa8e7178e80917be78937e0ee7477d11a75c8403c104a0b328eb3307c75d91ec102616f663fbbe64dbe7ffc
-  data.tar.gz: 5597bce947893b800f481c9df0ae89a70821e162593ca437116de60c1f58b981847d66c6ff80e90299385aed9e56d369d3d9b714ab794089bab1a65350d3872b
+  metadata.gz: 5c5f7bc3b996bfbd509da5bf0e9e41cfd561f95782d8558a83a8061e9f7c4886bbe5d57c9bf4d755fa1cc8db4fcdef69db1b96a2b4819ffda4f0c23738ab8e31
+  data.tar.gz: '0912e5e105747edb18f8dcf688bb63165a9ea205dab03d0f8f82f4a40769c5a1c99ace3c4fd5c39a669bc4afaac3a4380d12ea051df09dae87e4320bb4738202'

data/agent.md

@@ -2,7 +2,7 @@
 
 ## Context
 
-Context files from installed gems providing documentation and guidance for AI agents.
+This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`.
 
 ### decode
 

data/bake/agent/context.rb

@@ -69,7 +69,7 @@ def install(gem: nil)
 		installed = @installer.install_all_context
 		if installed.any?
 			puts "Installed context from #{installed.length} gems:"
-			installed.each { |gem_name| puts "  #{gem_name}" }
+			installed.each {|gem_name| puts "  #{gem_name}"}
 		else
 			puts "No gems with context found"
 		end

data/lib/agent/context/index.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2025, by Samuel Williams.
+# Copyright, 2025, by Shopify Inc.
 
 require_relative "version"
 require "fileutils"
-require "markly"
 require "yaml"
 
 # @namespace
@@ -44,7 +44,7 @@ module Agent
 			def generate_context_section
 				sections = []
 				
-				sections << "Context files from installed gems providing documentation and guidance for AI agents."
+				sections << "This section provides links to documentation from installed packages. It is automatically generated and may be updated by running `bake agent:context:install`."
 				sections << ""
 				
 				gem_contexts = collect_gem_contexts
@@ -129,7 +129,6 @@ module Agent
 					"## Context",
 					"",
 					context_content,
-					""
 				].join("\n")
 				File.write(agent_md_path, content)
 			end
@@ -274,7 +273,7 @@ module Agent
 			
 			def extract_title(lines)
 				# Look for the first markdown header
-				header_line = lines.find { |line| line.start_with?("#") }
+				header_line = lines.find {|line| line.start_with?("#")}
 				if header_line
 					# Remove markdown header syntax and clean up
 					header_line.sub(/^#+\s*/, "").strip

data/lib/agent/context/installer.rb

@@ -26,7 +26,7 @@ module Agent
 				"debugging"
 			]
 
-			# Initialize a new Helper instance.
+			# Initialize a new Installer instance.
 			#
 			# @parameter root [String] The root directory to work from (default: current directory).
 			# @parameter specifications [Gem::Specification] The gem specifications to search (default: all installed gems).
@@ -63,7 +63,7 @@ module Agent
 				
 			# Find a specific gem with context.
 			def find_gem_with_context(gem_name)
-				spec = @specifications.find { |s| s.name == gem_name }
+				spec = @specifications.find {|spec| spec.name == gem_name}
 				return nil unless spec
 					
 				context_path = File.join(spec.full_gem_path, "context")
@@ -86,7 +86,7 @@ module Agent
 				gem = find_gem_with_context(gem_name)
 				return nil unless gem
 					
-				Dir.glob(File.join(gem[:path], "**/*")).select { |f| File.file?(f) }
+				Dir.glob(File.join(gem[:path], "**/*")).select {|f| File.file?(f)}
 			end
 				
 			# Show content of a specific context file.
@@ -101,7 +101,7 @@ module Agent
 						File.join(gem[:path], "#{file_name}.md")
 					]
 					
-				file_path = possible_paths.find { |path| File.exist?(path) }
+				file_path = possible_paths.find {|path| File.exist?(path)}
 				return nil unless file_path
 					
 				File.read(file_path)
@@ -214,7 +214,7 @@ module Agent
 			
 			def extract_title(lines)
 				# Look for the first markdown header
-				header_line = lines.find { |line| line.start_with?("#") }
+				header_line = lines.find {|line| line.start_with?("#")}
 				if header_line
 					# Remove markdown header syntax and clean up
 					header_line.sub(/^#+\s*/, "").strip
@@ -257,14 +257,6 @@ module Agent
 				
 				description
 			end
-			
-			def extract_gem_description(gem_name)
-				# Find the gem specification using Ruby's Gem API
-				spec = Gem::Specification.find_by_name(gem_name)
-				spec&.summary
-			rescue Gem::MissingSpecError
-				nil
-			end
 		end
 	end
 end

data/lib/agent/context/version.rb

@@ -6,6 +6,6 @@
 
 module Agent
 	module Context
-		VERSION = "0.1.0"
+		VERSION = "0.1.2"
 	end
 end 

data/lib/agent/context.rb

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2025, by Shopify Inc.
+# Copyright, 2025, by Samuel Williams.
 
 require_relative "context/version"
 require_relative "context/installer"

data/readme.md

@@ -14,22 +14,23 @@ When you install context from gems, they are placed in the `.context/` directory
 
 Add the gem to your project and install context from all available gems:
 
-```bash
+``` bash
 $ bundle add agent-context
 $ bake agent:context:install
 ```
 
 This workflow:
-- Adds the `agent-context` gem to your project.
-- Installs context files from all gems into `.context/`.
-- Generates or updates `agent.md` with a comprehensive overview.
-- Follows the <https://agent.md> specification for agentic coding tools.
+
+  - Adds the `agent-context` gem to your project.
+  - Installs context files from all gems into `.context/`.
+  - Generates or updates `agent.md` with a comprehensive overview.
+  - Follows the <https://agent.md> specification for agentic coding tools.
 
 ## Context
 
 This gem provides its own context files in the `context/` directory, including:
 
-- `usage.md` - Comprehensive guide for using and providing context files.
+  - `usage.md` - Comprehensive guide for using and providing context files.
 
 When you install context from other gems, they will be placed in the `.context/` directory and referenced in `agent.md`.
 
@@ -39,7 +40,7 @@ When you install context from other gems, they will be placed in the `.context/`
 
 Add the `agent-context` gem to your project:
 
-```bash
+``` bash
 $ bundle add agent-context
 ```
 
@@ -49,13 +50,13 @@ $ bundle add agent-context
 
 Install context from all available gems and update `agent.md`:
 
-```bash
+``` bash
 $ bake agent:context:install
 ```
 
 Install context from a specific gem:
 
-```bash
+``` bash
 $ bake agent:context:install --gem async
 ```
 
@@ -63,13 +64,13 @@ $ bake agent:context:install --gem async
 
 List all gems that have context available:
 
-```bash
+``` bash
 $ bake agent:context:list
 ```
 
 List context files for a specific gem:
 
-```bash
+``` bash
 $ bake agent:context:list --gem async
 ```
 
@@ -77,7 +78,7 @@ $ bake agent:context:list --gem async
 
 Show the content of a specific context file:
 
-```bash
+``` bash
 $ bake agent:context:show --gem async --file thread-safety
 ```
 
@@ -85,30 +86,28 @@ $ bake agent:context:show --gem async --file thread-safety
 
 Both `.context/` and `agent.md` should be committed to git:
 
-- `agent.md` is user-facing documentation that should be versioned.
-- `.context/` files are referenced by `agent.md` and needed for AI agents to function properly.
-- This ensures AI agents in CI have access to the full context.
+  - `agent.md` is user-facing documentation that should be versioned.
+  - `.context/` files are referenced by `agent.md` and needed for AI agents to function properly.
+  - This ensures AI agents in CI have access to the full context.
 
 ## Providing Context in Your Gem
 
 To provide context files in your gem, create a `context/` directory in your gem's root:
 
-```
-your-gem/
-├── context/
-│   ├── getting-started.md
-│   ├── usage.md
-│   ├── configuration.md
-│   └── index.yaml (optional)
-├── lib/
-└── your-gem.gemspec
-```
+    your-gem/
+    ├── context/
+    │   ├── getting-started.md
+    │   ├── usage.md
+    │   ├── configuration.md
+    │   └── index.yaml (optional)
+    ├── lib/
+    └── your-gem.gemspec
 
 ### Optional: Custom Index File
 
 You can provide a custom `index.yaml` file to control ordering and metadata:
 
-```yaml
+``` yaml
 description: "Your gem description from gemspec"
 version: "1.0.0"
 files:
@@ -127,37 +126,57 @@ If no `index.yaml` is provided, one will be generated automatically from your ge
 The generated `agent.md` file can be integrated with various AI coding tools by creating symbolic links to their expected locations:
 
 ### Cline
-```bash
+
+``` bash
 ln -s agent.md .clinerules
 ```
 
 ### Claude Code
-```bash
+
+``` bash
 ln -s agent.md CLAUDE.md
 ```
 
 ### Cursor
-```bash
-ln -s agent.md .cursorrules
+
+First, create the `.cursor/rules` directory:
+
+``` bash
+mkdir -p .cursor/rules
 ```
 
+Then create `.cursor/rules/agent.mdc` with:
+
+``` markdown
+---
+alwaysApply: true
+---
+Consult the `agent.md` file in the root directory.
+```
+
+This approach uses Cursor's proper front-matter format and directs the AI to consult the main `agent.md` file.
+
 ### Gemini CLI, OpenAI Codex, OpenCode
-```bash
+
+``` bash
 ln -s agent.md AGENTS.md
 ```
 
 ### GitHub Copilot
-```bash
+
+``` bash
 ln -s ../../agent.md .github/copilot-instructions.md
 ```
 
 ### Replit
-```bash
+
+``` bash
 ln -s agent.md .replit.md
 ```
 
 ### Windsurf
-```bash
+
+``` bash
 ln -s agent.md .windsurfrules
 ```
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agent-context
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,33 +40,19 @@ cert_chain:
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: console
+  name: bake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.25'
-- !ruby/object:Gem::Dependency
-  name: markly
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.23'
 executables: []
 extensions: []
 extra_rdoc_files: []