-
-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(prettier-plugin-sh): improve type definitions, add more details …
…and test cases
- Loading branch information
Showing
24 changed files
with
2,646 additions
and
1,212 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| coverage | ||
| fixtures | ||
| lib | ||
| node_modules |
This file was deleted.
Oops, something went wrong.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2019 RxTS | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| declare module 'mvdan-sh' { | ||
| namespace sh { | ||
| interface Pos { | ||
| After(p: Pos): boolean | ||
| Col(): number | ||
| IsValid(): boolean | ||
| Line(): number | ||
| Offset(): number | ||
| String(): string | ||
| } | ||
|
|
||
| interface Node { | ||
| Pos(): Pos | ||
| End(): Pos | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-type-alias | ||
| type Command = Node | ||
|
|
||
| interface Stmt { | ||
| Comments: Comment[] | ||
| Cmd: Command | ||
| Position: Pos | ||
| Semicolon: Pos | ||
| Negated: boolean | ||
| Background: boolean | ||
| Coprocess: boolean | ||
| } | ||
|
|
||
| interface Comment extends Node { | ||
| Hash: Pos | ||
| Text: string | ||
| } | ||
|
|
||
| interface File extends Node { | ||
| Name: string | ||
| Stmts?: Stmt[] | ||
| Last: Stmt[] | ||
| } | ||
|
|
||
| type ParserOption = (parser: Parser) => void | ||
|
|
||
| interface Parser { | ||
| keepComments: boolean | ||
| (...options: ParserOption[]): Parser | ||
| Parse(text: string, path?: string): File | ||
| } | ||
|
|
||
| interface Printer { | ||
| (): Printer | ||
| Print(node: Node): string | ||
| } | ||
|
|
||
| interface ShellScript { | ||
| syntax: { | ||
| NewParser: Parser | ||
| NewPrinter: Printer | ||
| KeepComments(parser: sh.Parser, keep: boolean): ParserOption | ||
| DebugPrint(node: Node): void | ||
| NodeType(node: Node): string | ||
| ValidName(value: string): boolean | ||
| Walk(node: Node, walker: (node: Node) => boolean): void | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const sh: sh.ShellScript | ||
|
|
||
| export = sh | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,28 @@ | ||
| import { Doc, FastPath, Plugin } from 'prettier' | ||
| // @ts-ignore | ||
| const sh = require('mvdan-sh') | ||
| import sh from 'mvdan-sh' | ||
| import { FastPath, Plugin } from 'prettier' | ||
|
|
||
| const syntax = sh.syntax | ||
| import { languages } from './languages' | ||
|
|
||
| const { syntax } = sh | ||
| const parser = syntax.NewParser() | ||
| const printer = syntax.NewPrinter() | ||
|
|
||
| syntax.KeepComments(parser, true) | ||
|
|
||
| export default { | ||
| name: 'prettier-plugin-sh', | ||
| languages: [ | ||
| { | ||
| name: 'ShellScript', | ||
| parsers: ['sh-parse'], | ||
| }, | ||
| ], | ||
| languages, | ||
| parsers: { | ||
| 'sh-parse': { | ||
| parse: (text: string) => parser.Parse(text, 'src'), | ||
| astFormat: 'sh-parse', | ||
| locStart: () => -1, | ||
| locEnd: () => -1, | ||
| hasPragma: () => false, | ||
| sh: { | ||
| parse: (text, _parsers, { filepath }) => parser.Parse(text, filepath), | ||
| astFormat: 'sh', | ||
| locStart: (node: sh.Node) => node.Pos().Offset(), | ||
| locEnd: (node: sh.Node) => node.End().Offset(), | ||
| }, | ||
| }, | ||
| printers: { | ||
| 'sh-parse': { | ||
| print: (path: FastPath): Doc => printer.Print(path.getValue()), | ||
| sh: { | ||
| print: (path: FastPath<sh.Node>) => printer.Print(path.getValue()), | ||
| }, | ||
| }, | ||
| } as Plugin |
Oops, something went wrong.