dart-skills-lint-validation

Validating Skills with dart_skills_lint

Contents

• Usage for Agents (CLI)
• Setup for Dart Developers
• Authoring Custom Rules
• Workflow: Validating Skills
• Specification Reference

Usage for Agents (CLI)

Use the dart_skills_lint CLI to validate skills. Choose the appropriate workflow based on your environment:

Scenario A: The package is in your project dependencies

Use this method if you are working within a project that has dart_skills_lint listed in pubspec.yaml. Run:

dart run dart_skills_lint -d .agents/skills

Scenario B: The package is activated globally

Use this method if you want to validate skills across multiple projects without adding a dependency to each one. Run:

dart pub global run dart_skills_lint -d .agents/skills

Common Flags

• -d, --skills-directory: Specifies a root directory containing sub-folders of skills to validate. Can be passed multiple times.
• -s, --skill: Specifies an individual skill directory to validate directly. Can be passed multiple times.
• -q, --quiet: Hide non-error validation output.
• -w, --print-warnings: Enable printing of warning messages.
• --fast-fail: Halt execution immediately on the error.
• --ignore-config: Ignore the YAML configuration file entirely.

Setup for Dart Developers

Setup validation in your Dart project:

1. Add dart_skills_lint to your pubspec.yaml as a dev_dependency:

   dev_dependencies:
     dart_skills_lint: ^0.2.0
   

2. Integrate the linter into your automated tests by importing the package and calling validateSkills. This ensures your skills are automatically validated whenever you run dart test.

   Example test/lint_skills_test.dart:

   import 'dart:async';
   import 'package:dart_skills_lint/dart_skills_lint.dart';
   import 'package:logging/logging.dart';
   import 'package:test/test.dart';
   
   void main() {
     test('Run skills linter', () async {
       // Enable logging to see detailed validation errors in test output.
       final Level oldLevel = Logger.root.level;
       Logger.root.level = Level.ALL;
       final StreamSubscription<LogRecord> subscription =
           Logger.root.onRecord.listen((record) => print(record.message));
   
       try {
         final isValid = await validateSkills(
           skillDirPaths: ['.agents/skills'],
           resolvedRules: {
             'check-relative-paths': AnalysisSeverity.error,
             'check-absolute-paths': AnalysisSeverity.error,
             'check-trailing-whitespace': AnalysisSeverity.error,
           },
         );
         expect(isValid, isTrue, reason: 'Skills validation failed. See above for details.');
       } finally {
         Logger.root.level = oldLevel;
         await subscription.cancel();
       }
     });
   }