tldr-lint 0.0.14 → 0.0.16

package/README.md

@@ -33,6 +33,26 @@ Options:
   -h, --help           display help for command
 ```
 
+### Usage via Docker
+
+We provide a Dockerfile for reproducibly building and testing `tldr-lint` even without having NodeJS installed.
+
+For building the Docker image, run this command inside the cloned `tldr-lint` repository:
+
+`docker build -t tldr-lint .`
+
+For running a `tldr-lint` container, you need to mount a volume containing the page(s) you want to lint to the container.
+For checking a single page, run (replacing `{{/path/to/page.md}}` with the path to the page you want to check):
+
+`docker run --rm -v {{/path/to/page.md}}:/app/page.md tldr-lint page.md`
+
+In order to run the container on a directory, mount this directory as follows:
+
+`docker run --rm -v {{/path/to/directory}}:/app/pages tldr-lint pages/`
+
+> [!NOTE]
+> For Windows users, specify the full path to the directory or page you want to check along with the `docker run` command above.
+
 ## Linter errors
 
 All of the errors can be found in [`lib/tldr-lint.js`](./lib/tldr-lint.js).
@@ -58,6 +78,8 @@ TLDR016     | Label for information link should be spelled exactly `More informa
 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
+TLDR020     | Label for additional notes should be spelled exactly `Note:` (with a succeeding whitespace)
+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
@@ -68,6 +90,7 @@ TLDR107     | File name should end with `.md` extension
 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
 
 [npm-url]: https://www.npmjs.com/package/tldr-lint
 [npm-image]: https://img.shields.io/npm/v/tldr-lint.svg

package/lib/tldr-lint-cli.js

@@ -90,10 +90,10 @@ cli.process = function(file, args) {
 
 if (require.main === module) {
   const { program } = require('commander');
-  const package = require('../package.json');
+  const pkg = require('../package.json');
   program
-    .version(package.version)
-    .description(package.description)
+    .version(pkg.version)
+    .description(pkg.description)
     .arguments('<file|dir>')
     .option('-f, --format', 'also attempt formatting (to stdout, or as specified by -o)')
     .option('-o, --output <file>', 'output to formatted file')

package/lib/tldr-lint.js

@@ -25,6 +25,9 @@ module.exports.ERRORS = parser.ERRORS = {
   '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',
+  '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',
@@ -36,6 +39,7 @@ 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'
 };
 
 (function(parser) {
@@ -209,6 +213,10 @@ linter.processFile = function(file, verbose, alsoFormat, ignoreErrors) {
     result.errors.push({ locinfo: { first_line: '0' }, code: 'TLDR109', description: this.ERRORS.TLDR109 });
   }
 
+  if (/[<>:"/\\|?*]/.test(path.basename(file))) {
+    result.errors.push({ locinfo: { first_line: '0' }, code: 'TLDR111', description: this.ERRORS.TLDR111 });
+  }
+
   if (ignoreErrors) {
     ignoreErrors = ignoreErrors.split(',').map(function(val) {
       return val.trim();

package/lib/tldr-parser.js

@@ -729,6 +729,9 @@ case 8:
     if (!exceptions.includes(yy_.yytext.replace(/ .*/,'')) && yy_.yytext.match(/^[a-z]/)) {
       yy.error(yy_.yylloc, 'TLDR003');
     }
+    if (yy_.yytext.match(/(note|NOTE): /)) {
+      yy.error(yy_.yylloc, 'TLDR020');
+    }
     var punctuation = this.matches[2];
     if (punctuation !== '.') {
       yy.error(yy_.yylloc, 'TLDR004');
@@ -750,6 +753,9 @@ case 9:
     yy_.yytext = this.matches[1];
     if (!yy_.yytext.match(/^[\p{Lu}\[]/u)) yy.error(yy_.yylloc, 'TLDR015');
     if (this.matches[2] !== ':') yy.error(yy_.yylloc, 'TLDR005');
+    if (yy_.yytext.match(/(note|NOTE): /)) {
+      yy.error(yy_.yylloc, 'TLDR020');
+    }
     // Try to ensure that verbs at the beginning of the description are in the infinitive tense
     // 1. Any word at the start of a sentence that ends with "ing" and is 6 or more characters long (e.g. executing, writing) is likely a verb in the gerund
     // 2. Any word at the start of a sentence that doesn't end with "us", "ss", or "ys" (e.g. superfluous, success, always) is likely a verb in the present tense
@@ -777,6 +783,9 @@ case 10:
 break;
 case 11:
   this.pushState('example_command');
+  if (this.matches[1].match(/ /)) {
+    yy.error(yy_.yylloc, 'TLDR021')
+  }
   return 26;
 
 break;
@@ -807,6 +816,9 @@ case 14:
     if (this.matches[2].match(/ /)) {
       yy.error(yy_.yylloc, 'TLDR014');
     }
+    if (this.matches[1].endsWith(' ') && !this.matches[1].endsWith('\\ ')) {
+      yy.error(yy_.yylloc, 'TLDR021');
+    }
     // Don't swallow the trailing backtick just yet
     if (this.matches[2].match(/\`/)) this.unput('`');
     else {
@@ -841,7 +853,7 @@ case 17:
 break;
 }
 },
-rules: [/^(?:\s+$)/,/^(?:.*?\t+.*)/,/^(?:[^\n]$)/,/^(?:(\s*)#(\s*))/,/^(?:([\>-])(\s*))/,/^(?:([Mm]ore\s+[Ii]nfo(?:rmation)?:?\s*))/,/^(?:(<https?:\/\/[^\s\>]*>))/,/^(?:(.+?)([ ]*)((?:\r\n)|\n|\r))/,/^(?:(.+?)([\.,;!\?]?)([ ]*)((?:\r\n)|\n|\r))/,/^(?:(.+?)([\.:,;]?)([ ]*)((?:\r\n)|\n|\r))/,/^(?:`((?:\r\n)|\n|\r))/,/^(?:`)/,/^(?:\{\{([^\n\`\{\}]*)\}\}(((?:\r\n)|\n|\r)?))/,/^(?:([^\`\n]+?)\{\{)/,/^(?:([^\`\n]+?)(`[ ]*|[ ]*((?:\r\n)|\n|\r)))/,/^(?:[ ]+)/,/^(?:((?:\r\n)|\n|\r)+)/,/^(?:(.+?)[\.:]?((?:\r\n)|\n|\r))/],
+rules: [/^(?:\s+$)/,/^(?:.*?\t+.*)/,/^(?:[^\n]$)/,/^(?:(\s*)#(\s*))/,/^(?:([\>-])(\s*))/,/^(?:([Mm]ore\s+[Ii]nfo(?:rmation)?:?\s*))/,/^(?:(<https?:\/\/[^\s\>]*>))/,/^(?:(.+?)([ ]*)((?:\r\n)|\n|\r))/,/^(?:(.+?)([\.,;!\?]?)([ ]*)((?:\r\n)|\n|\r))/,/^(?:(.+?)([\.:,;]?)([ ]*)((?:\r\n)|\n|\r))/,/^(?:`((?:\r\n)|\n|\r))/,/^(?:`([ ]*))/,/^(?:\{\{([^\n\`\{\}]*)\}\}(((?:\r\n)|\n|\r)?))/,/^(?:([^\`\n]+?)\{\{)/,/^(?:([^\`\n]+?)(`[ ]*|[ ]*((?:\r\n)|\n|\r)))/,/^(?:[ ]+)/,/^(?:((?:\r\n)|\n|\r)+)/,/^(?:(.+?)[\.:]?((?:\r\n)|\n|\r))/],
 conditions: {"INITIAL":{"rules":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17],"inclusive":true}}
 });
 return lexer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tldr-lint",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "A linting tool to validate tldr pages",
   "repository": "tldr-pages/tldr-lint",
   "scripts": {
@@ -40,9 +40,10 @@
     "commander": "^12.0.0"
   },
   "devDependencies": {
-    "concurrently": "^8.0.1",
-    "eslint": "^8.0.0",
-    "eslint-plugin-jest": "^27.0.4",
+    "concurrently": "^9.0.0",
+    "eslint": "^9.4.0",
+    "eslint-config-eslint": "^11.0.0",
+    "eslint-plugin-jest": "^28.5.0",
     "husky": "^9.0.6",
     "jest": "^29.1.2",
     "jison": "^0.4.18",