@tapjs/typescript - npm Package Compare versions

Comparing version 1.0.3 to 1.1.0

dist/commonjs/index.d.ts

@@ -18,13 +18,12 @@ import { TapPlugin } from '@tapjs/core';
      *
-     * Type-check typescript test files, in addition to transpiling and running
-     * them.
+     * Type-check test files, in addition to transpiling and running them.
      *
-     * This defaults to being set, and type checking your tests is generally a
-     * good idea. However, it is also often considerably slower, adding as much
-     * as half a second to each test suite file, which can be painful if you have
-     * a lot of test files.
+     * This defaults to false, even though type checking your tests is generally
+     * a good idea. Unfortunately, it is also often considerably slower, adding
+     * as much as 500-750ms to each test suite file, which can be painful if you
+     * have a lot of tests. In large project folders, the effect can be even more
+     * pronounced.
      *
-     * If you find that your typescript tests are taking too long to run, and
-     * decide to disable type checking, it is best to enable it in CI, for
-     * example by setting `TAP_TYPECHECK=1` in the environment.
+     * It is a good idea to enable this in CI environments, where test speed is
+     * less of an ergonomic drawback.
      *
@@ -34,2 +33,5 @@ * The `"skipLibCheck": true` option in tsconfig will also speed things up a
      *
+     * Note that even if you pre-compile your tests, they will still be subject
+     * to type checking if `"allowJs": true` is set in your tsconfig.
+     *
      * @group Configuration
@@ -39,3 +41,2 @@ */
         type: string;
-        default: boolean;
         description: string;
@@ -42,0 +43,0 @@ };

dist/commonjs/index.js

@@ -43,13 +43,12 @@ "use strict";
      *
-     * Type-check typescript test files, in addition to transpiling and running
-     * them.
+     * Type-check test files, in addition to transpiling and running them.
      *
-     * This defaults to being set, and type checking your tests is generally a
-     * good idea. However, it is also often considerably slower, adding as much
-     * as half a second to each test suite file, which can be painful if you have
-     * a lot of test files.
+     * This defaults to false, even though type checking your tests is generally
+     * a good idea. Unfortunately, it is also often considerably slower, adding
+     * as much as 500-750ms to each test suite file, which can be painful if you
+     * have a lot of tests. In large project folders, the effect can be even more
+     * pronounced.
      *
-     * If you find that your typescript tests are taking too long to run, and
-     * decide to disable type checking, it is best to enable it in CI, for
-     * example by setting `TAP_TYPECHECK=1` in the environment.
+     * It is a good idea to enable this in CI environments, where test speed is
+     * less of an ergonomic drawback.
      *
@@ -59,2 +58,5 @@ * The `"skipLibCheck": true` option in tsconfig will also speed things up a
      *
+     * Note that even if you pre-compile your tests, they will still be subject
+     * to type checking if `"allowJs": true` is set in your tsconfig.
+     *
      * @group Configuration
@@ -64,19 +66,21 @@ */
         type: 'boolean',
-        default: true,
-        description: `Type-check typescript test files, in addition to
-                  transpiling and running them.
+        description: `Type-check test files, in addition to transpiling and running
+                  them.
 
-                  This defaults to being set, and type checking your tests
-                  is generally a good idea. However, it is also often
-                  considerably slower, adding as much as half a second to
-                  each test suite file, which can be painful if you have
-                  a lot of test files.
+                  This defaults to false, even though type checking your tests
+                  is generally a good idea. Unfortunately, it is also often
+                  considerably slower, adding as much as 500-750ms to each test
+                  suite file, which can be painful if you have a lot of tests.
+                  In large project folders, the effect can be even more
+                  pronounced.
 
-                  If you find that your typescript tests are taking too
-                  long to run, and decide to disable type checking, it is
-                  best to enable it in CI, for example by setting
-                  \`TAP_TYPECHECK=1\` in the environment.
+                  It is a good idea to enable this in CI environments, where
+                  test speed is less of an ergonomic drawback.
 
-                  The \`"skipLibCheck": true\` option in tsconfig will also
+                  The \`"skipLibCheck": true"\` option in tsconfig will also
                   speed things up a bit, at the expense of some type safety.
+
+                  Note that even if you pre-compile your tests, they will still
+                  be subject to type checking if \`"allowJs": true\` is set in
+                  your tsconfig.
     `,
@@ -83,0 +87,0 @@ },

dist/esm/index.d.ts

@@ -18,13 +18,12 @@ import { TapPlugin } from '@tapjs/core';
      *
-     * Type-check typescript test files, in addition to transpiling and running
-     * them.
+     * Type-check test files, in addition to transpiling and running them.
      *
-     * This defaults to being set, and type checking your tests is generally a
-     * good idea. However, it is also often considerably slower, adding as much
-     * as half a second to each test suite file, which can be painful if you have
-     * a lot of test files.
+     * This defaults to false, even though type checking your tests is generally
+     * a good idea. Unfortunately, it is also often considerably slower, adding
+     * as much as 500-750ms to each test suite file, which can be painful if you
+     * have a lot of tests. In large project folders, the effect can be even more
+     * pronounced.
      *
-     * If you find that your typescript tests are taking too long to run, and
-     * decide to disable type checking, it is best to enable it in CI, for
-     * example by setting `TAP_TYPECHECK=1` in the environment.
+     * It is a good idea to enable this in CI environments, where test speed is
+     * less of an ergonomic drawback.
      *
@@ -34,2 +33,5 @@ * The `"skipLibCheck": true` option in tsconfig will also speed things up a
      *
+     * Note that even if you pre-compile your tests, they will still be subject
+     * to type checking if `"allowJs": true` is set in your tsconfig.
+     *
      * @group Configuration
@@ -39,3 +41,2 @@ */
         type: string;
-        default: boolean;
         description: string;
@@ -42,0 +43,0 @@ };

dist/esm/index.js

@@ -39,13 +39,12 @@ import { env } from '@tapjs/core';
      *
-     * Type-check typescript test files, in addition to transpiling and running
-     * them.
+     * Type-check test files, in addition to transpiling and running them.
      *
-     * This defaults to being set, and type checking your tests is generally a
-     * good idea. However, it is also often considerably slower, adding as much
-     * as half a second to each test suite file, which can be painful if you have
-     * a lot of test files.
+     * This defaults to false, even though type checking your tests is generally
+     * a good idea. Unfortunately, it is also often considerably slower, adding
+     * as much as 500-750ms to each test suite file, which can be painful if you
+     * have a lot of tests. In large project folders, the effect can be even more
+     * pronounced.
      *
-     * If you find that your typescript tests are taking too long to run, and
-     * decide to disable type checking, it is best to enable it in CI, for
-     * example by setting `TAP_TYPECHECK=1` in the environment.
+     * It is a good idea to enable this in CI environments, where test speed is
+     * less of an ergonomic drawback.
      *
@@ -55,2 +54,5 @@ * The `"skipLibCheck": true` option in tsconfig will also speed things up a
      *
+     * Note that even if you pre-compile your tests, they will still be subject
+     * to type checking if `"allowJs": true` is set in your tsconfig.
+     *
      * @group Configuration
@@ -60,19 +62,21 @@ */
         type: 'boolean',
-        default: true,
-        description: `Type-check typescript test files, in addition to
-                  transpiling and running them.
+        description: `Type-check test files, in addition to transpiling and running
+                  them.
 
-                  This defaults to being set, and type checking your tests
-                  is generally a good idea. However, it is also often
-                  considerably slower, adding as much as half a second to
-                  each test suite file, which can be painful if you have
-                  a lot of test files.
+                  This defaults to false, even though type checking your tests
+                  is generally a good idea. Unfortunately, it is also often
+                  considerably slower, adding as much as 500-750ms to each test
+                  suite file, which can be painful if you have a lot of tests.
+                  In large project folders, the effect can be even more
+                  pronounced.
 
-                  If you find that your typescript tests are taking too
-                  long to run, and decide to disable type checking, it is
-                  best to enable it in CI, for example by setting
-                  \`TAP_TYPECHECK=1\` in the environment.
+                  It is a good idea to enable this in CI environments, where
+                  test speed is less of an ergonomic drawback.
 
-                  The \`"skipLibCheck": true\` option in tsconfig will also
+                  The \`"skipLibCheck": true"\` option in tsconfig will also
                   speed things up a bit, at the expense of some type safety.
+
+                  Note that even if you pre-compile your tests, they will still
+                  be subject to type checking if \`"allowJs": true\` is set in
+                  your tsconfig.
     `,
@@ -79,0 +83,0 @@ },

package.json

 {
   "name": "@tapjs/typescript",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "a built-in tap extension that adds typescript support",
@@ -44,3 +44,3 @@ "type": "module",
   "peerDependencies": {
-    "@tapjs/core": "1.0.3"
+    "@tapjs/core": "1.1.0"
   },
@@ -47,0 +47,0 @@ "dependencies": {

README.md

@@ -16,16 +16,17 @@ # `@tapjs/typescript`
 - adds `ts-node/esm` to the loader set.
-- adds the `typecheck` config flag, which is true by default
+- adds the `typecheck` config flag, which is `false` by default
+- adds the `tsconfig` config option, for specifying a project
+  config for your tests to use.
 
-The `typecheck` config defaults to being set, and type checking
-your tests is generally a good idea. However, it is also often
-considerably slower, adding as much as half a second to each test
-suite file, which can be painful if you have a lot of test files.
+The `typecheck` config defaults to false, even though type
+checking your tests is generally a good idea. Unfortunately, it
+is also often considerably slower, adding as much as 500-750ms to
+each test suite file, which can be painful if you have a lot of
+tests. In large project folders, the effect can be even more
+pronounced.
 
-You can disable type checking with `--no-typecheck` on the
-command line, or by putting `typecheck: false` in `.taprc`, or `{
-"tap": { "typecheck": false }}` in `package.json`, or
-`TAP_TYPECHECK=0` in the environment.
-
-If you find that your typescript tests are taking too long to run, and
-decide to disable type checking, it is best to enable it in CI, for
+You can enable type checking with `--typecheck` on the command
+line, or by putting `typecheck: true` in `.taprc`, or `{ "tap": {
+"typecheck": true }}` in `package.json`, or `TAP_TYPECHECK=1` in
+the environment. It is highly recommended to enable it in CI, for
 example by setting `TAP_TYPECHECK=1` in the environment.
@@ -35,1 +36,5 @@
 bit, at the expense of some type safety.
+
+Note that even if you pre-compile your tests, they will still be
+subject to type checking if `"allowJs": true` is set in your
+tsconfig.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27028

increased by5%

Lines of code

306

increased by2.68%

Number of lines in readme file

39

increased by14.71%

No dependency changes