Code Monkey home page Code Monkey logo

code2yaml's Introduction

code2yaml Build Status

A tool to extract metadata from code and export as yaml files

configure code2yaml

To use the tool, you need to provide a config file code2yaml.json.

Here is a simple code2yaml.json.

{
  "input_paths": ["./azure-sdk-for-java"],
  "output_path": "./output",
  "exclude_paths": ["./azure-sdk-for-java/azure-samples"],
  "language": "java"
}
  • input_paths: an array of input paths.
  • output_path: output path
  • exclude_paths: an array of exclude paths. Code in the paths wouldn't be extracted metadata.
  • language: it now supports cplusplus, java.

Note

all the paths(path in input_paths, exclude_paths or output_path) are either absolute path or path relative to code2yaml.json

The above sample indicates that we need code2yaml to extract metadata from all code under azure-sdk-for-java and save the results(metadata files which end with .yml) into folder output, except for code under folder azure-sdk-for-java/azure-samples. The folder structure is like below:

Folder  
|   code2yaml.json   
|
+---azure-sdk-for-java
|   ...
|   +---azure-samples
|
|---output

run code2yaml

  1. build the solution. open cmd shell. build.cmd
  2. code2yaml.exe code2yaml.json

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.