@yegor256/dogent 0.2.0 → 0.4.0

package/README.md

@@ -23,7 +23,7 @@ We respect [agent-sh/agnix](https://github.com/agent-sh/agnix)
 Run it on any manifesto file, no installation required:
 
 ```bash
-npx @yegor256/dogent@0.1.0 CLAUDE.md
+npx @yegor256/dogent@0.3.0 CLAUDE.md
 ```
 
 Lint several files at once:
@@ -32,6 +32,13 @@ Lint several files at once:
 npx @yegor256/dogent SKILL.md CLAUDE.md AGENTS.md
 ```
 
+Point it at a directory to lint the default manifestos it holds
+  (`AGENTS.md`, `CLAUDE.md`, `SKILL.md`, `SKILLS.md`):
+
+```bash
+npx @yegor256/dogent .
+```
+
 Sample output:
 
 ```text
@@ -55,7 +62,9 @@ The command exits with a non-zero status when problems are found,
 - Instructions must be grouped in sections.
 - Section names must be short, 1-3 words.
 - Every line must be no longer than 80 symbols.
+- The whole file must stay under 4000 tokens.
 - Every line must sound like a command.
+- Every sentence must start with a capital and end with a period.
 - No articles, no noise, no bloated text.
 - Simple grammar, no ambiguity.
 - `SKILL.md` must open with valid frontmatter.
@@ -119,7 +128,7 @@ Reference `dogent` as a remote hook in `.pre-commit-config.yaml`:
 ```yaml
 repos:
   - repo: https://github.com/yegor256/dogent
-    rev: 0.1.0
+    rev: 0.3.0
     hooks:
       - id: dogent
 ```

package/package.json

@@ -40,5 +40,5 @@
     "lint": "eslint .",
     "test": "mocha 'test/**/*.js' --timeout 60000"
   },
-  "version": "0.2.0"
+  "version": "0.4.0"
 }

package/src/dogent.js

@@ -9,17 +9,18 @@
 const fs = require('fs');
 const Markdown = require('./markdown');
 const Report = require('./report');
+const Sources = require('./sources');
 const rules = require('./rules');
 
 const argv = process.argv.slice(2);
 const sarif = argv.indexOf('--sarif') !== -1;
-const files = argv.filter((arg) => arg !== '--sarif');
-if (files.length === 0) {
-  process.stderr.write('Usage: dogent [--sarif] <file.md>...\n');
+const paths = argv.filter((arg) => arg !== '--sarif');
+if (paths.length === 0) {
+  process.stderr.write('Usage: dogent [--sarif] <file.md|dir>...\n');
   process.exit(2);
 }
 const found = [];
-files.forEach((file) => {
+new Sources(paths).files().forEach((file) => {
   const document = new Markdown(file, fs.readFileSync(file, 'utf8')).document();
   rules().forEach((rule) => {
     rule.violations(document).forEach((violation) => found.push(violation));

package/src/rules/index.js

@@ -6,18 +6,22 @@
 'use strict';
 
 const LineLength = require('./line-length');
+const TokenCount = require('./token-count');
 const ShortSections = require('./short-sections');
 const Grouped = require('./grouped');
 const NoArticles = require('./no-articles');
 const Command = require('./command');
+const Punctuation = require('./punctuation');
 const Frontmatter = require('./frontmatter');
 
 module.exports = () => [
   new Grouped(),
   new ShortSections(),
   new LineLength(80),
+  new TokenCount(4000),
   new NoArticles(),
   new Command(),
+  new Punctuation(),
   new Frontmatter(
     'SKILL.md',
     ['name', 'description'],

package/src/rules/punctuation.js

@@ -0,0 +1,57 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2026 Yegor Bugayenko
+ * SPDX-License-Identifier: MIT
+ */
+
+'use strict';
+
+const Violation = require('../violation');
+const Region = require('../region');
+
+/**
+ * Punctuation.
+ *
+ * Demands that every instruction read as one whole sentence: opening
+ * with a capital letter and closing with a period. Headings, snippets,
+ * and frontmatter escape this rule.
+ */
+class Punctuation {
+  constructor() {
+    this.id = 'punctuation';
+  }
+  violations(document) {
+    const uri = document.uri();
+    return document.walk({
+      header: () => [],
+      prose: (text, line) => this.judge(text, line, uri),
+      snippet: () => [],
+      bullets: () => [],
+      frontmatter: () => []
+    });
+  }
+  judge(text, line, uri) {
+    const [lead] = text.match(/^\s*(?:[-*+]|\d+\.)\s+/u) || text.match(/^\s*/u);
+    const sentence = text.slice(lead.length).replace(/\s+$/u, '');
+    const letter = sentence.match(/[A-Za-z]/u);
+    return [].concat(
+      sentence !== '' && letter !== null && letter[0] !== letter[0].toUpperCase()
+        ? [new Violation(
+          this.id,
+          'error',
+          'sentence must start with a capital letter',
+          new Region(uri, line, lead.length + letter.index + 1)
+        )]
+        : [],
+      sentence !== '' && sentence.slice(-1) !== '.'
+        ? [new Violation(
+          this.id,
+          'error',
+          'sentence must end with a period',
+          new Region(uri, line, lead.length + sentence.length)
+        )]
+        : []
+    );
+  }
+}
+
+module.exports = Punctuation;

package/src/rules/token-count.js

@@ -0,0 +1,44 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2026 Yegor Bugayenko
+ * SPDX-License-Identifier: MIT
+ */
+
+'use strict';
+
+const Violation = require('../violation');
+const Region = require('../region');
+
+/**
+ * TokenCount.
+ *
+ * Demands that a whole manifesto stay small enough to ride cheaply inside
+ * an agent context. Counts every word, number, and punctuation symbol
+ * across all fragments, frontmatter included, and complains once the sum
+ * reaches a cap.
+ */
+class TokenCount {
+  constructor(cap) {
+    this.id = 'token-count';
+    this.cap = cap;
+  }
+  violations(document) {
+    const count = (document.walk({
+      header: (text) => [text],
+      prose: (text) => [text],
+      snippet: (text) => [text],
+      bullets: () => [],
+      frontmatter: (pairs) => pairs.map((pair) => `${pair.key} ${pair.value}`)
+    }).join(' ').match(/[A-Za-z0-9]+|[^\sA-Za-z0-9]/gu) || []).length;
+    if (count < this.cap) {
+      return [];
+    }
+    return [new Violation(
+      this.id,
+      'error',
+      `file exceeds ${this.cap} tokens, has ${count}`,
+      new Region(document.uri(), 1, 1)
+    )];
+  }
+}
+
+module.exports = TokenCount;

package/src/sources.js

@@ -0,0 +1,42 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2026 Yegor Bugayenko
+ * SPDX-License-Identifier: MIT
+ */
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Sources.
+ *
+ * The paths passed on the command line. Each path names either one
+ * manifesto file or one directory. A directory expands into the default
+ * manifesto files it actually contains, so `dogent .` lints every known
+ * manifesto in the current folder.
+ */
+class Sources {
+  constructor(paths, defaults = ['AGENTS.md', 'CLAUDE.md', 'SKILL.md', 'SKILLS.md']) {
+    this.paths = paths;
+    this.defaults = defaults;
+  }
+  files() {
+    const found = [];
+    this.paths.forEach((entry) => {
+      if (fs.statSync(entry).isDirectory()) {
+        this.defaults.forEach((name) => {
+          const file = path.join(entry, name);
+          if (fs.existsSync(file)) {
+            found.push(file);
+          }
+        });
+      } else {
+        found.push(entry);
+      }
+    });
+    return found;
+  }
+}
+
+module.exports = Sources;

package/src/violation.js

@@ -22,7 +22,7 @@ class Violation {
     return [
       `${this.spot.uri()}:${this.spot.line()}:${this.spot.column()}`,
       this.level,
-      this.rule,
+      `[${this.rule}]:`,
       this.message
     ].join(' ');
   }