From 13f5a91e51b26b349f9e4ff656513e19c324c5f1 Mon Sep 17 00:00:00 2001 From: Julien Cayzac Date: Sat, 17 Aug 2024 18:51:27 +0900 Subject: [PATCH] migrating to a pnpm workspace --- packages/shiki-transformer-token/LICENSE | 21 ++++++++ .../shiki-transformer-token}/README.md | 9 +++- .../shiki-transformer-token}/build.config.ts | 0 packages/shiki-transformer-token/package.json | 53 +++++++++++++++++++ .../shiki-transformer-token/src}/index.ts | 2 +- .../shiki-transformer-token}/tsconfig.json | 0 pnpm-lock.yaml | 12 +++++ 7 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 packages/shiki-transformer-token/LICENSE rename {shiki-transformer-token => packages/shiki-transformer-token}/README.md (59%) rename {shiki-transformer-token => packages/shiki-transformer-token}/build.config.ts (100%) create mode 100644 packages/shiki-transformer-token/package.json rename {shiki-transformer-token => packages/shiki-transformer-token/src}/index.ts (97%) rename {shiki-transformer-token => packages/shiki-transformer-token}/tsconfig.json (100%) diff --git a/packages/shiki-transformer-token/LICENSE b/packages/shiki-transformer-token/LICENSE new file mode 100644 index 0000000..0761c61 --- /dev/null +++ b/packages/shiki-transformer-token/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Julien Cayzac + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/shiki-transformer-token/README.md b/packages/shiki-transformer-token/README.md similarity index 59% rename from shiki-transformer-token/README.md rename to packages/shiki-transformer-token/README.md index 9600781..6f50b89 100644 --- a/shiki-transformer-token/README.md +++ b/packages/shiki-transformer-token/README.md @@ -1,6 +1,9 @@ # `@jcayzac/shiki-transformer-token` -TODO +This [Shiki transformer](https://shiki.style/guide/transformers) is to be used together with [`@jcayzac/shiki-transformer-token`](https://www.npmjs.com/package/@jcayzac/shiki-transformer-token). + +> [!WARNING] +> Used alone, this transformer is non-functional, as it will pollute your output with useless HTML attributes. ## Installation @@ -21,6 +24,10 @@ yarn add @jcayzac/shiki-transformer-token deno add npm:@jcayzac/shiki-transformer-token ``` +## Usage + +See [the theme's documentation](https://github.com/jcayzac/copepod-modules/blob/main/packages/astro-theme-token/README.md#usage). + ## Like it? Buy me a coffee! If you like anything here, consider buying me a coffee using one of the following platforms: diff --git a/shiki-transformer-token/build.config.ts b/packages/shiki-transformer-token/build.config.ts similarity index 100% rename from shiki-transformer-token/build.config.ts rename to packages/shiki-transformer-token/build.config.ts diff --git a/packages/shiki-transformer-token/package.json b/packages/shiki-transformer-token/package.json new file mode 100644 index 0000000..db11eb7 --- /dev/null +++ b/packages/shiki-transformer-token/package.json @@ -0,0 +1,53 @@ +{ + "name": "@jcayzac/shiki-transformer-token", + "type": "module", + "version": "0.1.0", + "description": "Shiki transformer to enable more semantic styling.", + "author": "Julien Cayzac", + "license": "MIT", + "funding": "https://github.com/sponsors/jcayzac", + "homepage": "https://github.com/jcayzac/copepod-modules/tree/main/shiki-transformer-token#readme", + "repository": { + "type": "git", + "url": "github:jcayzac/copepod-modules", + "directory": "packages/shiki-transformer-token" + }, + "bugs": "https://github.com/jcayzac/copepod-modules/issues", + "keywords": [ + "shiki", + "transformer", + "shiki-transformer", + "semantic", + "unstyled" + ], + "sideEffects": false, + "publishConfig": { + "access": "public", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.mjs" + } + }, + "module": "./dist/index.mjs", + "types": "./dist/index.d.ts" + }, + "main": "./src/index.ts", + "files": [ + "dist" + ], + "scripts": { + "build": "unbuild --minify --sourcemap", + "prepublishOnly": "npm run build", + "lint": "eslint .", + "check": "tsc --noEmit" + }, + "peerDependencies": { + "@shikijs/core": "^1.13.0" + }, + "devDependencies": { + "@shikijs/core": "^1.13.0", + "@types/hast": "^3.0.4", + "@types/unist": "^3.0.3" + } +} diff --git a/shiki-transformer-token/index.ts b/packages/shiki-transformer-token/src/index.ts similarity index 97% rename from shiki-transformer-token/index.ts rename to packages/shiki-transformer-token/src/index.ts index 3d1d54e..6f1b202 100644 --- a/shiki-transformer-token/index.ts +++ b/packages/shiki-transformer-token/src/index.ts @@ -6,7 +6,7 @@ * other transformers may add extra styles. */ -import type { ShikiTransformer } from 'shiki' +import type { ShikiTransformer } from '@shikijs/core' import type { Element, Node } from 'hast' function transformer(): ShikiTransformer { diff --git a/shiki-transformer-token/tsconfig.json b/packages/shiki-transformer-token/tsconfig.json similarity index 100% rename from shiki-transformer-token/tsconfig.json rename to packages/shiki-transformer-token/tsconfig.json diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 76fce08..4b38860 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -70,6 +70,18 @@ importers: specifier: ^3.0.3 version: 3.0.3 + packages/shiki-transformer-token: + devDependencies: + '@shikijs/core': + specifier: ^1.13.0 + version: 1.13.0 + '@types/hast': + specifier: ^3.0.4 + version: 3.0.4 + '@types/unist': + specifier: ^3.0.3 + version: 3.0.3 + packages/utils-digest: {} packages/utils-text: {}