LoginSignup
1
1

More than 5 years have passed since last update.

swagger-codegenで吐き出されるnpmのpackage名を変更する

Last updated at Posted at 2018-05-28

swagger-codegenを使って、デフォルトで以下みたいに吐き出すと、タイトルを使用した適当な名前になってしまう

$ swagger-codegen generate -i swagger.json -l javascript -o ./codegen

何かオプションはないのかと、各言語のヘルプを見る。

$ swagger-codegen config-help -l javascript

CONFIG OPTIONS
    sortParamsByRequiredFlag
        Sort method arguments to place required parameters before optional parameters. (Default: true)

    ensureUniqueParams
        Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)

    allowUnicodeIdentifiers
        boolean, toggles whether unicode identifiers are allowed in names or not, default is false (Default: false)

    sourceFolder
        source folder for generated code (Default: src)

    localVariablePrefix
        prefix for generated code members and local variables

    invokerPackage
        root package for generated code

    apiPackage
        package for generated api classes

    modelPackage
        package for generated models

    projectName
        name of the project (Default: generated from info.title or "swagger-js-client")

    moduleName
        module name for AMD, Node or globals (Default: generated from <projectName>)

    projectDescription
        description of the project (Default: using info.description or "Client library of <projectName>")

    projectVersion
        version of the project (Default: using info.version or "1.0.0")

    licenseName
        name of the license the project uses (Default: using info.license.name)

    usePromises
        use Promises as return values from the client API, instead of superagent callbacks (Default: false)

    emitModelMethods
        generate getters and setters for model properties (Default: false)

    emitJSDoc
        generate JSDoc comments (Default: true)

    useInheritance
        use JavaScript prototype chains & delegation for inheritance (Default: true)

    hideGenerationTimestamp
        Hides the generation timestamp when files are generated. (Default: true)

    useES6
        use JavaScript ES6 (ECMAScript 6) (beta). Default is ES5. (Default: false)

projectName が使えそうなので、-Dオプションにくっつける。

$ swagger-codegen generate -i swagger.json -l javascript -o ./codegen -DprojectName=my-project

config-help コマンド重要だねというお話でした。

1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
1