@mdit-vue/shared 0.3.0 → 0.6.0

package/CHANGELOG.md

@@ -3,6 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.6.0](https://github.com/mdit-vue/mdit-vue/compare/v0.5.0...v0.6.0) (2022-07-11)
+
+### Features
+
+- **types:** extract types from shared package ([5fc56ce](https://github.com/mdit-vue/mdit-vue/commit/5fc56ce6439159584e09e13ca9a6e87abe8f4389))
+
+# [0.5.0](https://github.com/mdit-vue/mdit-vue/compare/v0.4.0...v0.5.0) (2022-07-06)
+
+**Note:** Version bump only for package @mdit-vue/shared
+
+# [0.4.0](https://github.com/mdit-vue/mdit-vue/compare/v0.3.1...v0.4.0) (2022-07-02)
+
+**Note:** Version bump only for package @mdit-vue/shared
+
 # [0.3.0](https://github.com/mdit-vue/mdit-vue/compare/v0.2.0...v0.3.0) (2022-06-25)
 
 ### Features

package/README.md

@@ -1,32 +1,11 @@
 # @mdit-vue/shared
 
-[![npm](https://badgen.net/npm/v/@mdit-vue/shared)](https://www.npmjs.com/package/@mdit-vue/plugin-sfc)
+[![npm](https://badgen.net/npm/v/@mdit-vue/shared)](https://www.npmjs.com/package/@mdit-vue/shared)
 
-Shared utils and types of mdit-vue.
+Shared utils of mdit-vue.
 
 ## Install
 
 ```sh
 npm i @mdit-vue/shared
 ```
-
-## Usage
-
-Add more properties to `env` via [TypeScript module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation):
-
-```ts
-declare module '@mdit-vue/shared' {
-  interface MarkdownItEnv {
-    foo?: string[];
-  }
-}
-```
-
-```ts
-import MarkdownIt from 'markdown-it';
-import type { MarkdownItEnv } from '@mdit-vue/shared';
-
-const md = MarkdownIt({ html: true });
-const env: MarkdownItEnv = {};
-const rendered = md.render('raw markdown text', env);
-```

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { MarkdownItHeader } from '@mdit-vue/types';
 import Token from 'markdown-it/lib/token';
 
 /**
@@ -10,15 +11,6 @@ declare const htmlEscape: (str: string) => string;
  */
 declare const htmlUnescape: (str: string) => string;
 
-interface MarkdownItEnv {
-}
-interface MarkdownItHeader {
-    level: number;
-    title: string;
-    slug: string;
-    children: MarkdownItHeader[];
-}
-
 /**
  * Resolve headers from markdown-it tokens
  */
@@ -45,4 +37,4 @@ declare const resolveTitleFromToken: (token: Token, { shouldAllowHtml, shouldEsc
  */
 declare const slugify: (str: string) => string;
 
-export { MarkdownItEnv, MarkdownItHeader, htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };
+export { htmlEscape, htmlUnescape, resolveHeadersFromTokens, resolveTitleFromToken, slugify };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@mdit-vue/shared",
-  "version": "0.3.0",
+  "version": "0.6.0",
   "description": "Shared utils and types of mdit-vue",
   "keywords": [
     "markdown-it",
-    "vue"
+    "vue",
+    "utils"
   ],
   "homepage": "https://github.com/mdit-vue",
   "bugs": {
@@ -31,16 +32,17 @@
     "test": "vitest"
   },
   "dependencies": {
+    "@mdit-vue/types": "0.6.0",
     "@types/markdown-it": "^12.2.3",
     "markdown-it": "^13.0.1"
   },
   "devDependencies": {
     "c8": "^7.11.3",
     "unbuild": "^0.7.4",
-    "vitest": "^0.15.2"
+    "vitest": "^0.18.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bcbfd4705d747ee71d6c7c32f8be6155261e9c90"
+  "gitHead": "654a3a4d52f4fb9711bf5f7ba3674ff58ec663bf"
 }

package/src/index.ts

@@ -3,4 +3,3 @@ export * from './html-unescape';
 export * from './resolve-headers-from-tokens';
 export * from './resolve-title-from-token';
 export * from './slugify';
-export * from './types';

package/src/resolve-headers-from-tokens.ts

@@ -1,6 +1,6 @@
+import type { MarkdownItHeader } from '@mdit-vue/types';
 import type Token from 'markdown-it/lib/token';
 import { resolveTitleFromToken } from './resolve-title-from-token';
-import type { MarkdownItHeader } from './types';
 
 /**
  * Resolve headers from markdown-it tokens

package/src/types.ts

@@ -1,11 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MarkdownItEnv {
-  // to be extended with module augmentation
-}
-
-export interface MarkdownItHeader {
-  level: number;
-  title: string;
-  slug: string;
-  children: MarkdownItHeader[];
-}