updating documentation for custom tsfmt/prettier versions

diffplug · Feb 22, 2019 · d96245b · d96245b
1 parent 39e9796
commit d96245b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -4,6 +4,10 @@
 
 **WARNING: xml formatter in this version may be vulnerable to XXE attacks (see [#358](https://github.com/diffplug/spotless/issues/358)).**
 
+* Making npm package versions of [`prettier`](https://prettier.io/) and [`tsfmt`](https://github.com/vvakame/typescript-formatter) (and its internally used npm packages) configurable. ([#363](https://github.com/diffplug/spotless/pull/363))
+* Updated default npm package version of `prettier` from 1.13.4 to 1.16.4
+* Updated default npm package version of internally used typescript package from 2.9.2 to 3.3.3 and tslint package from 5.1.0 to 5.12.0 (both used by `tsfmt`)
+
 ### Version 3.18.0 - February 11th 2018 ([javadoc](https://diffplug.github.io/spotless/javadoc/spotless-plugin-gradle/3.18.0/), [jcenter](https://bintray.com/diffplug/opensource/spotless-plugin-gradle/3.18.0))
 
 **WARNING: xml formatter in this version may be vulnerable to XXE attacks (see [#358](https://github.com/diffplug/spotless/issues/358)).**

diff --git a/plugin-gradle/README.md b/plugin-gradle/README.md
@@ -347,6 +347,8 @@ spotless {
   typescript {
     // using existing config files
     tsfmt().tslintFile('/path/to/repo/tslint.json')
+    // tsfmt('7.2.2') to specify specific version of tsfmt
+    // tsfmt(formatterVersion: '7.2.2', typescriptVersion: '3.3.3', tslintVersion: '5.12.1') to specify specific versions of tsfmt and internal packages
   }
 }
 ```
@@ -404,6 +406,7 @@ spotless {
 
     // at least provide the parser to use
     prettier().config(['parser': 'postcss'])
+    // prettier('1.16.4') to specify specific version of prettier
 
     // or provide a typical filename
     prettier().config(['filepath': 'style.scss'])