tldr-lint 0.0.21 → 0.0.23

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,7 +91,8 @@ 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
+TLDR112     | Terms `stdin`, `stdout`, `stderr`, `regex`, and `glob` (including longer forms like "standard input", "regular expression", "glob pattern") should be lowercase and wrapped in backticks
+TLDR113     | Translated line must not be identical to English line (only lines starting with `>` and `-` are checked)
 
 [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

@@ -4,6 +4,8 @@ const parser = require('./tldr-parser.js').parser;
 const util = require('util');
 
 const MAX_EXAMPLES = 8;
+const MIN_WORDS_PER_LINE = 2;
+const ALLOWED_LOWERCASE_WORDS = ['macOS'];
 
 module.exports.ERRORS = parser.ERRORS = {
   'TLDR001': 'File should contain no leading whitespace',
@@ -28,7 +30,6 @@ module.exports.ERRORS = parser.ERRORS = {
   'TLDR020': 'Label for additional notes should be spelled exactly `Note: `',
   'TLDR021': 'Command example should not begin or end in whitespace',
 
-
   'TLDR101': 'Command description probably not properly annotated',
   'TLDR102': 'Example description probably not properly annotated',
   'TLDR103': 'Command example is missing its closing backtick',
@@ -40,7 +41,8 @@ module.exports.ERRORS = parser.ERRORS = {
   '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` should be lowercase and wrapped in backticks'
+  'TLDR112': 'Terms `stdin`, `stdout`, `stderr`, `regex`, and `glob` should be lowercase and wrapped in backticks',
+  'TLDR113': 'Translated line must not be identical to English line'
 };
 
 (function(parser) {
@@ -217,6 +219,38 @@ linter.processFile = function(file, verbose, alsoFormat, ignoreErrors) {
     result.errors.push({ locinfo: { first_line: '0' }, code: 'TLDR111', description: this.ERRORS.TLDR111 });
   }
 
+  const parts = file.split(path.sep);
+  const pagesIdx = parts.findIndex(seg => seg && seg.indexOf('pages.') === 0 && seg.length > 6);
+  if (pagesIdx !== -1 && parts[pagesIdx].slice(6) !== 'en') {
+    const englishParts = parts.slice();
+    englishParts[pagesIdx] = 'pages';
+    const englishPath = englishParts.join(path.sep);
+    if (fs.existsSync(englishPath)) {
+      const englishLines = fs.readFileSync(englishPath, 'utf8').split(/\r?\n/).map(l => l.trim());
+      const englishSet = new Set(englishLines);
+      const translatedLines = fs.readFileSync(file, 'utf8').split(/\r?\n/).map(l => l.trim());
+      translatedLines.forEach(function(line, idx) {
+        if (!line.match(/^[>-]/)) return;
+        if (!englishSet.has(line)) return;
+
+        const content = line.replace(/^[>-]\s/, '').trim();
+        const words = content.split(/\s/).filter(w => w.length > 0);
+        if (!(words.length > MIN_WORDS_PER_LINE)) return;
+
+        const everyWordCapitalized = words.length > 0 && words.every(word => {
+          const stripped = word.replace(/[()]/g, '');
+          if (!/[a-zA-Z]/.test(stripped)) return true;
+          if (ALLOWED_LOWERCASE_WORDS.includes(stripped.replace(/\W+$/, ''))) return true;
+
+          return /^[A-Z]/.test(stripped);
+        });
+        if (!everyWordCapitalized) {
+          result.errors.push({ locinfo: { first_line: (idx+1).toString() }, code: 'TLDR113', description: this.ERRORS.TLDR113 });
+        }
+      }, this);
+    }
+  }
+
   if (ignoreErrors) {
     ignoreErrors = ignoreErrors.split(',').map(function(val) {
       return val.trim();

package/lib/tldr-parser.js

@@ -707,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');
@@ -751,7 +751,7 @@ case 8:
       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);
+    var termMatch = yy_.yytext.match(/(?:^|[^`-\w])(stdout|stdin|stderr|regex|regular\s+expression|standard\s+(?:in|input|out|output|err|error)|glob(?:\s+pattern)?)(?=[^`\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]));
@@ -765,6 +765,7 @@ case 8:
         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';
+        else if (foundTerm === 'glob pattern') term = 'glob';
         yy.errors.push({
           locinfo: yy_.yylloc,
           code: 'TLDR112',
@@ -796,7 +797,7 @@ case 9:
       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);
+    var termMatch = yy_.yytext.match(/(?:^|[^`-\w])(stdout|stdin|stderr|regex|regular\s+expression|standard\s+(?:in|input|out|output|err|error)|glob(?:\s+pattern)?)(?=[^`\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]));
@@ -810,6 +811,7 @@ case 9:
         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';
+        else if (foundTerm === 'glob pattern') term = 'glob';
         yy.errors.push({
           locinfo: yy_.yylloc,
           code: 'TLDR112',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tldr-lint",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "description": "A linting tool to validate tldr pages",
   "repository": {
     "type": "git",
@@ -42,12 +42,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "commander": "^14.0.0"
+    "commander": "^15.0.0"
   },
   "devDependencies": {
-    "concurrently": "^9.1.2",
-    "eslint": "^9.17.0",
-    "eslint-config-eslint": "^13.0.0",
+    "concurrently": "^10.0.1",
+    "eslint": "^10.1.0",
+    "eslint-config-eslint": "^14.0.0",
     "eslint-plugin-jest": "^29.0.1",
     "husky": "^9.1.7",
     "jest": "^30.0.0",