shiki-twoslash - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

dist/index.d.ts

@@ -16,2 +16,4 @@ import { Highlighter, HighlighterOptions } from "shiki";
     includeJSDocInHover?: true;
+    /** Instead of showing twoslash exceptions inline, throw the entire process like it will on CI */
+    alwayRaiseForTwoslashExceptions?: true;
 }
@@ -18,0 +20,0 @@ /** The possible user config, a combination of all shiki, twoslash and twoslash-shiki options */

package.json

 {
   "name": "shiki-twoslash",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "license": "MIT",
@@ -30,3 +30,3 @@ "homepage": "https://github.com/shikijs/twoslash",
   "dependencies": {
-    "@typescript/twoslash": "2.0.1",
+    "@typescript/twoslash": "2.1.0",
     "@typescript/vfs": "1.3.4",
@@ -33,0 +33,0 @@ "shiki": "0.9.3",

README.md

@@ -91,3 +91,30 @@ ### shiki-twoslash
 
+The Twoslash `ExampleOptions` looks like (these are things which can be set via `// @[flag]` in a code sample):
 
+<!-- AUTO-GENERATED-CONTENT:START (TYPE:src=./node_modules/@typescript/twoslash/dist/index.d.ts&symbol=ExampleOptions) -->
+```ts
+/** Available inline flags which are not compiler flags */
+export interface ExampleOptions {
+    /** Lets the sample suppress all error diagnostics */
+    noErrors: boolean;
+    /** An array of TS error codes, which you write as space separated - this is so the tool can know about unexpected errors */
+    errors: number[];
+    /** Shows the JS equivalent of the TypeScript code instead */
+    showEmit: boolean;
+    /**
+     * Must be used with showEmit, lets you choose the file to present instead of the source - defaults to index.js which
+     * means when you just use `showEmit` above it shows the transpiled JS.
+     */
+    showEmittedFile: string;
+    /** Whether to disable the pre-cache of LSP calls for interesting identifiers, defaults to false */
+    noStaticSemanticInfo: boolean;
+    /** Declare that the TypeScript program should edit the fsMap which is passed in, this is only useful for tool-makers, defaults to false */
+    emit: boolean;
+    /** Declare that you don't need to validate that errors have corresponding annotations, defaults to false */
+    noErrorValidation: boolean;
+}
+```
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+
 And one extra for good luck:
@@ -106,2 +133,4 @@
     includeJSDocInHover?: true;
+    /** Instead of showing twoslash exceptions inline, throw the entire process like it will on CI */
+    alwayRaiseForTwoslashExceptions?: true;
 }
@@ -108,0 +137,0 @@ ```

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

323194

increased by0.66%

Lines of code

1977

increased by0.1%

Number of lines in readme file

278

increased by11.65%

Dependency changes

• + Added@typescript/twoslash@2.1.0(transitive)

• - Removed@typescript/twoslash@2.0.1(transitive)

• Updated@typescript/twoslash@2.1.0