tldr-lint 0.0.20 → 0.0.22

package/README.md

@@ -71,10 +71,10 @@ TLDR009     | Page should contain a newline at end of file
 TLDR010     | Only Unix-style line endings allowed
 TLDR011     | Page never contains more than a single empty line
 TLDR012     | Page should contain no tabs
-TLDR013     | Title should be alphanumeric with dashes, underscores or spaces
+TLDR013     | Title should be alphanumeric with dashes, underscores, spaces or allowed characters
 TLDR014     | Page should contain no trailing whitespace
 TLDR015     | Example descriptions should start with a capital letter
-TLDR016     | Label for information link should be spelled exactly `More information: `
+TLDR016     | Label for information link should be spelled exactly `More information:` (with a succeeding whitespace)
 TLDR017     | Information link should be surrounded with angle brackets
 TLDR018     | Page should only include a single information link
 TLDR019     | Page should only include a maximum of 8 examples
@@ -91,6 +91,7 @@ TLDR108     | File name should not contain whitespace
 TLDR109     | File name should be lowercase
 TLDR110     | Command example should not be empty
 TLDR111     | File name should not contain any Windows-forbidden character
+TLDR112     | Terms `stdin`, `stdout`, `stderr`, and `regex` (including longer forms like "standard input", "regular expression") should be lowercase and wrapped in backticks
 
 [npm-url]: https://www.npmjs.com/package/tldr-lint
 [npm-image]: https://img.shields.io/npm/v/tldr-lint.svg

package/lib/tldr-lint.js

@@ -39,7 +39,8 @@ module.exports.ERRORS = parser.ERRORS = {
   'TLDR108': 'File name should not contain whitespace',
   'TLDR109': 'File name should be lowercase',
   'TLDR110': 'Command example should not be empty',
-  'TLDR111': 'File name should not contain any Windows-forbidden character'
+  'TLDR111': 'File name should not contain any Windows-forbidden character',
+  'TLDR112': 'Terms `stdin`, `stdout`, `stderr`, and `regex` should be lowercase and wrapped in backticks'
 };
 
 (function(parser) {
@@ -156,7 +157,6 @@ linter.format = function(parsedPage) {
     str += util.format('- %s', linter.formatExampleDescription(example.description));
     str += '\n\n';
     example.commands.forEach(function(command) {
-
       str += '`';
       command.forEach(function(textOrToken) {
         str += textOrToken.type === 'token' ? util.format('{{%s}}', textOrToken.content) : textOrToken.content;

package/lib/tldr-parser.js

@@ -117,7 +117,7 @@ case 15:
                 yy.error(_$[$0], 'TLDR007');
             
 break;
-case 18: case 24: case 25:
+case 18:
 this.$ = $$[$0];
 break;
 case 19:
@@ -135,6 +135,12 @@ break;
 case 23:
 this.$ = $$[$0-1];
 break;
+case 24:
+this.$ = [yy.createCommandText($$[$0])];
+break;
+case 25:
+this.$ = [yy.createToken($$[$0])];
+break;
 case 26:
 this.$ = [].concat($$[$0-1], yy.createCommandText($$[$0]));
 break;
@@ -701,7 +707,7 @@ case 7:
   if (this.topState() === "title") {
     yy_.yytext = this.matches[1];
     if (
-      /[^\w+\[\]{}!%,^~$:><|?. -]/.test(yy_.yytext) || 
+      /[^\w+\[\]{}\(\)!%,^~$:><|?. -]/.test(yy_.yytext) || 
       (yy_.yytext.endsWith('.') && yy_.yytext !== '.' && yy_.yytext !== ' .')
     ) {
       yy.error(yy_.yylloc, 'TLDR013');
@@ -744,6 +750,28 @@ case 8:
     if (punctuation.match(/[,;]/)) {
       console.warn(`Description ends in \'${punctuation}\'. Consider writing your sentence on one line.`);
     }
+    // Check for incorrect stdout/stdin/stderr/regex usage
+    var termMatch = yy_.yytext.match(/(?:^|[^`-\w])(stdout|stdin|stderr|regex|regular\s+expression|standard\s+(?:in|input|out|output|err|error))(?=[^`\w]|$)/i);
+    if (termMatch) {
+      // Skip if the term is inside angle brackets (URL)
+      var beforeTerm = yy_.yytext.substring(0, termMatch.index + termMatch[0].indexOf(termMatch[1]));
+      var afterTerm = yy_.yytext.substring(termMatch.index + termMatch[0].indexOf(termMatch[1]) + termMatch[1].length);
+      var insideUrl = (beforeTerm.lastIndexOf('<') > beforeTerm.lastIndexOf('>')) && (afterTerm.indexOf('>') < afterTerm.indexOf('<') || afterTerm.indexOf('<') === -1);
+      if (!insideUrl) {
+        var foundTerm = termMatch[1].toLowerCase();
+        var term = foundTerm;
+        // Map longer forms to shorter forms
+        if (foundTerm === 'regular expression') term = 'regex';
+        else if (foundTerm.match(/^standard (in|input)$/)) term = 'stdin';
+        else if (foundTerm.match(/^standard (out|output)$/)) term = 'stdout';
+        else if (foundTerm.match(/^standard (err|error)$/)) term = 'stderr';
+        yy.errors.push({
+          locinfo: yy_.yylloc,
+          code: 'TLDR112',
+          description: 'Term `' + termMatch[1] + '` should be lowercase and wrapped in backticks (`' + term + '`)'
+        });
+      }
+    }
     this.checkTrailingWhitespace(this.matches[3], yy_.yylloc);
     this.checkNewline(this.matches[4], yy_.yylloc);
     return 14;
@@ -767,6 +795,28 @@ case 9:
     if (yy_.yytext.match(/(^[A-Za-z]{3,}ing )|(^[A-Za-z]+[^usy]s )/)) {
       yy.error(yy_.yylloc, 'TLDR104');
     }
+    // Check for incorrect stdout/stdin/stderr/regex usage
+    var termMatch = yy_.yytext.match(/(?:^|[^`-\w])(stdout|stdin|stderr|regex|regular\s+expression|standard\s+(?:in|input|out|output|err|error))(?=[^`\w]|$)/i);
+    if (termMatch) {
+      // Skip if the term is inside angle brackets (URL)
+      var beforeTerm = yy_.yytext.substring(0, termMatch.index + termMatch[0].indexOf(termMatch[1]));
+      var afterTerm = yy_.yytext.substring(termMatch.index + termMatch[0].indexOf(termMatch[1]) + termMatch[1].length);
+      var insideUrl = (beforeTerm.lastIndexOf('<') > beforeTerm.lastIndexOf('>')) && (afterTerm.indexOf('>') < afterTerm.indexOf('<') || afterTerm.indexOf('<') === -1);
+      if (!insideUrl) {
+        var foundTerm = termMatch[1].toLowerCase();
+        var term = foundTerm;
+        // Map longer forms to shorter forms
+        if (foundTerm === 'regular expression') term = 'regex';
+        else if (foundTerm.match(/^standard (in|input)$/)) term = 'stdin';
+        else if (foundTerm.match(/^standard (out|output)$/)) term = 'stdout';
+        else if (foundTerm.match(/^standard (err|error)$/)) term = 'stderr';
+        yy.errors.push({
+          locinfo: yy_.yylloc,
+          code: 'TLDR112',
+          description: 'Term `' + termMatch[1] + '` should be lowercase and wrapped in backticks (`' + term + '`)'
+        });
+      }
+    }
     // Check if any sneaky spaces have been caught
     this.checkTrailingWhitespace(this.matches[3], yy_.yylloc);
     this.checkNewline(this.matches[3], yy_.yylloc);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tldr-lint",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "A linting tool to validate tldr pages",
   "repository": {
     "type": "git",
@@ -47,7 +47,7 @@
   "devDependencies": {
     "concurrently": "^9.1.2",
     "eslint": "^9.17.0",
-    "eslint-config-eslint": "^11.0.0",
+    "eslint-config-eslint": "^13.0.0",
     "eslint-plugin-jest": "^29.0.1",
     "husky": "^9.1.7",
     "jest": "^30.0.0",