tldr-lint 0.0.15 → 0.0.17

package/README.md

@@ -90,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

@@ -39,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) {
@@ -212,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

@@ -700,7 +700,7 @@ break;
 case 7:
   if (this.topState() === "title") {
     yy_.yytext = this.matches[1];
-    if (this.matches[1].match(/([^\w+\[. -])|(\.$)/)) yy.error(yy_.yylloc, 'TLDR013');
+    if (this.matches[1].match(/([^\w+\[\]}. -])|(\.$)/)) yy.error(yy_.yylloc, 'TLDR013');
     this.checkTrailingWhitespace(this.matches[2], yy_.yylloc);
     this.checkNewline(this.matches[3], yy_.yylloc);
     this.popState();
@@ -882,4 +882,4 @@ exports.main = function commonjsMain (args) {
 if (typeof module !== 'undefined' && require.main === module) {
   exports.main(process.argv.slice(1));
 }
-}
+}

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "tldr-lint",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "A linting tool to validate tldr pages",
-  "repository": "tldr-pages/tldr-lint",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tldr-pages/tldr-lint.git"
+  },
   "scripts": {
     "jison": "jison tldr.yy tldr.l -o lib/tldr-parser.js",
     "lint": "eslint lib specs",
@@ -37,14 +40,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "commander": "^12.0.0"
+    "commander": "^13.0.0"
   },
   "devDependencies": {
-    "concurrently": "^8.0.1",
-    "eslint": "^8.0.0",
-    "eslint-plugin-jest": "^27.0.4",
-    "husky": "^9.0.6",
-    "jest": "^29.1.2",
+    "concurrently": "^9.1.2",
+    "eslint": "^9.17.0",
+    "eslint-config-eslint": "^11.0.0",
+    "eslint-plugin-jest": "^28.10.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
     "jison": "^0.4.18",
     "onchange": "^7.1.0"
   },