An open API service indexing awesome lists of open source software.

https://github.com/chimehq/editorconfig

A Swift library for working with .editorconfig files
https://github.com/chimehq/editorconfig

editorconfig swift

Last synced: 6 months ago
JSON representation

A Swift library for working with .editorconfig files

Awesome Lists containing this project

README

          

[![Build Status][build status badge]][build status]
[![Platforms][platforms badge]][platforms]

# EditorConfig
A Swift library for working with [editorconfig][editorconfig] files

- Parse and resolve editorconfig files
- Enforce a limitation on how far up the filesystem the resolution will scan
- Render `Configuration` structs back into the editorconfig format

## Installation

```swift
dependencies: [
.package(url: "https://github.com/ChimeHQ/EditorConfig", from: "0.1.1")
],
```

## Usage

```swift
import EditorConfig

let resolver = Resolver()

let fileURL = URL(fileURLWithPath: "path/to/myfile")

let configuration = try resolver.configuration(for: fileURL)
```

## Contributing and Collaboration

I would love to hear from you! Issues, Discussions, or pull requests work great.

I prefer collaboration, and would love to find ways to work together if you have a similar project.

I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.

By participating in this project you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md).

[editorconfig]: https://editorconfig.org
[build status]: https://github.com/ChimeHQ/EditorConfig/actions
[build status badge]: https://github.com/ChimeHQ/EditorConfig/workflows/CI/badge.svg
[platforms]: https://swiftpackageindex.com/ChimeHQ/EditorConfig
[platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FChimeHQ%2FEditorConfig%2Fbadge%3Ftype%3Dplatforms