Nobody Prefers Margarine

    @microsoft.azure/format-spec
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.6 • Public • Published

    Format-spec

    Loads an OpenAPI/Swagger file, sorts the file (ensuring that significant fields float to the top), and can output the file with clean indenting, to either JSON or YAML

    Usage:

    format-spec [--switches] [ouptut-file(s)...]

    input-file can be either a .json or .yaml file output-file can be a list of filenames: files that end in .json will be JSON format files that end in .yaml will be YAML format

    Switches

    --json -- prints the file to stdout as JSON --yaml -- prints the file to stdout as YAML --indent=N -- sets indentation to N (defaults to 2 spaces) --no-sort -- doesn't sort the file

    install it globally

    npm install -g "@microsoft-azure/format-spec"

    Example: formats/sorts a spec and saves it as a new file

    format-spec someswagger.json formattedswagger.json

    Example: formats/sorts a spec and saves it as the same file

    format-spec someswagger.json someswagger.json

    Example: formats/sorts a spec and saves it as a yaml file.

    format-spec someswagger.json someswagger.yaml

    Example: formats (doesn't sort) a spec and saves it as a yaml file.

    format-spec --no-sort someswagger.json someswagger.yaml

    Example: Run without installing

    npx "@microsoft-azure/format-spec" someswagger.json someswagger.yaml

    Contributing

    This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

    When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

    This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

    Keywords

    none

    Install

    npm i @microsoft.azure/format-spec

    DownloadsWeekly Downloads

    2

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    16 kB

    Total Files

    15

    Last publish

    Collaborators

    • azure-sdk
    • windowsazure
    • fearthecowboy