UNPKG

remark-shiki-twoslash

Version:

A remark plugin which renders code samples for all languages via Shiki, but has some real cool features for TS/JS code

1,249 lines (1,023 loc) 44.4 kB
'use strict'; Object.defineProperty(exports, '__esModule', { value: true }); function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; } var twoslash = require('@typescript/twoslash'); var visit = _interopDefault(require('unist-util-visit')); var fenceparser = require('fenceparser'); var shiki = require('shiki'); var shikiTwoslash = require('shiki-twoslash'); function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } } function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; } function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); } function createCommonjsModule(fn, module) { return module = { exports: {} }, fn(module, module.exports), module.exports; } var runtime_1 = /*#__PURE__*/createCommonjsModule(function (module) { /** * Copyright (c) 2014-present, Facebook, Inc. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ var runtime = function (exports) { var Op = Object.prototype; var hasOwn = Op.hasOwnProperty; var undefined$1; // More compressible than void 0. var $Symbol = typeof Symbol === "function" ? Symbol : {}; var iteratorSymbol = $Symbol.iterator || "@@iterator"; var asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator"; var toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); return obj[key]; } try { // IE 8 has a broken Object.defineProperty that only works on DOM objects. define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { // If outerFn provided and outerFn.prototype is a Generator, then outerFn.prototype instanceof Generator. var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator; var generator = Object.create(protoGenerator.prototype); var context = new Context(tryLocsList || []); // The ._invoke method unifies the implementations of the .next, // .throw, and .return methods. generator._invoke = makeInvokeMethod(innerFn, self, context); return generator; } exports.wrap = wrap; // Try/catch helper to minimize deoptimizations. Returns a completion // record like context.tryEntries[i].completion. This interface could // have been (and was previously) designed to take a closure to be // invoked without arguments, but in all the cases we care about we // already have an existing method we want to call, so there's no need // to create a new function object. We can even get away with assuming // the method takes exactly one argument, since that happens to be true // in every case, so we don't have to touch the arguments object. The // only additional allocation required is the completion record, which // has a stable shape and so hopefully should be cheap to allocate. function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } var GenStateSuspendedStart = "suspendedStart"; var GenStateSuspendedYield = "suspendedYield"; var GenStateExecuting = "executing"; var GenStateCompleted = "completed"; // Returning this object from the innerFn has the same effect as // breaking out of the dispatch switch statement. var ContinueSentinel = {}; // Dummy constructor functions that we use as the .constructor and // .constructor.prototype properties for functions that return Generator // objects. For full spec compliance, you may wish to configure your // minifier not to mangle the names of these two functions. function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} // This is a polyfill for %IteratorPrototype% for environments that // don't natively support it. var IteratorPrototype = {}; IteratorPrototype[iteratorSymbol] = function () { return this; }; var getProto = Object.getPrototypeOf; var NativeIteratorPrototype = getProto && getProto(getProto(values([]))); if (NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol)) { // This environment has a native %IteratorPrototype%; use it instead // of the polyfill. IteratorPrototype = NativeIteratorPrototype; } var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); GeneratorFunction.prototype = Gp.constructor = GeneratorFunctionPrototype; GeneratorFunctionPrototype.constructor = GeneratorFunction; GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"); // Helper for defining the .next, .throw, and .return methods of the // Iterator interface in terms of a single ._invoke method. function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } exports.isGeneratorFunction = function (genFun) { var ctor = typeof genFun === "function" && genFun.constructor; return ctor ? ctor === GeneratorFunction || // For the native GeneratorFunction constructor, the best we can // do is to check its .name property. (ctor.displayName || ctor.name) === "GeneratorFunction" : false; }; exports.mark = function (genFun) { if (Object.setPrototypeOf) { Object.setPrototypeOf(genFun, GeneratorFunctionPrototype); } else { genFun.__proto__ = GeneratorFunctionPrototype; define(genFun, toStringTagSymbol, "GeneratorFunction"); } genFun.prototype = Object.create(Gp); return genFun; }; // Within the body of any async function, `await x` is transformed to // `yield regeneratorRuntime.awrap(x)`, so that the runtime can test // `hasOwn.call(value, "__await")` to determine if the yielded value is // meant to be awaited. exports.awrap = function (arg) { return { __await: arg }; }; function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if (record.type === "throw") { reject(record.arg); } else { var result = record.arg; var value = result.value; if (value && typeof value === "object" && hasOwn.call(value, "__await")) { return PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }); } return PromiseImpl.resolve(value).then(function (unwrapped) { // When a yielded Promise is resolved, its final value becomes // the .value of the Promise<{value,done}> result for the // current iteration. result.value = unwrapped; resolve(result); }, function (error) { // If a rejected Promise was yielded, throw the rejection back // into the async generator function so it can be handled there. return invoke("throw", error, resolve, reject); }); } } var previousPromise; function enqueue(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = // If enqueue has been called before, then we want to wait until // all previous Promises have been resolved before calling invoke, // so that results are always delivered in the correct order. If // enqueue has not been called before, then it is important to // call invoke immediately, without waiting on a callback to fire, // so that the async generator function has the opportunity to do // any necessary setup in a predictable way. This predictability // is why the Promise constructor synchronously invokes its // executor callback, and why async functions synchronously // execute code before the first await. Since we implement simple // async functions in terms of async generators, it is especially // important to get this right, even though it requires care. previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, // Avoid propagating failures to Promises returned by later // invocations of the iterator. callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } // Define the unified helper method that is used to implement .next, // .throw, and .return (see defineIteratorMethods). this._invoke = enqueue; } defineIteratorMethods(AsyncIterator.prototype); AsyncIterator.prototype[asyncIteratorSymbol] = function () { return this; }; exports.AsyncIterator = AsyncIterator; // Note that simple async functions are implemented on top of // AsyncIterator objects; they just return a Promise for the value of // the final result produced by the iterator. exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { if (PromiseImpl === void 0) PromiseImpl = Promise; var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter // If outerFn is a generator, return the full iterator. : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }; function makeInvokeMethod(innerFn, self, context) { var state = GenStateSuspendedStart; return function invoke(method, arg) { if (state === GenStateExecuting) { throw new Error("Generator is already running"); } if (state === GenStateCompleted) { if (method === "throw") { throw arg; } // Be forgiving, per 25.3.3.3.3 of the spec: // https://people.mozilla.org/~jorendorff/es6-draft.html#sec-generatorresume return doneResult(); } context.method = method; context.arg = arg; while (true) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if (context.method === "next") { // Setting context._sent for legacy support of Babel's // function.sent implementation. context.sent = context._sent = context.arg; } else if (context.method === "throw") { if (state === GenStateSuspendedStart) { state = GenStateCompleted; throw context.arg; } context.dispatchException(context.arg); } else if (context.method === "return") { context.abrupt("return", context.arg); } state = GenStateExecuting; var record = tryCatch(innerFn, self, context); if (record.type === "normal") { // If an exception is thrown from innerFn, we leave state === // GenStateExecuting and loop back for another invocation. state = context.done ? GenStateCompleted : GenStateSuspendedYield; if (record.arg === ContinueSentinel) { continue; } return { value: record.arg, done: context.done }; } else if (record.type === "throw") { state = GenStateCompleted; // Dispatch the exception by looping back around to the // context.dispatchException(context.arg) call above. context.method = "throw"; context.arg = record.arg; } } }; } // Call delegate.iterator[context.method](context.arg) and handle the // result, either by returning a { value, done } result from the // delegate iterator, or by modifying context.method and context.arg, // setting context.delegate to null, and returning the ContinueSentinel. function maybeInvokeDelegate(delegate, context) { var method = delegate.iterator[context.method]; if (method === undefined$1) { // A .throw or .return when the delegate iterator has no .throw // method always terminates the yield* loop. context.delegate = null; if (context.method === "throw") { // Note: ["return"] must be used for ES3 parsing compatibility. if (delegate.iterator["return"]) { // If the delegate iterator has a return method, give it a // chance to clean up. context.method = "return"; context.arg = undefined$1; maybeInvokeDelegate(delegate, context); if (context.method === "throw") { // If maybeInvokeDelegate(context) changed context.method from // "return" to "throw", let that override the TypeError below. return ContinueSentinel; } } context.method = "throw"; context.arg = new TypeError("The iterator does not provide a 'throw' method"); } return ContinueSentinel; } var record = tryCatch(method, delegate.iterator, context.arg); if (record.type === "throw") { context.method = "throw"; context.arg = record.arg; context.delegate = null; return ContinueSentinel; } var info = record.arg; if (!info) { context.method = "throw"; context.arg = new TypeError("iterator result is not an object"); context.delegate = null; return ContinueSentinel; } if (info.done) { // Assign the result of the finished delegate to the temporary // variable specified by delegate.resultName (see delegateYield). context[delegate.resultName] = info.value; // Resume execution at the desired location (see delegateYield). context.next = delegate.nextLoc; // If context.method was "throw" but the delegate handled the // exception, let the outer generator proceed normally. If // context.method was "next", forget context.arg since it has been // "consumed" by the delegate iterator. If context.method was // "return", allow the original .return call to continue in the // outer generator. if (context.method !== "return") { context.method = "next"; context.arg = undefined$1; } } else { // Re-yield the result returned by the delegate method. return info; } // The delegate iterator is finished, so forget it and continue with // the outer generator. context.delegate = null; return ContinueSentinel; } // Define Generator.prototype.{next,throw,return} in terms of the // unified ._invoke helper method. defineIteratorMethods(Gp); define(Gp, toStringTagSymbol, "Generator"); // A Generator should always return itself as the iterator object when the // @@iterator function is called on it. Some browsers' implementations of the // iterator prototype chain incorrectly implement this, causing the Generator // object to not be returned from this call. This ensures that doesn't happen. // See https://github.com/facebook/regenerator/issues/274 for more details. Gp[iteratorSymbol] = function () { return this; }; Gp.toString = function () { return "[object Generator]"; }; function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; if (1 in locs) { entry.catchLoc = locs[1]; } if (2 in locs) { entry.finallyLoc = locs[2]; entry.afterLoc = locs[3]; } this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal"; delete record.arg; entry.completion = record; } function Context(tryLocsList) { // The root entry object (effectively a try statement without a catch // or a finally block) gives us a place to store values thrown from // locations where there is no enclosing try statement. this.tryEntries = [{ tryLoc: "root" }]; tryLocsList.forEach(pushTryEntry, this); this.reset(true); } exports.keys = function (object) { var keys = []; for (var key in object) { keys.push(key); } keys.reverse(); // Rather than returning an object with a next method, we keep // things simple and return the next function itself. return function next() { while (keys.length) { var key = keys.pop(); if (key in object) { next.value = key; next.done = false; return next; } } // To avoid creating an additional object, we just hang the .value // and .done properties off the next function object itself. This // also ensures that the minifier will not anonymize the function. next.done = true; return next; }; }; function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) { return iteratorMethod.call(iterable); } if (typeof iterable.next === "function") { return iterable; } if (!isNaN(iterable.length)) { var i = -1, next = function next() { while (++i < iterable.length) { if (hasOwn.call(iterable, i)) { next.value = iterable[i]; next.done = false; return next; } } next.value = undefined$1; next.done = true; return next; }; return next.next = next; } } // Return an iterator with no values. return { next: doneResult }; } exports.values = values; function doneResult() { return { value: undefined$1, done: true }; } Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { this.prev = 0; this.next = 0; // Resetting context._sent for legacy support of Babel's // function.sent implementation. this.sent = this._sent = undefined$1; this.done = false; this.delegate = null; this.method = "next"; this.arg = undefined$1; this.tryEntries.forEach(resetTryEntry); if (!skipTempReset) { for (var name in this) { // Not sure about the optimal order of these conditions: if (name.charAt(0) === "t" && hasOwn.call(this, name) && !isNaN(+name.slice(1))) { this[name] = undefined$1; } } } }, stop: function stop() { this.done = true; var rootEntry = this.tryEntries[0]; var rootRecord = rootEntry.completion; if (rootRecord.type === "throw") { throw rootRecord.arg; } return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) { throw exception; } var context = this; function handle(loc, caught) { record.type = "throw"; record.arg = exception; context.next = loc; if (caught) { // If the dispatched exception was caught by a catch block, // then let that catch block handle the exception normally. context.method = "next"; context.arg = undefined$1; } return !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; var record = entry.completion; if (entry.tryLoc === "root") { // Exception thrown outside of any try block that could handle // it, so set the completion value of the entire function to // throw the exception. return handle("end"); } if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"); var hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) { return handle(entry.catchLoc, true); } else if (this.prev < entry.finallyLoc) { return handle(entry.finallyLoc); } } else if (hasCatch) { if (this.prev < entry.catchLoc) { return handle(entry.catchLoc, true); } } else if (hasFinally) { if (this.prev < entry.finallyLoc) { return handle(entry.finallyLoc); } } else { throw new Error("try statement without catch or finally"); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } if (finallyEntry && (type === "break" || type === "continue") && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc) { // Ignore the finally entry if control is not jumping to a // location outside the try/catch block. finallyEntry = null; } var record = finallyEntry ? finallyEntry.completion : {}; record.type = type; record.arg = arg; if (finallyEntry) { this.method = "next"; this.next = finallyEntry.finallyLoc; return ContinueSentinel; } return this.complete(record); }, complete: function complete(record, afterLoc) { if (record.type === "throw") { throw record.arg; } if (record.type === "break" || record.type === "continue") { this.next = record.arg; } else if (record.type === "return") { this.rval = this.arg = record.arg; this.method = "return"; this.next = "end"; } else if (record.type === "normal" && afterLoc) { this.next = afterLoc; } return ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) { this.complete(entry.completion, entry.afterLoc); resetTryEntry(entry); return ContinueSentinel; } } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if (record.type === "throw") { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } // The context.catch method must only be called with a location // argument that corresponds to a known catch block. throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }; if (this.method === "next") { // Deliberately forget the last sent value so that we don't // accidentally pass it on to the delegate. this.arg = undefined$1; } return ContinueSentinel; } }; // Regardless of whether this script is executing as a CommonJS module // or not, return the runtime object so that we can declare the variable // regeneratorRuntime in the outer scope, which allows this module to be // injected easily by `bin/regenerator --include-runtime script.js`. return exports; }( // If this script is executing as a CommonJS module, use module.exports // as the regeneratorRuntime namespace. Otherwise create a new empty // object. Either way, the resulting object will be used to initialize // the regeneratorRuntime variable at the top of this file. module.exports ); try { regeneratorRuntime = runtime; } catch (accidentalStrictMode) { // This module should not be running in strict mode, so the above // assignment should always work unless something is misconfigured. Just // in case runtime.js accidentally runs in strict mode, we can escape // strict mode using a global Function call. This could conceivably fail // if a Content Security Policy forbids using Function, but in that case // the proper solution is to fix the accidental strict mode problem. If // you've misconfigured your bundler to force strict mode and applied a // CSP to forbid Function, and you're not willing to fix either of those // problems, please detail your unique predicament in a GitHub issue. Function("r", "regeneratorRuntime = r")(runtime); } }); /** * Keeps a cache of the JSON responses to a twoslash call in node_modules/.cache/twoslash * which should keep CI times down (e.g. the epub vs the handbook etc) - but also during * dev time, where it can be super useful. */ var cachedTwoslashCall = function cachedTwoslashCall(code, lang, settings) { // @ts-expect-error var isWebWorker = typeof self !== "undefined" && typeof self.WorkerGlobalScope !== "undefined"; var isBrowser = isWebWorker || typeof window !== "undefined" && typeof window.document !== "undefined" && typeof fetch !== "undefined"; if (isBrowser) { // Not in Node, run un-cached return shikiTwoslash.runTwoSlash(code, lang, settings); } var _require = require("crypto"), createHash = _require.createHash; var _require2 = require("fs"), readFileSync = _require2.readFileSync, existsSync = _require2.existsSync, mkdirSync = _require2.mkdirSync, writeFileSync = _require2.writeFileSync; var _require3 = require("path"), join = _require3.join; var shikiVersion = require('@typescript/twoslash/package.json').version; var tsVersion = require('typescript/package.json').version; var shasum = createHash("sha1"); var codeSha = shasum.update(code + "-" + shikiVersion + "-" + tsVersion).digest("hex"); var getNmCache = function getNmCache() { if (__dirname.includes("node_modules")) { return join(__dirname.split("node_modules")[0], "node_modules", ".cache", "twoslash"); } else { return join(__dirname, "..", "..", ".cache", "twoslash"); } }; var getPnpCache = function getPnpCache() { try { var pnp = require("pnpapi"); return join(pnp.getPackageInformation(pnp.topLevel).packageLocation, "node_modules", ".cache", "twoslash"); } catch (error) { return getNmCache(); } }; var cacheRoot = process.versions.pnp ? getPnpCache() : getNmCache(); var cachePath = join(cacheRoot, codeSha + ".json"); if (existsSync(cachePath)) { if (process.env.debug) console.log("Using cached twoslash results from " + cachePath); return JSON.parse(readFileSync(cachePath, "utf8")); } else { var results = shikiTwoslash.runTwoSlash(code, lang, settings); if (!existsSync(cacheRoot)) mkdirSync(cacheRoot, { recursive: true }); writeFileSync(cachePath, JSON.stringify(results), "utf8"); return results; } }; var addIncludes = function addIncludes(map, name, code) { var lines = []; code.split("\n").forEach(function (l, _i) { var trimmed = l.trim(); if (trimmed.startsWith("// - ")) { var key = trimmed.split("// - ")[1].split(" ")[0]; map.set(name + "-" + key, lines.join("\n")); } else { lines.push(l); } }); map.set(name, lines.join("\n")); }; var replaceIncludesInCode = function replaceIncludesInCode(_map, code) { var includes = /\/\/ @include: (.*)$/gm; // Basically run a regex over the code replacing any // @include: thing with // 'thing' from the map // const toReplace: [index:number, length: number, str: string][] = [] var toReplace = []; var match; while ((match = includes.exec(code)) !== null) { // This is necessary to avoid infinite loops with zero-width matches if (match.index === includes.lastIndex) { includes.lastIndex++; } var key = match[1]; var replaceWith = _map.get(key); if (!replaceWith) { var msg = "Could not find an include with the key: '" + key + "'.\nThere is: " + Array.from(_map.keys()) + "."; throw new Error(msg); } toReplace.push([match.index, match[0].length, replaceWith]); } var newCode = code.toString(); // Go backwards through the found changes so that we can retain index position toReplace.reverse().forEach(function (r) { newCode = newCode.substring(0, r[0]) + r[2] + newCode.substring(r[0] + r[1]); }); return newCode; }; function escapeHtml(html) { return html.replace(/</g, "&lt;").replace(/>/g, "&gt;"); } var setupNodeForTwoslashException = function setupNodeForTwoslashException(code, node, error) { var css = "<style>\n@import url('http://fonts.cdnfonts.com/css/caslon-os'); \n\n.twoslash-fixed-error-note { \n position: fixed;\n top: 20px;\n right: 20px;\n display: flex;\n align-items: center;\n padding: .25rem .75rem;\n color: black;\n background-color: #FCF3D9;\n background-clip: padding-box;\n border-bottom: 1px solid rgba(0,0,0,.05);\n border-radius: .25rem;\n font-family: -apple-system,BlinkMacSystemFont,\"Segoe UI\",Roboto,\"Helvetica Neue\",Arial,\"Noto Sans\",sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\",\"Segoe UI Symbol\",\"Noto Color Emoji\";\n } \n\n #__docusaurus .twoslash-fixed-error-note {\n top: 80px;\n }\n\n .twoslash-fixed-error-note:hover {\n border-bottom: 1px solid rgba(226, 61, 30, 0.8);\n }\n\n .twoslash-error-color {\n background-color: #E23D1E;\n width: 18px;\n height: 18px;\n border-radius: 9px;\n margin-right: 10px;\n color: black;\n }\n\n.twoslash-exception-message { \n font-family: 'Caslon OS', sans-serif; \n background-color: #FCF3D9;\n font-size: 1.1rem;\n padding: 2rem;\n border-left: 2px solid #E23D1E;\n}\n\n.twoslash-exception-message p {\n margin-top: 1rem;\n margin-bottom: 0.6rem;\n}\n\n.twoslash-exception-message h3 { \n margin-top: 0.6rem;\n margin-bottom: 0.3rem;\n font-size: 1.8rem;\n}\n\n.twoslash-exception-message code {\n white-space: pre-wrap;\n font-family: \"JetBrains Mono\", Menlo, Monaco, Consolas, Courier New, monospace;\n margin-bottom: 20px;\n background-color: #FCF3D9;\n color: black;\n border: none;\n padding-left: 0;\n }\n\n .twoslash-exception-message > code {\n display: block;\n margin-bottom: 1.5rem;\n margin-top: 3rem;\n }\n\n.twoslash-exception-code {\n border-left: 2px solid #E5A604;\n padding-left: 20px;\n background-color: #FCF3D9;\n color: black;\n}\n</style>"; var bodyFromTwoslashError = function bodyFromTwoslashError(error) { return "\n<h3>" + escapeHtml(error.title) + "</h3>\n<p>" + escapeHtml(error.description).replace(/(?:\r\n|\r|\n)/g, "<br>") + "</p>\n<code>" + escapeHtml(error.recommendation).replace(/(?:\r\n|\r|\n)/g, "<br>") + "</code>\n"; }; var bodyFromError = function bodyFromError(error) { return "<pre><code>" + error.message.split("## Code")[0] + "</code></pre>"; }; // @ts-ignore var isWebWorker = typeof self !== "undefined" && typeof self.WorkerGlobalScope !== "undefined"; var isBrowser = isWebWorker || typeof window !== "undefined" && typeof window.document !== "undefined" && typeof fetch !== "undefined"; var isJest = typeof jest !== "undefined"; var eLog = !isBrowser && !isJest ? console.error : function (_str) {}; var body = "<pre><code>" + error + "</code></pre>"; if (typeof error !== "object") { body = String(error); eLog("### Unexpected error:"); eLog(error); } else if (error instanceof twoslash.TwoslashError) { body = bodyFromTwoslashError(error); eLog("### Twoslash error: " + error.title); eLog(error.description); eLog(error.recommendation); eLog("\n### Code Sample"); eLog(code); } else if (error instanceof Error) { body = bodyFromError(error); eLog("### Unexpected error:"); eLog(error); } var codeSample = "<p>Raising Code:</p><pre class='twoslash-exception-code'><code>" + escapeHtml(code) + "</code></pre>"; var html = "\n <a href='#twoslash-error'><div class='twoslash-fixed-error-note'><span class='twoslash-error-color'></span>Twoslash failure</div></a>\n <div class='twoslash-exception-message'>" + body + codeSample + "</div>"; node.type = "html"; node.value = "<div id='twoslash-error'>" + css + html + "</div>"; node.children = []; }; var includes = /*#__PURE__*/new Map(); function getHTML(code, fence, highlighters, twoslash, twoslashSettings) { // Shiki doesn't respect json5 as an input, so switch it // to json, which can handle comments in the syntax highlight var replacer = { json5: "json" }; if (replacer[fence.lang]) fence.lang = replacer[fence.lang]; var results; // Support 'twoslash' includes if (fence.lang === "twoslash") { if (!fence.meta.include || typeof fence.meta.include !== "string") { throw new Error("A twoslash code block needs a pragma like 'twoslash include [name]'"); } addIncludes(includes, fence.meta.include, code); results = twoslashSettings.wrapFragments ? "<div class=\"shiki-twoslash-fragment\"></div>" : ""; } else { // All good, get each highlighter and render the shiki output for it var output = highlighters.map(function (highlighter) { // @ts-ignore var themeName = highlighter.customName.split("/").pop().replace(".json", ""); return shikiTwoslash.renderCodeToHTML(code, fence.lang, fence.meta, _extends({ themeName: themeName }, twoslashSettings), highlighter, twoslash); }); results = output.join("\n"); if (highlighters.length > 1 && twoslashSettings.wrapFragments) { results = "<div class=\"shiki-twoslash-fragment\">" + results + "</div>"; } } return results; } /** * Runs twoslash across an AST node, switching out the text content, and lang * and adding a `twoslash` property to the node. */ var runTwoSlashOnNode = function runTwoSlashOnNode(code, _ref, settings) { var lang = _ref.lang, meta = _ref.meta; if (settings === void 0) { settings = {}; } // Offer a way to do high-perf iterations, this is less useful // given that we cache the results of twoslash in the file-system var shouldDisableTwoslash = typeof process !== "undefined" && process.env && !!process.env.TWOSLASH_DISABLE; if (shouldDisableTwoslash) return undefined; // Only run twoslash when the meta has the attribute twoslash if (meta.twoslash) { var importedCode = replaceIncludesInCode(includes, code); return cachedTwoslashCall(importedCode, lang, settings); } return undefined; }; // To make sure we only have one highlighter per theme in a process var highlighterCache = /*#__PURE__*/new Map(); /** Sets up the highlighters, and cache's for recalls */ var highlightersFromSettings = function highlightersFromSettings(settings) { // console.log("i should only log once per theme") // ^ uncomment this to debug if required var themes = settings.themes || (settings.theme ? [settings.theme] : ["light-plus"]); return Promise.all(themes.map( /*#__PURE__*/function () { var _ref2 = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(theme) { var themeName, highlighter; return runtime_1.wrap(function _callee$(_context) { while (1) { switch (_context.prev = _context.next) { case 0: // You can put a string, a path, or the JSON theme obj themeName = theme.name || theme; _context.next = 3; return shiki.getHighlighter(_extends({}, settings, { theme: theme, themes: undefined })); case 3: highlighter = _context.sent; // @ts-ignore - https://github.com/shikijs/shiki/pull/162 will fix this highlighter.customName = themeName; return _context.abrupt("return", highlighter); case 6: case "end": return _context.stop(); } } }, _callee); })); return function (_x) { return _ref2.apply(this, arguments); }; }())); }; var parsingNewFile = function parsingNewFile() { return includes.clear(); }; var parseFence = function parseFence(fence) { var _parse; var _lex = fenceparser.lex(fence), lang = _lex[0], tokens = _lex.slice(1); // if the language is twoslash and include key is found // insert an `=` after include to make it `include=[name]` // which yields better meta if (lang === "twoslash") { // Search for `include` in tokens var index = tokens.indexOf("include"); if (index !== -1) { tokens.splice(index + 1, 0, "="); } } var meta = (_parse = fenceparser.parse(tokens)) != null ? _parse : {}; return { lang: (lang || "").toString(), meta: meta }; }; /** * Synchronous outer function, async inner function, which is how the remark * async API works. */ function remarkTwoslash(settings) { if (settings === void 0) { settings = {}; } if (!highlighterCache.has(settings)) { highlighterCache.set(settings, highlightersFromSettings(settings)); } var transform = /*#__PURE__*/function () { var _ref3 = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(markdownAST) { var highlighters; return runtime_1.wrap(function _callee2$(_context2) { while (1) { switch (_context2.prev = _context2.next) { case 0: _context2.next = 2; return highlighterCache.get(settings); case 2: highlighters = _context2.sent; parsingNewFile(); visit(markdownAST, "code", remarkVisitor(highlighters, settings)); case 5: case "end": return _context2.stop(); } } }, _callee2); })); return function transform(_x2) { return _ref3.apply(this, arguments); }; }(); return transform; } /** * The function doing the work of transforming any codeblock samples in a remark AST. */ var remarkVisitor = function remarkVisitor(highlighters, twoslashSettings) { if (twoslashSettings === void 0) { twoslashSettings = {}; } return function (node) { var code = node.value; var fence = undefined; try { fence = parseFence([node.lang, node.meta].filter(Boolean).join(" ")); } catch (error) { var twoslashError = new twoslash.TwoslashError("Codefence error", "Could not parse the codefence for this code sample", "It's usually an unclosed string", code); return setupNodeForTwoslashException(code, node, twoslashError); } // Do nothing if the node has an attribute to ignore if (Object.keys(fence.meta).filter(function (key) { return (twoslashSettings.ignoreCodeblocksWithCodefenceMeta || []).includes(key); }).length > 0) { return; } var twoslash$1; try { // By allowing node.twoslash to already exist you can set it up yourself in a browser twoslash$1 = node.twoslash || runTwoSlashOnNode(code, fence, twoslashSettings); } catch (error) { var shouldAlwaysRaise = process && process.env && !!process.env.CI; var yeahButNotInTests = typeof jest === "undefined"; if (shouldAlwaysRaise && yeahButNotInTests || twoslashSettings.alwayRaiseForTwoslashExceptions) { throw error; } else { return setupNodeForTwoslashException(code, node, error); } } if (twoslash$1) { node.value = twoslash$1.code; node.lang = twoslash$1.extension; node.twoslash = twoslash$1; } var shikiHTML = getHTML(node.value, fence, highlighters, twoslash$1, twoslashSettings); node.type = "html"; node.value = shikiHTML; node.children = []; }; }; /** Only the inner function exposed as a synchronous API for markdown-it */ var setupForFile = /*#__PURE__*/function () { var _ref4 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(settings) { var highlighters; return runtime_1.wrap(function _callee3$(_context3) { while (1) { switch (_context3.prev = _context3.next) { case 0: if (settings === void 0) { settings = {}; } parsingNewFile(); if (!highlighterCache.has(settings)) { highlighterCache.set(settings, highlightersFromSettings(settings)); } _context3.next = 5; return highlighterCache.get(settings); case 5: highlighters = _context3.sent; return _context3.abrupt("return", { settings: settings, highlighters: highlighters }); case 7: case "end": return _context3.stop(); } } }, _callee3); })); return function setupForFile(_x3) { return _ref4.apply(this, arguments); }; }(); var transformAttributesToHTML = function transformAttributesToHTML(code, fenceString, highlighters, settings) { var fence = parseFence(fenceString); var twoslash = runTwoSlashOnNode(code, fence, settings); var newCode = twoslash && twoslash.code || code; return getHTML(newCode, fence, highlighters, twoslash, settings); }; exports.default = remarkTwoslash; exports.highlightersFromSettings = highlightersFromSettings; exports.remarkVisitor = remarkVisitor; exports.runTwoSlashOnNode = runTwoSlashOnNode; exports.setupForFile = setupForFile; exports.transformAttributesToHTML = transformAttributesToHTML; //# sourceMappingURL=remark-shiki-twoslash.cjs.development.js.map