ts-mocha - npm Package Compare versions

Comparing version 0.1.2-0 to 1.0.1

package.json

 {
   "name": "ts-mocha",
-  "version": "0.1.2-0",
-  "description": "Mocha wrapper that allows running TypeScript tests using TypeScript runtime (ts-node) to get rid of compilation complexity",
+  "version": "1.0.1",
+  "description": "Mocha thin wrapper that allows running TypeScript tests with TypeScript runtime (ts-node) to get rid of compilation complexity",
   "repository": "https://github.com/piotrwitek/ts-mocha",
@@ -15,3 +15,3 @@ "author": "Piotr Witek <[e-mail]> (http://piotrwitek.github.io)",
   "scripts": {
-    "prepublishOnly": "yarn run clean && yarn && yarn start",
+    "prepublishOnly": "yarn run clean && yarn install --production && yarn add -D mocha && yarn start",
     "clean": "rm -rf node_modules/",
@@ -18,0 +18,0 @@ "start": "./bin/ts-mocha -p test test/**/*.spec.ts",

README.md

@@ -1,2 +0,33 @@
-# ts-mocha
-Mocha wrapped in TypeScript for easy use in TypeScript Projects
+# TS-Mocha
+> Mocha thin wrapper that allows running TypeScript tests with TypeScript runtime (ts-node) to get rid of compilation complexity.
+> All Mocha features are available without any limitation.
+
+### Why?
+To setup Mocha with TypeScript you have to figure out how to integrate them to work together, it's not an easy task and require some advanced knowledge.
+This package handles for you this complexity and let you use ts-mocha just as regular mocha that will handle TypeScript `.ts` and `.tsx` files. Also added some usefull options, you can find them below.
+
+### How?
+TS-Mocha has one only dependency - ts-node, which is used as a TypeScript runtime to execute tests that can import and run imported TypeScript source files as well. It is as a thin wrapper that run local mocha package and set up ts-node environment to handle `.ts` and `.tsx` files. To speed up test execution of TypeScript code type-cheking is disabled, and it is using only transpile module.
+
+### __PRO TIP__: To make your developer experience better I recommend to run type-checking in a seperate process by starting TSC compiler (preferably in watch mode) in you terminal with --noEmit and --project flags.
+
+### __NOTE__: This package does not include Mocha - I have set Mocha as peer dependency on purpose, so I don't lock consumer to a specific Mocha version but most importantly, I don't have to update this package when Mocha is updated, and all the new features will be available automatically from your local Mocha package. Also integration with your existing Mocha setup is non-invasive.
+
+### Options:
+-p, --project  Relative or absolute path to directory containing tsconfig (the same as `tsc -p <value>`) [default: "."] 
+
+### Installation
+
+- Local:
+```
+# remember to install mocha if you don't have it already (npm i -D mocha)
+npm i -D ts-mocha
+`./node_modules/.bin/ts-mocha -p src/ src/**/*.spec.ts`
+```
+
+- Global:
+```
+# remember to install mocha if you don't have it already (npm i -g mocha)
+npm i -g ts-mocha
+`ts-mocha -p src/ src/**/*.spec.ts`
+```

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36833

increased by5.62%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

33

increased by1000%

No dependency changes