vile-tailor

A Vile plugin for identifying common style and maintainability issues in your Swift code (via Tailor).

Requirements

• Node.js
• Swift

Installation

Currently, you need to have tailor installed manually.

Example:

npm i -D vile vile-tailor
brew install tailor

Config

By default, .tailor.yml should be picked up without any extra config, and that is where you currently need to have most of your config.

You can specify a custom path as well:

tailor:
  config: some/custom_path.yml

You can also specify an allow list which is passed to tailor.

tailor:
  allow:
    - app
    - spec

Else, . is used as the directory to operate on.

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

1. Please consider tests and code quality before submitting.
2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Architecture

This project is currently written in JavaScript. Tailor provides a JSON CLI output that is currently used until a more ideal IPC option is implemented.

• bin houses any shell based scripts
• src is es6+ syntax compiled with Babel
• lib generated js library

Developing

cd vile-tailor
npm install
brew install tailor
npm run dev
npm test