• This repository has been archived on 22/Feb/2022
  • Stars
    star
    274
  • Rank 150,274 (Top 3 %)
  • Language
    JavaScript
  • Created almost 7 years ago
  • Updated over 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

[DEPRECATED] Prettier Swift Plugin - WARNING: The AST parser is not stable yet

DEPRECATED

prettier/plugin-swift is deprecated. It hasn’t been updated since early 2018, and the Swift community seems to have moved towards Apple’s swift-format and Nick Lockwood’s SwiftFormat instead.

We hope to someday have plugins for one or both of these tools, but the Prettier team has no current plans to develop such an integration. If you do make something, let us know by opening an issue on the main Prettier repository, and we will consider adding a link to this README.


Prettier Swift

Swift Plugin for the Opinionated Code Formatter

Gitter Travis npm version code style: prettier Follow+Prettier+on+Twitter

What does it do?

⚠️ Warning ⚠️ This plugin might eat your homework in its early stage. It also depends on Swift's lib/Syntax which is in flux. Please stage or commit your code before performing any in-place formatting.

You can check out how it formatted Artsy's Eidolon.

Prerequisites

You need one of the following:

  1. A snapshot from March 30, 2018 or later,
  2. a recent manual build from Swift's master, or
  3. Swift 4.2 (once it's available as a beta or released completely).

Assuming you picked (1) please follow the installation instructions, which recommend updating your PATH at the end:

TOOLCHAIN=swift-DEVELOPMENT-SNAPSHOT-2018-03-30-a.xctoolchain
export PATH=/Library/Developer/Toolchains/${TOOLCHAIN}/usr/bin/:"${PATH}"

Alternatively you can pass the full path to the swiftc binary via the environment variable PRETTIER_SWIFT_SWIFTC:

TOOLCHAIN=swift-DEVELOPMENT-SNAPSHOT-2018-03-30-a.xctoolchain
export PRETTIER_SWIFT_SWIFTC=/Library/Developer/Toolchains/${TOOLCHAIN}/usr/bin/swiftc

Contributing

If you're interested in contributing to the development of Prettier for Swift, you can follow the CONTRIBUTING guide from Prettier, as it all applies to this repository too.

To test it out on a Swift file:

  • Clone this repository.
  • Run yarn.
  • Create a file called test.swift.
  • Run yarn prettier test.swift to check the output.

Install

yarn add --dev --exact prettier prettier/plugin-swift

Use

prettier --write "**/*.swift"

Maintainers


Marcel Jackwerth

More Repositories

1

prettier

Prettier is an opinionated code formatter.
JavaScript
49,325
star
2

eslint-config-prettier

Turns off all rules that are unnecessary or might conflict with Prettier.
JavaScript
5,386
star
3

prettier-vscode

Visual Studio Code extension for Prettier
TypeScript
5,130
star
4

prettier-eslint

Code ➡️ prettier ➡️ eslint --fix ➡️ Formatted Code ✨
JavaScript
3,994
star
5

eslint-plugin-prettier

ESLint plugin for Prettier formatting
JavaScript
3,283
star
6

pretty-quick

⚡ Get Pretty Quick
TypeScript
2,211
star
7

vim-prettier

A Vim plugin for Prettier
Vim Script
1,780
star
8

plugin-php

Prettier PHP Plugin
PHP
1,736
star
9

plugin-ruby

Prettier Ruby Plugin
JavaScript
1,462
star
10

tslint-config-prettier

Use TSLint with Prettier without any conflict
TypeScript
1,234
star
11

prettier-atom

An atom package for the prettier formatter.
JavaScript
755
star
12

prettier-eslint-cli

CLI for prettier-eslint
JavaScript
541
star
13

plugin-python

Prettier Python Plugin
JavaScript
517
star
14

prettier-emacs

Minor mode to format JS code on file save
Emacs Lisp
374
star
15

stylelint-config-prettier

Turns off all rules that are unnecessary or might conflict with prettier.
JavaScript
374
star
16

stylelint-prettier

Stylelint plugin for Prettier formatting
JavaScript
346
star
17

tslint-plugin-prettier

Runs Prettier as a TSLint rule and reports differences as individual TSLint issues
TypeScript
235
star
18

plugin-xml

Prettier XML plugin
JavaScript
229
star
19

prettier-browser-extension

Prettier Browser Extension
JavaScript
200
star
20

plugin-pug

Prettier Pug Plugin
TypeScript
197
star
21

plugin-lua

Prettier Lua Plugin (WIP)
Lua
78
star
22

prettier-logo

The Prettier logo.
JavaScript
39
star
23

prettier-cli

TypeScript
28
star
24

yaml-unist-parser

A YAML parser that produces output compatible with unist
TypeScript
25
star
25

prettier-synchronized

Synchronous version of Prettier
JavaScript
24
star
26

stylelint-config-prettier-scss

Turns off all CSS and SCSS rules that are unnecessary or might conflict with prettier.
JavaScript
24
star
27

prettier-printer

Library for building and pretty printing text documents
JavaScript
23
star
28

prettier-linter-helpers

Helper functions for exposing prettier changes within linting tools
JavaScript
18
star
29

angular-estree-parser

A parser that converts Angular source code into an ESTree-compatible form
TypeScript
16
star
30

prettier-rpc

Single-file build of prettier with JSON-RPC communication
JavaScript
13
star
31

prettier-regression-testing

Automates the prettier/prettier regression checks with GitHub Actions.
TypeScript
12
star
32

parse-srcset

A spec-conformant JavaScript parser for the HTML5 srcset attribute
JavaScript
9
star
33

plugin-haml

Plugin for the HAML template language
JavaScript
5
star
34

pre-commit

Mirror of Prettier package for pre-commit.
JavaScript
5
star
35

core-test-fixtures

Test fixtures for Prettier core.
JavaScript
2
star
36

is-es5-identifier-name

Check if provided string is an `IdentifierName` as specified in ECMA262 edition 5.1 section 7.6.
JavaScript
2
star
37

html-ua-styles

User agent stylesheet defined in the WHATWG HTML specification.
JavaScript
1
star
38

eslint-plugin-prettier-internal-rules

Wrapper for Prettier internal rules
JavaScript
1
star