Dump shiki versions and document the deploy process a bit

shikijs · Jun 26, 2023 · 4fa28b2 · 4fa28b2
1 parent b6e7393
commit 4fa28b2
Show file tree

Hide file tree

Showing 16 changed files with 1,886 additions and 1,921 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -11,15 +11,15 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: "15.x"
+          node-version: "18.x"
           registry-url: "https://registry.npmjs.org/"
       - name: Cache .pnpm-store
         uses: actions/cache@v1
         with:
           path: ~/.pnpm-store
           key: ${{ runner.os }}-node${{ matrix.node-version }}-${{ hashFiles('**/pnpm-lock.yaml') }}
       - name: Install pnpm
-        run: curl -f https://get.pnpm.io/v6.js | node - add --global pnpm@6
+        run: curl -f https://get.pnpm.io/v8.js | node - add --global pnpm@8
 
 
       - run: pnpm install

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -23,4 +23,12 @@ The examples projects have been used to bootstrap the integration plugins, and d
 
 #### Twoslash
 
-Shiki Twoslash relies on Twoslash which lives in the [TypeScript website monorepo](https://github.com/microsoft/TypeScript-Website/tree/v2/packages/ts-twoslasher). For more daring features, you may need to add support there first.
+Shiki Twoslash relies on Twoslash which lives in the [TypeScript website monorepo](https://github.com/microsoft/TypeScript-Website/tree/v2/packages/ts-twoslasher). For more daring features, you may need to add support there first.
+
+#### Deps
+
+There is a script `node scripts/syncVersions.js` which ensures that all the deps in the repo line up, which if you make any package json changes you probably want to run
+
+#### Deploys 
+
+The deploy process happens on push and compares the versions via pleb
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
   "scripts": {
     "test": "jest",
     "bootstrap": "pnpm recursive run --workspace-concurrency 1 build  && md-magic",
-    "build": "pnpm run build -r && md-magic",
+    "build": "pnpm recursive run --workspace-concurrency 1 build && md-magic",
     "deploy": "pnpm changeset version && pnpm install && git add . && git commit -m 'Deploy' && git push"
   },
   "devDependencies": {

diff --git a/packages/docusaurus-preset-shiki-twoslash/package.json b/packages/docusaurus-preset-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-preset-shiki-twoslash",
-  "version": "1.1.41",
+  "version": "1.1.44",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "copy-text-to-clipboard": "^3.0.1",
-    "remark-shiki-twoslash": "3.1.3",
+    "remark-shiki-twoslash": "3.1.7",
     "typescript": ">3"
   },
   "devDependencies": {

diff --git a/packages/eleventy-plugin-shiki-twoslash/package.json b/packages/eleventy-plugin-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eleventy-plugin-shiki-twoslash",
-  "version": "1.1.3",
+  "version": "1.1.10",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -21,11 +21,15 @@
   },
   "dependencies": {
     "deasync": "^0.1.21",
-    "remark-shiki-twoslash": "3.1.3",
-    "typescript": ">3"
+    "remark-shiki-twoslash": "3.1.7",
+    "typescript": ">3",
+    "@typescript/vfs": "1.4.0",
+    "fenceparser": "^2.2.0",
+    "regenerator-runtime": "^0.13.7",
+    "shiki-twoslash": "3.1.3",
+    "shiki": "0.14.3"
   },
   "devDependencies": {
-    "shiki": "0.10.1",
-    "shiki-twoslash": "3.1.2"
+    "shiki-twoslash": "3.1.3"
   }
 }
diff --git a/packages/gatsby-remark-shiki-twoslash/package.json b/packages/gatsby-remark-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "gatsby-remark-shiki-twoslash",
-  "version": "3.0.38",
+  "version": "3.0.42",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -23,7 +23,7 @@
     "build": ""
   },
   "dependencies": {
-    "remark-shiki-twoslash": "3.1.3",
+    "remark-shiki-twoslash": "3.1.7",
     "typescript": ">3",
     "unist-util-visit": "^2.0.0"
   },

diff --git a/packages/hexo-shiki-twoslash/package.json b/packages/hexo-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "hexo-shiki-twoslash",
-  "version": "1.0.39",
+  "version": "1.0.43",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -21,7 +21,7 @@
     "lint": "echo 'NOOP'"
   },
   "dependencies": {
-    "remark-shiki-twoslash": "3.1.3",
+    "remark-shiki-twoslash": "3.1.7",
     "typescript": ">3"
   }
 }
diff --git a/packages/markdown-it-shiki-twoslash/package.json b/packages/markdown-it-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "markdown-it-shiki-twoslash",
-  "version": "2.1.3",
+  "version": "2.1.10",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -26,15 +26,14 @@
   },
   "dependencies": {
     "deasync": "^0.1.21",
-    "remark-shiki-twoslash": "3.1.3"
+    "remark-shiki-twoslash": "3.1.7"
   },
   "devDependencies": {
     "@types/deasync": "^0.1.1",
     "@types/jest": "^25.1.3",
     "@types/markdown-it": "^12.0.1",
     "markdown-it": "^12.0.6",
-    "shiki": "0.10.1",
-    "shiki-twoslash": "3.1.2",
+    "shiki-twoslash": "3.1.3",
     "tslib": "^1.10.0",
     "typescript": ">3"
   }

diff --git a/packages/remark-shiki-twoslash/package.json b/packages/remark-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "remark-shiki-twoslash",
-  "version": "3.1.3",
+  "version": "3.1.7",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -27,13 +27,13 @@
     "lint": "tsdx lint"
   },
   "dependencies": {
-    "@typescript/twoslash": "3.1.0",
-    "@typescript/vfs": "1.3.4",
     "@types/unist": "^2.0.0",
-    "fenceparser": "^1.1.0",
+    "@typescript/twoslash": "3.2.1",
+    "@typescript/vfs": "1.4.0",
+    "fenceparser": "^2.2.0",
     "regenerator-runtime": "^0.13.7",
-    "shiki": "0.10.1",
-    "shiki-twoslash": "3.1.2",
+    "shiki-twoslash": "3.1.3",
+    "shiki": "0.14.3",
     "tslib": "2.1.0",
     "unist-util-visit": "^2.0.0"
   },
@@ -52,6 +52,7 @@
     "tslib": "^1.10.0",
     "typescript": ">3",
     "unified": "^8.4.2"
+
   },
   "browser": {
     "fs": false,

diff --git a/packages/shiki-twoslash/README.md b/packages/shiki-twoslash/README.md
@@ -52,18 +52,18 @@ The config which you pass in is a mix of Shiki's [`HighlighterOptions`](https://
 interface HighlighterOptions {
     /**
      * The theme to load upfront.
+     *
+     * Default to: 'nord'
      */
     theme?: IThemeRegistration;
     /**
      * A list of themes to load upfront.
-     *
-     * Default to: `['dark-plus', 'light-plus']`
      */
     themes?: IThemeRegistration[];
     /**
      * A list of languages to load upfront.
      *
-     * Default to `['html', 'css', 'javascript']`
+     * Default to all the bundled languages.
      */
     langs?: (Lang | ILanguageRegistration)[];
     /**
@@ -88,6 +88,8 @@ export interface TwoSlashOptions {
     customTransformers?: CustomTransformers;
     /** An optional copy of the TypeScript import, if missing it will be require'd. */
     tsModule?: TS;
+    /** Absolute path to the directory to look up built-in TypeScript .d.ts files. */
+    tsLibDirectory?: string;
     /** An optional copy of the lz-string import, if missing it will be require'd. */
     lzstringModule?: LZ;
     /**

diff --git a/packages/shiki-twoslash/package.json b/packages/shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "shiki-twoslash",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -28,10 +28,10 @@
     "lint": "tsdx lint"
   },
   "dependencies": {
-    "@typescript/twoslash": "3.1.0",
-    "@typescript/vfs": "1.3.4",
-    "fenceparser": "^1.1.0",
-    "shiki": "0.10.1"
+    "@typescript/twoslash": "3.2.1",
+    "@typescript/vfs": "1.4.0",
+    "fenceparser": "^2.2.0",
+    "shiki": "0.14.3"
   },
   "peerDependencies": {
     "typescript": ">3"

diff --git a/packages/twoslash-cli/package.json b/packages/twoslash-cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "twoslash-cli",
-  "version": "1.3.24",
+  "version": "1.3.28",
   "main": "index.js",
   "bin": {
     "twoslash": "./bin/twoslash.js",
@@ -15,7 +15,7 @@
     "hast-util-to-html": "^7.1.2",
     "mdast-util-to-hast": "^10.0.0",
     "remark": "^13.0.0",
-    "remark-shiki-twoslash": "3.1.3",
+    "remark-shiki-twoslash": "3.1.7",
     "unist-util-visit": "^3.1.0"
   },
   "devDependencies": {

diff --git a/packages/vuepress-plugin-shiki-twoslash/package.json b/packages/vuepress-plugin-shiki-twoslash/package.json
@@ -1,6 +1,6 @@
 {
   "name": "vuepress-plugin-shiki-twoslash",
-  "version": "1.0.39",
+  "version": "1.0.43",
   "license": "MIT",
   "homepage": "https://github.com/shikijs/twoslash",
   "repository": {
@@ -22,7 +22,7 @@
     "lint": "echo 'NOOP'"
   },
   "dependencies": {
-    "remark-shiki-twoslash": "3.1.3",
+    "remark-shiki-twoslash": "3.1.7",
     "typescript": ">3"
   }
 }