tldr-lint 0.0.12 → 0.0.14

package/LICENSE.md

@@ -1,6 +1,8 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ruben Vereecken
+Copyright (c) 2016 Ruben Vereecken  
+Copyright (c) 2016-present The [tldr-pages team](https://github.com/orgs/tldr-pages/people)
+and [contributors](https://github.com/tldr-pages/tldr-lint/graphs/contributors)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -2,17 +2,24 @@
 
 [![npm version][npm-image]][npm-url]
 [![Build Status][github-actions-image]][github-actions-url]
-[![David DM Dependency Status][dep-image]][dep-url]
-[![Gitter chat][gitter-image]][gitter-url]
+[![Matrix chat][matrix-image]][matrix-url]
 
 `tldr-lint` is a linting tool for validating [tldr](https://github.com/tldr-pages/tldr) pages.
 It can also format your pages for you!
 
+## Installation
+
+`tldr-lint` and its alias `tldrl` can be installed via `npm`:
+
+```sh
+npm install --global tldr-lint
+```
+
 ## Usage
 
 It's really simple.
 
-```
+```txt
 Usage: tldr-lint [options] <file|dir>
 
 Options:
@@ -20,8 +27,10 @@ Options:
   -f, --format         also attempt formatting (to stdout, or as specified by -o)
   -o, --output <file>  output to formatted file
   -i, --in-place       formats in place
+  -t, --tabular        format errors in a tabular format
   -v, --verbose        print verbose output
-  -h, --help           output usage information
+  -I, --ignore <codes> ignore comma separated tldr-lint error codes (e.g. "TLDR001,TLDR0014")
+  -h, --help           display help for command
 ```
 
 ## Linter errors
@@ -58,18 +67,13 @@ TLDR106     | Page title should start with a hash (`#`)
 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
 
 [npm-url]: https://www.npmjs.com/package/tldr-lint
 [npm-image]: https://img.shields.io/npm/v/tldr-lint.svg
 
 [github-actions-url]: https://github.com/tldr-pages/tldr-lint/actions
-[github-actions-image]: https://img.shields.io/github/workflow/status/tldr-pages/tldr-lint/Tests/main.svg
-
-[dep-url]: https://david-dm.org/tldr-pages/tldr-lint
-[dep-image]: https://img.shields.io/david/tldr-pages/tldr-lint.svg
-
-[dev-dep-url]: https://david-dm.org/tldr-pages/tldr-lint#info=devDependencies
-[dev-dep-image]: https://img.shields.io/david/dev/tldr-pages/tldr-lint.svg
+[github-actions-image]: https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr-lint/test.yml?branch=main
 
-[gitter-url]: https://gitter.im/tldr-pages/tldr
-[gitter-image]: https://img.shields.io/gitter/room/tldr-pages/tldr.svg
+[matrix-url]: https://matrix.to/#/#tldr-pages:matrix.org
+[matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=chat+on+matrix

package/lib/tldr-lint-cli.js

@@ -1,18 +1,13 @@
 #!/usr/bin/env node
 
-var linter = require('./tldr-lint.js');
-var fs = require('fs');
-var path = require('path');
-var cli = module.exports;
-var util = require('util');
+const linter = require('./tldr-lint.js');
+const fs = require('fs');
+const path = require('path');
+const cli = module.exports;
+const util = require('util');
 
 cli.writeErrors = function(file, linterResult, args) {
-  var format;
-  if (args.tabular) {
-    format = '%s\t%s\t%s\t%s\t';
-  } else {
-    format = '%s:%s: %s %s';
-  }
+  const format = args.tabular ? '%s\t%s\t%s\t%s\t' : '%s:%s: %s %s';
   linterResult.errors.forEach(function(error) {
     console.error(util.format(format, file, (error.locinfo.first_line ||
                                             error.locinfo.last_line - 1),
@@ -22,8 +17,8 @@ cli.writeErrors = function(file, linterResult, args) {
     if (!linterResult.success) {
       console.error('Refraining from formatting because of fatal error');
     } else {
-      var formattedPage = linterResult.formatted;
-      var err;
+      const formattedPage = linterResult.formatted;
+      let err;
       if (args.output) {
         err = fs.writeFileSync(args.output, formattedPage, 'utf8');
         if (err) throw err;
@@ -38,15 +33,15 @@ cli.writeErrors = function(file, linterResult, args) {
 };
 
 cli.processFile = function(file, args) {
-  var linterResult = linter.processFile(file, args.verbose, args.format, args.ignore);
+  const linterResult = linter.processFile(file, args.verbose, args.format, args.ignore);
   cli.writeErrors(file, linterResult, args);
   return linterResult;
 };
 
 cli.processDirectory = function(dir, args) {
-  var files = fs.readdirSync(dir);
-  var stats;
-  var result = {
+  const files = fs.readdirSync(dir);
+  let stats;
+  const result = {
     success: true,
     errors: []
   };
@@ -61,11 +56,11 @@ cli.processDirectory = function(dir, args) {
     if (stats.isFile()) {
       // Only treat files ending in .md
       if (!file.match(/\.md$/)) return;
-      var linterResult = cli.processFile(file, args);
+      const linterResult = cli.processFile(file, args);
       result.success &= linterResult.success;
       result.errors = result.errors.concat(linterResult.errors);
     } else {
-      var aggregateResult = cli.processDirectory(file, args);
+      const aggregateResult = cli.processDirectory(file, args);
       result.success &= aggregateResult.success;
       result.errors = result.errors.concat(aggregateResult.errors);
     }
@@ -78,28 +73,24 @@ cli.process = function(file, args) {
     console.error('--output only makes sense when used with --format');
     process.exit(1);
   }
+  let stats;
   try {
-    var stats = fs.statSync(file);
+    stats = fs.statSync(file);
   } catch(err) {
     console.error(err.toString());
     process.exit(1);
   }
-  var isdir = stats.isDirectory();
+  const isdir = stats.isDirectory();
   if (args.output && isdir) {
     console.error('--output only makes sense when used with a file');
   }
-  var result;
-  if (!isdir) {
-    result = cli.processFile(file, args);
-  } else {
-    result = cli.processDirectory(file, args);
-  }
+  const result = isdir ? cli.processDirectory(file, args) : cli.processFile(file, args);
   if (!result.success || result.errors.length >= 1) return process.exit(1);
 };
 
 if (require.main === module) {
-  var program = require('commander');
-  var package = require('../package.json');
+  const { program } = require('commander');
+  const package = require('../package.json');
   program
     .version(package.version)
     .description(package.description)
@@ -109,7 +100,7 @@ if (require.main === module) {
     .option('-i, --in-place', 'formats in place')
     .option('-t, --tabular', 'format errors in a tabular format')
     .option('-v, --verbose', 'print verbose output')
-    .option('-i, --ignore <codes>', 'ignore comma separated tldr-lint error codes (e.g. "TLDR001,TLDR0014")')
+    .option('-I, --ignore <codes>', 'ignore comma separated tldr-lint error codes (e.g. "TLDR001,TLDR0014")')
     .parse(process.argv);
 
   if (program.args.length !== 1) {

package/lib/tldr-lint.js

@@ -1,7 +1,7 @@
-var fs = require('fs');
-var path = require('path');
-var parser = require('./tldr-parser.js').parser;
-var util = require('util');
+const fs = require('fs');
+const path = require('path');
+const parser = require('./tldr-parser.js').parser;
+const util = require('util');
 
 const MAX_EXAMPLES = 8;
 
@@ -35,6 +35,7 @@ module.exports.ERRORS = parser.ERRORS = {
   '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',
 };
 
 (function(parser) {
@@ -117,7 +118,7 @@ module.exports.ERRORS = parser.ERRORS = {
   };
 })(parser);
 
-var linter = module.exports;
+const linter = module.exports;
 
 linter.parse = function(page) {
   parser.init();
@@ -135,7 +136,7 @@ linter.formatExampleDescription = function(str) {
 };
 
 linter.format = function(parsedPage) {
-  var str = '';
+  let str = '';
   str += util.format('# %s', parsedPage.title);
   str += '\n\n';
   parsedPage.description.forEach(function(line) {
@@ -163,7 +164,7 @@ linter.format = function(parsedPage) {
 };
 
 linter.process = function(file, page, verbose, alsoFormat) {
-  var success, result;
+  let success, result;
   try {
     linter.parse(page);
     success = true;
@@ -195,7 +196,7 @@ linter.process = function(file, page, verbose, alsoFormat) {
 };
 
 linter.processFile = function(file, verbose, alsoFormat, ignoreErrors) {
-  var result = linter.process(file, fs.readFileSync(file, 'utf8'), verbose, alsoFormat);
+  const result = linter.process(file, fs.readFileSync(file, 'utf8'), verbose, alsoFormat);
   if (path.extname(file) !== '.md') {
     result.errors.push({ locinfo: { first_line: '0' }, code: 'TLDR107', description: this.ERRORS.TLDR107 });
   }

package/lib/tldr-parser.js

@@ -77,7 +77,7 @@ var parser = {trace: function trace () { },
 yy: {},
 symbols_: {"error":2,"page":3,"title":4,"NEWLINE":5,"info":6,"examples":7,"TEXT":8,"HASH":9,"TITLE":10,"description":11,"information_link":12,"GREATER_THAN":13,"DESCRIPTION_LINE":14,"INFORMATION_LINK":15,"ANGLE_BRACKETED_URL":16,"END_INFORMATION_LINK_URL":17,"END_INFORMATION_LINK":18,"example":19,"maybe_newline":20,"example_description":21,"example_commands":22,"DASH":23,"EXAMPLE_DESCRIPTION":24,"example_command":25,"BACKTICK":26,"example_command_inner":27,"COMMAND_TEXT":28,"COMMAND_TOKEN":29,"$accept":0,"$end":1},
 terminals_: {2:"error",5:"NEWLINE",8:"TEXT",9:"HASH",10:"TITLE",13:"GREATER_THAN",14:"DESCRIPTION_LINE",15:"INFORMATION_LINK",16:"ANGLE_BRACKETED_URL",17:"END_INFORMATION_LINK_URL",18:"END_INFORMATION_LINK",23:"DASH",24:"EXAMPLE_DESCRIPTION",26:"BACKTICK",28:"COMMAND_TEXT",29:"COMMAND_TOKEN"},
-productions_: [0,[3,4],[3,3],[3,4],[4,2],[4,1],[6,1],[6,2],[11,2],[11,3],[12,4],[12,3],[12,5],[7,0],[7,2],[19,4],[20,0],[20,1],[21,2],[21,1],[22,1],[22,2],[25,3],[27,0],[27,2],[27,2]],
+productions_: [0,[3,4],[3,3],[3,4],[4,2],[4,1],[6,1],[6,2],[11,2],[11,3],[12,4],[12,3],[12,5],[7,0],[7,2],[19,4],[20,0],[20,1],[21,2],[21,1],[22,1],[22,2],[25,2],[25,3],[27,1],[27,1],[27,2],[27,2]],
 performAction: function anonymous(yytext, yyleng, yylineno, yy, yystate /* action[1] */, $$ /* vstack */, _$ /* lstack */) {
 /* this == yyval */
 
@@ -117,7 +117,7 @@ case 15:
                 yy.error(_$[$0], 'TLDR007');
             
 break;
-case 18:
+case 18: case 24: case 25:
 this.$ = $$[$0];
 break;
 case 19:
@@ -130,20 +130,20 @@ case 21:
 this.$ = yy.error(_$[$0], 'TLDR105') || $$[$0-1];
 break;
 case 22:
-this.$ = $$[$0-1];
+this.$ = yy.error(this._$, 'TLDR110');
 break;
 case 23:
-this.$ = [];
+this.$ = $$[$0-1];
 break;
-case 24:
+case 26:
 this.$ = [].concat($$[$0-1], yy.createCommandText($$[$0]));
 break;
-case 25:
+case 27:
 this.$ = [].concat($$[$0-1], yy.createToken($$[$0]));
 break;
 }
 },
-table: [{3:1,4:2,8:[1,4],9:[1,3]},{1:[3]},{5:[1,5],6:6,11:7,13:$V0},{10:[1,9]},o($V1,[2,5]),{6:10,8:[1,11],11:7,13:$V0},o($V2,$V3,{7:12}),o($V2,[2,6],{12:13,13:[1,14]}),{14:[1,15]},o($V1,[2,4]),o($V2,$V3,{7:16}),o($V2,$V3,{7:17}),o($V4,$V5,{19:18,20:19,1:[2,2],5:$V6}),o($V2,[2,7],{13:[1,21]}),{14:[1,22],15:[1,23]},o($V7,[2,8]),o($V4,$V5,{19:18,20:19,1:[2,1],5:$V6}),o($V4,$V5,{19:18,20:19,1:[2,3],5:$V6}),o($V2,[2,14]),{8:[1,26],21:24,23:[1,25]},o([8,23,26],[2,17]),{15:[1,27]},o($V7,[2,9]),{16:[1,28],18:[1,29]},{5:$V6,20:30,26:$V5},{24:[1,31]},o($V8,[2,19]),{16:[1,32]},{17:[1,33]},o($V7,[2,11]),{22:34,25:35,26:$V9},o($V8,[2,18]),{17:[1,37]},o($V7,[2,10]),o($V2,[2,15],{25:38,26:$V9}),o($Va,[2,20]),o($Vb,[2,23],{27:39}),o($V7,[2,12]),o($Va,[2,21]),{26:[1,40],28:[1,41],29:[1,42]},o($Va,[2,22]),o($Vb,[2,24]),o($Vb,[2,25])],
+table: [{3:1,4:2,8:[1,4],9:[1,3]},{1:[3]},{5:[1,5],6:6,11:7,13:$V0},{10:[1,9]},o($V1,[2,5]),{6:10,8:[1,11],11:7,13:$V0},o($V2,$V3,{7:12}),o($V2,[2,6],{12:13,13:[1,14]}),{14:[1,15]},o($V1,[2,4]),o($V2,$V3,{7:16}),o($V2,$V3,{7:17}),o($V4,$V5,{19:18,20:19,1:[2,2],5:$V6}),o($V2,[2,7],{13:[1,21]}),{14:[1,22],15:[1,23]},o($V7,[2,8]),o($V4,$V5,{19:18,20:19,1:[2,1],5:$V6}),o($V4,$V5,{19:18,20:19,1:[2,3],5:$V6}),o($V2,[2,14]),{8:[1,26],21:24,23:[1,25]},o([8,23,26],[2,17]),{15:[1,27]},o($V7,[2,9]),{16:[1,28],18:[1,29]},{5:$V6,20:30,26:$V5},{24:[1,31]},o($V8,[2,19]),{16:[1,32]},{17:[1,33]},o($V7,[2,11]),{22:34,25:35,26:$V9},o($V8,[2,18]),{17:[1,37]},o($V7,[2,10]),o($V2,[2,15],{25:38,26:$V9}),o($Va,[2,20]),{26:[1,39],27:40,28:[1,41],29:[1,42]},o($V7,[2,12]),o($Va,[2,21]),o($Va,[2,22]),{26:[1,43],28:[1,44],29:[1,45]},o($Vb,[2,24]),o($Vb,[2,25]),o($Va,[2,23]),o($Vb,[2,26]),o($Vb,[2,27])],
 defaultActions: {},
 parseError: function parseError (str, hash) {
     if (hash.recoverable) {
@@ -725,7 +725,8 @@ case 8:
   if (this.topState() === 'description') {
     this.popState();
     yy_.yytext = this.matches[1];
-    if (yy_.yytext.match(/^[a-z]/)) {
+    var exceptions = ['npm', 'pnpm'];
+    if (!exceptions.includes(yy_.yytext.replace(/ .*/,'')) && yy_.yytext.match(/^[a-z]/)) {
       yy.error(yy_.yylloc, 'TLDR003');
     }
     var punctuation = this.matches[2];
@@ -733,7 +734,7 @@ case 8:
       yy.error(yy_.yylloc, 'TLDR004');
     }
     if (punctuation.match(/[,;]/)) {
-      console.warn('Description ends in\'', punctuation, '\'. Consider writing your sentence on one line.');
+      console.warn(`Description ends in \'${punctuation}\'. Consider writing your sentence on one line.`);
     }
     this.checkTrailingWhitespace(this.matches[3], yy_.yylloc);
     this.checkNewline(this.matches[4], yy_.yylloc);

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "tldr-lint",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "A linting tool to validate tldr pages",
   "repository": "tldr-pages/tldr-lint",
   "scripts": {
     "jison": "jison tldr.yy tldr.l -o lib/tldr-parser.js",
     "lint": "eslint lib specs",
-    "prepare": "husky install",
-    "test": "jasmine --config=jasmine.json --reporter=jasmine-console-reporter",
+    "prepare": "husky",
+    "test": "jest specs",
     "watch": "concurrently 'npm run watch:jison' 'npm run watch:specs'",
     "watch:jison": "onchange '*.l' '*.yy' -- npm run jison",
     "watch:specs": "onchange 'specs/*.js' 'lib/*.js' '*.l' '*.yy' -- npm run test"
@@ -27,19 +27,31 @@
     "name": "Ruben Vereecken",
     "email": "rubenvereecken@gmail.com"
   },
+  "maintainers": [
+    {
+      "name": "tldr-pages team"
+    }
+  ],
+  "engines": {
+    "node": ">=18"
+  },
   "license": "MIT",
   "dependencies": {
-    "commander": "^8.1.0"
+    "commander": "^12.0.0"
   },
   "devDependencies": {
-    "concurrently": "^6.0.0",
-    "eslint": "^7.20.0",
-    "husky": "^7.0.1",
-    "jasmine": "^3.6.4",
-    "jasmine-console-reporter": "^3.1.0",
+    "concurrently": "^8.0.1",
+    "eslint": "^8.0.0",
+    "eslint-plugin-jest": "^27.0.4",
+    "husky": "^9.0.6",
+    "jest": "^29.1.2",
     "jison": "^0.4.18",
     "onchange": "^7.1.0"
   },
+  "funding": {
+    "type": "liberapay",
+    "url": "https://liberapay.com/tldr-pages"
+  },
   "files": [
     "lib/"
   ]