Project

yaml-vfs

0.01
Low commit activity in last 3 years
No release in over a year
`vfs yamlwriter` lets you create clang opt "-ivfsoverlay" ymal file, map virtual path to real path.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

>= 2.1, < 3.0
~> 10.0
~> 3.0

Runtime

>= 1.0.2, < 2.0
~> 3.1
 Project Readme

yaml-vfs

License MIT 

A gem which can gen VFS YAML file.

vfs yamlwriter lets you create clang opt "-ivfsoverlay" ymal file, map virtual path to real path.

  • ✅ It can gen VFS YAML.

Installation

Add this line to your application's Gemfile:

gem 'yaml-vfs'

And then execute:

# bundle install
$ bundle install

Or install it yourself as:

# gem install
$ gem install yaml-vfs

Usage

The command should be executed when your want VFS YAML file.

# write the VFS YAML file to --output-path=<path>
$ vfs yamlwriter --framework-path=<path> --real-headers-dir=<path> --real-modules-dir=<path> --output-path=<path>

# write the VFS YAML file to .
$ vfs yamlwriter --framework-path=<path> --real-headers-dir=<path> --real-modules-dir=<path>

Option && Flags

Usage:

  • vfs yamlwriter --framework-path --real-headers-dir --real-modules-dir [--output-path]

Options:

  • --framework-path=<path>: framework path
  • --real-headers-dir=<path>: real header path
  • --real-modules-dir=<path>: real modules path
  • --output-path=<path>: vfs yaml file output path

Quickstart

To begin gen an yaml VFS file start by create an FileCollector:

require 'yaml_vfs'
modules = ['./module.modulemap', './module.private.modulemap']
headers_path = ['./A.h', './B.h']
vfs = VFS::FileCollector.new('./A.framework', modules, headers_path)
vfs.write_mapping('./vfs_yaml_output_path')

or set use path:

require 'yaml_vfs'
modules = ['./module.modulemap', './module.private.modulemap']
headers_path = ['./A.h', './B.h']
vfs = VFS::FileCollector.new_from_real_headers_dir('./A.framework', './module_path', './headers')
vfs.write_mapping('./vfs_yaml_output_path')

Command Line Tool

Installing the 'yaml-vfs' gem will also install two command-line tool vfs which you can use to generate VFS YAML file.

For more information consult vfs --help or vfs yamlwriter --help.

Contributing

Bug reports and pull requests are welcome on GitHub at yaml-vfs. This project is intended to be a safe, welcoming space for collaboration.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the yaml-vfs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.