fix: remove private parameter, use access (BREAKING CHANGES)

documentationjs · Oct 21, 2021 · 874069c · 874069c
1 parent 6f6f9d0
commit 874069c
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 14 deletions.
diff --git a/bin/documentation.js b/bin/documentation.js
@@ -6,7 +6,7 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import commands from '../src/commands/index.js';
 
-const argv = yargs(hideBin(process.argv))
+yargs(hideBin(process.argv))
   .strict()
   .command(commands.serve)
   .command(commands.build)
@@ -42,10 +42,3 @@ const argv = yargs(hideBin(process.argv))
   )
   .recommendCommands()
   .help().argv;
-
-if (argv.private) {
-  console.error(
-    '--private is deprecated, please use the --access (or -a) option instead'
-  );
-  console.error('for example: -a public -a private -a protected -a undefined');
-}
diff --git a/src/commands/shared_options.js b/src/commands/shared_options.js
@@ -45,12 +45,6 @@ export const sharedInputOptions = {
     type: 'array',
     alias: 'pe'
   },
-  private: {
-    describe: 'generate documentation tagged as private',
-    type: 'boolean',
-    default: false,
-    alias: 'p'
-  },
   access: {
     describe:
       'Include only comments with a given access level, out of private, ' +