Add check for Windows-forbidden characters in the filename (#353)

Author: sebastiaanspeck

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com).
 
+## Unreleased
+
+- Add rule `TLDR111` ([#353](https://github.com/tldr-pages/tldr-lint/pull/353))
+
 ## [v0.0.15 - 2024-04-03](https://github.com/tldr-pages/tldr-lint/compare/v0.0.14...v0.0.15)
 
 - Add rule `TLDR020` ([#308](https://github.com/tldr-pages/tldr-lint/pull/308))

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

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();

specs/pages/failing/111.md

@@ -0,0 +1,7 @@
+# jar
+
+> JAR (Java Archive) is a package file format.
+
+- Unzip file to the current directory:
+
+`jar -xvf *.jar`

specs/tldr-lint.spec.js

@@ -1,3 +1,4 @@
+const path = require('path');
 const linter = require('../lib/tldr-lint.js');
 const { lintFile, containsErrors, containsOnlyErrors } = require('./tldr-lint-helper');
 
@@ -183,6 +184,21 @@ describe('Common TLDR formatting errors', function() {
     expect(containsOnlyErrors(errors, 'TLDR110')).toBeTruthy();
     expect(errors.length).toBe(1);
   });
+
+  const invalidCharacters = ['<', '>', ':', '"', '/', '\\', '|', '?', '*'];
+  invalidCharacters.forEach((char) => {
+    it('TLDR111\t' + linter.ERRORS.TLDR111 + '\t - ${char}', function() {
+      const basenameSpy = jest.spyOn(path, 'basename').mockImplementation((filePath) => {
+        return `111${char}`;
+      });
+
+      let errors = lintFile(`pages/failing/111.md`).errors;
+      expect(containsOnlyErrors(errors, 'TLDR111')).toBeTruthy();
+      expect(errors.length).toBe(1);
+
+      basenameSpy.mockRestore();
+    });
+  });
 });
 
 describe('TLDR pages that are simply correct', function() {