Add even more special characters as allowed title (#414)

Author: sebastiaanspeck

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com).
 
+## [v0.0.20](https://github.com/tldr-pages/tldr-lint/compare/v0.0.19...v0.0.20)
+
+### Added
+
+- Add `:`, `>`, `<`, `|`, and `?` as allowed characters in page titles ([#414](https://github.com/tldr-pages/tldr-lint/pull/414))
+
+### Changed
+
+- Make TLDR013 more descriptive since we also allow specific characters ([#414](https://github.com/tldr-pages/tldr-lint/pull/414))
+
 ## [v0.0.19 - 2025-06-10](https://github.com/tldr-pages/tldr-lint/compare/v0.0.18...v0.0.19)
 
 ### Added

lib/tldr-lint.js

@@ -18,7 +18,7 @@ module.exports.ERRORS = parser.ERRORS = {
   '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: `',

lib/tldr-parser.js

@@ -0,0 +1,12 @@
+# :
+
+> Returns a successful exit status code of 0.
+> More information: <https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#colon>.
+
+- Return a successful exit code:
+
+`:`
+
+- Make a command always exit with 0:
+
+`{{command}} || :`

package-lock.json

@@ -0,0 +1,28 @@
+# >
+
+> Redirect output.
+> More information: <https://gnu.org/software/bash/manual/bash.html#Redirecting-Output>.
+
+- Redirect `stdout` to a file:
+
+`{{command}} > {{path/to/file}}`
+
+- Append to a file:
+
+`{{command}} >> {{path/to/file}}`
+
+- Redirect both `stdout` and `stderr` to a file:
+
+`{{command}} &> {{path/to/file}}`
+
+- Redirect `stderr` to `/dev/null` to keep the terminal output clean:
+
+`{{command}} 2> /dev/null`
+
+- Clear the file contents or create a new empty file:
+
+`> {{path/to/file}}`
+
+- Redirect `stderr` to `stdout` for piping them together:
+
+`{{command1}} 2>&1 | {{command2}}`

specs/pages/passing/colon.md

@@ -0,0 +1,32 @@
+# <
+
+> Redirect data to `stdin`.
+> More information: <https://gnu.org/software/bash/manual/bash.html#Redirecting-Input>.
+
+- Redirect a file to `stdin` (achieves the same effect as `cat file.txt |`):
+
+`{{command}} < {{path/to/file.txt}}`
+
+- Create a here document and pass that into `stdin` (requires a multiline command):
+
+`{{command}} << {{EOF}} <Enter> {{multiline_text}} <Enter> {{EOF}}`
+
+- Create a here string and pass that into `stdin` (achieves the same effect as `echo string |`):
+
+`{{command}} <<< {{string}}`
+
+- Process data from a file and write the output to another file:
+
+`{{command}} < {{path/to/file.txt}} > {{path/to/file2.txt}}`
+
+- Write a here document into a file:
+
+`cat << {{EOF}} > {{path/to/file.txt}} <Enter> {{multiline_data}} <Enter> {{EOF}}`
+
+- Disregard leading tabs (good for scripts with indentation but does not work for spaces):
+
+`cat <<- {{EOF}} > {{path/to/file.txt}} <Enter> {{multiline_data}} <Enter> {{EOF}}`
+
+- Pass command output to a program as a file descriptor:
+
+`diff <({{command1}}) <({{command2}})`

specs/pages/passing/greater-than.md

@@ -0,0 +1,16 @@
+# ?
+
+> Get context sensitive.
+> More information: <https://www.cisco.com/c/en/us/td/docs/ios-xml/ios/fundamentals/configuration/15mt/fundamentals-15-mt-book/cf-cli-basics.html#GUID-223128D2-FB6D-418D-86C6-06D1D0DA51B3>.
+
+- Get available commands:
+
+`?`
+
+- Get storages that are listable:
+
+`dir ?`
+
+- Show what IP information is viewable:
+
+`ip show ?`

specs/pages/passing/less-than.md

@@ -0,0 +1,12 @@
+# |
+
+> Pipe data between programs.
+> More information: <https://gnu.org/software/bash/manual/bash.html#Pipelines>.
+
+- Pipe `stdout` to `stdin`:
+
+`{{command}} | {{command}}`
+
+- Pipe both `stdout` and `stderr` to `stdin`:
+
+`{{command}} |& {{command}}`

specs/pages/passing/question-mark.md

@@ -225,6 +225,20 @@ describe('TLDR pages that are simply correct', function() {
     });
   });
 
+  const validTitleCharacters = [
+    [':', 'colon'],
+    ['>', 'greater-than'],
+    ['<', 'less-than'],
+    ['|', 'vertical-bar'],
+    ['?', 'question-mark']
+  ];
+  validTitleCharacters.forEach(([symbol, name]) => {
+    it(`Page title includes '${symbol}' symbol`, function() {
+      let errors = lintFile(`pages/passing/${name}.md`).errors;
+      expect(errors.length).toBe(0);
+    });
+  });
+
   it('Certain words are always written in lower case', function() {
     let errors = lintFile('pages/passing/lower-case.md').errors;
     expect(errors.length).toBe(0);