Metadata-Version: 2.1
Name: cwlformat
Version: 2020.3.26
Summary: A prettifier for CWL code
Home-page: https://github.com/kaushik-work/cwlformat
Author: Kaushik Ghose
Author-email: kaushik.ghose@sbgenomics.com
License: SBG Proprietary.
Requires-Dist: ruamel.yaml (>=0.15.77)

Copyright SBG
Description: # CWL Format
        
        ![](https://github.com/rabix/cwlformat/workflows/Tests/badge.svg)
        
        CWL Format is a specification and a reference implementation for
        a very opinionated code formatter for CWL.
        
        It outputs CWL in a standardized YAML format. It has no settings or
        options because you have better things to do with your time. And because
        CWL Format is always correct.
        
        This repository lists the formatting rules and also contains a Python
        implementation of the formatter.
        
        ## Rules
        
        - Only comment lines at the top of the file, including blank lines,
          before the actual CWL code are preserved. All other comments are lost.
          **Do not use this if all comments in the YAML are important to you**. 
        
        - All CWL fields are ordered systematically. The field order for specific 
          fields have a defined precedence ("pinned fields"). Any fields not 
          present in this file ("free fields") are printed after the pinned fields 
          and ordered alphabetically.
        
        - The pinned fields are defined in [this YAML file](cwlformat/keyorder.yml). 
        
        - Specific pinned field orderings are available for CommandLineTool, 
          ExpressionTool and Workflow processes. All other types follow a generic
          pinned field list.
         
        - All strings that fit within 80 columns are expressed in flow style.
          Longer strings or strings with new lines are expressed in block style.
        
        - All lists and maps are expressed in block style
        
        - The ordering of all lists are preserved
        
        - Indentation is 2 spaces, including for lists
        
        
        ## Conformance tests
        
        A series of documents are found in the [`tests`](tests/cwl) directory that can be used
        to check correctness of a formatter. The files named `original-*` are the input files
        and the files named `formatted-*` are the corresponding formatted documents. There
        are a mixture of YAML and JSON input files. Formatted files are always YAML.
        
Platform: UNKNOWN
Requires-Python: >=3.7.0
