[wip][beta] doc updates & CI filtering fixes #701

kulshekhar · 2018-09-07T11:54:26Z

No description provided.

kulshekhar · 2018-09-08T13:05:55Z

docs/user/config.md


 ## Jest preset

 ### Basic usage

-In most of the case, simply adding `preset: 'ts-jest'` to your Jest config should be enough starting using TypeScript with Jest (suposing you did add `ts-jest` to your dev. npm dependencies of course):
+In most of the case, simply adding `preset: 'ts-jest'` to your Jest config should be enough starting using TypeScript with Jest (supposing you did add `ts-jest` to your dev. npm dependencies of course):


In most cases, simply adding preset: 'ts-jest' to your Jest config should be enough to start using TypeScript with Jest (assuming you have added ts-jest to your dependencies of course):

kulshekhar · 2018-09-08T13:08:15Z

docs/user/config.md

@@ -50,10 +50,79 @@ module.exports = {
 }
 ```

+## Paths mapping
+
+If you use ["baseUrl" asn "paths" options](https://www.typescriptlang.org/docs/handbook/module-resolution.html) in your `tsconfig` file, you should make sure the ["moduleNameMapper"](https://facebook.github.io/jest/docs/en/configuration.html#modulenamemapper-object-string-string) option in your Jest config is setup accordingly.


"baseUrl" and "paths" options

kulshekhar · 2018-09-08T13:16:59Z

docs/user/config/isolatedModules.md

@@ -2,7 +2,7 @@
 title: Isolated Modules option
 ---

-By default TSJest uses TypeScript compiler in the context of a project (yours), with full type-checking and features. But it can also be used to compile each file separatly, as an isolated module. That's what the `isolatedModules` option (which defaults to `false`) comes for.
+By default TSJest uses TypeScript compiler in the context of a project (yours), with full type-checking and features. But it can also be used to compile each file separately, as an isolated module. That's what the `isolatedModules` option (which defaults to `false`) comes for.

 You'll loose type-checking ability and some features such as `const enum`, but in the case you plan on using Jest with the cache disabled (`jest --no-cache`), your tests will then run much faster.


loose -> lose

kulshekhar · 2018-09-08T13:19:11Z

docs/user/config/tsConfig.md

@@ -4,15 +4,15 @@ title: TypeScript Config option

 The `tsConfig` option allows you to define the which `tsconfig` JSON file to use. An inline compiler options object can also be specified instead of the path to a file.

-By default, TSJest will do like `tsc` and use the project's `tsconfig.json` file. If it cannot find one, it'l use defaults TypeScript compiler options (except `es5` is used as target instead of `es3`).
+By default, TSJest will do like `tsc` and use the project's `tsconfig.json` file. If it cannot find one, it'll use defaults TypeScript compiler options (except `es5` is used as target instead of `es3`).


TSJest will behave like tsc...

it'll use the default TypeScript ...

hmmm...

By default, it'll use the default TypeScript

not too many "default"?

not really, one is for the 'situation' and one is for the compiler options so it seems ok

doc: minor updates to the config docs

ahnpnl · 2018-09-10T06:29:25Z

docs/user/config/diagnostics.md


 ### Disabling/enabling

-By default all diagnostic are enabled. This is the same as setting the `diagnostics` option to `true`. To disable all diagnostics, set `diagnostics` to `false` (you might experience slightly better performence as well, especially if you disabled Jest cache).
+By default all diagnostic are enabled. This is the same as setting the `diagnostics` option to `true`. To disable all diagnostics, set `diagnostics` to `false` (you might experience slightly better performance as well, especially if you disabled Jest cache).


diagnostic -> diagnostics

ahnpnl · 2018-09-10T06:32:39Z

docs/user/config/diagnostics.md


 ### Advanced configuration

-The option's value can also accpet an object for more advanced configuration. Each config. key is optional:
+The option's value can also accept an object for more advanced configuration. Each config. key is optional:

 - **`pretty`**: Enables/disable colorful and pretty output of errors (default: _enabled_).


Enables/disable -> Enables/disables

ahnpnl · 2018-09-10T06:34:45Z

docs/user/config/index.md

+---
+title: Configuration
+---
+TSJest configuration is done within Jest configuration object. This configuration can be in `package.json` under the `jest` property, or in its own `jest.config.js` file. The latter is preferred since it's a JavaScript file, but it depends on your needs and preference.


The latter is preferred -> the 2nd option is preferred (it looks clearer).

coveralls · 2018-09-11T15:05:02Z

Coverage remained the same at 79.57% when pulling 2ba8fcc on kulshekhar-patch-1 into 294497a on beta.

@ahnpnl

Suggestions by @ahnpnl and @kulshekhar

docs: Updated documentation

huafu added this to the v23.10.0 milestone Sep 7, 2018

kulshekhar and others added 2 commits September 8, 2018 07:51

docs: update versioning section

b416b99

docs(config): typo

53b8f7a

huafu force-pushed the kulshekhar-patch-1 branch from a67d0a1 to 53b8f7a Compare September 8, 2018 05:52

ci(travis): forces tests to run when git push -f

2bf6b5f

huafu force-pushed the kulshekhar-patch-1 branch from e65eb74 to 2bf6b5f Compare September 8, 2018 06:01

huafu changed the title ~~Update versioning section~~ [DOC] text updates & CI filtering fixes Sep 8, 2018

huafu added the Documentation 📖 label Sep 8, 2018

huafu changed the title ~~[DOC] text updates & CI filtering fixes~~ [beta] text updates & CI filtering fixes Sep 8, 2018

huafu changed the title ~~[beta] text updates & CI filtering fixes~~ [beta] doc updates & CI filtering fixes Sep 8, 2018

huafu added 2 commits September 8, 2018 13:31

docs(config): explains paths mapping

dcf14aa

docs: typos

0016cd6

huafu changed the title ~~[beta] doc updates & CI filtering fixes~~ [wip][beta] doc updates & CI filtering fixes Sep 8, 2018

style(docs): makes jekyll html style closer to GFM

dead5ec

kulshekhar commented Sep 8, 2018

View reviewed changes

kulshekhar and others added 3 commits September 10, 2018 11:40

doc: minor updates to the config docs

8463ee5

Merge pull request #706 from kulshekhar/kulshekhar-patch-2

d673bc9

doc: minor updates to the config docs

Merge branch 'beta' into kulshekhar-patch-1

91e29ff

ahnpnl reviewed Sep 10, 2018

View reviewed changes

kulshekhar and others added 2 commits September 10, 2018 12:36

docs: update the menu names

8e97c53

Merge branch 'beta' into kulshekhar-patch-1

d1b4af1

huafu and others added 3 commits September 11, 2018 17:05

docs: typos

1029253

Suggestions by @ahnpnl and @kulshekhar

Beta docfix (#711)

5730b4f

docs: Updated documentation

docs: renames remaining TSJest

2ba8fcc

huafu merged commit ac3a833 into beta Sep 12, 2018

huafu deleted the kulshekhar-patch-1 branch September 12, 2018 06:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[wip][beta] doc updates & CI filtering fixes #701

[wip][beta] doc updates & CI filtering fixes #701

kulshekhar commented Sep 7, 2018

kulshekhar Sep 8, 2018

kulshekhar Sep 8, 2018

kulshekhar Sep 8, 2018

kulshekhar Sep 8, 2018

huafu Sep 11, 2018

kulshekhar Sep 11, 2018

ahnpnl Sep 10, 2018

ahnpnl Sep 10, 2018

ahnpnl Sep 10, 2018

coveralls commented Sep 11, 2018 •

edited

[wip][beta] doc updates & CI filtering fixes #701

[wip][beta] doc updates & CI filtering fixes #701

Conversation

kulshekhar commented Sep 7, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Sep 11, 2018 • edited

coveralls commented Sep 11, 2018 •

edited