feat: add check that command is not empty (#306)

This adds `TLDR110` which checks whether command examples are empty. --------- Co-authored-by: Owen Voke <[email protected]>
tldr-pages · Mar 20, 2024 · c336197 · c336197
1 parent 52dcb00
commit c336197
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -67,6 +67,7 @@ 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

diff --git a/lib/tldr-lint-cli.js b/lib/tldr-lint-cli.js
@@ -89,7 +89,7 @@ cli.process = function(file, args) {
 };
 
 if (require.main === module) {
-  const program = require('commander');
+  const { program } = require('commander');
   const package = require('../package.json');
   program
     .version(package.version)

diff --git a/lib/tldr-lint.js b/lib/tldr-lint.js
@@ -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) {

diff --git a/lib/tldr-parser.js b/lib/tldr-parser.js
diff --git a/specs/pages/failing/110.md b/specs/pages/failing/110.md
@@ -0,0 +1,9 @@
+# tar
+
+> Archiving utility.
+> Often combined with a compression method, such as gzip or bzip.
+> More information: <https://www.gnu.org/software/tar>.
+
+- [c]reate an archive from [f]iles:
+
+``
diff --git a/specs/tldr-lint.spec.js b/specs/tldr-lint.spec.js
@@ -167,6 +167,12 @@ describe('Common TLDR formatting errors', function() {
     expect(containsOnlyErrors(errors, 'TLDR109')).toBeTruthy();
     expect(errors.length).toBe(1);
   });
+
+  it('TLDR110\t' + linter.ERRORS.TLDR110, function () {
+    let errors = lintFile('pages/failing/110.md').errors;
+    expect(containsOnlyErrors(errors, 'TLDR110')).toBeTruthy();
+    expect(errors.length).toBe(1);
+  });
 });
 
 describe('TLDR pages that are simply correct', function() {

diff --git a/tldr.yy b/tldr.yy
@@ -63,11 +63,13 @@ example_commands    : example_command   -> [$example_command]
                       -> yy.error(@example_command, 'TLDR105') || $example_commands
                     ;
 
-example_command     : BACKTICK example_command_inner BACKTICK -> $example_command_inner
+example_command     : BACKTICK BACKTICK -> yy.error(@$, 'TLDR110')
+                    | BACKTICK example_command_inner BACKTICK -> $example_command_inner
                     /* | BACKTICK example_command_inner          -> yy.error(@$, 'TLDR103') || $example_command_inner */
                     ;
 
-example_command_inner : -> []
+example_command_inner : COMMAND_TEXT -> $COMMAND_TEXT
+                      | COMMAND_TOKEN -> $COMMAND_TOKEN
                       | example_command_inner COMMAND_TEXT
                         -> [].concat($example_command_inner, yy.createCommandText($COMMAND_TEXT))
                       | example_command_inner COMMAND_TOKEN