src/InitCli.js - Code Metrics - sonrac/swagger-vue-doc-generator - Measure and Improve Code Quality continuously with Scrutinizer

src/InitCli.js A
last analyzed 2017-12-22 13:34 UTC

↳ Parent: Project

Size

Lines of Code

229

Duplication

Duplicated Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
nc	1
dl	0
loc	229
rs	10
noi	1

1 Function

Rating	Name	Duplication	Size	Complexity
A	InitCli.js ➔ ???	0	13	1

const ArgumentParser = require('argparse').ArgumentParser,
      fs             = require('fs'),
      path           = require('path'),
      DocGenerator   = require('./DocGenerator'),
      SwaggerParser  = require('./SwaggerParser'),

      GenerateApi    = require('./GenerateApi')

/**
 * @class InitCli
 * Init command line interface options
 *
 * @property {ArgumentParser} parser Command line arguments parser
 * @property {Object} arguments Arguments from cli
 * @property {String} workingDir Working directory
 */
class InitCli {
  /**
   *
   * @param {String} version Command script version
   * @param {String} description Command script description
   */
  constructor (version, description) {
    this.parser = new ArgumentParser({
      version    : version,
      description: description,
      addHelp    : true
    })

    this.workingDir = process.cwd()

    this.arguments = {}

    this._defaultArguments()
  }

  /**
   * Init default cli arguments
   *
   * @private
   */
  _defaultArguments () {
    this.addArgument(
      ['-s', '--source'],
      {
        help    : 'Source swagger file destination',
        required: true
      }
    )

    this.addArgument(
      ['-f', '--flag-version'],
      {
        help        : 'Set swagger version (2.0 or openapi). 2.0 only supported | [optional]. Default value is 2.0',
        required    : false,
        defaultValue: '2.0'
      }
    )

    this.addArgument(
      ['-m', '--moduleName'],
      {
        help    : 'Swagger generator module name',
        required: true
      }
    )

    this.addArgument(
      ['-c', '--className'],
      {
        help        : 'Swagger generator class name',
        defaultValue: 'API',
      }
    )

    this.addArgument(
      ['-d', '--destination'],
      {
        help    : 'Destination for output generate client ',
        required: true
      }
    )

    this.addArgument(
      ['-n', '--package-name'],
      {
        help        : 'Package name',
        defaultValue: 'vue-swagger-api'
      }
    )

    this.addArgument(
      ['--package-version'],
      {
        help        : 'Package version',
        defaultValue: '0.2'
      }
    )

    this.addArgument(
      ['-p', '--repo-path'],
      {
        help: 'Path to repository for auto detect version'
      }
    )

    this.addArgument(
      ['-t', '--tag-command'],
      {
        help        : 'Command for get tags list',
        defaultValue: 'git tag -l'
      }
    )
  }

  /**
   * Add options for documentation generator
   */
  addDocumentGeneratorArguments () {
    this.addArgument(
      ['--doc-path'],
      {
        help        : 'Destination for methods descriptions',
        required    : false,
        defaultValue: 'docs',
      }
    )

    this.addArgument(
      ['--model-path'],
      {
        help        : 'Destination for models description',
        required    : false,
        defaultValue: 'docs/models',
      }
    )

    this.parser.addArgument(
      ['--html'],
      {
        help  : 'Generate in Html format',
        action: 'storeTrue'
      }
    )

    this.parser.addArgument(
      ['--md'],
      {
        help  : 'Generate in md format',
        action: 'storeFalse'
      }
    )
  }

  /**
   * Add argument definition
   *
   * @param {Array.<String>} command Argument definition
   * @param {Object} options Argument options
   */
  addArgument (command, options) {
    this.parser.addArgument(command, options)
  }

  /**
   * Generate api file
   */
  generateApi () {

    this.parse()

    let jsonFile  = fs.existsSync(this.arguments.source) ? this.arguments.source : path.join(process.cwd(), this.arguments.source),
        generator = new GenerateApi(jsonFile, {
          outFile   : this.arguments.destination,
          moduleName: this.arguments.moduleName,
          className : this.arguments.className,
        })

    generator.generate()
  }

  _getDocOutFormat () {
    if (this.arguments.md) {
      return DocGenerator.Markdown
    }

    return DocGenerator.HTML
  }

  generateDoc () {
    this.addDocumentGeneratorArguments()

    this.parse()

    let jsonFile = this._getJsonFile(),
        docs     = new DocGenerator(this._getDocOutFormat(), {
          inputJson     : jsonFile,
          moduleName    : this.arguments.moduleName,
          modelPath     : this.arguments.model_path,
          docsPath      : this.arguments.doc_path,
          className     : this.arguments.className,
          packageName   : this.arguments.package_name,
          packageVersion: this.arguments.package_version,
          destination   : this.arguments.destination
        }, this.arguments.flag_version)

    docs.generate()
  }

  /**
   * Get json file path
   *
   * @return {String}
   * @private
   */
  _getJsonFile () {
    return fs.existsSync(this.parser.source) ? this.arguments.source : path.join(process.cwd(), this.arguments.source)
  }

  /**
   * Parse cli options & arguments
   */
  parse () {
    this.arguments = this.parser.parseArgs()

    return this.arguments
  }
}

module.exports = InitCli

1			const ArgumentParser = require('argparse').ArgumentParser,
2			fs = require('fs'),
3			path = require('path'),
4			DocGenerator = require('./DocGenerator'),
5			SwaggerParser = require('./SwaggerParser'),
			0 ignored issues – show Unused Code introduced 2017-10-17 13:15 UTC by Report Bug Copy Issue Report The constant `SwaggerParser` seems to be never used. Consider removing it. Loading history...
6			GenerateApi = require('./GenerateApi')
7
8			/**
9			* @class InitCli
10			* Init command line interface options
11			*
12			* @property {ArgumentParser} parser Command line arguments parser
13			* @property {Object} arguments Arguments from cli
14			* @property {String} workingDir Working directory
15			*/
16			class InitCli {
17			/**
18			*
19			* @param {String} version Command script version
20			* @param {String} description Command script description
21			*/
22			constructor (version, description) {
23			this.parser = new ArgumentParser({
24			version : version,
25			description: description,
26			addHelp : true
27			})
28
29			this.workingDir = process.cwd()
30
31			this.arguments = {}
32
33			this._defaultArguments()
34			}
35
36			/**
37			* Init default cli arguments
38			*
39			* @private
40			*/
41			_defaultArguments () {
42			this.addArgument(
43			['-s', '--source'],
44			{
45			help : 'Source swagger file destination',
46			required: true
47			}
48			)
49
50			this.addArgument(
51			['-f', '--flag-version'],
52			{
53			help : 'Set swagger version (2.0 or openapi). 2.0 only supported \| [optional]. Default value is 2.0',
54			required : false,
55			defaultValue: '2.0'
56			}
57			)
58
59			this.addArgument(
60			['-m', '--moduleName'],
61			{
62			help : 'Swagger generator module name',
63			required: true
64			}
65			)
66
67			this.addArgument(
68			['-c', '--className'],
69			{
70			help : 'Swagger generator class name',
71			defaultValue: 'API',
72			}
73			)
74
75			this.addArgument(
76			['-d', '--destination'],
77			{
78			help : 'Destination for output generate client ',
79			required: true
80			}
81			)
82
83			this.addArgument(
84			['-n', '--package-name'],
85			{
86			help : 'Package name',
87			defaultValue: 'vue-swagger-api'
88			}
89			)
90
91			this.addArgument(
92			['--package-version'],
93			{
94			help : 'Package version',
95			defaultValue: '0.2'
96			}
97			)
98
99			this.addArgument(
100			['-p', '--repo-path'],
101			{
102			help: 'Path to repository for auto detect version'
103			}
104			)
105
106			this.addArgument(
107			['-t', '--tag-command'],
108			{
109			help : 'Command for get tags list',
110			defaultValue: 'git tag -l'
111			}
112			)
113			}
114
115			/**
116			* Add options for documentation generator
117			*/
118			addDocumentGeneratorArguments () {
119			this.addArgument(
120			['--doc-path'],
121			{
122			help : 'Destination for methods descriptions',
123			required : false,
124			defaultValue: 'docs',
125			}
126			)
127
128			this.addArgument(
129			['--model-path'],
130			{
131			help : 'Destination for models description',
132			required : false,
133			defaultValue: 'docs/models',
134			}
135			)
136
137			this.parser.addArgument(
138			['--html'],
139			{
140			help : 'Generate in Html format',
141			action: 'storeTrue'
142			}
143			)
144
145			this.parser.addArgument(
146			['--md'],
147			{
148			help : 'Generate in md format',
149			action: 'storeFalse'
150			}
151			)
152			}
153
154			/**
155			* Add argument definition
156			*
157			* @param {Array.<String>} command Argument definition
158			* @param {Object} options Argument options
159			*/
160			addArgument (command, options) {
161			this.parser.addArgument(command, options)
162			}
163
164			/**
165			* Generate api file
166			*/
167			generateApi () {
168
169			this.parse()
170
171			let jsonFile = fs.existsSync(this.arguments.source) ? this.arguments.source : path.join(process.cwd(), this.arguments.source),
172			generator = new GenerateApi(jsonFile, {
173			outFile : this.arguments.destination,
174			moduleName: this.arguments.moduleName,
175			className : this.arguments.className,
176			})
177
178			generator.generate()
179			}
180
181			_getDocOutFormat () {
182			if (this.arguments.md) {
183			return DocGenerator.Markdown
184			}
185
186			return DocGenerator.HTML
187			}
188
189			generateDoc () {
190			this.addDocumentGeneratorArguments()
191
192			this.parse()
193
194			let jsonFile = this._getJsonFile(),
195			docs = new DocGenerator(this._getDocOutFormat(), {
196			inputJson : jsonFile,
197			moduleName : this.arguments.moduleName,
198			modelPath : this.arguments.model_path,
199			docsPath : this.arguments.doc_path,
200			className : this.arguments.className,
201			packageName : this.arguments.package_name,
202			packageVersion: this.arguments.package_version,
203			destination : this.arguments.destination
204			}, this.arguments.flag_version)
205
206			docs.generate()
207			}
208
209			/**
210			* Get json file path
211			*
212			* @return {String}
213			* @private
214			*/
215			_getJsonFile () {
216			return fs.existsSync(this.parser.source) ? this.arguments.source : path.join(process.cwd(), this.arguments.source)
217			}
218
219			/**
220			* Parse cli options & arguments
221			*/
222			parse () {
223			this.arguments = this.parser.parseArgs()
224
225			return this.arguments
226			}
227			}
228
229			module.exports = InitCli

sonrac / swagger-vue-doc-generator

src/InitCli.js A last analyzed 2017-12-22 13:34 UTC

Size

Duplication

Importance

1 Function

Duplication Side-by-Side

Filter issues like

src/InitCli.js A
last analyzed 2017-12-22 13:34 UTC