Actualizacion maquina principal
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / prettier-tslint / README.md
diff --git a/.config/coc/extensions/node_modules/coc-prettier/node_modules/prettier-tslint/README.md b/.config/coc/extensions/node_modules/coc-prettier/node_modules/prettier-tslint/README.md
new file mode 100644 (file)
index 0000000..2961689
--- /dev/null
@@ -0,0 +1,70 @@
+# prettier-tslint
+
+Formats your TypeScript using [`prettier`](https://github.com/prettier/prettier)
+followed by [`tslint --fix`](https://github.com/palantir/tslint).
+
+[![Travis](https://img.shields.io/travis/azz/prettier-tslint.svg?style=flat-square)](https://travis-ci.org/azz/prettier-tslint)
+[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![npm](https://img.shields.io/npm/v/prettier-tslint.svg?style=flat-square)](https://npmjs.org/prettier-tslint)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
+
+## Install
+
+With `npm`:
+
+```bash
+npm install --save-dev prettier-tslint
+```
+
+Or with `yarn`:
+
+```bash
+yarn add --dev prettier-tslint
+```
+
+`prettier-tslint` allows you to install your own version of `prettier` and
+`typescript`, so make sure you've installed them, too.
+
+## Configuration
+
+`prettier-tslint` find and will respect:
+
+* `prettier`'s `.prettierrc`, or any other config file such as `package.json`.
+* `prettier`'s `.prettierignore` file.
+* `tslint`'s `tslint.json`.
+
+`prettier-tslint` has no additional configuration.
+
+## CLI
+
+```
+Commands:
+  fix    Fix one or more files
+  check  List files that aren't formatted
+
+Options:
+  --version  Show version number                                       [boolean]
+  --help     Show help                                                 [boolean]
+
+Examples:
+  prettier-tslint fix file1.ts file2.ts  Fix provided files
+  prettier-tslint fix '**/*.ts'          Fix all TypeScript files
+  prettier-tslint check '**/*.ts'        List all unformatted TypeScript files
+```
+
+## API
+
+```js
+import { fix, check } from "prettier-tslint";
+
+check("file.ts"); // -> false
+fix("file.ts");
+check("file.ts"); // -> true
+```
+
+Currently the `fix` function will write to disk and not return anything. This behavior **may change** in a minor release before `1.0.0` is released.
+
+## Contributing
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md)